Separate folders-Create airshipctl cli user guide documentation
Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org
Steps to render the document locally
* Install sphinx: python3 -m pip install sphinx
* Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
* Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
* Run local server: cd _build; python3 -m http.server
* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document
Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352
This commit is contained in:
Sirisha Gopigiri
parent
261a0d4b8a
commit
4da8a54887
@ -76,7 +76,7 @@ func NewBaremetalCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
baremetalRootCmd := &cobra.Command{
|
baremetalRootCmd := &cobra.Command{
|
||||||
Use: "baremetal",
|
Use: "baremetal",
|
||||||
Short: "Airshipctl command to manage bare metal host(s)",
|
Short: "Airshipctl command to manage bare metal host(s)",
|
||||||
Long: baremetalLong,
|
Long: baremetalLong[1:],
|
||||||
}
|
}
|
||||||
|
|
||||||
baremetalRootCmd.AddCommand(NewEjectMediaCommand(cfgFactory, options))
|
baremetalRootCmd.AddCommand(NewEjectMediaCommand(cfgFactory, options))
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Provides commands that can be performed on bare metal host(s). The commands help 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).
|
performing the basic boot and power operations on the bare metal host(s).
|
||||||
|
|
||||||
|
|||||||
@ -41,7 +41,7 @@ func NewListCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "list",
|
Use: "list",
|
||||||
Short: "Airshipctl command to get and list defined clusters",
|
Short: "Airshipctl command to get and list defined clusters",
|
||||||
Long: listLong,
|
Long: listLong[1:],
|
||||||
Example: listExample,
|
Example: listExample,
|
||||||
RunE: listRunE(o),
|
RunE: listRunE(o),
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Retrieve and list the defined clusters in table form or display just the cluster names. The contents of the
|
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.
|
table would include cluster name, kubeconfig context and parent cluster name.
|
||||||
|
|
||||||
|
|||||||
@ -30,7 +30,7 @@ func NewConfigCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
Use: "config",
|
Use: "config",
|
||||||
DisableFlagsInUseLine: true,
|
DisableFlagsInUseLine: true,
|
||||||
Short: "Airshipctl command to manage airshipctl config file",
|
Short: "Airshipctl command to manage airshipctl config file",
|
||||||
Long: configLong,
|
Long: configLong[1:],
|
||||||
}
|
}
|
||||||
|
|
||||||
configRootCmd.AddCommand(NewGetContextCommand(cfgFactory))
|
configRootCmd.AddCommand(NewGetContextCommand(cfgFactory))
|
||||||
|
|||||||
@ -43,7 +43,7 @@ func NewGetManagementConfigCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "get-management-config MGMT_CONFIG_NAME",
|
Use: "get-management-config MGMT_CONFIG_NAME",
|
||||||
Short: "Airshipctl command to view management config(s) defined in the airshipctl config",
|
Short: "Airshipctl command to view management config(s) defined in the airshipctl config",
|
||||||
Long: getManagementConfigLong,
|
Long: getManagementConfigLong[1:],
|
||||||
Example: getManagementConfigExample,
|
Example: getManagementConfigExample,
|
||||||
Args: cobra.MaximumNArgs(1),
|
Args: cobra.MaximumNArgs(1),
|
||||||
Aliases: []string{"get-management-configs"},
|
Aliases: []string{"get-management-configs"},
|
||||||
|
|||||||
@ -62,7 +62,7 @@ func NewSetManagementConfigCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "set-management-config MGMT_CONFIG_NAME",
|
Use: "set-management-config MGMT_CONFIG_NAME",
|
||||||
Short: "Airshipctl command to create/modify out-of-band management configuration in airshipctl config file",
|
Short: "Airshipctl command to create/modify out-of-band management configuration in airshipctl config file",
|
||||||
Long: setManagementConfigLong,
|
Long: setManagementConfigLong[1:],
|
||||||
Example: setManagementConfigExample,
|
Example: setManagementConfigExample,
|
||||||
Args: cobra.ExactArgs(1),
|
Args: cobra.ExactArgs(1),
|
||||||
RunE: setManagementConfigRunE(cfgFactory, o),
|
RunE: setManagementConfigRunE(cfgFactory, o),
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Provides commands which can be used to manage the airshipctl config file.
|
Provides commands which can be used to manage the airshipctl config file.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Creates or modifies management config information based on the MGMT_CONFIG_NAME passed. The allowed set
|
Creates or modifies management config information based on the MGMT_CONFIG_NAME passed. The allowed set
|
||||||
of optional flags are management-type, system-action-retries and system-reboot-delay. Use --use-proxy
|
of optional flags are management-type, system-action-retries and system-reboot-delay. Use --use-proxy
|
||||||
and --insecure to enable proxy and insecure options respectively.
|
and --insecure to enable proxy and insecure options respectively.
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Displays a specific management config information, or all defined management configs if no name is provided.
|
Displays a specific management config information, or all defined management configs if no name is provided.
|
||||||
The information relates to reboot-delays and retry in seconds along with management-type that has to be used.
|
The information relates to reboot-delays and retry in seconds along with management-type that has to be used.
|
||||||
|
|
||||||
|
|||||||
@ -29,7 +29,7 @@ func NewDocumentCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
documentRootCmd := &cobra.Command{
|
documentRootCmd := &cobra.Command{
|
||||||
Use: "document",
|
Use: "document",
|
||||||
Short: "Airshipctl command to manage site manifest documents",
|
Short: "Airshipctl command to manage site manifest documents",
|
||||||
Long: documentLong,
|
Long: documentLong[1:],
|
||||||
}
|
}
|
||||||
|
|
||||||
documentRootCmd.AddCommand(NewPullCommand(cfgFactory))
|
documentRootCmd.AddCommand(NewPullCommand(cfgFactory))
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Provides commands which help in management of site manifest documents.
|
Provides commands which help in management of site manifest documents.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|||||||
@ -47,7 +47,7 @@ func NewRenderCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
renderCmd := &cobra.Command{
|
renderCmd := &cobra.Command{
|
||||||
Use: "render PHASE_NAME",
|
Use: "render PHASE_NAME",
|
||||||
Short: "Airshipctl command to render phase documents from model",
|
Short: "Airshipctl command to render phase documents from model",
|
||||||
Long: renderLong,
|
Long: renderLong[1:],
|
||||||
Example: renderExample,
|
Example: renderExample,
|
||||||
Args: RenderArgs(filterOptions),
|
Args: RenderArgs(filterOptions),
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
|||||||
@ -44,7 +44,7 @@ func NewRunCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
runCmd := &cobra.Command{
|
runCmd := &cobra.Command{
|
||||||
Use: "run PHASE_NAME",
|
Use: "run PHASE_NAME",
|
||||||
Short: "Airshipctl command to run phase",
|
Short: "Airshipctl command to run phase",
|
||||||
Long: runLong,
|
Long: runLong[1:],
|
||||||
Args: cobra.ExactArgs(1),
|
Args: cobra.ExactArgs(1),
|
||||||
Example: runExample,
|
Example: runExample,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
|||||||
@ -42,7 +42,7 @@ func NewStatusCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
statusCmd := &cobra.Command{
|
statusCmd := &cobra.Command{
|
||||||
Use: "status PHASE_NAME",
|
Use: "status PHASE_NAME",
|
||||||
Short: "Airshipctl command to show status of the phase",
|
Short: "Airshipctl command to show status of the phase",
|
||||||
Long: statusLong,
|
Long: statusLong[1:],
|
||||||
Args: cobra.ExactArgs(1),
|
Args: cobra.ExactArgs(1),
|
||||||
Example: statusExample,
|
Example: statusExample,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Render documents for a phase.
|
Render documents for a phase.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Run a phase such as controlplane-ephemeral, remotedirect-ephemeral, initinfra-ephemeral, etc...
|
Run a phase such as controlplane-ephemeral, remotedirect-ephemeral, initinfra-ephemeral, etc...
|
||||||
To list the phases associated with a site, run 'airshipctl phase list'.
|
To list the phases associated with a site, run 'airshipctl phase list'.
|
||||||
|
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Get the status of a phase such as ephemeral-control-plane, target-initinfra etc...
|
Get the status of a phase such as ephemeral-control-plane, target-initinfra etc...
|
||||||
To list the phases associated with a site, run 'airshipctl phase list'.
|
To list the phases associated with a site, run 'airshipctl phase list'.
|
||||||
|
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
Validates phase and its documents. To list the phases associated with a site, run 'airshipctl phase list'.
|
Validates phase and its documents. To list the phases associated with a site, run 'airshipctl phase list'.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|||||||
@ -41,7 +41,7 @@ func NewValidateCommand(cfgFactory config.Factory) *cobra.Command {
|
|||||||
validCmd := &cobra.Command{
|
validCmd := &cobra.Command{
|
||||||
Use: "validate PHASE_NAME",
|
Use: "validate PHASE_NAME",
|
||||||
Short: "Airshipctl command to validate phase and its documents",
|
Short: "Airshipctl command to validate phase and its documents",
|
||||||
Long: validLong,
|
Long: validLong[1:],
|
||||||
Args: cobra.ExactArgs(1),
|
Args: cobra.ExactArgs(1),
|
||||||
Example: validExample,
|
Example: validExample,
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
|||||||
@ -1,31 +0,0 @@
|
|||||||
## airshipctl
|
|
||||||
|
|
||||||
A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Command line utility for management of end-to-end kubernetes cluster deployment.
|
|
||||||
|
|
||||||
Find more information at: https://docs.airshipit.org/airshipctl/
|
|
||||||
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
-h, --help help for airshipctl
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [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) - 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) - 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) - Airshipctl command to display the current version number
|
|
||||||
|
|
||||||
38
docs/source/cli/airshipctl.rst
Normal file
38
docs/source/cli/airshipctl.rst
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
.. _airshipctl:
|
||||||
|
|
||||||
|
airshipctl
|
||||||
|
----------
|
||||||
|
|
||||||
|
A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Command line utility for management of end-to-end kubernetes cluster deployment.
|
||||||
|
|
||||||
|
Find more information at: https://docs.airshipit.org/airshipctl/
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
-h, --help help for airshipctl
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl baremetal <airshipctl_baremetal>` - Airshipctl command to manage bare metal host(s)
|
||||||
|
* :ref:`airshipctl cluster <airshipctl_cluster>` - Airshipctl command to manage kubernetes clusters
|
||||||
|
* :ref:`airshipctl completion <airshipctl_completion>` - Airshipctl command to generate completion script for the specified shell (bash or zsh)
|
||||||
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
* :ref:`airshipctl document <airshipctl_document>` - Airshipctl command to manage site manifest documents
|
||||||
|
* :ref:`airshipctl phase <airshipctl_phase>` - Airshipctl command to manage phases
|
||||||
|
* :ref:`airshipctl plan <airshipctl_plan>` - Airshipctl command to manage plans
|
||||||
|
* :ref:`airshipctl secret <airshipctl_secret>` - Airshipctl command to manage secrets
|
||||||
|
* :ref:`airshipctl version <airshipctl_version>` - Airshipctl command to display the current version number
|
||||||
|
|
||||||
@ -1,34 +0,0 @@
|
|||||||
## airshipctl baremetal
|
|
||||||
|
|
||||||
Airshipctl command to manage bare metal host(s)
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
|
|
||||||
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).
|
|
||||||
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for baremetal
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [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)
|
|
||||||
* [airshipctl baremetal powerstatus](airshipctl_baremetal_powerstatus.md) - Airshipctl command to retrieve the power status of a bare metal host
|
|
||||||
* [airshipctl baremetal reboot](airshipctl_baremetal_reboot.md) - Airshipctl command to reboot host(s)
|
|
||||||
* [airshipctl baremetal remotedirect](airshipctl_baremetal_remotedirect.md) - Airshipctl command to bootstrap the ephemeral host
|
|
||||||
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
## airshipctl cluster
|
|
||||||
|
|
||||||
Airshipctl command to manage kubernetes clusters
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Provides capabilities for interacting with a Kubernetes cluster,
|
|
||||||
such as getting status and deploying initial infrastructure.
|
|
||||||
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for cluster
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [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
|
|
||||||
* [airshipctl cluster rotate-sa-token](airshipctl_cluster_rotate-sa-token.md) - Airshipctl command to rotate tokens of Service Account(s)
|
|
||||||
* [airshipctl cluster status](airshipctl_cluster_status.md) - Retrieve statuses of deployed cluster components
|
|
||||||
|
|
||||||
@ -1,59 +0,0 @@
|
|||||||
## airshipctl cluster check-certificate-expiration
|
|
||||||
|
|
||||||
Airshipctl command to check expiring TLS certificates, secrets and kubeconfigs in the kubernetes cluster
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Displays a list of certificate along with expirations from both the management and workload clusters, or in a
|
|
||||||
self-managed cluster. Checks for TLS Secrets, kubeconf secrets (which gets created while creating the
|
|
||||||
workload cluster) and also the node certificates present inside /etc/kubernetes/pki directory for each node.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl cluster check-certificate-expiration [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
To display all the expiring certificates in the cluster
|
|
||||||
# airshipctl cluster check-certificate-expiration --kubeconfig testconfig
|
|
||||||
|
|
||||||
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 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 in yaml format
|
|
||||||
# airshipctl cluster check-certificate-expiration -o yaml --kubeconfig testconfig
|
|
||||||
|
|
||||||
To output the contents whose expiration is within 30 days in yaml format
|
|
||||||
# airshipctl cluster check-certificate-expiration -t 30 -o yaml --kubeconfig testconfig
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for check-certificate-expiration
|
|
||||||
--kubeconfig string path to kubeconfig associated with cluster being managed
|
|
||||||
--kubecontext string kubeconfig context to be used
|
|
||||||
-o, --output string convert output to yaml or json (default "json")
|
|
||||||
-t, --threshold int the max expiration threshold in days before a certificate is expiring. Displays all the certificates by default (default -1)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl cluster](airshipctl_cluster.md) - Airshipctl command to manage kubernetes clusters
|
|
||||||
|
|
||||||
@ -1,58 +0,0 @@
|
|||||||
## airshipctl cluster get-kubeconfig
|
|
||||||
|
|
||||||
Airshipctl command to retrieve kubeconfig for a desired cluster
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Retrieves kubeconfig of the cluster and prints it to stdout.
|
|
||||||
|
|
||||||
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 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.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl cluster get-kubeconfig CLUSTER_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Retrieve target-cluster kubeconfig
|
|
||||||
# airshipctl cluster get-kubeconfig target-cluster
|
|
||||||
|
|
||||||
Retrieve kubeconfig for the entire site; the kubeconfig will have context for every cluster
|
|
||||||
# airshipctl cluster get-kubeconfig
|
|
||||||
|
|
||||||
Specify a file where kubeconfig should be written
|
|
||||||
# airshipctl cluster get-kubeconfig --file ~/my-kubeconfig
|
|
||||||
|
|
||||||
Merge site kubeconfig with existing kubeconfig file.
|
|
||||||
Keep in mind that this can override a context if it has the same name
|
|
||||||
Airshipctl will overwrite the contents of the file, if you want merge with existing file, specify "--merge" flag
|
|
||||||
# airshipctl cluster get-kubeconfig --file ~/.airship/kubeconfig --merge
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-f, --file string specify where to write kubeconfig file. If flag isn't specified, airshipctl will write it to stdout
|
|
||||||
-h, --help help for get-kubeconfig
|
|
||||||
--merge specify if you want to merge kubeconfig with the one that exists at --file location
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl cluster](airshipctl_cluster.md) - Airshipctl command to manage kubernetes clusters
|
|
||||||
|
|
||||||
@ -1,77 +0,0 @@
|
|||||||
## airshipctl cluster init
|
|
||||||
|
|
||||||
Deploy cluster-api provider components
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
|
|
||||||
Initialize cluster-api providers based on airshipctl document set.
|
|
||||||
document set must contain document of Kind: Clusterctl in phase initinfra.
|
|
||||||
Path to initinfra phase is defined in the initinfra phase document located
|
|
||||||
in the manifest repository.
|
|
||||||
Clusterctl document example:
|
|
||||||
---
|
|
||||||
apiVersion: airshipit.org/v1alpha1
|
|
||||||
kind: Clusterctl
|
|
||||||
metadata:
|
|
||||||
labels:
|
|
||||||
airshipit.org/deploy-k8s: "false"
|
|
||||||
name: clusterctl-v1
|
|
||||||
init-options:
|
|
||||||
core-provider: "cluster-api:v0.3.3"
|
|
||||||
bootstrap-providers:
|
|
||||||
- "kubeadm:v0.3.3"
|
|
||||||
infrastructure-providers:
|
|
||||||
- "metal3:v0.3.1"
|
|
||||||
control-plane-providers:
|
|
||||||
- "kubeadm:v0.3.3"
|
|
||||||
providers:
|
|
||||||
- name: "metal3"
|
|
||||||
type: "InfrastructureProvider"
|
|
||||||
versions:
|
|
||||||
v0.3.1: manifests/function/capm3/v0.3.1
|
|
||||||
- name: "kubeadm"
|
|
||||||
type: "BootstrapProvider"
|
|
||||||
versions:
|
|
||||||
v0.3.3: manifests/function/cabpk/v0.3.3
|
|
||||||
- name: "cluster-api"
|
|
||||||
type: "CoreProvider"
|
|
||||||
versions:
|
|
||||||
v0.3.3: manifests/function/capi/v0.3.3
|
|
||||||
- name: "kubeadm"
|
|
||||||
type: "ControlPlaneProvider"
|
|
||||||
versions:
|
|
||||||
v0.3.3: manifests/function/cacpk/v0.3.3
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl cluster init [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
# Initialize clusterctl providers and components
|
|
||||||
airshipctl cluster init
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for init
|
|
||||||
--kubeconfig string Path to kubeconfig associated with cluster being managed
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config")
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl cluster](airshipctl_cluster.md) - Manage Kubernetes clusters
|
|
||||||
|
|
||||||
@ -1,44 +0,0 @@
|
|||||||
## airshipctl cluster move
|
|
||||||
|
|
||||||
Move Cluster API objects, provider specific objects and all dependencies to the target cluster
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Move Cluster API objects, provider specific objects and all dependencies to the target cluster.
|
|
||||||
|
|
||||||
Note: The destination cluster MUST have the required provider components installed.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl cluster move [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Move Cluster API objects, provider specific objects and all dependencies to the target cluster.
|
|
||||||
|
|
||||||
airshipctl cluster move --target-context <context name>
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for move
|
|
||||||
--kubeconfig string Path to kubeconfig associated with cluster being managed
|
|
||||||
--target-context string Context to be used within the kubeconfig file for the target cluster. If empty, current context will be used.
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config")
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl cluster](airshipctl_cluster.md) - Manage Kubernetes clusters
|
|
||||||
|
|
||||||
@ -1,42 +0,0 @@
|
|||||||
## airshipctl completion
|
|
||||||
|
|
||||||
Airshipctl command to generate completion script for the specified shell (bash or zsh)
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Generate completion script for airshipctl for the specified shell (bash or zsh).
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl completion SHELL [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Save shell completion to a file
|
|
||||||
# airshipctl completion bash > $HOME/.airship_completions
|
|
||||||
|
|
||||||
Apply completions to the current shell
|
|
||||||
# source <(airshipctl completion bash)
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for completion
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
|
||||||
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
## airshipctl config
|
|
||||||
|
|
||||||
Airshipctl command to manage airshipctl config file
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
|
|
||||||
Provides commands which can be used to manage the airshipctl config file.
|
|
||||||
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [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
|
|
||||||
* [airshipctl config init](airshipctl_config_init.md) - Airshipctl command to generate initial configuration file for airshipctl
|
|
||||||
* [airshipctl config set-context](airshipctl_config_set-context.md) - Airshipctl command to create/modify context in airshipctl config file
|
|
||||||
* [airshipctl config set-management-config](airshipctl_config_set-management-config.md) - Airshipctl command to create/modify out-of-band management configuration in airshipctl config file
|
|
||||||
* [airshipctl config set-manifest](airshipctl_config_set-manifest.md) - Airshipctl command to create/modify manifests in airship config
|
|
||||||
* [airshipctl config use-context](airshipctl_config_use-context.md) - Airshipctl command to switch to a different context
|
|
||||||
|
|
||||||
@ -1,44 +0,0 @@
|
|||||||
## airshipctl config get-management-config
|
|
||||||
|
|
||||||
Airshipctl command to view management config(s) defined in the airshipctl config
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
|
|
||||||
Displays a specific management config information, or all defined management configs if no name is provided.
|
|
||||||
The information relates to reboot-delays and retry in seconds along with management-type that has to be used.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl config get-management-config MGMT_CONFIG_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
View all management configurations
|
|
||||||
# airshipctl config get-management-configs
|
|
||||||
|
|
||||||
View a specific management configuration named "default"
|
|
||||||
# airshipctl config get-management-config default
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for get-management-config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
|
|
||||||
|
|
||||||
@ -1,43 +0,0 @@
|
|||||||
## airshipctl config get-manifest
|
|
||||||
|
|
||||||
Airshipctl command to get a specific or all manifest(s) information from the airshipctl config
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Displays a specific manifest information, or all defined manifests if no name is provided. The information
|
|
||||||
includes the repository details related to site manifest along with the local targetPath for them.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl config get-manifest MANIFEST_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
List all the manifests
|
|
||||||
# airshipctl config get-manifests
|
|
||||||
|
|
||||||
Display a specific manifest
|
|
||||||
# airshipctl config get-manifest e2e
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for get-manifest
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
|
|
||||||
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
## airshipctl config import
|
|
||||||
|
|
||||||
Merge information from a kubernetes config file
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Merge the clusters, contexts, and users from an existing kubeConfig file into the airshipctl config file.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl config import <kubeConfig> [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
# Import from a kubeConfig file"
|
|
||||||
airshipctl config import $HOME/.kube/config
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for import
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config")
|
|
||||||
--debug enable verbose output
|
|
||||||
--kubeconfig string Path to kubeconfig associated with airshipctl configuration. (default "$HOME/.airship/kubeconfig")
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file
|
|
||||||
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
## airshipctl config use-context
|
|
||||||
|
|
||||||
Airshipctl command to switch to a different context
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Switch to a different context defined in the airshipctl config file.
|
|
||||||
This command doesn't change the context for the kubeconfig file.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl config use-context CONTEXT_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Switch to a context named "exampleContext" in airshipctl config file
|
|
||||||
# airshipctl config use-context exampleContext
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for use-context
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
|
|
||||||
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
## airshipctl document
|
|
||||||
|
|
||||||
Airshipctl command to manage site manifest documents
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
|
|
||||||
Provides commands which help in management of site manifest documents.
|
|
||||||
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for document
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [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
|
|
||||||
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
## airshipctl phase
|
|
||||||
|
|
||||||
Airshipctl command to manage phases
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Provides capabilities for interacting with phases, such as getting list of phases or applying a specific one.
|
|
||||||
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for phase
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [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
|
|
||||||
* [airshipctl phase status](airshipctl_phase_status.md) - Airshipctl command to show status of the phase
|
|
||||||
* [airshipctl phase tree](airshipctl_phase_tree.md) - Airshipctl command to show tree view of kustomize entrypoints of phase
|
|
||||||
* [airshipctl phase validate](airshipctl_phase_validate.md) - Airshipctl command to validate phase and its documents
|
|
||||||
|
|
||||||
@ -1,55 +0,0 @@
|
|||||||
## airshipctl phase list
|
|
||||||
|
|
||||||
Airshipctl command to list phases
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
List phases defined in site manifests by plan. Phases within a plan are
|
|
||||||
executed sequentially. Multiple phase plans are executed in parallel.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl phase list PHASE_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
List phases of phasePlan
|
|
||||||
# airshipctl phase list --plan phasePlan
|
|
||||||
|
|
||||||
To output the contents in table format (default operation)
|
|
||||||
# airshipctl phase list --plan phasePlan -o table
|
|
||||||
|
|
||||||
To output the contents in yaml format
|
|
||||||
# airshipctl phase list --plan phasePlan -o yaml
|
|
||||||
|
|
||||||
List all phases
|
|
||||||
# airshipctl phase list
|
|
||||||
|
|
||||||
List phases with clustername
|
|
||||||
# airshipctl phase list --cluster-name clustername
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-c, --cluster-name string filter documents by cluster name
|
|
||||||
-h, --help help for list
|
|
||||||
-o, --output string output format. Supported formats are 'table' and 'yaml' (default "table")
|
|
||||||
--plan string plan name of a plan
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl phase](airshipctl_phase.md) - Airshipctl command to manage phases
|
|
||||||
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
## airshipctl phase plan
|
|
||||||
|
|
||||||
List phases
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
List life-cycle phases which were defined in document model by group.
|
|
||||||
Phases within a group are executed sequentially. Multiple phase groups
|
|
||||||
are executed in parallel.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl phase plan [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for plan
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config")
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl phase](airshipctl_phase.md) - Manage phases
|
|
||||||
|
|
||||||
@ -1,41 +0,0 @@
|
|||||||
## airshipctl phase status
|
|
||||||
|
|
||||||
Airshipctl command to show status of the phase
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
|
|
||||||
Get the status of a phase such as ephemeral-control-plane, target-initinfra etc...
|
|
||||||
To list the phases associated with a site, run 'airshipctl phase list'.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl phase status PHASE_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Status of initinfra phase
|
|
||||||
# airshipctl phase status ephemeral-control-plane
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for status
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl phase](airshipctl_phase.md) - Airshipctl command to manage phases
|
|
||||||
|
|
||||||
@ -1,42 +0,0 @@
|
|||||||
## airshipctl phase tree
|
|
||||||
|
|
||||||
Airshipctl command to show tree view of kustomize entrypoints of phase
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Get tree view of the kustomize entrypoints of a phase.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl phase tree PHASE_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
yaml explorer of a phase with relative path
|
|
||||||
# airshipctl phase tree /manifests/site/test-site/ephemeral/initinfra
|
|
||||||
|
|
||||||
yaml explorer of a phase with phase name
|
|
||||||
# airshipctl phase tree initinfra-ephemeral
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for tree
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl phase](airshipctl_phase.md) - Airshipctl command to manage phases
|
|
||||||
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
## airshipctl phase validate
|
|
||||||
|
|
||||||
Airshipctl command to validate phase and its documents
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
|
|
||||||
Validates phase and its documents. To list the phases associated with a site, run 'airshipctl phase list'.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl phase validate PHASE_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
To validate initinfra phase
|
|
||||||
# airshipctl phase validate initinfra
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for validate
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl phase](airshipctl_phase.md) - Airshipctl command to manage phases
|
|
||||||
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
## airshipctl plan
|
|
||||||
|
|
||||||
Airshipctl command to manage plans
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Provides capabilities for interacting with plan objects, responsible for execution of phases in groups.
|
|
||||||
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for plan
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [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
|
|
||||||
|
|
||||||
@ -1,45 +0,0 @@
|
|||||||
## airshipctl plan list
|
|
||||||
|
|
||||||
Airshipctl command to list plans
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
List plans defined in site manifest.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl plan list [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
List plan
|
|
||||||
# airshipctl plan list
|
|
||||||
|
|
||||||
List plan(yaml output format)
|
|
||||||
# airshipctl plan list -o yaml
|
|
||||||
|
|
||||||
List plan(table output format)
|
|
||||||
# airshipctl plan list -o table
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for list
|
|
||||||
-o, --output string output format. Supported formats are 'table' and 'yaml' (default "table")
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl plan](airshipctl_plan.md) - Airshipctl command to manage plans
|
|
||||||
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
## airshipctl plan validate
|
|
||||||
|
|
||||||
Airshipctl command to validate plan
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Validate a plan defined in the site manifest. Specify the plan using the mandatory parameter PLAN_NAME.
|
|
||||||
To get list of plans associated for a site, run 'airshipctl plan list'.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl plan validate PLAN_NAME [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Validate plan named iso
|
|
||||||
# airshipctl plan validate iso
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for validate
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl plan](airshipctl_plan.md) - Airshipctl command to manage plans
|
|
||||||
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## airshipctl secret
|
|
||||||
|
|
||||||
Airshipctl command to manage secrets
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Commands and sub-commnads defined can be used to manage secrets.
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for secret
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [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
|
|
||||||
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## airshipctl secret generate
|
|
||||||
|
|
||||||
Airshipctl command to generate secrets
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Airshipctl command to generate secrets
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for generate
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl secret](airshipctl_secret.md) - Airshipctl command to manage secrets
|
|
||||||
* [airshipctl secret generate encryptionkey](airshipctl_secret_generate_encryptionkey.md) - Airshipctl command to generate a secure encryption key or passphrase
|
|
||||||
|
|
||||||
@ -1,46 +0,0 @@
|
|||||||
## airshipctl secret generate encryptionkey
|
|
||||||
|
|
||||||
Airshipctl command to generate a secure encryption key or passphrase
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Generates a secure encryption key or passphrase.
|
|
||||||
|
|
||||||
If regex arguments are passed the encryption key created would match the regular expression passed.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl secret generate encryptionkey [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Generates a secure encryption key or passphrase.
|
|
||||||
# airshipctl secret generate encryptionkey
|
|
||||||
|
|
||||||
Generates a secure encryption key or passphrase matching the regular expression
|
|
||||||
# airshipctl secret generate encryptionkey --regex Xy[a-c][0-9]!a*
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for encryptionkey
|
|
||||||
--limit int limit number of characters for + or * regex (default 5)
|
|
||||||
--regex string regular expression string
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl secret generate](airshipctl_secret_generate.md) - Airshipctl command to generate secrets
|
|
||||||
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
## airshipctl version
|
|
||||||
|
|
||||||
Airshipctl command to display the current version number
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Airshipctl command to display the current version number
|
|
||||||
|
|
||||||
```
|
|
||||||
airshipctl version [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for version
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
||||||
--debug enable verbose output
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [airshipctl](airshipctl.md) - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
|
||||||
|
|
||||||
41
docs/source/cli/baremetal/airshipctl_baremetal.rst
Normal file
41
docs/source/cli/baremetal/airshipctl_baremetal.rst
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
.. _airshipctl_baremetal:
|
||||||
|
|
||||||
|
airshipctl baremetal
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Airshipctl command to manage bare metal host(s)
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for baremetal
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
* :ref:`airshipctl baremetal ejectmedia <airshipctl_baremetal_ejectmedia>` - Airshipctl command to eject virtual media attached to a bare metal host
|
||||||
|
* :ref:`airshipctl baremetal poweroff <airshipctl_baremetal_poweroff>` - Airshipctl command to shutdown bare metal host(s)
|
||||||
|
* :ref:`airshipctl baremetal poweron <airshipctl_baremetal_poweron>` - Airshipctl command to power on host(s)
|
||||||
|
* :ref:`airshipctl baremetal powerstatus <airshipctl_baremetal_powerstatus>` - Airshipctl command to retrieve the power status of a bare metal host
|
||||||
|
* :ref:`airshipctl baremetal reboot <airshipctl_baremetal_reboot>` - Airshipctl command to reboot host(s)
|
||||||
|
* :ref:`airshipctl baremetal remotedirect <airshipctl_baremetal_remotedirect>` - Airshipctl command to bootstrap the ephemeral host
|
||||||
|
|
||||||
@ -1,21 +1,28 @@
|
|||||||
## airshipctl baremetal ejectmedia
|
.. _airshipctl_baremetal_ejectmedia:
|
||||||
|
|
||||||
|
airshipctl baremetal ejectmedia
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
Airshipctl command to eject virtual media attached to a bare metal host
|
Airshipctl command to eject virtual media attached to a bare metal host
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship site inventory based on 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
|
--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site
|
||||||
inventory.
|
inventory.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl baremetal ejectmedia [flags]
|
airshipctl baremetal ejectmedia [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Perform ejectmedia 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
|
# airshipctl baremetal ejectmedia --name rdm9r3s3
|
||||||
@ -29,27 +36,29 @@ Perform ejectmedia action against all hosts defined in inventory
|
|||||||
Perform ejectmedia action against hosts with a label 'foo=bar'
|
Perform ejectmedia action against hosts with a label 'foo=bar'
|
||||||
# airshipctl baremetal ejectmedia --labels "foo=bar"
|
# airshipctl baremetal ejectmedia --labels "foo=bar"
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--all specify this to target all hosts in the site inventory
|
--all specify this to target all hosts in the site inventory
|
||||||
-h, --help help for ejectmedia
|
-h, --help help for ejectmedia
|
||||||
-l, --labels string label(s) to filter desired bare metal host from site manifest documents
|
-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
|
--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)
|
-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)
|
--timeout duration timeout on bare metal action (default 10m0s)
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)
|
* :ref:`airshipctl baremetal <airshipctl_baremetal>` - Airshipctl command to manage bare metal host(s)
|
||||||
|
|
||||||
@ -1,21 +1,28 @@
|
|||||||
## airshipctl baremetal poweroff
|
.. _airshipctl_baremetal_poweroff:
|
||||||
|
|
||||||
|
airshipctl baremetal poweroff
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
Airshipctl command to shutdown bare metal host(s)
|
Airshipctl command to shutdown bare metal host(s)
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Power off bare metal host(s). The command will target bare metal hosts from airship site inventory based on 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
|
--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site
|
||||||
inventory.
|
inventory.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl baremetal poweroff [flags]
|
airshipctl baremetal poweroff [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Perform poweroff 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
|
# airshipctl baremetal poweroff --name rdm9r3s3
|
||||||
@ -29,27 +36,29 @@ Perform poweroff action against all hosts defined in inventory
|
|||||||
Perform poweroff action against hosts with a label 'foo=bar'
|
Perform poweroff action against hosts with a label 'foo=bar'
|
||||||
# airshipctl baremetal poweroff --labels "foo=bar"
|
# airshipctl baremetal poweroff --labels "foo=bar"
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--all specify this to target all hosts in the site inventory
|
--all specify this to target all hosts in the site inventory
|
||||||
-h, --help help for poweroff
|
-h, --help help for poweroff
|
||||||
-l, --labels string label(s) to filter desired bare metal host from site manifest documents
|
-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
|
--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)
|
-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)
|
--timeout duration timeout on bare metal action (default 10m0s)
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)
|
* :ref:`airshipctl baremetal <airshipctl_baremetal>` - Airshipctl command to manage bare metal host(s)
|
||||||
|
|
||||||
@ -1,21 +1,28 @@
|
|||||||
## airshipctl baremetal poweron
|
.. _airshipctl_baremetal_poweron:
|
||||||
|
|
||||||
|
airshipctl baremetal poweron
|
||||||
|
----------------------------
|
||||||
|
|
||||||
Airshipctl command to power on host(s)
|
Airshipctl command to power on host(s)
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Power on bare metal host(s). The command will target bare metal hosts from airship site inventory based on 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
|
--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site
|
||||||
inventory.
|
inventory.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl baremetal poweron [flags]
|
airshipctl baremetal poweron [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Perform poweron 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
|
# airshipctl baremetal poweron --name rdm9r3s3
|
||||||
@ -29,27 +36,29 @@ Perform poweron action against all hosts defined in inventory
|
|||||||
Perform poweron action against hosts with a label 'foo=bar'
|
Perform poweron action against hosts with a label 'foo=bar'
|
||||||
# airshipctl baremetal poweron --labels "foo=bar"
|
# airshipctl baremetal poweron --labels "foo=bar"
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--all specify this to target all hosts in the site inventory
|
--all specify this to target all hosts in the site inventory
|
||||||
-h, --help help for poweron
|
-h, --help help for poweron
|
||||||
-l, --labels string label(s) to filter desired bare metal host from site manifest documents
|
-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
|
--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)
|
-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)
|
--timeout duration timeout on bare metal action (default 10m0s)
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)
|
* :ref:`airshipctl baremetal <airshipctl_baremetal>` - Airshipctl command to manage bare metal host(s)
|
||||||
|
|
||||||
@ -1,20 +1,27 @@
|
|||||||
## airshipctl baremetal powerstatus
|
.. _airshipctl_baremetal_powerstatus:
|
||||||
|
|
||||||
|
airshipctl baremetal powerstatus
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
Airshipctl command to retrieve the power status of a bare metal host
|
Airshipctl command to retrieve the power status of a bare metal host
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Retrieve the power status of a bare metal host. It targets a bare metal host from airship inventory
|
Retrieve the power status of a bare metal host. It targets a bare metal host from airship inventory
|
||||||
based on the --name, --namespace, --label and --timeout flags provided.
|
based on the --name, --namespace, --label and --timeout flags provided.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl baremetal powerstatus [flags]
|
airshipctl baremetal powerstatus [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
To get power status of 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
|
# airshipctl baremetal powerstatus --name rdm9r3s3
|
||||||
@ -25,26 +32,28 @@ To get power status of host with name rdm9r3s3 in metal3 namespace
|
|||||||
To get power status of host with a label 'foo=bar'
|
To get power status of host with a label 'foo=bar'
|
||||||
# airshipctl baremetal powerstatus --labels "foo=bar"
|
# airshipctl baremetal powerstatus --labels "foo=bar"
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for powerstatus
|
-h, --help help for powerstatus
|
||||||
-l, --labels string label(s) to filter desired bare metal host from site manifest documents
|
-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
|
--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)
|
-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)
|
--timeout duration timeout on bare metal action (default 10m0s)
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)
|
* :ref:`airshipctl baremetal <airshipctl_baremetal>` - Airshipctl command to manage bare metal host(s)
|
||||||
|
|
||||||
@ -1,21 +1,28 @@
|
|||||||
## airshipctl baremetal reboot
|
.. _airshipctl_baremetal_reboot:
|
||||||
|
|
||||||
|
airshipctl baremetal reboot
|
||||||
|
---------------------------
|
||||||
|
|
||||||
Airshipctl command to reboot host(s)
|
Airshipctl command to reboot host(s)
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Reboot bare metal host(s). The command will target bare metal hosts from airship site inventory based on 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
|
--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site
|
||||||
inventory.
|
inventory.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl baremetal reboot [flags]
|
airshipctl baremetal reboot [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Perform reboot 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
|
# airshipctl baremetal reboot --name rdm9r3s3
|
||||||
@ -29,27 +36,29 @@ Perform reboot action against all hosts defined in inventory
|
|||||||
Perform reboot action against hosts with a label 'foo=bar'
|
Perform reboot action against hosts with a label 'foo=bar'
|
||||||
# airshipctl baremetal reboot --labels "foo=bar"
|
# airshipctl baremetal reboot --labels "foo=bar"
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--all specify this to target all hosts in the site inventory
|
--all specify this to target all hosts in the site inventory
|
||||||
-h, --help help for reboot
|
-h, --help help for reboot
|
||||||
-l, --labels string label(s) to filter desired bare metal host from site manifest documents
|
-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
|
--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)
|
-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)
|
--timeout duration timeout on bare metal action (default 10m0s)
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)
|
* :ref:`airshipctl baremetal <airshipctl_baremetal>` - Airshipctl command to manage bare metal host(s)
|
||||||
|
|
||||||
@ -1,20 +1,27 @@
|
|||||||
## airshipctl baremetal remotedirect
|
.. _airshipctl_baremetal_remotedirect:
|
||||||
|
|
||||||
|
airshipctl baremetal remotedirect
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
Airshipctl command to bootstrap the ephemeral host
|
Airshipctl command to bootstrap the ephemeral host
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Bootstrap bare metal host. It targets bare metal host from airship inventory based
|
Bootstrap bare metal host. It targets bare metal host from airship inventory based
|
||||||
on the --iso-url, --name, --namespace, --label and --timeout flags provided.
|
on the --iso-url, --name, --namespace, --label and --timeout flags provided.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl baremetal remotedirect [flags]
|
airshipctl baremetal remotedirect [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Perform bootstrap 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
|
# airshipctl baremetal remotedirect --name rdm9r3s3
|
||||||
@ -25,27 +32,29 @@ Perform bootstrap action against hosts with name rdm9r3s3 in metal3 namespace
|
|||||||
Perform bootstrap action against hosts with a label 'foo=bar'
|
Perform bootstrap action against hosts with a label 'foo=bar'
|
||||||
# airshipctl baremetal remotedirect --labels "foo=bar"
|
# airshipctl baremetal remotedirect --labels "foo=bar"
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for remotedirect
|
-h, --help help for remotedirect
|
||||||
--iso-url string specify iso url for host to boot from
|
--iso-url string specify iso url for host to boot from
|
||||||
-l, --labels string label(s) to filter desired bare metal host from site manifest documents
|
-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
|
--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)
|
-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)
|
--timeout duration timeout on bare metal action (default 10m0s)
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)
|
* :ref:`airshipctl baremetal <airshipctl_baremetal>` - Airshipctl command to manage bare metal host(s)
|
||||||
|
|
||||||
14
docs/source/cli/baremetal/index.rst
Normal file
14
docs/source/cli/baremetal/index.rst
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
####################
|
||||||
|
baremetal
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_baremetal
|
||||||
|
airshipctl_baremetal_ejectmedia
|
||||||
|
airshipctl_baremetal_poweroff
|
||||||
|
airshipctl_baremetal_poweron
|
||||||
|
airshipctl_baremetal_powerstatus
|
||||||
|
airshipctl_baremetal_reboot
|
||||||
|
airshipctl_baremetal_remotedirect
|
||||||
40
docs/source/cli/cluster/airshipctl_cluster.rst
Normal file
40
docs/source/cli/cluster/airshipctl_cluster.rst
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
.. _airshipctl_cluster:
|
||||||
|
|
||||||
|
airshipctl cluster
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Airshipctl command to manage kubernetes clusters
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Provides capabilities for interacting with a Kubernetes cluster,
|
||||||
|
such as getting status and deploying initial infrastructure.
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for cluster
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
* :ref:`airshipctl cluster check-certificate-expiration <airshipctl_cluster_check-certificate-expiration>` - Airshipctl command to check expiring TLS certificates, secrets and kubeconfigs in the kubernetes cluster
|
||||||
|
* :ref:`airshipctl cluster get-kubeconfig <airshipctl_cluster_get-kubeconfig>` - Airshipctl command to retrieve kubeconfig for a desired cluster
|
||||||
|
* :ref:`airshipctl cluster list <airshipctl_cluster_list>` - Airshipctl command to get and list defined clusters
|
||||||
|
* :ref:`airshipctl cluster rotate-sa-token <airshipctl_cluster_rotate-sa-token>` - Airshipctl command to rotate tokens of Service Account(s)
|
||||||
|
* :ref:`airshipctl cluster status <airshipctl_cluster_status>` - Retrieve statuses of deployed cluster components
|
||||||
|
|
||||||
@ -0,0 +1,68 @@
|
|||||||
|
.. _airshipctl_cluster_check-certificate-expiration:
|
||||||
|
|
||||||
|
airshipctl cluster check-certificate-expiration
|
||||||
|
-----------------------------------------------
|
||||||
|
|
||||||
|
Airshipctl command to check expiring TLS certificates, secrets and kubeconfigs in the kubernetes cluster
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Displays a list of certificate along with expirations from both the management and workload clusters, or in a
|
||||||
|
self-managed cluster. Checks for TLS Secrets, kubeconf secrets (which gets created while creating the
|
||||||
|
workload cluster) and also the node certificates present inside /etc/kubernetes/pki directory for each node.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl cluster check-certificate-expiration [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
To display all the expiring certificates in the cluster
|
||||||
|
# airshipctl cluster check-certificate-expiration --kubeconfig testconfig
|
||||||
|
|
||||||
|
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 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 in yaml format
|
||||||
|
# airshipctl cluster check-certificate-expiration -o yaml --kubeconfig testconfig
|
||||||
|
|
||||||
|
To output the contents whose expiration is within 30 days in yaml format
|
||||||
|
# airshipctl cluster check-certificate-expiration -t 30 -o yaml --kubeconfig testconfig
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for check-certificate-expiration
|
||||||
|
--kubeconfig string path to kubeconfig associated with cluster being managed
|
||||||
|
--kubecontext string kubeconfig context to be used
|
||||||
|
-o, --output string convert output to yaml or json (default "json")
|
||||||
|
-t, --threshold int the max expiration threshold in days before a certificate is expiring. Displays all the certificates by default (default -1)
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl cluster <airshipctl_cluster>` - Airshipctl command to manage kubernetes clusters
|
||||||
|
|
||||||
@ -0,0 +1,67 @@
|
|||||||
|
.. _airshipctl_cluster_get-kubeconfig:
|
||||||
|
|
||||||
|
airshipctl cluster get-kubeconfig
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
Airshipctl command to retrieve kubeconfig for a desired cluster
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Retrieves kubeconfig of the cluster and prints it to stdout.
|
||||||
|
|
||||||
|
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 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.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl cluster get-kubeconfig CLUSTER_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
Retrieve target-cluster kubeconfig
|
||||||
|
# airshipctl cluster get-kubeconfig target-cluster
|
||||||
|
|
||||||
|
Retrieve kubeconfig for the entire site; the kubeconfig will have context for every cluster
|
||||||
|
# airshipctl cluster get-kubeconfig
|
||||||
|
|
||||||
|
Specify a file where kubeconfig should be written
|
||||||
|
# airshipctl cluster get-kubeconfig --file ~/my-kubeconfig
|
||||||
|
|
||||||
|
Merge site kubeconfig with existing kubeconfig file.
|
||||||
|
Keep in mind that this can override a context if it has the same name
|
||||||
|
Airshipctl will overwrite the contents of the file, if you want merge with existing file, specify "--merge" flag
|
||||||
|
# airshipctl cluster get-kubeconfig --file ~/.airship/kubeconfig --merge
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-f, --file string specify where to write kubeconfig file. If flag isn't specified, airshipctl will write it to stdout
|
||||||
|
-h, --help help for get-kubeconfig
|
||||||
|
--merge specify if you want to merge kubeconfig with the one that exists at --file location
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl cluster <airshipctl_cluster>` - Airshipctl command to manage kubernetes clusters
|
||||||
|
|
||||||
@ -1,44 +1,52 @@
|
|||||||
## airshipctl cluster list
|
.. _airshipctl_cluster_list:
|
||||||
|
|
||||||
|
airshipctl cluster list
|
||||||
|
-----------------------
|
||||||
|
|
||||||
Airshipctl command to get and list defined clusters
|
Airshipctl command to get and list defined clusters
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Retrieve and list the defined clusters in table form or display just the cluster names. The contents of the
|
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.
|
table would include cluster name, kubeconfig context and parent cluster name.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl cluster list [flags]
|
airshipctl cluster list [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Retrieve list of clusters
|
Retrieve list of clusters
|
||||||
# airshipctl cluster list --airshipconf /tmp/airconfig
|
# airshipctl cluster list --airshipconf /tmp/airconfig
|
||||||
# airshipctl cluster list -o table
|
# airshipctl cluster list -o table
|
||||||
# airshipctl cluster list -o name
|
# airshipctl cluster list -o name
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for list
|
-h, --help help for list
|
||||||
-o, --output string output formats. Supported options are 'table' and 'name' (default "name")
|
-o, --output string output formats. Supported options are 'table' and 'name' (default "name")
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl cluster](airshipctl_cluster.md) - Airshipctl command to manage kubernetes clusters
|
* :ref:`airshipctl cluster <airshipctl_cluster>` - Airshipctl command to manage kubernetes clusters
|
||||||
|
|
||||||
@ -1,8 +1,13 @@
|
|||||||
## airshipctl cluster rotate-sa-token
|
.. _airshipctl_cluster_rotate-sa-token:
|
||||||
|
|
||||||
|
airshipctl cluster rotate-sa-token
|
||||||
|
----------------------------------
|
||||||
|
|
||||||
Airshipctl command to rotate tokens of Service Account(s)
|
Airshipctl command to rotate tokens of Service Account(s)
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Reset/rotate the Service Account(SA) tokens and additionally restart the corresponding pods to get the latest
|
Reset/rotate the Service Account(SA) tokens and additionally restart the corresponding pods to get the latest
|
||||||
token data reflected in the pod spec.
|
token data reflected in the pod spec.
|
||||||
@ -11,13 +16,15 @@ Secret-namespace is a mandatory flag and secret-name is optional. If a secret-na
|
|||||||
tokens in the specified namespace are rotated, else only the specified secret-name.
|
tokens in the specified namespace are rotated, else only the specified secret-name.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl cluster rotate-sa-token [flags]
|
airshipctl cluster rotate-sa-token [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
To rotate a particular SA token
|
To rotate a particular SA token
|
||||||
# airshipctl cluster rotate-sa-token -n cert-manager -s cert-manager-token-vvn9p
|
# airshipctl cluster rotate-sa-token -n cert-manager -s cert-manager-token-vvn9p
|
||||||
@ -25,25 +32,27 @@ To rotate a particular SA token
|
|||||||
To rotate all the SA tokens in cert-manager namespace
|
To rotate all the SA tokens in cert-manager namespace
|
||||||
# airshipctl cluster rotate-sa-token -n cert-manager
|
# airshipctl cluster rotate-sa-token -n cert-manager
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for rotate-sa-token
|
-h, --help help for rotate-sa-token
|
||||||
--kubeconfig string path to kubeconfig associated with cluster being managed
|
--kubeconfig string path to kubeconfig associated with cluster being managed
|
||||||
-s, --secret-name string name of the secret containing Service Account Token
|
-s, --secret-name string name of the secret containing Service Account Token
|
||||||
-n, --secret-namespace string namespace of the Service Account Token
|
-n, --secret-namespace string namespace of the Service Account Token
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl cluster](airshipctl_cluster.md) - Airshipctl command to manage kubernetes clusters
|
* :ref:`airshipctl cluster <airshipctl_cluster>` - Airshipctl command to manage kubernetes clusters
|
||||||
|
|
||||||
@ -1,30 +1,38 @@
|
|||||||
## airshipctl cluster status
|
.. _airshipctl_cluster_status:
|
||||||
|
|
||||||
|
airshipctl cluster status
|
||||||
|
-------------------------
|
||||||
|
|
||||||
Retrieve statuses of deployed cluster components
|
Retrieve statuses of deployed cluster components
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Retrieve statuses of deployed cluster components
|
Retrieve statuses of deployed cluster components
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl cluster status [flags]
|
airshipctl cluster status [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for status
|
-h, --help help for status
|
||||||
--kubeconfig string Path to kubeconfig associated with cluster being managed
|
--kubeconfig string Path to kubeconfig associated with cluster being managed
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl cluster](airshipctl_cluster.md) - Airshipctl command to manage kubernetes clusters
|
* :ref:`airshipctl cluster <airshipctl_cluster>` - Airshipctl command to manage kubernetes clusters
|
||||||
|
|
||||||
13
docs/source/cli/cluster/index.rst
Normal file
13
docs/source/cli/cluster/index.rst
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
####################
|
||||||
|
cluster
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_cluster
|
||||||
|
airshipctl_cluster_check-certificate-expiration
|
||||||
|
airshipctl_cluster_get-kubeconfig
|
||||||
|
airshipctl_cluster_list
|
||||||
|
airshipctl_cluster_rotate-sa-token
|
||||||
|
airshipctl_cluster_status
|
||||||
51
docs/source/cli/completion/airshipctl_completion.rst
Normal file
51
docs/source/cli/completion/airshipctl_completion.rst
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
.. _airshipctl_completion:
|
||||||
|
|
||||||
|
airshipctl completion
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Airshipctl command to generate completion script for the specified shell (bash or zsh)
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Generate completion script for airshipctl for the specified shell (bash or zsh).
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl completion SHELL [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
Save shell completion to a file
|
||||||
|
# airshipctl completion bash > $HOME/.airship_completions
|
||||||
|
|
||||||
|
Apply completions to the current shell
|
||||||
|
# source <(airshipctl completion bash)
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for completion
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
|
||||||
8
docs/source/cli/completion/index.rst
Normal file
8
docs/source/cli/completion/index.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
####################
|
||||||
|
completion
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_completion
|
||||||
42
docs/source/cli/config/airshipctl_config.rst
Normal file
42
docs/source/cli/config/airshipctl_config.rst
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
.. _airshipctl_config:
|
||||||
|
|
||||||
|
airshipctl config
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Provides commands which can be used to manage the airshipctl config file.
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for config
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
* :ref:`airshipctl config get-context <airshipctl_config_get-context>` - Airshipctl command to get context(s) information from the airshipctl config
|
||||||
|
* :ref:`airshipctl config get-management-config <airshipctl_config_get-management-config>` - Airshipctl command to view management config(s) defined in the airshipctl config
|
||||||
|
* :ref:`airshipctl config get-manifest <airshipctl_config_get-manifest>` - Airshipctl command to get a specific or all manifest(s) information from the airshipctl config
|
||||||
|
* :ref:`airshipctl config init <airshipctl_config_init>` - Airshipctl command to generate initial configuration file for airshipctl
|
||||||
|
* :ref:`airshipctl config set-context <airshipctl_config_set-context>` - Airshipctl command to create/modify context in airshipctl config file
|
||||||
|
* :ref:`airshipctl config set-management-config <airshipctl_config_set-management-config>` - Airshipctl command to create/modify out-of-band management configuration in airshipctl config file
|
||||||
|
* :ref:`airshipctl config set-manifest <airshipctl_config_set-manifest>` - Airshipctl command to create/modify manifests in airship config
|
||||||
|
* :ref:`airshipctl config use-context <airshipctl_config_use-context>` - Airshipctl command to switch to a different context
|
||||||
|
|
||||||
@ -1,20 +1,27 @@
|
|||||||
## airshipctl config get-context
|
.. _airshipctl_config_get-context:
|
||||||
|
|
||||||
|
airshipctl config get-context
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
Airshipctl command to get context(s) information from the airshipctl config
|
Airshipctl command to get context(s) information from the airshipctl config
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Displays information about contexts such as associated manifests, users, and clusters. It would display a specific
|
Displays information about contexts such as associated manifests, users, and clusters. It would display a specific
|
||||||
context information, or all defined context information if no name is provided.
|
context information, or all defined context information if no name is provided.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl config get-context CONTEXT_NAME [flags]
|
airshipctl config get-context CONTEXT_NAME [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
List all contexts
|
List all contexts
|
||||||
# airshipctl config get-contexts
|
# airshipctl config get-contexts
|
||||||
@ -25,24 +32,26 @@ Display the current context
|
|||||||
Display a specific context
|
Display a specific context
|
||||||
# airshipctl config get-context exampleContext
|
# airshipctl config get-context exampleContext
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--current get the current context
|
--current get the current context
|
||||||
--format yaml supported output format yaml or `table`, default is `yaml` (default "yaml")
|
--format yaml supported output format yaml or `table`, default is `yaml` (default "yaml")
|
||||||
-h, --help help for get-context
|
-h, --help help for get-context
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
@ -0,0 +1,52 @@
|
|||||||
|
.. _airshipctl_config_get-management-config:
|
||||||
|
|
||||||
|
airshipctl config get-management-config
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
Airshipctl command to view management config(s) defined in the airshipctl config
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Displays a specific management config information, or all defined management configs if no name is provided.
|
||||||
|
The information relates to reboot-delays and retry in seconds along with management-type that has to be used.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl config get-management-config MGMT_CONFIG_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
View all management configurations
|
||||||
|
# airshipctl config get-management-configs
|
||||||
|
|
||||||
|
View a specific management configuration named "default"
|
||||||
|
# airshipctl config get-management-config default
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for get-management-config
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
52
docs/source/cli/config/airshipctl_config_get-manifest.rst
Normal file
52
docs/source/cli/config/airshipctl_config_get-manifest.rst
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
.. _airshipctl_config_get-manifest:
|
||||||
|
|
||||||
|
airshipctl config get-manifest
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
Airshipctl command to get a specific or all manifest(s) information from the airshipctl config
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Displays a specific manifest information, or all defined manifests if no name is provided. The information
|
||||||
|
includes the repository details related to site manifest along with the local targetPath for them.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl config get-manifest MANIFEST_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
List all the manifests
|
||||||
|
# airshipctl config get-manifests
|
||||||
|
|
||||||
|
Display a specific manifest
|
||||||
|
# airshipctl config get-manifest e2e
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for get-manifest
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
@ -1,8 +1,13 @@
|
|||||||
## airshipctl config init
|
.. _airshipctl_config_init:
|
||||||
|
|
||||||
|
airshipctl config init
|
||||||
|
----------------------
|
||||||
|
|
||||||
Airshipctl command to generate initial configuration file for airshipctl
|
Airshipctl command to generate initial configuration file for airshipctl
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Generates airshipctl config file. This file by default will be written to the $HOME/.airship directory,
|
Generates airshipctl config file. This file by default will be written to the $HOME/.airship directory,
|
||||||
and will contain default configuration. In case if flag --airshipconf provided - the default configuration
|
and will contain default configuration. In case if flag --airshipconf provided - the default configuration
|
||||||
@ -10,13 +15,15 @@ will be written to the file in the specified location instead. If a configuratio
|
|||||||
at the specified path, an error will be thrown; to overwrite it, specify the --overwrite flag.
|
at the specified path, an error will be thrown; to overwrite it, specify the --overwrite flag.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl config init [flags]
|
airshipctl config init [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
To create new airshipctl config file at the default location
|
To create new airshipctl config file at the default location
|
||||||
# airshipctl config init
|
# airshipctl config init
|
||||||
@ -27,23 +34,25 @@ To create new airshipctl config file at the custom location
|
|||||||
To create new airshipctl config file at the custom location and overwrite it
|
To create new airshipctl config file at the custom location and overwrite it
|
||||||
# airshipctl config init --overwrite --airshipconf path/to/config
|
# airshipctl config init --overwrite --airshipconf path/to/config
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for init
|
-h, --help help for init
|
||||||
--overwrite overwrite config file
|
--overwrite overwrite config file
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
@ -1,20 +1,27 @@
|
|||||||
## airshipctl config set-context
|
.. _airshipctl_config_set-context:
|
||||||
|
|
||||||
|
airshipctl config set-context
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
Airshipctl command to create/modify context in airshipctl config file
|
Airshipctl command to create/modify context in airshipctl config file
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Creates or modifies context in the airshipctl config file based on the CONTEXT_NAME passed or for the current context
|
Creates or modifies context in the airshipctl config file based on the CONTEXT_NAME passed or for the current context
|
||||||
if --current flag is specified. It accepts optional flags which include manifest name and management-config name.
|
if --current flag is specified. It accepts optional flags which include manifest name and management-config name.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl config set-context CONTEXT_NAME [flags]
|
airshipctl config set-context CONTEXT_NAME [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
To create a new context named "exampleContext"
|
To create a new context named "exampleContext"
|
||||||
# airshipctl config set-context exampleContext --manifest=exampleManifest
|
# airshipctl config set-context exampleContext --manifest=exampleManifest
|
||||||
@ -22,25 +29,27 @@ To create a new context named "exampleContext"
|
|||||||
To update the manifest of the current-context
|
To update the manifest of the current-context
|
||||||
# airshipctl config set-context --current --manifest=exampleManifest
|
# airshipctl config set-context --current --manifest=exampleManifest
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--current update the current context
|
--current update the current context
|
||||||
-h, --help help for set-context
|
-h, --help help for set-context
|
||||||
--management-config string set the management config for the specified context
|
--management-config string set the management config for the specified context
|
||||||
--manifest string set the manifest for the specified context
|
--manifest string set the manifest for the specified context
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
@ -1,8 +1,12 @@
|
|||||||
## airshipctl config set-management-config
|
.. _airshipctl_config_set-management-config:
|
||||||
|
|
||||||
|
airshipctl config set-management-config
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
Airshipctl command to create/modify out-of-band management configuration in airshipctl config file
|
Airshipctl command to create/modify out-of-band management configuration in airshipctl config file
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Creates or modifies management config information based on the MGMT_CONFIG_NAME passed. The allowed set
|
Creates or modifies management config information based on the MGMT_CONFIG_NAME passed. The allowed set
|
||||||
@ -10,13 +14,15 @@ of optional flags are management-type, system-action-retries and system-reboot-d
|
|||||||
and --insecure to enable proxy and insecure options respectively.
|
and --insecure to enable proxy and insecure options respectively.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl config set-management-config MGMT_CONFIG_NAME [flags]
|
airshipctl config set-management-config MGMT_CONFIG_NAME [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Create management configuration
|
Create management configuration
|
||||||
# airshipctl config set-management-config default
|
# airshipctl config set-management-config default
|
||||||
@ -27,27 +33,29 @@ Create or update management configuration named "default" with retry and to enab
|
|||||||
Enable proxy for "test" management configuration
|
Enable proxy for "test" management configuration
|
||||||
# airshipctl config set-management-config test --use-proxy
|
# airshipctl config set-management-config test --use-proxy
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for set-management-config
|
-h, --help help for set-management-config
|
||||||
--insecure ignore SSL certificate verification on out-of-band management requests
|
--insecure ignore SSL certificate verification on out-of-band management requests
|
||||||
--management-type string set the out-of-band management type (default "redfish")
|
--management-type string set the out-of-band management type (default "redfish")
|
||||||
--system-action-retries int set the number of attempts to poll a host for a status (default 30)
|
--system-action-retries int set the number of attempts to poll a host for a status (default 30)
|
||||||
--system-reboot-delay int set the number of seconds to wait between power actions (e.g. shutdown, startup) (default 30)
|
--system-reboot-delay int set the number of seconds to wait between power actions (e.g. shutdown, startup) (default 30)
|
||||||
--use-proxy use the proxy configuration specified in the local environment (default true)
|
--use-proxy use the proxy configuration specified in the local environment (default true)
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
@ -1,8 +1,13 @@
|
|||||||
## airshipctl config set-manifest
|
.. _airshipctl_config_set-manifest:
|
||||||
|
|
||||||
|
airshipctl config set-manifest
|
||||||
|
------------------------------
|
||||||
|
|
||||||
Airshipctl command to create/modify manifests in airship config
|
Airshipctl command to create/modify manifests in airship config
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Creates or modifies a manifests in the airshipctl config file based on the MANIFEST_NAME argument passed.
|
Creates or modifies a manifests in the airshipctl config file based on the MANIFEST_NAME argument passed.
|
||||||
The optional flags that can be passed to the command are repo name, url, branch name, tag name, commit hash,
|
The optional flags that can be passed to the command are repo name, url, branch name, tag name, commit hash,
|
||||||
@ -10,13 +15,15 @@ target-path and metadata-path. Use --force flag to enable force checkout of the
|
|||||||
to enable phase repository.
|
to enable phase repository.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl config set-manifest MANIFEST_NAME [flags]
|
airshipctl config set-manifest MANIFEST_NAME [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Create a new manifest
|
Create a new manifest
|
||||||
# airshipctl config set-manifest exampleManifest --repo exampleRepo --url https://github.com/site \
|
# airshipctl config set-manifest exampleManifest --repo exampleRepo --url https://github.com/site \
|
||||||
@ -28,11 +35,12 @@ Change the phase repo for manifest
|
|||||||
Change the target-path for manifest
|
Change the target-path for manifest
|
||||||
# airshipctl config set-manifest e2e --target-path /tmp/e2e
|
# airshipctl config set-manifest e2e --target-path /tmp/e2e
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--branch string the branch to be associated with repository in this manifest
|
--branch string the branch to be associated with repository in this manifest
|
||||||
--commithash string the commit hash to be associated with repository in this manifest
|
--commithash string the commit hash to be associated with repository in this manifest
|
||||||
--force if set, enable force checkout in repository with this manifest
|
--force if set, enable force checkout in repository with this manifest
|
||||||
@ -43,16 +51,17 @@ Change the target-path for manifest
|
|||||||
--tag string the tag to be associated with repository in this manifest
|
--tag string the tag to be associated with repository in this manifest
|
||||||
--target-path string the target path to be set for this manifest
|
--target-path string the target path to be set for this manifest
|
||||||
--url string the repository url to be associated with this manifest
|
--url string the repository url to be associated with this manifest
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
49
docs/source/cli/config/airshipctl_config_use-context.rst
Normal file
49
docs/source/cli/config/airshipctl_config_use-context.rst
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
.. _airshipctl_config_use-context:
|
||||||
|
|
||||||
|
airshipctl config use-context
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
Airshipctl command to switch to a different context
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Switch to a different context defined in the airshipctl config file.
|
||||||
|
This command doesn't change the context for the kubeconfig file.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl config use-context CONTEXT_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
Switch to a context named "exampleContext" in airshipctl config file
|
||||||
|
# airshipctl config use-context exampleContext
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for use-context
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl config <airshipctl_config>` - Airshipctl command to manage airshipctl config file
|
||||||
|
|
||||||
16
docs/source/cli/config/index.rst
Normal file
16
docs/source/cli/config/index.rst
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
####################
|
||||||
|
config
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_config
|
||||||
|
airshipctl_config_get-context
|
||||||
|
airshipctl_config_get-management-config
|
||||||
|
airshipctl_config_get-manifest
|
||||||
|
airshipctl_config_init
|
||||||
|
airshipctl_config_set-context
|
||||||
|
airshipctl_config_set-management-config
|
||||||
|
airshipctl_config_set-manifest
|
||||||
|
airshipctl_config_use-context
|
||||||
35
docs/source/cli/document/airshipctl_document.rst
Normal file
35
docs/source/cli/document/airshipctl_document.rst
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
.. _airshipctl_document:
|
||||||
|
|
||||||
|
airshipctl document
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Airshipctl command to manage site manifest documents
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Provides commands which help in management of site manifest documents.
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for document
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
* :ref:`airshipctl document pull <airshipctl_document_pull>` - Airshipctl command to pull manifests from remote git repositories
|
||||||
|
|
||||||
@ -1,8 +1,13 @@
|
|||||||
## airshipctl document pull
|
.. _airshipctl_document_pull:
|
||||||
|
|
||||||
|
airshipctl document pull
|
||||||
|
------------------------
|
||||||
|
|
||||||
Airshipctl command to pull manifests from remote git repositories
|
Airshipctl command to pull manifests from remote git repositories
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
The remote manifests repositories as well as the target path where
|
The remote manifests repositories as well as the target path where
|
||||||
the repositories will be cloned are defined in the airship config file.
|
the repositories will be cloned are defined in the airship config file.
|
||||||
@ -12,35 +17,39 @@ repository "https://opendev.org/airship/treasuremap" as a source of
|
|||||||
manifests and with the manifests target path "$HOME/.airship/default".
|
manifests and with the manifests target path "$HOME/.airship/default".
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl document pull [flags]
|
airshipctl document pull [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Pull manifests from remote repos
|
Pull manifests from remote repos
|
||||||
# airshipctl document pull
|
# airshipctl document pull
|
||||||
>>>>>>> Updating cmd files for documentation
|
>>>>>>> Updating cmd files for documentation
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-h, --help help for pull
|
-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
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl document](airshipctl_document.md) - Airshipctl command to manage site manifest documents
|
* :ref:`airshipctl document <airshipctl_document>` - Airshipctl command to manage site manifest documents
|
||||||
|
|
||||||
9
docs/source/cli/document/index.rst
Normal file
9
docs/source/cli/document/index.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
####################
|
||||||
|
document
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_document
|
||||||
|
airshipctl_document_pull
|
||||||
38
docs/source/cli/help/airshipctl_help.rst
Normal file
38
docs/source/cli/help/airshipctl_help.rst
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
.. _airshipctl_help:
|
||||||
|
|
||||||
|
airshipctl help
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Help about any command
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Help provides help for any command in the application.
|
||||||
|
Simply type airshipctl help [path to command] for full details.
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl help [command] [flags]
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for help
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
|
||||||
8
docs/source/cli/help/index.rst
Normal file
8
docs/source/cli/help/index.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
####################
|
||||||
|
help
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_help
|
||||||
18
docs/source/cli/index.rst
Normal file
18
docs/source/cli/index.rst
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
####################
|
||||||
|
Commands
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl
|
||||||
|
baremetal/index
|
||||||
|
cluster/index
|
||||||
|
completion/index
|
||||||
|
config/index
|
||||||
|
document/index
|
||||||
|
help/index
|
||||||
|
phase/index
|
||||||
|
plan/index
|
||||||
|
secret/index
|
||||||
|
version/index
|
||||||
40
docs/source/cli/phase/airshipctl_phase.rst
Normal file
40
docs/source/cli/phase/airshipctl_phase.rst
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
.. _airshipctl_phase:
|
||||||
|
|
||||||
|
airshipctl phase
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Airshipctl command to manage phases
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Provides capabilities for interacting with phases, such as getting list of phases or applying a specific one.
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for phase
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
* :ref:`airshipctl phase list <airshipctl_phase_list>` - Airshipctl command to list phases
|
||||||
|
* :ref:`airshipctl phase render <airshipctl_phase_render>` - Airshipctl command to render phase documents from model
|
||||||
|
* :ref:`airshipctl phase run <airshipctl_phase_run>` - Airshipctl command to run phase
|
||||||
|
* :ref:`airshipctl phase status <airshipctl_phase_status>` - Airshipctl command to show status of the phase
|
||||||
|
* :ref:`airshipctl phase tree <airshipctl_phase_tree>` - Airshipctl command to show tree view of kustomize entrypoints of phase
|
||||||
|
* :ref:`airshipctl phase validate <airshipctl_phase_validate>` - Airshipctl command to validate phase and its documents
|
||||||
|
|
||||||
64
docs/source/cli/phase/airshipctl_phase_list.rst
Normal file
64
docs/source/cli/phase/airshipctl_phase_list.rst
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
.. _airshipctl_phase_list:
|
||||||
|
|
||||||
|
airshipctl phase list
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Airshipctl command to list phases
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
List phases defined in site manifests by plan. Phases within a plan are
|
||||||
|
executed sequentially. Multiple phase plans are executed in parallel.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl phase list PHASE_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
List phases of phasePlan
|
||||||
|
# airshipctl phase list --plan phasePlan
|
||||||
|
|
||||||
|
To output the contents in table format (default operation)
|
||||||
|
# airshipctl phase list --plan phasePlan -o table
|
||||||
|
|
||||||
|
To output the contents in yaml format
|
||||||
|
# airshipctl phase list --plan phasePlan -o yaml
|
||||||
|
|
||||||
|
List all phases
|
||||||
|
# airshipctl phase list
|
||||||
|
|
||||||
|
List phases with clustername
|
||||||
|
# airshipctl phase list --cluster-name clustername
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-c, --cluster-name string filter documents by cluster name
|
||||||
|
-h, --help help for list
|
||||||
|
-o, --output string output format. Supported formats are 'table' and 'yaml' (default "table")
|
||||||
|
--plan string plan name of a plan
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl phase <airshipctl_phase>` - Airshipctl command to manage phases
|
||||||
|
|
||||||
@ -1,20 +1,26 @@
|
|||||||
## airshipctl phase render
|
.. _airshipctl_phase_render:
|
||||||
|
|
||||||
|
airshipctl phase render
|
||||||
|
-----------------------
|
||||||
|
|
||||||
Airshipctl command to render phase documents from model
|
Airshipctl command to render phase documents from model
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Render documents for a phase.
|
Render documents for a phase.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl phase render PHASE_NAME [flags]
|
airshipctl phase render PHASE_NAME [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Get all 'initinfra' phase documents containing labels "app=helm" and "service=tiller"
|
Get all 'initinfra' phase documents containing labels "app=helm" and "service=tiller"
|
||||||
# airshipctl phase render initinfra -l app=helm,service=tiller
|
# airshipctl phase render initinfra -l app=helm,service=tiller
|
||||||
@ -28,11 +34,12 @@ Get all documents from config bundle
|
|||||||
Get all documents executor rendered documents for a phase
|
Get all documents executor rendered documents for a phase
|
||||||
# airshipctl phase render initinfra --source executor
|
# airshipctl phase render initinfra --source executor
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
-a, --annotation string filter documents by Annotations
|
-a, --annotation string filter documents by Annotations
|
||||||
-g, --apiversion string filter documents by API version
|
-g, --apiversion string filter documents by API version
|
||||||
-d, --decrypt ensure that decryption of encrypted documents has finished successfully
|
-d, --decrypt ensure that decryption of encrypted documents has finished successfully
|
||||||
@ -42,16 +49,17 @@ Get all documents executor rendered documents for a phase
|
|||||||
-s, --source string phase: phase entrypoint will be rendered by kustomize, if entrypoint is not specified error will be returned
|
-s, --source string phase: phase entrypoint will be rendered by kustomize, if entrypoint is not specified error will be returned
|
||||||
executor: rendering will be performed by executor if the phase
|
executor: rendering will be performed by executor if the phase
|
||||||
config: this will render bundle containing phase and executor documents (default "phase")
|
config: this will render bundle containing phase and executor documents (default "phase")
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl phase](airshipctl_phase.md) - Airshipctl command to manage phases
|
* :ref:`airshipctl phase <airshipctl_phase>` - Airshipctl command to manage phases
|
||||||
|
|
||||||
@ -1,43 +1,51 @@
|
|||||||
## airshipctl phase run
|
.. _airshipctl_phase_run:
|
||||||
|
|
||||||
|
airshipctl phase run
|
||||||
|
--------------------
|
||||||
|
|
||||||
Airshipctl command to run phase
|
Airshipctl command to run phase
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Run a phase such as controlplane-ephemeral, remotedirect-ephemeral, initinfra-ephemeral, etc...
|
Run a phase such as controlplane-ephemeral, remotedirect-ephemeral, initinfra-ephemeral, etc...
|
||||||
To list the phases associated with a site, run 'airshipctl phase list'.
|
To list the phases associated with a site, run 'airshipctl phase list'.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl phase run PHASE_NAME [flags]
|
airshipctl phase run PHASE_NAME [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Run initinfra phase
|
Run initinfra phase
|
||||||
# airshipctl phase run ephemeral-control-plane
|
# airshipctl phase run ephemeral-control-plane
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--dry-run simulate phase execution
|
--dry-run simulate phase execution
|
||||||
-h, --help help for run
|
-h, --help help for run
|
||||||
--wait-timeout duration wait timeout
|
--wait-timeout duration wait timeout
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl phase](airshipctl_phase.md) - Airshipctl command to manage phases
|
* :ref:`airshipctl phase <airshipctl_phase>` - Airshipctl command to manage phases
|
||||||
|
|
||||||
49
docs/source/cli/phase/airshipctl_phase_status.rst
Normal file
49
docs/source/cli/phase/airshipctl_phase_status.rst
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
.. _airshipctl_phase_status:
|
||||||
|
|
||||||
|
airshipctl phase status
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
Airshipctl command to show status of the phase
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Get the status of a phase such as ephemeral-control-plane, target-initinfra etc...
|
||||||
|
To list the phases associated with a site, run 'airshipctl phase list'.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl phase status PHASE_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
Status of initinfra phase
|
||||||
|
# airshipctl phase status ephemeral-control-plane
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for status
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl phase <airshipctl_phase>` - Airshipctl command to manage phases
|
||||||
|
|
||||||
51
docs/source/cli/phase/airshipctl_phase_tree.rst
Normal file
51
docs/source/cli/phase/airshipctl_phase_tree.rst
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
.. _airshipctl_phase_tree:
|
||||||
|
|
||||||
|
airshipctl phase tree
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Airshipctl command to show tree view of kustomize entrypoints of phase
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Get tree view of the kustomize entrypoints of a phase.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl phase tree PHASE_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
yaml explorer of a phase with relative path
|
||||||
|
# airshipctl phase tree /manifests/site/test-site/ephemeral/initinfra
|
||||||
|
|
||||||
|
yaml explorer of a phase with phase name
|
||||||
|
# airshipctl phase tree initinfra-ephemeral
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for tree
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl phase <airshipctl_phase>` - Airshipctl command to manage phases
|
||||||
|
|
||||||
48
docs/source/cli/phase/airshipctl_phase_validate.rst
Normal file
48
docs/source/cli/phase/airshipctl_phase_validate.rst
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
.. _airshipctl_phase_validate:
|
||||||
|
|
||||||
|
airshipctl phase validate
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
Airshipctl command to validate phase and its documents
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Validates phase and its documents. To list the phases associated with a site, run 'airshipctl phase list'.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl phase validate PHASE_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
To validate initinfra phase
|
||||||
|
# airshipctl phase validate initinfra
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for validate
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl phase <airshipctl_phase>` - Airshipctl command to manage phases
|
||||||
|
|
||||||
14
docs/source/cli/phase/index.rst
Normal file
14
docs/source/cli/phase/index.rst
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
####################
|
||||||
|
phase
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_phase
|
||||||
|
airshipctl_phase_list
|
||||||
|
airshipctl_phase_render
|
||||||
|
airshipctl_phase_run
|
||||||
|
airshipctl_phase_status
|
||||||
|
airshipctl_phase_tree
|
||||||
|
airshipctl_phase_validate
|
||||||
37
docs/source/cli/plan/airshipctl_plan.rst
Normal file
37
docs/source/cli/plan/airshipctl_plan.rst
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
.. _airshipctl_plan:
|
||||||
|
|
||||||
|
airshipctl plan
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Airshipctl command to manage plans
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Provides capabilities for interacting with plan objects, responsible for execution of phases in groups.
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for plan
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
* :ref:`airshipctl plan list <airshipctl_plan_list>` - Airshipctl command to list plans
|
||||||
|
* :ref:`airshipctl plan run <airshipctl_plan_run>` - Airshipctl command to run plan
|
||||||
|
* :ref:`airshipctl plan validate <airshipctl_plan_validate>` - Airshipctl command to validate plan
|
||||||
|
|
||||||
54
docs/source/cli/plan/airshipctl_plan_list.rst
Normal file
54
docs/source/cli/plan/airshipctl_plan_list.rst
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
.. _airshipctl_plan_list:
|
||||||
|
|
||||||
|
airshipctl plan list
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Airshipctl command to list plans
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
List plans defined in site manifest.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl plan list [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
List plan
|
||||||
|
# airshipctl plan list
|
||||||
|
|
||||||
|
List plan(yaml output format)
|
||||||
|
# airshipctl plan list -o yaml
|
||||||
|
|
||||||
|
List plan(table output format)
|
||||||
|
# airshipctl plan list -o table
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for list
|
||||||
|
-o, --output string output format. Supported formats are 'table' and 'yaml' (default "table")
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl plan <airshipctl_plan>` - Airshipctl command to manage plans
|
||||||
|
|
||||||
@ -1,20 +1,27 @@
|
|||||||
## airshipctl plan run
|
.. _airshipctl_plan_run:
|
||||||
|
|
||||||
|
airshipctl plan run
|
||||||
|
-------------------
|
||||||
|
|
||||||
Airshipctl command to run plan
|
Airshipctl command to run plan
|
||||||
|
|
||||||
### Synopsis
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
Run a plan defined in the site manifest. Specify the plan using the mandatory parameter PLAN_NAME.
|
Run a plan defined in the site manifest. Specify the plan using the mandatory parameter PLAN_NAME.
|
||||||
To get list of plans associated for a site, run 'airshipctl plan list'.
|
To get list of plans associated for a site, run 'airshipctl plan list'.
|
||||||
|
|
||||||
|
|
||||||
```
|
::
|
||||||
|
|
||||||
airshipctl plan run PLAN_NAME [flags]
|
airshipctl plan run PLAN_NAME [flags]
|
||||||
```
|
|
||||||
|
|
||||||
### Examples
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Run plan named iso
|
Run plan named iso
|
||||||
# airshipctl plan run iso
|
# airshipctl plan run iso
|
||||||
@ -22,24 +29,26 @@ Run plan named iso
|
|||||||
Perform a dry run of a plan
|
Perform a dry run of a plan
|
||||||
# airshipctl plan run iso --dry-run
|
# airshipctl plan run iso --dry-run
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--dry-run simulate phase execution
|
--dry-run simulate phase execution
|
||||||
-h, --help help for run
|
-h, --help help for run
|
||||||
--wait-timeout duration wait timeout
|
--wait-timeout duration wait timeout
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
```
|
|
||||||
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
--debug enable verbose output
|
--debug enable verbose output
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
* [airshipctl plan](airshipctl_plan.md) - Airshipctl command to manage plans
|
* :ref:`airshipctl plan <airshipctl_plan>` - Airshipctl command to manage plans
|
||||||
|
|
||||||
49
docs/source/cli/plan/airshipctl_plan_validate.rst
Normal file
49
docs/source/cli/plan/airshipctl_plan_validate.rst
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
.. _airshipctl_plan_validate:
|
||||||
|
|
||||||
|
airshipctl plan validate
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
Airshipctl command to validate plan
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Validate a plan defined in the site manifest. Specify the plan using the mandatory parameter PLAN_NAME.
|
||||||
|
To get list of plans associated for a site, run 'airshipctl plan list'.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl plan validate PLAN_NAME [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
Validate plan named iso
|
||||||
|
# airshipctl plan validate iso
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for validate
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl plan <airshipctl_plan>` - Airshipctl command to manage plans
|
||||||
|
|
||||||
11
docs/source/cli/plan/index.rst
Normal file
11
docs/source/cli/plan/index.rst
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
####################
|
||||||
|
plan
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_plan
|
||||||
|
airshipctl_plan_list
|
||||||
|
airshipctl_plan_run
|
||||||
|
airshipctl_plan_validate
|
||||||
34
docs/source/cli/secret/airshipctl_secret.rst
Normal file
34
docs/source/cli/secret/airshipctl_secret.rst
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
.. _airshipctl_secret:
|
||||||
|
|
||||||
|
airshipctl secret
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Airshipctl command to manage secrets
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Commands and sub-commnads defined can be used to manage secrets.
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for secret
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
* :ref:`airshipctl secret generate <airshipctl_secret_generate>` - Airshipctl command to generate secrets
|
||||||
|
|
||||||
34
docs/source/cli/secret/airshipctl_secret_generate.rst
Normal file
34
docs/source/cli/secret/airshipctl_secret_generate.rst
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
.. _airshipctl_secret_generate:
|
||||||
|
|
||||||
|
airshipctl secret generate
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
Airshipctl command to generate secrets
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Airshipctl command to generate secrets
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for generate
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl secret <airshipctl_secret>` - Airshipctl command to manage secrets
|
||||||
|
* :ref:`airshipctl secret generate encryptionkey <airshipctl_secret_generate_encryptionkey>` - Airshipctl command to generate a secure encryption key or passphrase
|
||||||
|
|
||||||
@ -0,0 +1,55 @@
|
|||||||
|
.. _airshipctl_secret_generate_encryptionkey:
|
||||||
|
|
||||||
|
airshipctl secret generate encryptionkey
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
Airshipctl command to generate a secure encryption key or passphrase
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Generates a secure encryption key or passphrase.
|
||||||
|
|
||||||
|
If regex arguments are passed the encryption key created would match the regular expression passed.
|
||||||
|
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl secret generate encryptionkey [flags]
|
||||||
|
|
||||||
|
Examples
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
Generates a secure encryption key or passphrase.
|
||||||
|
# airshipctl secret generate encryptionkey
|
||||||
|
|
||||||
|
Generates a secure encryption key or passphrase matching the regular expression
|
||||||
|
# airshipctl secret generate encryptionkey --regex Xy[a-c][0-9]!a*
|
||||||
|
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for encryptionkey
|
||||||
|
--limit int limit number of characters for + or * regex (default 5)
|
||||||
|
--regex string regular expression string
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl secret generate <airshipctl_secret_generate>` - Airshipctl command to generate secrets
|
||||||
|
|
||||||
10
docs/source/cli/secret/index.rst
Normal file
10
docs/source/cli/secret/index.rst
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
####################
|
||||||
|
secret
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_secret
|
||||||
|
airshipctl_secret_generate
|
||||||
|
airshipctl_secret_generate_encryptionkey
|
||||||
37
docs/source/cli/version/airshipctl_version.rst
Normal file
37
docs/source/cli/version/airshipctl_version.rst
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
.. _airshipctl_version:
|
||||||
|
|
||||||
|
airshipctl version
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Airshipctl command to display the current version number
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Airshipctl command to display the current version number
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
airshipctl version [flags]
|
||||||
|
|
||||||
|
Options
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
-h, --help help for version
|
||||||
|
|
||||||
|
Options inherited from parent commands
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
||||||
|
--debug enable verbose output
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* :ref:`airshipctl <airshipctl>` - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
|
||||||
|
|
||||||
8
docs/source/cli/version/index.rst
Normal file
8
docs/source/cli/version/index.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
####################
|
||||||
|
version
|
||||||
|
####################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
airshipctl_version
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user