airshipctl/docs/source/cli/airshipctl_cluster_get-kubeconfig.md
bijayasharma 622d45f3bd Add flags to airshipctl get-kubeconfig cmd
* This commits add --file and --merge flags to
  airshipctl get-kubeconfig cmd

Change-Id: I919d4f068d3ef9bcda6b3a7c9aeb0826a4e5c0d4
Signed-off-by: bijayasharma <vetbijaya@gmail.com>
Relates-To: #495
Closes: #495
2021-06-23 13:41:14 +00:00

59 lines
1.8 KiB
Markdown

## airshipctl cluster get-kubeconfig
Airshipctl command to retrieve kubeconfig for a desired cluster
### Synopsis
Retrieves kubeconfig of the cluster and prints it to stdout.
If you specify CLUSTER_NAME, kubeconfig will have a CurrentContext set to CLUSTER_NAME and
will have its context defined.
If you don't specify CLUSTER_NAME, kubeconfig will have multiple contexts for every cluster
in the airship site. Context names will correspond to cluster names. CurrentContext will be empty.
```
airshipctl cluster get-kubeconfig CLUSTER_NAME [flags]
```
### Examples
```
Retrieve target-cluster kubeconfig
# airshipctl cluster get-kubeconfig target-cluster
Retrieve kubeconfig for the entire site; the kubeconfig will have context for every cluster
# airshipctl cluster get-kubeconfig
Specify a file where kubeconfig should be written
# airshipctl cluster get-kubeconfig --file ~/my-kubeconfig
Merge site kubeconfig with existing kubeconfig file.
Keep in mind that this can override a context if it has the same name
Airshipctl will overwrite the contents of the file, if you want merge with existing file, specify "--merge" flag
# airshipctl cluster get-kubeconfig --file ~/.airship/kubeconfig --merge
```
### Options
```
-f, --file string specify where to write kubeconfig file. If flag isn't specified, airshipctl will write it to stdout
-h, --help help for get-kubeconfig
--merge specify if you want to merge kubeconfig with the one that exists at --file location
```
### Options inherited from parent commands
```
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
--debug enable verbose output
```
### SEE ALSO
* [airshipctl cluster](airshipctl_cluster.md) - Airshipctl command to manage kubernetes clusters