Sirisha Gopigiri 4da8a54887 Separate folders-Create airshipctl cli user guide documentation

Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org

Steps to render the document locally

	* Install sphinx: python3 -m pip install sphinx
        * Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
        * Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
	* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
	* Run local server: cd _build; python3 -m http.server
	* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document

Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352

2021-06-28 10:20:55 +05:30

1.9 KiB

Raw Blame History

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

1.9 KiB Raw Blame History