openstack/python-tripleoclient
Code Issues Proposed changes

Merge "Use cliff autodoc generation"

Browse Source
This commit is contained in:
Zuul 2019-02-12 22:18:43 +00:00 committed by Gerrit Code Review
commit b884aed993
8 changed files with 42 additions and 254 deletions

9
doc/source/command-list.rst

@ -1,9 +0,0 @@
============
Command List
============
.. toctree::
:glob:
:maxdepth: 2
command-objects/*

80
doc/source/command-objects/baremetal.rst

@ -1,80 +0,0 @@
=========
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
.. option:: --initial-state [enroll|available]
Provision state to set on newly-enrolled nodes. To use "enroll" state,
OS_BAREMETAL_API_VERSION must be at least 1.11. (default: "available")
.. _baremetal_import-file_in:
.. describe:: <file_in>
Filename to be imported
baremetal introspection bulk start
----------------------------------
Begin introspection of all baremetal nodes
.. program:: baremetal introspection bulk start
.. code:: bash
os baremetal introspection bulk start
baremetal introspection bulk status
-----------------------------------
Get status of node introspection
.. program:: baremetal introspection bulk status
.. code:: bash
os baremetal introspection bulk status
baremetal configure boot
------------------------
Configure boot devices for all baremetal nodes
.. program:: baremetal configure boot
.. code:: bash
os baremetal configure boot
[ --deploy-kernel <image_name> ]
[ --deploy-ramdisk <image_name> ]
.. option:: --deploy-kernel <name>
Image name with kernel which should be used for boot config.
.. option:: --deploy-ramdisk <name>
Image name with ramdisk which should be used for boot config.

142
doc/source/command-objects/overcloud.rst

@ -1,142 +0,0 @@
=========
overcloud
=========
Overcloud v1
overcloud deploy
----------------
Deploy an overcloud stack
.. program:: overcloud deploy
.. code:: bash
os overcloud deploy
--stack [STACK_NAME]
--templates [TEMPLATES]
[-t <TIMEOUT>]
[--control-scale CONTROL_SCALE]
[--compute-scale COMPUTE_SCALE]
[--ceph-storage-scale CEPH_STORAGE_SCALE]
[--block-storage-scale BLOCK_STORAGE_SCALE]
[--swift-storage-scale SWIFT_STORAGE_SCALE]
[--control-flavor CONTROL_FLAVOR]
[--compute-flavor COMPUTE_FLAVOR]
[--ceph-storage-flavor CEPH_STORAGE_FLAVOR]
[--block-storage-flavor BLOCK_STORAGE_FLAVOR]
[--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
[--libvirt-type LIBVIRT_TYPE]
[--ntp-server NTP_SERVER] [--cinder-lvm]
[--no-proxy NO_PROXY] [-O <OUTPUT DIR>]
[-e <HEAT ENVIRONMENT FILE>] [--rhel-reg]
[--reg-method {satellite,portal}]
[--reg-org REG_ORG] [--reg-force]
[--reg-sat-url REG_SAT_URL]
[--reg-activation-key REG_ACTIVATION_KEY]
[--answers-file <ANSWERS FILE>]
.. option:: --stack <stack_name>
Optionally rename stack from default of 'overcloud'. Currently, only one
stack is supported.
.. option:: --templates <directory>
The directory containing the Heat templates to deploy.
.. option:: -t <timeout>, --timeout <timeout>
Deployment timeout in minutes (default: 240)
.. option:: --control-scale <scale-amount>
New number of control nodes.
.. option:: --compute-scale <scale-amount>
New number of compute nodes.
.. option:: --ceph-storage-scale <scale-amount>
New number of ceph storage nodes.
.. option:: --block-storage-scale <scale-amount>
New number of block storage nodes.
.. option:: --swift-storage-scale <scale-amount>
New number of swift storage nodes.
.. option:: --control-flavor <flavor-name>
Nova flavor to use for control nodes.
.. option:: --compute-flavor <flavor-name>
Nova flavor to use for compute nodes.
.. option:: --ceph-storage-flavor <flavor-name>
Nova flavor to use for ceph storage nodes.
.. option:: --block-storage-flavor <flavor-name>
Nova flavor to use for cinder storage nodes.
.. option:: --swift-storage-flavor <flavor-name>
Nova flavor to use for swift storage nodes.
.. option:: --libvirt-type {kvm,qemu}
Libvirt domain type. (default: kvm)
.. option:: --ntp-server <ip-address>
The NTP for overcloud nodes.
.. option:: --no-proxy <hosts>
A comma separated list of hosts that should not be proxied.
.. option:: -e <file>, --environment-file <file>
Environment files to be passed to the heat stack-create or heat
stack-update command. (Can be specified more than once.)
.. option:: --rhel-reg
Register overcloud nodes to the customer portal or a satellite.
.. option:: --reg-method [sattelite|portal]
RHEL registration method to use for the overcloud nodes.
.. option:: --reg-org <organization>
Organization key to use for registration.
.. option:: --reg-force
Register the system even if it is already registered.
.. option:: --reg-sat-url <url>
Satellite server to register overcloud nodes.
.. option:: --reg-activation-key <key>
Activation key to use for registration.
.. option:: --answers-file <file>
Point to a file that specifies a templates directory and a list
of environment files in YAML format::
templates: ~/templates
environments:
- ~/test-env1.yaml
- ~/test-env2.yaml
- ~/test-env3.yaml

15
doc/source/command-objects/undercloud.rst

@ -1,15 +0,0 @@
==========
undercloud
==========
Undercloud v1
undercloud install
------------------
Install the undercloud
.. program:: undercloud install
.. code:: bash
os undercloud install

34
doc/source/commands.rst Normal file

@ -0,0 +1,34 @@
======================
All Overcloud Commands
======================
.. autoprogram-cliff:: openstack.tripleoclient.v1
:command: overcloud *
==================
Container Commands
==================
.. autoprogram-cliff:: openstack.tripleoclient.v1
:command: tripleo container *
.. autoprogram-cliff:: openstack.tripleoclient.v1
:command: overcloud container image [!prep]*
===================
Undercloud Commands
===================
.. autoprogram-cliff:: openstack.tripleoclient.v1
:command: undercloud *
===================
Standalone Commands
===================
.. autoprogram-cliff:: openstack.tripleoclient.v1
:command: tripleo deploy
.. autoprogram-cliff:: openstack.tripleoclient.v1
:command: tripleo upgrade

10
doc/source/conf.py

@ -12,8 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import os
import sys
import os, sys
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
@ -22,8 +21,8 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'openstackdocstheme'
'openstackdocstheme',
'cliff.sphinxext',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -38,7 +37,7 @@ master_doc = 'index'
# General information about the project.
project = u'tripleoclient'
copyright = u'2015 Red Hat, Inc.'
copyright = u'2017 Red Hat, Inc.'
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -80,3 +79,4 @@ bug_tag = ''
# Last updated timestamp
html_last_updated_fmt = '%Y-%m-%d %H:%M'
autoprogram_cliff_application = 'openstack'

2
doc/source/index.rst

@ -12,7 +12,7 @@ Contents:
readme
installation
usage
command-list
commands
contributing
Indices and tables

4
tripleoclient/constants.py

@ -19,7 +19,7 @@ TRIPLEO_HEAT_TEMPLATES = "/usr/share/openstack-tripleo-heat-templates/"
OVERCLOUD_YAML_NAME = "overcloud.yaml"
OVERCLOUD_ROLES_FILE = "roles_data.yaml"
UNDERCLOUD_ROLES_FILE = "roles_data_undercloud.yaml"
UNDERCLOUD_OUTPUT_DIR = os.path.join(os.environ.get('HOME'))
UNDERCLOUD_OUTPUT_DIR = os.path.join(os.environ.get('HOME', '~/'))
STANDALONE_EPHEMERAL_STACK_VSTATE = '/var/lib/tripleo-heat-installer'
UNDERCLOUD_LOG_FILE = "install-undercloud.log"
UNDERCLOUD_CONF_PATH = os.path.join(UNDERCLOUD_OUTPUT_DIR, "undercloud.conf")
@ -35,7 +35,7 @@ USER_ENVIRONMENT = 'user-environment.yaml'
USER_PARAMETERS = 'user-environments/tripleoclient-parameters.yaml'
# This directory may contain additional environments to use during deploy
DEFAULT_ENV_DIRECTORY = os.path.join(os.environ.get('HOME'),
DEFAULT_ENV_DIRECTORY = os.path.join(os.environ.get('HOME', '~/'),
'.tripleo', 'environments')
TRIPLEO_PUPPET_MODULES = "/usr/share/openstack-puppet/modules/"