airshipctl/airshipctl_phase_list.md at 622d45f3bddc98e96abac49497909444ae666ea4

Sirisha Gopigiri 21f015b502 Updating cmd files for documentation

This PS updates cmd related to root, completion, document and
version subcommands. It also updates minor details in other
subcommands.

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: I562c15c0d25b2e9731c0eb03854d1d348eb435f2

2021-06-09 09:56:21 +00:00

1.2 KiB

Raw Blame History

airshipctl phase list

Airshipctl command to list phases

Synopsis

List phases defined in site manifests by plan. Phases within a plan are executed sequentially. Multiple phase plans are executed in parallel.

airshipctl phase 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

Options

  -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

Options inherited from parent commands

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

1.2 KiB Raw Blame History