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
56 lines
1.4 KiB
ReStructuredText
56 lines
1.4 KiB
ReStructuredText
.. _airshipctl_config_set-context:
|
|
|
|
airshipctl config set-context
|
|
-----------------------------
|
|
|
|
Airshipctl command to create/modify context in airshipctl config file
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
|
|
Creates or modifies context in the airshipctl config file based on the CONTEXT_NAME passed or for the current context
|
|
if --current flag is specified. It accepts optional flags which include manifest name and management-config name.
|
|
|
|
|
|
::
|
|
|
|
airshipctl config set-context CONTEXT_NAME [flags]
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
::
|
|
|
|
|
|
To create a new context named "exampleContext"
|
|
# airshipctl config set-context exampleContext --manifest=exampleManifest
|
|
|
|
To update the manifest of the current-context
|
|
# airshipctl config set-context --current --manifest=exampleManifest
|
|
|
|
|
|
Options
|
|
~~~~~~~
|
|
|
|
::
|
|
|
|
--current update the current context
|
|
-h, --help help for set-context
|
|
--management-config string set the management config for the specified context
|
|
--manifest string set the manifest for the specified 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
|
|
|