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

2.2 KiB

Raw Blame History

airshipctl config set-manifest

Airshipctl command to create/modify manifests in airship config

Synopsis

Creates or modifies a manifests in the airshipctl config file based on the MANIFEST_NAME argument passed. The optional flags that can be passed to the command are repo name, url, branch name, tag name, commit hash, target-path and metadata-path. Use --force flag to enable force checkout of the repo. And use --phase flag to enable phase repository.

airshipctl config set-manifest MANIFEST_NAME [flags]

Examples

Create a new manifest
# airshipctl config set-manifest exampleManifest --repo exampleRepo --url https://github.com/site \
  --branch master --phase --target-path exampleTargetpath

Change the phase repo for manifest
# airshipctl config set-manifest e2e --repo exampleRepo --phase

Change the target-path for manifest
# airshipctl config set-manifest e2e --target-path /tmp/e2e

Options

--branch string          the branch to be associated with repository in this manifest
--commithash string      the commit hash to be associated with repository in this manifest
--force                  if set, enable force checkout in repository with this manifest
-h, --help                   help for set-manifest
--metadata-path string   the metadata path to be set for this manifest
--phase                  if set, enable this repository as phase repository to be used with this manifest
--repo string            the name of the repository to be associated with this manifest
--tag string             the tag to be associated with repository in this manifest
--target-path string     the target path to be set for this manifest
--url string             the repository url to be associated with this manifest

Options inherited from parent commands

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

2.2 KiB Raw Blame History