performa/shaker
Code Issues Proposed changes

Update generated docs for CLI tools and config template

Browse Source 
Change-Id: If7633dbae76870674a05e0059fd0f063b3283f8b
This commit is contained in:
Ilya Shakhat
2018-09-11 14:05:50 +02:00
parent 81d69169d7
commit 157bf3700e
8 changed files with 128 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2,11 +2,12 @@ usage: shaker-agent [-h] [--agent-id AGENT_ID] [--config-dir DIR]
[--config-file PATH] [--debug] [--log-config-append PATH]
[--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
[--log-file PATH] [--nodebug] [--nouse-journal]
[--nouse-syslog] [--nowatch-log-file]
[--nouse-json] [--nouse-syslog] [--nowatch-log-file]
[--polling-interval POLLING_INTERVAL]
[--server-endpoint SERVER_ENDPOINT]
[--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-journal] [--use-syslog] [--watch-log-file]
[--use-journal] [--use-json] [--use-syslog]
[--watch-log-file]
optional arguments:
-h, --help show this help message and exit
@@ -46,6 +47,7 @@ optional arguments:
log_config_append is set.
--nodebug The inverse of --debug
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--polling-interval POLLING_INTERVAL
@@ -62,6 +64,8 @@ optional arguments:
includes structured metadata in addition to log
messages.This option is ignored if log_config_append
is set.
--use-json Use JSON formatting for logging. This option is
ignored if log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is
DEPRECATED and will be changed later to honor RFC5424.
This option is ignored if log_config_append is set.

30
doc/source/tools/shaker-all-in-one.txt
View File

@@ -17,14 +17,17 @@ usage: shaker-all-in-one [-h] [--agent-join-timeout AGENT_JOIN_TIMEOUT]
[--no-report-on-error] [--nocleanup]
[--nocleanup-on-error] [--nodebug]
[--nono-report-on-error] [--noos-insecure]
[--nouse-journal] [--nouse-syslog]
[--nouse-journal] [--nouse-json] [--nouse-syslog]
[--nowatch-log-file] [--os-auth-url <auth-url>]
[--os-cacert <auth-cacert>] [--os-insecure]
[--os-password <auth-password>]
[--os-cacert <auth-cacert>]
[--os-identity-api-version <identity-api-version>]
[--os-insecure] [--os-password <auth-password>]
[--os-profile <hmac-key>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-project-name <auth-project-name>]
[--os-region-name <auth-region-name>]
[--os-tenant-name <auth-tenant-name>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-username <auth-username>] [--output OUTPUT]
[--polling-interval POLLING_INTERVAL]
[--report REPORT] [--report-template REPORT_TEMPLATE]
@@ -32,7 +35,8 @@ usage: shaker-all-in-one [-h] [--agent-join-timeout AGENT_JOIN_TIMEOUT]
[--server-endpoint SERVER_ENDPOINT]
[--subunit SUBUNIT]
[--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-journal] [--use-syslog] [--watch-log-file]
[--use-journal] [--use-json] [--use-syslog]
[--watch-log-file]
optional arguments:
-h, --help show this help message and exit
@@ -86,14 +90,16 @@ optional arguments:
to env[SHAKER_FLAVOR_VCPUS]
--image-builder-distro IMAGE_BUILDER_DISTRO
Operating System Distribution for shaker image when
using diskimage-builder, defaults to ubuntu
using diskimage-builder, defaults to ubuntu Allowed
values: ubuntu, centos7
--image-builder-mode IMAGE_BUILDER_MODE
Image building mode: "heat" - using Heat template
(requires Glance v1 for base image upload); "dib" -
using diskimage-builder elements (requires qemu-utils
and debootstrap). If not set, switches to "dib" if
Glance v1 is not available. Can be specified as
env[SHAKER_IMAGE_BUILDER_MODE]
env[SHAKER_IMAGE_BUILDER_MODE] Allowed values: heat,
dib
--image-builder-template IMAGE_BUILDER_TEMPLATE
Heat template containing receipt of building the
image. Can be a file name or one of aliases: "centos",
@@ -137,6 +143,7 @@ optional arguments:
The inverse of --no-report-on-error
--noos-insecure The inverse of --os-insecure
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--os-auth-url <auth-url>
@@ -144,6 +151,9 @@ optional arguments:
--os-cacert <auth-cacert>
Location of CA Certificate, defaults to
env[OS_CACERT].
--os-identity-api-version <identity-api-version>
Identity API version, defaults to
env[OS_IDENTITY_API_VERSION].
--os-insecure When using SSL in connections to the registry server,
do not require validation via a certifying authority,
defaults to env[OS_INSECURE].
@@ -152,6 +162,9 @@ optional arguments:
--os-profile <hmac-key>
HMAC key for encrypting profiling context data,
defaults to env[OS_PROFILE].
--os-project-domain-name <auth-project-domain-name>
Authentication project domain name. Defaults to
env[OS_PROJECT_DOMAIN_NAME].
--os-project-name <auth-project-name>
Authentication project name. This option is mutually
exclusive with --os-tenant-name. Defaults to
@@ -162,6 +175,9 @@ optional arguments:
--os-tenant-name <auth-tenant-name>
Authentication tenant name, defaults to
env[OS_TENANT_NAME].
--os-user-domain-name <auth-user-domain-name>
Authentication username. Defaults to
env[OS_USER_DOMAIN_NAME].
--os-username <auth-username>
Authentication username, defaults to env[OS_USERNAME].
--output OUTPUT File for output in JSON format, defaults to
@@ -218,6 +234,8 @@ optional arguments:
includes structured metadata in addition to log
messages.This option is ignored if log_config_append
is set.
--use-json Use JSON formatting for logging. This option is
ignored if log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is
DEPRECATED and will be changed later to honor RFC5424.
This option is ignored if log_config_append is set.

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

@@ -7,16 +7,20 @@ usage: shaker-cleanup [-h] [--cleanup] [--cleanup-on-error] [--config-dir DIR]
[--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
[--log-file PATH] [--nocleanup] [--nocleanup-on-error]
[--nodebug] [--noos-insecure] [--nouse-journal]
[--nouse-syslog] [--nowatch-log-file]
[--nouse-json] [--nouse-syslog] [--nowatch-log-file]
[--os-auth-url <auth-url>] [--os-cacert <auth-cacert>]
[--os-identity-api-version <identity-api-version>]
[--os-insecure] [--os-password <auth-password>]
[--os-profile <hmac-key>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-project-name <auth-project-name>]
[--os-region-name <auth-region-name>]
[--os-tenant-name <auth-tenant-name>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-username <auth-username>]
[--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-journal] [--use-syslog] [--watch-log-file]
[--use-journal] [--use-json] [--use-syslog]
[--watch-log-file]
optional arguments:
-h, --help show this help message and exit
@@ -75,6 +79,7 @@ optional arguments:
--nodebug The inverse of --debug
--noos-insecure The inverse of --os-insecure
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--os-auth-url <auth-url>
@@ -82,6 +87,9 @@ optional arguments:
--os-cacert <auth-cacert>
Location of CA Certificate, defaults to
env[OS_CACERT].
--os-identity-api-version <identity-api-version>
Identity API version, defaults to
env[OS_IDENTITY_API_VERSION].
--os-insecure When using SSL in connections to the registry server,
do not require validation via a certifying authority,
defaults to env[OS_INSECURE].
@@ -90,6 +98,9 @@ optional arguments:
--os-profile <hmac-key>
HMAC key for encrypting profiling context data,
defaults to env[OS_PROFILE].
--os-project-domain-name <auth-project-domain-name>
Authentication project domain name. Defaults to
env[OS_PROJECT_DOMAIN_NAME].
--os-project-name <auth-project-name>
Authentication project name. This option is mutually
exclusive with --os-tenant-name. Defaults to
@@ -100,6 +111,9 @@ optional arguments:
--os-tenant-name <auth-tenant-name>
Authentication tenant name, defaults to
env[OS_TENANT_NAME].
--os-user-domain-name <auth-user-domain-name>
Authentication username. Defaults to
env[OS_USER_DOMAIN_NAME].
--os-username <auth-username>
Authentication username, defaults to env[OS_USERNAME].
--syslog-log-facility SYSLOG_LOG_FACILITY
@@ -111,6 +125,8 @@ optional arguments:
includes structured metadata in addition to log
messages.This option is ignored if log_config_append
is set.
--use-json Use JSON formatting for logging. This option is
ignored if log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is
DEPRECATED and will be changed later to honor RFC5424.
This option is ignored if log_config_append is set.

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

@@ -14,18 +14,22 @@ usage: shaker-image-builder [-h] [--cleanup-on-error] [--config-dir DIR]
[--log-date-format DATE_FORMAT]
[--log-dir LOG_DIR] [--log-file PATH]
[--nocleanup-on-error] [--nodebug]
[--noos-insecure] [--nouse-journal]
[--noos-insecure] [--nouse-journal] [--nouse-json]
[--nouse-syslog] [--nowatch-log-file]
[--os-auth-url <auth-url>]
[--os-cacert <auth-cacert>] [--os-insecure]
[--os-password <auth-password>]
[--os-cacert <auth-cacert>]
[--os-identity-api-version <identity-api-version>]
[--os-insecure] [--os-password <auth-password>]
[--os-profile <hmac-key>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-project-name <auth-project-name>]
[--os-region-name <auth-region-name>]
[--os-tenant-name <auth-tenant-name>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-username <auth-username>]
[--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-journal] [--use-syslog] [--watch-log-file]
[--use-journal] [--use-json] [--use-syslog]
[--watch-log-file]
optional arguments:
-h, --help show this help message and exit
@@ -64,14 +68,16 @@ optional arguments:
to env[SHAKER_FLAVOR_VCPUS]
--image-builder-distro IMAGE_BUILDER_DISTRO
Operating System Distribution for shaker image when
using diskimage-builder, defaults to ubuntu
using diskimage-builder, defaults to ubuntu Allowed
values: ubuntu, centos7
--image-builder-mode IMAGE_BUILDER_MODE
Image building mode: "heat" - using Heat template
(requires Glance v1 for base image upload); "dib" -
using diskimage-builder elements (requires qemu-utils
and debootstrap). If not set, switches to "dib" if
Glance v1 is not available. Can be specified as
env[SHAKER_IMAGE_BUILDER_MODE]
env[SHAKER_IMAGE_BUILDER_MODE] Allowed values: heat,
dib
--image-builder-template IMAGE_BUILDER_TEMPLATE
Heat template containing receipt of building the
image. Can be a file name or one of aliases: "centos",
@@ -105,6 +111,7 @@ optional arguments:
--nodebug The inverse of --debug
--noos-insecure The inverse of --os-insecure
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--os-auth-url <auth-url>
@@ -112,6 +119,9 @@ optional arguments:
--os-cacert <auth-cacert>
Location of CA Certificate, defaults to
env[OS_CACERT].
--os-identity-api-version <identity-api-version>
Identity API version, defaults to
env[OS_IDENTITY_API_VERSION].
--os-insecure When using SSL in connections to the registry server,
do not require validation via a certifying authority,
defaults to env[OS_INSECURE].
@@ -120,6 +130,9 @@ optional arguments:
--os-profile <hmac-key>
HMAC key for encrypting profiling context data,
defaults to env[OS_PROFILE].
--os-project-domain-name <auth-project-domain-name>
Authentication project domain name. Defaults to
env[OS_PROJECT_DOMAIN_NAME].
--os-project-name <auth-project-name>
Authentication project name. This option is mutually
exclusive with --os-tenant-name. Defaults to
@@ -130,6 +143,9 @@ optional arguments:
--os-tenant-name <auth-tenant-name>
Authentication tenant name, defaults to
env[OS_TENANT_NAME].
--os-user-domain-name <auth-user-domain-name>
Authentication username. Defaults to
env[OS_USER_DOMAIN_NAME].
--os-username <auth-username>
Authentication username, defaults to env[OS_USERNAME].
--syslog-log-facility SYSLOG_LOG_FACILITY
@@ -141,6 +157,8 @@ optional arguments:
includes structured metadata in addition to log
messages.This option is ignored if log_config_append
is set.
--use-json Use JSON formatting for logging. This option is
ignored if log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is
DEPRECATED and will be changed later to honor RFC5424.
This option is ignored if log_config_append is set.

11
doc/source/tools/shaker-report.txt
View File

@@ -3,10 +3,12 @@ usage: shaker-report [-h] [--book BOOK] [--config-dir DIR]
[--log-config-append PATH]
[--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
[--log-file PATH] [--nodebug] [--nouse-journal]
[--nouse-syslog] [--nowatch-log-file] [--report REPORT]
[--report-template REPORT_TEMPLATE] [--subunit SUBUNIT]
[--nouse-json] [--nouse-syslog] [--nowatch-log-file]
[--report REPORT] [--report-template REPORT_TEMPLATE]
[--subunit SUBUNIT]
[--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-journal] [--use-syslog] [--watch-log-file]
[--use-journal] [--use-json] [--use-syslog]
[--watch-log-file]
optional arguments:
-h, --help show this help message and exit
@@ -49,6 +51,7 @@ optional arguments:
log_config_append is set.
--nodebug The inverse of --debug
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--report REPORT Report file name, defaults to env[SHAKER_REPORT].
@@ -67,6 +70,8 @@ optional arguments:
includes structured metadata in addition to log
messages.This option is ignored if log_config_append
is set.
--use-json Use JSON formatting for logging. This option is
ignored if log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is
DEPRECATED and will be changed later to honor RFC5424.
This option is ignored if log_config_append is set.

9
doc/source/tools/shaker-spot.txt
View File

@@ -3,12 +3,12 @@ usage: shaker-spot [-h] [--artifacts-dir ARTIFACTS_DIR] [--book BOOK]
[--log-config-append PATH] [--log-date-format DATE_FORMAT]
[--log-dir LOG_DIR] [--log-file PATH] [--matrix MATRIX]
[--no-report-on-error] [--nodebug] [--nono-report-on-error]
[--nouse-journal] [--nouse-syslog] [--nowatch-log-file]
[--output OUTPUT] [--report REPORT]
[--nouse-journal] [--nouse-json] [--nouse-syslog]
[--nowatch-log-file] [--output OUTPUT] [--report REPORT]
[--report-template REPORT_TEMPLATE] [--scenario SCENARIO]
[--subunit SUBUNIT]
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal]
[--use-syslog] [--watch-log-file]
[--use-json] [--use-syslog] [--watch-log-file]
optional arguments:
-h, --help show this help message and exit
@@ -62,6 +62,7 @@ optional arguments:
--nono-report-on-error
The inverse of --no-report-on-error
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--output OUTPUT File for output in JSON format, defaults to
@@ -113,6 +114,8 @@ optional arguments:
includes structured metadata in addition to log
messages.This option is ignored if log_config_append
is set.
--use-json Use JSON formatting for logging. This option is
ignored if log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is
DEPRECATED and will be changed later to honor RFC5424.
This option is ignored if log_config_append is set.

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

@@ -8,19 +8,23 @@ usage: shaker [-h] [--agent-join-timeout AGENT_JOIN_TIMEOUT]
[--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
[--log-file PATH] [--matrix MATRIX] [--no-report-on-error]
[--nocleanup-on-error] [--nodebug] [--nono-report-on-error]
[--noos-insecure] [--nouse-journal] [--nouse-syslog]
[--nowatch-log-file] [--os-auth-url <auth-url>]
[--os-cacert <auth-cacert>] [--os-insecure]
[--os-password <auth-password>] [--os-profile <hmac-key>]
[--noos-insecure] [--nouse-journal] [--nouse-json]
[--nouse-syslog] [--nowatch-log-file] [--os-auth-url <auth-url>]
[--os-cacert <auth-cacert>]
[--os-identity-api-version <identity-api-version>]
[--os-insecure] [--os-password <auth-password>]
[--os-profile <hmac-key>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-project-name <auth-project-name>]
[--os-region-name <auth-region-name>]
[--os-tenant-name <auth-tenant-name>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-username <auth-username>] [--output OUTPUT]
[--polling-interval POLLING_INTERVAL] [--report REPORT]
[--report-template REPORT_TEMPLATE] [--scenario SCENARIO]
[--server-endpoint SERVER_ENDPOINT] [--subunit SUBUNIT]
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal]
[--use-syslog] [--watch-log-file]
[--use-json] [--use-syslog] [--watch-log-file]
optional arguments:
-h, --help show this help message and exit
@@ -100,6 +104,7 @@ optional arguments:
The inverse of --no-report-on-error
--noos-insecure The inverse of --os-insecure
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--os-auth-url <auth-url>
@@ -107,6 +112,9 @@ optional arguments:
--os-cacert <auth-cacert>
Location of CA Certificate, defaults to
env[OS_CACERT].
--os-identity-api-version <identity-api-version>
Identity API version, defaults to
env[OS_IDENTITY_API_VERSION].
--os-insecure When using SSL in connections to the registry server,
do not require validation via a certifying authority,
defaults to env[OS_INSECURE].
@@ -115,6 +123,9 @@ optional arguments:
--os-profile <hmac-key>
HMAC key for encrypting profiling context data,
defaults to env[OS_PROFILE].
--os-project-domain-name <auth-project-domain-name>
Authentication project domain name. Defaults to
env[OS_PROJECT_DOMAIN_NAME].
--os-project-name <auth-project-name>
Authentication project name. This option is mutually
exclusive with --os-tenant-name. Defaults to
@@ -125,6 +136,9 @@ optional arguments:
--os-tenant-name <auth-tenant-name>
Authentication tenant name, defaults to
env[OS_TENANT_NAME].
--os-user-domain-name <auth-user-domain-name>
Authentication username. Defaults to
env[OS_USER_DOMAIN_NAME].
--os-username <auth-username>
Authentication username, defaults to env[OS_USERNAME].
--output OUTPUT File for output in JSON format, defaults to
@@ -181,6 +195,8 @@ optional arguments:
includes structured metadata in addition to log
messages.This option is ignored if log_config_append
is set.
--use-json Use JSON formatting for logging. This option is
ignored if log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is
DEPRECATED and will be changed later to honor RFC5424.
This option is ignored if log_config_append is set.

23
etc/shaker.conf
View File

@@ -57,6 +57,10 @@
# log_config_append is set. (string value)
#syslog_log_facility = LOG_USER
# Use JSON formatting for logging. This option is ignored if log_config_append
# is set. (boolean value)
#use_json = false
# Log output to standard error. This option is ignored if log_config_append is
# set. (boolean value)
#use_stderr = false
@@ -130,9 +134,20 @@
# tenant-name. Defaults to env[OS_PROJECT_NAME]. (string value)
#os_project_name =
# Authentication project domain name. Defaults to env[OS_PROJECT_DOMAIN_NAME].
# (string value)
#os_project_domain_name = Default
# Authentication username, defaults to env[OS_USERNAME]. (string value)
#os_username =
# Authentication username. Defaults to env[OS_USER_DOMAIN_NAME]. (string value)
#os_user_domain_name =
# Identity API version, defaults to env[OS_IDENTITY_API_VERSION]. (string
# value)
#os_identity_api_version = 3
# Authentication password, defaults to env[OS_PASSWORD]. (string value)
#os_password =
@@ -268,12 +283,16 @@
# base image upload); "dib" - using diskimage-builder elements (requires qemu-
# utils and debootstrap). If not set, switches to "dib" if Glance v1 is not
# available. Can be specified as env[SHAKER_IMAGE_BUILDER_MODE] (string value)
# Allowed values: heat, dib
# Possible values:
# heat - <No description provided>
# dib - <No description provided>
#image_builder_mode = <None>
# Operating System Distribution for shaker image when using diskimage-builder,
# defaults to ubuntu (string value)
# Allowed values: ubuntu, centos7
# Possible values:
# ubuntu - <No description provided>
# centos7 - <No description provided>
#image_builder_distro = ubuntu
# Cleanup the image and the flavor. (boolean value)