airship/airshipctl
Code Issues Proposed changes

Updating cmd files for documentation

Browse Source 
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
This commit is contained in:
Sirisha Gopigiri 2021-05-06 15:40:29 +05:30
parent 14ef1f8680
commit 21f015b502
73 changed files with 297 additions and 263 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
cmd/baremetal/baremetal.go
View File

@ -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"
`
)

6
cmd/baremetal/powerstatus.go
View File

@ -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"
`
)

6
cmd/baremetal/remotedirect.go
View File

@ -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"
`
)

20
cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden vendored
View File

@ -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)

20
cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden vendored
View File

@ -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)

20
cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden vendored
View File

@ -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)

12
cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden vendored
View File

@ -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)

20
cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden vendored
View File

@ -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)

12
cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden vendored
View File

@ -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)

2
cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden vendored
View File

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

10
cmd/cluster/checkexpiration/checkexpiration.go
View File

@ -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
`

10
cmd/cluster/checkexpiration/testdata/TestCheckExpirationGoldenOutput/check-expiration-with-help.golden vendored
View File

@ -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

4
cmd/cluster/get_kubeconfig.go
View File

@ -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 = `

3
cmd/cluster/list.go
View File

@ -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 = `

4
cmd/cluster/resetsatoken/resetsatoken.go
View File

@ -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 = `

4
cmd/cluster/resetsatoken/testdata/TestResetTokenGoldenOutput/reset-with-help.golden vendored
View File

@ -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]

4
cmd/cluster/testdata/TestNewKubeConfigCommandCmdGoldenOutput/cluster-get-kubeconfig-cmd-with-help.golden vendored
View File

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

3
cmd/cluster/testdata/TestNewListCommandGoldenOutput/cluster-list-cmd-with-help.golden vendored
View File

@ -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]

10
cmd/completion/completion.go
View File

@ -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),

8
cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-few-args.golden vendored
View File

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

8
cmd/completion/testdata/TestCompletionGoldenOutput/completion-cmd-too-many-args.golden vendored
View File

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

8
cmd/completion/testdata/TestCompletionGoldenOutput/completion-unknown-shell.golden vendored
View File

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

7
cmd/document/document.go
View File

@ -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))

11
cmd/document/pull.go
View File

@ -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
`
)
@ -40,16 +46,17 @@ func NewPullCommand(cfgFactory config.Factory) *cobra.Command {
var noCheckout bool
documentPullCmd := &cobra.Command{
Use: "pull",
Short: "Pulls documents from remote git repository",
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
}

5
cmd/document/testdata/TestDocumentGoldenOutput/document-with-help.golden vendored
View File

@ -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

9
cmd/document/testdata/TestPullGoldenOutput/document-pull-cmd-with-help.golden vendored
View File

@ -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.

13
cmd/root.go
View File

@ -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/
`
@ -58,7 +58,9 @@ func NewRootCommand(out io.Writer) (*cobra.Command, *RootOptions) {
options := &RootOptions{}
rootCmd := &cobra.Command{
Use: "airshipctl",
Short: "A unified entrypoint to various airship components",
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+`"`)
}

10
cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden vendored
View File

@ -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

2
cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden vendored
View File

@ -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/

4
cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden vendored
View File

@ -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

2
cmd/testdata/TestVersionGoldenOutput/version-help.golden vendored
View File

@ -1,4 +1,4 @@
Show the version number of airshipctl
Airshipctl command to display the current version number
Usage:
version [flags]

2
cmd/version.go
View File

@ -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()

12
docs/source/cli/airshipctl.md
View File

@ -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

6
docs/source/cli/airshipctl_baremetal.md
View File

@ -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)

22
docs/source/cli/airshipctl_baremetal_ejectmedia.md
View File

@ -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
```

22
docs/source/cli/airshipctl_baremetal_poweroff.md
View File

@ -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
```

22
docs/source/cli/airshipctl_baremetal_poweron.md
View File

@ -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
```

14
docs/source/cli/airshipctl_baremetal_powerstatus.md
View File

@ -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
```

22
docs/source/cli/airshipctl_baremetal_reboot.md
View File

@ -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
```

14
docs/source/cli/airshipctl_baremetal_remotedirect.md
View File

@ -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
```

4
docs/source/cli/airshipctl_cluster.md
View File

@ -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

12
docs/source/cli/airshipctl_cluster_check-certificate-expiration.md
View File

@ -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
```

6
docs/source/cli/airshipctl_cluster_get-kubeconfig.md
View File

@ -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
```

5
docs/source/cli/airshipctl_cluster_list.md
View File

@ -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
```

6
docs/source/cli/airshipctl_cluster_rotate-sa-token.md
View File

@ -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
```

2
docs/source/cli/airshipctl_cluster_status.md
View File

@ -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
```

14
docs/source/cli/airshipctl_completion.md
View File

@ -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.

4
docs/source/cli/airshipctl_config.md
View File

@ -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

2
docs/source/cli/airshipctl_config_get-context.md
View File

@ -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
```

2
docs/source/cli/airshipctl_config_get-management-config.md
View File

@ -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
```

2
docs/source/cli/airshipctl_config_get-manifest.md
View File

@ -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
```

2
docs/source/cli/airshipctl_config_init.md
View File

@ -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
```

2
docs/source/cli/airshipctl_config_set-context.md
View File

@ -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
```

2
docs/source/cli/airshipctl_config_set-management-config.md
View File

@ -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
```

2
docs/source/cli/airshipctl_config_set-manifest.md
View File

@ -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
```

2
docs/source/cli/airshipctl_config_use-context.md
View File

@ -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
```

12
docs/source/cli/airshipctl_document.md
View File

@ -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

18
docs/source/cli/airshipctl_document_pull.md
View File

@ -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

4
docs/source/cli/airshipctl_phase.md
View File

@ -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

2
docs/source/cli/airshipctl_phase_list.md
View File

@ -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
```

2
docs/source/cli/airshipctl_phase_render.md
View File

@ -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
```

2
docs/source/cli/airshipctl_phase_run.md
View File

@ -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
```

2
docs/source/cli/airshipctl_phase_status.md
View File

@ -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
```

2
docs/source/cli/airshipctl_phase_tree.md
View File

@ -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
```

2
docs/source/cli/airshipctl_phase_validate.md
View File

@ -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
```

4
docs/source/cli/airshipctl_plan.md
View File

@ -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

2
docs/source/cli/airshipctl_plan_list.md
View File

@ -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
```

2
docs/source/cli/airshipctl_plan_run.md
View File

@ -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
```

2
docs/source/cli/airshipctl_plan_validate.md
View File

@ -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
```

4
docs/source/cli/airshipctl_secret.md
View File

@ -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

2
docs/source/cli/airshipctl_secret_generate.md
View File

@ -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
```

2
docs/source/cli/airshipctl_secret_generate_encryptionkey.md
View File

@ -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
```

8
docs/source/cli/airshipctl_version.md
View File

@ -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.