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
Download Patch File Download Diff File Expand all files Collapse all files

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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