diff --git a/cmd/baremetal/baremetal.go b/cmd/baremetal/baremetal.go index 7b1b0cfc5..b1a47709f 100644 --- a/cmd/baremetal/baremetal.go +++ b/cmd/baremetal/baremetal.go @@ -28,28 +28,32 @@ import ( type Action int 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" flagLabelShort = "l" - flagLabelDescription = "Label(s) to filter desired baremetal host documents" + flagLabelDescription = "label(s) to filter desired bare metal host documents" flagName = "name" - flagNameDescription = "Name to filter desired baremetal host document" + flagNameDescription = "name to filter desired bare metal host document" flagNamespace = "namespace" 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" - flagTimeoutDescription = "timeout on baremetal action" + flagTimeoutDescription = "timeout on bare metal action" flagAll = "all" flagAllDescription = "specify this to target all hosts in the inventory" ) var ( - selectorsDescription = fmt.Sprintf(`The command will target baremetal hosts from airship inventory kustomize root -based on the --%s, --%s and --%s flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory`, flagName, flagNamespace, flagLabel) + selectorsDescription = fmt.Sprintf(`The command will target bare metal hosts from airship inventory based on the +--%s, --%s and --%s flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory.`, flagName, flagNamespace, flagLabel) bmhActionExampleTemplate = ` 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)) baremetalRootCmd := &cobra.Command{ Use: "baremetal", - Short: "Perform actions on baremetal hosts", + Short: "Airshipctl command to manage bare metal host(s)", + Long: baremetalLong, } baremetalRootCmd.AddCommand(NewEjectMediaCommand(cfgFactory, options)) diff --git a/cmd/baremetal/ejectmedia.go b/cmd/baremetal/ejectmedia.go index 37c76539f..aef460ec2 100644 --- a/cmd/baremetal/ejectmedia.go +++ b/cmd/baremetal/ejectmedia.go @@ -28,8 +28,7 @@ var ( ejectMediaCommand = "ejectmedia" ejectMediaLong = fmt.Sprintf(` -Eject media attached to a baremetal hosts -%s +Eject virtual media attached to a bare metal host. %s `, selectorsDescription) 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 { cmd := &cobra.Command{ 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:], - Example: ejectMediaExample[1:], + Example: ejectMediaExample, Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { return options.BMHAction(ifc.BaremetalOperationEjectVirtualMedia) diff --git a/cmd/baremetal/poweroff.go b/cmd/baremetal/poweroff.go index c67fe4654..a3af0be86 100644 --- a/cmd/baremetal/poweroff.go +++ b/cmd/baremetal/poweroff.go @@ -28,8 +28,7 @@ var ( powerOffCommand = "poweroff" powerOffLong = fmt.Sprintf(` -Power off baremetal hosts -%s +Power off bare metal host(s). %s `, selectorsDescription) powerOffExample = fmt.Sprintf(bmhActionExampleTemplate, powerOffCommand) @@ -39,9 +38,9 @@ Power off baremetal hosts func NewPowerOffCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { cmd := &cobra.Command{ Use: powerOffCommand, - Short: "Shutdown a baremetal hosts", + Short: "Airshipctl command to shutdown bare metal host(s)", Long: powerOffLong[1:], - Example: powerOffExample[1:], + Example: powerOffExample, Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { return options.BMHAction(ifc.BaremetalOperationPowerOff) diff --git a/cmd/baremetal/poweron.go b/cmd/baremetal/poweron.go index d84a89098..1e174b944 100644 --- a/cmd/baremetal/poweron.go +++ b/cmd/baremetal/poweron.go @@ -28,8 +28,7 @@ var ( powerOnCommand = "poweron" powerOnLong = fmt.Sprintf(` -Power on baremetal hosts -%s +Power on bare metal host(s). %s `, selectorsDescription) powerOnExample = fmt.Sprintf(bmhActionExampleTemplate, powerOnCommand) @@ -39,9 +38,9 @@ Power on baremetal hosts func NewPowerOnCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { cmd := &cobra.Command{ Use: powerOnCommand, - Short: "Power on a hosts", + Short: "Airshipctl command to power on host(s)", Long: powerOnLong[1:], - Example: powerOnExample[1:], + Example: powerOnExample, Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { return options.BMHAction(ifc.BaremetalOperationPowerOn) diff --git a/cmd/baremetal/powerstatus.go b/cmd/baremetal/powerstatus.go index f4edf1f2d..25c706c80 100644 --- a/cmd/baremetal/powerstatus.go +++ b/cmd/baremetal/powerstatus.go @@ -21,12 +21,32 @@ import ( "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. func NewPowerStatusCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { cmd := &cobra.Command{ - Use: "powerstatus", - Short: "Retrieve the power status of a baremetal host", - Args: cobra.NoArgs, + Use: "powerstatus", + Short: "Airshipctl command to retrieve the power status of a bare metal host", + Long: powerStatusLong[1:], + Example: powerStatusExample, + Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { return options.PowerStatus(cmd.OutOrStdout()) }, diff --git a/cmd/baremetal/reboot.go b/cmd/baremetal/reboot.go index 9a481eb6a..d58400791 100644 --- a/cmd/baremetal/reboot.go +++ b/cmd/baremetal/reboot.go @@ -28,8 +28,7 @@ var ( rebootCommand = "reboot" rebootLong = fmt.Sprintf(` -Reboot baremetal hosts -%s +Reboot bare metal host(s). %s `, selectorsDescription) rebootExample = fmt.Sprintf(bmhActionExampleTemplate, rebootCommand) @@ -40,8 +39,8 @@ func NewRebootCommand(cfgFactory config.Factory, options *inventory.CommandOptio cmd := &cobra.Command{ Use: rebootCommand, Long: rebootLong[1:], - Short: "Reboot a hosts", - Example: rebootExample[1:], + Short: "Airshipctl command to reboot host(s)", + Example: rebootExample, Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { return options.BMHAction(ifc.BaremetalOperationReboot) diff --git a/cmd/baremetal/remotedirect.go b/cmd/baremetal/remotedirect.go index ebda41ce7..860c2f345 100644 --- a/cmd/baremetal/remotedirect.go +++ b/cmd/baremetal/remotedirect.go @@ -21,11 +21,31 @@ import ( "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. func NewRemoteDirectCommand(cfgFactory config.Factory, options *inventory.CommandOptions) *cobra.Command { cmd := &cobra.Command{ - Use: "remotedirect", - Short: "Bootstrap the ephemeral host", + Use: "remotedirect", + Short: "Airshipctl command to bootstrap the ephemeral host", + Long: remoteDirectLong[1:], + Example: remoteDirectExample, RunE: func(cmd *cobra.Command, args []string) error { return options.RemoteDirect() }, diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden index 11e6d2298..159f5c859 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-ejectmedia-with-help.golden @@ -1,12 +1,12 @@ -Eject media attached to a baremetal hosts -The command will target baremetal hosts from airship inventory kustomize root -based on the --name, --namespace and --labels flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory +Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory. Usage: ejectmedia [flags] Examples: + Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal ejectmedia --name rdm9r3s3 @@ -23,7 +23,7 @@ Perform action against hosts with a label 'foo=bar' Flags: --all specify this to target all hosts in the inventory -h, --help help for ejectmedia - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden index d5ce74613..80351db5e 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweroff-with-help.golden @@ -1,12 +1,12 @@ -Power off baremetal hosts -The command will target baremetal hosts from airship inventory kustomize root -based on the --name, --namespace and --labels flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory +Power off bare metal host(s). The command will target bare metal hosts from airship inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory. Usage: poweroff [flags] Examples: + Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal poweroff --name rdm9r3s3 @@ -23,7 +23,7 @@ Perform action against hosts with a label 'foo=bar' Flags: --all specify this to target all hosts in the inventory -h, --help help for poweroff - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden index 976009921..518664179 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-poweron-with-help.golden @@ -1,12 +1,12 @@ -Power on baremetal hosts -The command will target baremetal hosts from airship inventory kustomize root -based on the --name, --namespace and --labels flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory +Power on bare metal host(s). The command will target bare metal hosts from airship inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory. Usage: poweron [flags] Examples: + Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal poweron --name rdm9r3s3 @@ -23,7 +23,7 @@ Perform action against hosts with a label 'foo=bar' Flags: --all specify this to target all hosts in the inventory -h, --help help for poweron - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden index 260b6152b..a551d0241 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-powerstatus-with-help.golden @@ -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: 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: -h, --help help for powerstatus - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden index e40a87edf..3b1bd40f2 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-reboot-with-help.golden @@ -1,12 +1,12 @@ -Reboot baremetal hosts -The command will target baremetal hosts from airship inventory kustomize root -based on the --name, --namespace and --labels flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory +Reboot bare metal host(s). The command will target bare metal hosts from airship inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory. Usage: reboot [flags] Examples: + Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found # airshipctl baremetal reboot --name rdm9r3s3 @@ -23,7 +23,7 @@ Perform action against hosts with a label 'foo=bar' Flags: --all specify this to target all hosts in the inventory -h, --help help for reboot - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden index 3152cc0c2..8968e58b8 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-remotedirect-with-help.golden @@ -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: 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: -h, --help help for remotedirect --iso-url string specify iso url for host to boot from - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) diff --git a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden index 698b9f28e..f4b6ffc0c 100644 --- a/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden +++ b/cmd/baremetal/testdata/TestBaremetalGoldenOutput/baremetal-with-help.golden @@ -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: baremetal [command] 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 - poweroff Shutdown a baremetal hosts - poweron Power on a hosts - powerstatus Retrieve the power status of a baremetal host - reboot Reboot a hosts - remotedirect Bootstrap the ephemeral host + poweroff Airshipctl command to shutdown bare metal host(s) + poweron Airshipctl command to power on host(s) + powerstatus Airshipctl command to retrieve the power status of a bare metal host + reboot Airshipctl command to reboot host(s) + remotedirect Airshipctl command to bootstrap the ephemeral host Flags: -h, --help help for baremetal diff --git a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden index 5faaec4d3..642f4e986 100644 --- a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden +++ b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden @@ -4,7 +4,7 @@ Usage: airshipctl [command] Available Commands: - baremetal Perform actions on baremetal hosts + baremetal Airshipctl command to manage bare metal host(s) cluster Manage Kubernetes clusters completion Generate completion script for the specified shell (bash or zsh) config Manage the airshipctl config file diff --git a/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden b/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden index a83284cb9..d918aaf82 100644 --- a/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden +++ b/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden @@ -4,7 +4,7 @@ Usage: airshipctl [command] Available Commands: - baremetal Perform actions on baremetal hosts + baremetal Airshipctl command to manage bare metal host(s) help Help about any command Flags: diff --git a/docs/source/cli/airshipctl.md b/docs/source/cli/airshipctl.md index cdbdd3415..0335c87d2 100644 --- a/docs/source/cli/airshipctl.md +++ b/docs/source/cli/airshipctl.md @@ -16,7 +16,7 @@ A unified entrypoint to various airship components ### 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 completion](airshipctl_completion.md) - Generate completion script for the specified shell (bash or zsh) * [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file diff --git a/docs/source/cli/airshipctl_baremetal.md b/docs/source/cli/airshipctl_baremetal.md index 0d6a6c732..8988e7105 100644 --- a/docs/source/cli/airshipctl_baremetal.md +++ b/docs/source/cli/airshipctl_baremetal.md @@ -1,10 +1,13 @@ ## airshipctl baremetal -Perform actions on baremetal hosts +Airshipctl command to manage bare metal host(s) ### 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 @@ -22,10 +25,10 @@ Perform actions on baremetal hosts ### SEE ALSO * [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 poweroff](airshipctl_baremetal_poweroff.md) - Shutdown a baremetal hosts -* [airshipctl baremetal poweron](airshipctl_baremetal_poweron.md) - Power on a hosts -* [airshipctl baremetal powerstatus](airshipctl_baremetal_powerstatus.md) - Retrieve the power status of a baremetal host -* [airshipctl baremetal reboot](airshipctl_baremetal_reboot.md) - Reboot a hosts -* [airshipctl baremetal remotedirect](airshipctl_baremetal_remotedirect.md) - Bootstrap the ephemeral host +* [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 diff --git a/docs/source/cli/airshipctl_baremetal_ejectmedia.md b/docs/source/cli/airshipctl_baremetal_ejectmedia.md index 9f1967680..1af4252f3 100644 --- a/docs/source/cli/airshipctl_baremetal_ejectmedia.md +++ b/docs/source/cli/airshipctl_baremetal_ejectmedia.md @@ -1,13 +1,12 @@ ## airshipctl baremetal ejectmedia -Eject media attached to a baremetal hosts +Airshipctl command to eject virtual media attached to a bare metal host ### Synopsis -Eject media attached to a baremetal hosts -The command will target baremetal hosts from airship inventory kustomize root -based on the --name, --namespace and --labels flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory +Eject virtual media attached to a bare metal host. The command will target bare metal hosts from airship inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory. ``` @@ -17,6 +16,7 @@ airshipctl baremetal ejectmedia [flags] ### Examples ``` + Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found # 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 -h, --help help for ejectmedia - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands @@ -51,5 +51,5 @@ Perform action against hosts with a label 'foo=bar' ### 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) diff --git a/docs/source/cli/airshipctl_baremetal_poweroff.md b/docs/source/cli/airshipctl_baremetal_poweroff.md index b42354a4b..9544f2d7e 100644 --- a/docs/source/cli/airshipctl_baremetal_poweroff.md +++ b/docs/source/cli/airshipctl_baremetal_poweroff.md @@ -1,13 +1,12 @@ ## airshipctl baremetal poweroff -Shutdown a baremetal hosts +Airshipctl command to shutdown bare metal host(s) ### Synopsis -Power off baremetal hosts -The command will target baremetal hosts from airship inventory kustomize root -based on the --name, --namespace and --labels flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory +Power off bare metal host(s). The command will target bare metal hosts from airship inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory. ``` @@ -17,6 +16,7 @@ airshipctl baremetal poweroff [flags] ### Examples ``` + Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found # 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 -h, --help help for poweroff - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands @@ -51,5 +51,5 @@ Perform action against hosts with a label 'foo=bar' ### 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) diff --git a/docs/source/cli/airshipctl_baremetal_poweron.md b/docs/source/cli/airshipctl_baremetal_poweron.md index 1173239a6..eade320ad 100644 --- a/docs/source/cli/airshipctl_baremetal_poweron.md +++ b/docs/source/cli/airshipctl_baremetal_poweron.md @@ -1,13 +1,12 @@ ## airshipctl baremetal poweron -Power on a hosts +Airshipctl command to power on host(s) ### Synopsis -Power on baremetal hosts -The command will target baremetal hosts from airship inventory kustomize root -based on the --name, --namespace and --labels flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory +Power on bare metal host(s). The command will target bare metal hosts from airship inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory. ``` @@ -17,6 +16,7 @@ airshipctl baremetal poweron [flags] ### Examples ``` + Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found # 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 -h, --help help for poweron - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands @@ -51,5 +51,5 @@ Perform action against hosts with a label 'foo=bar' ### 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) diff --git a/docs/source/cli/airshipctl_baremetal_powerstatus.md b/docs/source/cli/airshipctl_baremetal_powerstatus.md index b20bd1e12..0106afd1f 100644 --- a/docs/source/cli/airshipctl_baremetal_powerstatus.md +++ b/docs/source/cli/airshipctl_baremetal_powerstatus.md @@ -1,23 +1,40 @@ ## airshipctl baremetal powerstatus -Retrieve the power status of a baremetal host +Airshipctl command to retrieve the power status of a bare metal host ### 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] ``` +### 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 ``` -h, --help help for powerstatus - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands @@ -29,5 +46,5 @@ airshipctl baremetal powerstatus [flags] ### 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) diff --git a/docs/source/cli/airshipctl_baremetal_reboot.md b/docs/source/cli/airshipctl_baremetal_reboot.md index 0bec99d90..8e531c98d 100644 --- a/docs/source/cli/airshipctl_baremetal_reboot.md +++ b/docs/source/cli/airshipctl_baremetal_reboot.md @@ -1,13 +1,12 @@ ## airshipctl baremetal reboot -Reboot a hosts +Airshipctl command to reboot host(s) ### Synopsis -Reboot baremetal hosts -The command will target baremetal hosts from airship inventory kustomize root -based on the --name, --namespace and --labels flags provided. If no flags are -provided airshipctl will try to select all baremetal hosts in the inventory +Reboot bare metal host(s). The command will target bare metal hosts from airship inventory based on the +--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the +inventory. ``` @@ -17,6 +16,7 @@ airshipctl baremetal reboot [flags] ### Examples ``` + Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found # 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 -h, --help help for reboot - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands @@ -51,5 +51,5 @@ Perform action against hosts with a label 'foo=bar' ### 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) diff --git a/docs/source/cli/airshipctl_baremetal_remotedirect.md b/docs/source/cli/airshipctl_baremetal_remotedirect.md index b72055eda..6f56c2ac0 100644 --- a/docs/source/cli/airshipctl_baremetal_remotedirect.md +++ b/docs/source/cli/airshipctl_baremetal_remotedirect.md @@ -1,24 +1,41 @@ ## airshipctl baremetal remotedirect -Bootstrap the ephemeral host +Airshipctl command to bootstrap the ephemeral host ### 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] ``` +### 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 ``` -h, --help help for remotedirect --iso-url string specify iso url for host to boot from - -l, --labels string Label(s) to filter desired baremetal host documents - --name string Name to filter desired baremetal host document - -n, --namespace string airshipctl phase that contains the desired baremetal host document(s) - --timeout duration timeout on baremetal action (default 10m0s) + -l, --labels string label(s) to filter desired bare metal host documents + --name string name to filter desired bare metal host document + -n, --namespace string airshipctl phase that contains the desired bare metal host document(s) + --timeout duration timeout on bare metal action (default 10m0s) ``` ### Options inherited from parent commands @@ -30,5 +47,5 @@ airshipctl baremetal remotedirect [flags] ### 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)