Shaker config parameters¶
DEFAULT¶
-
agent_dir
¶ Type: string Default: <None>
If specified, directs Shaker to write execution script for the shell class in agent(s) instance defined directory. Defaults to /tmp directory.
-
server_endpoint
¶ Type: unknown type Default: <None>
Address for server connections (host:port), defaults to env[SHAKER_SERVER_ENDPOINT].
-
polling_interval
¶ Type: integer Default: 10
How frequently the agent polls server, in seconds
-
os_auth_url
¶ Type: string Default: u''
Authentication URL, defaults to env[OS_AUTH_URL].
-
os_tenant_name
¶ Type: string Default: u''
Authentication tenant name, defaults to env[OS_TENANT_NAME].
-
os_project_name
¶ Type: string Default: u''
Authentication project name. This option is mutually exclusive with –os-tenant-name. Defaults to env[OS_PROJECT_NAME].
-
os_project_domain_name
¶ Type: string Default: Default
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Authentication project domain name. Defaults to env[OS_PROJECT_DOMAIN_NAME].
-
os_username
¶ Type: string Default: u''
Authentication username, defaults to env[OS_USERNAME].
-
os_user_domain_name
¶ Type: string Default: u''
Authentication username. Defaults to env[OS_USER_DOMAIN_NAME].
-
os_identity_api_version
¶ Type: string Default: 3
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Identity API version, defaults to env[OS_IDENTITY_API_VERSION].
-
os_password
¶ Type: string Default: u''
Authentication password, defaults to env[OS_PASSWORD].
-
os_cacert
¶ Type: string Default: u''
Location of CA Certificate, defaults to env[OS_CACERT].
-
os_insecure
¶ Type: boolean Default: false
When using SSL in connections to the registry server, do not require validation via a certifying authority, defaults to env[OS_INSECURE].
-
os_region_name
¶ Type: string Default: RegionOne
Authentication region name, defaults to env[OS_REGION_NAME].
-
os_interface
¶ Type: string Default: u''
Interface type. Valid options are public, admin and internal. defaults to env[OS_INTERFACE].
-
os_profile
¶ Type: string Default: u''
HMAC key for encrypting profiling context data, defaults to env[OS_PROFILE].
-
external_net
¶ Type: string Default: <None>
Name or ID of external network, defaults to env[SHAKER_EXTERNAL_NET]. If no value provided then Shaker picks any of available external networks.
-
dns_nameservers
¶ Type: list Default: 8.8.8.8,8.8.4.4
Comma-separated list of IPs of the DNS nameservers for the subnets. If no value is provided defaults to Google Public DNS.
-
image_name
¶ Type: string Default: shaker-image
Name of image to use. The default is created by shaker-image-builder.
-
flavor_name
¶ Type: string Default: shaker-flavor
Name of image flavor. The default is created by shaker-image-builder.
-
stack_name
¶ Type: string Default: <None>
Name of test heat stack. The default is a uniquely generated name.
-
reuse_stack_name
¶ Type: string Default: <None>
Name of an existing Shaker heat stack to reuse. The default is to not reuse an existing stack. Caution should be taken to only reuse stacks meant for a specific scenario. Also certain configs e.g. image-name, flavor-name, stack-name, etc will be ignored when reusing an existing stack.
-
cleanup_on_exit
¶ Type: boolean Default: true
Clean up the heat-stack when exiting execution.
-
scenario
¶ Type: list Default: <None>
Comma-separated list of scenarios to play. Each entity can be a file name or one of aliases: “misc/instance_metadata”, “openstack/cross_az/full_l2”, “openstack/cross_az/full_l3_east_west”, “openstack/cross_az/full_l3_north_south”, “openstack/cross_az/perf_l2”, “openstack/cross_az/perf_l3_east_west”, “openstack/cross_az/perf_l3_north_south”, “openstack/cross_az/udp_l2”, “openstack/cross_az/udp_l2_mss8950”, “openstack/cross_az/udp_l3_east_west”, “openstack/dense_l2”, “openstack/dense_l3_east_west”, “openstack/dense_l3_north_south”, “openstack/external/dense_l3_north_south_no_fip”, “openstack/external/dense_l3_north_south_with_fip”, “openstack/external/full_l3_north_south_no_fip”, “openstack/external/full_l3_north_south_with_fip”, “openstack/external/perf_l3_north_south_no_fip”, “openstack/external/perf_l3_north_south_with_fip”, “openstack/full_l2”, “openstack/full_l3_east_west”, “openstack/full_l3_north_south”, “openstack/perf_l2”, “openstack/perf_l3_east_west”, “openstack/perf_l3_north_south”, “openstack/qos/perf_l2”, “openstack/udp_l2”, “openstack/udp_l3_east_west”, “openstack/udp_l3_north_south”, “spot/ping”, “spot/tcp”, “spot/udp”. Defaults to env[SHAKER_SCENARIO].
-
matrix
¶ Type: unknown type Default: <None>
Set the matrix of parameters for the scenario. The value is specified in YAML format. E.g. to override the scenario duration one may provide: “{time: 10}”, or to override list of hosts: “{host:[ping.online.net, iperf.eenet.ee]}”. When several parameters are overridden all combinations are tested
-
output
¶ Type: string Default: u''
File for output in JSON format, defaults to env[SHAKER_OUTPUT]. If it is empty, then output will be saved to /tmp/shaker_<time_now>.json
-
artifacts_dir
¶ Type: string Default: <None>
If specified, directs Shaker to store there all its artifacts (output, report, subunit and book). Defaults to env[SHAKER_ARTIFACTS_DIR].
-
no_report_on_error
¶ Type: boolean Default: false
Do not generate report for failed scenarios
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
-
scenario_availability_zone
¶ Type: list Default: <None>
Comma-separated list of availability_zone. If specified this setting will override the availability_zone accomodation setting in the scenario test definition.Defaults to SCENARIO_AVAILABILITY_ZONE
-
scenario_compute_nodes
¶ Type: integer Default: <None>
Number of compute_nodes. If specified this setting will override the compute_nodes accomodation setting in the scenario test definition. Defaults to SCENARIO_COMPUTE_NODES
-
custom_user_opts
¶ Type: unknown type Default: <None>
Set custom user option parameters for the scenario. The value is specified in YAML, e.g. custom_user_opts = { key1:value1, key2:value2} The values specified can be referenced in the usual python way. e.g. {{ CONF.custom_user_opts[‘key1’] }}. This option is useful to inject custom values into heat environment files
-
agent_loss_timeout
¶ Type: integer Default: 60
Timeout to treat agent as lost in seconds, defaults to env[SHAKER_AGENT_LOSS_TIMEOUT]
-
agent_join_timeout
¶ Type: integer Default: 600
Timeout to treat agent as join failed in seconds, defaults to env[SHAKER_AGENT_JOIN_TIMEOUT] (time between stack deployment and start of scenario execution).
-
report_template
¶ Type: string Default: interactive
Template for report. Can be a file name or one of aliases: “interactive”, “json”. Defaults to “interactive”.
-
report
¶ Type: string Default: <None>
Report file name, defaults to env[SHAKER_REPORT].
-
subunit
¶ Type: string Default: <None>
Subunit stream file name, defaults to env[SHAKER_SUBUNIT].
-
book
¶ Type: string Default: <None>
Generate report in ReST format and store it into the specified folder, defaults to env[SHAKER_BOOK].
-
input
¶ Type: list Default: <None>
File or list of files to read test results from, defaults to env[SHAKER_INPUT].
-
agent_id
¶ Type: string Default: <None>
Agent unique id, defaults to MAC of primary interface.
-
agent_socket_recv_timeout
¶ Type: integer Default: <None>
The amount of time the socket will wait for a response from a sent message, in milliseconds.
-
agent_socket_send_timeout
¶ Type: integer Default: <None>
The amount of time the socket will wait until a sent message is accepted, in milliseconds.
-
agent_socket_conn_retries
¶ Type: integer Default: 10
Prior to exiting, the number of reconnects the Agent will attempt with the server upon socket operation errors.
-
image_builder_template
¶ Type: string Default: ubuntu
Heat template containing receipt of building the image. Can be a file name or one of aliases: “centos”, “debian”, “ubuntu”. Defaults to “ubuntu”.
-
flavor_ram
¶ Type: integer Default: 512
Shaker image RAM size in MB, defaults to env[SHAKER_FLAVOR_RAM]
-
flavor_vcpus
¶ Type: integer Default: 1
Number of cores to allocate for Shaker image, defaults to env[SHAKER_FLAVOR_VCPUS]
-
flavor_disk
¶ Type: integer Default: 3
Shaker image disk size in GB, defaults to env[SHAKER_FLAVOR_DISK]
-
image_builder_mode
¶ Type: string Default: <None>
Valid Values: heat, dib 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]
-
image_builder_distro
¶ Type: string Default: ubuntu
Valid Values: ubuntu, centos7 Operating System Distribution for shaker image when using diskimage-builder, defaults to ubuntu
-
cleanup
¶ Type: boolean Default: true
Cleanup the image and the flavor.
-
debug
¶ Type: boolean Default: false
Mutable: This option can be changed without restarting. If set to true, the logging level will be set to DEBUG instead of the default INFO level.
-
log_config_append
¶ Type: string Default: <None>
Mutable: This option can be changed without restarting. The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).
¶ Group Name DEFAULT log-config DEFAULT log_config
-
log_date_format
¶ Type: string Default: %Y-%m-%d %H:%M:%S
Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
-
log_file
¶ Type: string Default: <None>
(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
¶ Group Name DEFAULT logfile
-
log_dir
¶ Type: string Default: <None>
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
¶ Group Name DEFAULT logdir
-
watch_log_file
¶ Type: boolean Default: false
Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
-
use_syslog
¶ Type: boolean Default: false
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.
-
use_journal
¶ Type: boolean Default: false
Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.
-
syslog_log_facility
¶ Type: string Default: LOG_USER
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
-
use_json
¶ Type: boolean Default: false
Use JSON formatting for logging. This option is ignored if log_config_append is set.
-
use_stderr
¶ Type: boolean Default: false
Log output to standard error. This option is ignored if log_config_append is set.
-
use_eventlog
¶ Type: boolean Default: false
Log output to Windows Event Log.
-
log_rotate_interval
¶ Type: integer Default: 1
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is setto “interval”.
-
log_rotate_interval_type
¶ Type: string Default: days
Valid Values: Seconds, Minutes, Hours, Days, Weekday, Midnight Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.
-
max_logfile_count
¶ Type: integer Default: 30
Maximum number of rotated log files.
-
max_logfile_size_mb
¶ Type: integer Default: 200
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
-
log_rotation_type
¶ Type: string Default: none
Valid Values: interval, size, none Log rotation type.
Possible values
- interval
- Rotate logs at predefined time intervals.
- size
- Rotate logs once they reach a predefined size.
- none
- Do not rotate log files.
-
logging_context_format_string
¶ Type: string Default: %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s
Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter
-
logging_default_format_string
¶ Type: string Default: %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter
-
logging_debug_format_suffix
¶ Type: string Default: %(funcName)s %(pathname)s:%(lineno)d
Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter
-
logging_exception_prefix
¶ Type: string Default: %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter
-
logging_user_identity_format
¶ Type: string Default: %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter
-
default_log_levels
¶ Type: list Default: amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,oslo_messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,oslo_policy=INFO,dogpile.core.dogpile=INFO
List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
-
publish_errors
¶ Type: boolean Default: false
Enables or disables publication of error events.
-
instance_format
¶ Type: string Default: "[instance: %(uuid)s] "
The format for an instance that is passed with the log message.
-
instance_uuid_format
¶ Type: string Default: "[instance: %(uuid)s] "
The format for an instance UUID that is passed with the log message.
-
rate_limit_interval
¶ Type: integer Default: 0
Interval, number of seconds, of log rate limiting.
-
rate_limit_burst
¶ Type: integer Default: 0
Maximum number of logged messages per rate_limit_interval.
-
rate_limit_except_level
¶ Type: string Default: CRITICAL
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
-
fatal_deprecations
¶ Type: boolean Default: false
Enables or disables fatal status of deprecations.