4c3140be93
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: I3587ad211f7d614b5cc6a162ca352ac54c3b90f0
32 lines
1.3 KiB
Plaintext
32 lines
1.3 KiB
Plaintext
|
|
Render documents for a phase.
|
|
|
|
Usage:
|
|
render PHASE_NAME [flags]
|
|
|
|
Examples:
|
|
|
|
Get all 'initinfra' phase documents containing labels "app=helm" and "service=tiller"
|
|
# airshipctl phase render initinfra -l app=helm,service=tiller
|
|
|
|
Get all phase documents containing labels "app=helm" and "service=tiller" and kind 'Deployment'
|
|
# airshipctl phase render initinfra -l app=helm,service=tiller -k Deployment
|
|
|
|
Get all documents from config bundle
|
|
# airshipctl phase render --source config
|
|
|
|
Get all documents executor rendered documents for a phase
|
|
# airshipctl phase render initinfra --source executor
|
|
|
|
|
|
Flags:
|
|
-a, --annotation string filter documents by Annotations
|
|
-g, --apiversion string filter documents by API version
|
|
-d, --decrypt ensure that decryption of encrypted documents has finished successfully
|
|
-h, --help help for render
|
|
-k, --kind string filter documents by Kind
|
|
-l, --label string filter documents by Labels
|
|
-s, --source string phase: phase entrypoint will be rendered by kustomize, if entrypoint is not specified error will be returned
|
|
executor: rendering will be performed by executor if the phase
|
|
config: this will render bundle containing phase and executor documents (default "phase")
|