Add man-type documentation pages for rdo-manager commands
Change-Id: I8bf5e62cbe1b563c985712f54abff9b03dd47e48
This commit is contained in:
parent
b02b1814d6
commit
c57ef6fdc5
9
doc/source/command-list.rst
Normal file
9
doc/source/command-list.rst
Normal file
@ -0,0 +1,9 @@
|
||||
============
|
||||
Command List
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
command-objects/*
|
65
doc/source/command-objects/baremetal.rst
Normal file
65
doc/source/command-objects/baremetal.rst
Normal file
@ -0,0 +1,65 @@
|
||||
=========
|
||||
baremetal
|
||||
=========
|
||||
|
||||
Baremetal v1
|
||||
|
||||
baremetal import
|
||||
----------------
|
||||
|
||||
Import baremetal nodes
|
||||
|
||||
.. program:: baremetal import
|
||||
.. code:: bash
|
||||
|
||||
os baremetal import
|
||||
[ --service-host <service_host> ]
|
||||
[ --json | --csv ]
|
||||
<file_in>
|
||||
|
||||
.. option:: --service-host <service_host>
|
||||
|
||||
Nova compute service host to register nodes with (default None)
|
||||
|
||||
.. option:: --json
|
||||
|
||||
Input file is in json format
|
||||
|
||||
.. option:: --csv
|
||||
|
||||
Input file is in csv format
|
||||
|
||||
.. _baremetal_import-file_in:
|
||||
.. describe:: <file_in>
|
||||
|
||||
Filename to be imported
|
||||
|
||||
baremetal introspection all start
|
||||
---------------------------------
|
||||
|
||||
Begin introspection of all baremetal nodes
|
||||
|
||||
.. program:: baremetal introspection all start
|
||||
.. code:: bash
|
||||
|
||||
os baremetal introspection all start
|
||||
|
||||
baremetal introspection all status
|
||||
----------------------------------
|
||||
|
||||
Get status of node introspection
|
||||
|
||||
.. program:: baremetal introspection all status
|
||||
.. code:: bash
|
||||
|
||||
os baremetal introspection all status
|
||||
|
||||
baremetal configure boot
|
||||
------------------------
|
||||
|
||||
Configure boot devices for all baremetal nodes
|
||||
|
||||
.. program:: baremetal configure boot
|
||||
.. code:: bash
|
||||
|
||||
os baremetal configure boot
|
40
doc/source/command-objects/overcloud.rst
Normal file
40
doc/source/command-objects/overcloud.rst
Normal file
@ -0,0 +1,40 @@
|
||||
=========
|
||||
overcloud
|
||||
=========
|
||||
|
||||
Overcloud v1
|
||||
|
||||
overcloud deploy stack
|
||||
----------------------
|
||||
|
||||
Deploy an overcloud stack
|
||||
|
||||
.. program:: overcloud deploy stack
|
||||
.. code:: bash
|
||||
|
||||
os overcloud deploy stack
|
||||
[ --control-scale <scale-amount> ]
|
||||
[ --compute-scale <scale-amount> ]
|
||||
[ --ceph-storage-scale <scale-amount> ]
|
||||
[ --block-storage-scale <scale-amount> ]
|
||||
[ --swift-storage-scale <scale-amount> ]
|
||||
|
||||
.. option:: --control-scale <scale-amount>
|
||||
|
||||
New number of control nodes (default 0)
|
||||
|
||||
.. option:: --compute-scale <scale-amount>
|
||||
|
||||
New number of compute nodes (default 0)
|
||||
|
||||
.. option:: --ceph-storage-scale <scale-amount>
|
||||
|
||||
New number of ceph storage nodes (default 0)
|
||||
|
||||
.. option:: --block-storage-scale <scale-amount>
|
||||
|
||||
New number of block storage nodes (default 0)
|
||||
|
||||
.. option:: --swift-storage-scale <scale-amount>
|
||||
|
||||
New number of swift storage nodes (default 0)
|
15
doc/source/command-objects/undercloud.rst
Normal file
15
doc/source/command-objects/undercloud.rst
Normal file
@ -0,0 +1,15 @@
|
||||
==========
|
||||
undercloud
|
||||
==========
|
||||
|
||||
Undercloud v1
|
||||
|
||||
undercloud install
|
||||
------------------
|
||||
|
||||
Install the undercloud
|
||||
|
||||
.. program:: undercloud install
|
||||
.. code:: bash
|
||||
|
||||
os undercloud install
|
@ -11,7 +11,7 @@ Contents:
|
||||
|
||||
readme
|
||||
installation
|
||||
usage
|
||||
command-list
|
||||
contributing
|
||||
|
||||
Indices and tables
|
||||
|
Loading…
x
Reference in New Issue
Block a user