diff --git a/doc/source/command-list.rst b/doc/source/command-list.rst new file mode 100644 index 000000000..c4045b040 --- /dev/null +++ b/doc/source/command-list.rst @@ -0,0 +1,9 @@ +============ +Command List +============ + +.. toctree:: + :glob: + :maxdepth: 2 + + command-objects/* diff --git a/doc/source/command-objects/baremetal.rst b/doc/source/command-objects/baremetal.rst new file mode 100644 index 000000000..4cf07c23d --- /dev/null +++ b/doc/source/command-objects/baremetal.rst @@ -0,0 +1,65 @@ +========= +baremetal +========= + +Baremetal v1 + +baremetal import +---------------- + +Import baremetal nodes + +.. program:: baremetal import +.. code:: bash + + os baremetal import + [ --service-host ] + [ --json | --csv ] + + +.. option:: --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:: + + 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 diff --git a/doc/source/command-objects/overcloud.rst b/doc/source/command-objects/overcloud.rst new file mode 100644 index 000000000..705347142 --- /dev/null +++ b/doc/source/command-objects/overcloud.rst @@ -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 ] + [ --compute-scale ] + [ --ceph-storage-scale ] + [ --block-storage-scale ] + [ --swift-storage-scale ] + +.. option:: --control-scale + + New number of control nodes (default 0) + +.. option:: --compute-scale + + New number of compute nodes (default 0) + +.. option:: --ceph-storage-scale + + New number of ceph storage nodes (default 0) + +.. option:: --block-storage-scale + + New number of block storage nodes (default 0) + +.. option:: --swift-storage-scale + + New number of swift storage nodes (default 0) diff --git a/doc/source/command-objects/undercloud.rst b/doc/source/command-objects/undercloud.rst new file mode 100644 index 000000000..10f2ac8ac --- /dev/null +++ b/doc/source/command-objects/undercloud.rst @@ -0,0 +1,15 @@ +========== +undercloud +========== + +Undercloud v1 + +undercloud install +------------------ + +Install the undercloud + +.. program:: undercloud install +.. code:: bash + + os undercloud install diff --git a/doc/source/index.rst b/doc/source/index.rst index fad83bc26..e033c350c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,7 +11,7 @@ Contents: readme installation - usage + command-list contributing Indices and tables diff --git a/tox.ini b/tox.ini index bd788aa75..d067eb0fd 100644 --- a/tox.ini +++ b/tox.ini @@ -24,6 +24,9 @@ commands = {posargs} [testenv:cover] commands = python setup.py testr --coverage --testr-args='{posargs}' +[testenv:docs] +commands = python setup.py build_sphinx + [flake8] show-source = True ignore = H402