airship/airshipctl
Code Issues Proposed changes

Baremetal- updating cmd files for documentation

Browse Source 
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I323fa145b512e58cb878b117656c51bc39e76360
This commit is contained in:
Sirisha Gopigiri 2021-04-16 17:13:04 +05:30
parent 1f52d46374
commit ec3840a866
24 changed files with 249 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
cmd/baremetal/baremetal.go
View File

@ -28,28 +28,32 @@ import (
type Action int type Action int
const ( const (
baremetalLong = `
Provides commands that can be performed on bare metal host(s). The commands helps in
performing the basic boot and power operations on the bare metal host(s).
`
flagLabel = "labels" flagLabel = "labels"
flagLabelShort = "l" flagLabelShort = "l"
flagLabelDescription = "Label(s) to filter desired baremetal host documents" flagLabelDescription = "label(s) to filter desired bare metal host documents"
flagName = "name" flagName = "name"
flagNameDescription = "Name to filter desired baremetal host document" flagNameDescription = "name to filter desired bare metal host document"
flagNamespace = "namespace" flagNamespace = "namespace"
flagNamespaceSort = "n" flagNamespaceSort = "n"
flagNamespaceDescription = "airshipctl phase that contains the desired baremetal host document(s)" flagNamespaceDescription = "airshipctl phase that contains the desired bare metal host document(s)"
flagTimeout = "timeout" flagTimeout = "timeout"
flagTimeoutDescription = "timeout on baremetal action" flagTimeoutDescription = "timeout on bare metal action"
flagAll = "all" flagAll = "all"
flagAllDescription = "specify this to target all hosts in the inventory" flagAllDescription = "specify this to target all hosts in the inventory"
) )
var ( var (
selectorsDescription = fmt.Sprintf(`The command will target baremetal hosts from airship inventory kustomize root selectorsDescription = fmt.Sprintf(`The command will target bare metal hosts from airship inventory based on the
based on the --%s, --%s and --%s flags provided. If no flags are --%s, --%s and --%s flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
provided airshipctl will try to select all baremetal hosts in the inventory`, flagName, flagNamespace, flagLabel) inventory.`, flagName, flagNamespace, flagLabel)
bmhActionExampleTemplate = ` bmhActionExampleTemplate = `
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
@ -71,7 +75,8 @@ func NewBaremetalCommand(cfgFactory config.Factory) *cobra.Command {
options := inventory.NewOptions(inventory.NewInventory(cfgFactory)) options := inventory.NewOptions(inventory.NewInventory(cfgFactory))
baremetalRootCmd := &cobra.Command{ baremetalRootCmd := &cobra.Command{
Use: "baremetal", Use: "baremetal",
Short: "Perform actions on baremetal hosts", Short: "Airshipctl command to manage bare metal host(s)",
Long: baremetalLong,
} }
baremetalRootCmd.AddCommand(NewEjectMediaCommand(cfgFactory, options)) baremetalRootCmd.AddCommand(NewEjectMediaCommand(cfgFactory, options))

7
cmd/baremetal/ejectmedia.go
View File

@ -28,8 +28,7 @@ var (
ejectMediaCommand = "ejectmedia" ejectMediaCommand = "ejectmedia"
ejectMediaLong = fmt.Sprintf(` ejectMediaLong = fmt.Sprintf(`
Eject media attached to a baremetal hosts Eject virtual media attached to a bare metal host. %s
%s
`, selectorsDescription) `, selectorsDescription)
ejectMediaExample = fmt.Sprintf(bmhActionExampleTemplate, ejectMediaCommand) ejectMediaExample = fmt.Sprintf(bmhActionExampleTemplate, ejectMediaCommand)
@ -39,9 +38,9 @@ Eject media attached to a baremetal hosts
func NewEjectMediaCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { func NewEjectMediaCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: ejectMediaCommand, Use: ejectMediaCommand,
Short: "Eject media attached to a baremetal hosts", Short: "Airshipctl command to eject virtual media attached to a bare metal host",
Long: ejectMediaLong[1:], Long: ejectMediaLong[1:],
Example: ejectMediaExample[1:], Example: ejectMediaExample,
Args: cobra.NoArgs, Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return options.BMHAction(ifc.BaremetalOperationEjectVirtualMedia) return options.BMHAction(ifc.BaremetalOperationEjectVirtualMedia)

7
cmd/baremetal/poweroff.go
View File

@ -28,8 +28,7 @@ var (
powerOffCommand = "poweroff" powerOffCommand = "poweroff"
powerOffLong = fmt.Sprintf(` powerOffLong = fmt.Sprintf(`
Power off baremetal hosts Power off bare metal host(s). %s
%s
`, selectorsDescription) `, selectorsDescription)
powerOffExample = fmt.Sprintf(bmhActionExampleTemplate, powerOffCommand) powerOffExample = fmt.Sprintf(bmhActionExampleTemplate, powerOffCommand)
@ -39,9 +38,9 @@ Power off baremetal hosts
func NewPowerOffCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { func NewPowerOffCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: powerOffCommand, Use: powerOffCommand,
Short: "Shutdown a baremetal hosts", Short: "Airshipctl command to shutdown bare metal host(s)",
Long: powerOffLong[1:], Long: powerOffLong[1:],
Example: powerOffExample[1:], Example: powerOffExample,
Args: cobra.NoArgs, Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return options.BMHAction(ifc.BaremetalOperationPowerOff) return options.BMHAction(ifc.BaremetalOperationPowerOff)

7
cmd/baremetal/poweron.go
View File

@ -28,8 +28,7 @@ var (
powerOnCommand = "poweron" powerOnCommand = "poweron"
powerOnLong = fmt.Sprintf(` powerOnLong = fmt.Sprintf(`
Power on baremetal hosts Power on bare metal host(s). %s
%s
`, selectorsDescription) `, selectorsDescription)
powerOnExample = fmt.Sprintf(bmhActionExampleTemplate, powerOnCommand) powerOnExample = fmt.Sprintf(bmhActionExampleTemplate, powerOnCommand)
@ -39,9 +38,9 @@ Power on baremetal hosts
func NewPowerOnCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { func NewPowerOnCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: powerOnCommand, Use: powerOnCommand,
Short: "Power on a hosts", Short: "Airshipctl command to power on host(s)",
Long: powerOnLong[1:], Long: powerOnLong[1:],
Example: powerOnExample[1:], Example: powerOnExample,
Args: cobra.NoArgs, Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return options.BMHAction(ifc.BaremetalOperationPowerOn) return options.BMHAction(ifc.BaremetalOperationPowerOn)

26
cmd/baremetal/powerstatus.go
View File

@ -21,12 +21,32 @@ import (
"opendev.org/airship/airshipctl/pkg/inventory" "opendev.org/airship/airshipctl/pkg/inventory"
) )
var (
powerStatusLong = `
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.
`
powerStatusExample = `
Perform action against host with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal powerstatus --name rdm9r3s3
Perform action against host with name rdm9r3s3 in namespace metal3
# airshipctl baremetal powerstatus --name rdm9r3s3 --namespace metal3
Perform action against host with a label 'foo=bar'
# airshipctl baremetal powerstatus --labels "foo=bar"
`
)
// NewPowerStatusCommand provides a command to retrieve the power status of a baremetal host. // NewPowerStatusCommand provides a command to retrieve the power status of a baremetal host.
func NewPowerStatusCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { func NewPowerStatusCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "powerstatus", Use: "powerstatus",
Short: "Retrieve the power status of a baremetal host", Short: "Airshipctl command to retrieve the power status of a bare metal host",
Args: cobra.NoArgs, Long: powerStatusLong[1:],
Example: powerStatusExample,
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return options.PowerStatus(cmd.OutOrStdout()) return options.PowerStatus(cmd.OutOrStdout())
}, },

7
cmd/baremetal/reboot.go
View File

@ -28,8 +28,7 @@ var (
rebootCommand = "reboot" rebootCommand = "reboot"
rebootLong = fmt.Sprintf(` rebootLong = fmt.Sprintf(`
Reboot baremetal hosts Reboot bare metal host(s). %s
%s
`, selectorsDescription) `, selectorsDescription)
rebootExample = fmt.Sprintf(bmhActionExampleTemplate, rebootCommand) rebootExample = fmt.Sprintf(bmhActionExampleTemplate, rebootCommand)
@ -40,8 +39,8 @@ func NewRebootCommand(cfgFactory config.Factory, options *inventory.CommandOptio
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: rebootCommand, Use: rebootCommand,
Long: rebootLong[1:], Long: rebootLong[1:],
Short: "Reboot a hosts", Short: "Airshipctl command to reboot host(s)",
Example: rebootExample[1:], Example: rebootExample,
Args: cobra.NoArgs, Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return options.BMHAction(ifc.BaremetalOperationReboot) return options.BMHAction(ifc.BaremetalOperationReboot)

24
cmd/baremetal/remotedirect.go
View File

@ -21,11 +21,31 @@ import (
"opendev.org/airship/airshipctl/pkg/inventory" "opendev.org/airship/airshipctl/pkg/inventory"
) )
var (
remoteDirectLong = `
Bootstrap bare metal host. It targets bare metal host from airship inventory based
on the --iso-url, --name, --namespace, --label and --timeout flags provided.
`
remoteDirectExample = `
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal remotedirect --name rdm9r3s3
Perform action against hosts with name rdm9r3s3 in namespace metal3
# airshipctl baremetal remotedirect --name rdm9r3s3 --namespace metal3
Perform action against hosts with a label 'foo=bar'
# airshipctl baremetal remotedirect --labels "foo=bar"
`
)
// NewRemoteDirectCommand provides a command with the capability to perform remote direct operations. // NewRemoteDirectCommand provides a command with the capability to perform remote direct operations.
func NewRemoteDirectCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { func NewRemoteDirectCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "remotedirect", Use: "remotedirect",
Short: "Bootstrap the ephemeral host", Short: "Airshipctl command to bootstrap the ephemeral host",
Long: remoteDirectLong[1:],
Example: remoteDirectExample,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return options.RemoteDirect() return options.RemoteDirect()
}, },

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

@ -1,12 +1,12 @@
Eject media attached to a baremetal hosts Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship inventory based on the
The command will target baremetal hosts from airship inventory kustomize root --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
based on the --name, --namespace and --labels flags provided. If no flags are inventory.
provided airshipctl will try to select all baremetal hosts in the inventory
Usage: Usage:
ejectmedia [flags] ejectmedia [flags]
Examples: Examples:
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal ejectmedia --name rdm9r3s3 # airshipctl baremetal ejectmedia --name rdm9r3s3
@ -23,7 +23,7 @@ Perform action against hosts with a label 'foo=bar'
Flags: Flags:
--all specify this to target all hosts in the inventory --all specify this to target all hosts in the inventory
-h, --help help for ejectmedia -h, --help help for ejectmedia
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)

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

@ -1,12 +1,12 @@
Power off baremetal hosts Power off bare metal host(s). The command will target bare metal hosts from airship inventory based on the
The command will target baremetal hosts from airship inventory kustomize root --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
based on the --name, --namespace and --labels flags provided. If no flags are inventory.
provided airshipctl will try to select all baremetal hosts in the inventory
Usage: Usage:
poweroff [flags] poweroff [flags]
Examples: Examples:
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal poweroff --name rdm9r3s3 # airshipctl baremetal poweroff --name rdm9r3s3
@ -23,7 +23,7 @@ Perform action against hosts with a label 'foo=bar'
Flags: Flags:
--all specify this to target all hosts in the inventory --all specify this to target all hosts in the inventory
-h, --help help for poweroff -h, --help help for poweroff
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)

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

@ -1,12 +1,12 @@
Power on baremetal hosts Power on bare metal host(s). The command will target bare metal hosts from airship inventory based on the
The command will target baremetal hosts from airship inventory kustomize root --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
based on the --name, --namespace and --labels flags provided. If no flags are inventory.
provided airshipctl will try to select all baremetal hosts in the inventory
Usage: Usage:
poweron [flags] poweron [flags]
Examples: Examples:
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal poweron --name rdm9r3s3 # airshipctl baremetal poweron --name rdm9r3s3
@ -23,7 +23,7 @@ Perform action against hosts with a label 'foo=bar'
Flags: Flags:
--all specify this to target all hosts in the inventory --all specify this to target all hosts in the inventory
-h, --help help for poweron -h, --help help for poweron
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)

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

@ -1,11 +1,24 @@
Retrieve the power status of a baremetal host 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.
Usage: Usage:
powerstatus [flags] powerstatus [flags]
Examples:
Perform action against host with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal powerstatus --name rdm9r3s3
Perform action against host with name rdm9r3s3 in namespace metal3
# airshipctl baremetal powerstatus --name rdm9r3s3 --namespace metal3
Perform action against host with a label 'foo=bar'
# airshipctl baremetal powerstatus --labels "foo=bar"
Flags: Flags:
-h, --help help for powerstatus -h, --help help for powerstatus
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)

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

@ -1,12 +1,12 @@
Reboot baremetal hosts Reboot bare metal host(s). The command will target bare metal hosts from airship inventory based on the
The command will target baremetal hosts from airship inventory kustomize root --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
based on the --name, --namespace and --labels flags provided. If no flags are inventory.
provided airshipctl will try to select all baremetal hosts in the inventory
Usage: Usage:
reboot [flags] reboot [flags]
Examples: Examples:
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal reboot --name rdm9r3s3 # airshipctl baremetal reboot --name rdm9r3s3
@ -23,7 +23,7 @@ Perform action against hosts with a label 'foo=bar'
Flags: Flags:
--all specify this to target all hosts in the inventory --all specify this to target all hosts in the inventory
-h, --help help for reboot -h, --help help for reboot
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)

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

@ -1,12 +1,25 @@
Bootstrap the ephemeral host Bootstrap bare metal host. It targets bare metal host from airship inventory based
on the --iso-url, --name, --namespace, --label and --timeout flags provided.
Usage: Usage:
remotedirect [flags] remotedirect [flags]
Examples:
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal remotedirect --name rdm9r3s3
Perform action against hosts with name rdm9r3s3 in namespace metal3
# airshipctl baremetal remotedirect --name rdm9r3s3 --namespace metal3
Perform action against hosts with a label 'foo=bar'
# airshipctl baremetal remotedirect --labels "foo=bar"
Flags: Flags:
-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 baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)

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

@ -1,16 +1,18 @@
Perform actions on baremetal hosts
Provides commands that can be performed on bare metal host(s). The commands helps in
performing the basic boot and power operations on the bare metal host(s).
Usage: Usage:
baremetal [command] baremetal [command]
Available Commands: Available Commands:
ejectmedia Eject media attached to a baremetal hosts ejectmedia Airshipctl command to eject virtual media attached to a bare metal host
help Help about any command help Help about any command
poweroff Shutdown a baremetal hosts poweroff Airshipctl command to shutdown bare metal host(s)
poweron Power on a hosts poweron Airshipctl command to power on host(s)
powerstatus Retrieve the power status of a baremetal host powerstatus Airshipctl command to retrieve the power status of a bare metal host
reboot Reboot a hosts reboot Airshipctl command to reboot host(s)
remotedirect Bootstrap the ephemeral host remotedirect Airshipctl command to bootstrap the ephemeral host
Flags: Flags:
-h, --help help for baremetal -h, --help help for baremetal

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

@ -4,7 +4,7 @@ Usage:
airshipctl [command] airshipctl [command]
Available Commands: Available Commands:
baremetal Perform actions on baremetal hosts baremetal Airshipctl command to manage bare metal host(s)
cluster Manage Kubernetes clusters cluster Manage Kubernetes clusters
completion Generate completion script for the specified shell (bash or zsh) completion Generate completion script for the specified shell (bash or zsh)
config Manage the airshipctl config file config Manage the airshipctl config file

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

@ -4,7 +4,7 @@ Usage:
airshipctl [command] airshipctl [command]
Available Commands: Available Commands:
baremetal Perform actions on baremetal hosts baremetal Airshipctl command to manage bare metal host(s)
help Help about any command help Help about any command
Flags: Flags:

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

@ -16,7 +16,7 @@ A unified entrypoint to various airship components
### SEE ALSO ### SEE ALSO
* [airshipctl baremetal](airshipctl_baremetal.md) - Perform actions on baremetal hosts * [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)
* [airshipctl cluster](airshipctl_cluster.md) - Manage Kubernetes clusters * [airshipctl cluster](airshipctl_cluster.md) - Manage Kubernetes clusters
* [airshipctl completion](airshipctl_completion.md) - Generate completion script for the specified shell (bash or zsh) * [airshipctl completion](airshipctl_completion.md) - Generate completion script for the specified shell (bash or zsh)
* [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file * [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file

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

@ -1,10 +1,13 @@
## airshipctl baremetal ## airshipctl baremetal
Perform actions on baremetal hosts Airshipctl command to manage bare metal host(s)
### Synopsis ### Synopsis
Perform actions on baremetal hosts
Provides commands that can be performed on bare metal host(s). The commands helps in
performing the basic boot and power operations on the bare metal host(s).
### Options ### Options
@ -22,10 +25,10 @@ Perform actions on baremetal hosts
### SEE ALSO ### SEE ALSO
* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components * [airshipctl](airshipctl.md) - A unified entrypoint to various airship components
* [airshipctl baremetal ejectmedia](airshipctl_baremetal_ejectmedia.md) - Eject media attached to a baremetal hosts * [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) - Shutdown a baremetal hosts * [airshipctl baremetal poweroff](airshipctl_baremetal_poweroff.md) - Airshipctl command to shutdown bare metal host(s)
* [airshipctl baremetal poweron](airshipctl_baremetal_poweron.md) - Power on a hosts * [airshipctl baremetal poweron](airshipctl_baremetal_poweron.md) - Airshipctl command to power on host(s)
* [airshipctl baremetal powerstatus](airshipctl_baremetal_powerstatus.md) - Retrieve the power status of a baremetal host * [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) - Reboot a hosts * [airshipctl baremetal reboot](airshipctl_baremetal_reboot.md) - Airshipctl command to reboot host(s)
* [airshipctl baremetal remotedirect](airshipctl_baremetal_remotedirect.md) - Bootstrap the ephemeral host * [airshipctl baremetal remotedirect](airshipctl_baremetal_remotedirect.md) - Airshipctl command to bootstrap the ephemeral host

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

@ -1,13 +1,12 @@
## airshipctl baremetal ejectmedia ## airshipctl baremetal ejectmedia
Eject media attached to a baremetal hosts Airshipctl command to eject virtual media attached to a bare metal host
### Synopsis ### Synopsis
Eject media attached to a baremetal hosts Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship inventory based on the
The command will target baremetal hosts from airship inventory kustomize root --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
based on the --name, --namespace and --labels flags provided. If no flags are inventory.
provided airshipctl will try to select all baremetal hosts in the inventory
``` ```
@ -17,6 +16,7 @@ airshipctl baremetal ejectmedia [flags]
### Examples ### Examples
``` ```
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal ejectmedia --name rdm9r3s3 # airshipctl baremetal ejectmedia --name rdm9r3s3
@ -36,10 +36,10 @@ Perform action against hosts with a label 'foo=bar'
``` ```
--all specify this to target all hosts in the inventory --all specify this to target all hosts in the inventory
-h, --help help for ejectmedia -h, --help help for ejectmedia
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -51,5 +51,5 @@ Perform action against hosts with a label 'foo=bar'
### SEE ALSO ### SEE ALSO
* [airshipctl baremetal](airshipctl_baremetal.md) - Perform actions on baremetal hosts * [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)

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

@ -1,13 +1,12 @@
## airshipctl baremetal poweroff ## airshipctl baremetal poweroff
Shutdown a baremetal hosts Airshipctl command to shutdown bare metal host(s)
### Synopsis ### Synopsis
Power off baremetal hosts Power off bare metal host(s). The command will target bare metal hosts from airship inventory based on the
The command will target baremetal hosts from airship inventory kustomize root --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
based on the --name, --namespace and --labels flags provided. If no flags are inventory.
provided airshipctl will try to select all baremetal hosts in the inventory
``` ```
@ -17,6 +16,7 @@ airshipctl baremetal poweroff [flags]
### Examples ### Examples
``` ```
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal poweroff --name rdm9r3s3 # airshipctl baremetal poweroff --name rdm9r3s3
@ -36,10 +36,10 @@ Perform action against hosts with a label 'foo=bar'
``` ```
--all specify this to target all hosts in the inventory --all specify this to target all hosts in the inventory
-h, --help help for poweroff -h, --help help for poweroff
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -51,5 +51,5 @@ Perform action against hosts with a label 'foo=bar'
### SEE ALSO ### SEE ALSO
* [airshipctl baremetal](airshipctl_baremetal.md) - Perform actions on baremetal hosts * [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)

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

@ -1,13 +1,12 @@
## airshipctl baremetal poweron ## airshipctl baremetal poweron
Power on a hosts Airshipctl command to power on host(s)
### Synopsis ### Synopsis
Power on baremetal hosts Power on bare metal host(s). The command will target bare metal hosts from airship inventory based on the
The command will target baremetal hosts from airship inventory kustomize root --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
based on the --name, --namespace and --labels flags provided. If no flags are inventory.
provided airshipctl will try to select all baremetal hosts in the inventory
``` ```
@ -17,6 +16,7 @@ airshipctl baremetal poweron [flags]
### Examples ### Examples
``` ```
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal poweron --name rdm9r3s3 # airshipctl baremetal poweron --name rdm9r3s3
@ -36,10 +36,10 @@ Perform action against hosts with a label 'foo=bar'
``` ```
--all specify this to target all hosts in the inventory --all specify this to target all hosts in the inventory
-h, --help help for poweron -h, --help help for poweron
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -51,5 +51,5 @@ Perform action against hosts with a label 'foo=bar'
### SEE ALSO ### SEE ALSO
* [airshipctl baremetal](airshipctl_baremetal.md) - Perform actions on baremetal hosts * [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)

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

@ -1,23 +1,40 @@
## airshipctl baremetal powerstatus ## airshipctl baremetal powerstatus
Retrieve the power status of a baremetal host Airshipctl command to retrieve the power status of a bare metal host
### Synopsis ### Synopsis
Retrieve the power status of a baremetal host 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.
``` ```
airshipctl baremetal powerstatus [flags] airshipctl baremetal powerstatus [flags]
``` ```
### Examples
```
Perform action against host with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal powerstatus --name rdm9r3s3
Perform action against host with name rdm9r3s3 in namespace metal3
# airshipctl baremetal powerstatus --name rdm9r3s3 --namespace metal3
Perform action against host with a label '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 baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -29,5 +46,5 @@ airshipctl baremetal powerstatus [flags]
### SEE ALSO ### SEE ALSO
* [airshipctl baremetal](airshipctl_baremetal.md) - Perform actions on baremetal hosts * [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)

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

@ -1,13 +1,12 @@
## airshipctl baremetal reboot ## airshipctl baremetal reboot
Reboot a hosts Airshipctl command to reboot host(s)
### Synopsis ### Synopsis
Reboot baremetal hosts Reboot bare metal host(s). The command will target bare metal hosts from airship inventory based on the
The command will target baremetal hosts from airship inventory kustomize root --name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the
based on the --name, --namespace and --labels flags provided. If no flags are inventory.
provided airshipctl will try to select all baremetal hosts in the inventory
``` ```
@ -17,6 +16,7 @@ airshipctl baremetal reboot [flags]
### Examples ### Examples
``` ```
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal reboot --name rdm9r3s3 # airshipctl baremetal reboot --name rdm9r3s3
@ -36,10 +36,10 @@ Perform action against hosts with a label 'foo=bar'
``` ```
--all specify this to target all hosts in the inventory --all specify this to target all hosts in the inventory
-h, --help help for reboot -h, --help help for reboot
-l, --labels string Label(s) to filter desired baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -51,5 +51,5 @@ Perform action against hosts with a label 'foo=bar'
### SEE ALSO ### SEE ALSO
* [airshipctl baremetal](airshipctl_baremetal.md) - Perform actions on baremetal hosts * [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)

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

@ -1,24 +1,41 @@
## airshipctl baremetal remotedirect ## airshipctl baremetal remotedirect
Bootstrap the ephemeral host Airshipctl command to bootstrap the ephemeral host
### Synopsis ### Synopsis
Bootstrap the ephemeral host Bootstrap bare metal host. It targets bare metal host from airship inventory based
on the --iso-url, --name, --namespace, --label and --timeout flags provided.
``` ```
airshipctl baremetal remotedirect [flags] airshipctl baremetal remotedirect [flags]
``` ```
### Examples
```
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal remotedirect --name rdm9r3s3
Perform action against hosts with name rdm9r3s3 in namespace metal3
# airshipctl baremetal remotedirect --name rdm9r3s3 --namespace metal3
Perform action against hosts with a label '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 baremetal host documents -l, --labels string label(s) to filter desired bare metal host documents
--name string Name to filter desired baremetal host document --name string name to filter desired bare metal host document
-n, --namespace string airshipctl phase that contains the desired baremetal host document(s) -n, --namespace string airshipctl phase that contains the desired bare metal host document(s)
--timeout duration timeout on baremetal action (default 10m0s) --timeout duration timeout on bare metal action (default 10m0s)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -30,5 +47,5 @@ airshipctl baremetal remotedirect [flags]
### SEE ALSO ### SEE ALSO
* [airshipctl baremetal](airshipctl_baremetal.md) - Perform actions on baremetal hosts * [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)