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

995 B

Raw Blame History

airshipctl plan run

Airshipctl command to run plan

Synopsis

Run a plan defined in the site manifest. Specify the plan using the mandatory parameter PLAN_NAME. To get list of plans associated for a site, run 'airshipctl plan list'.

airshipctl plan run PLAN_NAME [flags]

Examples

Run plan named iso
# airshipctl plan run iso

Perform a dry run of a plan
# airshipctl plan run iso --dry-run

Options

--dry-run                 simulate phase execution
-h, --help                    help for run
--wait-timeout duration   wait timeout

Options inherited from parent commands

--airshipconf string   path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
--debug                enable verbose output

995 B Raw Blame History