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
58 lines
1.2 KiB
ReStructuredText
58 lines
1.2 KiB
ReStructuredText
.. _airshipctl_config_get-context:
|
|
|
|
airshipctl config get-context
|
|
-----------------------------
|
|
|
|
Airshipctl command to get context(s) information from the airshipctl config
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
|
|
Displays information about contexts such as associated manifests, users, and clusters. It would display a specific
|
|
context information, or all defined context information if no name is provided.
|
|
|
|
|
|
::
|
|
|
|
airshipctl config get-context CONTEXT_NAME [flags]
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
::
|
|
|
|
|
|
List all contexts
|
|
# airshipctl config get-contexts
|
|
|
|
Display the current context
|
|
# airshipctl config get-context --current
|
|
|
|
Display a specific context
|
|
# airshipctl config get-context exampleContext
|
|
|
|
|
|
Options
|
|
~~~~~~~
|
|
|
|
::
|
|
|
|
--current get the current context
|
|
--format yaml supported output format yaml or `table`, default is `yaml` (default "yaml")
|
|
-h, --help help for get-context
|
|
|
|
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 config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
|
|