airshipctl/cmd/phase/testdata/TestNewListCommandGoldenOutput/phase-list-cmd-with-help.golden
Sirisha Gopigiri 4c3140be93 Phase- updating cmd files for documentation
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
2021-06-09 11:53:58 +05:30

30 lines
844 B
Plaintext

List phases defined in site manifests by plan. Phases within a plan are
executed sequentially. Multiple phase plans are executed in parallel.
Usage:
list PHASE_NAME [flags]
Examples:
List phases of phasePlan
# airshipctl phase list --plan phasePlan
To output the contents in table format (default operation)
# airshipctl phase list --plan phasePlan -o table
To output the contents in yaml format
# airshipctl phase list --plan phasePlan -o yaml
List all phases
# airshipctl phase list
List phases with clustername
# airshipctl phase list --cluster-name clustername
Flags:
-c, --cluster-name string filter documents by cluster name
-h, --help help for list
-o, --output string output format. Supported formats are 'table' and 'yaml' (default "table")
--plan string plan name of a plan