3274b41151
The description and examples are updated for the airshipctl commands, which will be inturn used for generating documentation. Please ignore the .md file changes in this PS. They are added for zuul gates to pass. Here is the PS with generated documention files https://review.opendev.org/c/airship/airshipctl/+/789250 Relates-To: #280 Change-Id: If3ec175e2f582919296576a4bff6ae64871a7333
33 lines
1.6 KiB
Plaintext
33 lines
1.6 KiB
Plaintext
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.
|
|
|
|
Usage:
|
|
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
|
|
|
|
|
|
Flags:
|
|
--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
|