Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.06 KB

README.md

File metadata and controls

72 lines (45 loc) · 2.06 KB

Kubeconnect Build Status

iMIT License Go Report Card

Kubeconnect Is a tool with which you can easily connect to any pod running in any of your kubernetes clusters.

Don't you know the exact namespace, the pod name, or the name of that one container in the pod? This is the command for you.

Installation

OSX

Installing on OSX can be done using brew:

$ brew tap marijnkoesen/kubeconnect
$ brew install kubeconnect

Others

Download one of the releases from the release page.

Extract the archive and run the kubeconnect command.

Building from source

Building from source is as simple as a go build

$ git clone https://github.com/MarijnKoesen/kubeconnect.git
$ cd kubeconnect
$ go build
$ ./kubeconnect

Specifying the shell to be used

By default kubeconnect will try to use the best shell available in the pod. It does this by first making a connecting to the pod and checking what shells are available.

By default kubeconnect tries to use the following shells, in this order:

zsh
ksh
bash
sh

Note that it does not have to be a full path, kubeconnect will figure that out by itself.

If you want to connect to a different shell, you can specify the shell you want in the ~/.kubeconnect.yaml configuration.

You can see an example in the /.kubeconnect.yaml-dist file.

shell: zsh ksh bash sh

Alternatively you can set it via an environment variable:

$ KUBECONNECT_SHELL="fish sh" kubeconnect

When the shell is a single full path, the lookup will not be done and the shell will be used as-is.