4da8a54887
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
59 lines
1.5 KiB
ReStructuredText
59 lines
1.5 KiB
ReStructuredText
.. _airshipctl_cluster_rotate-sa-token:
|
|
|
|
airshipctl cluster rotate-sa-token
|
|
----------------------------------
|
|
|
|
Airshipctl command to rotate tokens of Service Account(s)
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
|
|
Reset/rotate the Service Account(SA) tokens and additionally restart the corresponding pods to get the latest
|
|
token data reflected in the pod spec.
|
|
|
|
Secret-namespace is a mandatory flag and secret-name is optional. If a secret-name is not specified, all of the SA
|
|
tokens in the specified namespace are rotated, else only the specified secret-name.
|
|
|
|
|
|
::
|
|
|
|
airshipctl cluster rotate-sa-token [flags]
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
::
|
|
|
|
|
|
To rotate a particular SA token
|
|
# airshipctl cluster rotate-sa-token -n cert-manager -s cert-manager-token-vvn9p
|
|
|
|
To rotate all the SA tokens in cert-manager namespace
|
|
# airshipctl cluster rotate-sa-token -n cert-manager
|
|
|
|
|
|
Options
|
|
~~~~~~~
|
|
|
|
::
|
|
|
|
-h, --help help for rotate-sa-token
|
|
--kubeconfig string path to kubeconfig associated with cluster being managed
|
|
-s, --secret-name string name of the secret containing Service Account Token
|
|
-n, --secret-namespace string namespace of the Service Account Token
|
|
|
|
Options inherited from parent commands
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
::
|
|
|
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
--debug enable verbose output
|
|
|
|
SEE ALSO
|
|
~~~~~~~~
|
|
|
|
* :ref:`airshipctl cluster <airshipctl_cluster>` - Airshipctl command to manage kubernetes clusters
|
|
|