performa/shaker
Code Issues Proposed changes

Cleanup in option definition and the docs

Browse Source 
Change-Id: Ifc3745f205fec406757c9892e02e2a503dc495e5
This commit is contained in:
Ilya Shakhat 2016-08-04 16:30:23 +03:00 committed by Ilya Shakhat
parent 1f9c4d0a21
commit 73c3995e77
7 changed files with 38 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/tools/shaker-cleanup.txt
View File

@ -20,7 +20,7 @@ usage: shaker-cleanup [-h] [--cleanup] [--cleanup-on-error] [--config-dir DIR]
optional arguments:
-h, --help show this help message and exit
--cleanup Cleanup the image and the flavor.
--cleanup-on-error Clean up the heat-stack upon any error occured during
--cleanup-on-error Clean up the heat-stack upon any error occurred during
scenario execution.
--config-dir DIR Path to a config directory to pull *.conf files from.
This file set is sorted, so as to provide a
@ -34,7 +34,7 @@ optional arguments:
--debug, -d If set to true, the logging level will be set to DEBUG
instead of the default INFO level.
--dns-nameservers DNS_NAMESERVERS
Comma seperated list of IPs of the DNS nameservers for
Comma-separated list of IPs of the DNS nameservers for
the subnets. If no value is provided defaults to
Google Public DNS.
--external-net EXTERNAL_NET
@ -87,8 +87,8 @@ optional arguments:
--os-password <auth-password>
Authentication password, defaults to env[OS_PASSWORD].
--os-project-name <auth-project-name>
Another way to specify tenant name. This option is
mutually exclusive with --os-tenant-name. Defaults to
Authentication project name. This option is mutually
exclusive with --os-tenant-name. Defaults to
env[OS_PROJECT_NAME].
--os-region-name <auth-region-name>
Authentication region name, defaults to

8
doc/source/tools/shaker-image-builder.txt
View File

@ -25,7 +25,7 @@ usage: shaker-image-builder [-h] [--cleanup-on-error] [--config-dir DIR]
optional arguments:
-h, --help show this help message and exit
--cleanup-on-error Clean up the heat-stack upon any error occured during
--cleanup-on-error Clean up the heat-stack upon any error occurred during
scenario execution.
--config-dir DIR Path to a config directory to pull *.conf files from.
This file set is sorted, so as to provide a
@ -39,7 +39,7 @@ optional arguments:
--debug, -d If set to true, the logging level will be set to DEBUG
instead of the default INFO level.
--dns-nameservers DNS_NAMESERVERS
Comma seperated list of IPs of the DNS nameservers for
Comma-separated list of IPs of the DNS nameservers for
the subnets. If no value is provided defaults to
Google Public DNS.
--external-net EXTERNAL_NET
@ -104,8 +104,8 @@ optional arguments:
--os-password <auth-password>
Authentication password, defaults to env[OS_PASSWORD].
--os-project-name <auth-project-name>
Another way to specify tenant name. This option is
mutually exclusive with --os-tenant-name. Defaults to
Authentication project name. This option is mutually
exclusive with --os-tenant-name. Defaults to
env[OS_PROJECT_NAME].
--os-region-name <auth-region-name>
Authentication region name, defaults to

8
doc/source/tools/shaker.txt
View File

@ -33,7 +33,7 @@ optional arguments:
env[SHAKER_AGENT_LOSS_TIMEOUT]
--book BOOK Generate report in ReST format and store it into the
specified folder, defaults to env[SHAKER_BOOK].
--cleanup-on-error Clean up the heat-stack upon any error occured during
--cleanup-on-error Clean up the heat-stack upon any error occurred during
scenario execution.
--config-dir DIR Path to a config directory to pull *.conf files from.
This file set is sorted, so as to provide a
@ -47,7 +47,7 @@ optional arguments:
--debug, -d If set to true, the logging level will be set to DEBUG
instead of the default INFO level.
--dns-nameservers DNS_NAMESERVERS
Comma seperated list of IPs of the DNS nameservers for
Comma-separated list of IPs of the DNS nameservers for
the subnets. If no value is provided defaults to
Google Public DNS.
--external-net EXTERNAL_NET
@ -108,8 +108,8 @@ optional arguments:
--os-password <auth-password>
Authentication password, defaults to env[OS_PASSWORD].
--os-project-name <auth-project-name>
Another way to specify tenant name. This option is
mutually exclusive with --os-tenant-name. Defaults to
Authentication project name. This option is mutually
exclusive with --os-tenant-name. Defaults to
env[OS_PROJECT_NAME].
--os-region-name <auth-region-name>
Authentication region name, defaults to

14
doc/source/usage.rst
View File

@ -6,14 +6,18 @@ Configuration
-------------
For OpenStack scenarios the connection is configured using standard
``openrc`` file. (Refer to
``openrc`` file (refer to
http://docs.openstack.org/cli-reference/common/cli_set_environment_variables_using_openstack_rc.html
on how to retrieve it).
The config can be passed to Shaker rather by sourcing into system env ``source openrc``
or via set of CLI parameters ``--os-tenant-name``, ``--os-username``, ``--os-password``,
``--os-auth-url`` and ``--os-region-name``. Note that Shaker requires a user with admin privileges.
Connection to SSL endpoints is configuredby parameters ``--os-cacert`` and ``--os-insecure``
(to disable strict verifications of certificates).
or via set of CLI parameters ``--os-project-name``, ``--os-username``, ``--os-password``,
``--os-auth-url`` and ``--os-region-name``.
Connection to SSL endpoints is configured by parameters ``--os-cacert`` and ``--os-insecure``
(to disable certificate verification).
.. note::
Shaker is better run under user with admin privileges. However, it's possible
to run under ordinary user too - refer to :ref:`non_admin_mode`
Common Parameters

8
etc/shaker.conf
View File

@ -113,8 +113,8 @@
# Authentication tenant name, defaults to env[OS_TENANT_NAME]. (string value)
#os_tenant_name =
# Another way to specify tenant name. This option is mutually exclusive with
# --os-tenant-name. Defaults to env[OS_PROJECT_NAME]. (string value)
# Authentication project name. This option is mutually exclusive with --os-
# tenant-name. Defaults to env[OS_PROJECT_NAME]. (string value)
#os_project_name =
# Authentication username, defaults to env[OS_USERNAME]. (string value)
@ -139,7 +139,7 @@
# value)
#external_net = <None>
# Comma seperated list of IPs of the DNS nameservers for the subnets. If no
# Comma-separated list of IPs of the DNS nameservers for the subnets. If no
# value is provided defaults to Google Public DNS. (list value)
#dns_nameservers = 8.8.8.8,8.8.4.4
@ -151,7 +151,7 @@
# value)
#flavor_name = shaker-flavor
# Clean up the heat-stack upon any error occured during scenario execution.
# Clean up the heat-stack upon any error occurred during scenario execution.
# (boolean value)
#cleanup_on_error = true

6
shaker/engine/config.py
View File

@ -81,7 +81,7 @@ OPENSTACK_OPTS = [
cfg.StrOpt('os-project-name', metavar='<auth-project-name>',
default=utils.env('OS_PROJECT_NAME'),
sample_default='',
help='Another way to specify tenant name. This option is '
help='Authentication project name. This option is '
'mutually exclusive with --os-tenant-name. '
'Defaults to env[OS_PROJECT_NAME].'),
cfg.StrOpt('os-username', metavar='<auth-username>',
@ -114,7 +114,7 @@ OPENSTACK_OPTS = [
cfg.ListOpt('dns-nameservers',
default=['8.8.8.8', '8.8.4.4'],
help='Comma seperated list of IPs of the DNS nameservers '
help='Comma-separated list of IPs of the DNS nameservers '
'for the subnets. If no value is provided defaults to '
' Google Public DNS.'),
@ -128,7 +128,7 @@ OPENSTACK_OPTS = [
'shaker-image-builder.'),
cfg.BoolOpt('cleanup-on-error',
default=(utils.env('SHAKER_CLEANUP_ON_ERROR') or True),
help='Clean up the heat-stack upon any error occured during '
help='Clean up the heat-stack upon any error occurred during '
'scenario execution.'),
]

20
shaker/engine/utils.py
View File

@ -257,14 +257,14 @@ def copy_value_by_path(src, src_param, dst, dst_param):
def pack_openstack_params(conf):
params = dict(auth=dict(username=cfg.CONF.os_username,
password=cfg.CONF.os_password,
auth_url=cfg.CONF.os_auth_url),
os_region_name=cfg.CONF.os_region_name,
os_cacert=cfg.CONF.os_cacert,
os_insecure=cfg.CONF.os_insecure)
if cfg.CONF.os_tenant_name:
params['auth']['tenant_name'] = cfg.CONF.os_tenant_name
if cfg.CONF.os_project_name:
params['auth']['project_name'] = cfg.CONF.os_project_name
params = dict(auth=dict(username=conf.os_username,
password=conf.os_password,
auth_url=conf.os_auth_url),
os_region_name=conf.os_region_name,
os_cacert=conf.os_cacert,
os_insecure=conf.os_insecure)
if conf.os_tenant_name:
params['auth']['tenant_name'] = conf.os_tenant_name
if conf.os_project_name:
params['auth']['project_name'] = conf.os_project_name
return params