Shaker config parameters¶
DEFAULT¶
- 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: Authentication URL, defaults to env[OS_AUTH_URL].
- os_tenant_name¶
Type: string Default: Authentication tenant name, defaults to env[OS_TENANT_NAME].
- os_project_name¶
Type: string Default: Authentication project name. This option is mutually exclusive with –os-tenant-name. Defaults to env[OS_PROJECT_NAME].
- os_username¶
Type: string Default: Authentication username, defaults to env[OS_USERNAME].
- os_password¶
Type: string Default: Authentication password, defaults to env[OS_PASSWORD].
- os_cacert¶
Type: string Default: 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].
- 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.
- cleanup_on_error¶
Type: boolean Default: true Clean up the heat-stack upon any error occurred during scenario 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”, “misc/static_agent”, “misc/static_agents_pair”, “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: 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.
- 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.
- 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”, “ubuntu_xenial”. 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]
- 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.
- verbose¶
Type: boolean Default: true If set to false, the logging level will be set to WARNING instead of the default INFO level.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- 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, logging_context_format_string).
Deprecated Variations Group Name 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.
Deprecated Variations 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.
Deprecated Variations 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.
- 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_stderr¶
Type: boolean Default: false Log output to standard error. This option is ignored if log_config_append is set.
- 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.
- 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.
- 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.
- 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.
- 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.
- default_log_levels¶
Type: list Default: amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=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,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.