airship/airshipctl
Code Issues Proposed changes
airshipctl/docs/source/cli/baremetal/airshipctl_baremetal.rst
Sirisha Gopigiri 4da8a54887 Separate folders-Create airshipctl cli user guide documentation 
Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org

Steps to render the document locally

	* Install sphinx: python3 -m pip install sphinx
        * Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
        * Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
	* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
	* Run local server: cd _build; python3 -m http.server
	* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document

Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352
2021-06-28 10:20:55 +05:30

1.5 KiB
Raw Blame History

airshipctl baremetal

Airshipctl command to manage bare metal host(s)

Synopsis

Provides commands that can be performed on bare metal host(s). The commands help in performing the basic boot and power operations on the bare metal host(s).

Options

-h, --help   help for baremetal

Options inherited from parent commands

--airshipconf string   path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
--debug                enable verbose output

SEE ALSO

  • airshipctl <airshipctl> - A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
  • airshipctl baremetal ejectmedia <airshipctl_baremetal_ejectmedia> - Airshipctl command to eject virtual media attached to a bare metal host
  • airshipctl baremetal poweroff <airshipctl_baremetal_poweroff> - Airshipctl command to shutdown bare metal host(s)
  • airshipctl baremetal poweron <airshipctl_baremetal_poweron> - Airshipctl command to power on host(s)
  • airshipctl baremetal powerstatus <airshipctl_baremetal_powerstatus> - Airshipctl command to retrieve the power status of a bare metal host
  • airshipctl baremetal reboot <airshipctl_baremetal_reboot> - Airshipctl command to reboot host(s)
  • airshipctl baremetal remotedirect <airshipctl_baremetal_remotedirect> - Airshipctl command to bootstrap the ephemeral host