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
1.9 KiB
1.9 KiB
airshipctl config
Airshipctl command to manage airshipctl config file
Synopsis
Provides commands which can be used to manage the airshipctl config file.
Options
-h, --help help for configOptions inherited from parent commands
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
--debug enable verbose outputSEE ALSO
airshipctl <airshipctl>- A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.airshipctl config get-context <airshipctl_config_get-context>- Airshipctl command to get context(s) information from the airshipctl configairshipctl config get-management-config <airshipctl_config_get-management-config>- Airshipctl command to view management config(s) defined in the airshipctl configairshipctl config get-manifest <airshipctl_config_get-manifest>- Airshipctl command to get a specific or all manifest(s) information from the airshipctl configairshipctl config init <airshipctl_config_init>- Airshipctl command to generate initial configuration file for airshipctlairshipctl config set-context <airshipctl_config_set-context>- Airshipctl command to create/modify context in airshipctl config fileairshipctl config set-management-config <airshipctl_config_set-management-config>- Airshipctl command to create/modify out-of-band management configuration in airshipctl config fileairshipctl config set-manifest <airshipctl_config_set-manifest>- Airshipctl command to create/modify manifests in airship configairshipctl config use-context <airshipctl_config_use-context>- Airshipctl command to switch to a different context