From 21f015b50233e08eb1320887b5127752257d8d25 Mon Sep 17 00:00:00 2001 From: Sirisha Gopigiri Date: Thu, 6 May 2021 15:40:29 +0530 Subject: [PATCH] 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 --- cmd/baremetal/baremetal.go | 22 +++++++++---------- cmd/baremetal/powerstatus.go | 6 ++--- cmd/baremetal/remotedirect.go | 6 ++--- .../baremetal-ejectmedia-with-help.golden | 20 ++++++++--------- .../baremetal-poweroff-with-help.golden | 20 ++++++++--------- .../baremetal-poweron-with-help.golden | 20 ++++++++--------- .../baremetal-powerstatus-with-help.golden | 12 +++++----- .../baremetal-reboot-with-help.golden | 20 ++++++++--------- .../baremetal-remotedirect-with-help.golden | 12 +++++----- .../baremetal-with-help.golden | 2 +- .../checkexpiration/checkexpiration.go | 10 ++++----- .../check-expiration-with-help.golden | 10 ++++----- cmd/cluster/get_kubeconfig.go | 4 ++-- cmd/cluster/list.go | 3 ++- cmd/cluster/resetsatoken/resetsatoken.go | 4 ++-- .../reset-with-help.golden | 4 ++-- ...luster-get-kubeconfig-cmd-with-help.golden | 4 ++-- .../cluster-list-cmd-with-help.golden | 3 ++- cmd/completion/completion.go | 10 ++++----- .../completion-cmd-too-few-args.golden | 8 +++---- .../completion-cmd-too-many-args.golden | 8 +++---- .../completion-unknown-shell.golden | 8 +++---- cmd/document/document.go | 7 +++++- cmd/document/pull.go | 13 ++++++++--- .../document-with-help.golden | 5 +++-- .../document-pull-cmd-with-help.golden | 9 +++++++- cmd/root.go | 15 ++++++------- .../rootCmd-with-default-subcommands.golden | 10 ++++----- .../rootCmd-with-no-subcommands.golden | 2 +- .../specialized-rootCmd-with-bootstrap.golden | 4 ++-- .../version-help.golden | 2 +- cmd/version.go | 2 +- docs/source/cli/airshipctl.md | 12 +++++----- docs/source/cli/airshipctl_baremetal.md | 6 ++--- .../cli/airshipctl_baremetal_ejectmedia.md | 22 +++++++++---------- .../cli/airshipctl_baremetal_poweroff.md | 22 +++++++++---------- .../cli/airshipctl_baremetal_poweron.md | 22 +++++++++---------- .../cli/airshipctl_baremetal_powerstatus.md | 14 ++++++------ .../source/cli/airshipctl_baremetal_reboot.md | 22 +++++++++---------- .../cli/airshipctl_baremetal_remotedirect.md | 14 ++++++------ docs/source/cli/airshipctl_cluster.md | 4 ++-- ...tl_cluster_check-certificate-expiration.md | 12 +++++----- .../cli/airshipctl_cluster_get-kubeconfig.md | 6 ++--- docs/source/cli/airshipctl_cluster_list.md | 5 +++-- .../cli/airshipctl_cluster_rotate-sa-token.md | 6 ++--- docs/source/cli/airshipctl_cluster_status.md | 2 +- docs/source/cli/airshipctl_completion.md | 14 ++++++------ docs/source/cli/airshipctl_config.md | 4 ++-- .../cli/airshipctl_config_get-context.md | 2 +- ...airshipctl_config_get-management-config.md | 2 +- .../cli/airshipctl_config_get-manifest.md | 2 +- docs/source/cli/airshipctl_config_init.md | 2 +- .../cli/airshipctl_config_set-context.md | 2 +- ...airshipctl_config_set-management-config.md | 2 +- .../cli/airshipctl_config_set-manifest.md | 2 +- .../cli/airshipctl_config_use-context.md | 2 +- docs/source/cli/airshipctl_document.md | 12 +++++----- docs/source/cli/airshipctl_document_pull.md | 18 +++++++++++---- docs/source/cli/airshipctl_phase.md | 4 ++-- docs/source/cli/airshipctl_phase_list.md | 2 +- docs/source/cli/airshipctl_phase_render.md | 2 +- docs/source/cli/airshipctl_phase_run.md | 2 +- docs/source/cli/airshipctl_phase_status.md | 2 +- docs/source/cli/airshipctl_phase_tree.md | 2 +- docs/source/cli/airshipctl_phase_validate.md | 2 +- docs/source/cli/airshipctl_plan.md | 4 ++-- docs/source/cli/airshipctl_plan_list.md | 2 +- docs/source/cli/airshipctl_plan_run.md | 2 +- docs/source/cli/airshipctl_plan_validate.md | 2 +- docs/source/cli/airshipctl_secret.md | 4 ++-- docs/source/cli/airshipctl_secret_generate.md | 2 +- ...irshipctl_secret_generate_encryptionkey.md | 2 +- docs/source/cli/airshipctl_version.md | 8 +++---- 73 files changed, 297 insertions(+), 263 deletions(-) diff --git a/cmd/baremetal/baremetal.go b/cmd/baremetal/baremetal.go index b1a47709f..50e780292 100644 --- a/cmd/baremetal/baremetal.go +++ b/cmd/baremetal/baremetal.go @@ -29,43 +29,43 @@ type Action int const ( baremetalLong = ` -Provides commands that can be performed on bare metal host(s). The commands helps in +Provides commands that can be performed on bare metal host(s). The commands help in performing the basic boot and power operations on the bare metal host(s). ` flagLabel = "labels" flagLabelShort = "l" - flagLabelDescription = "label(s) to filter desired bare metal host documents" + flagLabelDescription = "label(s) to filter desired bare metal host from site manifest documents" flagName = "name" - flagNameDescription = "name to filter desired bare metal host document" + flagNameDescription = "name to filter desired bare metal host from site manifest document" flagNamespace = "namespace" flagNamespaceSort = "n" - flagNamespaceDescription = "airshipctl phase that contains the desired bare metal host document(s)" + flagNamespaceDescription = "airshipctl phase that contains the desired bare metal host from site manifest document(s)" flagTimeout = "timeout" flagTimeoutDescription = "timeout on bare metal action" flagAll = "all" - flagAllDescription = "specify this to target all hosts in the inventory" + flagAllDescription = "specify this to target all hosts in the site inventory" ) var ( - selectorsDescription = fmt.Sprintf(`The command will target bare metal hosts from airship inventory based on the ---%s, --%s and --%s flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the + selectorsDescription = fmt.Sprintf(`The command will target bare metal hosts from airship site inventory based on the +--%s, --%s and --%s flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory.`, flagName, flagNamespace, flagLabel) bmhActionExampleTemplate = ` -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform %[1]s action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal %[1]s --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform %[1]s action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal %[1]s --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform %[1]s action against all hosts defined in inventory # airshipctl baremetal %[1]s --all -Perform action against hosts with a label 'foo=bar' +Perform %[1]s action against hosts with a label 'foo=bar' # airshipctl baremetal %[1]s --labels "foo=bar" ` ) diff --git a/cmd/baremetal/powerstatus.go b/cmd/baremetal/powerstatus.go index 25c706c80..03870c5f7 100644 --- a/cmd/baremetal/powerstatus.go +++ b/cmd/baremetal/powerstatus.go @@ -28,13 +28,13 @@ based on the --name, --namespace, --label and --timeout flags provided. ` powerStatusExample = ` -Perform action against host with name rdm9r3s3 in all namespaces where the host is found +To get power status of host with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal powerstatus --name rdm9r3s3 -Perform action against host with name rdm9r3s3 in namespace metal3 +To get power status of host with name rdm9r3s3 in metal3 namespace # airshipctl baremetal powerstatus --name rdm9r3s3 --namespace metal3 -Perform action against host with a label 'foo=bar' +To get power status of host with a label 'foo=bar' # airshipctl baremetal powerstatus --labels "foo=bar" ` ) diff --git a/cmd/baremetal/remotedirect.go b/cmd/baremetal/remotedirect.go index 860c2f345..62d056aca 100644 --- a/cmd/baremetal/remotedirect.go +++ b/cmd/baremetal/remotedirect.go @@ -28,13 +28,13 @@ on the --iso-url, --name, --namespace, --label and --timeout flags provided. ` remoteDirectExample = ` -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform bootstrap action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal remotedirect --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform bootstrap action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal remotedirect --name rdm9r3s3 --namespace metal3 -Perform action against hosts with a label 'foo=bar' +Perform bootstrap action against hosts with a label 'foo=bar' # airshipctl baremetal remotedirect --labels "foo=bar" ` ) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden index 159f5c859..29bb79c78 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden @@ -1,5 +1,5 @@ -Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship inventory based on the ---name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship site inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory. Usage: @@ -7,23 +7,23 @@ Usage: Examples: -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform ejectmedia action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal ejectmedia --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform ejectmedia action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal ejectmedia --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform ejectmedia action against all hosts defined in inventory # airshipctl baremetal ejectmedia --all -Perform action against hosts with a label 'foo=bar' +Perform ejectmedia action against hosts with a label 'foo=bar' # airshipctl baremetal ejectmedia --labels "foo=bar" Flags: - --all specify this to target all hosts in the inventory + --all specify this to target all hosts in the site inventory -h, --help help for ejectmedia - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden index 80351db5e..34e1f99ca 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden @@ -1,5 +1,5 @@ -Power off bare metal host(s). The command will target bare metal hosts from airship inventory based on the ---name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +Power off bare metal host(s). The command will target bare metal hosts from airship site inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory. Usage: @@ -7,23 +7,23 @@ Usage: Examples: -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform poweroff action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal poweroff --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform poweroff action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal poweroff --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform poweroff action against all hosts defined in inventory # airshipctl baremetal poweroff --all -Perform action against hosts with a label 'foo=bar' +Perform poweroff action against hosts with a label 'foo=bar' # airshipctl baremetal poweroff --labels "foo=bar" Flags: - --all specify this to target all hosts in the inventory + --all specify this to target all hosts in the site inventory -h, --help help for poweroff - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden index 518664179..c967c6c0c 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden @@ -1,5 +1,5 @@ -Power on bare metal host(s). The command will target bare metal hosts from airship inventory based on the ---name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +Power on bare metal host(s). The command will target bare metal hosts from airship site inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory. Usage: @@ -7,23 +7,23 @@ Usage: Examples: -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform poweron action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal poweron --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform poweron action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal poweron --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform poweron action against all hosts defined in inventory # airshipctl baremetal poweron --all -Perform action against hosts with a label 'foo=bar' +Perform poweron action against hosts with a label 'foo=bar' # airshipctl baremetal poweron --labels "foo=bar" Flags: - --all specify this to target all hosts in the inventory + --all specify this to target all hosts in the site inventory -h, --help help for poweron - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden index a551d0241..9f030c86d 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden @@ -6,19 +6,19 @@ Usage: Examples: -Perform action against host with name rdm9r3s3 in all namespaces where the host is found +To get power status of host with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal powerstatus --name rdm9r3s3 -Perform action against host with name rdm9r3s3 in namespace metal3 +To get power status of host with name rdm9r3s3 in metal3 namespace # airshipctl baremetal powerstatus --name rdm9r3s3 --namespace metal3 -Perform action against host with a label 'foo=bar' +To get power status of host with a label 'foo=bar' # airshipctl baremetal powerstatus --labels "foo=bar" Flags: -h, --help help for powerstatus - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden index 3b1bd40f2..25040c412 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden @@ -1,5 +1,5 @@ -Reboot bare metal host(s). The command will target bare metal hosts from airship inventory based on the ---name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +Reboot bare metal host(s). The command will target bare metal hosts from airship site inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory. Usage: @@ -7,23 +7,23 @@ Usage: Examples: -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform reboot action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal reboot --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform reboot action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal reboot --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform reboot action against all hosts defined in inventory # airshipctl baremetal reboot --all -Perform action against hosts with a label 'foo=bar' +Perform reboot action against hosts with a label 'foo=bar' # airshipctl baremetal reboot --labels "foo=bar" Flags: - --all specify this to target all hosts in the inventory + --all specify this to target all hosts in the site inventory -h, --help help for reboot - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden index 8968e58b8..376ab0396 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden @@ -6,20 +6,20 @@ Usage: Examples: -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform bootstrap action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal remotedirect --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform bootstrap action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal remotedirect --name rdm9r3s3 --namespace metal3 -Perform action against hosts with a label 'foo=bar' +Perform bootstrap action against hosts with a label 'foo=bar' # airshipctl baremetal remotedirect --labels "foo=bar" Flags: -h, --help help for remotedirect --iso-url string specify iso url for host to boot from - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden index f4b6ffc0c..5228e16b2 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden @@ -1,5 +1,5 @@ -Provides commands that can be performed on bare metal host(s). The commands helps in +Provides commands that can be performed on bare metal host(s). The commands help in performing the basic boot and power operations on the bare metal host(s). Usage: diff --git a/cmd/cluster/checkexpiration/checkexpiration.go b/cmd/cluster/checkexpiration/checkexpiration.go index bdfd465c7..bf9477702 100644 --- a/cmd/cluster/checkexpiration/checkexpiration.go +++ b/cmd/cluster/checkexpiration/checkexpiration.go @@ -31,21 +31,21 @@ workload cluster) and also the node certificates present inside /etc/kubernetes/ ` checkExample = ` -To display all the expiring entities in the cluster +To display all the expiring certificates in the cluster # airshipctl cluster check-certificate-expiration --kubeconfig testconfig -To display the entities whose expiration is within threshold of 30 days +To display the certificates whose expiration is within threshold of 30 days # airshipctl cluster check-certificate-expiration -t 30 --kubeconfig testconfig -To output the contents to json (default operation) +To output the contents in json format (default operation) # airshipctl cluster check-certificate-expiration -o json --kubeconfig testconfig or # airshipctl cluster check-certificate-expiration --kubeconfig testconfig -To output the contents to yaml +To output the contents in yaml format # airshipctl cluster check-certificate-expiration -o yaml --kubeconfig testconfig -To output the contents whose expiration is within 30 days to yaml +To output the contents whose expiration is within 30 days in yaml format # airshipctl cluster check-certificate-expiration -t 30 -o yaml --kubeconfig testconfig ` diff --git a/cmd/cluster/checkexpiration/testdata/TestCheckExpirationGoldenOutput/check-expiration-with-help.golden b/cmd/cluster/checkexpiration/testdata/TestCheckExpirationGoldenOutput/check-expiration-with-help.golden index 47b9bd1d1..d10b18305 100644 --- a/cmd/cluster/checkexpiration/testdata/TestCheckExpirationGoldenOutput/check-expiration-with-help.golden +++ b/cmd/cluster/checkexpiration/testdata/TestCheckExpirationGoldenOutput/check-expiration-with-help.golden @@ -7,21 +7,21 @@ Usage: Examples: -To display all the expiring entities in the cluster +To display all the expiring certificates in the cluster # airshipctl cluster check-certificate-expiration --kubeconfig testconfig -To display the entities whose expiration is within threshold of 30 days +To display the certificates whose expiration is within threshold of 30 days # airshipctl cluster check-certificate-expiration -t 30 --kubeconfig testconfig -To output the contents to json (default operation) +To output the contents in json format (default operation) # airshipctl cluster check-certificate-expiration -o json --kubeconfig testconfig or # airshipctl cluster check-certificate-expiration --kubeconfig testconfig -To output the contents to yaml +To output the contents in yaml format # airshipctl cluster check-certificate-expiration -o yaml --kubeconfig testconfig -To output the contents whose expiration is within 30 days to yaml +To output the contents whose expiration is within 30 days in yaml format # airshipctl cluster check-certificate-expiration -t 30 -o yaml --kubeconfig testconfig diff --git a/cmd/cluster/get_kubeconfig.go b/cmd/cluster/get_kubeconfig.go index 082bd59db..47079efd7 100644 --- a/cmd/cluster/get_kubeconfig.go +++ b/cmd/cluster/get_kubeconfig.go @@ -25,10 +25,10 @@ const ( getKubeconfigLong = ` Retrieves kubeconfig of the cluster and prints it to stdout. -If you specify clusterName, kubeconfig will have a CurrentContext set to clusterName and +If you specify CLUSTER_NAME, kubeconfig will have a CurrentContext set to CLUSTER_NAME and will have its context defined. -If you don't specify clusterName, kubeconfig will have multiple contexts for every cluster +If you don't specify CLUSTER_NAME, kubeconfig will have multiple contexts for every cluster in the airship site. Context names will correspond to cluster names. CurrentContext will be empty. ` getKubeconfigExample = ` diff --git a/cmd/cluster/list.go b/cmd/cluster/list.go index 76ac358d2..298128a4b 100755 --- a/cmd/cluster/list.go +++ b/cmd/cluster/list.go @@ -23,7 +23,8 @@ import ( const ( listLong = ` -Retrieve and list the defined clusters in the table form or display just the name as specified. +Retrieve and list the defined clusters in table form or display just the cluster names. The contents of the +table would include cluster name, kubeconfig context and parent cluster name. ` listExample = ` diff --git a/cmd/cluster/resetsatoken/resetsatoken.go b/cmd/cluster/resetsatoken/resetsatoken.go index 37226c3cc..6a1c4b3b0 100644 --- a/cmd/cluster/resetsatoken/resetsatoken.go +++ b/cmd/cluster/resetsatoken/resetsatoken.go @@ -27,8 +27,8 @@ const ( Reset/rotate the Service Account(SA) tokens and additionally restart the corresponding pods to get the latest token data reflected in the pod spec. -Secret-namespace is a mandatory flag and secret-name is optional. If secret-name is not given, all the SA tokens -in that particular namespace is considered, else only that particular input secret-name. +Secret-namespace is a mandatory flag and secret-name is optional. If a secret-name is not specified, all of the SA +tokens in the specified namespace are rotated, else only the specified secret-name. ` resetExample = ` diff --git a/cmd/cluster/resetsatoken/testdata/TestResetTokenGoldenOutput/reset-with-help.golden b/cmd/cluster/resetsatoken/testdata/TestResetTokenGoldenOutput/reset-with-help.golden index a806dbd70..2fc10e0c5 100644 --- a/cmd/cluster/resetsatoken/testdata/TestResetTokenGoldenOutput/reset-with-help.golden +++ b/cmd/cluster/resetsatoken/testdata/TestResetTokenGoldenOutput/reset-with-help.golden @@ -1,8 +1,8 @@ Reset/rotate the Service Account(SA) tokens and additionally restart the corresponding pods to get the latest token data reflected in the pod spec. -Secret-namespace is a mandatory flag and secret-name is optional. If secret-name is not given, all the SA tokens -in that particular namespace is considered, else only that particular input secret-name. +Secret-namespace is a mandatory flag and secret-name is optional. If a secret-name is not specified, all of the SA +tokens in the specified namespace are rotated, else only the specified secret-name. Usage: rotate-sa-token [flags] diff --git a/cmd/cluster/testdata/TestNewKubeConfigCommandCmdGoldenOutput/cluster-get-kubeconfig-cmd-with-help.golden b/cmd/cluster/testdata/TestNewKubeConfigCommandCmdGoldenOutput/cluster-get-kubeconfig-cmd-with-help.golden index 49098c1d5..745206786 100644 --- a/cmd/cluster/testdata/TestNewKubeConfigCommandCmdGoldenOutput/cluster-get-kubeconfig-cmd-with-help.golden +++ b/cmd/cluster/testdata/TestNewKubeConfigCommandCmdGoldenOutput/cluster-get-kubeconfig-cmd-with-help.golden @@ -1,9 +1,9 @@ Retrieves kubeconfig of the cluster and prints it to stdout. -If you specify clusterName, kubeconfig will have a CurrentContext set to clusterName and +If you specify CLUSTER_NAME, kubeconfig will have a CurrentContext set to CLUSTER_NAME and will have its context defined. -If you don't specify clusterName, kubeconfig will have multiple contexts for every cluster +If you don't specify CLUSTER_NAME, kubeconfig will have multiple contexts for every cluster in the airship site. Context names will correspond to cluster names. CurrentContext will be empty. Usage: diff --git a/cmd/cluster/testdata/TestNewListCommandGoldenOutput/cluster-list-cmd-with-help.golden b/cmd/cluster/testdata/TestNewListCommandGoldenOutput/cluster-list-cmd-with-help.golden index 906ecd688..d998bd3e0 100644 --- a/cmd/cluster/testdata/TestNewListCommandGoldenOutput/cluster-list-cmd-with-help.golden +++ b/cmd/cluster/testdata/TestNewListCommandGoldenOutput/cluster-list-cmd-with-help.golden @@ -1,5 +1,6 @@ -Retrieve and list the defined clusters in the table form or display just the name as specified. +Retrieve and list the defined clusters in table form or display just the cluster names. The contents of the +table would include cluster name, kubeconfig context and parent cluster name. Usage: list [flags] diff --git a/cmd/completion/completion.go b/cmd/completion/completion.go index 4e3d88e77..145d65562 100644 --- a/cmd/completion/completion.go +++ b/cmd/completion/completion.go @@ -27,11 +27,11 @@ Generate completion script for airshipctl for the specified shell (bash or zsh). ` completionExample = ` -# Save shell completion to a file -airshipctl completion bash > $HOME/.airship_completions +Save shell completion to a file +# airshipctl completion bash > $HOME/.airship_completions -# Apply completions to the current shell -source <(airshipctl completion bash) +Apply completions to the current shell +# source <(airshipctl completion bash) ` ) @@ -51,7 +51,7 @@ func NewCompletionCommand() *cobra.Command { cmd := &cobra.Command{ Use: "completion SHELL", - Short: "Generate completion script for the specified shell (bash or zsh)", + Short: "Airshipctl command to generate completion script for the specified shell (bash or zsh)", Long: completionLong[1:], Example: completionExample, Args: cobra.ExactArgs(1), diff --git a/cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-few-args.golden b/cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-few-args.golden index 4bb1332fe..e9e52965a 100644 --- a/cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-few-args.golden +++ b/cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-few-args.golden @@ -4,11 +4,11 @@ Usage: Examples: -# Save shell completion to a file -airshipctl completion bash > $HOME/.airship_completions +Save shell completion to a file +# airshipctl completion bash > $HOME/.airship_completions -# Apply completions to the current shell -source <(airshipctl completion bash) +Apply completions to the current shell +# source <(airshipctl completion bash) Flags: diff --git a/cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-many-args.golden b/cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-many-args.golden index 986328590..05eeed103 100644 --- a/cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-many-args.golden +++ b/cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-many-args.golden @@ -4,11 +4,11 @@ Usage: Examples: -# Save shell completion to a file -airshipctl completion bash > $HOME/.airship_completions +Save shell completion to a file +# airshipctl completion bash > $HOME/.airship_completions -# Apply completions to the current shell -source <(airshipctl completion bash) +Apply completions to the current shell +# source <(airshipctl completion bash) Flags: diff --git a/cmd/completion/testdata/TestCompletionGoldenOutput/completion-unknown-shell.golden b/cmd/completion/testdata/TestCompletionGoldenOutput/completion-unknown-shell.golden index 5f4102bc8..a4d04a34e 100644 --- a/cmd/completion/testdata/TestCompletionGoldenOutput/completion-unknown-shell.golden +++ b/cmd/completion/testdata/TestCompletionGoldenOutput/completion-unknown-shell.golden @@ -4,11 +4,11 @@ Usage: Examples: -# Save shell completion to a file -airshipctl completion bash > $HOME/.airship_completions +Save shell completion to a file +# airshipctl completion bash > $HOME/.airship_completions -# Apply completions to the current shell -source <(airshipctl completion bash) +Apply completions to the current shell +# source <(airshipctl completion bash) Flags: diff --git a/cmd/document/document.go b/cmd/document/document.go index c1451cfe3..1cd89a54b 100644 --- a/cmd/document/document.go +++ b/cmd/document/document.go @@ -20,11 +20,16 @@ import ( "opendev.org/airship/airshipctl/pkg/config" ) +const documentLong = ` +Provides commands which help in management of site manifest documents. +` + // NewDocumentCommand creates a new command for managing airshipctl documents func NewDocumentCommand(cfgFactory config.Factory) *cobra.Command { documentRootCmd := &cobra.Command{ Use: "document", - Short: "Manage deployment documents", + Short: "Airshipctl command to manage site manifest documents", + Long: documentLong, } documentRootCmd.AddCommand(NewPullCommand(cfgFactory)) diff --git a/cmd/document/pull.go b/cmd/document/pull.go index a1fb7168f..d5618faff 100644 --- a/cmd/document/pull.go +++ b/cmd/document/pull.go @@ -32,6 +32,12 @@ the repositories will be cloned are defined in the airship config file. By default the airship config file is initialized with the repository "https://opendev.org/airship/treasuremap" as a source of manifests and with the manifests target path "%s". +` + + pullExample = ` +Pull manifests from remote repos +# airshipctl document pull +>>>>>>> Updating cmd files for documentation ` ) @@ -39,17 +45,18 @@ manifests and with the manifests target path "%s". func NewPullCommand(cfgFactory config.Factory) *cobra.Command { var noCheckout bool documentPullCmd := &cobra.Command{ - Use: "pull", - Short: "Pulls documents from remote git repository", + Use: "pull", Long: fmt.Sprintf(long[1:], filepath.Join( config.HomeEnvVar, config.AirshipConfigDir, config.AirshipDefaultManifest)), + Short: "Airshipctl command to pull manifests from remote git repositories", + Example: pullExample, RunE: func(cmd *cobra.Command, args []string) error { return pull.Pull(cfgFactory, noCheckout) }, } documentPullCmd.Flags().BoolVarP(&noCheckout, "no-checkout", "n", false, - "No checkout is performed after the clone is complete.") + "no checkout is performed after the clone is complete.") return documentPullCmd } diff --git a/cmd/document/testdata/TestDocumentGoldenOutput/document-with-help.golden b/cmd/document/testdata/TestDocumentGoldenOutput/document-with-help.golden index e1dd55866..d3076c6c1 100644 --- a/cmd/document/testdata/TestDocumentGoldenOutput/document-with-help.golden +++ b/cmd/document/testdata/TestDocumentGoldenOutput/document-with-help.golden @@ -1,11 +1,12 @@ -Manage deployment documents + +Provides commands which help in management of site manifest documents. Usage: document [command] Available Commands: help Help about any command - pull Pulls documents from remote git repository + pull Airshipctl command to pull manifests from remote git repositories Flags: -h, --help help for document diff --git a/cmd/document/testdata/TestPullGoldenOutput/document-pull-cmd-with-help.golden b/cmd/document/testdata/TestPullGoldenOutput/document-pull-cmd-with-help.golden index a38ae7402..9a874b68c 100644 --- a/cmd/document/testdata/TestPullGoldenOutput/document-pull-cmd-with-help.golden +++ b/cmd/document/testdata/TestPullGoldenOutput/document-pull-cmd-with-help.golden @@ -8,6 +8,13 @@ manifests and with the manifests target path "$HOME/.airship/default". Usage: pull [flags] +Examples: + +Pull manifests from remote repos +# airshipctl document pull +>>>>>>> Updating cmd files for documentation + + Flags: -h, --help help for pull - -n, --no-checkout No checkout is performed after the clone is complete. + -n, --no-checkout no checkout is performed after the clone is complete. diff --git a/cmd/root.go b/cmd/root.go index f04c2e40d..67c3ed41e 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -34,7 +34,7 @@ import ( "opendev.org/airship/airshipctl/pkg/log" ) -const longRoot = `A unified entrypoint to various airship components +const longRoot = `Command line utility for management of end-to-end kubernetes cluster deployment. Find more information at: https://docs.airshipit.org/airshipctl/ ` @@ -57,8 +57,10 @@ func NewAirshipCTLCommand(out io.Writer) *cobra.Command { func NewRootCommand(out io.Writer) (*cobra.Command, *RootOptions) { options := &RootOptions{} rootCmd := &cobra.Command{ - Use: "airshipctl", - Short: "A unified entrypoint to various airship components", + Use: "airshipctl", + Short: "A unified command line tool for management of end-to-end " + + "kubernetes cluster deployment on cloud infrastructure " + + "environments.", Long: longRoot, SilenceErrors: true, SilenceUsage: true, @@ -95,9 +97,6 @@ func initFlags(options *RootOptions, cmd *cobra.Command) { defaultAirshipConfigDir := filepath.Join(cfg.HomeEnvVar, cfg.AirshipConfigDir) defaultAirshipConfigPath := filepath.Join(defaultAirshipConfigDir, cfg.AirshipConfig) - flags.StringVar( - &options.AirshipConfigPath, - "airshipconf", - "", - `Path to file for airshipctl configuration. (default "`+defaultAirshipConfigPath+`")`) + flags.StringVar(&options.AirshipConfigPath, "airshipconf", "", + `path to the airshipctl configuration file. Defaults to "`+defaultAirshipConfigPath+`"`) } diff --git a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden index 50c16f8be..0370e08c5 100644 --- a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden +++ b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden @@ -1,4 +1,4 @@ -A unified entrypoint to various airship components +Command line utility for management of end-to-end kubernetes cluster deployment. Find more information at: https://docs.airshipit.org/airshipctl/ @@ -8,17 +8,17 @@ Usage: Available Commands: baremetal Airshipctl command to manage bare metal host(s) cluster Airshipctl command to manage kubernetes clusters - completion Generate completion script for the specified shell (bash or zsh) + completion Airshipctl command to generate completion script for the specified shell (bash or zsh) config Airshipctl command to manage airshipctl config file - document Manage deployment documents + document Airshipctl command to manage site manifest documents help Help about any command phase Airshipctl command to manage phases plan Airshipctl command to manage plans secret Airshipctl command to manage secrets - version Show the version number of airshipctl + version Airshipctl command to display the current version number Flags: - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output -h, --help help for airshipctl diff --git a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden index 6b941e9ec..cef587f8d 100644 --- a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden +++ b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden @@ -1,4 +1,4 @@ -A unified entrypoint to various airship components +Command line utility for management of end-to-end kubernetes cluster deployment. Find more information at: https://docs.airshipit.org/airshipctl/ diff --git a/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden b/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden index ed05f5364..dfadf970d 100644 --- a/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden +++ b/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden @@ -1,4 +1,4 @@ -A unified entrypoint to various airship components +Command line utility for management of end-to-end kubernetes cluster deployment. Find more information at: https://docs.airshipit.org/airshipctl/ @@ -10,7 +10,7 @@ Available Commands: help Help about any command Flags: - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output -h, --help help for airshipctl diff --git a/cmd/testdata/TestVersionGoldenOutput/version-help.golden b/cmd/testdata/TestVersionGoldenOutput/version-help.golden index 207565558..6959dd932 100644 --- a/cmd/testdata/TestVersionGoldenOutput/version-help.golden +++ b/cmd/testdata/TestVersionGoldenOutput/version-help.golden @@ -1,4 +1,4 @@ -Show the version number of airshipctl +Airshipctl command to display the current version number Usage: version [flags] diff --git a/cmd/version.go b/cmd/version.go index 68ec1db87..d6820d362 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -27,7 +27,7 @@ import ( func NewVersionCommand() *cobra.Command { versionCmd := &cobra.Command{ Use: "version", - Short: "Show the version number of airshipctl", + Short: "Airshipctl command to display the current version number", Run: func(cmd *cobra.Command, args []string) { out := cmd.OutOrStdout() clientV := clientVersion() diff --git a/docs/source/cli/airshipctl.md b/docs/source/cli/airshipctl.md index 89ae40e24..584aae18e 100644 --- a/docs/source/cli/airshipctl.md +++ b/docs/source/cli/airshipctl.md @@ -1,10 +1,10 @@ ## airshipctl -A unified entrypoint to various airship components +A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. ### Synopsis -A unified entrypoint to various airship components +Command line utility for management of end-to-end kubernetes cluster deployment. Find more information at: https://docs.airshipit.org/airshipctl/ @@ -12,7 +12,7 @@ A unified entrypoint to various airship components ### Options ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output -h, --help help for airshipctl ``` @@ -21,11 +21,11 @@ A unified entrypoint to various airship components * [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s) * [airshipctl cluster](airshipctl_cluster.md) - Airshipctl command to manage kubernetes clusters -* [airshipctl completion](airshipctl_completion.md) - Generate completion script for the specified shell (bash or zsh) +* [airshipctl completion](airshipctl_completion.md) - Airshipctl command to generate completion script for the specified shell (bash or zsh) * [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file -* [airshipctl document](airshipctl_document.md) - Manage deployment documents +* [airshipctl document](airshipctl_document.md) - Airshipctl command to manage site manifest documents * [airshipctl phase](airshipctl_phase.md) - Airshipctl command to manage phases * [airshipctl plan](airshipctl_plan.md) - Airshipctl command to manage plans * [airshipctl secret](airshipctl_secret.md) - Airshipctl command to manage secrets -* [airshipctl version](airshipctl_version.md) - Show the version number of airshipctl +* [airshipctl version](airshipctl_version.md) - Airshipctl command to display the current version number diff --git a/docs/source/cli/airshipctl_baremetal.md b/docs/source/cli/airshipctl_baremetal.md index 8988e7105..74bfef503 100644 --- a/docs/source/cli/airshipctl_baremetal.md +++ b/docs/source/cli/airshipctl_baremetal.md @@ -5,7 +5,7 @@ Airshipctl command to manage bare metal host(s) ### Synopsis -Provides commands that can be performed on bare metal host(s). The commands helps in +Provides commands that can be performed on bare metal host(s). The commands help in performing the basic boot and power operations on the bare metal host(s). @@ -18,13 +18,13 @@ performing the basic boot and power operations on the bare metal host(s). ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. * [airshipctl baremetal ejectmedia](airshipctl_baremetal_ejectmedia.md) - Airshipctl command to eject virtual media attached to a bare metal host * [airshipctl baremetal poweroff](airshipctl_baremetal_poweroff.md) - Airshipctl command to shutdown bare metal host(s) * [airshipctl baremetal poweron](airshipctl_baremetal_poweron.md) - Airshipctl command to power on host(s) diff --git a/docs/source/cli/airshipctl_baremetal_ejectmedia.md b/docs/source/cli/airshipctl_baremetal_ejectmedia.md index 1af4252f3..f7e0bb373 100644 --- a/docs/source/cli/airshipctl_baremetal_ejectmedia.md +++ b/docs/source/cli/airshipctl_baremetal_ejectmedia.md @@ -4,8 +4,8 @@ Airshipctl command to eject virtual media attached to a bare metal host ### Synopsis -Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship inventory based on the ---name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship site inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory. @@ -17,16 +17,16 @@ airshipctl baremetal ejectmedia [flags] ``` -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform ejectmedia action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal ejectmedia --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform ejectmedia action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal ejectmedia --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform ejectmedia action against all hosts defined in inventory # airshipctl baremetal ejectmedia --all -Perform action against hosts with a label 'foo=bar' +Perform ejectmedia action against hosts with a label 'foo=bar' # airshipctl baremetal ejectmedia --labels "foo=bar" ``` @@ -34,18 +34,18 @@ Perform action against hosts with a label 'foo=bar' ### Options ``` - --all specify this to target all hosts in the inventory + --all specify this to target all hosts in the site inventory -h, --help help for ejectmedia - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_baremetal_poweroff.md b/docs/source/cli/airshipctl_baremetal_poweroff.md index 9544f2d7e..5de7ee053 100644 --- a/docs/source/cli/airshipctl_baremetal_poweroff.md +++ b/docs/source/cli/airshipctl_baremetal_poweroff.md @@ -4,8 +4,8 @@ Airshipctl command to shutdown bare metal host(s) ### Synopsis -Power off bare metal host(s). The command will target bare metal hosts from airship inventory based on the ---name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +Power off bare metal host(s). The command will target bare metal hosts from airship site inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory. @@ -17,16 +17,16 @@ airshipctl baremetal poweroff [flags] ``` -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform poweroff action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal poweroff --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform poweroff action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal poweroff --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform poweroff action against all hosts defined in inventory # airshipctl baremetal poweroff --all -Perform action against hosts with a label 'foo=bar' +Perform poweroff action against hosts with a label 'foo=bar' # airshipctl baremetal poweroff --labels "foo=bar" ``` @@ -34,18 +34,18 @@ Perform action against hosts with a label 'foo=bar' ### Options ``` - --all specify this to target all hosts in the inventory + --all specify this to target all hosts in the site inventory -h, --help help for poweroff - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_baremetal_poweron.md b/docs/source/cli/airshipctl_baremetal_poweron.md index eade320ad..d41be8169 100644 --- a/docs/source/cli/airshipctl_baremetal_poweron.md +++ b/docs/source/cli/airshipctl_baremetal_poweron.md @@ -4,8 +4,8 @@ Airshipctl command to power on host(s) ### Synopsis -Power on bare metal host(s). The command will target bare metal hosts from airship inventory based on the ---name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +Power on bare metal host(s). The command will target bare metal hosts from airship site inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory. @@ -17,16 +17,16 @@ airshipctl baremetal poweron [flags] ``` -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform poweron action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal poweron --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform poweron action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal poweron --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform poweron action against all hosts defined in inventory # airshipctl baremetal poweron --all -Perform action against hosts with a label 'foo=bar' +Perform poweron action against hosts with a label 'foo=bar' # airshipctl baremetal poweron --labels "foo=bar" ``` @@ -34,18 +34,18 @@ Perform action against hosts with a label 'foo=bar' ### Options ``` - --all specify this to target all hosts in the inventory + --all specify this to target all hosts in the site inventory -h, --help help for poweron - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_baremetal_powerstatus.md b/docs/source/cli/airshipctl_baremetal_powerstatus.md index 0106afd1f..428ff01ba 100644 --- a/docs/source/cli/airshipctl_baremetal_powerstatus.md +++ b/docs/source/cli/airshipctl_baremetal_powerstatus.md @@ -16,13 +16,13 @@ airshipctl baremetal powerstatus [flags] ``` -Perform action against host with name rdm9r3s3 in all namespaces where the host is found +To get power status of host with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal powerstatus --name rdm9r3s3 -Perform action against host with name rdm9r3s3 in namespace metal3 +To get power status of host with name rdm9r3s3 in metal3 namespace # airshipctl baremetal powerstatus --name rdm9r3s3 --namespace metal3 -Perform action against host with a label 'foo=bar' +To get power status of host with a label 'foo=bar' # airshipctl baremetal powerstatus --labels "foo=bar" ``` @@ -31,16 +31,16 @@ Perform action against host with a label 'foo=bar' ``` -h, --help help for powerstatus - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_baremetal_reboot.md b/docs/source/cli/airshipctl_baremetal_reboot.md index 8e531c98d..0de3ccb59 100644 --- a/docs/source/cli/airshipctl_baremetal_reboot.md +++ b/docs/source/cli/airshipctl_baremetal_reboot.md @@ -4,8 +4,8 @@ Airshipctl command to reboot host(s) ### Synopsis -Reboot bare metal host(s). The command will target bare metal hosts from airship inventory based on the ---name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +Reboot bare metal host(s). The command will target bare metal hosts from airship site inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site inventory. @@ -17,16 +17,16 @@ airshipctl baremetal reboot [flags] ``` -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform reboot action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal reboot --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform reboot action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal reboot --name rdm9r3s3 --namespace metal3 -Perform action against all hosts defined in inventory +Perform reboot action against all hosts defined in inventory # airshipctl baremetal reboot --all -Perform action against hosts with a label 'foo=bar' +Perform reboot action against hosts with a label 'foo=bar' # airshipctl baremetal reboot --labels "foo=bar" ``` @@ -34,18 +34,18 @@ Perform action against hosts with a label 'foo=bar' ### Options ``` - --all specify this to target all hosts in the inventory + --all specify this to target all hosts in the site inventory -h, --help help for reboot - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_baremetal_remotedirect.md b/docs/source/cli/airshipctl_baremetal_remotedirect.md index 6f56c2ac0..22ba41323 100644 --- a/docs/source/cli/airshipctl_baremetal_remotedirect.md +++ b/docs/source/cli/airshipctl_baremetal_remotedirect.md @@ -16,13 +16,13 @@ airshipctl baremetal remotedirect [flags] ``` -Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found +Perform bootstrap action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal remotedirect --name rdm9r3s3 -Perform action against hosts with name rdm9r3s3 in namespace metal3 +Perform bootstrap action against hosts with name rdm9r3s3 in metal3 namespace # airshipctl baremetal remotedirect --name rdm9r3s3 --namespace metal3 -Perform action against hosts with a label 'foo=bar' +Perform bootstrap action against hosts with a label 'foo=bar' # airshipctl baremetal remotedirect --labels "foo=bar" ``` @@ -32,16 +32,16 @@ Perform action against hosts with a label 'foo=bar' ``` -h, --help help for remotedirect --iso-url string specify iso url for host to boot from - -l, --labels string label(s) to filter desired bare metal host documents - --name string name to filter desired bare metal host document - -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + -l, --labels string label(s) to filter desired bare metal host from site manifest documents + --name string name to filter desired bare metal host from site manifest document + -n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s) --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_cluster.md b/docs/source/cli/airshipctl_cluster.md index 0b9c677cc..35af97a56 100644 --- a/docs/source/cli/airshipctl_cluster.md +++ b/docs/source/cli/airshipctl_cluster.md @@ -17,13 +17,13 @@ such as getting status and deploying initial infrastructure. ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. * [airshipctl cluster check-certificate-expiration](airshipctl_cluster_check-certificate-expiration.md) - Airshipctl command to check expiring TLS certificates, secrets and kubeconfigs in the kubernetes cluster * [airshipctl cluster get-kubeconfig](airshipctl_cluster_get-kubeconfig.md) - Airshipctl command to retrieve kubeconfig for a desired cluster * [airshipctl cluster list](airshipctl_cluster_list.md) - Airshipctl command to get and list defined clusters diff --git a/docs/source/cli/airshipctl_cluster_check-certificate-expiration.md b/docs/source/cli/airshipctl_cluster_check-certificate-expiration.md index dfaf276c6..22544f6c7 100644 --- a/docs/source/cli/airshipctl_cluster_check-certificate-expiration.md +++ b/docs/source/cli/airshipctl_cluster_check-certificate-expiration.md @@ -17,21 +17,21 @@ airshipctl cluster check-certificate-expiration [flags] ``` -To display all the expiring entities in the cluster +To display all the expiring certificates in the cluster # airshipctl cluster check-certificate-expiration --kubeconfig testconfig -To display the entities whose expiration is within threshold of 30 days +To display the certificates whose expiration is within threshold of 30 days # airshipctl cluster check-certificate-expiration -t 30 --kubeconfig testconfig -To output the contents to json (default operation) +To output the contents in json format (default operation) # airshipctl cluster check-certificate-expiration -o json --kubeconfig testconfig or # airshipctl cluster check-certificate-expiration --kubeconfig testconfig -To output the contents to yaml +To output the contents in yaml format # airshipctl cluster check-certificate-expiration -o yaml --kubeconfig testconfig -To output the contents whose expiration is within 30 days to yaml +To output the contents whose expiration is within 30 days in yaml format # airshipctl cluster check-certificate-expiration -t 30 -o yaml --kubeconfig testconfig ``` @@ -49,7 +49,7 @@ To output the contents whose expiration is within 30 days to yaml ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_cluster_get-kubeconfig.md b/docs/source/cli/airshipctl_cluster_get-kubeconfig.md index 28bf7c8b8..32817aef6 100644 --- a/docs/source/cli/airshipctl_cluster_get-kubeconfig.md +++ b/docs/source/cli/airshipctl_cluster_get-kubeconfig.md @@ -6,10 +6,10 @@ Airshipctl command to retrieve kubeconfig for a desired cluster Retrieves kubeconfig of the cluster and prints it to stdout. -If you specify clusterName, kubeconfig will have a CurrentContext set to clusterName and +If you specify CLUSTER_NAME, kubeconfig will have a CurrentContext set to CLUSTER_NAME and will have its context defined. -If you don't specify clusterName, kubeconfig will have multiple contexts for every cluster +If you don't specify CLUSTER_NAME, kubeconfig will have multiple contexts for every cluster in the airship site. Context names will correspond to cluster names. CurrentContext will be empty. @@ -38,7 +38,7 @@ Retrieve kubeconfig for the entire site; the kubeconfig will have context for ev ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_cluster_list.md b/docs/source/cli/airshipctl_cluster_list.md index a6c801568..5859e59d8 100644 --- a/docs/source/cli/airshipctl_cluster_list.md +++ b/docs/source/cli/airshipctl_cluster_list.md @@ -5,7 +5,8 @@ Airshipctl command to get and list defined clusters ### Synopsis -Retrieve and list the defined clusters in the table form or display just the name as specified. +Retrieve and list the defined clusters in table form or display just the cluster names. The contents of the +table would include cluster name, kubeconfig context and parent cluster name. ``` @@ -33,7 +34,7 @@ Retrieve list of clusters ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_cluster_rotate-sa-token.md b/docs/source/cli/airshipctl_cluster_rotate-sa-token.md index 190194f9b..c6f9ac45e 100644 --- a/docs/source/cli/airshipctl_cluster_rotate-sa-token.md +++ b/docs/source/cli/airshipctl_cluster_rotate-sa-token.md @@ -7,8 +7,8 @@ Airshipctl command to rotate tokens of Service Account(s) Reset/rotate the Service Account(SA) tokens and additionally restart the corresponding pods to get the latest token data reflected in the pod spec. -Secret-namespace is a mandatory flag and secret-name is optional. If secret-name is not given, all the SA tokens -in that particular namespace is considered, else only that particular input secret-name. +Secret-namespace is a mandatory flag and secret-name is optional. If a secret-name is not specified, all of the SA +tokens in the specified namespace are rotated, else only the specified secret-name. ``` @@ -39,7 +39,7 @@ To rotate all the SA tokens in cert-manager namespace ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_cluster_status.md b/docs/source/cli/airshipctl_cluster_status.md index 99cd3e50b..d9b998b98 100644 --- a/docs/source/cli/airshipctl_cluster_status.md +++ b/docs/source/cli/airshipctl_cluster_status.md @@ -20,7 +20,7 @@ airshipctl cluster status [flags] ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_completion.md b/docs/source/cli/airshipctl_completion.md index e54bbdbe6..6e480b6ce 100644 --- a/docs/source/cli/airshipctl_completion.md +++ b/docs/source/cli/airshipctl_completion.md @@ -1,6 +1,6 @@ ## airshipctl completion -Generate completion script for the specified shell (bash or zsh) +Airshipctl command to generate completion script for the specified shell (bash or zsh) ### Synopsis @@ -15,11 +15,11 @@ airshipctl completion SHELL [flags] ``` -# Save shell completion to a file -airshipctl completion bash > $HOME/.airship_completions +Save shell completion to a file +# airshipctl completion bash > $HOME/.airship_completions -# Apply completions to the current shell -source <(airshipctl completion bash) +Apply completions to the current shell +# source <(airshipctl completion bash) ``` @@ -32,11 +32,11 @@ source <(airshipctl completion bash) ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. diff --git a/docs/source/cli/airshipctl_config.md b/docs/source/cli/airshipctl_config.md index ca093fb39..f82814e60 100644 --- a/docs/source/cli/airshipctl_config.md +++ b/docs/source/cli/airshipctl_config.md @@ -17,13 +17,13 @@ Provides commands which can be used to manage the airshipctl config file. ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. * [airshipctl config get-context](airshipctl_config_get-context.md) - Airshipctl command to get context(s) information from the airshipctl config * [airshipctl config get-management-config](airshipctl_config_get-management-config.md) - Airshipctl command to view management config(s) defined in the airshipctl config * [airshipctl config get-manifest](airshipctl_config_get-manifest.md) - Airshipctl command to get a specific or all manifest(s) information from the airshipctl config diff --git a/docs/source/cli/airshipctl_config_get-context.md b/docs/source/cli/airshipctl_config_get-context.md index b9950e2d2..cd938e48c 100644 --- a/docs/source/cli/airshipctl_config_get-context.md +++ b/docs/source/cli/airshipctl_config_get-context.md @@ -38,7 +38,7 @@ Display a specific context ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_config_get-management-config.md b/docs/source/cli/airshipctl_config_get-management-config.md index 0312c9236..e855a88b5 100644 --- a/docs/source/cli/airshipctl_config_get-management-config.md +++ b/docs/source/cli/airshipctl_config_get-management-config.md @@ -34,7 +34,7 @@ View a specific management configuration named "default" ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_config_get-manifest.md b/docs/source/cli/airshipctl_config_get-manifest.md index c7ecbec53..a8eee2ee2 100644 --- a/docs/source/cli/airshipctl_config_get-manifest.md +++ b/docs/source/cli/airshipctl_config_get-manifest.md @@ -33,7 +33,7 @@ Display a specific manifest ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_config_init.md b/docs/source/cli/airshipctl_config_init.md index d55e9bb9b..8e172d780 100644 --- a/docs/source/cli/airshipctl_config_init.md +++ b/docs/source/cli/airshipctl_config_init.md @@ -39,7 +39,7 @@ To create new airshipctl config file at the custom location and overwrite it ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_config_set-context.md b/docs/source/cli/airshipctl_config_set-context.md index 88e046b47..fa1f9b343 100644 --- a/docs/source/cli/airshipctl_config_set-context.md +++ b/docs/source/cli/airshipctl_config_set-context.md @@ -36,7 +36,7 @@ To update the manifest of the current-context ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_config_set-management-config.md b/docs/source/cli/airshipctl_config_set-management-config.md index 832dc3226..bb49c4512 100644 --- a/docs/source/cli/airshipctl_config_set-management-config.md +++ b/docs/source/cli/airshipctl_config_set-management-config.md @@ -43,7 +43,7 @@ Enable proxy for "test" management configuration ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_config_set-manifest.md b/docs/source/cli/airshipctl_config_set-manifest.md index 93a7b785e..b20fd4d2b 100644 --- a/docs/source/cli/airshipctl_config_set-manifest.md +++ b/docs/source/cli/airshipctl_config_set-manifest.md @@ -48,7 +48,7 @@ Change the target-path for manifest ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_config_use-context.md b/docs/source/cli/airshipctl_config_use-context.md index ba36a6322..0d31fe4bf 100644 --- a/docs/source/cli/airshipctl_config_use-context.md +++ b/docs/source/cli/airshipctl_config_use-context.md @@ -30,7 +30,7 @@ Switch to a context named "exampleContext" in airshipctl config file ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_document.md b/docs/source/cli/airshipctl_document.md index b913878d9..4b353d7ef 100644 --- a/docs/source/cli/airshipctl_document.md +++ b/docs/source/cli/airshipctl_document.md @@ -1,10 +1,12 @@ ## airshipctl document -Manage deployment documents +Airshipctl command to manage site manifest documents ### Synopsis -Manage deployment documents + +Provides commands which help in management of site manifest documents. + ### Options @@ -15,12 +17,12 @@ Manage deployment documents ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components -* [airshipctl document pull](airshipctl_document_pull.md) - Pulls documents from remote git repository +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. +* [airshipctl document pull](airshipctl_document_pull.md) - Airshipctl command to pull manifests from remote git repositories diff --git a/docs/source/cli/airshipctl_document_pull.md b/docs/source/cli/airshipctl_document_pull.md index 7b4500f48..708c30205 100644 --- a/docs/source/cli/airshipctl_document_pull.md +++ b/docs/source/cli/airshipctl_document_pull.md @@ -1,6 +1,6 @@ ## airshipctl document pull -Pulls documents from remote git repository +Airshipctl command to pull manifests from remote git repositories ### Synopsis @@ -16,21 +16,31 @@ manifests and with the manifests target path "$HOME/.airship/default". airshipctl document pull [flags] ``` +### Examples + +``` + +Pull manifests from remote repos +# airshipctl document pull +>>>>>>> Updating cmd files for documentation + +``` + ### Options ``` -h, --help help for pull - -n, --no-checkout No checkout is performed after the clone is complete. + -n, --no-checkout no checkout is performed after the clone is complete. ``` ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl document](airshipctl_document.md) - Manage deployment documents +* [airshipctl document](airshipctl_document.md) - Airshipctl command to manage site manifest documents diff --git a/docs/source/cli/airshipctl_phase.md b/docs/source/cli/airshipctl_phase.md index 762ccf054..abf5dc477 100644 --- a/docs/source/cli/airshipctl_phase.md +++ b/docs/source/cli/airshipctl_phase.md @@ -16,13 +16,13 @@ Provides capabilities for interacting with phases, such as getting list of phase ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. * [airshipctl phase list](airshipctl_phase_list.md) - Airshipctl command to list phases * [airshipctl phase render](airshipctl_phase_render.md) - Airshipctl command to render phase documents from model * [airshipctl phase run](airshipctl_phase_run.md) - Airshipctl command to run phase diff --git a/docs/source/cli/airshipctl_phase_list.md b/docs/source/cli/airshipctl_phase_list.md index 9e442b9b8..274064f2b 100644 --- a/docs/source/cli/airshipctl_phase_list.md +++ b/docs/source/cli/airshipctl_phase_list.md @@ -45,7 +45,7 @@ List phases with clustername ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_phase_render.md b/docs/source/cli/airshipctl_phase_render.md index 2ded14205..af3592fcc 100644 --- a/docs/source/cli/airshipctl_phase_render.md +++ b/docs/source/cli/airshipctl_phase_render.md @@ -47,7 +47,7 @@ Get all documents executor rendered documents for a phase ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_phase_run.md b/docs/source/cli/airshipctl_phase_run.md index 9557da4af..f987cab05 100644 --- a/docs/source/cli/airshipctl_phase_run.md +++ b/docs/source/cli/airshipctl_phase_run.md @@ -33,7 +33,7 @@ Run initinfra phase ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_phase_status.md b/docs/source/cli/airshipctl_phase_status.md index c69b43a60..b41538f76 100644 --- a/docs/source/cli/airshipctl_phase_status.md +++ b/docs/source/cli/airshipctl_phase_status.md @@ -31,7 +31,7 @@ Status of initinfra phase ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_phase_tree.md b/docs/source/cli/airshipctl_phase_tree.md index 20126ad06..1e9bb909b 100644 --- a/docs/source/cli/airshipctl_phase_tree.md +++ b/docs/source/cli/airshipctl_phase_tree.md @@ -32,7 +32,7 @@ yaml explorer of a phase with phase name ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_phase_validate.md b/docs/source/cli/airshipctl_phase_validate.md index 4defc6bbd..9e7b8216b 100644 --- a/docs/source/cli/airshipctl_phase_validate.md +++ b/docs/source/cli/airshipctl_phase_validate.md @@ -30,7 +30,7 @@ To validate initinfra phase ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_plan.md b/docs/source/cli/airshipctl_plan.md index 58b719f2f..8e8d4929d 100644 --- a/docs/source/cli/airshipctl_plan.md +++ b/docs/source/cli/airshipctl_plan.md @@ -16,13 +16,13 @@ Provides capabilities for interacting with plan objects, responsible for executi ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. * [airshipctl plan list](airshipctl_plan_list.md) - Airshipctl command to list plans * [airshipctl plan run](airshipctl_plan_run.md) - Airshipctl command to run plan * [airshipctl plan validate](airshipctl_plan_validate.md) - Airshipctl command to validate plan diff --git a/docs/source/cli/airshipctl_plan_list.md b/docs/source/cli/airshipctl_plan_list.md index eddb60d2b..a3dc870bd 100644 --- a/docs/source/cli/airshipctl_plan_list.md +++ b/docs/source/cli/airshipctl_plan_list.md @@ -35,7 +35,7 @@ List plan(table output format) ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_plan_run.md b/docs/source/cli/airshipctl_plan_run.md index 3d1fb274b..824bc552a 100644 --- a/docs/source/cli/airshipctl_plan_run.md +++ b/docs/source/cli/airshipctl_plan_run.md @@ -35,7 +35,7 @@ Perform a dry run of a plan ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_plan_validate.md b/docs/source/cli/airshipctl_plan_validate.md index 8439e01d3..1076f35cc 100644 --- a/docs/source/cli/airshipctl_plan_validate.md +++ b/docs/source/cli/airshipctl_plan_validate.md @@ -30,7 +30,7 @@ Validate plan named iso ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_secret.md b/docs/source/cli/airshipctl_secret.md index 69e3f4f6c..a0ce694a0 100644 --- a/docs/source/cli/airshipctl_secret.md +++ b/docs/source/cli/airshipctl_secret.md @@ -15,12 +15,12 @@ Commands and sub-commnads defined can be used to manage secrets. ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments. * [airshipctl secret generate](airshipctl_secret_generate.md) - Airshipctl command to generate secrets diff --git a/docs/source/cli/airshipctl_secret_generate.md b/docs/source/cli/airshipctl_secret_generate.md index f5b4350c4..6ebf84f9f 100644 --- a/docs/source/cli/airshipctl_secret_generate.md +++ b/docs/source/cli/airshipctl_secret_generate.md @@ -15,7 +15,7 @@ Airshipctl command to generate secrets ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_secret_generate_encryptionkey.md b/docs/source/cli/airshipctl_secret_generate_encryptionkey.md index c092bb2e8..0d813365f 100644 --- a/docs/source/cli/airshipctl_secret_generate_encryptionkey.md +++ b/docs/source/cli/airshipctl_secret_generate_encryptionkey.md @@ -36,7 +36,7 @@ Generates a secure encryption key or passphrase matching the regular expression ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` diff --git a/docs/source/cli/airshipctl_version.md b/docs/source/cli/airshipctl_version.md index 228f64c40..6f6e299ee 100644 --- a/docs/source/cli/airshipctl_version.md +++ b/docs/source/cli/airshipctl_version.md @@ -1,10 +1,10 @@ ## airshipctl version -Show the version number of airshipctl +Airshipctl command to display the current version number ### Synopsis -Show the version number of airshipctl +Airshipctl command to display the current version number ``` airshipctl version [flags] @@ -19,11 +19,11 @@ airshipctl version [flags] ### Options inherited from parent commands ``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") + --airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config" --debug enable verbose output ``` ### SEE ALSO -* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components +* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.