## Sample Configuration File

updated: December 08, 2017

# Sample Configuration File

The following is a sample Tempest configuration for adaptation and use. It is auto-generated from Tempest when this documentation is built, so if you are having issues with an option, please compare your version of Tempest with the version of this documentation.

The sample configuration can also be viewed in file form.

    [DEFAULT]

    #
    # From oslo.log
    #

    # If set to true, the logging level will be set to DEBUG instead of
    # the default INFO level. (boolean value)
    # Note: This option can be changed without restarting.
    #debug = false

    # 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). (string value)
    # Note: This option can be changed without restarting.
    # Deprecated group/name - [DEFAULT]/log_config
    #log_config_append = <None>

    # Defines the format string for %%(asctime)s in log records. Default:
    # %(default)s . This option is ignored if log_config_append is set.
    # (string value)
    #log_date_format = %Y-%m-%d %H:%M:%S

    # (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. (string value)
    # Deprecated group/name - [DEFAULT]/logfile
    #log_file = <None>

    # (Optional) The base directory used for relative log_file  paths.
    # This option is ignored if log_config_append is set. (string value)
    # Deprecated group/name - [DEFAULT]/logdir
    #log_dir = <None>

    # 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. (boolean value)
    #watch_log_file = 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. (boolean value)
    #use_syslog = 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.
    # (boolean value)
    #use_journal = false

    # Syslog facility to receive log lines. This option is ignored if
    # log_config_append is set. (string value)
    #syslog_log_facility = LOG_USER

    # Log output to standard error. This option is ignored if
    # log_config_append is set. (boolean value)
    #use_stderr = false

    # Format string to use for log messages with context. (string value)
    #logging_context_format_string = %(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 when context is undefined.
    # (string value)
    #logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

    # Additional data to append to log message when logging level for the
    # message is DEBUG. (string value)
    #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d

    # Prefix each line of exception output with this format. (string
    # value)
    #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

    # Defines the format string for %(user_identity)s that is used in
    # logging_context_format_string. (string value)
    #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s

    # List of package logging levels in logger=LEVEL pairs. This option is
    # ignored if log_config_append is set. (list value)
    #default_log_levels = 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,dogpile.core.dogpile=INFO

    # Enables or disables publication of error events. (boolean value)
    #publish_errors = false

    # The format for an instance that is passed with the log message.
    # (string value)
    #instance_format = "[instance: %(uuid)s] "

    # The format for an instance UUID that is passed with the log message.
    # (string value)
    #instance_uuid_format = "[instance: %(uuid)s] "

    # Interval, number of seconds, of log rate limiting. (integer value)
    #rate_limit_interval = 0

    # Maximum number of logged messages per rate_limit_interval. (integer
    # value)
    #rate_limit_burst = 0

    # 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. (string value)
    #rate_limit_except_level = CRITICAL

    # Enables or disables fatal status of deprecations. (boolean value)
    #fatal_deprecations = false

    #
    # From tempest.config
    #

    # DEPRECATED: Prefix to be added when generating the name for test
    # resources. It can be used to discover all resources associated with
    # a specific test run when running tempest on a real-life cloud
    # (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: It is enough to add 'tempest' as this prefix to ideintify
    # resources which are created by Tempest and no projects set this
    # option on OpenStack dev community.
    #resources_prefix = tempest

    # Whether to pause a test in global teardown.
    #
    # The best use case is investigating used resources of one test.
    # A test can be run as follows:
    #  $ ostestr --pdb TEST_ID
    # or
    #  $ python -m testtools.run TEST_ID (boolean value)
    #pause_teardown = false

    [auth]

    #
    # From tempest.config
    #

    # Path to the yaml file that contains the list of credentials to use
    # for running tests. If used when running in parallel you have to make
    # sure sufficient credentials are provided in the accounts file. For
    # example if no tests with roles are being run it requires at least `2
    # * CONC` distinct accounts configured in  the `test_accounts_file`,
    # with CONC == the number of concurrent test processes. (string value)
    #test_accounts_file = <None>

    # Allows test cases to create/destroy projects and users. This option
    # requires that OpenStack Identity API admin credentials are known. If
    # false, isolated test cases and parallel execution, can still be
    # achieved configuring a list of test accounts (boolean value)
    # Deprecated group/name - [auth]/allow_tenant_isolation
    # Deprecated group/name - [compute]/allow_tenant_isolation
    # Deprecated group/name - [orchestration]/allow_tenant_isolation
    #use_dynamic_credentials = true

    # Roles to assign to all users created by tempest (list value)
    #tempest_roles =

    # Default domain used when getting v3 credentials. This is the name
    # keystone uses for v2 compatibility. (string value)
    # Deprecated group/name - [auth]/tenant_isolation_domain_name
    #default_credentials_domain_name = Default

    # If use_dynamic_credentials is set to True and Neutron is enabled
    # Tempest will try to create a usable network, subnet, and router when
    # needed for each project it creates. However in some neutron
    # configurations, like with VLAN provider networks, this doesn't work.
    # So if set to False the isolated networks will not be created
    # (boolean value)
    #create_isolated_networks = true

    # Username for an administrative user. This is needed for
    # authenticating requests made by project isolation to create users
    # and projects (string value)
    #admin_username = <None>

    # Project name to use for an administrative user. This is needed for
    # authenticating requests made by project isolation to create users
    # and projects (string value)
    # Deprecated group/name - [auth]/admin_tenant_name
    # Deprecated group/name - [identity]/admin_tenant_name
    #admin_project_name = <None>

    # Password to use for an administrative user. This is needed for
    # authenticating requests made by project isolation to create users
    # and projects (string value)
    #admin_password = <None>

    # Admin domain name for authentication (Keystone V3).The same domain
    # applies to user and project (string value)
    #admin_domain_name = <None>

    [compute]

    #
    # From tempest.config
    #

    # Valid primary image reference to be used in tests. This is a
    # required option (string value)
    #image_ref = <None>

    # Valid secondary image reference to be used in tests. This is a
    # required option, but if only one image is available duplicate the
    # value of image_ref above (string value)
    #image_ref_alt = <None>

    # Valid primary flavor to use in tests. (string value)
    #flavor_ref = 1

    # Valid secondary flavor to be used in tests. (string value)
    #flavor_ref_alt = 2

    # Time in seconds between build status checks. (integer value)
    #build_interval = 1

    # Timeout in seconds to wait for an instance to build. Other services
    # that do not define build_timeout will inherit this value. (integer
    # value)
    #build_timeout = 300

    # Additional wait time for clean state, when there is no OS-EXT-STS
    # extension available (integer value)
    #ready_wait = 0

    # Name of the fixed network that is visible to all test projects. If
    # multiple networks are available for a project, this is the network
    # which will be used for creating servers if tempest does not create a
    # network or a network is not specified elsewhere. It may be used for
    # ssh validation only if floating IPs are disabled. (string value)
    #fixed_network_name = <None>

    # Catalog type of the Compute service. (string value)
    #catalog_type = compute

    # The compute region name to use. If empty, the value of
    # identity.region is used instead. If no such region is found in the
    # service catalog, the first found one is used. (string value)
    #region =

    # The endpoint type to use for the compute service. (string value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    #endpoint_type = publicURL

    # Expected device name when a volume is attached to an instance. Not
    # all hypervisors guarantee that they will respect the user defined
    # device name, tests may fail if inappropriate device name is set.
    # (string value)
    #volume_device_name = vdb

    # Time in seconds before a shelved instance is eligible for removing
    # from a host.  -1 never offload, 0 offload when shelved. This time
    # should be the same as the time of nova.conf, and some tests will run
    # for as long as the time. (integer value)
    #shelved_offload_time = 0

    # The minimum number of compute nodes expected. This will be utilized
    # by some multinode specific tests to ensure that requests match the
    # expected size of the cluster you are testing with. (integer value)
    #min_compute_nodes = 1

    # Hypervisor type of the test target on heterogeneous compute
    # environment. The value can be 'QEMU', 'xen' or something. (string
    # value)
    #hypervisor_type = <None>

    # Lower version of the test target microversion range. The format is
    # 'X.Y', where 'X' and 'Y' are int values. Tempest selects tests based
    # on the range between min_microversion and max_microversion. If both
    # values are not specified, Tempest avoids tests which require a
    # microversion. Valid values are string with format 'X.Y' or string
    # 'latest' (string value)
    #min_microversion = <None>

    # Upper version of the test target microversion range. The format is
    # 'X.Y', where 'X' and 'Y' are int values. Tempest selects tests based
    # on the range between min_microversion and max_microversion. If both
    # values are not specified, Tempest avoids tests which require a
    # microversion. Valid values are string with format 'X.Y' or string
    # 'latest' (string value)
    #max_microversion = <None>

    [compute-feature-enabled]

    #
    # From tempest.config
    #

    # If false, skip disk config tests (boolean value)
    #disk_config = true

    # DEPRECATED: A list of enabled compute extensions with a special
    # entry all which indicates every extension is enabled. Each extension
    # should be specified with alias name. Empty list indicates all
    # extensions are disabled (list value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: The Nova extensions API and mechanism is deprecated. This
    # option will be removed when all releases supported by tempest no
    # longer contain the Nova extensions API and mechanism.
    #api_extensions = all

    # Does the test environment support changing the admin password?
    # (boolean value)
    #change_password = false

    # Does the test environment support obtaining instance serial console
    # output? (boolean value)
    #console_output = true

    # Does the test environment support resizing? When you enable this
    # feature, 'flavor_ref_alt' should be set and it should refer to a
    # larger flavor than 'flavor_ref' one. (boolean value)
    #resize = false

    # Does the test environment support pausing? (boolean value)
    #pause = true

    # Does the test environment support shelving/unshelving? (boolean
    # value)
    #shelve = true

    # Does the test environment support suspend/resume? (boolean value)
    #suspend = true

    # Does the test environment support cold migration? (boolean value)
    #cold_migration = true

    # Does the test environment support live migration? (boolean value)
    #live_migration = true

    # Does the test environment support live migrating VM back and forth
    # between different versions of nova-compute? (boolean value)
    #live_migrate_back_and_forth = false

    # Does the test environment support metadata service? Ignored unless
    # validation.run_validation=true. (boolean value)
    #metadata_service = true

    # Does the test environment use block devices for live migration
    # (boolean value)
    #block_migration_for_live_migration = false

    # Does the test environment support block migration with Cinder iSCSI
    # volumes. Note: libvirt >= 1.2.17 is required to support this if
    # using the libvirt compute driver. (boolean value)
    #block_migrate_cinder_iscsi = false

    # Enable VNC console. This configuration value should be same as
    # [nova.vnc]->vnc_enabled in nova.conf (boolean value)
    #vnc_console = false

    # Enable Spice console. This configuration value should be same as
    # [nova.spice]->enabled in nova.conf (boolean value)
    #spice_console = false

    # Enable RDP console. This configuration value should be same as
    # [nova.rdp]->enabled in nova.conf (boolean value)
    #rdp_console = false

    # Enable serial console. This configuration value should be the same
    # as [nova.serial_console]->enabled in nova.conf (boolean value)
    #serial_console = false

    # Does the test environment support instance rescue mode? (boolean
    # value)
    #rescue = true

    # Enables returning of the instance password by the relevant server
    # API calls such as create, rebuild or rescue. This configuration
    # value should be same as nova.conf: DEFAULT.enable_instance_password
    # (boolean value)
    #enable_instance_password = true

    # Does the test environment support dynamic network interface
    # attachment? (boolean value)
    #interface_attach = true

    # Does the test environment support creating snapshot images of
    # running instances? (boolean value)
    #snapshot = true

    # DEPRECATED: Does the test environment have the nova cert running?
    # (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: On Nova side, the nova-cert service is deprecated and the
    # service will be removed as early as Ocata.
    #nova_cert = false

    # Does the test environment support server personality (boolean value)
    #personality = false

    # Does the test environment support attaching an encrypted volume to a
    # running server instance? This may depend on the combination of
    # compute_driver in nova and the volume_driver(s) in cinder. (boolean
    # value)
    #attach_encrypted_volume = true

    # Enable special configuration drive with metadata. (boolean value)
    #config_drive = true

    # A list of enabled filters that nova will accept as hints to the
    # scheduler when creating a server. A special entry 'all' indicates
    # all filters that are included with nova are enabled. Empty list
    # indicates all filters are disabled. The full list of available
    # filters is in nova.conf: DEFAULT.scheduler_available_filters. If the
    # default value is overridden in nova.conf by the test environment
    # (which means that a different set of filters is enabled than what is
    # included in Nova by default) then, this option must be configured to
    # contain the same filters that Nova uses in the test environment.
    # (list value)
    #scheduler_available_filters = all

    # Does the test environment support in-place swapping of volumes
    # attached to a server instance? (boolean value)
    #swap_volume = false

    [debug]

    #
    # From tempest.config
    #

    # A regex to determine which requests should be traced.
    #
    # This is a regex to match the caller for rest client requests to be
    # able to
    # selectively trace calls out of specific classes and methods. It
    # largely
    # exists for test development, and is not expected to be used in a
    # real deploy
    # of tempest. This will be matched against the discovered
    # ClassName:method
    # in the test environment.
    #
    # Expected values for this field are:
    #
    #  * ClassName:test_method_name - traces one test_method
    #  * ClassName:setUp(Class) - traces specific setup functions
    #  * ClassName:tearDown(Class) - traces specific teardown functions
    #  * ClassName:_run_cleanups - traces the cleanup functions
    #
    # If nothing is specified, this feature is not enabled. To trace
    # everything
    # specify .* as the regex.
    #  (string value)
    #trace_requests =

    [identity]

    #
    # From tempest.config
    #

    # Catalog type of the Identity service. (string value)
    #catalog_type = identity

    # Set to True if using self-signed SSL certificates. (boolean value)
    #disable_ssl_certificate_validation = false

    # Specify a CA bundle file to use in verifying a TLS (https) server
    # certificate. (string value)
    #ca_certificates_file = <None>

    # Full URI of the OpenStack Identity API (Keystone), v2 (string value)
    #uri = <None>

    # Full URI of the OpenStack Identity API (Keystone), v3 (string value)
    #uri_v3 = <None>

    # Identity API version to be used for authentication for API tests.
    # (string value)
    #auth_version = v3

    # The identity region name to use. Also used as the other services'
    # region name unless they are set explicitly. If no such region is
    # found in the service catalog, the first found one is used. (string
    # value)
    #region = RegionOne

    # The admin endpoint type to use for OpenStack Identity (Keystone) API
    # v2 (string value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    #v2_admin_endpoint_type = adminURL

    # The public endpoint type to use for OpenStack Identity (Keystone)
    # API v2 (string value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    # Deprecated group/name - [identity]/endpoint_type
    #v2_public_endpoint_type = publicURL

    # The endpoint type to use for OpenStack Identity (Keystone) API v3.
    # The default value adminURL is deprecated and will be modified to
    # publicURL in the next release. (string value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    #v3_endpoint_type = adminURL

    # Role required to administrate keystone. (string value)
    #admin_role = admin

    # ID of the default domain (string value)
    #default_domain_id = default

    # Whether keystone identity v3 policy required a domain scoped token
    # to use admin APIs (boolean value)
    #admin_domain_scope = false

    # The number of unsuccessful login attempts the user is allowed before
    # having the account locked. (integer value)
    #user_lockout_failure_attempts = 2

    # The number of seconds a user account will remain locked. (integer
    # value)
    #user_lockout_duration = 5

    # The number of passwords for a user that must be unique before an old
    # password can be reused. (integer value)
    #user_unique_last_password_count = 2

    [identity-feature-enabled]

    #
    # From tempest.config
    #

    # Does the identity service have delegation and impersonation enabled
    # (boolean value)
    #trust = true

    # DEPRECATED: Is the v2 identity API enabled (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: The identity v2.0 API was removed in the Queens release.
    # Tests that exercise the v2.0 API will be removed from tempest in the
    # v22.0.0 release. They are kept only to test stable branches.
    #api_v2 = false

    # Is the v2 identity admin API available? This setting only applies if
    # api_v2 is set to True. (boolean value)
    #api_v2_admin = true

    # Is the v3 identity API enabled (boolean value)
    #api_v3 = true

    # A list of enabled identity extensions with a special entry all which
    # indicates every extension is enabled. Empty list indicates all
    # extensions are disabled. To get the list of extensions run:
    # 'openstack extension list --identity' (list value)
    #api_extensions = all

    # DEPRECATED: Does the environment forbid global roles implying domain
    # specific ones? (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: This feature flag was introduced to support testing of old
    # OpenStack versions, which are not supported anymore
    #forbid_global_implied_dsr = false

    # Are domain specific drivers enabled? This configuration value should
    # be same as [identity]->domain_specific_drivers_enabled in
    # keystone.conf. (boolean value)
    #domain_specific_drivers = false

    # Does the environment have the security compliance settings enabled?
    # (boolean value)
    #security_compliance = false

    [image]

    #
    # From tempest.config
    #

    # Catalog type of the Image service. (string value)
    #catalog_type = image

    # The image region name to use. If empty, the value of identity.region
    # is used instead. If no such region is found in the service catalog,
    # the first found one is used. (string value)
    #region =

    # The endpoint type to use for the image service. (string value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    #endpoint_type = publicURL

    # http accessible image (string value)
    #http_image = http://download.cirros-cloud.net/0.3.1/cirros-0.3.1-x86_64-uec.tar.gz

    # Timeout in seconds to wait for an image to become available.
    # (integer value)
    #build_timeout = 300

    # Time in seconds between image operation status checks. (integer
    # value)
    #build_interval = 1

    # A list of image's container formats users can specify. (list value)
    #container_formats = ami,ari,aki,bare,ovf,ova

    # A list of image's disk formats users can specify. (list value)
    #disk_formats = ami,ari,aki,vhd,vmdk,raw,qcow2,vdi,iso,vhdx

    [image-feature-enabled]

    #
    # From tempest.config
    #

    # DEPRECATED: Is the v2 image API enabled (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Glance v1 APIs are deprecated and v2 APIs are current one.
    # In future, Tempest will test v2 APIs only so this config option will
    # be removed.
    #api_v2 = true

    # DEPRECATED: Is the v1 image API enabled (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Glance v1 APIs are deprecated and v2 APIs are current one.
    # In future, Tempest will test v2 APIs only so this config option will
    # be removed.
    #api_v1 = true

    # DEPRECATED: Is the deactivate-image feature enabled. The feature has
    # been integrated since Kilo. (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: All supported versions of OpenStack now support the
    # 'deactivate_image' feature
    #deactivate_image = false

    [network]

    #
    # From tempest.config
    #

    # Catalog type of the Neutron service. (string value)
    #catalog_type = network

    # The network region name to use. If empty, the value of
    # identity.region is used instead. If no such region is found in the
    # service catalog, the first found one is used. (string value)
    #region =

    # The endpoint type to use for the network service. (string value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    #endpoint_type = publicURL

    # The cidr block to allocate project ipv4 subnets from (string value)
    #project_network_cidr = 10.100.0.0/16

    # The mask bits for project ipv4 subnets (integer value)
    #project_network_mask_bits = 28

    # The cidr block to allocate project ipv6 subnets from (string value)
    #project_network_v6_cidr = 2003::/48

    # The mask bits for project ipv6 subnets (integer value)
    #project_network_v6_mask_bits = 64

    # Whether project networks can be reached directly from the test
    # client. This must be set to True when the 'fixed' connect_method is
    # selected. (boolean value)
    #project_networks_reachable = false

    # Id of the public network that provides external connectivity (string
    # value)
    #public_network_id =

    # Default floating network name. Used to allocate floating IPs when
    # neutron is enabled. (string value)
    #floating_network_name = <None>

    # Id of the public router that provides external connectivity. This
    # should only be used when Neutron's 'allow_overlapping_ips' is set to
    # 'False' in neutron.conf. usually not needed past 'Grizzly' release
    # (string value)
    #public_router_id =

    # Timeout in seconds to wait for network operation to complete.
    # (integer value)
    #build_timeout = 300

    # Time in seconds between network operation status checks. (integer
    # value)
    #build_interval = 1

    # List of dns servers which should be used for subnet creation (list
    # value)
    #dns_servers = 8.8.8.8,8.8.4.4

    # vnic_type to use when Launching instances with pre-configured ports.
    # Supported ports are: ['normal','direct','macvtap'] (string value)
    # Allowed values: <None>, normal, direct, macvtap
    #port_vnic_type = <None>

    # List of ip pools for subnetpools creation (list value)
    #default_network = 1.0.0.0/16,2.0.0.0/16

    # The environment does not support network separation between tenants.
    # (boolean value)
    #shared_physical_network = false

    [network-feature-enabled]

    #
    # From tempest.config
    #

    # Allow the execution of IPv6 tests (boolean value)
    #ipv6 = true

    # A list of enabled network extensions with a special entry all which
    # indicates every extension is enabled. Empty list indicates all
    # extensions are disabled. To get the list of extensions run: 'neutron
    # ext-list' (list value)
    #api_extensions = all

    # Allow the execution of IPv6 subnet tests that use the extended IPv6
    # attributes ipv6_ra_mode and ipv6_address_mode (boolean value)
    #ipv6_subnet_attributes = false

    # Does the test environment support changing port admin state (boolean
    # value)
    #port_admin_state_change = true

    # Does the test environment support port security? (boolean value)
    #port_security = false

    # Does the test environment support floating_ips (boolean value)
    #floating_ips = true

    [object-storage]

    #
    # From tempest.config
    #

    # Catalog type of the Object-Storage service. (string value)
    #catalog_type = object-store

    # The object-storage region name to use. If empty, the value of
    # identity.region is used instead. If no such region is found in the
    # service catalog, the first found one is used. (string value)
    #region =

    # The endpoint type to use for the object-store service. (string
    # value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    #endpoint_type = publicURL

    # Number of seconds to time on waiting for a container to container
    # synchronization complete. (integer value)
    #container_sync_timeout = 600

    # Number of seconds to wait while looping to check the status of a
    # container to container synchronization (integer value)
    #container_sync_interval = 5

    # Role to add to users created for swift tests to enable creating
    # containers (string value)
    #operator_role = Member

    # User role that has reseller admin (string value)
    #reseller_admin_role = ResellerAdmin

    # Name of sync realm. A sync realm is a set of clusters that have
    # agreed to allow container syncing with each other. Set the same
    # realm name as Swift's container-sync-realms.conf (string value)
    #realm_name = realm1

    # One name of cluster which is set in the realm whose name is set in
    # 'realm_name' item in this file. Set the same cluster name as Swift's
    # container-sync-realms.conf (string value)
    #cluster_name = name1

    [object-storage-feature-enabled]

    #
    # From tempest.config
    #

    # A list of the enabled optional discoverable apis. A single entry,
    # all, indicates that all of these features are expected to be enabled
    # (list value)
    #discoverable_apis = all

    # Execute (old style) container-sync tests (boolean value)
    #container_sync = true

    # Execute object-versioning tests (boolean value)
    #object_versioning = true

    # Execute discoverability tests (boolean value)
    #discoverability = true

    [orchestration]

    #
    # From tempest.config
    #

    # DEPRECATED: Catalog type of the Orchestration service. (string
    # value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #catalog_type = orchestration

    # DEPRECATED: The orchestration region name to use. If empty, the
    # value of identity.region is used instead. If no such region is found
    # in the service catalog, the first found one is used. (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #region =

    # DEPRECATED: The endpoint type to use for the orchestration service.
    # (string value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #endpoint_type = publicURL

    # DEPRECATED: Role required for users to be able to manage stacks
    # (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #stack_owner_role = heat_stack_owner

    # DEPRECATED: Time in seconds between build status checks. (integer
    # value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #build_interval = 1

    # DEPRECATED: Timeout in seconds to wait for a stack to build.
    # (integer value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #build_timeout = 1200

    # DEPRECATED: Instance type for tests. Needs to be big enough for a
    # full OS plus the test workload (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #instance_type = m1.micro

    # DEPRECATED: Name of existing keypair to launch servers with. (string
    # value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #keypair_name = <None>

    # DEPRECATED: Value must match heat configuration of the same name.
    # (integer value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #max_template_size = 524288

    # DEPRECATED: Value must match heat configuration of the same name.
    # (integer value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #max_resources_per_stack = 1000

    [oslo_concurrency]

    #
    # From oslo.concurrency
    #

    # Enables or disables inter-process locks. (boolean value)
    #disable_process_locking = false

    # Directory to use for lock files.  For security, the specified
    # directory should only be writable by the user running the processes
    # that need locking. Defaults to environment variable OSLO_LOCK_PATH.
    # If OSLO_LOCK_PATH is not set in the environment, use the Python
    # tempfile.gettempdir function to find a suitable location. If
    # external locks are used, a lock path must be set. (string value)
    #lock_path = /tmp

    [scenario]

    #
    # From tempest.config
    #

    # DEPRECATED: Directory containing image files (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    #img_dir = /opt/stack/new/devstack/files/images/cirros-0.3.1-x86_64-uec

    # Image file name (string value)
    # Deprecated group/name - [scenario]/qcow2_img_file
    #img_file = cirros-0.3.1-x86_64-disk.img

    # Image disk format (string value)
    #img_disk_format = qcow2

    # Image container format (string value)
    #img_container_format = bare

    # Glance image properties. Use for custom images which require them
    # (dict value)
    #img_properties = <None>

    # DEPRECATED: AMI image file name (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    #ami_img_file = cirros-0.3.1-x86_64-blank.img

    # DEPRECATED: ARI image file name (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    #ari_img_file = cirros-0.3.1-x86_64-initrd

    # DEPRECATED: AKI image file name (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    #aki_img_file = cirros-0.3.1-x86_64-vmlinuz

    # DHCP client used by images to renew DCHP lease. If left empty,
    # update operation will be skipped. Supported clients: "udhcpc",
    # "dhclient" (string value)
    # Allowed values: udhcpc, dhclient, ''
    #dhcp_client = udhcpc

    [service-clients]

    #
    # From tempest.config
    #

    # Timeout in seconds to wait for the http request to return (integer
    # value)
    #http_timeout = 60

    # Specify an http proxy to use. (string value)
    #proxy_url = <None>

    [service_available]

    #
    # From tempest.config
    #

    # Whether or not cinder is expected to be available (boolean value)
    #cinder = true

    # Whether or not neutron is expected to be available (boolean value)
    #neutron = false

    # Whether or not glance is expected to be available (boolean value)
    #glance = true

    # Whether or not swift is expected to be available (boolean value)
    #swift = true

    # Whether or not nova is expected to be available (boolean value)
    #nova = true

    # DEPRECATED: Whether or not Heat is expected to be available (boolean
    # value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Heat support will be removed from Tempest
    #heat = false

    [validation]

    #
    # From tempest.config
    #

    # Enable ssh on created servers and creation of additional validation
    # resources to enable remote access (boolean value)
    #run_validation = false

    # Enable/disable security groups. (boolean value)
    #security_group = true

    # Enable/disable security group rules. (boolean value)
    #security_group_rules = true

    # Default IP type used for validation: -fixed: uses the first IP
    # belonging to the fixed network -floating: creates and uses a
    # floating IP (string value)
    # Allowed values: fixed, floating
    #connect_method = floating

    # Default authentication method to the instance. Only ssh via keypair
    # is supported for now. Additional methods will be handled in a
    # separate spec. (string value)
    # Allowed values: keypair
    #auth_method = keypair

    # Default IP version for ssh connections. (integer value)
    #ip_version_for_ssh = 4

    # Timeout in seconds to wait for ping to succeed. (integer value)
    #ping_timeout = 120

    # Timeout in seconds to wait for the TCP connection to be successful.
    # (integer value)
    #connect_timeout = 60

    # Timeout in seconds to wait for the ssh banner. (integer value)
    #ssh_timeout = 300

    # User name used to authenticate to an instance. (string value)
    #image_ssh_user = root

    # Password used to authenticate to an instance. (string value)
    #image_ssh_password = password

    # Shell fragments to use before executing a command when sshing to a
    # guest. (string value)
    #ssh_shell_prologue = set -eu -o pipefail; PATH=$$PATH:/sbin;

    # The packet size for ping packets originating from remote linux hosts
    # (integer value)
    #ping_size = 56

    # The number of ping packets originating from remote linux hosts
    # (integer value)
    #ping_count = 1

    # Unallocated floating IP range, which will be used to test the
    # floating IP bulk feature for CRUD operation. This block must not
    # overlap an existing floating IP pool. (string value)
    #floating_ip_range = 10.0.0.0/29

    # Network used for SSH connections. Ignored if
    # connect_method=floating. (string value)
    #network_for_ssh = public

    [volume]

    #
    # From tempest.config
    #

    # Time in seconds between volume availability checks. (integer value)
    #build_interval = 1

    # Timeout in seconds to wait for a volume to become available.
    # (integer value)
    #build_timeout = 300

    # Catalog type of the Volume Service (string value)
    #catalog_type = volume

    # The volume region name to use. If empty, the value of
    # identity.region is used instead. If no such region is found in the
    # service catalog, the first found one is used. (string value)
    #region =

    # The endpoint type to use for the volume service. (string value)
    # Allowed values: public, admin, internal, publicURL, adminURL, internalURL
    #endpoint_type = publicURL

    # A list of backend names separated by comma. The backend name must be
    # declared in cinder.conf (list value)
    #backend_names = BACKEND_1,BACKEND_2

    # Backend protocol to target when creating volume types (string value)
    #storage_protocol = iSCSI

    # Backend vendor to target when creating volume types (string value)
    #vendor_name = Open Source

    # Disk format to use when copying a volume to image (string value)
    #disk_format = raw

    # Default size in GB for volumes created by volumes tests (integer
    # value)
    #volume_size = 1

    # A reference to existing volume for volume manage. It contains two
    # elements, the first is ref type (like 'source-name', 'source-id',
    # etc), the second is volume name template used in storage backend
    # (list value)
    #manage_volume_ref = source-name,volume-%s

    # A reference to existing snapshot for snapshot manage. It contains
    # two elements, the first is ref type (like 'source-name', 'source-
    # id', etc), the second is snapshot name template used in storage
    # backend (list value)
    #manage_snapshot_ref = source-name,_snapshot-%s

    # Lower version of the test target microversion range. The format is
    # 'X.Y', where 'X' and 'Y' are int values. Tempest selects tests based
    # on the range between min_microversion and max_microversion. If both
    # values are not specified, Tempest avoids tests which require a
    # microversion. Valid values are string with format 'X.Y' or string
    # 'latest' (string value)
    #min_microversion = <None>

    # Upper version of the test target microversion range. The format is
    # 'X.Y', where 'X' and 'Y' are int values. Tempest selects tests based
    # on the range between min_microversion and max_microversion. If both
    # values are not specified, Tempest avoids tests which require a
    # microversion. Valid values are string with format 'X.Y' or string
    # 'latest' (string value)
    #max_microversion = <None>

    [volume-feature-enabled]

    #
    # From tempest.config
    #

    # Runs Cinder multi-backend test (requires 2 backends) (boolean value)
    #multi_backend = false

    # Runs Cinder volumes backup test (boolean value)
    #backup = true

    # Runs Cinder volume snapshot test (boolean value)
    #snapshot = true

    # Runs Cinder volume clone test (boolean value)
    #clone = true

    # Runs Cinder manage snapshot tests (boolean value)
    #manage_snapshot = false

    # Runs Cinder manage volume tests (boolean value)
    #manage_volume = false

    # A list of enabled volume extensions with a special entry all which
    # indicates every extension is enabled. Empty list indicates all
    # extensions are disabled (list value)
    #api_extensions = all

    # DEPRECATED: Is the v1 volume API enabled (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: The v1 volume API has been deprecated since Juno release,
    # and the API will be removed.
    #api_v1 = false

    # Is the v2 volume API enabled (boolean value)
    #api_v2 = true

    # Is the v3 volume API enabled (boolean value)
    #api_v3 = true

    # Does the cloud support extending the size of a volume which is
    # currently attached to a server instance? This depends on the 3.42
    # volume API microversion and the 2.51 compute API microversion. Also,
    # not all volume or compute backends support this operation. (boolean
    # value)
    #extend_attached_volume = false

updated: December 08, 2017

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug questions?