openstack
/
python-tripleoclient
Code Issues Proposed changes

Add command option descriptions 

Add command option descriptions for the deploy overcloud command.

Change-Id: I20815efddd020ab652bd2666cafbdbfbfd637437
Closes-bug: https://bugzilla.redhat.com/show_bug.cgi?id=1241668
This commit is contained in:
Lennart Regebro 2015-07-30 16:09:43 +02:00 committed by Lennart Regebro
parent 8802345544
commit eebb8e2630
2 changed files with 239 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

185
doc/source/command-objects/overcloud.rst
View File

@ -12,29 +12,192 @@ 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> ]
openstack overcloud deploy stack
(--plan PLAN | --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]
[--neutron-flat-networks NEUTRON_FLAT_NETWORKS]
[--neutron-physical-bridge NEUTRON_PHYSICAL_BRIDGE]
[--neutron-bridge-mappings NEUTRON_BRIDGE_MAPPINGS]
[--neutron-public-interface NEUTRON_PUBLIC_INTERFACE]
[--hypervisor-neutron-public-interface HYPERVISOR_NEUTRON_PUBLIC_INTERFACE]
[--neutron-network-type NEUTRON_NETWORK_TYPE]
[--neutron-tunnel-types NEUTRON_TUNNEL_TYPES]
[--neutron-disable-tunneling]
[--neutron-network-vlan-ranges NEUTRON_NETWORK_VLAN_RANGES]
[--neutron-mechanism-drivers NEUTRON_MECHANISM_DRIVERS]
[--libvirt-type LIBVIRT_TYPE]
[--ntp-server NTP_SERVER] [--cinder-lvm]
[--tripleo-root TRIPLEO_ROOT]
[--nodes-json NODES_JSON]
[--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]
.. option:: --plan <name or UUID>
The Name or UUID of the Tuskar plan to deploy.
.. 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 (default 0)
New number of control nodes.
.. option:: --compute-scale <scale-amount>
New number of compute nodes (default 0)
New number of compute nodes.
.. option:: --ceph-storage-scale <scale-amount>
New number of ceph storage nodes (default 0)
New number of ceph storage nodes.
.. option:: --block-storage-scale <scale-amount>
New number of block storage nodes (default 0)
New number of block storage nodes.
.. option:: --swift-storage-scale <scale-amount>
New number of swift storage nodes (default 0)
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:: --neutron-flat-networks <networks>
Comma separated list of physical_network names with which flat networks
can be created. Use * to allow flat networks with arbitrary
physical_network names. (default: 'datacentre')
.. option:: --neutron-physical-bridge <bridge>
Deprecated.
.. option:: --neutron-bridge-mappings <mappings>
Comma separated list of bridge mappings. (default: datacentre:br-ex)
.. option:: --neutron-public-interface <interface>
Deprecated.
.. option:: --hypervisor-neutron-public-interface <interface>
Deprecated.
.. option:: --neutron-network-type <type>
The network type for the tenant networks.
.. option:: --neutron-tunnel-types <type>
Network types supported by the agent (gre and/or vxlan).
.. option:: --neutron-disable-tunneling
Disables tunneling.
.. option:: --neutron-network-vlan-ranges <ranges>
Comma separated list of <physical_network>:<vlan_min>:<vlan_max> or
<physical_network> specifying physical_network names usable for VLAN
provider and tenant networks, as well as ranges of VLAN tags on each
available for allocation to tenant networks. (ex: datacentre:1:1000)
.. option:: --neutron-mechanism-drivers <drivers>
An ordered list of extension driver entrypoints to be loaded from the
neutron.ml2.extension_drivers namespace.
.. option:: --libvirt-type [kvm|lxc|qemu|uml|xen|parallels]
Libvirt domain type. (default: qemu)
.. option:: --ntp-server <ip-address>
The NTP for overcloud nodes.
.. option:: --cinder-lvm
Enables the cinder lvm/iscsi backend.
.. option:: --tripleo-root <directory>
The root directory for TripleO templates.
.. option:: --nodes-json <file>
A file containing node definitions. (default: instackenv.json)
.. option:: --no-proxy <hosts>
A comma separated list of hosts that should not be proxied.
.. option:: -O <directory>, --output-dir <directory>
Directory to write Tuskar template files into. It will be created if it
does not exist. If not provided a temporary directory will be used.
.. 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.

92
rdomanager_oscplugin/v1/overcloud_deploy.py
View File

@ -14,6 +14,7 @@
#
from __future__ import print_function
import argparse
import logging
import os
import re
@ -664,7 +665,12 @@ class DeployOvercloud(command.Command):
compute_client.flavors.create('m1.demo', 512, 1, 10, 'auto')
def get_parser(self, prog_name):
parser = super(DeployOvercloud, self).get_parser(prog_name)
# add_help doesn't work properly, set it to False:
parser = argparse.ArgumentParser(
description=self.get_description(),
prog=prog_name,
add_help=False
)
main_group = parser.add_mutually_exclusive_group(required=True)
main_group.add_argument(
'--plan',
@ -676,11 +682,16 @@ class DeployOvercloud(command.Command):
parser.add_argument('-t', '--timeout', metavar='<TIMEOUT>',
type=int, default=240,
help=_('Deployment timeout in minutes.'))
parser.add_argument('--control-scale', type=int)
parser.add_argument('--compute-scale', type=int)
parser.add_argument('--ceph-storage-scale', type=int)
parser.add_argument('--block-storage-scale', type=int)
parser.add_argument('--swift-storage-scale', type=int)
parser.add_argument('--control-scale', type=int,
help=_('New number of control nodes.'))
parser.add_argument('--compute-scale', type=int,
help=_('New number of compute nodes.'))
parser.add_argument('--ceph-storage-scale', type=int,
help=_('New number of ceph storage nodes.'))
parser.add_argument('--block-storage-scale', type=int,
help=_('New number of cinder storage nodes.'))
parser.add_argument('--swift-storage-scale', type=int,
help=_('New number of swift storage nodes.'))
parser.add_argument('--control-flavor',
help=_("Nova flavor to use for control nodes."))
parser.add_argument('--compute-flavor',
@ -694,14 +705,25 @@ class DeployOvercloud(command.Command):
parser.add_argument('--swift-storage-flavor',
help=_("Nova flavor to use for swift storage "
"nodes."))
parser.add_argument('--neutron-flat-networks')
parser.add_argument('--neutron-physical-bridge')
parser.add_argument('--neutron-bridge-mappings')
parser.add_argument('--neutron-public-interface')
parser.add_argument('--neutron-flat-networks',
help=_('Comma separated list of physical_network '
'names with which flat networks can be '
'created. Use * to allow flat networks '
'with arbitrary physical_network names.'))
parser.add_argument('--neutron-physical-bridge',
help=_('Deprecated.'))
parser.add_argument('--neutron-bridge-mappings',
help=_('Comma separated list of bridge mappings. '
'(default: datacentre:br-ex)'))
parser.add_argument('--neutron-public-interface',
help=_('Deprecated.'))
parser.add_argument('--hypervisor-neutron-public-interface',
default='nic1')
parser.add_argument('--neutron-network-type')
parser.add_argument('--neutron-tunnel-types')
default='nic1', help=_('Deprecated.'))
parser.add_argument('--neutron-network-type',
help=_('The network type for tenant networks.'))
parser.add_argument('--neutron-tunnel-types',
help=_('Network types supported by the agent '
'(gre and/or vxlan).'))
parser.add_argument('--neutron-tunnel-id-ranges',
default="1:1000",
help=_("Ranges of GRE tunnel IDs to make "
@ -712,20 +734,36 @@ class DeployOvercloud(command.Command):
"available for tenant network allocation"),)
parser.add_argument('--neutron-disable-tunneling',
dest='neutron_disable_tunneling',
action="store_const", const=True),
parser.add_argument('--neutron-network-vlan-ranges')
parser.add_argument('--neutron-mechanism-drivers')
parser.add_argument('--libvirt-type')
action="store_const", const=True,
help=_('Disables tunneling.')),
parser.add_argument('--neutron-network-vlan-ranges',
help=_('Comma separated list of '
'<physical_network>:<vlan_min>:<vlan_max> '
'or <physical_network> specifying '
'physical_network names usable for VLAN '
'provider and tenant networks, as well as '
'ranges of VLAN tags on each available for '
'allocation to tenant networks. '
'(ex: datacentre:1:1000)'))
parser.add_argument('--neutron-mechanism-drivers',
help=_('An ordered list of extension driver '
'entrypoints to be loaded from the '
'neutron.ml2.extension_drivers namespace.'))
parser.add_argument('--libvirt-type',
help=_('Libvirt domain type. (default: qemu) '
'[qemu|kvm|lxc|uml|xen|parallels]'))
parser.add_argument('--ntp-server',
help=_("NTP server address is required for HA"
" deployments."))
help=_('The NTP for overcloud nodes.'))
parser.add_argument(
'--tripleo-root',
default=os.environ.get('TRIPLEO_ROOT', '/etc/tripleo')
default=os.environ.get('TRIPLEO_ROOT', '/etc/tripleo'),
help=_('The root directory for TripleO templates.')
)
parser.add_argument(
'--no-proxy',
default=os.environ.get('no_proxy', '')
default=os.environ.get('no_proxy', ''),
help=_('A comma separated list of hosts that should not be '
'proxied.')
)
parser.add_argument(
'-O', '--output-dir', metavar='<OUTPUT DIR>',
@ -745,33 +783,33 @@ class DeployOvercloud(command.Command):
'--rhel-reg',
action='store_true',
help=_('Register overcloud nodes to the customer portal or a '
'satellite')
'satellite.')
)
reg_group.add_argument(
'--reg-method',
choices=['satellite', 'portal'],
default='satellite',
help=_('RHEL registration method to use for the overcloud nodes')
help=_('RHEL registration method to use for the overcloud nodes.')
)
reg_group.add_argument(
'--reg-org',
default='',
help=_('Organization key to use for registration')
help=_('Organization key to use for registration.')
)
reg_group.add_argument(
'--reg-force',
action='store_true',
help=_('Register the system even if it is already registered')
help=_('Register the system even if it is already registered.')
)
reg_group.add_argument(
'--reg-sat-url',
default='',
help=_('Satellite server to register overcloud nodes')
help=_('Satellite server to register overcloud nodes.')
)
reg_group.add_argument(
'--reg-activation-key',
default='',
help=_('Activation key to use for registration')
help=_('Activation key to use for registration.')
)
return parser