4da8a54887
Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org
Steps to render the document locally
* Install sphinx: python3 -m pip install sphinx
* Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
* Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
* Run local server: cd _build; python3 -m http.server
* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document
Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352
65 lines
1.8 KiB
ReStructuredText
65 lines
1.8 KiB
ReStructuredText
.. _airshipctl_baremetal_poweron:
|
|
|
|
airshipctl baremetal poweron
|
|
----------------------------
|
|
|
|
Airshipctl command to power on host(s)
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
|
|
Power on bare metal host(s). The command will target bare metal hosts from airship site inventory based on the
|
|
--name, --namespace and --labels flags provided. If no flags are provided, airshipctl will select all bare metal hosts in the site
|
|
inventory.
|
|
|
|
|
|
::
|
|
|
|
airshipctl baremetal poweron [flags]
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
::
|
|
|
|
|
|
Perform poweron action against hosts with name rdm9r3s3 in all namespaces where the host is found
|
|
# airshipctl baremetal poweron --name rdm9r3s3
|
|
|
|
Perform poweron action against hosts with name rdm9r3s3 in metal3 namespace
|
|
# airshipctl baremetal poweron --name rdm9r3s3 --namespace metal3
|
|
|
|
Perform poweron action against all hosts defined in inventory
|
|
# airshipctl baremetal poweron --all
|
|
|
|
Perform poweron action against hosts with a label 'foo=bar'
|
|
# airshipctl baremetal poweron --labels "foo=bar"
|
|
|
|
|
|
Options
|
|
~~~~~~~
|
|
|
|
::
|
|
|
|
--all specify this to target all hosts in the site inventory
|
|
-h, --help help for poweron
|
|
-l, --labels string label(s) to filter desired bare metal host from site manifest documents
|
|
--name string name to filter desired bare metal host from site manifest document
|
|
-n, --namespace string airshipctl phase that contains the desired bare metal host from site manifest document(s)
|
|
--timeout duration timeout on bare metal action (default 10m0s)
|
|
|
|
Options inherited from parent commands
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
::
|
|
|
|
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
|
|
--debug enable verbose output
|
|
|
|
SEE ALSO
|
|
~~~~~~~~
|
|
|
|
* :ref:`airshipctl baremetal <airshipctl_baremetal>` - Airshipctl command to manage bare metal host(s)
|
|
|