Red Hat 7 OpenStack Platform Configuration Reference Guide
Below you will find brief information for OpenStack Platform 7. This guide provides detailed instructions on configuring Red Hat Enterprise Linux OpenStack Platform 7 environments.
Advertisement
Advertisement
Red Hat Enterprise Linux OpenStack
Platform 7
Configuration Reference
Configuring Red Hat Enterprise Linux OpenStack Platform environments
OpenStack Documentation TeamRed Hat
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuring Red Hat Enterprise Linux OpenStack Platform environments
OpenStack Documentation Team
Red Hat Customer Content Services [email protected]
Legal Notice
Copyright © 2015 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons
Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/
. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,
Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.
Java ® is a registered trademark of Oracle and/or its affiliates.
XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL ® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js ® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Abstract
This document is for system administrators who want to look up configuration options. It contains lists of configuration options available with OpenStack and uses auto-generation to generate options and the descriptions from the code for each project. It includes sample configuration files.
Table of Contents
Table of Contents
2.1. INTRODUCTION TO THE BLOCK STORAGE SERVICE
2.4. BLOCK STORAGE SAMPLE CONFIGURATION FILES
2.5. LOG FILES USED BY BLOCK STORAGE
2.6. FIBRE CHANNEL ZONE MANAGER
2.8. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR OPENSTACK BLOCK STORAGE
3.3. CONFIGURE AUTHENTICATION AND AUTHORIZATION
3.6. CONFIGURE THE OSLO RPC MESSAGING SYSTEM
3.7. CONFIGURE THE COMPUTE API
3.9. FIBRE CHANNEL SUPPORT IN COMPUTE
3.10. ISCSI INTERFACE AND OFFLOAD SUPPORT IN COMPUTE
3.15. EXAMPLE NOVA.CONF CONFIGURATION FILES
3.17. COMPUTE SAMPLE CONFIGURATION FILES
3.18. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR OPENSTACK COMPUTE
4.3. ADDITIONAL SAMPLE CONFIGURATION FILES
5.2. CONFIGURE THE RPC MESSAGING SYSTEM
5.3. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR DATABASE SERVICE
6.1. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR DATA PROCESSING SERVICE
7.1. IDENTITY SERVICE CONFIGURATION FILE
7.2. IDENTITY SERVICE SAMPLE CONFIGURATION FILES
7.3. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR OPENSTACK IDENTITY
8.2. CONFIGURE THE RPC MESSAGING SYSTEM
234
253
273
278
278
282
282
350
224
229
232
232
233
220
223
223
223
223
362
367
370
382
30
31
109
114
172
172
176
207
400
410
415
442
451
483
527
553
556
1
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
8.2. CONFIGURE THE RPC MESSAGING SYSTEM
8.6. IMAGE SERVICE SAMPLE CONFIGURATION FILES
8.7. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR OPENSTACK IMAGE SERVICE
9.1. NETWORKING CONFIGURATION OPTIONS
9.2. LOG FILES USED BY NETWORKING
9.3. NETWORKING SAMPLE CONFIGURATION FILES
9.4. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR OPENSTACK NETWORKING
10.1. INTRODUCTION TO OBJECT STORAGE
10.2. OBJECT STORAGE GENERAL SERVICE CONFIGURATION
10.3. OBJECT SERVER CONFIGURATION
10.4. OBJECT EXPIRER CONFIGURATION
10.5. CONTAINER SERVER CONFIGURATION
10.6. CONTAINER SYNC REALMS CONFIGURATION
10.7. CONTAINER RECONCILER CONFIGURATION
10.8. ACCOUNT SERVER CONFIGURATION
10.9. PROXY SERVER CONFIGURATION
10.10. PROXY SERVER MEMCACHE CONFIGURATION
10.12. CONFIGURE OBJECT STORAGE FEATURES
10.13. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR OPENSTACK OBJECT STORAGE
730
730
732
746
752
763
765
768
778
804
805
806
824
616
683
684
715
556
562
564
565
574
605
11.3. CONFIGURE THE RPC MESSAGING SYSTEM
11.4. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR ORCHESTRATION
12.1. TELEMETRY SAMPLE CONFIGURATION FILES
12.2. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR TELEMETRY
839
844
850
855
886
920
927
929
931
2
Table of Contents
3
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
CHAPTER 1. BARE METAL
The Bare metal service is capable of managing and provisioning physical machines. The configuration file of this module is /etc/ironic/ironic.conf.
The following tables provide a comprehensive list of the Bare metal service configuration options.
Table 1.1. Description of agent configuration options
Configuration option = Default value
[agent] agent_api_version
= v1
manage_tftp
= True
Description agent_erase_devices_priority
= None
agent_pxe_append_params
= nofb
nomodeset vga=normal
agent_pxe_bootfile_name
= pxelinux.0
agent_pxe_config_template
=
$pybasedir/drivers/modules/agent_config.template
(StrOpt) Additional append parameters for baremetal PXE boot.
(StrOpt) Neutron bootfile DHCP parameter.
(StrOpt) Template file for PXE configuration.
heartbeat_timeout
= 300
(StrOpt) API version to use for communicating with the ramdisk agent.
(IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the
GenericHardwareManager). If set to 0, will not run during cleaning.
(IntOpt) Maximum interval (in seconds) for agent heartbeats.
(BoolOpt) Whether Ironic will manage TFTP files for the deploy ramdisks. If set to False, you will need to configure your own TFTP server that allows booting the deploy ramdisks.
Table 1.2. Description of AMQP configuration options
Description Configuration option = Default value
[DEFAULT] control_exchange
= openstack (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
4
Configuration option = Default value notification_driver
= []
notification_topics
= notifications
transport_url
= None
CHAPTER 1. BARE METAL
Description
(MultiStrOpt) Driver or drivers to handle sending notifications.
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
Table 1.3. Description of AMT configuration options
Description Configuration option = Default value
[amt] action_wait
= 10
max_attempts protocol
= http
= 3
(IntOpt) Amount of time (in seconds) to wait, before retrying an AMT operation
(IntOpt) Maximum number of times to attempt an
AMT operation, before failing
(StrOpt) Protocol used for AMT endpoint, support http/https
Table 1.4. Description of API configuration options
Description Configuration option = Default value
[api] host_ip
= 0.0.0.0
max_limit
= 1000
port
= 6385
(StrOpt) The listen IP for the Ironic API server.
(IntOpt) The maximum number of items returned in a single response from a collection resource.
(IntOpt) The port for the Ironic API server.
Table 1.5. Description of authorization token configuration options
5
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
admin_token
= None
admin_user auth_port auth_uri cache cafile certfile
= None
auth_admin_prefix auth_host
= 127.0.0.1
auth_plugin
= None
= 35357
auth_protocol auth_section
= None
= None
= https
= None
= None
auth_version
= None
= None
=
(StrOpt) Service user password.
(StrOpt) Service tenant name.
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
6
CHAPTER 1. BARE METAL
Configuration option = Default value check_revocations_for_cached
= False
delay_auth_decision enforce_token_bind hash_algorithms http_connect_timeout http_request_max_retries identity_uri insecure keyfile
= False
= None
= md5
= None
= False
= permissive
= None
include_service_catalog
= 3
= True
Description
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times are we trying to reconnect when communicating with Identity API
Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
7
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value memcache_pool_conn_get_timeout
= 10
memcache_pool_dead_retry memcache_pool_maxsize memcached_servers signing_dir
= None
= None
revocation_cache_time
= 10
= 10
= 300
memcache_pool_socket_timeout memcache_pool_unused_timeout memcache_secret_key
= None
memcache_security_strategy memcache_use_advanced_pool
= 3
= 60
= None
= False
Description
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
(StrOpt) Directory used to cache files related to PKI tokens.
8
Configuration option = Default value token_cache_time
= 300
CHAPTER 1. BARE METAL
Description
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
Table 1.6. Description of authorization configuration options
Description Configuration option = Default value
[DEFAULT] auth_strategy
= keystone (StrOpt) Method to use for authentication: noauth or keystone.
Table 1.7. Description of common configuration options
Description Configuration option = Default value
[DEFAULT] bindir
= /usr/local/bin
enabled_drivers
= pxe_ipmitool
fatal_deprecations
= False
force_raw_images
= True
grub_config_template
=
$pybasedir/common/grub_conf.template
(StrOpt) Directory where ironic binaries are installed.
(ListOpt) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online.
(BoolOpt) Enables or disables fatal status of deprecations.
(BoolOpt) Force backing images to raw format.
(StrOpt) Template file for grub configuration file.
9
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value hash_distribution_replicas
= 1
hash_partition_exponent host
= sd-52009.dedibox.fr
= 5
Description
(IntOpt) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated.
(IntOpt) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is
(2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Too many partitions has a CPU impact.
(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key.
(StrOpt) Path to isolinux binary file.
(StrOpt) Template file for isolinux configuration file.
isolinux_bin
= /usr/lib/syslinux/isolinux.bin
isolinux_config_template
=
$pybasedir/common/isolinux_config.template
memcached_servers
= None
my_ip
= 10.0.0.1
parallel_image_downloads
= False
periodic_interval
= 60
pybasedir
= /usr/lib/python/site-
packages/ironic/ironic
rootwrap_config
= /etc/ironic/rootwrap.conf
run_external_periodic_tasks
= True
(ListOpt) Memcached servers or None for in process cache.
(StrOpt) IP address of this host.
(BoolOpt) Run image downloads and raw format conversions in parallel.
(IntOpt) Seconds between running periodic tasks.
(StrOpt) Directory where the ironic python module is installed.
(StrOpt) Path to the rootwrap configuration file to use for running commands as root.
(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?
10
Configuration option = Default value state_path
= $pybasedir
tempdir
= None
CHAPTER 1. BARE METAL
Description
(StrOpt) Top-level directory for maintaining ironic's state.
(StrOpt) Explicitly specify the temporary working directory.
Table 1.8. Description of conductor configuration options
Configuration option = Default value
[conductor] api_url
= None
Description check_provision_state_interval clean_nodes
= True
configdrive_swift_container
ironic_configdrive_container
=
= 60
(StrOpt) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog.
(IntOpt) Interval between checks of provision timeouts, in seconds.
(BoolOpt) Cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion, and during the transition from a
"managed" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver's documentation for details. NOTE:
The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled.
(StrOpt) Name of the Swift container to store config drive data. Used when configdrive_use_swift is
True.
configdrive_use_swift
= False (BoolOpt) Whether to upload the config drive to
Swift.
deploy_callback_timeout
= 1800 (IntOpt) Timeout (seconds) for waiting callback from deploy ramdisk. 0 - unlimited.
force_power_state_during_sync
= True (BoolOpt) During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False).
11
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value heartbeat_interval
= 10
heartbeat_timeout
= 60
inspect_timeout
= 1800
node_locked_retry_attempts node_locked_retry_interval periodic_max_workers
= 8
power_state_sync_max_retries send_sensor_data
= False
send_sensor_data_interval send_sensor_data_types
= ALL
sync_local_state_interval sync_power_state_interval workers_pool_size
= 100
= 3
= 1
= 600
= 60
= 3
= 180
Description
(IntOpt) Seconds between conductor heart beats.
(IntOpt) Maximum time (in seconds) since the last check-in of a conductor.
(IntOpt) Timeout (seconds) for waiting for node inspection. 0 - unlimited.
(IntOpt) Number of attempts to grab a node lock.
(IntOpt) Seconds to sleep between node lock attempts.
(IntOpt) Maximum number of worker threads that can be started simultaneously by a periodic task.
Should be less than RPC thread pool size.
(IntOpt) During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB
(BoolOpt) Enable sending sensor data message via the notification bus
(IntOpt) Seconds between conductor sending sensor data message to ceilometer via the notification bus.
(ListOpt) List of comma separated metric types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data.
(IntOpt) When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to a negative value to disable the check entirely.
(IntOpt) Interval between syncing the node power state to the database, in seconds.
(IntOpt) The size of the workers greenthread pool.
Table 1.9. Description of console configuration options
12
CHAPTER 1. BARE METAL
Configuration option = Default value
[console] subprocess_checking_interval
= 1
subprocess_timeout terminal
= shellinaboxd
terminal_pid_dir
= 10
terminal_cert_dir
= None
= None
Description
(IntOpt) Time interval (in seconds) for checking the status of console subprocess.
(IntOpt) Time (in seconds) to wait for the console subprocess to start.
(StrOpt) Path to serial console terminal program
(StrOpt) Directory containing the terminal SSL cert(PEM) for serial console access
(StrOpt) Directory for holding terminal pid files. If not specified, the temporary directory will be used.
Table 1.10. Description of database configuration options
Description Configuration option = Default value
[database] backend
= sqlalchemy
connection
= None
connection_debug
= 0
connection_trace db_max_retries
= False
db_inc_retry_interval
= 20
db_max_retry_interval db_retry_interval
= 1
= True
= 10
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
13
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value idle_timeout
= 3600
max_overflow max_pool_size max_retries min_pool_size
= 1
mysql_engine
= InnoDB
mysql_sql_mode
= TRADITIONAL
pool_timeout
= None
retry_interval
= 10
slave_connection sqlite_db
= None
= None
= 10
= None
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
Description
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) MySQL engine to use.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
Table 1.11. Description of logging configuration options
Description Configuration option = Default value
[DEFAULT]
14
Configuration option = Default value backdoor_port
= None
pecan_debug
= False
CHAPTER 1. BARE METAL
Description
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
(BoolOpt) Enable pecan debug mode. WARNING: this is insecure and should not be used in production.
Table 1.12. Description of deploy configuration options
Description Configuration option = Default value
[deploy] dd_block_size
= 1M
efi_system_partition_size iscsi_verify_attempts
= 3
= 200
(StrOpt) Block size to use when writing to the nodes disk.
(IntOpt) Size of EFI system partition in MiB when configuring UEFI systems for local boot.
(IntOpt) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts.
Table 1.13. Description of DHCP configuration options
Description Configuration option = Default value
[dhcp] dhcp_provider
= neutron (StrOpt) DHCP provider to use. "neutron" uses
Neutron, and "none" uses a no-op provider.
Table 1.14. Description of discoverd configuration options
Description Configuration option = Default value
[discoverd]
15
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value enabled
= False
service_url
= None
status_check_period
= 60
Description
(BoolOpt) whether to enable inspection using ironic-discoverd
(StrOpt) ironic-discoverd HTTP endpoint. If this is not set, the ironic-discoverd client default
(http://127.0.0.1:5050) will be used.
(IntOpt) period (in seconds) to check status of nodes on inspection
Table 1.15. Description of disk partitioner configuration options
Description Configuration option = Default value
[disk_partitioner] check_device_interval
= 1
check_device_max_retries
= 20
(IntOpt) After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds
(IntOpt) The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed.
Table 1.16. Description of glance configuration options
Description Configuration option = Default value
[glance] allowed_direct_url_schemes
=
auth_strategy
= keystone
glance_api_insecure glance_api_servers
= False
= None
(ListOpt) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].
(StrOpt) Authentication strategy to use when connecting to glance. Only "keystone" and "noauth" are currently supported by ironic.
(BoolOpt) Allow to perform insecure SSL (https) requests to glance.
(ListOpt) A list of the glance api servers available to ironic. Prefix with https:// for SSL-based glance API servers. Format is [hostname|IP]:port.
16
CHAPTER 1. BARE METAL
Configuration option = Default value glance_host
= $my_ip
glance_num_retries
= 0
glance_port
= 9292
glance_protocol swift_account
= http
= None
swift_api_version swift_container
= v1
= glance
Description
(StrOpt) Default glance hostname or IP address.
(IntOpt) Number of retries when downloading an image from glance.
(IntOpt) Default glance port.
(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.
(StrOpt) The account that Glance uses to communicate with Swift. The format is
"AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs. For example: "AUTH_a422b2-
91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary
URL format:
"endpoint_url/api_version/account/container/object
_id"
(StrOpt) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format:
"endpoint_url/api_version/account/container/object
_id"
(StrOpt) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format:
"endpoint_url/api_version/account/container/object
_id"
swift_endpoint_url
= None (StrOpt) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form
"endpoint_url/api_version/account/container/object
_id". Do not include trailing "/". For example, use
"https://swift.example.com". Required for temporary
URLs.
swift_store_multiple_containers_se ed
= 0
(IntOpt) This should match a config by the same name in the Glance configuration file. When set to
0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a single-tenant store will use multiple containers to store images, and this value will determine how many containers are created.
17
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value swift_temp_url_duration
= 1200
swift_temp_url_key
= None
Description
(IntOpt) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration.
(StrOpt) The secret token given to Swift to allow temporary URL downloads. Required for temporary
URLs.
Table 1.17. Description of iLO configuration options
Configuration option = Default value
[ilo]
Description clean_priority_clear_secure_boot_k eys
= 0
(IntOpt) Priority for clear_secure_boot_keys clean step. This step is not enabled by default. It can be enabled to to clear all secure boot keys enrolled with iLO.
clean_priority_erase_devices
= None (IntOpt) Priority for erase devices clean step. If unset, it defaults to 10. If set to 0, the step will be disabled and will not run during cleaning.
clean_priority_reset_bios_to_defau lt
= 10
(IntOpt) Priority for reset_bios_to_default clean step.
clean_priority_reset_ilo
= 1
clean_priority_reset_ilo_credentia l
= 30
(IntOpt) Priority for reset_ilo clean step.
(IntOpt) Priority for reset_ilo_credential clean step.
This step requires "ilo_change_password" parameter to be updated in nodes's driver_info with the new password.
clean_priority_reset_secure_boot_k eys_to_default
= 20
(IntOpt) Priority for reset_secure_boot_keys clean step. This step will reset the secure boot keys to manufacturing defaults.
client_port
= 443
client_timeout
= 60
power_retry
= 6
(IntOpt) Port to be used for iLO operations
(IntOpt) Timeout (in seconds) for iLO operations
(IntOpt) Number of times a power operation needs to be retried
power_wait
= 2 (IntOpt) Amount of time in seconds to wait in between power operations
18
CHAPTER 1. BARE METAL
Configuration option = Default value Description swift_ilo_container
= ironic_ilo_container (StrOpt) The Swift iLO container to store data.
swift_object_expiry_timeout
= 900 (IntOpt) Amount of time in seconds for Swift objects to auto-expire.
Table 1.18. Description of IPMI configuration options
Description Configuration option = Default value
[ipmi] min_command_interval
= 5
retry_timeout
= 60
(IntOpt) Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds.
(IntOpt) Maximum time in seconds to retry IPMI operations. There is a tradeoff when setting this value. Setting this too low may cause older BMCs to crash and require a hard reset. However, setting too high can cause the sync power state periodic task to hang when there are slow or unresponsive
BMCs.
Table 1.19. Description of iRMC configuration options
Description Configuration option = Default value
[irmc] auth_method
= basic
client_timeout port
= 443
sensor_method
= 60
= ipmitool
(StrOpt) Authentication method to be used for iRMC operations, either "basic" or "digest"
(IntOpt) Timeout (in seconds) for iRMC operations
(IntOpt) Port to be used for iRMC operations, either
80 or 443
(StrOpt) Sensor data retrieval method, either
"ipmitool" or "scci"
Table 1.20. Description of keystone configuration options
19
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[keystone] region_name
= None (StrOpt) The region used for getting endpoints of
OpenStackservices.
Table 1.21. Description of logging configuration options
Configuration option = Default value
[DEFAULT]
Description debug
= False (BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
default_log_levels
= 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, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN
(ListOpt) List of logger=LEVEL pairs.
fatal_exception_format_errors
False
instance_format
=
= "[instance: %(uuid)s] "
instance_uuid_format
= "[instance: %
(uuid)s] "
(BoolOpt) Make exception message format errors fatal.
(StrOpt) The format for an instance that is passed with the log message.
(StrOpt) The format for an instance UUID that is passed with the log message.
log_config_append
= None (StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None (StrOpt) (Optional) The base directory used for relative --log-file paths.
log_file
= None (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
20
CHAPTER 1. BARE METAL
Configuration option = Default value log_format
= None
logging_context_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
syslog_log_facility use_stderr use_syslog
= True
= False
= LOG_USER
use_syslog_rfc_format verbose
= False
= False
Description
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
(StrOpt) Prefix each line of exception output with this format.
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Log output to standard error.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 1.22. Description of neutron configuration options
21
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[neutron] auth_strategy
= keystone
cleaning_network_uuid retries url
= 3
= http://$my_ip:9696
url_timeout
= 30
= None
(StrOpt) Default authentication strategy to use when connecting to neutron. Can be either
"keystone" or "noauth". Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing.
(StrOpt) UUID of the network to create Neutron ports on when booting to a ramdisk for cleaning/zapping using Neutron DHCP
(IntOpt) Client retries in the case of a failed request.
(StrOpt) URL for connecting to neutron.
(IntOpt) Timeout value for connecting to neutron in seconds.
Table 1.23. Description of policy configuration options
Description Configuration option = Default value
[oslo_policy] policy_default_rule
= default
policy_dirs
= ['policy.d']
policy_file
= policy.json
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
Table 1.24. Description of PXE configuration options
Description Configuration option = Default value
[pxe]
22
CHAPTER 1. BARE METAL
Configuration option = Default value default_ephemeral_format
= ext4
disk_devices http_root http_url
= /httpboot
= None
image_cache_size image_cache_ttl images_path
= cciss/c0d0,sda,hda,vda
= 20480
= 10080
= /var/lib/ironic/images/
Description
(StrOpt) Default file system format for ephemeral partition, if one is created.
(StrOpt) The disk devices to scan while doing the deploy.
(StrOpt) Ironic compute node's HTTP root path.
(StrOpt) Ironic compute node's HTTP server URL.
Example: http://192.1.2.3:8080
(IntOpt) Maximum size (in MiB) of cache for master images, including those in use.
(IntOpt) Maximum TTL (in minutes) for old master images in cache.
(StrOpt) Directory where images are stored on disk.
(StrOpt) Directory where master instance images are stored on disk.
(StrOpt) The path to the main iPXE script file.
instance_master_path
=
/var/lib/ironic/master_images
ipxe_boot_script
=
$pybasedir/drivers/modules/boot.ipxe
ipxe_enabled
= False
pxe_append_params
= nofb nomodeset
vga=normal
(BoolOpt) Enable iPXE boot.
(StrOpt) Additional append parameters for baremetal PXE boot.
pxe_bootfile_name
= pxelinux.0
pxe_config_template
=
$pybasedir/drivers/modules/pxe_config.template
uefi_pxe_bootfile_name
= elilo.efi
(StrOpt) Bootfile DHCP parameter.
(StrOpt) Template file for PXE configuration.
tftp_master_path
= /tftpboot/master_images (StrOpt) Directory where master tftp images are stored on disk.
(StrOpt) Ironic compute node's tftp root path.
tftp_root
= /tftpboot
tftp_server
= $my_ip (StrOpt) IP address of Ironic compute node's tftp server.
(StrOpt) Bootfile DHCP parameter for UEFI boot mode.
23
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description uefi_pxe_config_template
=
$pybasedir/drivers/modules/elilo_efi_pxe_config.te
mplate
(StrOpt) Template file for PXE configuration for
UEFI boot loader.
Table 1.25. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
Table 1.26. Description of RPC configuration options
Description Configuration option = Default value
[DEFAULT] matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
rpc_cast_timeout
[oslo_concurrency]
= 30
rpc_response_timeout rpc_thread_pool_size
= 60
= 64
disable_process_locking
= False
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
(IntOpt) Size of RPC thread pool.
(BoolOpt) Enables or disables inter-process locks.
24
Configuration option = Default value lock_path
= None
CHAPTER 1. BARE METAL
Description
(StrOpt) 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 external locks are used, a lock path must be set.
[oslo_messaging_amqp] allow_insecure_clients
= False
broadcast_prefix container_name group_request_prefix idle_timeout
= 0
ssl_key_password
= broadcast
= None
= unicast
server_request_prefix ssl_ca_file
=
ssl_cert_file ssl_key_file
=
=
= exclusive
= None
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
trace
= False
Table 1.27. Description of RabbitMQ configuration options
Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
Description
(BoolOpt) Auto-delete queues in AMQP.
25
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value amqp_durable_queues
= False
fake_rabbit
= False
heartbeat_rate rabbit_host rabbit_hosts
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_port
= 2
heartbeat_timeout_threshold kombu_reconnect_delay kombu_ssl_ca_certs kombu_ssl_certfile kombu_ssl_keyfile
=
kombu_ssl_version
=
rabbit_ha_queues rabbit_password
=
= guest
= 5672
=
= localhost
= 1.0
= False
= 0
Description
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
26
Configuration option = Default value rabbit_retry_backoff
= 2
rabbit_retry_interval
= 1
rabbit_use_ssl
= False
rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
CHAPTER 1. BARE METAL
Description
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
Table 1.28. Description of Qpid configuration options
Description Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname qpid_hosts qpid_password
= localhost
= $qpid_hostname:$qpid_port
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity qpid_sasl_mechanisms qpid_tcp_nodelay
=
= True
= 1
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
27
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value qpid_topology_version
= 1
qpid_username
=
rpc_conn_pool_size
= 30
Description
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
Table 1.29. Description of SeaMicro configuration options
Description Configuration option = Default value
[seamicro] action_timeout
= 10
max_retry
= 3
(IntOpt) Seconds to wait for power action to be completed
(IntOpt) Maximum retries for SeaMicro operations
Table 1.30. Description of SNMP configuration options
Description Configuration option = Default value
[snmp] power_timeout
= 10 (IntOpt) Seconds to wait for power action to be completed
Table 1.31. Description of SSH configuration options
Description Configuration option = Default value
[ssh] libvirt_uri
= qemu:///system (StrOpt) libvirt uri
Table 1.32. Description of swift configuration options
28
CHAPTER 1. BARE METAL
Configuration option = Default value
[swift] swift_max_retries
= 2
Description
(IntOpt) Maximum number of times to retry a Swift request, before failing.
Table 1.33. Description of VirtualBox configuration options
Description Configuration option = Default value
[virtualbox] port
= 18083 (IntOpt) Port on which VirtualBox web service is listening.
29
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
CHAPTER 2. BLOCK STORAGE
The OpenStack Block Storage service works with many different storage drivers that you can configure by using these instructions.
2.1. INTRODUCTION TO THE BLOCK STORAGE SERVICE
The OpenStack Block Storage service provides persistent block storage resources that OpenStack
Compute instances can consume. This includes secondary attached storage similar to the Amazon
Elastic Block Storage (EBS) offering. In addition, you can write images to a Block Storage device for
Compute to use as a bootable persistent instance.
The Block Storage service differs slightly from the Amazon EBS offering. The Block Storage service does not provide a shared storage solution like NFS. With the Block Storage service, you can attach a device to only one instance.
The Block Storage service provides:
cinder-api. A WSGI app that authenticates and routes requests throughout the Block Storage service. It supports the OpenStack APIs only, although there is a translation that can be done through Compute's EC2 interface, which calls in to the Block Storage client.
cinder-scheduler. Schedules and routes requests to the appropriate volume service.
Depending upon your configuration, this may be simple round-robin scheduling to the running volume services, or it can be more sophisticated through the use of the Filter Scheduler. The
Filter Scheduler is the default and enables filters on things like Capacity, Availability Zone,
Volume Types, and Capabilities as well as custom filters.
cinder-volume. Manages Block Storage devices, specifically the back-end devices themselves.
cinder-backup. Provides a means to back up a Block Storage volume to OpenStack Object
Storage (swift).
The Block Storage service contains the following components:
Back-end Storage Devices. The Block Storage service requires some form of back-end storage that the service is built on. The default implementation is to use LVM on a local volume group named "cinder-volumes." In addition to the base driver implementation, the Block Storage service also provides the means to add support for other storage devices to be utilized such as external Raid Arrays or other storage appliances. These back-end storage devices may have custom block sizes when using KVM or QEMU as the hypervisor.
Users and Tenants (Projects). The Block Storage service can be used by many different cloud computing consumers or customers (tenants on a shared system), using role-based access assignments. Roles control the actions that a user is allowed to perform. In the default configuration, most actions do not require a particular role, but this can be configured by the
30
CHAPTER 2. BLOCK STORAGE
system administrator in the appropriate policy.json file that maintains the rules. A user's access to particular volumes is limited by tenant, but the user name and password are assigned per user. Key pairs granting access to a volume are enabled per user, but quotas to control resource consumption across available hardware resources are per tenant.
For tenants, quota controls are available to limit:
The number of volumes that can be created.
The number of snapshots that can be created.
The total number of GBs allowed per tenant (shared between snapshots and volumes).
You can revise the default quota values with the Block Storage CLI, so the limits placed by quotas are editable by admin users.
Volumes, Snapshots, and Backups. The basic resources offered by the Block Storage service are volumes and snapshots which are derived from volumes and volume backups:
Volumes. Allocated block storage resources that can be attached to instances as secondary storage or they can be used as the root store to boot instances. Volumes are persistent R/W block storage devices most commonly attached to the compute node through iSCSI.
Snapshots. A read-only point in time copy of a volume. The snapshot can be created from a volume that is currently in use (through the use of --force True) or in an available state.
The snapshot can then be used to create a new volume through create from snapshot.
Backups. An archived copy of a volume currently stored in OpenStack Object Storage
(swift).
2.2. VOLUME DRIVERS
To use different volume drivers for the cinder-volume service, use the parameters described in these sections.
To set a volume driver, use the volume_driver flag. The default is: volume_driver = cinder.volume.drivers.lvm.LVMISCSIDriver
2.2.1. Ceph RADOS Block Device (RBD)
If you use KVM or QEMU as your hypervisor, you can configure the Compute service to use Ceph
RADOS block devices (RBD) for volumes.
Ceph is a massively scalable, open source, distributed storage system. It is comprised of an object store, block store, and a POSIX-compliant distributed file system. The platform can auto-scale to the exabyte level and beyond. It runs on commodity hardware, is self-healing and self-managing, and
31
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
has no single point of failure. Ceph is in the Linux kernel and is integrated with the OpenStack cloud operating system. Due to its open-source nature, you can install and use this portable storage platform in public or private clouds.
Figure 2.1. Ceph architecture
32
RADOS
Ceph is based on RADOS: Reliable Autonomic Distributed Object Store. RADOS distributes objects across the storage cluster and replicates objects for fault tolerance. RADOS contains the following major components:
Object Storage Device (OSD) Daemon. The storage daemon for the RADOS service, which interacts with the OSD (physical or logical storage unit for your data).
You must run this daemon on each server in your cluster. For each OSD, you can have an associated hard drive disk. For performance purposes, pool your hard drive disk with raid arrays, logical volume management (LVM), or B-tree file system (Btrfs) pooling. By default, the following pools are created: data, metadata, and RBD.
Meta-Data Server (MDS). Stores metadata. MDSs build a POSIX file system on top of objects for
Ceph clients. However, if you do not use the Ceph file system, you do not need a metadata server.
Monitor (MON). A lightweight daemon that handles all communications with external applications and clients. It also provides a consensus for distributed decision making in a Ceph/RADOS cluster. For instance, when you mount a Ceph shared on a client, you point to the address of a
MON server. It checks the state and the consistency of the data. In an ideal setup, you must run at least three ceph-mon daemons on separate servers.
Ceph developers recommend that you use Btrfs as a file system for storage. XFS might be a better alternative for production environments;XFS is an excellent alternative to Btrfs. The ext4 file system is also compatible but does not exploit the power of Ceph.
CHAPTER 2. BLOCK STORAGE
Note
If using Btrfs, ensure that you use the correct version (see Ceph Dependencies ).
For more information about usable file systems, see ceph.com/ceph-storage/file-system/ .
Ways to store, use, and expose data
To store and access your data, you can use the following storage systems:
RADOS. Use as an object, default storage mechanism.
RBD. Use as a block device. The Linux kernel RBD (RADOS block device) driver allows striping a Linux block device over multiple distributed object store data objects. It is compatible with the
KVM RBD image.
CephFS. Use as a file, POSIX-compliant file system.
Ceph exposes RADOS; you can access it through the following interfaces:
RADOS Gateway. OpenStack Object Storage and Amazon-S3 compatible RESTful interface
(see RADOS_Gateway ).
librados, and its related C/C++ bindings.
RBD and QEMU-RBD. Linux kernel and QEMU block devices that stripe data across multiple objects.
Driver options
The following table contains the configuration options supported by the Ceph RADOS Block Device driver.
Deprecation notice
The volume_tmp_dir option has been deprecated and replaced by
image_conversion_dir.
Table 2.1. Description of Ceph storage configuration options
Configuration option = Default value
[DEFAULT]
Description
33
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rados_connect_timeout
= -1
rbd_ceph_conf
=
rbd_flatten_volume_from_snapshot
=
False
rbd_max_clone_depth
= 5
rbd_pool
= rbd
rbd_secret_uuid rbd_store_chunk_size rbd_user
= None
volume_tmp_dir
= None
= None
= 4
Description
(IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used.
(StrOpt) Path to the ceph configuration file
(BoolOpt) Flatten volumes created from snapshots to remove dependency from volume to snapshot
(IntOpt) Maximum number of nested volume clones that are taken before a flatten occurs. Set to
0 to disable cloning.
(StrOpt) The RADOS pool where rbd volumes are stored
(StrOpt) The libvirt uuid of the secret for the rbd_user volumes
(IntOpt) Volumes will be chunked into objects of this size (in megabytes).
(StrOpt) The RADOS client name for accessing rbd volumes - only set when using cephx authentication
(StrOpt) Directory where temporary image files are stored when the volume driver does not write them directly to the volume. Warning: this option is now deprecated, please use image_conversion_dir instead.
2.2.2. Dell EqualLogic volume driver
The Dell EqualLogic volume driver interacts with configured EqualLogic arrays and supports various operations.
Supported operations
Create, delete, attach, and detach volumes.
Create, list, and delete volume snapshots.
Clone a volume.
34
The OpenStack Block Storage service supports:
Multiple instances of Dell EqualLogic Groups or Dell EqualLogic Group Storage Pools and
CHAPTER 2. BLOCK STORAGE
Multiple instances of Dell EqualLogic Groups or Dell EqualLogic Group Storage Pools and multiple pools on a single array.
Multiple instances of Dell EqualLogic Groups or Dell EqualLogic Group Storage Pools or multiple pools on a single array.
The Dell EqualLogic volume driver's ability to access the EqualLogic Group is dependent upon the generic block storage driver's SSH settings in the /etc/cinder/cinder.conf file (see
Section 2.4, “Block Storage sample configuration files”
for reference).
Table 2.2. Description of Dell EqualLogic volume driver configuration options
Configuration option = Default value
[DEFAULT] eqlx_chap_login
= admin
Description eqlx_chap_password eqlx_cli_max_retries eqlx_cli_timeout eqlx_group_name eqlx_pool
= default
eqlx_use_chap
= password
= 30
= group-0
= False
= 5
(StrOpt) Existing CHAP account name. Note that this option is deprecated in favour of
"chap_username" as specified in cinder/volume/driver.py and will be removed in next release.
(StrOpt) Password for specified CHAP account name. Note that this option is deprecated in favour of "chap_password" as specified in cinder/volume/driver.py and will be removed in the next release
(IntOpt) Maximum retry count for reconnection.
Default is 5.
(IntOpt) Timeout for the Group Manager cli command execution. Default is 30.
(StrOpt) Group name to use for creating volumes.
Defaults to "group-0".
(StrOpt) Pool in which volumes will be created.
Defaults to "default".
(BoolOpt) Use CHAP authentication for targets.
Note that this option is deprecated in favour of
"use_chap_auth" as specified in cinder/volume/driver.py and will be removed in next release.
The following sample /etc/cinder/cinder.conf configuration lists the relevant settings for a typical Block Storage service using a single Dell EqualLogic Group:
Example 2.1. Default (single-instance) configuration
35
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
[DEFAULT]
#Required settings volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
san_ip = IP_EQLX san_login = SAN_UNAME san_password = SAN_PW eqlx_group_name = EQLX_GROUP eqlx_pool = EQLX_POOL
#Optional settings san_thin_provision = true|false eqlx_use_chap = true|false eqlx_chap_login = EQLX_UNAME eqlx_chap_password = EQLX_PW eqlx_cli_timeout = 30 eqlx_cli_max_retries = 5 san_ssh_port = 22 ssh_conn_timeout = 30 san_private_key = SAN_KEY_PATH ssh_min_pool_conn = 1 ssh_max_pool_conn = 5
In this example, replace the following variables accordingly:
IP_EQLX
The IP address used to reach the Dell EqualLogic Group through SSH. This field has no default value.
SAN_UNAME
The user name to login to the Group manager via SSH at the san_ip. Default user name is
grpadmin.
SAN_PW
The corresponding password of SAN_UNAME. Not used when san_private_key is set.
Default password is password.
EQLX_GROUP
36
The group to be used for a pool where the Block Storage service will create volumes and snapshots. Default group is group-0.
EQLX_POOL
The pool where the Block Storage service will create volumes and snapshots. Default pool is default. This option cannot be used for multiple pools utilized by the Block Storage
CHAPTER 2. BLOCK STORAGE
is default. This option cannot be used for multiple pools utilized by the Block Storage service on a single Dell EqualLogic Group.
EQLX_UNAME
The CHAP login account for each volume in a pool, if eqlx_use_chap is set to true.
Default account name is chapadmin.
EQLX_PW
The corresponding password of EQLX_UNAME. The default password is randomly generated in hexadecimal, so you must set this password manually.
SAN_KEY_PATH (optional)
The filename of the private key used for SSH authentication. This provides password-less login to the EqualLogic Group. Not used when san_password is set. There is no default value.
In addition, enable thin provisioning for SAN volumes using the default san_thin_provision =
true setting.
Example 2.2. Multi back-end Dell EqualLogic configuration
The following example shows the typical configuration for a Block Storage service that uses two
Dell EqualLogic back ends: enabled_backends = backend1,backend2 san_ssh_port = 22
ssh_conn_timeout = 30
san_thin_provision = true
[backend1]
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
volume_backend_name = backend1
san_ip = IP_EQLX1
san_login = SAN_UNAME san_password = SAN_PW
eqlx_group_name = EQLX_GROUP
eqlx_pool = EQLX_POOL
[backend2]
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
volume_backend_name = backend2
san_ip = IP_EQLX2 san_login = SAN_UNAME san_password = SAN_PW
eqlx_group_name = EQLX_GROUP
eqlx_pool = EQLX_POOL
In this example:
37
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Thin provisioning for SAN volumes is enabled (san_thin_provision = true). This is recommended when setting up Dell EqualLogic back ends.
Each Dell EqualLogic back-end configuration ([backend1] and [backend2]) has the same required settings as a single back-end configuration, with the addition of
volume_backend_name.
The san_ssh_port option is set to its default value, 22. This option sets the port used for
SSH.
The ssh_conn_timeout option is also set to its default value, 30. This option sets the timeout in seconds for CLI commands over SSH.
The IP_EQLX1 and IP_EQLX2 refer to the IP addresses used to reach the Dell EqualLogic
Group of backend1 and backend2 through SSH, respectively.
2.2.3. Dell Storage Center iSCSI drivers
The Dell Storage Center volume driver interacts with configured Storage Center arrays.
The Dell Storage Center driver manages Storage Center arrays through Enterprise Manager.
Enterprise Manager connection settings and Storage Center options are defined in the
cinder.conf file.
Prerequisite: Dell Enterprise Manager 2015 R1 or later must be used.
Supported operations
The Dell Storage Center volume driver provides the following Cinder volume operations:
Create, delete, attach (map), and detach (unmap) volumes.
Create, list, and delete volume snapshots.
Create a volume from a snapshot.
Copy an image to a volume.
Copy a volume to an image.
Clone a volume.
Extend a volume.
38
CHAPTER 2. BLOCK STORAGE
Extra spec options
Volume type extra specs can be used to select different Storage Profiles.
Storage Profiles control how Storage Center manages volume data. For a given volume, the selected Storage Profile dictates which disk tier accepts initial writes, as well as how data progression moves data between tiers to balance performance and cost. Predefined Storage
Profiles are the most effective way to manage data in Storage Center.
By default, if no Storage Profile is specified in the volume extra specs, the default Storage Profile for the user account configured for the Block Storage driver is used. The extra spec key
storagetype:storageprofile with the value of the name of the Storage Profile on the Storage
Center can be set to allow to use Storage Profiles other than the default.
For ease of use from the command line, spaces in Storage Profile names are ignored. As an example, here is how to define two volume types using the High Priority and Low Priority
Storage Profiles:
$ cinder type-create "GoldVolumeType"
$ cinder type-key "GoldVolumeType" set storagetype:storageprofile=highpriority
$ cinder type-create "BronzeVolumeType"
$ cinder type-key "BronzeVolumeType" set storagetype:storageprofile=lowpriority
Driver options
The following table contains the configuration options specific to the Dell Storage Center volume driver.
Table 2.3. Description of Dell Storage Center volume driver configuration options
Description Configuration option = Default value
[DEFAULT] dell_sc_api_port
= 3033
dell_sc_server_folder
= openstack
dell_sc_ssn
= 64702
dell_sc_volume_folder
= openstack
(IntOpt) Dell API port
(StrOpt) Name of the server folder to use on the
Storage Center
(IntOpt) Storage Center System Serial Number
(StrOpt) Name of the volume folder to use on the
Storage Center
iSCSI configuration
39
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The following snippet displays the required and optional settings for a single iSCSI back end:
Example 2.3. Sample iSCSI Configuration
default_volume_type = delliscsitype enabled_backends = delliscsi
[delliscsi]
# Required settings volume_driver = cinder.volume.drivers.dell.dell_storagecenter_iscsi.DellStorageCenterIS
CSIDriver san_ip = IP_SC san_login = SAN_UNAME san_password = SAN_PW iscsi_ip_address = ISCSI_IP dell_sc_ssn = SERIAL
# Optional settings dell_sc_api_port = API_PORT dell_sc_server_folder = SERVFOLDER dell_sc_volume_folder = VOLFOLDER
# The iSCSI IP port iscsi_port = ISCSI_PORT
40
Where:
IP_SC
The IP address used to reach the Dell Enterprise Manager. This field has no default value.
SAN_UNAME
The user name to login to the Dell Enterprise Manager at the IP_EQLX. Default user name is Admin.
SAN_PW
The corresponding password of SAN_UNAME. Default password is password.
ISCSI_IP
SERIAL
The IP address that the iSCSI daemon is listening on. In this case, ISCSI_IP is the IP address of the Dell Storage Center iSCSI.
The Dell Storage Center serial number to use. Default is 64702.
CHAPTER 2. BLOCK STORAGE
API_PORT
The Dell Enterprise Manager API port. Default is 3033
SERVFOLDER
The Server folder in Dell Storage Center where the new server definitions are placed.
VOLFOLDER
The Server folder in Dell Storage Center where the new volumes are created.
ISCSI_PORT
The corresponding port of the Dell Storage Center array. This parameter is optional, and defaults to 3036
Each back end's name is defined in its section header (in this case, delliscsi). To enable a back end, add its name to the enabled_backends setting. In the case of multiple back ends, enable them by adding their respective names to enabled_backends as a comma-delimited list.
2.2.4. EMC VMAX iSCSI and FC drivers
The EMC VMAX drivers, EMCVMAXISCSIDriver and EMCVMAXFCDriver, support the use of EMC
VMAX storage arrays under OpenStack Block Storage. They both provide equivalent functions and differ only in support for their respective host attachment methods.
The drivers perform volume operations by communicating with the backend VMAX storage. It uses a
CIM client in Python called PyWBEM to perform CIM operations over HTTP.
The EMC CIM Object Manager (ECOM) is packaged with the EMC SMI-S provider. It is a CIM server that enables CIM clients to perform CIM operations over HTTP by using SMI-S in the backend for VMAX storage operations.
The EMC SMI-S Provider supports the SNIA Storage Management Initiative (SMI), an ANSI standard for storage management. It supports the VMAX storage system.
2.2.4.1. System requirements
EMC SMI-S Provider V4.6.2.8 and higher is required. You can download SMI-S from the EMC's support web site (login is required). See the EMC SMI-S Provider release notes for installation instructions.
EMC storage VMAX Family is supported.
2.2.4.2. Supported operations
41
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
VMAX drivers support these operations:
Create, delete, attach, and detach volumes.
Create, list, and delete volume snapshots.
Copy an image to a volume.
Copy a volume to an image.
Clone a volume.
Extend a volume.
Retype a volume.
Create a volume from a snapshot.
VMAX drivers also support the following features:
FAST automated storage tiering policy.
Dynamic masking view creation.
Striped volume creation.
2.2.4.3. Set up the VMAX drivers
Procedure 2.1. To set up the EMC VMAX drivers
2. Download SMI-S from PowerLink and install it. Add your VMAX arrays to SMI-S.
For information, see
Section 2.2.4.3.2, “Set up SMI-S” and the SMI-S release notes.
3. Change configuration files. See
Section 2.2.4.3.3, “cinder.conf configuration file” and
Section 2.2.4.3.4, “cinder_emc_config_CONF_GROUP_ISCSI.xml configuration file” .
4. Configure connectivity. For FC driver, see
Section 2.2.4.3.5, “FC Zoning with VMAX”
. For
iSCSI driver, see Section 2.2.4.3.6, “iSCSI with VMAX”
.
2.2.4.3.1. Install the python-pywbem package
42
CHAPTER 2. BLOCK STORAGE
# yum install pywbem
2.2.4.3.2. Set up SMI-S
You can install SMI-S on a non-OpenStack host. Supported platforms include different flavors of
Windows, Red Hat, and SUSE Linux. SMI-S can be installed on a physical server or a VM hosted by an ESX server. Note that the supported hypervisor for a VM running SMI-S is ESX only. See the
EMC SMI-S Provider release notes for more information on supported platforms and installation instructions.
Note
You must discover storage arrays on the SMI-S server before you can use the VMAX drivers. Follow instructions in the SMI-S release notes.
SMI-S is usually installed at /opt/emc/ECIM/ECOM/bin on Linux and C:\Program
Files\EMC\ECIM\ECOM\bin on Windows. After you install and configure SMI-S, go to that directory and type TestSmiProvider.exe.
Use addsys in TestSmiProvider.exe to add an array. Use dv and examine the output after the array is added. Make sure that the arrays are recognized by the SMI-S server before using the EMC
VMAX drivers.
2.2.4.3.3. cinder.conf configuration file
Make the following changes in /etc/cinder/cinder.conf.
Add the following entries, where 10.10.61.45 is the IP address of the VMAX iSCSI target: enabled_backends = CONF_GROUP_ISCSI, CONF_GROUP_FC
[CONF_GROUP_ISCSI] iscsi_ip_address = 10.10.61.45
volume_driver = cinder.volume.drivers.emc.emc_vmax_iscsi.EMCVMAXISCSIDriver
cinder_emc_config_file =
/etc/cinder/cinder_emc_config_CONF_GROUP_ISCSI.xml
volume_backend_name=ISCSI_backend
[CONF_GROUP_FC] volume_driver = cinder.volume.drivers.emc.emc_vmax_fc.EMCVMAXFCDriver
cinder_emc_config_file = /etc/cinder/cinder_emc_config_CONF_GROUP_FC.xml
volume_backend_name=FC_backend
In this example, two backend configuration groups are enabled: CONF_GROUP_ISCSI and
CONF_GROUP_FC. Each configuration group has a section describing unique parameters for connections, drivers, the volume_backend_name, and the name of the EMC-specific configuration file containing additional settings. Note that the file name is in the format
/etc/cinder/cinder_emc_config_[confGroup].xml.
43
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Once the cinder.conf and EMC-specific configuration files have been created, cinder commands need to be issued in order to create and associate OpenStack volume types with the declared volume_backend_names:
$ cinder type-create VMAX_ISCSI
$ cinder type-key VMAX_ISCSI set volume_backend_name=ISCSI_backend
$ cinder type-create VMAX_FC
$ cinder type-key VMAX_FC set volume_backend_name=FC_backend
By issuing these commands, the Block Storage volume type VMAX_ISCSI is associated with the
ISCSI_backend, and the type VMAX_FC is associated with the FC_backend.
Restart the cinder-volume service.
2.2.4.3.4. cinder_emc_config_CONF_GROUP_ISCSI.xml configuration file
Create the /etc/cinder/cinder_emc_config_CONF_GROUP_ISCSI.xml file. You do not need to restart the service for this change.
Add the following lines to the XML file:
<?xml version= "1.0" encoding= "UTF-8" ?>
<EMC>
<EcomServerIp> 1.1.1.1
</EcomServerIp>
<EcomServerPort> 00 </EcomServerPort>
<EcomUserName> user1 </EcomUserName>
<EcomPassword> password1 </EcomPassword>
<PortGroups>
<PortGroup> OS-PORTGROUP1-PG </PortGroup>
<PortGroup> OS-PORTGROUP2-PG </PortGroup>
</PortGroups>
<Array> 111111111111 </Array>
<Pool> FC_GOLD1 </Pool>
<FastPolicy> GOLD1 </FastPolicy>
</EMC>
Where:
EcomServerIp and EcomServerPort are the IP address and port number of the ECOM server which is packaged with SMI-S.
EcomUserName and EcomPassword are credentials for the ECOM server.
PortGroups supplies the names of VMAX port groups that have been pre-configured to expose volumes managed by this backend. Each supplied port group should have sufficient number and distribution of ports (across directors and switches) as to ensure adequate bandwidth and failure protection for the volume connections. PortGroups can contain one or more port groups of
44
CHAPTER 2. BLOCK STORAGE
either iSCSI or FC ports. When a dynamic masking view is created by the VMAX driver, the port group is chosen randomly from the PortGroup list, to evenly distribute load across the set of groups provided. Make sure that the PortGroups set contains either all FC or all iSCSI port groups (for a given backend), as appropriate for the configured driver (iSCSI or FC).
The Array tag holds the unique VMAX array serial number.
The Pool tag holds the unique pool name within a given array. For backends not using FAST automated tiering, the pool is a single pool that has been created by the administrator. For backends exposing FAST policy automated tiering, the pool is the bind pool to be used with the
FAST policy.
The FastPolicy tag conveys the name of the FAST Policy to be used. By including this tag, volumes managed by this backend are treated as under FAST control. Omitting the
FastPolicy tag means FAST is not enabled on the provided storage pool.
2.2.4.3.5. FC Zoning with VMAX
Zone Manager is recommended when using the VMAX FC driver, especially for larger configurations where pre-zoning would be too complex and open-zoning would raise security concerns.
2.2.4.3.6. iSCSI with VMAX
Make sure the iscsi-initiator-utils package is installed on the host (use apt-get, zypper, or yum, depending on Linux flavor).
Verify host is able to ping VMAX iSCSI target ports.
2.2.4.4. VMAX masking view and group naming info
Masking view names
Masking views are dynamically created by the VMAX FC and iSCSI drivers using the following naming conventions:
OS-[shortHostName][poolName]-I-MV (for Masking Views using iSCSI)
OS-[shortHostName][poolName]-F-MV (for Masking Views using FC)
Initiator group names
For each host that is attached to VMAX volumes using the drivers, an initiator group is created or reused (per attachment type). All initiators of the appropriate type known for that host are included in the group. At each new attach volume operation, the VMAX driver retrieves the initiators (either
WWNNs or IQNs) from OpenStack and adds or updates the contents of the Initiator Group as required. Names are of the following format:
45
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
OS-[shortHostName]-I-IG (for iSCSI initiators)
OS-[shortHostName]-F-IG (for Fibre Channel initiators)
Note
Hosts attaching to VMAX storage managed by the OpenStack environment cannot also be attached to storage on the same VMAX not being managed by OpenStack. This is due to limitations on VMAX Initiator Group membership.
FA port groups
VMAX array FA ports to be used in a new masking view are chosen from the list provided in the
EMC configuration file.
Storage group names
As volumes are attached to a host, they are either added to an existing storage group (if it exists) or a new storage group is created and the volume is then added. Storage groups contain volumes created from a pool (either single-pool or FAST-controlled), attached to a single host, over a single connection type (iSCSI or FC). Names are formed:
OS-[shortHostName][poolName]-I-SG (attached over iSCSI)
OS-[shortHostName][poolName]-F-SG (attached over Fibre Channel)
2.2.4.5. Concatenated or striped volumes
In order to support later expansion of created volumes, the VMAX Block Storage drivers create concatenated volumes as the default layout. If later expansion is not required, users can opt to create striped volumes in order to optimize I/O performance.
Below is an example of how to create striped volumes. First, create a volume type. Then define the extra spec for the volume type storagetype:stripecount representing the number of meta members in the striped volume. The example below means that each volume created under the
GoldStriped volume type will be striped and made up of 4 meta members.
$ cinder type-create GoldStriped
$ cinder type-key GoldStriped set volume_backend_name=GOLD_BACKEND
$ cinder type-key GoldStriped set storagetype:stripecount=4
2.2.5. EMC VNX direct driver
46
CHAPTER 2. BLOCK STORAGE
EMC VNX direct driver (consists of EMCCLIISCSIDriver and EMCCLIFCDriver) supports both iSCSI and FC protocol. EMCCLIISCSIDriver (VNX iSCSI direct driver) and
EMCCLIFCDriver (VNX FC direct driver) are separately based on the ISCSIDriver and
FCDriver defined in Block Storage.
EMCCLIISCSIDriver and EMCCLIFCDriver perform the volume operations by executing
Navisphere CLI (NaviSecCLI) which is a command line interface used for management, diagnostics and reporting functions for VNX.
2.2.5.1. Supported OpenStack release
EMC VNX direct driver supports the Kilo release.
2.2.5.2. System requirements
VNX Operational Environment for Block version 5.32 or higher.
VNX Snapshot and Thin Provisioning license should be activated for VNX.
Navisphere CLI v7.32 or higher is installed along with the driver.
2.2.5.3. Supported operations
Create, delete, attach, and detach volumes.
Create, list, and delete volume snapshots.
Create a volume from a snapshot.
Copy an image to a volume.
Clone a volume.
Extend a volume.
Migrate a volume.
Retype a volume.
Get volume statistics.
Create and delete consistency groups.
Create, list, and delete consistency group snapshots.
47
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Modify consistency groups.
2.2.5.4. Preparation
This section contains instructions to prepare the Block Storage nodes to use the EMC VNX direct driver. You install the Navisphere CLI, install the driver, ensure you have correct zoning configurations, and register the driver.
2.2.5.4.1. Install NaviSecCLI
Navisphere CLI needs to be installed on all Block Storage nodes within an OpenStack deployment.
For all other variants of Linux, Navisphere CLI is available at Downloads for VNX2 Series or
Downloads for VNX1 Series .
After installation, set the security level of Navisphere CLI to low:
$ /opt/Navisphere/bin/naviseccli security -certificate -setLevel low
2.2.5.4.2. Install Block Storage driver
Both EMCCLIISCSIDriver and EMCCLIFCDriver are provided in the installer package:
emc_vnx_cli.py
emc_cli_fc.py (for EMCCLIFCDriver)
emc_cli_iscsi.py (for EMCCLIISCSIDriver)
Copy the files above to the cinder/volume/drivers/emc/ directory of the OpenStack node(s) where cinder-volume is running.
2.2.5.4.3. FC zoning with VNX (EMCCLIFCDriver only)
A storage administrator must enable FC SAN auto zoning between all OpenStack nodes and VNX if
FC SAN auto zoning is not enabled.
2.2.5.4.4. Register with VNX
Register the compute nodes with VNX to access the storage in VNX or enable initiator auto registration.
To perform "Copy Image to Volume" and "Copy Volume to Image" operations, the nodes running the
cinder-volume service(Block Storage nodes) must be registered with the VNX as well.
48
CHAPTER 2. BLOCK STORAGE
Steps mentioned below are for a compute node. Please follow the same steps for the Block Storage nodes also. The steps can be skipped if initiator auto registration is enabled.
Note
When the driver notices that there is no existing storage group that has the host name as the storage group name, it will create the storage group and then add the compute nodes' or Block Storage nodes' registered initiators into the storage group.
If the driver notices that the storage group already exists, it will assume that the registered initiators have also been put into it and skip the operations above for better performance.
It is recommended that the storage administrator does not create the storage group manually and instead relies on the driver for the preparation. If the storage administrator needs to create the storage group manually for some special requirements, the correct registered initiators should be put into the storage group as well (otherwise the following volume attaching operations will fail).
2.2.5.4.4.1. EMCCLIFCDriver
Steps for EMCCLIFCDriver:
1. Assume 20:00:00:24:FF:48:BA:C2:21:00:00:24:FF:48:BA:C2 is the WWN of a
FC initiator port name of the compute node whose hostname and IP are myhost1 and
10.10.61.1. Register 20:00:00:24:FF:48:BA:C2:21:00:00:24:FF:48:BA:C2 in
Unisphere: a. Login to Unisphere, go to FNM0000000000->Hosts->Initiators.
b. Refresh and wait until the initiator
20:00:00:24:FF:48:BA:C2:21:00:00:24:FF:48:BA:C2 with SP Port A-1 appears.
c. Click the Register button, select CLARiiON/VNX and enter the hostname (which is the output of the linux command hostname) and IP address:
Hostname : myhost1
IP : 10.10.61.1
Click Register d. Then host 10.10.61.1 will appear under Hosts->Host List as well.
2. Register the wwn with more ports if needed.
49
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
2.2.5.4.4.2. EMCCLIISCSIDriver
Steps for EMCCLIISCSIDriver:
1. On the compute node with IP address 10.10.61.1 and hostname myhost1, execute the following commands (assuming 10.10.61.35 is the iSCSI target): a. Start the iSCSI initiator service on the node
# /etc/init.d/open-iscsi start b. Discover the iSCSI target portals on VNX
# iscsiadm -m discovery -t st -p 10.10.61.35
c. Enter /etc/iscsi
# cd /etc/iscsi d. Find out the iqn of the node
# more initiatorname.iscsi
2. Login to VNX from the compute node using the target corresponding to the SPA port:
# iscsiadm -m node -T iqn.1992-04.com.emc:cx.apm01234567890.a0 -p
10.10.61.35 -l
3. Assume iqn.1993-08.org.debian:01:1a2b3c4d5f6g is the initiator name of the compute node. Register iqn.1993-08.org.debian:01:1a2b3c4d5f6g in Unisphere: a. Login to Unisphere, go to FNM0000000000->Hosts->Initiators .
b. Refresh and wait until the initiator iqn.1993-
08.org.debian:01:1a2b3c4d5f6g with SP Port A-8v0 appears.
c. Click the Register button, select CLARiiON/VNX and enter the hostname (which is the output of the linux command hostname) and IP address:
Hostname : myhost1
IP : 10.10.61.1
Click Register
50
CHAPTER 2. BLOCK STORAGE
d. Then host 10.10.61.1 will appear under Hosts->Host List as well.
4. Logout iSCSI on the node:
# iscsiadm -m node -u
5. Login to VNX from the compute node using the target corresponding to the SPB port:
# iscsiadm -m node -T iqn.1992-04.com.emc:cx.apm01234567890.b8 -p
10.10.61.36 -l
6. In Unisphere register the initiator with the SPB port.
7. Logout iSCSI on the node:
# iscsiadm -m node -u
8. Register the iqn with more ports if needed.
2.2.5.5. Backend configuration
Make the following changes in the /etc/cinder/cinder.conf: storage_vnx_pool_name = Pool_01_SAS san_ip = 10.10.72.41
san_secondary_ip = 10.10.72.42
#VNX user name
#san_login = username
#VNX user password
#san_password = password
#VNX user type. Valid values are: global(default), local and ldap.
#storage_vnx_authentication_type = ldap
#Directory path of the VNX security file. Make sure the security file is generated first.
#VNX credentials are not necessary when using security file.
storage_vnx_security_file_dir = /etc/secfile/array1 naviseccli_path = /opt/Navisphere/bin/naviseccli
#timeout in minutes default_timeout = 10
#If deploying EMCCLIISCSIDriver:
#volume_driver = cinder.volume.drivers.emc.emc_cli_iscsi.EMCCLIISCSIDriver
volume_driver = cinder.volume.drivers.emc.emc_cli_fc.EMCCLIFCDriver
destroy_empty_storage_group = False
#"node1hostname" and "node2hostname" shoule be the full hostnames of the nodes(Try command 'hostname').
#This option is for EMCCLIISCSIDriver only.
iscsi_initiators = {"node1hostname":["10.0.0.1",
"10.0.0.2"],"node2hostname":["10.0.0.3"]}
51
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
[database] max_pool_size = 20 max_overflow = 30 where san_ip is one of the SP IP addresses of the VNX array and san_secondary_ip is the other SP IP address of VNX array. san_secondary_ip is an optional field, and it serves the purpose of providing a high availability(HA) design. In case that one SP is down, the other SP can be connected automatically. san_ip is a mandatory field, which provides the main connection.
where Pool_01_SAS is the pool from which the user wants to create volumes. The pools can be created using Unisphere for VNX. Refer to the
Section 2.2.5.18, “Multiple pools support”
on how to manage multiple pools.
where storage_vnx_security_file_dir is the directory path of the VNX security file. Make
sure the security file is generated following the steps in Section 2.2.5.6, “Authentication” .
where iscsi_initiators is a dictionary of IP addresses of the iSCSI initiator ports on all
OpenStack nodes which want to connect to VNX via iSCSI. If this option is configured, the driver will leverage this information to find an accessible iSCSI target portal for the initiator when attaching volume. Otherwise, the iSCSI target portal will be chosen in a relative random way.
Restart cinder-volume service to make the configuration change take effect.
2.2.5.6. Authentication
VNX credentials are necessary when the driver connects to the VNX system. Credentials in global, local and ldap scopes are supported. There are two approaches to provide the credentials.
The recommended one is using the Navisphere CLI security file to provide the credentials which can get rid of providing the plain text credentials in the configuration file. Following is the instruction on how to do this.
1. Find out the linux user id of the /usr/bin/cinder-volume processes. Assuming the service /usr/bin/cinder-volume is running by account cinder.
2. Switch to root account
3. Change cinder:x:113:120::/var/lib/cinder:/bin/false to
cinder:x:113:120::/var/lib/cinder:/bin/bash in /etc/passwd (This temporary change is to make step 4 work).
4. Save the credentials on behalf of cinder user to a security file (assuming the array credentials are admin/admin in global scope). In below command, switch -
secfilepath is used to specify the location to save the security file (assuming saving to directory /etc/secfile/array1).
52
CHAPTER 2. BLOCK STORAGE
# su -l cinder -c '/opt/Navisphere/bin/naviseccli -
AddUserSecurity -user admin -password admin -scope 0 -secfilepath
/etc/secfile/array1'
Save the security file to the different locations for different arrays except where the same credentials are shared between all arrays managed by the host. Otherwise, the credentials in the security file will be overwritten. If -secfilepath is not specified in the command above, the security file will be saved to the default location which is the home directory of the executor.
5. Change cinder:x:113:120::/var/lib/cinder:/bin/bash back to
cinder:x:113:120::/var/lib/cinder:/bin/false in /etc/passwd.
6. Remove the credentials options san_login, san_password and
storage_vnx_authentication_type from cinder.conf (normally it is
/etc/cinder/cinder.conf). Add the option storage_vnx_security_file_dir and set its value to the directory path supplied with switch -secfilepath in step 4. Omit this option if -secfilepath is not used in step 4.
#Directory path that contains the VNX security file. Generate the security file first storage_vnx_security_file_dir = /etc/secfile/array1
7. Restart cinder-volume service to make the change take effect.
Alternatively, the credentials can be specified in /etc/cinder/cinder.conf through the three options below:
#VNX user name san_login = username
#VNX user password san_password = password
#VNX user type. Valid values are: global, local and ldap. global is the default value storage_vnx_authentication_type = ldap
2.2.5.7. Restriction of deployment
It does not suggest to deploy the driver on a compute node if cinder upload-to-image --
force True is used against an in-use volume. Otherwise, cinder upload-to-image --
force True will terminate the vm instance's data access to the volume.
2.2.5.8. Restriction of volume extension
VNX does not support to extend the thick volume which has a snapshot. If the user tries to extend a volume which has a snapshot, the volume's status would change to error_extending.
2.2.5.9. Restriction of iSCSI attachment
53
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The driver caches the iSCSI ports information. If the iSCSI port configurations are changed, the administrator should restart the cinder-volume service or wait 5 minutes before any volume attachment operation. Otherwise, the attachment may fail because the old iSCSI port configurations were used.
2.2.5.10. Provisioning type (thin, thick, deduplicated and compressed)
User can specify extra spec key storagetype:provisioning in volume type to set the provisioning type of a volume. The provisioning type can be thick, thin, deduplicated or
compressed.
thick provisioning type means the volume is fully provisioned.
thin provisioning type means the volume is virtually provisioned.
deduplicated provisioning type means the volume is virtually provisioned and the deduplication is enabled on it. Administrator shall go to VNX to configure the system level deduplication settings. To create a deduplicated volume, the VNX deduplication license should be activated on VNX first, and use key deduplication_support=True to let Block Storage scheduler find a volume back end which manages a VNX with deduplication license activated.
compressed provisioning type means the volume is virtually provisioned and the compression is enabled on it. Administrator shall go to the VNX to configure the system level compression settings. To create a compressed volume, the VNX compression license should be activated on
VNX first, and the user should specify key compression_support=True to let Block Storage scheduler find a volume back end which manages a VNX with compression license activated.
VNX does not support to create a snapshot on a compressed volume. If the user tries to create a snapshot on a compressed volume, the operation would fail and OpenStack would show the new snapshot in error state.
Here is an example about how to create a volume with provisioning type. Firstly create a volume type and specify storage pool in the extra spec, then create a volume with this volume type:
$ cinder type-create "ThickVolume"
$ cinder type-create "ThinVolume"
$ cinder type-create "DeduplicatedVolume"
$ cinder type-create "CompressedVolume"
$ cinder type-key "ThickVolume" set storagetype:provisioning=thick
$ cinder type-key "ThinVolume" set storagetype:provisioning=thin
$ cinder type-key "DeduplicatedVolume" set storagetype:provisioning=deduplicated deduplication_support=True
$ cinder type-key "CompressedVolume" set storagetype:provisioning=compressed compression_support=True
In the example above, four volume types are created: ThickVolume, ThinVolume,
DeduplicatedVolume and CompressedVolume. For ThickVolume,
storagetype:provisioning is set to thick. Similarly for other volume types. If
storagetype:provisioning is not specified or an invalid value, the default value thick is adopted.
54
CHAPTER 2. BLOCK STORAGE
Volume type name, such as ThickVolume, is user-defined and can be any name. Extra spec key
storagetype:provisioning shall be the exact name listed here. Extra spec value for
storagetype:provisioning shall be thick, thin, deduplicated or compressed. During volume creation, if the driver finds storagetype:provisioning in the extra spec of the volume type, it will create the volume with the provisioning type accordingly. Otherwise, the volume will be thick as the default.
2.2.5.11. Fully automated storage tiering support
VNX supports Fully automated storage tiering which requires the FAST license activated on the
VNX. The OpenStack administrator can use the extra spec key storagetype:tiering to set the tiering policy of a volume and use the extra spec key fast_support=True to let Block Storage scheduler find a volume back end which manages a VNX with FAST license activated. Here are the five supported values for the extra spec key storagetype:tiering:
StartHighThenAuto (Default option)
Auto
HighestAvailable
LowestAvailable
NoMovement
Tiering policy can not be set for a deduplicated volume. The user can check storage pool properties on VNX to know the tiering policy of a deduplicated volume.
Here is an example about how to create a volume with tiering policy:
$ cinder type-create "AutoTieringVolume"
$ cinder type-key "AutoTieringVolume" set storagetype:tiering=Auto fast_support=True
$ cinder type-create "ThinVolumeOnLowestAvaibleTier"
$ cinder type-key "CompressedVolumeOnLowestAvaibleTier" set storagetype:provisioning=thin storagetype:tiering=Auto fast_support=True
2.2.5.12. FAST Cache support
VNX has FAST Cache feature which requires the FAST Cache license activated on the VNX. The
OpenStack administrator can use the extra spec key fast_cache_enabled to choose whether to create a volume on the volume back end which manages a pool with FAST Cache enabled. The value of the extra spec key fast_cache_enabled is either True or False. When creating a volume, if the key fast_cache_enabled is set to True in the volume type, the volume will be created by a back end which manages a pool with FAST Cache enabled.
2.2.5.13. Storage group automatic deletion
55
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
For volume attaching, the driver has a storage group on VNX for each compute node hosting the vm instances that are going to consume VNX Block Storage (using the compute node's hostname as the storage group's name). All the volumes attached to the vm instances in a computer node will be put into the corresponding Storage Group. If destroy_empty_storage_group=True, the driver will remove the empty storage group when its last volume is detached. For data safety, it does not suggest to set the option destroy_empty_storage_group=True unless the VNX is exclusively managed by one Block Storage node because consistent lock_path is required for operation synchronization for this behavior.
2.2.5.14. EMC storage-assisted volume migration
EMC VNX direct driver supports storage-assisted volume migration, when the user starts migrating with cinder migrate --force-host-copy False volume_id host or cinder
migrate volume_id host, cinder will try to leverage the VNX's native volume migration functionality.
In the following scenarios, VNX native volume migration will not be triggered:
Volume migration between back ends with different storage protocol, ex, FC and iSCSI.
Volume is being migrated across arrays.
2.2.5.15. Initiator auto registration
If initiator_auto_registration=True, the driver will automatically register iSCSI initiators with all working iSCSI target ports on the VNX array during volume attaching (The driver will skip those initiators that have already been registered).
If the user wants to register the initiators with some specific ports on VNX but not register with the other ports, this functionality should be disabled.
2.2.5.16. Initiator auto deregistration
Enabling storage group automatic deletion is the precondition of this functionality. If
initiator_auto_deregistration=True is set, the driver will deregister all the iSCSI initiators of the host after its storage group is deleted.
2.2.5.17. Read-only volumes
OpenStack supports read-only volumes. The following command can be used to set a volume to read-only.
$ cinder readonly-mode-update volume True
After a volume is marked as read-only, the driver will forward the information when a hypervisor is attaching the volume and the hypervisor will have an implementation-specific way to make sure the volume is not written.
56
CHAPTER 2. BLOCK STORAGE
2.2.5.18. Multiple pools support
The user configures a storage pool for a Block Storage back end (named as pool-based back end), so that the Block Storage back end uses only that storage pool.
If storage_vnx_pool_name is not given in the configuration file, the Block Storage back end uses all the pools on the VNX array, and the scheduler chooses the pool to place the volume based on its capacities and capabilities. This kind of Block Storage back end is named as array-based back end.
Here is an example about configuration of array-based back end: san_ip = 10.10.72.41
#Directory path that contains the VNX security file. Make sure the security file is generated first storage_vnx_security_file_dir = /etc/secfile/array1 storage_vnx_authentication_type = global naviseccli_path = /opt/Navisphere/bin/naviseccli default_timeout = 10 volume_driver = cinder.volume.drivers.emc.emc_cli_iscsi.EMCCLIISCSIDriver
destroy_empty_storage_group = False volume_backend_name = vnx_41
In this configuration, if the user wants to create a volume on a certain storage pool, a volume type with a extra spec specified the storage pool should be created first, then the user can use this volume type to create the volume.
Here is an example about creating the volume type:
$ cinder type-create "HighPerf"
$ cinder type-key "HighPerf" set pool_name=Pool_02_SASFLASH volume_backend_name=vnx_41
2.2.5.19. Volume number threshold
In VNX, there is a limit on the maximum number of pool volumes that can be created in the system.
When the limit is reached, no more pool volumes can be created even if there is enough remaining capacity in the storage pool. In other words, if the scheduler dispatches a volume creation request to a back end that has free capacity but reaches the limit, the back end will fail to create the corresponding volume.
The default value of the option check_max_pool_luns_threshold is False. When
check_max_pool_luns_threshold=True, the pool-based back end will check the limit and will report 0 free capacity to the scheduler if the limit is reached. So the scheduler will be able to skip this kind of pool-based back end that runs out of the pool volume number.
2.2.5.20. FC SAN auto zoning
57
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
EMC direct driver supports FC SAN auto zoning when ZoneManager is configured. Set
zoning_mode to fabric in back-end configuration section to enable this feature. For
ZoneManager configuration, please refer to
Section 2.6, “Fibre Channel Zone Manager” .
2.2.5.21. Multi-backend configuration
[DEFAULT] enabled_backends = backendA, backendB
[backendA] storage_vnx_pool_name = Pool_01_SAS san_ip = 10.10.72.41
#Directory path that contains the VNX security file. Make sure the security file is generated first.
storage_vnx_security_file_dir = /etc/secfile/array1 naviseccli_path = /opt/Navisphere/bin/naviseccli
#Timeout in Minutes default_timeout = 10 volume_driver = cinder.volume.drivers.emc.emc_cli_fc.EMCCLIFCDriver
destroy_empty_storage_group = False initiator_auto_registration = True
[backendB] storage_vnx_pool_name = Pool_02_SAS san_ip = 10.10.26.101
san_login = username san_password = password naviseccli_path = /opt/Navisphere/bin/naviseccli
#Timeout in Minutes default_timeout = 10 volume_driver = cinder.volume.drivers.emc.emc_cli_fc.EMCCLIFCDriver
destroy_empty_storage_group = False initiator_auto_registration = True
[database] max_pool_size = 20 max_overflow = 30
For more details on multi-backend, see OpenStack Cloud Administration Guide .
2.2.5.22. Force delete volumes in storage groups
58
Some available volumes may remain in storage groups on the VNX array due to some OpenStack timeout issues. But the VNX array does not allow the user to delete the volumes which are still in storage groups. The option force_delete_lun_in_storagegroup is introduced to allow the user to delete the available volumes in this tricky situation.
When force_delete_lun_in_storagegroup=True is set in the back-end section, the driver will move the volumes out of storage groups and then delete them if the user tries to delete the volumes that remain in storage groups on the VNX array.
CHAPTER 2. BLOCK STORAGE
The default value of force_delete_lun_in_storagegroup is False.
2.2.6. EMC XtremIO Block Storage driver configuration
The high performance XtremIO All Flash Array (AFA) offers Block Storage services to OpenStack.
Using the driver, OpenStack Block Storage hosts can connect to an XtermIO Storage cluster.
This section explains how to configure and connect an OpenStack block storage host to an XtremIO storage cluster.
2.2.6.1. Support matrix
Xtremapp: Version 3.0 and 4.0
2.2.6.2. Supported operations
Create, delete, clone, attach, and detach volumes
Create and delete volume snapshots
Create a volume from a snapshot
Copy an image to a volume
Copy a volume to an image
Extend a volume
Manage and unmanage a volume
Get volume statistics
2.2.6.3. XtremIO Block Storage driver configuration
Edit the cinder.conf file by adding the configuration below under the [DEFAULT] section of the file in case of a single back end or under a separate section in case of multiple back ends (for example [XTREMIO]). The configuration file is usually located under the following path
/etc/cinder/cinder.conf.
For a configuration example, refer to the configuration example
.
2.2.6.3.1. XtremIO driver name
59
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configure the driver name by adding the following parameter:
For iSCSI volume_driver =
cinder.volume.drivers.emc.xtremio.XtremIOIscsiDriver
For Fibre Channel volume_driver =
cinder.volume.drivers.emc.xtremio.XtremIOFibreChannelDriver
2.2.6.3.2. XtremIO management server (XMS) IP
To retrieve the management IP, use the show-xms CLI command.
Configure the management IP by adding the following parameter: san_ip = XMS Management
IP
2.2.6.3.3. XtremIO cluster name
In XtremIO version 4.0, a single XMS can manage multiple cluster back ends. In such setups, the administrator is required to specify the cluster name (in addition to the XMS IP). Each cluster must be defined as a separate back end.
To retrieve the Cluster Name, run the show-clusters CLI command.
Configure the cluster name by adding the xtremio_cluster_name = Cluster-Name
Note
When a single cluster is managed in XtremIO version 4.0, the cluster name is not required.
2.2.6.3.4. XtremIO user credentials
OpenStack Block Storage requires an XtremIO XMS user with administrative privileges. XtremIO recommends creating a dedicated OpenStack user account that holds an administrative user role.
Refer to the XtremIO User Guide for details on user account management
Create an XMS account using either the XMS GUI or the add-user-accountCLI command.
Configure the user credentials by adding the following parameters:
san_login = XMS username san_password = XMS username password
60
CHAPTER 2. BLOCK STORAGE
2.2.6.4. Multiple back ends
Configuring multiple storage back ends enables you to create several back-end storage solutions that serve the same OpenStack Compute resources.
When a volume is created, the scheduler selects the appropriate back end to handle the request, according to the specified volume type.
2.2.6.5. Setting thin provisioning and multipathing parameters
To support thin provisioning and multipathing in the XtremIO Array, the following parameters from the Nova and Cinder configuration files should be modified as follows:
Thin Provisioning
All XtremIO volumes are thin provisioned. The default value of 20 should be maintained for the
max_over_subscription_ratio parameter.
The use_cow_images parameter in thenova.conffile should be set to False as follows:
use_cow_images = false
Multipathing
The use_multipath_for_image_xfer parameter in thecinder.conf file should be set to
True as follows:
use_multipath_for_image_xfer = true
2.2.6.6. Restarting OpenStack Block Storage
Save thecinder.conffile and restart cinder by running the following command:
$ openstack-service restart cinder-volume
2.2.6.7. Configuring CHAP
The XtremIO Block Storage driver supports CHAP initiator authentication. If CHAP initiator authentication is required, set the CHAP Authentication mode to initiator.
To set the CHAP initiator mode using CLI, run the following CLI command:
$ modify-chap chap-authentication-mode=initiator
The CHAP initiator mode can also be set via the XMS GUI
61
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Refer to XtremIO User Guide for details on CHAP configuration via GUI and CLI.
The CHAP initiator authentication credentials (username and password) are generated automatically by the Block Storage driver. Therefore, there is no need to configure the initial CHAP credentials manually in XMS.
2.2.6.8. Configuration example cinder.conf example file
You can update the cinder.conf file by editing the necessary parameters as follows:
[Default] enabled_backends = XtremIO
[XtremIO] volume_driver = cinder.volume.drivers.emc.xtremio.XtremIOFibreChannelDriver
san_ip = XMS_IP xtremio_cluster_name = Cluster01 san_login = XMS_USER san_password = XMS_PASSWD volume_backend_name = XtremIOAFA
2.2.7. GlusterFS driver
GlusterFS is an open-source scalable distributed file system that is able to grow to petabytes and beyond in size. More information can be found on Gluster's homepage .
This driver enables the use of GlusterFS in a similar fashion as NFS. It supports basic volume operations, including snapshot/clone.
Note
You must use a Linux kernel of version 3.4 or greater (or version 2.6.32 or greater in Red
Hat Enterprise Linux/CentOS 6.3+) when working with Gluster-based volumes. See Bug
1177103 for more information.
To use Block Storage with GlusterFS, first set the volume_driver in cinder.conf: volume_driver=cinder.volume.drivers.glusterfs.GlusterfsDriver
The following table contains the configuration options supported by the GlusterFS driver.
Table 2.4. Description of GlusterFS storage configuration options
62
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value
[DEFAULT] glusterfs_mount_point_base
=
$state_path/mnt
glusterfs_qcow2_volumes
= False
glusterfs_shares_config
=
/etc/cinder/glusterfs_shares
glusterfs_sparsed_volumes
= True
Description
(StrOpt) Base dir containing mount points for gluster shares.
(BoolOpt) Create volumes as QCOW2 files rather than raw files.
(StrOpt) File with the list of available gluster shares
(BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.
2.2.8. HDS HNAS iSCSI and NFS driver
This OpenStack Block Storage volume driver provides iSCSI and NFS support for Hitachi NAS
Platform Models 3080, 3090, 4040, 4060, 4080 and 4100.
2.2.8.1. Supported operations
The NFS and iSCSI drivers support these operations:
Create, delete, attach, and detach volumes.
Create, list, and delete volume snapshots.
Create a volume from a snapshot.
Copy an image to a volume.
Copy a volume to an image.
Clone a volume.
Extend a volume.
Get volume statistics.
2.2.8.2. HNAS storage requirements
Before using iSCSI and NFS services, use the HNAS configuration and management GUI (SMU) or
63
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
SSC CLI to create storage pool(s), file system(s), and assign an EVS. Make sure that the file system used is not created as replication targets. Additionally:
For NFS:
Create NFS exports, choose a path for them (it must be different from "/") and set the Show
snapshots option to hide and disable access.
Also, configure the option norootsquash as "* (rw, norootsquash)", so cinder services can change the permissions of its volumes.
In order to use the hardware accelerated features of NFS HNAS, we recommend setting
max-nfs-version to 3. Refer to HNAS command line reference to see how to configure this option.
For iSCSI:
You need to set an iSCSI domain.
2.2.8.3. Block storage host requirements
The HNAS driver is supported for Red Hat. The following packages must be installed:
1. nfs-utils for Red Hat
2. If you are not using SSH, you need the HDS SSC package (hds-ssc-v1.0-1) to communicate with an HNAS array using the SSC command. This utility package is available in the RPM package distributed with the hardware through physical media or it can be manually copied from the SMU to the Block Storage host.
2.2.8.4. Package installation
If you are installing the driver from a RPM or DEB package, follow the steps bellow:
1. Install SSC:
In Red Hat:
# rpm -i hds-ssc-v1.0-1.rpm
2. Install the dependencies:
In Red Hat:
# yum install nfs-utils nfs-utils-lib
64
CHAPTER 2. BLOCK STORAGE
3. Configure the driver as described in the "Driver Configuration" section.
4. Restart all cinder services (volume, scheduler and backup).
2.2.8.5. Driver configuration
The HDS driver supports the concept of differentiated services (also referred as quality of service) by mapping volume types to services provided through HNAS.
HNAS supports a variety of storage options and file system capabilities, which are selected through the definition of volume types and the use of multiple back ends. The driver maps up to four volume types into separated exports or file systems, and can support any number if using multiple back ends.
The configuration for the driver is read from an XML-formatted file (one per back end), which you need to create and set its path in the cinder.conf configuration file. Below are the configuration
needed in the cinder.conf configuration file
:
[DEFAULT] enabled_backends = hnas_iscsi1, hnas_nfs1
For HNAS iSCSI driver create this section:
[hnas_iscsi1] volume_driver = cinder.volume.drivers.hds.iscsi.HDSISCSIDriver
hds_hnas_iscsi_config_file = /path/to/config/hnas_config_file.xml volume_backend_name = HNAS-ISCSI
For HNAS NFS driver create this section:
[hnas_nfs1] volume_driver = cinder.volume.drivers.hds.nfs.HDSNFSDriver
hds_hnas_nfs_config_file = /path/to/config/hnas_config_file.xml volume_backend_name = HNAS-NFS
The XML file has the following format:
<?xml version = "1.0" encoding = "UTF-8" ?>
<config>
<mgmt_ip0> 172.24.44.15
</mgmt_ip0>
<hnas_cmd> ssc </hnas_cmd>
<chap_enabled> False </chap_enabled>
<ssh_enabled> False </ssh_enabled>
<cluster_admin_ip0> 10.1.1.1
</cluster_admin_ip0>
<username> supervisor </username>
<password> supervisor </password>
<svc_0>
<volume_type> default </volume_type>
<iscsi_ip> 172.24.44.20
</iscsi_ip>
<hdp> fs01-husvm </hdp>
65
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
</svc_0>
<svc_1>
<volume_type> platinun </volume_type>
<iscsi_ip> 172.24.44.20
</iscsi_ip>
<hdp> fs01-platinun </hdp>
</svc_1>
</config>
2.2.8.6. HNAS volume driver XML configuration options
An OpenStack Block Storage node using HNAS drivers can have up to four services. Each service is defined by a svc_n tag (svc_0, svc_1, svc_2, or svc_3
configuration options available for each service label:
Table 2.5. Configuration options for service labels
Option Type Default Description
volume_type iscsi_ip
Requir ed
default
When a
create_volume
call with a certain volume type happens, the volume type will try to be matched up with this tag. In each configuration file you must define the
default
volume type in the service labels and, if no volume type is specified, the
default
is used. Other labels are case sensitive and should match exactly. If no configured volume types match the incoming requested type, an error occurs in the volume creation.
Requir ed only for iSCSI
An iSCSI IP address dedicated to the service.
hdp
Requir ed
For iSCSI driver: virtual file system label associated with the service.
For NFS driver: path to the volume
(<ip_address>:/<path>) associated with the service.
Additionally, this entry must be added in the file used to list available NFS shares. This file is located, by default, in
/etc/cinder/nfs_shares
or you can specify the location in the
nfs_shares_config
option in the
cinder.conf
configuration file.
66
These are the configuration options available to the config section of the XML config file:
CHAPTER 2. BLOCK STORAGE
Table 2.6. Configuration options
Option Type Default Description
mgmt_ip0
Requir ed
Management Port 0 IP address. Should be the IP address of the "Admin" EVS.
hnas_cmd chap_enabled username password
Option al ssc
Option al
(iSCSI only)
True
Command to communicate to HNAS array.
Boolean tag used to enable CHAP authentication protocol.
Requir ed supervisor It's always required on HNAS.
Requir ed supervisor Password is always required on HNAS.
svc_0, svc_1, svc_2, svc_3
Option al
(at least one label has to be defined)
Service labels: these four predefined names help four different sets of configuration options. Each can specify HDP and a unique volume type.
The address of HNAS cluster admin.
cluster_admin_i p0
Option al if
ssh_e nable d
is
True ssh_enabled
Option al
False ssh_private_key
Requir ed if
ssh_e nable d
is
True
False
Enables SSH authentication between Block
Storage host and the SMU.
Path to the SSH private key used to authenticate in
HNAS SMU. The public key must be uploaded to
HNAS SMU using
ssh-register-publickey
(this is an SSH subcommand). Note that copying the public key HNAS using wipe out those keys.
ssh-copyid
doesn't work properly as the SMU periodically
2.2.8.7. Service labels
67
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
HNAS driver supports differentiated types of service using the service labels. It is possible to create up to four types of them, as gold, platinun, silver and ssd, for example.
After creating the services in the XML configuration file, you must configure one volume_type per service. Each volume_type must have the metadata service_label with the same name configured in the <volume_type> section of that service. If this is not set, OpenStack Block
Storage will schedule the volume creation to the pool with largest available free space or other criteria configured in volume filters.
$ cinder type-create 'default'
$ cinder type-key 'default' set service_label = 'default'
$ cinder type-create 'platinun-tier'
$ cinder type-key 'platinun' set service_label = 'platinun'
2.2.8.8. Multi-back-end configuration
If you use multiple back ends and intend to enable the creation of a volume in a specific back end, you must configure volume types to set the volume_backend_name option to the appropriate back end. Then, create volume_type configurations with the same volume_backend_name .
$ cinder type-create 'iscsi'
$ cinder type-key 'iscsi' set volume_backend_name = 'HNAS-ISCSI'
$ cinder type-create 'nfs'
$ cinder type-key 'nfs' set volume_backend_name = 'HNAS-NFS'
You can deploy multiple OpenStack HNAS drivers instances that each control a separate HNAS array. Each service (svc_0, svc_1, svc_2, svc_3) on the instances need to have a volume_type and service_label metadata associated with it. If no metadata is associated with a pool, OpenStack Block Storage filtering algorithm selects the pool with the largest available free space.
2.2.8.9. SSH configuration
Instead of using SSC on the Block Storage host and store its credential on the XML configuration file,
HNAS driver supports SSH authentication. To configure that:
1. If you don't have a pair of public keys already generated, create it in the Block Storage host
(leave the pass-phrase empty):
$ mkdir -p /opt/hds/ssh
$ ssh-keygen -f /opt/hds/ssh/hnaskey
2. Change the owner of the key to cinder (or the user the volume service will be run):
# chown -R cinder.cinder /opt/hds/ssh
3. Create the directory "ssh_keys" in the SMU server:
68
CHAPTER 2. BLOCK STORAGE
$ ssh [manager|supervisor]@<smu-ip> 'mkdir -p /var/opt/mercurymain/home/[manager|supervisor]/ssh_keys/'
4. Copy the public key to the "ssh_keys" directory:
$ scp /opt/hds/ssh/hnaskey.pub [manager|supervisor]@<smuip>:/var/opt/mercury-main/home/[manager|supervisor]/ssh_keys/
5. Access the SMU server:
$ ssh [manager|supervisor]@<smu-ip>
6. Run the command to register the SSH keys:
$ ssh-register-public-key -u [manager|supervisor] -f ssh_keys/hnaskey.pub
7. Check the communication with HNAS in the Block Storage host:
$ ssh -i /opt/hds/ssh/hnaskey [manager|supervisor]@<smu-ip> 'ssc
<cluster_admin_ip0> df -a'
<cluster_admin_ip0> is "localhost" for single node deployments. This should return a list of available file systems on HNAS.
2.2.8.10. Editing the XML config file:
1. Set the "username".
2. Enable SSH adding the line "<ssh_enabled> True</ssh_enabled>" under "
<config>" session.
3. Set the private key path: "<ssh_private_key>
/opt/hds/ssh/hnaskey</ssh_private_key>" under "<config>" session.
4. If the HNAS is in a multi-cluster configuration set "<cluster_admin_ip0>" to the cluster node admin IP. In a single node HNAS, leave it empty.
5. Restart the cinder service.
2.2.8.11. Additional notes
The get_volume_stats() function always provides the available capacity based on the combined sum of all the HDPs that are used in these services labels.
After changing the configuration on the storage, the OpenStack Block Storage driver must be
69
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
After changing the configuration on the storage, the OpenStack Block Storage driver must be restarted.
HNAS iSCSI driver, due to an HNAS limitation, allows only 32 volumes per target.
On Red Hat, if the system is configured to use SELinux, you need to set "virt_use_nfs =
on" for NFS driver work properly.
2.2.9. HDS HUS iSCSI driver
This Block Storage volume driver provides iSCSI support for HUS (Hitachi Unified Storage) arrays such as, HUS-110, HUS-130, and HUS-150.
2.2.9.1. System requirements
Use the HDS hus-cmd command to communicate with an HUS array. You can download this utility package from the HDS support site ( https://hdssupport.hds.com/ ).
Platform: Ubuntu 12.04 LTS or newer.
2.2.9.2. Supported operations
Create, delete, attach, and detach volumes.
Create, list, and delete volume snapshots.
Create a volume from a snapshot.
Copy an image to a volume.
Copy a volume to an image.
Clone a volume.
Extend a volume.
Get volume statistics.
2.2.9.3. Configuration
The HDS driver supports the concept of differentiated services, where a volume type can be associated with the fine-tuned performance characteristics of an HDP— the dynamic pool where volumes are created
. For instance, an HDP can consist of fast SSDs to provide speed. HDP can provide a certain reliability based on things like its RAID level characteristics. HDS driver maps volume type to the volume_type option in its configuration file.
70
CHAPTER 2. BLOCK STORAGE
Configuration is read from an XML-format file. Examples are shown for single and multi back-end cases.
Note
Configuration is read from an XML file. This example shows the configuration for single back-end and for multi-back-end cases.
It is not recommended to manage an HUS array simultaneously from multiple
OpenStack Block Storage instances or servers.
Table 2.7. Description of HDS HUS iSCSI driver configuration options
Description Configuration option = Default value
[DEFAULT] hds_cinder_config_file
=
/opt/hds/hus/cinder_hus_conf.xml
(StrOpt) The configuration file for the Cinder HDS driver for HUS
HUS setup
Before using iSCSI services, use the HUS UI to create an iSCSI domain for each EVS providing iSCSI services.
Single back-end
In a single back-end deployment, only one OpenStack Block Storage instance runs on the
OpenStack Block Storage server and controls one HUS array: this deployment requires these configuration files:
1. Set the hds_cinder_config_file option in the /etc/cinder/cinder.conf file to use the HDS volume driver. This option points to a configuration file.
volume_driver = cinder.volume.drivers.hds.hds.HUSDriver
hds_cinder_config_file = /opt/hds/hus/cinder_hds_conf.xml
2. Configure hds_cinder_config_file at the location specified previously. For example,
/opt/hds/hus/cinder_hds_conf.xml:
<?xml version= "1.0" encoding= "UTF-8" ?>
<config>
<mgmt_ip0> 172.17.44.16
</mgmt_ip0>
<mgmt_ip1> 172.17.44.17
</mgmt_ip1>
<hus_cmd> hus-cmd </hus_cmd>
<username> system </username>
71
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
<password> manager </password>
<svc_0>
<volume_type> default </volume_type>
<iscsi_ip> 172.17.39.132
</iscsi_ip>
<hdp> 9 </hdp>
</svc_0>
<snapshot>
<hdp> 13 </hdp>
</snapshot>
<lun_start>
3000
</lun_start>
<lun_end>
4000
</lun_end>
</config>
Multi back-end
In a multi back-end deployment, more than one OpenStack Block Storage instance runs on the same server. In this example, two HUS arrays are used, possibly providing different storage performance:
1. Configure /etc/cinder/cinder.conf: the hus1 hus2 configuration blocks are created.
Set the hds_cinder_config_file option to point to a unique configuration file for each block. Set the volume_driver option for each back-end to
cinder.volume.drivers.hds.hds.HUSDriver
enabled_backends=hus1,hus2
[hus1] volume_driver = cinder.volume.drivers.hds.hds.HUSDriver
hds_cinder_config_file = /opt/hds/hus/cinder_hus1_conf.xml
volume_backend_name=hus-1
[hus2] volume_driver = cinder.volume.drivers.hds.hds.HUSDriver
hds_cinder_config_file = /opt/hds/hus/cinder_hus2_conf.xml
volume_backend_name=hus-2
2. Configure /opt/hds/hus/cinder_hus1_conf.xml:
<?xml version= "1.0" encoding= "UTF-8" ?>
<config>
<mgmt_ip0> 172.17.44.16
</mgmt_ip0>
<mgmt_ip1> 172.17.44.17
</mgmt_ip1>
<hus_cmd> hus-cmd </hus_cmd>
<username> system </username>
<password> manager </password>
<svc_0>
<volume_type> regular </volume_type>
<iscsi_ip> 172.17.39.132
</iscsi_ip>
<hdp> 9 </hdp>
72
CHAPTER 2. BLOCK STORAGE
</svc_0>
<snapshot>
<hdp> 13 </hdp>
</snapshot>
<lun_start>
3000
</lun_start>
<lun_end>
4000
</lun_end>
</config>
3. Configure the /opt/hds/hus/cinder_hus2_conf.xml file:
<?xml version= "1.0" encoding= "UTF-8" ?>
<config>
<mgmt_ip0> 172.17.44.20
</mgmt_ip0>
<mgmt_ip1> 172.17.44.21
</mgmt_ip1>
<hus_cmd> hus-cmd </hus_cmd>
<username> system </username>
<password> manager </password>
<svc_0>
<volume_type> platinum </volume_type>
<iscsi_ip> 172.17.30.130
</iscsi_ip>
<hdp> 2 </hdp>
</svc_0>
<snapshot>
<hdp> 3 </hdp>
</snapshot>
<lun_start>
2000
</lun_start>
<lun_end>
3000
</lun_end>
</config>
Type extra specs: volume_backend and volume type
If you use volume types, you must configure them in the configuration file and set the
volume_backend_name option to the appropriate back-end. In the previous multi back-end example, the platinum volume type is served by hus-2, and the regular volume type is served by hus-1.
cinder type-key regular set volume_backend_name=hus-1 cinder type-key platinum set volume_backend_name=hus-2
Non differentiated deployment of HUS arrays
73
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
You can deploy multiple OpenStack Block Storage instances that each control a separate HUS array. Each instance has no volume type associated with it. The OpenStack Block Storage filtering algorithm selects the HUS array with the largest available free space. In each configuration file, you must define the default volume_type in the service labels.
2.2.9.4. HDS iSCSI volume driver configuration options
These details apply to the XML format configuration file that is read by HDS volume driver. These
differentiated service labels are predefined: svc_0, svc_1, svc_2, and svc_3
. Each respective service label associates with these parameters and tags:
1. volume-types: A create_volume call with a certain volume type shall be matched up with this tag. default is special in that any service associated with this type is used to create volume when no other labels match. Other labels are case sensitive and should exactly match. If no configured volume_types match the incoming requested type, an error occurs in volume creation.
2. HDP, the pool ID associated with the service.
3. An iSCSI port dedicated to the service.
Typically a OpenStack Block Storage volume instance has only one such service label. For example, any svc_0, svc_1, svc_2, or svc_3 can be associated with it. But any mix of these
service labels can be used in the same instance
.
Table 2.8. Configuration options
Option Type Default Description
mgmt_ip0
Management Port 0 IP address
mgmt_ip1 hus_cmd
Requir ed
Requir ed
Option al
Management Port 1 IP address
username
Option al
hus_cmd
is the command used to communicate with the HUS array. If it is not set, the default value is
hus-cmd
.
Username is required only if secure mode is used
74
CHAPTER 2. BLOCK STORAGE
Option Type Default Description
password
Requir ed
Password is required only if secure mode is used
svc_0, svc_1, svc_2, svc_3 snapshot
Option al
(at least one label has to be defined)
Service labels: these four predefined names help four different sets of configuration options -- each can specify iSCSI port address, HDP and a unique volume type.
Requir ed
A service label which helps specify configuration for snapshots, such as, HDP.
volume_type
Option al
iscsi_ip volume_type
tag is used to match volume type.
Default
meets any type of
volume_type
, or if it is not specified. Any other volume_type is selected if exactly matched during
create_volume
.
iSCSI port IP address where volume attaches for this volume type.
hdp lun_start
Requir ed
Requir ed
Option al
0
HDP, the pool number where volume, or snapshot should be created.
LUN allocation starts at this number.
lun_end
Option al
4096 LUN allocation is up to, but not including, this number.
2.2.10. IBM Storwize family and SVC volume driver
The volume management driver for Storwize family and SAN Volume Controller (SVC) provides
OpenStack Compute instances with access to IBM Storwize family or SVC storage systems.
2.2.10.1. Configure the Storwize family and SVC system
Network configuration
The Storwize family or SVC system must be configured for iSCSI, Fibre Channel, or both.
75
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
If using iSCSI, each Storwize family or SVC node should have at least one iSCSI IP address. The
IBM Storwize/SVC driver uses an iSCSI IP address associated with the volume's preferred node (if available) to attach the volume to the instance, otherwise it uses the first available iSCSI IP address of the system. The driver obtains the iSCSI IP address directly from the storage system; you do not need to provide these iSCSI IP addresses directly to the driver.
Note
If using iSCSI, ensure that the compute nodes have iSCSI network access to the Storwize family or SVC system.
Note
OpenStack Nova's Grizzly version supports iSCSI multipath. Once this is configured on the Nova host (outside the scope of this documentation), multipath is enabled.
If using Fibre Channel (FC), each Storwize family or SVC node should have at least one WWPN port configured. If the storwize_svc_multipath_enabled flag is set to True in the Cinder configuration file, the driver uses all available WWPNs to attach the volume to the instance (details
WWPN associated with the volume's preferred node (if available), otherwise it uses the first available WWPN of the system. The driver obtains the WWPNs directly from the storage system; you do not need to provide these WWPNs directly to the driver.
Note
If using FC, ensure that the compute nodes have FC connectivity to the Storwize family or
SVC system.
iSCSI CHAP authentication
If using iSCSI for data access and the storwize_svc_iscsi_chap_enabled is set to True, the driver will associate randomly-generated CHAP secrets with all hosts on the Storwize family system.
OpenStack compute nodes use these secrets when creating iSCSI connections.
Note
CHAP secrets are added to existing hosts as well as newly-created ones. If the CHAP option is enabled, hosts will not be able to access the storage without the generated secrets.
Note
Not all OpenStack Compute drivers support CHAP authentication. Please check compatibility before using.
76
CHAPTER 2. BLOCK STORAGE
Note
CHAP secrets are passed from OpenStack Block Storage to Compute in clear text. This communication should be secured to ensure that CHAP secrets are not discovered.
Configure storage pools
Each instance of the IBM Storwize/SVC driver allocates all volumes in a single pool. The pool should be created in advance and be provided to the driver using the
storwize_svc_volpool_name configuration flag. Details about the configuration flags and how
to provide the flags to the driver appear in the next section
.
Configure user authentication for the driver
The driver requires access to the Storwize family or SVC system management interface. The driver communicates with the management using SSH. The driver should be provided with the Storwize family or SVC management IP using the san_ip flag, and the management port should be provided by the san_ssh_port flag. By default, the port value is configured to be port 22 (SSH).
Note
Make sure the compute node running the cinder-volume management driver has SSH network access to the storage system.
To allow the driver to communicate with the Storwize family or SVC system, you must provide the driver with a user on the storage system. The driver has two authentication methods: passwordbased authentication and SSH key pair authentication. The user should have an Administrator role. It is suggested to create a new user for the management driver. Please consult with your storage and security administrator regarding the preferred authentication method and how passwords or SSH keys should be stored in a secure manner.
Note
When creating a new user on the Storwize or SVC system, make sure the user belongs to the Administrator group or to another group that has an Administrator role.
If using password authentication, assign a password to the user on the Storwize or SVC system. The driver configuration flags for the user and password are san_login and san_password, respectively.
If you are using the SSH key pair authentication, create SSH private and public keys using the instructions below or by any other method. Associate the public key with the user by uploading the public key: select the "choose file" option in the Storwize family or SVC management GUI under
"SSH public key". Alternatively, you may associate the SSH public key using the command line interface; details can be found in the Storwize and SVC documentation. The private key should be provided to the driver using the san_private_key configuration flag.
Create a SSH key pair with OpenSSH
77
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Create a SSH key pair with OpenSSH
You can create an SSH key pair using OpenSSH, by running:
$ ssh-keygen -t rsa
The command prompts for a file to save the key pair. For example, if you select 'key' as the filename, two files are created: key and key.pub. The key file holds the private SSH key and
key.pub holds the public SSH key.
The command also prompts for a pass phrase, which should be empty.
The private key file should be provided to the driver using the san_private_key configuration flag.
The public key should be uploaded to the Storwize family or SVC system using the storage management GUI or command line interface.
Note
Ensure that Cinder has read permissions on the private key file.
2.2.10.2. Configure the Storwize family and SVC driver
Enable the Storwize family and SVC driver
Set the volume driver to the Storwize family and SVC driver by setting the volume_driver option in cinder.conf as follows: volume_driver = cinder.volume.drivers.ibm.storwize_svc.StorwizeSVCDriver
Storwize family and SVC driver options in cinder.conf
The following options specify default values for all volumes. Some can be over-ridden using volume types, which are described below.
Table 2.9. List of configuration flags for Storwize storage and SVC driver
Flag name Type Default Description san_ip
Management IP or host name
san_ssh_port
Requir ed
Option al
22 Management port
78
Flag name san_login
CHAPTER 2. BLOCK STORAGE
Type Default Description
Requir ed
Management login username
san_password san_private_key
Requir ed
Requir ed
storwize_svc_volpool_name
Requir ed
storwize_svc_vol_rsize
Option al
2
Management login password
Management login SSH private key
Default pool name for volumes
Initial physical allocation (percentage)
storwize_svc_vol_warning
Option al
0
(disabled
)
Space allocation warning threshold
storwize_svc_vol_autoexpan d
Option al
True Enable or disable volume auto expand
storwize_svc_vol_grainsize
Option al
256
storwize_svc_vol_compressi on
Option al
False Enable or disable Real-time
Compression
storwize_svc_vol_easytier
Option al
True
Enable or disable Easy Tier
storwize_svc_vol_iogrp
Option al
0
storwize_svc_flashcopy_tim eout
Option al
120
The I/O group in which to allocate vdisks
FlashCopy timeout threshold
(seconds)
79
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Flag name Type Default Description storwize_svc_connection_pr otocol
Option al iSCSI Connection protocol to use (currently supports 'iSCSI' or 'FC')
storwize_svc_iscsi_chap_en abled
Option al
True
storwize_svc_multipath_ena bled
Option al
False
Configure CHAP authentication for iSCSI connections
Enable multipath for FC connections
storwize_svc_multihost_ena bled
Option al
True Enable mapping vdisks to multiple hosts
The authentication requires either a password (
san_password
) or SSH private key (
san_private_key
).
One must be specified. If both are specified, the driver uses only the SSH private key.
The driver creates thin-provisioned volumes by default. The
storwize_svc_vol_rsize
flag defines the initial physical allocation percentage for thin-provisioned volumes, or if set to
-1
, the driver creates full allocated volumes. More details about the available options are available in the Storwize family and SVC documentation.
Defines whether thin-provisioned volumes can be auto expanded by the storage system, a value of
True
means that auto expansion is enabled, a value of
False
disables auto expansion. Details about this option can be found in the
–autoexpand
flag of the Storwize family and SVC command line interface
mkvdisk
command.
Defines whether Real-time Compression is used for the volumes created with OpenStack. Details on Real-time
Compression can be found in the Storwize family and SVC documentation. The Storwize or SVC system must have compression enabled for this feature to work.
Defines whether Easy Tier is used for the volumes created with OpenStack. Details on EasyTier can be found in the Storwize family and SVC documentation. The Storwize or SVC system must have Easy Tier enabled for this feature to work.
The driver wait timeout threshold when creating an OpenStack snapshot. This is actually the maximum amount of time that the driver waits for the Storwize family or SVC system to prepare a new FlashCopy mapping. The driver accepts a maximum wait time of 600 seconds (10 minutes).
Multipath for iSCSI connections requires no storage-side configuration and is enabled if the compute host has multipath configured.
This option allows the driver to map a vdisk to more than one host at a time. This scenario occurs during migration of a virtual machine with an attached volume; the volume is simultaneously mapped to both the source and destination compute hosts. If your deployment does not require attaching vdisks to multiple hosts, setting this flag to
False will provide added safety.
Table 2.10. Description of IBM Storwise driver configuration options
80
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value
[DEFAULT] storwize_svc_allow_tenant_qos
=
False
storwize_svc_connection_protocol
=
iSCSI
Description
(BoolOpt) Allow tenants to specify QOS on create
(StrOpt) Connection protocol (iSCSI/FC)
storwize_svc_flashcopy_timeout
120
=
storwize_svc_iscsi_chap_enabled
=
True
storwize_svc_multihostmap_enabled
= True
storwize_svc_multipath_enabled
=
False
(IntOpt) Maximum number of seconds to wait for
FlashCopy to be prepared. Maximum value is 600 seconds (10 minutes)
(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Enabled)
(BoolOpt) Allows vdisk to multi host mapping
storwize_svc_npiv_compatibility_mo de
= False
(BoolOpt) Indicate whether svc driver is compatible for NPIV setup. If it is compatible, it will allow no wwpns being returned on get_conn_fc_wwpns during initialize_connection
storwize_svc_stretched_cluster_par tner
= None
(StrOpt) If operating in stretched cluster mode, specify the name of the pool in which mirrored copies are stored.Example: "pool2"
storwize_svc_vol_autoexpand
= True
(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)
storwize_svc_vol_compression storwize_svc_vol_easytier storwize_svc_vol_iogrp storwize_svc_vol_rsize
= 0
= 2
storwize_svc_vol_warning
= True
storwize_svc_vol_grainsize
= 256
= 0
= False
(BoolOpt) Storage system autoexpand parameter for volumes (True/False)
(BoolOpt) Storage system compression option for volumes
(BoolOpt) Enable Easy Tier for volumes
(IntOpt) Storage system grain size parameter for volumes (32/64/128/256)
(IntOpt) The I/O group in which to allocate volumes
(IntOpt) Storage system space-efficiency parameter for volumes (percentage)
(IntOpt) Storage system threshold for volume capacity warnings (percentage)
81
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value storwize_svc_volpool_name
= volpool
Description
(StrOpt) Storage system storage pool for volumes
82
Placement with volume types
The IBM Storwize/SVC driver exposes capabilities that can be added to the extra specs of volume types, and used by the filter scheduler to determine placement of new volumes. Make sure to prefix these keys with capabilities: to indicate that the scheduler should use them. The following extra specs are supported: capabilities:volume_back-end_name - Specify a specific back-end where the volume should be created. The back-end name is a concatenation of the name of the IBM Storwize/SVC storage system as shown in lssystem, an underscore, and the name of the pool (mdisk group). For example: capabilities:volume_back-end_name=myV7000_openstackpool capabilities:compression_support - Specify a back-end according to compression support. A value of True should be used to request a back-end that supports compression, and a value of
False will request a back-end that does not support compression. If you do not have constraints on compression support, do not set this key. Note that specifying True does not enable compression; it only requests that the volume be placed on a back-end that supports compression. Example syntax: capabilities:compression_support='<is> True' capabilities:easytier_support - Similar semantics as the compression_support key, but for specifying according to support of the Easy Tier feature. Example syntax: capabilities:easytier_support='<is> True' capabilities:storage_protocol - Specifies the connection protocol used to attach volumes of this type to instances. Legal values are iSCSI and FC. This extra specs value is used for both placement and setting the protocol used for this volume. In the example syntax, note <in> is used as opposed to <is> used in the previous examples.
capabilities:storage_protocol='<in> FC'
Configure per-volume creation options
Volume types can also be used to pass options to the IBM Storwize/SVC driver, which over-ride the default values set in the configuration file. Contrary to the previous examples where the
"capabilities" scope was used to pass parameters to the Cinder scheduler, options can be passed to the IBM Storwize/SVC driver with the "drivers" scope.
The following extra specs keys are supported by the IBM Storwize/SVC driver:
CHAPTER 2. BLOCK STORAGE
rsize warning autoexpand grainsize compression easytier multipath iogrp
These keys have the same semantics as their counterparts in the configuration file. They are set similarly; for example, rsize=2 or compression=False.
Example: Volume types
In the following example, we create a volume type to specify a controller that supports iSCSI and compression, to use iSCSI when attaching the volume, and to enable compression:
$ cinder type-create compressed
$ cinder type-key compressed set capabilities:storage_protocol='<in> iSCSI' capabilities:compression_support='<is> True' drivers:compression=True
We can then create a 50GB volume using this type:
$ cinder create --display-name "compressed volume" --volume-type compressed 50
Volume types can be used, for example, to provide users with different performance levels (such as, allocating entirely on an HDD tier, using Easy Tier for an HDD-SDD mix, or allocating entirely on an SSD tier) resiliency levels (such as, allocating volumes in pools with different RAID levels) features (such as, enabling/disabling Real-time Compression)
QOS
The Storwize driver provides QOS support for storage volumes by controlling the I/O amount. QOS
83
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
is enabled by editing the etc/cinder/cinder.conf file and setting the
storwize_svc_allow_tenant_qos to True.
There are three ways to set the Storwize IOThrotting parameter for storage volumes:
Add the qos:IOThrottling key into a QOS specification and associate it with a volume type.
Add the qos:IOThrottling key into an extra specification with a volume type.
Add the qos:IOThrottling key to the storage volume metadata.
Note
If you are changing a volume type with QOS to a new volume type without QOS, the QOS configuration settings will be removed.
2.2.10.3. Operational notes for the Storwize family and SVC driver
Migrate volumes
In the context of OpenStack Block Storage's volume migration feature, the IBM Storwize/SVC driver enables the storage's virtualization technology. When migrating a volume from one pool to another, the volume will appear in the destination pool almost immediately, while the storage moves the data in the background.
Note
To enable this feature, both pools involved in a given volume migration must have the same values for extent_size. If the pools have different values for extent_size, the data will still be moved directly between the pools (not host-side copy), but the operation will be synchronous.
Extend volumes
The IBM Storwize/SVC driver allows for extending a volume's size, but only for volumes without snapshots.
Snapshots and clones
Snapshots are implemented using FlashCopy with no background copy (space-efficient). Volume clones (volumes created from existing volumes) are implemented with FlashCopy, but with background copy enabled. This means that volume clones are independent, full copies. While this background copy is taking place, attempting to delete or extend the source volume will result in that operation waiting for the copy to complete.
Volume retype
84
CHAPTER 2. BLOCK STORAGE
The IBM Storwize/SVC driver enables you to modify volume types. When you modify volume types, you can also change these extra specs properties: rsize warning autoexpand grainsize compression easytier iogrp
Note
When you change the rsize, grainsize or compression properties, volume copies are asynchronously synchronized on the array.
Note
To change the iogrp property, IBM Storwize/SVC firmware version 6.4.0 or later is required.
2.2.11. IBM XIV and DS8000 volume driver
The IBM Storage Driver for OpenStack is a Block Storage driver that supports IBM XIV and IBM
DS8000 storage systems over Fiber channel and iSCSI.
Set the following in your cinder.conf, and use the following options to configure it.
volume_driver = cinder.volume.drivers.xiv_ds8k.XIVDS8KDriver
Table 2.11. Description of IBM XIV and DS8000 volume driver configuration options
Configuration option = Default value
[DEFAULT] san_clustername
=
Description
(StrOpt) Cluster name to use for creating volumes
85
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value san_ip
=
san_login
= admin
san_password
=
xiv_chap
= disabled
xiv_ds8k_connection_type
= iscsi
xiv_ds8k_proxy
=
xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaPr
oxy
Description
(StrOpt) IP address of SAN controller
(StrOpt) Username for SAN controller
(StrOpt) Password for SAN controller
(StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled)
(StrOpt) Connection type to the IBM Storage Array
(StrOpt) Proxy driver that connects to the IBM
Storage Array
86
Note
To use the IBM Storage Driver for OpenStack you must download and install the package available at: http://www.ibm.com/support/fixcentral/swg/selectFixes?
parent=Enterprise%2BStorage%2BServers&product=ibm/Storage_Disk/XIV+Storage+System+%282810,+2812%29&release=All&platform=All&function=all
For full documentation refer to IBM's online documentation available at http://pic.dhe.ibm.com/infocenter/strhosts/ic/topic/com.ibm.help.strghosts.doc/nova-homepage.html
.
2.2.12. LVM
The default volume back-end uses local volumes managed by LVM.
This driver supports different transport protocols to attach volumes, currently iSCSI and iSER.
Note
The Block Storage iSCSI LVM driver has significant performance issues. In production environments, with high I/O activity, there are many potential issues which could affect performance or data integrity.
Red Hat strongly recommends using a certified Block Storage plug-in provider for storage in a production environment. The software iSCSI LVM driver should be used and is only supported for single node evaluations and proof of concept environments.
Set the following in your cinder.conf configuration file, and use the following options to configure for iSCSI transport:
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
iscsi_protocol = iscsi
CHAPTER 2. BLOCK STORAGE
Use the following options to configure for the iSER transport:
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
iscsi_protocol = iser
Table 2.12. Description of LVM configuration options
Configuration option = Default value
[DEFAULT] lvm_conf_file
= /etc/cinder/lvm.conf
Description lvm_mirrors lvm_type
= 0
= default
volume_group
= cinder-volumes
(StrOpt) LVM conf file to use for the LVM driver in
Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists).
(IntOpt) If >0, create LVs with multiple mirrors.
Note that this requires lvm_mirrors + 2 PVs with available space
(StrOpt) Type of LVM volumes to deploy
(StrOpt) Name for the VG that will contain exported volumes
2.2.13. NetApp unified driver
The NetApp unified driver is a block storage driver that supports multiple storage families and protocols. A storage family corresponds to storage systems built on different NetApp technologies such as clustered Data ONTAP, Data ONTAP operating in 7-Mode, and E-Series. The storage protocol refers to the protocol used to initiate data storage and access operations on those storage systems like iSCSI and NFS. The NetApp unified driver can be configured to provision and manage
OpenStack volumes on a given storage family using a specified storage protocol. The OpenStack volumes can then be used for accessing and storing data using the storage protocol on the storage family system. The NetApp unified driver is an extensible interface that can support new storage families and protocols.
87
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Note
With the Juno release of OpenStack, OpenStack Block Storage has introduced the concept of "storage pools", in which a single OpenStack Block Storage back end may present one or more logical storage resource pools from which OpenStack Block Storage will select as a storage location when provisioning volumes.
In releases prior to Juno, the NetApp unified driver contained some "scheduling" logic that determined which NetApp storage container (namely, a FlexVol volume for Data ONTAP, or a dynamic disk pool for E-Series) that a new OpenStack Block Storage volume would be placed into.
With the introduction of pools, all scheduling logic is performed completely within the
OpenStack Block Storage scheduler, as each NetApp storage container is directly exposed to the OpenStack Block Storage scheduler as a storage pool; whereas previously, the NetApp unified driver presented an aggregated view to the scheduler and made a final placement decision as to which NetApp storage container the OpenStack
Block Storage volume would be provisioned into.
2.2.13.1. NetApp clustered Data ONTAP storage family
88
The NetApp clustered Data ONTAP storage family represents a configuration group which provides
OpenStack compute instances access to clustered Data ONTAP storage systems. At present it can be configured in OpenStack Block Storage to work with iSCSI and NFS storage protocols.
2.2.13.1.1. NetApp iSCSI configuration for clustered Data ONTAP
The NetApp iSCSI configuration for clustered Data ONTAP is an interface from OpenStack to clustered Data ONTAP storage systems for provisioning and managing the SAN block storage entity; that is, a NetApp LUN which can be accessed using the iSCSI protocol.
The iSCSI configuration for clustered Data ONTAP is a direct interface from OpenStack Block
Storage to the clustered Data ONTAP instance and as such does not require additional management software to achieve the desired functionality. It uses NetApp APIs to interact with the clustered Data ONTAP instance.
Configuration options for clustered Data ONTAP family with iSCSI protocol
Configure the volume driver, storage family and storage protocol to the NetApp unified driver, clustered Data ONTAP, and iSCSI respectively by setting the volume_driver,
netapp_storage_family and netapp_storage_protocol options in cinder.conf as follows: volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = ontap_cluster netapp_storage_protocol = iscsi netapp_vserver = openstack-vserver netapp_server_hostname = myhostname netapp_server_port = port netapp_login = username
CHAPTER 2. BLOCK STORAGE
netapp_password = password
Note
To use the iSCSI protocol, you must override the default value of
netapp_storage_protocol with iscsi.
Table 2.13. Description of NetApp cDOT iSCSI driver configuration options
Configuration option = Default value
[DEFAULT] netapp_login
= None
Description netapp_partner_backend_name
= None
netapp_password
= None
netapp_server_hostname netapp_server_port netapp_size_multiplier netapp_storage_family
= None
= None
= 1.2
= ontap_cluster
netapp_storage_protocol
= None
(StrOpt) Administrative user account name used to access the storage system or proxy server.
(StrOpt) The name of the config.conf stanza for a
Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.
(StrOpt) Password for the administrative user account specified in the netapp_login option.
(StrOpt) The hostname (or IP address) for the storage system or proxy server.
(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for
HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.
(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request.
(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.
(StrOpt) The storage protocol to be used on the data path with the storage system.
89
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value netapp_transport_type
= http
netapp_vserver
= None
Description
(StrOpt) The transport protocol used when communicating with the storage system or proxy server.
(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur.
Note
If you specify an account in the netapp_login that only has virtual storage server
(Vserver) administration privileges (rather than cluster-wide administration privileges), some advanced features of the NetApp unified driver will not work and you may see warnings in the OpenStack Block Storage logs.
Tip
For more information on these options and other deployment and operational scenarios, visit the
NetApp OpenStack Deployment and Operations Guide .
2.2.13.1.2. NetApp NFS configuration for clustered Data ONTAP
The NetApp NFS configuration for clustered Data ONTAP is an interface from OpenStack to a clustered Data ONTAP system for provisioning and managing OpenStack volumes on NFS exports provided by the clustered Data ONTAP system that are accessed using the NFS protocol.
The NFS configuration for clustered Data ONTAP is a direct interface from OpenStack Block
Storage to the clustered Data ONTAP instance and as such does not require any additional management software to achieve the desired functionality. It uses NetApp APIs to interact with the clustered Data ONTAP instance.
Configuration options for the clustered Data ONTAP family with NFS protocol
Configure the volume driver, storage family, and storage protocol to NetApp unified driver, clustered
Data ONTAP, and NFS respectively by setting the volume_driver, netapp_storage_family and netapp_storage_protocol options in cinder.conf as follows: volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = ontap_cluster netapp_storage_protocol = nfs netapp_vserver = openstack-vserver netapp_server_hostname = myhostname
90
CHAPTER 2. BLOCK STORAGE
netapp_server_port = port netapp_login = username netapp_password = password nfs_shares_config = /etc/cinder/nfs_shares
Table 2.14. Description of NetApp cDOT NFS driver configuration options
Configuration option = Default value
[DEFAULT] expiry_thres_minutes
= 720
Description netapp_copyoffload_tool_path
= None
netapp_login
= None
netapp_partner_backend_name netapp_password
= None
netapp_server_hostname netapp_server_port
= None
netapp_storage_family
= None
= None
= ontap_cluster
(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache.
When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.
(StrOpt) This option specifies the path of the
NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file.
(StrOpt) Administrative user account name used to access the storage system or proxy server.
(StrOpt) The name of the config.conf stanza for a
Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.
(StrOpt) Password for the administrative user account specified in the netapp_login option.
(StrOpt) The hostname (or IP address) for the storage system or proxy server.
(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for
HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.
(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.
91
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value netapp_storage_protocol
= None
netapp_transport_type netapp_vserver
= None
= http
thres_avl_size_perc_start thres_avl_size_perc_stop
= 20
= 60
Description
(StrOpt) The storage protocol to be used on the data path with the storage system.
(StrOpt) The transport protocol used when communicating with the storage system or proxy server.
(StrOpt) This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur.
(IntOpt) If the percentage of available space for an
NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.
(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.
Note
Additional NetApp NFS configuration options are shared with the generic NFS driver.
These options can be found here: Table 2.19, “Description of NFS storage configuration options” .
Note
If you specify an account in the netapp_login that only has virtual storage server
(Vserver) administration privileges (rather than cluster-wide administration privileges), some advanced features of the NetApp unified driver will not work and you may see warnings in the OpenStack Block Storage logs.
NetApp NFS Copy Offload client
A feature was added in the Icehouse release of the NetApp unified driver that enables Image
Service images to be efficiently copied to a destination Block Storage volume. When the Block
Storage and Image Service are configured to use the NetApp NFS Copy Offload client, a controllerside copy will be attempted before reverting to downloading the image from the Image Service. This improves image provisioning times while reducing the consumption of bandwidth and CPU cycles on the host(s) running the Image and Block Storage services. This is due to the copy operation being performed completely within the storage cluster.
92
CHAPTER 2. BLOCK STORAGE
The NetApp NFS Copy Offload client can be used in either of the following scenarios:
The Image Service is configured to store images in an NFS share that is exported from a NetApp
FlexVol volume and the destination for the new Block Storage volume will be on an NFS share exported from a different FlexVol volume than the one used by the Image Service. Both FlexVols must be located within the same cluster.
The source image from the Image Service has already been cached in an NFS image cache within a Block Storage backend. The cached image resides on a different FlexVol volume than the destination for the new Block Storage volume. Both FlexVols must be located within the same cluster.
To use this feature, you must configure the Image Service, as follows:
Set the default_store configuration option to file.
Set the filesystem_store_datadir configuration option to the path to the Image Service
NFS export.
Set the show_image_direct_url configuration option to True.
Set the show_multiple_locations configuration option to True.
Set the filesystem_store_metadata_file configuration option to a metadata file. The metadata file should contain a JSON object that contains the correct information about the NFS export used by the Image Service, similar to:
{
"share_location": "nfs://192.168.0.1/myGlanceExport",
"mount_point": "/var/lib/glance/images",
"type": "nfs"
}
To use this feature, you must configure the Block Storage service, as follows:
Set the netapp_copyoffload_tool_path configuration option to the path to the NetApp
Copy Offload binary.
Set the glance_api_version configuration option to 2.
93
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Important
This feature requires that:
The storage system must have Data ONTAP v8.2 or greater installed.
The vStorage feature must be enabled on each storage virtual machine (SVM, also known as a Vserver) that is permitted to interact with the copy offload client.
To configure the copy offload workflow, enable NFS v4.0 or greater and export it from the SVM.
94
Tip
To download the NetApp copy offload binary to be utilized in conjunction with the
netapp_copyoffload_tool_path configuration option, please visit the Utility Toolchest page at the NetApp Support portal (login is required).
Tip
For more information on these options and other deployment and operational scenarios, visit the
NetApp OpenStack Deployment and Operations Guide .
2.2.13.1.3. NetApp-supported extra specs for clustered Data ONTAP
Extra specs enable vendors to specify extra filter criteria that the Block Storage scheduler uses when it determines which volume node should fulfill a volume provisioning request. When you use the NetApp unified driver with a clustered Data ONTAP storage system, you can leverage extra specs with OpenStack Block Storage volume types to ensure that OpenStack Block Storage volumes are created on storage back ends that have certain properties. For example, when you configure QoS, mirroring, or compression for a storage back end.
Extra specs are associated with OpenStack Block Storage volume types, so that when users request volumes of a particular volume type, the volumes are created on storage back ends that meet the list of requirements. For example, the back ends have the available space or extra specs.
You can use the specs in the following table when you define OpenStack Block Storage volume types by using the cinder type-key command.
Table 2.15. Description of extra specs options for NetApp Unified Driver with Clustered Data
ONTAP
Extra spec netapp_raid_type
Type
String
Description
Limit the candidate volume list based on one of the following raid types:
raid4, raid_dp
.
Extra spec netapp_disk_type netapp:qos_policy_g
Type
String
String
netapp_mirrored
Boolean
netapp_unmirrored
Boolean
netapp_dedup
Boolean
Boolean
netapp_compression
Boolean
netapp_nocompressio n
netapp_thin_provisi oned netapp_thick_provis ioned
Boolean
Boolean
Boolean
CHAPTER 2. BLOCK STORAGE
Description
Limit the candidate volume list based on one of the following disk types:
ATA, BSAS, EATA, FCAL,
FSAS, LUN, MSATA, SAS, SATA, SCSI,
XATA, XSAS, or SSD.
Specify the name of a QoS policy group, which defines measurable Service Level Objectives, that should be applied to the OpenStack Block Storage volume at the time of volume creation. Ensure that the QoS policy group object within Data ONTAP should be defined before an OpenStack Block Storage volume is created, and that the QoS policy group is not associated with the destination FlexVol volume.
Limit the candidate volume list to only the ones that are mirrored on the storage controller.
Limit the candidate volume list to only the ones that are not mirrored on the storage controller.
Limit the candidate volume list to only the ones that have deduplication enabled on the storage controller.
Limit the candidate volume list to only the ones that have deduplication disabled on the storage controller.
Limit the candidate volume list to only the ones that have compression enabled on the storage controller.
Limit the candidate volume list to only the ones that have compression disabled on the storage controller.
Limit the candidate volume list to only the ones that support thin provisioning on the storage controller.
Limit the candidate volume list to only the ones that support thick provisioning on the storage controller.
Please note that this extra spec has a colon (
:
) in its name because it is used by the driver to assign the QoS policy group to the OpenStack Block Storage volume after it has been provisioned.
In the Juno release, these negative-assertion extra specs are formally deprecated by the NetApp unified driver.
Instead of using the deprecated negative-assertion extra specs (for example, value of
netapp_unmirrored
) with a
true
, use the corresponding positive-assertion extra spec (for example,
netapp_mirrored
) with a value of
false
.
2.2.13.2. NetApp Data ONTAP operating in 7-Mode storage family
95
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The NetApp Data ONTAP operating in 7-Mode storage family represents a configuration group which provides OpenStack compute instances access to 7-Mode storage systems. At present it can be configured in OpenStack Block Storage to work with iSCSI and NFS storage protocols.
2.2.13.2.1. NetApp iSCSI configuration for Data ONTAP operating in 7-Mode
The NetApp iSCSI configuration for Data ONTAP operating in 7-Mode is an interface from
OpenStack to Data ONTAP operating in 7-Mode storage systems for provisioning and managing the
SAN block storage entity, that is, a LUN which can be accessed using iSCSI protocol.
The iSCSI configuration for Data ONTAP operating in 7-Mode is a direct interface from OpenStack to Data ONTAP operating in 7-Mode storage system and it does not require additional management software to achieve the desired functionality. It uses NetApp ONTAPI to interact with the Data
ONTAP operating in 7-Mode storage system.
Configuration options for the Data ONTAP operating in 7-Mode storage family with iSCSI protocol
Configure the volume driver, storage family and storage protocol to the NetApp unified driver, Data
ONTAP operating in 7-Mode, and iSCSI respectively by setting the volume_driver,
netapp_storage_family and netapp_storage_protocol options in cinder.conf as follows: volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = ontap_7mode netapp_storage_protocol = iscsi netapp_server_hostname = myhostname netapp_server_port = 80 netapp_login = username netapp_password = password
Note
To use the iSCSI protocol, you must override the default value of
netapp_storage_protocol with iscsi.
Table 2.16. Description of NetApp 7-Mode iSCSI driver configuration options
Configuration option = Default value
[DEFAULT] netapp_login
= None
Description
(StrOpt) Administrative user account name used to access the storage system or proxy server.
96
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value netapp_partner_backend_name
= None
netapp_password netapp_server_hostname netapp_server_port netapp_vfiler
= None
= None
= None
netapp_size_multiplier netapp_storage_family netapp_storage_protocol netapp_transport_type
= None
= 1.2
= ontap_cluster
= None
= http
Description
(StrOpt) The name of the config.conf stanza for a
Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.
(StrOpt) Password for the administrative user account specified in the netapp_login option.
(StrOpt) The hostname (or IP address) for the storage system or proxy server.
(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for
HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.
(FloatOpt) The quantity to be multiplied by the requested volume size to ensure enough space is available on the virtual storage server (Vserver) to fulfill the volume creation request.
(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.
(StrOpt) The storage protocol to be used on the data path with the storage system.
(StrOpt) The transport protocol used when communicating with the storage system or proxy server.
(StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system.
97
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value netapp_volume_list
= None
Description
(StrOpt) This option is only utilized when the storage protocol is configured to use iSCSI or FC.
This option is used to restrict provisioning to the specified controller volumes. Specify the value of this option to be a comma separated list of NetApp controller volume names to be used for provisioning.
Tip
For more information on these options and other deployment and operational scenarios, visit the
NetApp OpenStack Deployment and Operations Guide .
2.2.13.2.2. NetApp NFS configuration for Data ONTAP operating in 7-Mode
The NetApp NFS configuration for Data ONTAP operating in 7-Mode is an interface from OpenStack to Data ONTAP operating in 7-Mode storage system for provisioning and managing OpenStack volumes on NFS exports provided by the Data ONTAP operating in 7-Mode storage system which can then be accessed using NFS protocol.
The NFS configuration for Data ONTAP operating in 7-Mode is a direct interface from OpenStack
Block Storage to the Data ONTAP operating in 7-Mode instance and as such does not require any additional management software to achieve the desired functionality. It uses NetApp ONTAPI to interact with the Data ONTAP operating in 7-Mode storage system.
Configuration options for the Data ONTAP operating in 7-Mode family with NFS protocol
Configure the volume driver, storage family, and storage protocol to the NetApp unified driver, Data
ONTAP operating in 7-Mode, and NFS respectively by setting the volume_driver,
netapp_storage_family and netapp_storage_protocol options in cinder.conf as follows: volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = ontap_7mode netapp_storage_protocol = nfs netapp_server_hostname = myhostname netapp_server_port = 80 netapp_login = username netapp_password = password nfs_shares_config = /etc/cinder/nfs_shares
Table 2.17. Description of NetApp 7-Mode NFS driver configuration options
98
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value
[DEFAULT] expiry_thres_minutes
= 720
Description netapp_login
= None
netapp_partner_backend_name
= None
netapp_password
= None
netapp_server_hostname netapp_server_port
= None
netapp_storage_family netapp_storage_protocol netapp_transport_type
= None
= ontap_cluster
= None
= http
(IntOpt) This option specifies the threshold for last access time for images in the NFS image cache.
When a cache cleaning cycle begins, images in the cache that have not been accessed in the last M minutes, where M is the value of this parameter, will be deleted from the cache to create free space on the NFS share.
(StrOpt) Administrative user account name used to access the storage system or proxy server.
(StrOpt) The name of the config.conf stanza for a
Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.
(StrOpt) Password for the administrative user account specified in the netapp_login option.
(StrOpt) The hostname (or IP address) for the storage system or proxy server.
(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for
HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.
(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.
(StrOpt) The storage protocol to be used on the data path with the storage system.
(StrOpt) The transport protocol used when communicating with the storage system or proxy server.
99
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value netapp_vfiler
= None
thres_avl_size_perc_start thres_avl_size_perc_stop
= 20
= 60
Description
(StrOpt) The vFiler unit on which provisioning of block storage volumes will be done. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode. Only use this option when utilizing the MultiStore feature on the NetApp storage system.
(IntOpt) If the percentage of available space for an
NFS share has dropped below the value specified by this option, the NFS image cache will be cleaned.
(IntOpt) When the percentage of available space on an NFS share has reached the percentage specified by this option, the driver will stop clearing files from the NFS image cache that have not been accessed in the last M minutes, where M is the value of the expiry_thres_minutes configuration option.
Note
Additional NetApp NFS configuration options are shared with the generic NFS driver. For
a description of these, see Table 2.19, “Description of NFS storage configuration options” .
Tip
For more information on these options and other deployment and operational scenarios, visit the
NetApp OpenStack Deployment and Operations Guide .
2.2.13.3. NetApp E-Series storage family
The NetApp E-Series storage family represents a configuration group which provides OpenStack compute instances access to E-Series storage systems. At present it can be configured in
OpenStack Block Storage to work with the iSCSI storage protocol.
2.2.13.3.1. NetApp iSCSI configuration for E-Series
The NetApp iSCSI configuration for E-Series is an interface from OpenStack to E-Series storage systems for provisioning and managing the SAN block storage entity; that is, a NetApp LUN which can be accessed using the iSCSI protocol.
100
CHAPTER 2. BLOCK STORAGE
The iSCSI configuration for E-Series is an interface from OpenStack Block Storage to the E-Series proxy instance and as such requires the deployment of the proxy instance in order to achieve the desired functionality. The driver uses REST APIs to interact with the E-Series proxy instance, which in turn interacts directly with the E-Series controllers.
The use of multipath and DM-MP are required when using the OpenStack Block Storage driver for
E-Series. In order for OpenStack Block Storage and OpenStack Compute to take advantage of multiple paths, the following configuration options must be correctly configured:
The use_multipath_for_image_xfer option should be set to True in the cinder.conf file within the driver-specific stanza (for example, [myDriver]).
The iscsi_use_multipath option should be set to True in the nova.conf file within the
[libvirt] stanza.
Configuration options for E-Series storage family with iSCSI protocol
Configure the volume driver, storage family, and storage protocol to the NetApp unified driver, E-
Series, and iSCSI respectively by setting the volume_driver, netapp_storage_family and
netapp_storage_protocol options in cinder.conf as follows: volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = eseries netapp_storage_protocol = iscsi netapp_server_hostname = myhostname netapp_server_port = 80 netapp_login = username netapp_password = password netapp_controller_ips = 1.2.3.4,5.6.7.8 netapp_sa_password = arrayPassword netapp_storage_pools = pool1,pool2 use_multipath_for_image_xfer = True
Note
To use the E-Series driver, you must override the default value of
netapp_storage_family with eseries.
Note
To use the iSCSI protocol, you must override the default value of
netapp_storage_protocol with iscsi.
Table 2.18. Description of NetApp E-Series driver configuration options
101
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[DEFAULT] netapp_controller_ips
= None
Description netapp_eseries_host_type
linux_dm_mp
netapp_login
= None
=
netapp_partner_backend_name
= None
netapp_password
= None
netapp_sa_password netapp_server_port
= None
netapp_server_hostname
= None
= None
netapp_storage_family netapp_storage_pools
= ontap_cluster
= None
(StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning.
(StrOpt) This option is used to define how the controllers in the E-Series storage array will work with the particular operating system on the hosts that are connected to it.
(StrOpt) Administrative user account name used to access the storage system or proxy server.
(StrOpt) The name of the config.conf stanza for a
Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.
(StrOpt) Password for the administrative user account specified in the netapp_login option.
(StrOpt) Password for the NetApp E-Series storage array.
(StrOpt) The hostname (or IP address) for the storage system or proxy server.
(IntOpt) The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for
HTTP and 443 for HTTPS; E-Series will use 8080 for HTTP and 8443 for HTTPS.
(StrOpt) The storage family type used on the storage system; valid values are ontap_7mode for using Data ONTAP operating in 7-Mode, ontap_cluster for using clustered Data ONTAP, or eseries for using E-Series.
(StrOpt) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning.
102
Configuration option = Default value netapp_transport_type
= http
netapp_webservice_path
= /devmgr/v2
CHAPTER 2. BLOCK STORAGE
Description
(StrOpt) The transport protocol used when communicating with the storage system or proxy server.
(StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server.
The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application.
Tip
For more information on these options and other deployment and operational scenarios, visit the
NetApp OpenStack Deployment and Operations Guide .
2.2.13.4. Upgrading prior NetApp drivers to the NetApp unified driver
NetApp introduced a new unified block storage driver in Havana for configuring different storage families and storage protocols. This requires defining upgrade path for NetApp drivers which existed in releases prior to Havana. This section covers the upgrade configuration for NetApp drivers to the new unified configuration and a list of deprecated NetApp drivers.
2.2.13.4.1. Upgraded NetApp drivers
This section describes how to update OpenStack Block Storage configuration from a pre-Havana release to the unified driver format.
Driver upgrade configuration
1. NetApp iSCSI direct driver for Clustered Data ONTAP in Grizzly (or earlier).
volume_driver = cinder.volume.drivers.netapp.iscsi.NetAppDirectCmodeISCSIDriver
NetApp unified driver configuration.
volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = ontap_cluster netapp_storage_protocol = iscsi
2. NetApp NFS direct driver for Clustered Data ONTAP in Grizzly (or earlier).
103
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
volume_driver = cinder.volume.drivers.netapp.nfs.NetAppDirectCmodeNfsDriver
NetApp unified driver configuration.
volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = ontap_cluster netapp_storage_protocol = nfs
3. NetApp iSCSI direct driver for Data ONTAP operating in 7-Mode storage controller in
Grizzly (or earlier) volume_driver = cinder.volume.drivers.netapp.iscsi.NetAppDirect7modeISCSIDriver
NetApp unified driver configuration volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = ontap_7mode netapp_storage_protocol = iscsi
4. NetApp NFS direct driver for Data ONTAP operating in 7-Mode storage controller in Grizzly
(or earlier) volume_driver = cinder.volume.drivers.netapp.nfs.NetAppDirect7modeNfsDriver
NetApp unified driver configuration volume_driver = cinder.volume.drivers.netapp.common.NetAppDriver
netapp_storage_family = ontap_7mode netapp_storage_protocol = nfs
2.2.13.4.2. Deprecated NetApp drivers
This section lists the NetApp drivers in earlier releases that are deprecated in Havana.
1. NetApp iSCSI driver for clustered Data ONTAP.
volume_driver = cinder.volume.drivers.netapp.iscsi.NetAppCmodeISCSIDriver
2. NetApp NFS driver for clustered Data ONTAP.
volume_driver = cinder.volume.drivers.netapp.nfs.NetAppCmodeNfsDriver
104
CHAPTER 2. BLOCK STORAGE
3. NetApp iSCSI driver for Data ONTAP operating in 7-Mode storage controller.
volume_driver = cinder.volume.drivers.netapp.iscsi.NetAppISCSIDriver
4. NetApp NFS driver for Data ONTAP operating in 7-Mode storage controller.
volume_driver = cinder.volume.drivers.netapp.nfs.NetAppNFSDriver
Note
For support information on deprecated NetApp drivers in the Havana release, visit the
NetApp OpenStack Deployment and Operations Guide .
2.2.14. NFS driver
The Network File System (NFS) is a distributed file system protocol originally developed by Sun
Microsystems in 1984. An NFS server exports one or more of its file systems, known as shares. An
NFS client can mount these exported shares on its own file system. You can perform file actions on this mounted remote file system as if the file system were local.
2.2.14.1. How the NFS driver works
The NFS driver, and other drivers based on it, work quite differently than a traditional block storage driver.
The NFS driver does not actually allow an instance to access a storage device at the block level.
Instead, files are created on an NFS share and mapped to instances, which emulates a block device. This works in a similar way to QEMU, which stores instances in the
/var/lib/nova/instances directory.
2.2.14.2. Enable the NFS driver and related options
To use Cinder with the NFS driver, first set the volume_driver in cinder.conf: volume_driver=cinder.volume.drivers.nfs.NfsDriver
The following table contains the options supported by the NFS driver.
Table 2.19. Description of NFS storage configuration options
Configuration option = Default value
[DEFAULT]
Description
105
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value nfs_mount_attempts
= 3
Description
(IntOpt) The number of attempts to mount nfs shares before raising an error. At least one attempt will be made to mount an nfs share, regardless of the value specified.
nfs_mount_options nfs_mount_point_base nfs_oversub_ratio
= None
= $state_path/mnt
= 1.0
(StrOpt) Mount options passed to the nfs client.
See section of the nfs man page for details.
(StrOpt) Base dir containing mount points for nfs shares.
(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.
nfs_shares_config
= /etc/cinder/nfs_shares (StrOpt) File with the list of available nfs shares
nfs_sparsed_volumes
= True (BoolOpt) Create volumes as sparsed files which take no space.If set to False volume is created as regular file.In such case volume creation takes a lot of time.
nfs_used_ratio
= 0.95 (FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.
Note
As of the Icehouse release, the NFS driver (and other drivers based off it) will attempt to mount shares using version 4.1 of the NFS protocol (including pNFS). If the mount attempt is unsuccessful due to a lack of client or server support, a subsequent mount attempt that requests the default behavior of the mount.nfs command will be performed. On most distributions, the default behavior is to attempt mounting first with NFS v4.0, then silently fall back to NFS v3.0 if necessary. If the nfs_mount_options configuration option contains a request for a specific version of NFS to be used, or if specific options are specified in the shares configuration file specified by the nfs_shares_config configuration option, the mount will be attempted as requested with no subsequent attempts.
2.2.14.3. How to use the NFS driver
1. Access to one or more NFS servers. Creating an NFS server is outside the scope of this document. This example assumes access to the following NFS servers and mount points:
192.168.1.200:/storage
106
CHAPTER 2. BLOCK STORAGE
192.168.1.201:/storage
192.168.1.202:/storage
This example demonstrates the use of with this driver with multiple NFS servers. Multiple servers are not required. One is usually enough.
2. Add your list of NFS servers to the file you specified with the nfs_shares_config option.
For example, if the value of this option was set to /etc/cinder/shares.txt, then:
# cat /etc/cinder/shares.txt
192.168.1.200:/storage
192.168.1.201:/storage
192.168.1.202:/storage
Comments are allowed in this file. They begin with a #.
3. Configure the nfs_mount_point_base option. This is a directory where cinder-
volume mounts all NFS shares stored in shares.txt. For this example,
/var/lib/cinder/nfs is used. You can, of course, use the default value of
$state_path/mnt.
4. Start the cinder-volume service. /var/lib/cinder/nfs should now contain a directory for each NFS share specified in shares.txt. The name of each directory is a hashed name:
# ls /var/lib/cinder/nfs/
...
46c5db75dc3a3a50a10bfd1a456a9f3f
...
5. You can now create volumes as you normally would:
$ nova volume-create --display-name myvol 5
# ls /var/lib/cinder/nfs/46c5db75dc3a3a50a10bfd1a456a9f3f volume-a8862558-e6d6-4648-b5df-bb84f31c8935
This volume can also be attached and deleted just like other volumes. However, snapshotting is not supported.
NFS driver notes
cinder-volume manages the mounting of the NFS shares as well as volume creation on the shares. Keep this in mind when planning your OpenStack architecture. If you have one master
NFS server, it might make sense to only have one cinder-volume service to handle all requests to that NFS server. However, if that single server is unable to handle all requests, more than one cinder-volume service is needed as well as potentially more than one NFS server.
107
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Because data is stored in a file and not actually on a block storage device, you might not see the same IO performance as you would with a traditional block storage driver. Please test accordingly.
Despite possible IO performance loss, having volume data stored in a file might be beneficial.
For example, backing up volumes can be as easy as copying the volume files.
Note
Regular IO flushing and syncing still stands.
2.2.15. SolidFire
The SolidFire Cluster is a high performance all SSD iSCSI storage device that provides massive scale out capability and extreme fault tolerance. A key feature of the SolidFire cluster is the ability to set and modify during operation specific QoS levels on a volume for volume basis. The SolidFire cluster offers this along with de-duplication, compression, and an architecture that takes full advantage of SSDs.
To configure the use of a SolidFire cluster with Block Storage, modify your cinder.conf file as follows: volume_driver = cinder.volume.drivers.solidfire.SolidFireDriver
san_ip = 172.17.1.182 # the address of your MVIP san_login = sfadmin # your cluster admin login san_password = sfpassword # your cluster admin password sf_account_prefix = '' # prefix for tenant account creation on solidfire cluster (see warning below)
Warning
The SolidFire driver creates a unique account prefixed with $cinder-volume-
service-hostname-$tenant-id on the SolidFire cluster for each tenant that accesses the cluster through the Volume API. Unfortunately, this account formation results in issues for High Availability (HA) installations and installations where the
cinder-volume service can move to a new node. HA installations can return an
Account Not Found error because the call to the SolidFire cluster is not always going to be sent from the same node. In installations where the cinder-volume service moves to a new node, the same issue can occur when you perform operations on existing volumes, such as clone, extend, delete, and so on.
Note
Set the sf_account_prefix option to an empty string ('') in the cinder.conf file. This setting results in unique accounts being created on the SolidFire cluster, but the accounts are prefixed with the tenant-id or any unique identifier that you choose and are independent of the host where the cinder-volume service resides.
108
CHAPTER 2. BLOCK STORAGE
Table 2.20. Description of SolidFire driver configuration options
Configuration option = Default value
[DEFAULT] sf_account_prefix
= None
Description sf_allow_template_caching sf_allow_tenant_qos sf_api_port
= 443
sf_emulate_512
= True
= False
= True
sf_template_account_name
= openstack-
vtemplate
(StrOpt) Create SolidFire accounts with this prefix.
Any string can be used here, but the string
"hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix.
(BoolOpt) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls.
(BoolOpt) Allow tenants to specify QOS on create
(IntOpt) SolidFire API port. Useful if the device api is behind a proxy on a different port.
(BoolOpt) Set 512 byte emulation on volume creation;
(StrOpt) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist).
2.3. BACKUP DRIVERS
This section describes how to configure the cinder-backup service and its drivers.
To set a backup driver, use the backup_driver flag. By default there is no backup driver enabled.
2.3.1. Ceph backup driver
The Ceph backup driver backs up volumes of any type to a Ceph back-end store. The driver can also detect whether the volume to be backed up is a Ceph RBD volume, and if so, it tries to perform incremental and differential backups.
For source Ceph RBD volumes, you can perform backups within the same Ceph pool (not recommended). You can also perform backups between different Ceph pools and between different
Ceph clusters.
At the time of writing, differential backup support in Ceph/librbd was quite new. This driver attempts a differential backup in the first instance. If the differential backup fails, the driver falls back to full backup/copy.
109
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
If incremental backups are used, multiple backups of the same volume are stored as snapshots so that minimal space is consumed in the backup store. It takes far less time to restore a volume than to take a full copy.
Note
Block Storage enables you to:
Restore to a new volume, which is the default and recommended action.
Restore to the original volume from which the backup was taken. The restore action takes a full copy because this is the safest action.
110
To enable the Ceph backup driver, include the following option in the cinder.conf file: backup_driver = cinder.backup.drivers.ceph
The following configuration options are available for the Ceph backup driver.
Table 2.21. Description of Ceph backup driver configuration options
Configuration option = Default value
[DEFAULT] backup_ceph_chunk_size
= 134217728
Description backup_ceph_conf backup_ceph_pool
= /etc/ceph/ceph.conf
= backups
backup_ceph_stripe_count backup_ceph_stripe_unit backup_ceph_user
= cinder
= 0
= 0
restore_discard_excess_bytes
= True
(IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store.
(StrOpt) Ceph configuration file to use.
(StrOpt) The Ceph pool where volume backups are stored.
(IntOpt) RBD stripe count to use when creating a backup image.
(IntOpt) RBD stripe unit to use when creating a backup image.
(StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to
None.
(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.
CHAPTER 2. BLOCK STORAGE
This example shows the default options for the Ceph backup driver.
backup_ceph_conf=/etc/ceph/ceph.conf
backup_ceph_user = cinder backup_ceph_chunk_size = 134217728 backup_ceph_pool = backups backup_ceph_stripe_unit = 0 backup_ceph_stripe_count = 0
2.3.2. IBM Tivoli Storage Manager backup driver
The IBM Tivoli Storage Manager (TSM) backup driver enables performing volume backups to a
TSM server.
The TSM client should be installed and configured on the machine running the cinder-backup service. See the IBM Tivoli Storage Manager Backup-Archive Client Installation and User's Guide for details on installing the TSM client.
To enable the IBM TSM backup driver, include the following option in cinder.conf: backup_driver = cinder.backup.drivers.tsm
The following configuration options are available for the TSM backup driver.
Table 2.22. Description of IBM Tivoli Storage Manager backup driver configuration options
Description Configuration option = Default value
[DEFAULT] backup_tsm_compression
= True
backup_tsm_password
= password
backup_tsm_volume_prefix
= backup
(BoolOpt) Enable or Disable compression for backups
(StrOpt) TSM password for the running username
(StrOpt) Volume prefix for the backup id when backing up to TSM
This example shows the default options for the TSM backup driver.
backup_tsm_volume_prefix = backup backup_tsm_password = password backup_tsm_compression = True
2.3.3. Swift backup driver
The backup driver for the swift back end performs a volume backup to an object storage system.
111
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
To enable the swift backup driver, include the following option in the cinder.conf file: backup_driver = cinder.backup.drivers.swift
The following configuration options are available for the Swift back-end backup driver.
Table 2.23. Description of Swift backup driver configuration options
Configuration option = Default value
[DEFAULT] backup_swift_auth
= per_user
backup_swift_auth_version backup_swift_block_size
= 1
= 32768
Description
(StrOpt) Swift authentication mechanism
(StrOpt) Swift authentication version. Specify "1" for auth 1.0, or "2" for auth 2.0
(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.
backup_swift_container
= volumebackups (StrOpt) The default Swift container to use
backup_swift_enable_progress_timer
= True
(BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer.
backup_swift_key
= None
backup_swift_object_size
= 52428800
backup_swift_retry_attempts
= 3
backup_swift_retry_backoff backup_swift_tenant backup_swift_url
= None
= None
backup_swift_user
= None
= 2
(StrOpt) Swift key for authentication
(IntOpt) The size in bytes of Swift backup objects
(IntOpt) The number of retries to make for Swift operations
(IntOpt) The backoff time in seconds between Swift retries
(StrOpt) Swift tenant/account name. Required when connecting to an auth 2.0 system
(StrOpt) The URL of the Swift endpoint
(StrOpt) Swift user name
112
Configuration option = Default value swift_catalog_info
= object-
store:swift:publicURL
CHAPTER 2. BLOCK STORAGE
Description
(StrOpt) Info to match when looking for swift in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:
<endpoint_type> - Only used if backup_swift_url is unset
To enable the swift backup driver for 1.0 or 2.0 authentication version, specify 1 or 2 correspondingly. For example: backup_swift_auth_version = 2
In addition, the 2.0 authentication system requires backup_swift_tenant setting: backup_swift_tenant = <None>
This example shows the default options for the Swift back-end backup driver.
backup_swift_url = http://localhost:8080/v1/AUTH_ backup_swift_auth = per_user backup_swift_auth_version = 1 backup_swift_user = <None> backup_swift_key = <None> backup_swift_container = volumebackups backup_swift_object_size = 52428800 backup_swift_retry_attempts = 3 backup_swift_retry_backoff = 2 backup_compression_algorithm = zlib
2.3.4. NFS backup driver
The backup driver for the NFS back end backs up volumes of any type to an NFS exported backup repository.
To enable the NFS backup driver, include the following option in the [DEFAULT] section of the
cinder.conf file: backup_driver = cinder.backup.drivers.nfs
The following configuration options are available for the NFS back-end backup driver.
Table 2.24. Description of NFS backup driver configuration options
113
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[DEFAULT] backup_container backup_enable_progress_timer backup_file_size backup_mount_options backup_mount_point_base
=
$state_path/backup_mount
backup_sha_block_size_bytes
= 32768
backup_share
= None
= 1999994880
= None
= None
= True
Description
(StrOpt) Custom container to use for backups.
(BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage.
The default value is True to enable the timer.
(IntOpt) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files. backup_file_size must be a multiple of backup_sha_block_size_bytes.
(StrOpt) Mount options passed to the NFS client.
See NFS man page for details.
(StrOpt) Base dir containing mount point for NFS share.
(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes.
(StrOpt) NFS share in fqdn:path, ipv4addr:path, or
"[ipv6addr]:path" format.
2.4. BLOCK STORAGE SAMPLE CONFIGURATION FILES
All the files in this section can be found in /etc/cinder.
2.4.1. cinder.conf
The cinder.conf file is installed in /etc/cinder by default. When you manually install the Block
Storage service, the options in the cinder.conf file are set to default values.
114
The cinder.conf file contains most of the options to configure the Block Storage service.
[DEFAULT]
#
# Options defined in oslo.messaging
#
# ZeroMQ bind address. Should be a wildcard (*), an ethernet
# interface, or IP. The "host" option should point or resolve
# to this address. (string value)
CHAPTER 2. BLOCK STORAGE
#rpc_zmq_bind_address=*
# MatchMaker driver. (string value)
#rpc_zmq_matchmaker=local
# ZeroMQ receiver listening port. (integer value)
#rpc_zmq_port=9501
# Number of ZeroMQ contexts, defaults to 1. (integer value)
#rpc_zmq_contexts=1
# Maximum number of ingress messages to locally buffer per
# topic. Default is unlimited. (integer value)
#rpc_zmq_topic_backlog=<None>
# Directory for holding IPC sockets. (string value)
#rpc_zmq_ipc_dir=/var/run/openstack
# Name of this node. Must be a valid hostname, FQDN, or IP
# address. Must match "host" option, if running Nova. (string
# value)
#rpc_zmq_host=cinder
# Seconds to wait before a cast expires (TTL). Only supported
# by impl_zmq. (integer value)
#rpc_cast_timeout=30
# Heartbeat frequency. (integer value)
#matchmaker_heartbeat_freq=300
# Heartbeat time-to-live. (integer value)
#matchmaker_heartbeat_ttl=600
# Size of RPC thread pool. (integer value)
#rpc_thread_pool_size=64
# Driver or drivers to handle sending notifications. (multi
# valued)
#notification_driver=
# AMQP topic used for OpenStack notifications. (list value)
# Deprecated group/name - [rpc_notifier2]/topics
#notification_topics=notifications
# Seconds to wait for a response from a call. (integer value)
#rpc_response_timeout=60
# A URL representing the messaging driver to use and its full
# configuration. If not set, we fall back to the rpc_backend
# option and driver specific configuration. (string value)
#transport_url=<None>
# The messaging driver to use, defaults to rabbit. Other
# drivers include qpid and zmq. (string value)
#rpc_backend=rabbit
115
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The default exchange under which topics are scoped. May be
# overridden by an exchange name specified in the
# transport_url option. (string value)
#control_exchange=openstack
#
# Options defined in cinder.exception
#
# Make exception message format errors fatal. (boolean value)
#fatal_exception_format_errors=false
#
# Options defined in cinder.quota
#
# Number of volumes allowed per project (integer value)
#quota_volumes=10
# Number of volume snapshots allowed per project (integer
# value)
#quota_snapshots=10
# Number of consistencygroups allowed per project (integer
# value)
#quota_consistencygroups=10
# Total amount of storage, in gigabytes, allowed for volumes
# and snapshots per project (integer value)
#quota_gigabytes=1000
# Number of volume backups allowed per project (integer value)
#quota_backups=10
# Total amount of storage, in gigabytes, allowed for backups
# per project (integer value)
#quota_backup_gigabytes=1000
# Number of seconds until a reservation expires (integer
# value)
#reservation_expire=86400
# Count of reservations until usage is refreshed (integer
# value)
#until_refresh=0
# Number of seconds between subsequent usage refreshes
# (integer value)
#max_age=0
# Default driver to use for quota checks (string value)
#quota_driver=cinder.quota.DbQuotaDriver
# Enables or disables use of default quota class with default
116
CHAPTER 2. BLOCK STORAGE
# quota. (boolean value)
#use_default_quota_class=true
#
# Options defined in cinder.service
#
# Interval, in seconds, between nodes reporting state to
# datastore (integer value)
#report_interval=10
# Interval, in seconds, between running periodic tasks
# (integer value)
#periodic_interval=60
# Range, in seconds, to randomly delay when starting the
# periodic task scheduler to reduce stampeding. (Disable by
# setting to 0) (integer value)
#periodic_fuzzy_delay=60
# IP address on which OpenStack Volume API listens (string
# value)
#osapi_volume_listen=0.0.0.0
# Port on which OpenStack Volume API listens (integer value)
#osapi_volume_listen_port=8776
# Number of workers for OpenStack Volume API service. The
# default is equal to the number of CPUs available. (integer
# value)
#osapi_volume_workers=<None>
#
# Options defined in cinder.ssh_utils
#
# Option to enable strict host key checking. When set to
# "True" Cinder will only connect to systems with a host key
# present in the configured "ssh_hosts_key_file". When set to
# "False" the host key will be saved upon first connection and
# used for subsequent connections. Default=False (boolean
# value)
#strict_ssh_host_key_policy=false
# File containing SSH host keys for the systems with which
# Cinder needs to communicate. OPTIONAL:
# Default=$state_path/ssh_known_hosts (string value)
#ssh_hosts_key_file=$state_path/ssh_known_hosts
#
# Options defined in cinder.test
#
117
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# File name of clean sqlite db (string value)
#sqlite_clean_db=clean.sqlite
#
# Options defined in cinder.wsgi
#
# Maximum line size of message headers to be accepted.
# max_header_line may need to be increased when using large
# tokens (typically those generated by the Keystone v3 API
# with big service catalogs). (integer value)
#max_header_line=16384
# Timeout for client connections' socket operations. If an
# incoming connection is idle for this number of seconds it
# will be closed. A value of '0' means wait forever. (integer
# value)
#client_socket_timeout=900
# If False, closes the client socket connection explicitly.
# Setting it to True to maintain backward compatibility.
# Recommended setting is set it to False. (boolean value)
#wsgi_keep_alive=true
# Sets the value of TCP_KEEPALIVE (True/False) for each server
# socket. (boolean value)
#tcp_keepalive=true
# Sets the value of TCP_KEEPIDLE in seconds for each server
# socket. Not supported on OS X. (integer value)
#tcp_keepidle=600
# Sets the value of TCP_KEEPINTVL in seconds for each server
# socket. Not supported on OS X. (integer value)
#tcp_keepalive_interval=<None>
# Sets the value of TCP_KEEPCNT for each server socket. Not
# supported on OS X. (integer value)
#tcp_keepalive_count=<None>
# CA certificate file to use to verify connecting clients
# (string value)
#ssl_ca_file=<None>
# Certificate file to use when starting the server securely
# (string value)
#ssl_cert_file=<None>
# Private key file to use when starting the server securely
# (string value)
#ssl_key_file=<None>
#
# Options defined in cinder.api.common
118
CHAPTER 2. BLOCK STORAGE
#
# The maximum number of items that a collection resource
# returns in a single response (integer value)
#osapi_max_limit=1000
# Base URL that will be presented to users in links to the
# OpenStack Volume API (string value)
# Deprecated group/name - [DEFAULT]/osapi_compute_link_prefix
#osapi_volume_base_URL=<None>
#
# Options defined in cinder.api.middleware.auth
#
# Treat X-Forwarded-For as the canonical remote address. Only
# enable this if you have a sanitizing proxy. (boolean value)
#use_forwarded_for=false
#
# Options defined in cinder.api.middleware.sizelimit
#
# Max size for body of a request (integer value)
#osapi_max_request_body_size=114688
#
# Options defined in cinder.api.views.versions
#
# Public url to use for versions endpoint. The default is
# None, which will use the request's host_url attribute to
# populate the URL base. If Cinder is operating behind a
# proxy, you will want to change this to represent the proxy's
# URL. (string value)
#public_endpoint=<None>
#
# Options defined in cinder.backup.chunkeddriver
#
# Compression algorithm (None to disable) (string value)
#backup_compression_algorithm=zlib
#
# Options defined in cinder.backup.driver
#
# Backup metadata version to be used when backing up volume
# metadata. If this number is bumped, make sure the service
# doing the restore supports the new version. (integer value)
119
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#backup_metadata_version=2
# The number of chunks or objects, for which one Ceilometer
# notification will be sent (integer value)
#backup_object_number_per_notification=10
# Interval, in seconds, between two progress notifications
# reporting the backup status (integer value)
#backup_timer_interval=120
#
# Options defined in cinder.backup.drivers.ceph
#
# Ceph configuration file to use. (string value)
#backup_ceph_conf=/etc/ceph/ceph.conf
# The Ceph user to connect with. Default here is to use the
# same user as for Cinder volumes. If not using cephx this
# should be set to None. (string value)
#backup_ceph_user=cinder
# The chunk size, in bytes, that a backup is broken into
# before transfer to the Ceph object store. (integer value)
#backup_ceph_chunk_size=134217728
# The Ceph pool where volume backups are stored. (string
# value)
#backup_ceph_pool=backups
# RBD stripe unit to use when creating a backup image.
# (integer value)
#backup_ceph_stripe_unit=0
# RBD stripe count to use when creating a backup image.
# (integer value)
#backup_ceph_stripe_count=0
# If True, always discard excess bytes when restoring volumes
# i.e. pad with zeroes. (boolean value)
#restore_discard_excess_bytes=true
#
# Options defined in cinder.backup.drivers.nfs
#
# The maximum size in bytes of the files used to hold backups.
# If the volume being backed up exceeds this size, then it
# will be backed up into multiple files. (integer value)
#backup_file_size=1999994880
# The size in bytes that changes are tracked for incremental
# backups. backup_swift_object_size has to be multiple of
# backup_swift_block_size. (integer value)
120
CHAPTER 2. BLOCK STORAGE
#backup_sha_block_size_bytes=32768
# Enable or Disable the timer to send the periodic progress
# notifications to Ceilometer when backing up the volume to
# the backend storage. The default value is True to enable the
# timer. (boolean value)
#backup_enable_progress_timer=true
# Base dir containing mount point for NFS share. (string
# value)
#backup_mount_point_base=$state_path/backup_mount
# NFS share in fqdn:path, ipv4addr:path, or "[ipv6addr]:path"
# format. (string value)
#backup_share=<None>
# Mount options passed to the NFS client. See NFS man page for
# details. (string value)
#backup_mount_options=<None>
# Custom container to use for backups. (string value)
#backup_container=<None>
#
# Options defined in cinder.backup.drivers.swift
#
# The URL of the Swift endpoint (string value)
#backup_swift_url=<None>
# Info to match when looking for swift in the service catalog.
# Format is: separated values of the form:
# <service_type>:<service_name>:<endpoint_type> - Only used if
# backup_swift_url is unset (string value)
#swift_catalog_info=object-store:swift:publicURL
# Swift authentication mechanism (string value)
#backup_swift_auth=per_user
# Swift authentication version. Specify "1" for auth 1.0, or
# "2" for auth 2.0 (string value)
#backup_swift_auth_version=1
# Swift tenant/account name. Required when connecting to an
# auth 2.0 system (string value)
#backup_swift_tenant=<None>
# Swift user name (string value)
#backup_swift_user=<None>
# Swift key for authentication (string value)
#backup_swift_key=<None>
# The default Swift container to use (string value)
#backup_swift_container=volumebackups
121
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The size in bytes of Swift backup objects (integer value)
#backup_swift_object_size=52428800
# The size in bytes that changes are tracked for incremental
# backups. backup_swift_object_size has to be multiple of
# backup_swift_block_size. (integer value)
#backup_swift_block_size=32768
# The number of retries to make for Swift operations (integer
# value)
#backup_swift_retry_attempts=3
# The backoff time in seconds between Swift retries (integer
# value)
#backup_swift_retry_backoff=2
# Enable or Disable the timer to send the periodic progress
# notifications to Ceilometer when backing up the volume to
# the Swift backend storage. The default value is True to
# enable the timer. (boolean value)
#backup_swift_enable_progress_timer=true
#
# Options defined in cinder.backup.drivers.tsm
#
# Volume prefix for the backup id when backing up to TSM
# (string value)
#backup_tsm_volume_prefix=backup
# TSM password for the running username (string value)
#backup_tsm_password=password
# Enable or Disable compression for backups (boolean value)
#backup_tsm_compression=true
#
# Options defined in cinder.backup.manager
#
# Driver to use for backups. (string value)
# Deprecated group/name - [DEFAULT]/backup_service
#backup_driver=cinder.backup.drivers.swift
#
# Options defined in cinder.cmd.volume
#
# Backend override of host value. (string value)
# Deprecated group/name - [DEFAULT]/host
#backend_host=<None>
122
CHAPTER 2. BLOCK STORAGE
#
# Options defined in cinder.cmd.volume_usage_audit
#
# If this option is specified then the start time specified is
# used instead of the start time of the last completed audit
# period. (string value)
#start_time=<None>
# If this option is specified then the end time specified is
# used instead of the end time of the last completed audit
# period. (string value)
#end_time=<None>
# Send the volume and snapshot create and delete notifications
# generated in the specified period. (boolean value)
#send_actions=false
#
# Options defined in cinder.common.config
#
# File name for the paste.deploy config for cinder-api (string
# value)
#api_paste_config=api-paste.ini
# Top-level directory for maintaining cinder's state (string
# value)
# Deprecated group/name - [DEFAULT]/pybasedir
#state_path=/var/lib/cinder
# IP address of this host (string value)
#my_ip=10.0.0.1
# Default glance host name or IP (string value)
#glance_host=$my_ip
# Default glance port (integer value)
#glance_port=9292
# A list of the glance API servers available to cinder
# ([hostname|ip]:port) (list value)
#glance_api_servers=$glance_host:$glance_port
# Version of the glance API to use (integer value)
#glance_api_version=1
# Number retries when downloading an image from glance
# (integer value)
#glance_num_retries=0
# Allow to perform insecure SSL (https) requests to glance
# (boolean value)
#glance_api_insecure=false
123
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Enables or disables negotiation of SSL layer compression. In
# some cases disabling compression can improve data
# throughput, such as when high network bandwidth is available
# and you use compressed image formats like qcow2. (boolean
# value)
#glance_api_ssl_compression=false
# Location of ca certificates file to use for glance client
# requests. (string value)
#glance_ca_certificates_file=<None>
# http/https timeout value for glance operations. If no value
# (None) is supplied here, the glanceclient default value is
# used. (integer value)
#glance_request_timeout=<None>
# The topic that scheduler nodes listen on (string value)
#scheduler_topic=cinder-scheduler
# The topic that volume nodes listen on (string value)
#volume_topic=cinder-volume
# The topic that volume backup nodes listen on (string value)
#backup_topic=cinder-backup
# DEPRECATED: Deploy v1 of the Cinder API. (boolean value)
#enable_v1_api=true
# Deploy v2 of the Cinder API. (boolean value)
#enable_v2_api=true
# Enables or disables rate limit of the API. (boolean value)
#api_rate_limit=true
# Specify list of extensions to load when using
# osapi_volume_extension option with
# cinder.api.contrib.select_extensions (list value)
#osapi_volume_ext_list=
# osapi volume extension to load (multi valued)
#osapi_volume_extension=cinder.api.contrib.standard_extensions
# Full class name for the Manager for volume (string value)
#volume_manager=cinder.volume.manager.VolumeManager
# Full class name for the Manager for volume backup (string
# value)
#backup_manager=cinder.backup.manager.BackupManager
# Full class name for the Manager for scheduler (string value)
#scheduler_manager=cinder.scheduler.manager.SchedulerManager
# Name of this node. This can be an opaque identifier. It is
# not necessarily a host name, FQDN, or IP address. (string
# value)
124
CHAPTER 2. BLOCK STORAGE
#host=cinder
# Availability zone of this node (string value)
#storage_availability_zone=nova
# Default availability zone for new volumes. If not set, the
# storage_availability_zone option value is used as the
# default for new volumes. (string value)
#default_availability_zone=<None>
# Default volume type to use (string value)
#default_volume_type=<None>
# Time period for which to generate volume usages. The options
# are hour, day, month, or year. (string value)
#volume_usage_audit_period=month
# Path to the rootwrap configuration file to use for running
# commands as root (string value)
#rootwrap_config=/etc/cinder/rootwrap.conf
# Enable monkey patching (boolean value)
#monkey_patch=false
# List of modules/decorators to monkey patch (list value)
#monkey_patch_modules=
# Maximum time since last check-in for a service to be
# considered up (integer value)
#service_down_time=60
# The full class name of the volume API class to use (string
# value)
#volume_api_class=cinder.volume.api.API
# The full class name of the volume backup API class (string
# value)
#backup_api_class=cinder.backup.api.API
# The strategy to use for auth. Supports noauth, keystone, and
# deprecated. (string value)
#auth_strategy=noauth
# A list of backend names to use. These backend names should
# be backed by a unique [CONFIG] group with its options (list
# value)
#enabled_backends=<None>
# Whether snapshots count against gigabyte quota (boolean
# value)
#no_snapshot_gb_quota=false
# The full class name of the volume transfer API class (string
# value)
#transfer_api_class=cinder.transfer.api.API
125
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The full class name of the volume replication API class
# (string value)
#replication_api_class=cinder.replication.api.API
# The full class name of the consistencygroup API class
# (string value)
#consistencygroup_api_class=cinder.consistencygroup.api.API
# OpenStack privileged account username. Used for requests to
# other services (such as Nova) that require an account with
# special rights. (string value)
#os_privileged_user_name=<None>
# Password associated with the OpenStack privileged account.
# (string value)
#os_privileged_user_password=<None>
# Tenant name associated with the OpenStack privileged
# account. (string value)
#os_privileged_user_tenant=<None>
#
# Options defined in cinder.compute
#
# The full class name of the compute API class to use (string
# value)
#compute_api_class=cinder.compute.nova.API
#
# Options defined in cinder.compute.nova
#
# Match this value when searching for nova in the service
# catalog. Format is: separated values of the form:
# <service_type>:<service_name>:<endpoint_type> (string value)
#nova_catalog_info=compute:Compute Service:publicURL
# Same as nova_catalog_info, but for admin endpoint. (string
# value)
#nova_catalog_admin_info=compute:Compute Service:adminURL
# Override service catalog lookup with template for nova
# endpoint e.g. http://localhost:8774/v2/%(project_id)s
# (string value)
#nova_endpoint_template=<None>
# Same as nova_endpoint_template, but for admin endpoint.
# (string value)
#nova_endpoint_admin_template=<None>
# Region name of this node (string value)
#os_region_name=<None>
126
CHAPTER 2. BLOCK STORAGE
# Location of ca certificates file to use for nova client
# requests. (string value)
#nova_ca_certificates_file=<None>
# Allow to perform insecure SSL requests to nova (boolean
# value)
#nova_api_insecure=false
#
# Options defined in cinder.db.api
#
# Services to be added to the available pool on create
# (boolean value)
#enable_new_services=true
# Template string to be used to generate volume names (string
# value)
#volume_name_template=volume-%s
# Template string to be used to generate snapshot names
# (string value)
#snapshot_name_template=snapshot-%s
# Template string to be used to generate backup names (string
# value)
#backup_name_template=backup-%s
#
# Options defined in cinder.db.base
#
# Driver to use for database access (string value)
#db_driver=cinder.db
#
# Options defined in cinder.image.glance
#
# Default core properties of image (list value)
#glance_core_properties=checksum,container_format,disk_format,image_name, image_id,min_disk,min_ram,name,size
# A list of url schemes that can be downloaded directly via
# the direct_url. Currently supported schemes: [file]. (list
# value)
#allowed_direct_url_schemes=
#
# Options defined in cinder.image.image_utils
#
127
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Directory used for temporary storage during image conversion
# (string value)
#image_conversion_dir=$state_path/conversion
#
# Options defined in cinder.openstack.common.eventlet_backdoor
#
# Enable eventlet backdoor. Acceptable values are 0, <port>,
# and <start>:<end>, where 0 results in listening on a random
# tcp port number; <port> results in listening on the
# specified port number (and not enabling backdoor if that
# port is in use); and <start>:<end> results in listening on
# the smallest unused port number within the specified range
# of port numbers. The chosen port is displayed in the
# service's log file. (string value)
#backdoor_port=<None>
#
# Options defined in cinder.openstack.common.periodic_task
#
# Some periodic tasks can be run in a separate process. Should
# we run them here? (boolean value)
#run_external_periodic_tasks=true
#
# Options defined in cinder.openstack.common.policy
#
# The JSON file that defines policies. (string value)
#policy_file=policy.json
# Default rule. Enforced when a requested rule is not found.
# (string value)
#policy_default_rule=default
# Directories where policy configuration files are stored.
# They can be relative to any directory in the search path
# defined by the config_dir option, or absolute paths. The
# file defined by policy_file must exist for these directories
# to be searched. Missing or empty directories are ignored.
# (multi valued)
#policy_dirs=policy.d
#
# Options defined in cinder.openstack.common.versionutils
#
# Enables or disables fatal status of deprecations. (boolean
# value)
#fatal_deprecations=false
128
CHAPTER 2. BLOCK STORAGE
#
# Options defined in cinder.scheduler.driver
#
# The scheduler host manager class to use (string value)
#scheduler_host_manager=cinder.scheduler.host_manager.HostManager
# Maximum number of attempts to schedule an volume (integer
# value)
#scheduler_max_attempts=3
#
# Options defined in cinder.scheduler.host_manager
#
# Which filter class names to use for filtering hosts when not
# specified in the request. (list value)
#scheduler_default_filters=AvailabilityZoneFilter,CapacityFilter,Capabili tiesFilter
# Which weigher class names to use for weighing hosts. (list
# value)
#scheduler_default_weighers=CapacityWeigher
#
# Options defined in cinder.scheduler.manager
#
# Default scheduler driver to use (string value)
#scheduler_driver=cinder.scheduler.filter_scheduler.FilterScheduler
#
# Options defined in cinder.scheduler.scheduler_options
#
# Absolute path to scheduler configuration JSON file. (string
# value)
#scheduler_json_config_location=
#
# Options defined in cinder.scheduler.simple
#
# This configure option has been deprecated along with the
# SimpleScheduler. New scheduler is able to gather capacity
# information for each host, thus setting the maximum number
# of volume gigabytes for host is no longer needed. It's safe
# to remove this configure from cinder.conf. (integer value)
#max_gigabytes=10000
129
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#
# Options defined in cinder.scheduler.weights.capacity
#
# Multiplier used for weighing volume capacity. Negative
# numbers mean to stack vs spread. (floating point value)
#capacity_weight_multiplier=1.0
# Multiplier used for weighing volume capacity. Negative
# numbers mean to stack vs spread. (floating point value)
#allocated_capacity_weight_multiplier=-1.0
#
# Options defined in cinder.scheduler.weights.volume_number
#
# Multiplier used for weighing volume number. Negative numbers
# mean to spread vs stack. (floating point value)
#volume_number_multiplier=-1.0
#
# Options defined in cinder.transfer.api
#
# The number of characters in the salt. (integer value)
#volume_transfer_salt_length=8
# The number of characters in the autogenerated auth key.
# (integer value)
#volume_transfer_key_length=16
#
# Options defined in cinder.volume.api
#
# Cache volume availability zones in memory for the provided
# duration in seconds (integer value)
#az_cache_duration=3600
# Create volume from snapshot at the host where snapshot
# resides (boolean value)
#snapshot_same_host=true
# Ensure that the new volumes are the same AZ as snapshot or
# source volume (boolean value)
#cloned_volume_same_az=true
#
# Options defined in cinder.volume.driver
#
130
CHAPTER 2. BLOCK STORAGE
# The maximum number of times to rescan iSER targetto find
# volume (integer value)
#num_iser_scan_tries=3
# This option is deprecated and unused. It will be removed in
# the Liberty release. (integer value)
#iser_num_targets=<None>
# Prefix for iSER volumes (string value)
#iser_target_prefix=iqn.2010-10.org.openstack:
# The IP address that the iSER daemon is listening on (string
# value)
#iser_ip_address=$my_ip
# The port that the iSER daemon is listening on (integer
# value)
#iser_port=3260
# The name of the iSER target user-land tool to use (string
# value)
#iser_helper=tgtadm
# Number of times to attempt to run flakey shell commands
# (integer value)
#num_shell_tries=3
# The percentage of backend capacity is reserved (integer
# value)
#reserved_percentage=0
# This option is deprecated and unused. It will be removed in
# the Liberty release. (integer value)
#iscsi_num_targets=<None>
# Prefix for iSCSI volumes (string value)
#iscsi_target_prefix=iqn.2010-10.org.openstack:
# The IP address that the iSCSI daemon is listening on (string
# value)
#iscsi_ip_address=$my_ip
# The list of secondary IP addresses of the iSCSI daemon (list
# value)
#iscsi_secondary_ip_addresses=
# The port that the iSCSI daemon is listening on (integer
# value)
#iscsi_port=3260
# The maximum number of times to rescan targets to find volume
# (integer value)
# Deprecated group/name - [DEFAULT]/num_iscsi_scan_tries
#num_volume_device_scan_tries=3
# The backend name for a given driver implementation (string
131
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# value)
#volume_backend_name=<None>
# Do we attach/detach volumes in cinder using multipath for
# volume to image and image to volume transfers? (boolean
# value)
#use_multipath_for_image_xfer=false
# If this is set to True, attachment of volumes for image
# transfer will be aborted when multipathd is not running.
# Otherwise, it will fallback to single path. (boolean value)
#enforce_multipath_for_image_xfer=false
# Method used to wipe old volumes (string value)
#volume_clear=zero
# Size in MiB to wipe at start of old volumes. 0 => all
# (integer value)
#volume_clear_size=0
# The flag to pass to ionice to alter the i/o priority of the
# process used to zero a volume after deletion, for example
# "-c3" for idle only priority. (string value)
#volume_clear_ionice=<None>
# iSCSI target user-land tool to use. tgtadm is default, use
# lioadm for LIO iSCSI support, scstadmin for SCST target
# support, iseradm for the ISER protocol, ietadm for iSCSI
# Enterprise Target, iscsictl for Chelsio iSCSI Target or fake
# for testing. (string value)
#iscsi_helper=tgtadm
# Volume configuration file storage directory (string value)
#volumes_dir=$state_path/volumes
# IET configuration file (string value)
#iet_conf=/etc/iet/ietd.conf
# Chiscsi (CXT) global defaults configuration file (string
# value)
#chiscsi_conf=/etc/chelsio-iscsi/chiscsi.conf
# This option is deprecated and unused. It will be removed in
# the next release. (string value)
#lio_initiator_iqns=
# Sets the behavior of the iSCSI target to either perform
# blockio or fileio optionally, auto can be set and Cinder
# will autodetect type of backing device (string value)
#iscsi_iotype=fileio
# The default block size used when copying/clearing volumes
# (string value)
#volume_dd_blocksize=1M
# The blkio cgroup name to be used to limit bandwidth of
132
CHAPTER 2. BLOCK STORAGE
# volume copy (string value)
#volume_copy_blkio_cgroup_name=cinder-volume-copy
# The upper limit of bandwidth of volume copy. 0 => unlimited
# (integer value)
#volume_copy_bps_limit=0
# Sets the behavior of the iSCSI target to either perform
# write-back(on) or write-through(off). This parameter is
# valid if iscsi_helper is set to tgtadm or iseradm. (string
# value)
#iscsi_write_cache=on
# Determines the iSCSI protocol for new iSCSI volumes, created
# with tgtadm or lioadm target helpers. In order to enable
# RDMA, this parameter should be set with the value "iser".
# The supported iSCSI protocol values are "iscsi" and "iser".
# (string value)
#iscsi_protocol=iscsi
# The path to the client certificate key for verification, if
# the driver supports it. (string value)
#driver_client_cert_key=<None>
# The path to the client certificate for verification, if the
# driver supports it. (string value)
#driver_client_cert=<None>
# Tell driver to use SSL for connection to backend storage if
# the driver supports it. (boolean value)
#driver_use_ssl=false
# Float representation of the over subscription ratio when
# thin provisioning is involved. Default ratio is 20.0,
# meaning provisioned capacity can be 20 times of the total
# physical capacity. If the ratio is 10.5, it means
# provisioned capacity can be 10.5 times of the total physical
# capacity. A ratio of 1.0 means provisioned capacity cannot
# exceed the total physical capacity. A ratio lower than 1.0
# will be ignored and the default value will be used instead.
# (floating point value)
#max_over_subscription_ratio=20.0
# Certain ISCSI targets have predefined target names, SCST
# target driver uses this name. (string value)
#scst_target_iqn_name=<None>
# SCST target implementation can choose from multiple SCST
# target drivers. (string value)
#scst_target_driver=iscsi
# Option to enable/disable CHAP authentication for targets.
# (boolean value)
# Deprecated group/name - [DEFAULT]/eqlx_use_chap
#use_chap_auth=false
133
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# CHAP user name. (string value)
# Deprecated group/name - [DEFAULT]/eqlx_chap_login
#chap_username=
# Password for specified CHAP account name. (string value)
# Deprecated group/name - [DEFAULT]/eqlx_chap_password
#chap_password=
# Namespace for driver private data values to be saved in.
# (string value)
#driver_data_namespace=<None>
# String representation for an equation that will be used to
# filter hosts. Only used when the driver filter is set to be
# used by the Cinder scheduler. (string value)
#filter_function=<None>
# String representation for an equation that will be used to
# determine the goodness of a host. Only used when using the
# goodness weigher is set to be used by the Cinder scheduler.
# (string value)
#goodness_function=<None>
#
# Options defined in cinder.volume.drivers.block_device
#
# List of all available devices (list value)
#available_devices=
#
# Options defined in cinder.volume.drivers.cloudbyte.options
#
# These values will be used for CloudByte storage's addQos API
# call. (dict value)
#cb_add_qosgroup=latency:15,iops:10,graceallowed:false,iopscontrol:true,m emlimit:0,throughput:0,tpcontrol:false,networkspeed:0
# Driver will use this API key to authenticate against the
# CloudByte storage's management interface. (string value)
#cb_apikey=None
# CloudByte storage specific account name. This maps to a
# project name in OpenStack. (string value)
#cb_account_name=None
# This corresponds to the name of Tenant Storage Machine (TSM)
# in CloudByte storage. A volume will be created in this TSM.
# (string value)
#cb_tsm_name=None
# A retry value in seconds. Will be used by the driver to
# check if volume creation was successful in CloudByte
134
CHAPTER 2. BLOCK STORAGE
# storage. (integer value)
#cb_confirm_volume_create_retry_interval=5
# Will confirm a successful volume creation in CloudByte
# storage by making this many number of attempts. (integer
# value)
#cb_confirm_volume_create_retries=3
# These values will be used for CloudByte storage's
# createVolume API call. (dict value)
#cb_create_volume=compression:off,deduplication:off,blocklength:512B,sync
:always,protocoltype:ISCSI,recordsize:16k
#
# Options defined in cinder.volume.drivers.datera
#
# DEPRECATED: This will be removed in the Liberty release. Use
# san_login and san_password instead. This directly sets the
# Datera API token. (string value)
#datera_api_token=<None>
# Datera API port. (string value)
#datera_api_port=7717
# Datera API version. (string value)
#datera_api_version=1
# Number of replicas to create of an inode. (string value)
#datera_num_replicas=3
#
# Options defined in cinder.volume.drivers.dell.dell_storagecenter_common
#
# Storage Center System Serial Number (integer value)
#dell_sc_ssn=64702
# Dell API port (integer value)
#dell_sc_api_port=3033
# Name of the server folder to use on the Storage Center
# (string value)
#dell_sc_server_folder=openstack
# Name of the volume folder to use on the Storage Center
# (string value)
#dell_sc_volume_folder=openstack
#
# Options defined in cinder.volume.drivers.emc.emc_vmax_common
#
135
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# use this file for cinder emc plugin config data (string
# value)
#cinder_emc_config_file=/etc/cinder/cinder_emc_config.xml
#
# Options defined in cinder.volume.drivers.emc.emc_vnx_cli
#
# VNX authentication scope type. (string value)
#storage_vnx_authentication_type=global
# Directory path that contains the VNX security file. Make
# sure the security file is generated first. (string value)
#storage_vnx_security_file_dir=<None>
# Naviseccli Path. (string value)
#naviseccli_path=
# Storage pool name. (string value)
#storage_vnx_pool_name=<None>
# VNX secondary SP IP Address. (string value)
#san_secondary_ip=<None>
# Default timeout for CLI operations in minutes. For example,
# LUN migration is a typical long running operation, which
# depends on the LUN size and the load of the array. An upper
# bound in the specific deployment can be set to avoid
# unnecessary long wait. By default, it is 365 days long.
# (integer value)
#default_timeout=525600
# Default max number of LUNs in a storage group. By default,
# the value is 255. (integer value)
#max_luns_per_storage_group=255
# To destroy storage group when the last LUN is removed from
# it. By default, the value is False. (boolean value)
#destroy_empty_storage_group=false
# Mapping between hostname and its iSCSI initiator IP
# addresses. (string value)
#iscsi_initiators=
# Automatically register initiators. By default, the value is
# False. (boolean value)
#initiator_auto_registration=false
# Automatically deregister initiators after the related
# storage group is destroyed. By default, the value is False.
# (boolean value)
#initiator_auto_deregistration=false
# Report free_capacity_gb as 0 when the limit to maximum
# number of pool LUNs is reached. By default, the value is
136
CHAPTER 2. BLOCK STORAGE
# False. (boolean value)
#check_max_pool_luns_threshold=false
# Delete a LUN even if it is in Storage Groups. (boolean
# value)
#force_delete_lun_in_storagegroup=false
#
# Options defined in cinder.volume.drivers.emc.xtremio
#
# XMS cluster id in multi-cluster environment (string value)
#xtremio_cluster_name=
#
# Options defined in cinder.volume.drivers.eqlx
#
# Group name to use for creating volumes. Defaults to
# "group-0". (string value)
#eqlx_group_name=group-0
# Timeout for the Group Manager cli command execution. Default
# is 30. (integer value)
#eqlx_cli_timeout=30
# Maximum retry count for reconnection. Default is 5. (integer
# value)
#eqlx_cli_max_retries=5
# Use CHAP authentication for targets. Note that this option
# is deprecated in favour of "use_chap_auth" as specified in
# cinder/volume/driver.py and will be removed in next release.
# (boolean value)
#eqlx_use_chap=false
# Existing CHAP account name. Note that this option is
# deprecated in favour of "chap_username" as specified in
# cinder/volume/driver.py and will be removed in next release.
# (string value)
#eqlx_chap_login=admin
# Password for specified CHAP account name. Note that this
# option is deprecated in favour of "chap_password" as
# specified in cinder/volume/driver.py and will be removed in
# the next release (string value)
#eqlx_chap_password=password
# Pool in which volumes will be created. Defaults to
# "default". (string value)
#eqlx_pool=default
#
137
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Options defined in cinder.volume.drivers.glusterfs
#
# File with the list of available gluster shares (string
# value)
#glusterfs_shares_config=/etc/cinder/glusterfs_shares
# Create volumes as sparsed files which take no space.If set
# to False volume is created as regular file.In such case
# volume creation takes a lot of time. (boolean value)
#glusterfs_sparsed_volumes=true
# Create volumes as QCOW2 files rather than raw files.
# (boolean value)
#glusterfs_qcow2_volumes=false
# Base dir containing mount points for gluster shares. (string
# value)
#glusterfs_mount_point_base=$state_path/mnt
#
# Options defined in cinder.volume.drivers.hds.hds
#
# The configuration file for the Cinder HDS driver for HUS
# (string value)
#hds_cinder_config_file=/opt/hds/hus/cinder_hus_conf.xml
#
# Options defined in cinder.volume.drivers.hds.iscsi
#
# Configuration file for HDS iSCSI cinder plugin (string
# value)
#hds_hnas_iscsi_config_file=/opt/hds/hnas/cinder_iscsi_conf.xml
#
# Options defined in cinder.volume.drivers.hds.nfs
#
# Configuration file for HDS NFS cinder plugin (string value)
#hds_hnas_nfs_config_file=/opt/hds/hnas/cinder_nfs_conf.xml
#
# Options defined in cinder.volume.drivers.hitachi.hbsd_common
#
# Serial number of storage system (string value)
#hitachi_serial_number=<None>
# Name of an array unit (string value)
#hitachi_unit_name=<None>
138
CHAPTER 2. BLOCK STORAGE
# Pool ID of storage system (integer value)
#hitachi_pool_id=<None>
# Thin pool ID of storage system (integer value)
#hitachi_thin_pool_id=<None>
# Range of logical device of storage system (string value)
#hitachi_ldev_range=<None>
# Default copy method of storage system (string value)
#hitachi_default_copy_method=FULL
# Copy speed of storage system (integer value)
#hitachi_copy_speed=3
# Interval to check copy (integer value)
#hitachi_copy_check_interval=3
# Interval to check copy asynchronously (integer value)
#hitachi_async_copy_check_interval=10
# Control port names for HostGroup or iSCSI Target (string
# value)
#hitachi_target_ports=<None>
# Range of group number (string value)
#hitachi_group_range=<None>
# Request for creating HostGroup or iSCSI Target (boolean
# value)
#hitachi_group_request=false
#
# Options defined in cinder.volume.drivers.hitachi.hbsd_fc
#
# Request for FC Zone creating HostGroup (boolean value)
#hitachi_zoning_request=false
#
# Options defined in cinder.volume.drivers.hitachi.hbsd_horcm
#
# Instance numbers for HORCM (string value)
#hitachi_horcm_numbers=200,201
# Username of storage system for HORCM (string value)
#hitachi_horcm_user=<None>
# Password of storage system for HORCM (string value)
#hitachi_horcm_password=<None>
# Add to HORCM configuration (boolean value)
139
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#hitachi_horcm_add_conf=true
#
# Options defined in cinder.volume.drivers.hitachi.hbsd_iscsi
#
# Add CHAP user (boolean value)
#hitachi_add_chap_user=false
# iSCSI authentication method (string value)
#hitachi_auth_method=<None>
# iSCSI authentication username (string value)
#hitachi_auth_user=HBSD-CHAP-user
# iSCSI authentication password (string value)
#hitachi_auth_password=HBSD-CHAP-password
#
# Options defined in cinder.volume.drivers.huawei
#
# The configuration file for the Cinder Huawei driver (string
# value)
#cinder_huawei_conf_file=/etc/cinder/cinder_huawei_conf.xml
#
# Options defined in cinder.volume.drivers.ibm.flashsystem
#
# Connection protocol should be FC. (string value)
#flashsystem_connection_protocol=FC
# Connect with multipath (FC only). (boolean value)
#flashsystem_multipath_enabled=false
# Allows vdisk to multi host mapping. (boolean value)
#flashsystem_multihostmap_enabled=true
#
# Options defined in cinder.volume.drivers.ibm.gpfs
#
# Specifies the path of the GPFS directory where Block Storage
# volume and snapshot files are stored. (string value)
#gpfs_mount_point_base=<None>
# Specifies the path of the Image service repository in GPFS.
# Leave undefined if not storing images in GPFS. (string
# value)
#gpfs_images_dir=<None>
140
CHAPTER 2. BLOCK STORAGE
# Specifies the type of image copy to be used. Set this when
# the Image service repository also uses GPFS so that image
# files can be transferred efficiently from the Image service
# to the Block Storage service. There are two valid values:
# "copy" specifies that a full copy of the image is made;
# "copy_on_write" specifies that copy-on-write optimization
# strategy is used and unmodified blocks of the image file are
# shared efficiently. (string value)
#gpfs_images_share_mode=<None>
# Specifies an upper limit on the number of indirections
# required to reach a specific block due to snapshots or
# clones. A lengthy chain of copy-on-write snapshots or
# clones can have a negative impact on performance, but
# improves space utilization. 0 indicates unlimited clone
# depth. (integer value)
#gpfs_max_clone_depth=0
# Specifies that volumes are created as sparse files which
# initially consume no space. If set to False, the volume is
# created as a fully allocated file, in which case, creation
# may take a significantly longer time. (boolean value)
#gpfs_sparse_volumes=true
# Specifies the storage pool that volumes are assigned to. By
# default, the system storage pool is used. (string value)
#gpfs_storage_pool=system
#
# Options defined in cinder.volume.drivers.ibm.ibmnas
#
# IBMNAS platform type to be used as backend storage; valid
# values are - v7ku : for using IBM Storwize V7000 Unified,
# sonas : for using IBM Scale Out NAS, gpfs-nas : for using
# NFS based IBM GPFS deployments. (string value)
#ibmnas_platform_type=v7ku
#
# Options defined in cinder.volume.drivers.ibm.storwize_svc
#
# Storage system storage pool for volumes (string value)
#storwize_svc_volpool_name=volpool
# Storage system space-efficiency parameter for volumes
# (percentage) (integer value)
#storwize_svc_vol_rsize=2
# Storage system threshold for volume capacity warnings
# (percentage) (integer value)
#storwize_svc_vol_warning=0
# Storage system autoexpand parameter for volumes (True/False)
141
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# (boolean value)
#storwize_svc_vol_autoexpand=true
# Storage system grain size parameter for volumes
# (32/64/128/256) (integer value)
#storwize_svc_vol_grainsize=256
# Storage system compression option for volumes (boolean
# value)
#storwize_svc_vol_compression=false
# Enable Easy Tier for volumes (boolean value)
#storwize_svc_vol_easytier=true
# The I/O group in which to allocate volumes (integer value)
#storwize_svc_vol_iogrp=0
# Maximum number of seconds to wait for FlashCopy to be
# prepared. Maximum value is 600 seconds (10 minutes) (integer
# value)
#storwize_svc_flashcopy_timeout=120
# Connection protocol (iSCSI/FC) (string value)
#storwize_svc_connection_protocol=iSCSI
# Configure CHAP authentication for iSCSI connections
# (Default: Enabled) (boolean value)
#storwize_svc_iscsi_chap_enabled=true
# Connect with multipath (FC only; iSCSI multipath is
# controlled by Nova) (boolean value)
#storwize_svc_multipath_enabled=false
# Allows vdisk to multi host mapping (boolean value)
#storwize_svc_multihostmap_enabled=true
# Indicate whether svc driver is compatible for NPIV setup. If
# it is compatible, it will allow no wwpns being returned on
# get_conn_fc_wwpns during initialize_connection (boolean
# value)
#storwize_svc_npiv_compatibility_mode=false
# Allow tenants to specify QOS on create (boolean value)
#storwize_svc_allow_tenant_qos=false
# If operating in stretched cluster mode, specify the name of
# the pool in which mirrored copies are stored.Example:
# "pool2" (string value)
#storwize_svc_stretched_cluster_partner=<None>
#
# Options defined in cinder.volume.drivers.ibm.xiv_ds8k
#
# Proxy driver that connects to the IBM Storage Array (string
142
CHAPTER 2. BLOCK STORAGE
# value)
#xiv_ds8k_proxy=xiv_ds8k_openstack.nova_proxy.XIVDS8KNovaProxy
# Connection type to the IBM Storage Array (string value)
#xiv_ds8k_connection_type=iscsi
# CHAP authentication mode, effective only for iscsi
# (disabled|enabled) (string value)
#xiv_chap=disabled
#
# Options defined in cinder.volume.drivers.lvm
#
# Name for the VG that will contain exported volumes (string
# value)
#volume_group=cinder-volumes
# If >0, create LVs with multiple mirrors. Note that this
# requires lvm_mirrors + 2 PVs with available space (integer
# value)
#lvm_mirrors=0
# Type of LVM volumes to deploy (string value)
#lvm_type=default
# LVM conf file to use for the LVM driver in Cinder; this
# setting is ignored if the specified file does not exist (You
# can also specify 'None' to not use a conf file even if one
# exists). (string value)
#lvm_conf_file=/etc/cinder/lvm.conf
#
# Options defined in cinder.volume.drivers.netapp.options
#
# The vFiler unit on which provisioning of block storage
# volumes will be done. This option is only used by the driver
# when connecting to an instance with a storage family of Data
# ONTAP operating in 7-Mode. Only use this option when
# utilizing the MultiStore feature on the NetApp storage
# system. (string value)
#netapp_vfiler=<None>
# The name of the config.conf stanza for a Data ONTAP (7-mode)
# HA partner. This option is only used by the driver when
# connecting to an instance with a storage family of Data
# ONTAP operating in 7-Mode, and it is required if the storage
# protocol selected is FC. (string value)
#netapp_partner_backend_name=<None>
# Administrative user account name used to access the storage
# system or proxy server. (string value)
#netapp_login=<None>
143
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Password for the administrative user account specified in
# the netapp_login option. (string value)
#netapp_password=<None>
# This option specifies the virtual storage server (Vserver)
# name on the storage cluster on which provisioning of block
# storage volumes should occur. (string value)
#netapp_vserver=<None>
# The hostname (or IP address) for the storage system or proxy
# server. (string value)
#netapp_server_hostname=<None>
# The TCP port to use for communication with the storage
# system or proxy server. If not specified, Data ONTAP drivers
# will use 80 for HTTP and 443 for HTTPS; E-Series will use
# 8080 for HTTP and 8443 for HTTPS. (integer value)
#netapp_server_port=<None>
# This option is used to specify the path to the E-Series
# proxy application on a proxy server. The value is combined
# with the value of the netapp_transport_type,
# netapp_server_hostname, and netapp_server_port options to
# create the URL used by the driver to connect to the proxy
# application. (string value)
#netapp_webservice_path=/devmgr/v2
# This option is only utilized when the storage family is
# configured to eseries. This option is used to restrict
# provisioning to the specified controllers. Specify the value
# of this option to be a comma separated list of controller
# hostnames or IP addresses to be used for provisioning.
# (string value)
#netapp_controller_ips=<None>
# Password for the NetApp E-Series storage array. (string
# value)
#netapp_sa_password=<None>
# This option is used to restrict provisioning to the
# specified storage pools. Only dynamic disk pools are
# currently supported. Specify the value of this option to be
# a comma separated list of disk pool names to be used for
# provisioning. (string value)
#netapp_storage_pools=<None>
# This option is used to define how the controllers in the
# E-Series storage array will work with the particular
# operating system on the hosts that are connected to it.
# (string value)
#netapp_eseries_host_type=linux_dm_mp
# If the percentage of available space for an NFS share has
# dropped below the value specified by this option, the NFS
# image cache will be cleaned. (integer value)
144
CHAPTER 2. BLOCK STORAGE
#thres_avl_size_perc_start=20
# When the percentage of available space on an NFS share has
# reached the percentage specified by this option, the driver
# will stop clearing files from the NFS image cache that have
# not been accessed in the last M minutes, where M is the
# value of the expiry_thres_minutes configuration option.
# (integer value)
#thres_avl_size_perc_stop=60
# This option specifies the threshold for last access time for
# images in the NFS image cache. When a cache cleaning cycle
# begins, images in the cache that have not been accessed in
# the last M minutes, where M is the value of this parameter,
# will be deleted from the cache to create free space on the
# NFS share. (integer value)
#expiry_thres_minutes=720
# This option specifies the path of the NetApp copy offload
# tool binary. Ensure that the binary has execute permissions
# set which allow the effective user of the cinder-volume
# process to execute the file. (string value)
#netapp_copyoffload_tool_path=<None>
# The quantity to be multiplied by the requested volume size
# to ensure enough space is available on the virtual storage
# server (Vserver) to fulfill the volume creation request.
# (floating point value)
#netapp_size_multiplier=1.2
# This option is only utilized when the storage protocol is
# configured to use iSCSI or FC. This option is used to
# restrict provisioning to the specified controller volumes.
# Specify the value of this option to be a comma separated
# list of NetApp controller volume names to be used for
# provisioning. (string value)
#netapp_volume_list=<None>
# The storage family type used on the storage system; valid
# values are ontap_7mode for using Data ONTAP operating in
# 7-Mode, ontap_cluster for using clustered Data ONTAP, or
# eseries for using E-Series. (string value)
#netapp_storage_family=ontap_cluster
# The storage protocol to be used on the data path with the
# storage system. (string value)
#netapp_storage_protocol=<None>
# The transport protocol used when communicating with the
# storage system or proxy server. (string value)
#netapp_transport_type=http
#
# Options defined in cinder.volume.drivers.nfs
#
145
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# File with the list of available nfs shares (string value)
#nfs_shares_config=/etc/cinder/nfs_shares
# Create volumes as sparsed files which take no space.If set
# to False volume is created as regular file.In such case
# volume creation takes a lot of time. (boolean value)
#nfs_sparsed_volumes=true
# Percent of ACTUAL usage of the underlying volume before no
# new volumes can be allocated to the volume destination.
# (floating point value)
#nfs_used_ratio=0.95
# This will compare the allocated to available space on the
# volume destination. If the ratio exceeds this number, the
# destination will no longer be valid. (floating point value)
#nfs_oversub_ratio=1.0
# Base dir containing mount points for nfs shares. (string
# value)
#nfs_mount_point_base=$state_path/mnt
# Mount options passed to the nfs client. See section of the
# nfs man page for details. (string value)
#nfs_mount_options=<None>
# The number of attempts to mount nfs shares before raising an
# error. At least one attempt will be made to mount an nfs
# share, regardless of the value specified. (integer value)
#nfs_mount_attempts=3
#
# Options defined in cinder.volume.drivers.nimble
#
# Nimble Controller pool name (string value)
#nimble_pool_name=default
# Nimble Subnet Label (string value)
#nimble_subnet_label=*
#
# Options defined in cinder.volume.drivers.openvstorage
#
# Vpool to use for volumes - backend is defined by vpool not
# by us. (string value)
#vpool_name=
#
# Options defined in cinder.volume.drivers.prophetstor.options
#
146
CHAPTER 2. BLOCK STORAGE
# DPL pool uuid in which DPL volumes are stored. (string
# value)
#dpl_pool=
# DPL port number. (integer value)
#dpl_port=8357
#
# Options defined in cinder.volume.drivers.pure
#
# REST API authorization token. (string value)
#pure_api_token=<None>
#
# Options defined in cinder.volume.drivers.quobyte
#
# URL to the Quobyte volume e.g., quobyte://<DIR host>/<volume
# name> (string value)
#quobyte_volume_url=<None>
# Path to a Quobyte Client configuration file. (string value)
#quobyte_client_cfg=<None>
# Create volumes as sparse files which take no space. If set
# to False, volume is created as regular file.In such case
# volume creation takes a lot of time. (boolean value)
#quobyte_sparsed_volumes=true
# Create volumes as QCOW2 files rather than raw files.
# (boolean value)
#quobyte_qcow2_volumes=true
# Base dir containing the mount point for the Quobyte volume.
# (string value)
#quobyte_mount_point_base=$state_path/mnt
#
# Options defined in cinder.volume.drivers.rbd
#
# The RADOS pool where rbd volumes are stored (string value)
#rbd_pool=rbd
# The RADOS client name for accessing rbd volumes - only set
# when using cephx authentication (string value)
#rbd_user=<None>
# Path to the ceph configuration file (string value)
#rbd_ceph_conf=
147
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Flatten volumes created from snapshots to remove dependency
# from volume to snapshot (boolean value)
#rbd_flatten_volume_from_snapshot=false
# The libvirt uuid of the secret for the rbd_user volumes
# (string value)
#rbd_secret_uuid=<None>
# Directory where temporary image files are stored when the
# volume driver does not write them directly to the volume.
# Warning: this option is now deprecated, please use
# image_conversion_dir instead. (string value)
#volume_tmp_dir=<None>
# Maximum number of nested volume clones that are taken before
# a flatten occurs. Set to 0 to disable cloning. (integer
# value)
#rbd_max_clone_depth=5
# Volumes will be chunked into objects of this size (in
# megabytes). (integer value)
#rbd_store_chunk_size=4
# Timeout value (in seconds) used when connecting to ceph
# cluster. If value < 0, no timeout is set and default
# librados value is used. (integer value)
#rados_connect_timeout=-1
#
# Options defined in cinder.volume.drivers.remotefs
#
# IP address or Hostname of NAS system. (string value)
#nas_ip=
# User name to connect to NAS system. (string value)
#nas_login=admin
# Password to connect to NAS system. (string value)
#nas_password=
# SSH port to use to connect to NAS system. (integer value)
#nas_ssh_port=22
# Filename of private key to use for SSH authentication.
# (string value)
#nas_private_key=
# Allow network-attached storage systems to operate in a
# secure environment where root level access is not permitted.
# If set to False, access is as the root user and insecure. If
# set to True, access is not as root. If set to auto, a check
# is done to determine if this is a new installation: True is
# used if so, otherwise False. Default is auto. (string value)
#nas_secure_file_operations=auto
148
CHAPTER 2. BLOCK STORAGE
# Set more secure file permissions on network-attached storage
# volume files to restrict broad other/world access. If set to
# False, volumes are created with open permissions. If set to
# True, volumes are created with permissions for the cinder
# user and group (660). If set to auto, a check is done to
# determine if this is a new installation: True is used if so,
# otherwise False. Default is auto. (string value)
#nas_secure_file_permissions=auto
# Path to the share to use for storing Cinder volumes. For
# example: "/srv/export1" for an NFS server export available
# at 10.0.5.10:/srv/export1 . (string value)
#nas_share_path=
# Options used to mount the storage backend file system where
# Cinder volumes are stored. (string value)
#nas_mount_options=<None>
#
# Options defined in cinder.volume.drivers.san.hp.hp_3par_common
#
# 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
# (string value)
#hp3par_api_url=
# 3PAR Super user username (string value)
#hp3par_username=
# 3PAR Super user password (string value)
#hp3par_password=
# List of the CPG(s) to use for volume creation (list value)
#hp3par_cpg=OpenStack
# The CPG to use for Snapshots for volumes. If empty the
# userCPG will be used. (string value)
#hp3par_cpg_snap=
# The time in hours to retain a snapshot. You can't delete it
# before this expires. (string value)
#hp3par_snapshot_retention=
# The time in hours when a snapshot expires and is deleted.
# This must be larger than expiration (string value)
#hp3par_snapshot_expiration=
# Enable HTTP debugging to 3PAR (boolean value)
#hp3par_debug=false
# List of target iSCSI addresses to use. (list value)
#hp3par_iscsi_ips=
# Enable CHAP authentication for iSCSI connections. (boolean
149
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# value)
#hp3par_iscsi_chap_enabled=false
#
# Options defined in cinder.volume.drivers.san.hp.hp_lefthand_rest_proxy
#
# HP LeftHand WSAPI Server Url like https://<LeftHand
# ip>:8081/lhos (string value)
#hplefthand_api_url=<None>
# HP LeftHand Super user username (string value)
#hplefthand_username=<None>
# HP LeftHand Super user password (string value)
#hplefthand_password=<None>
# HP LeftHand cluster name (string value)
#hplefthand_clustername=<None>
# Configure CHAP authentication for iSCSI connections
# (Default: Disabled) (boolean value)
#hplefthand_iscsi_chap_enabled=false
# Enable HTTP debugging to LeftHand (boolean value)
#hplefthand_debug=false
#
# Options defined in cinder.volume.drivers.san.san
#
# Use thin provisioning for SAN volumes? (boolean value)
#san_thin_provision=true
# IP address of SAN controller (string value)
#san_ip=
# Username for SAN controller (string value)
#san_login=admin
# Password for SAN controller (string value)
#san_password=
# Filename of private key to use for SSH authentication
# (string value)
#san_private_key=
# Cluster name to use for creating volumes (string value)
#san_clustername=
# SSH port to use with SAN (integer value)
#san_ssh_port=22
# Execute commands locally instead of over SSH; use if the
150
CHAPTER 2. BLOCK STORAGE
# volume service is running on the SAN device (boolean value)
#san_is_local=false
# SSH connection timeout in seconds (integer value)
#ssh_conn_timeout=30
# Minimum ssh connections in the pool (integer value)
#ssh_min_pool_conn=1
# Maximum ssh connections in the pool (integer value)
#ssh_max_pool_conn=5
#
# Options defined in cinder.volume.drivers.scality
#
# Path or URL to Scality SOFS configuration file (string
# value)
#scality_sofs_config=<None>
# Base dir where Scality SOFS shall be mounted (string value)
#scality_sofs_mount_point=$state_path/scality
# Path from Scality SOFS root to volume dir (string value)
#scality_sofs_volume_dir=cinder/volumes
#
# Options defined in cinder.volume.drivers.smbfs
#
# File with the list of available smbfs shares. (string value)
#smbfs_shares_config=/etc/cinder/smbfs_shares
# Default format that will be used when creating volumes if no
# volume format is specified. (string value)
#smbfs_default_volume_format=qcow2
# Create volumes as sparsed files which take no space rather
# than regular files when using raw format, in which case
# volume creation takes lot of time. (boolean value)
#smbfs_sparsed_volumes=true
# Percent of ACTUAL usage of the underlying volume before no
# new volumes can be allocated to the volume destination.
# (floating point value)
#smbfs_used_ratio=0.95
# This will compare the allocated to available space on the
# volume destination. If the ratio exceeds this number, the
# destination will no longer be valid. (floating point value)
#smbfs_oversub_ratio=1.0
# Base dir containing mount points for smbfs shares. (string
# value)
151
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#smbfs_mount_point_base=$state_path/mnt
# Mount options passed to the smbfs client. See mount.cifs man
# page for details. (string value)
#smbfs_mount_options=noperm,file_mode=0775,dir_mode=0775
#
# Options defined in cinder.volume.drivers.solidfire
#
# Set 512 byte emulation on volume creation; (boolean value)
#sf_emulate_512=true
# Allow tenants to specify QOS on create (boolean value)
#sf_allow_tenant_qos=false
# Create SolidFire accounts with this prefix. Any string can
# be used here, but the string "hostname" is special and will
# create a prefix using the cinder node hostsname (previous
# default behavior). The default is NO prefix. (string value)
#sf_account_prefix=<None>
# Account name on the SolidFire Cluster to use as owner of
# template/cache volumes (created if does not exist). (string
# value)
#sf_template_account_name=openstack-vtemplate
# Create an internal cache of copy of images when a bootable
# volume is created to eliminate fetch from glance and qemu-
# conversion on subsequent calls. (boolean value)
#sf_allow_template_caching=true
# SolidFire API port. Useful if the device api is behind a
# proxy on a different port. (integer value)
#sf_api_port=443
#
# Options defined in cinder.volume.drivers.srb
#
# Comma-separated list of REST servers IP to connect to. (eg
# http://IP1/,http://IP2:81/path (string value)
#srb_base_urls=<None>
#
# Options defined in cinder.volume.drivers.violin.v6000_common
#
# IP address or hostname of mg-a (string value)
#gateway_mga=<None>
# IP address or hostname of mg-b (string value)
#gateway_mgb=<None>
152
CHAPTER 2. BLOCK STORAGE
# Use igroups to manage targets and initiators (boolean value)
#use_igroups=false
# Global backend request timeout, in seconds (integer value)
#request_timeout=300
#
# Options defined in cinder.volume.drivers.vmware.vmdk
#
# IP address for connecting to VMware ESX/VC server. (string
# value)
#vmware_host_ip=<None>
# Username for authenticating with VMware ESX/VC server.
# (string value)
#vmware_host_username=<None>
# Password for authenticating with VMware ESX/VC server.
# (string value)
#vmware_host_password=<None>
# Optional VIM service WSDL Location e.g
# http://<server>/vimService.wsdl. Optional over-ride to
# default location for bug work-arounds. (string value)
#vmware_wsdl_location=<None>
# Number of times VMware ESX/VC server API must be retried
# upon connection related issues. (integer value)
#vmware_api_retry_count=10
# The interval (in seconds) for polling remote tasks invoked
# on VMware ESX/VC server. (floating point value)
#vmware_task_poll_interval=0.5
# Name for the folder in the VC datacenter that will contain
# cinder volumes. (string value)
#vmware_volume_folder=cinder-volumes
# Timeout in seconds for VMDK volume transfer between Cinder
# and Glance. (integer value)
#vmware_image_transfer_timeout_secs=7200
# Max number of objects to be retrieved per batch. Query
# results will be obtained in batches from the server and not
# in one shot. Server may still limit the count to something
# less than the configured value. (integer value)
#vmware_max_objects_retrieval=100
# Optional string specifying the VMware VC server version. The
# driver attempts to retrieve the version from VMware VC
# server. Set this configuration only if you want to override
# the VC server version. (string value)
#vmware_host_version=<None>
153
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Directory where virtual disks are stored during volume
# backup and restore. (string value)
#vmware_tmp_dir=/tmp
#
# Options defined in cinder.volume.drivers.windows.windows
#
# Path to store VHD backed volumes (string value)
#windows_iscsi_lun_path=C:\iSCSIVirtualDisks
#
# Options defined in cinder.volume.drivers.xio
#
# Default storage pool for volumes. (integer value)
#ise_storage_pool=1
# Raid level for ISE volumes. (integer value)
#ise_raid=1
# Number of retries (per port) when establishing connection to
# ISE management port. (integer value)
#ise_connection_retries=5
# Interval (secs) between retries. (integer value)
#ise_retry_interval=1
# Number on retries to get completion status after issuing a
# command to ISE. (integer value)
#ise_completion_retries=30
#
# Options defined in cinder.volume.drivers.zfssa.zfssanfs
#
# Data path IP address (string value)
#zfssa_data_ip=<None>
# HTTPS port number (string value)
#zfssa_https_port=443
# Options to be passed while mounting share over nfs (string
# value)
#zfssa_nfs_mount_options=
# Storage pool name. (string value)
#zfssa_nfs_pool=
# Project name. (string value)
#zfssa_nfs_project=NFSProject
154
CHAPTER 2. BLOCK STORAGE
# Share name. (string value)
#zfssa_nfs_share=nfs_share
# Data compression. (string value)
#zfssa_nfs_share_compression=off
# Synchronous write bias-latency, throughput. (string value)
#zfssa_nfs_share_logbias=latency
# REST connection timeout. (seconds) (integer value)
#zfssa_rest_timeout=<None>
#
# Options defined in cinder.volume.manager
#
# Driver to use for volume creation (string value)
#volume_driver=cinder.volume.drivers.lvm.LVMISCSIDriver
# Timeout for creating the volume to migrate to when
# performing volume migration (seconds) (integer value)
#migration_create_volume_timeout_secs=300
# Offload pending volume delete during volume service startup
# (boolean value)
#volume_service_inithost_offload=false
# FC Zoning mode configured (string value)
#zoning_mode=none
# User defined capabilities, a JSON formatted string
# specifying key/value pairs. The key/value pairs can be used
# by the CapabilitiesFilter to select between backends when
# requests specify volume types. For example, specifying a
# service level or the geographical location of a backend,
# then creating a volume type to allow the user to select by
# these different properties. (string value)
#extra_capabilities={}
[BRCD_FABRIC_EXAMPLE]
#
# Options defined in cinder.zonemanager.drivers.brocade.brcd_fabric_opts
#
# Management IP of fabric (string value)
#fc_fabric_address=
# Fabric user ID (string value)
#fc_fabric_user=
# Password for user (string value)
#fc_fabric_password=
155
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Connecting port (integer value)
#fc_fabric_port=22
# overridden zoning policy (string value)
#zoning_policy=initiator-target
# overridden zoning activation state (boolean value)
#zone_activate=true
# overridden zone name prefix (string value)
#zone_name_prefix=<None>
# Principal switch WWN of the fabric (string value)
#principal_switch_wwn=<None>
[CISCO_FABRIC_EXAMPLE]
#
# Options defined in cinder.zonemanager.drivers.cisco.cisco_fabric_opts
#
# Management IP of fabric (string value)
#cisco_fc_fabric_address=
# Fabric user ID (string value)
#cisco_fc_fabric_user=
# Password for user (string value)
#cisco_fc_fabric_password=
# Connecting port (integer value)
#cisco_fc_fabric_port=22
# overridden zoning policy (string value)
#cisco_zoning_policy=initiator-target
# overridden zoning activation state (boolean value)
#cisco_zone_activate=true
# overridden zone name prefix (string value)
#cisco_zone_name_prefix=<None>
# VSAN of the Fabric (string value)
#cisco_zoning_vsan=<None>
[database]
#
# Options defined in oslo.db.concurrency
#
# Enable the experimental use of thread pooling for all DB API
# calls (boolean value)
# Deprecated group/name - [DEFAULT]/dbapi_use_tpool
156
CHAPTER 2. BLOCK STORAGE
#use_tpool=false
[fc-zone-manager]
#
# Options defined in cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver
#
# Southbound connector for zoning operation (string value)
#brcd_sb_connector=cinder.zonemanager.drivers.brocade.brcd_fc_zone_client
_cli.BrcdFCZoneClientCLI
#
# Options defined in cinder.zonemanager.drivers.cisco.cisco_fc_zone_driver
#
# Southbound connector for zoning operation (string value)
#cisco_sb_connector=cinder.zonemanager.drivers.cisco.cisco_fc_zone_client
_cli.CiscoFCZoneClientCLI
#
# Options defined in cinder.zonemanager.fc_zone_manager
#
# FC Zone Driver responsible for zone management (string
# value)
#zone_driver=cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdF
CZoneDriver
# Zoning policy configured by user; valid values include
# "initiator-target" or "initiator" (string value)
#zoning_policy=initiator-target
# Comma separated list of Fibre Channel fabric names. This
# list of names is used to retrieve other SAN credentials for
# connecting to each SAN fabric (string value)
#fc_fabric_names=<None>
# FC SAN Lookup Service (string value)
#fc_san_lookup_service=cinder.zonemanager.drivers.brocade.brcd_fc_san_loo
kup_service.BrcdFCSanLookupService
[keymgr]
#
# Options defined in cinder.keymgr
#
# The full class name of the key manager API class (string
# value)
157
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#api_class=cinder.keymgr.conf_key_mgr.ConfKeyManager
#
# Options defined in cinder.keymgr.conf_key_mgr
#
# Fixed key returned by key manager, specified in hex (string
# value)
#fixed_key=<None>
#
# Options defined in cinder.keymgr.key_mgr
#
# Authentication url for encryption service. (string value)
#encryption_auth_url=http://localhost:5000/v3
# Url for encryption service. (string value)
#encryption_api_url=http://localhost:9311/v1
[keystone_authtoken]
#
# Options defined in keystonemiddleware.auth_token
#
# Complete public Identity API endpoint. (string value)
#auth_uri=<None>
# API version of the admin Identity API endpoint. (string
# value)
#auth_version=<None>
# Do not handle authorization requests within the middleware,
# but delegate the authorization decision to downstream WSGI
# components. (boolean value)
#delay_auth_decision=false
# Request timeout value for communicating with Identity API
# server. (integer value)
#http_connect_timeout=<None>
# How many times are we trying to reconnect when communicating
# with Identity API Server. (integer value)
#http_request_max_retries=3
# Env key for the swift cache. (string value)
#cache=<None>
# Required if identity server requires client certificate
# (string value)
#certfile=<None>
158
CHAPTER 2. BLOCK STORAGE
# Required if identity server requires client certificate
# (string value)
#keyfile=<None>
# A PEM encoded Certificate Authority to use when verifying
# HTTPs connections. Defaults to system CAs. (string value)
#cafile=<None>
# Verify HTTPS connections. (boolean value)
#insecure=false
# Directory used to cache files related to PKI tokens. (string
# value)
#signing_dir=<None>
# Optionally specify a list of memcached server(s) to use for
# caching. If left undefined, tokens will instead be cached
# in-process. (list value)
# Deprecated group/name - [DEFAULT]/memcache_servers
#memcached_servers=<None>
# In order to prevent excessive effort spent validating
# tokens, the middleware caches previously-seen tokens for a
# configurable duration (in seconds). Set to -1 to disable
# caching completely. (integer value)
#token_cache_time=300
# Determines the frequency at which the list of revoked tokens
# is retrieved from the Identity service (in seconds). A high
# number of revocation events combined with a low cache
# duration may significantly reduce performance. (integer
# value)
#revocation_cache_time=10
# (Optional) If defined, indicate whether token data should be
# authenticated or authenticated and encrypted. Acceptable
# values are MAC or ENCRYPT. If MAC, token data is
# authenticated (with HMAC) in the cache. If ENCRYPT, token
# data is encrypted and authenticated in the cache. If the
# value is not one of these options or empty, auth_token will
# raise an exception on initialization. (string value)
#memcache_security_strategy=<None>
# (Optional, mandatory if memcache_security_strategy is
# defined) This string is used for key derivation. (string
# value)
#memcache_secret_key=<None>
# (Optional) Number of seconds memcached server is considered
# dead before it is tried again. (integer value)
#memcache_pool_dead_retry=300
# (Optional) Maximum total number of open connections to every
# memcached server. (integer value)
#memcache_pool_maxsize=10
159
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# (Optional) Socket timeout in seconds for communicating with
# a memcache server. (integer value)
#memcache_pool_socket_timeout=3
# (Optional) Number of seconds a connection to memcached is
# held unused in the pool before it is closed. (integer value)
#memcache_pool_unused_timeout=60
# (Optional) Number of seconds that an operation will wait to
# get a memcache client connection from the pool. (integer
# value)
#memcache_pool_conn_get_timeout=10
# (Optional) Use the advanced (eventlet safe) memcache client
# pool. The advanced pool will only work under python 2.x.
# (boolean value)
#memcache_use_advanced_pool=false
# (Optional) Indicate whether to set the X-Service-Catalog
# header. If False, middleware will not ask for service
# catalog on token validation and will not set the X-Service-
# Catalog header. (boolean value)
#include_service_catalog=true
# Used to control the use and type of token binding. Can be
# set to: "disabled" to not check token binding. "permissive"
# (default) to validate binding information if the bind type
# is of a form known to the server and ignore it if not.
# "strict" like "permissive" but if the bind type is unknown
# the token will be rejected. "required" any form of token
# binding is needed to be allowed. Finally the name of a
# binding method that must be present in tokens. (string
# value)
#enforce_token_bind=permissive
# If true, the revocation list will be checked for cached
# tokens. This requires that PKI tokens are configured on the
# identity server. (boolean value)
#check_revocations_for_cached=false
# Hash algorithms to use for hashing PKI tokens. This may be a
# single algorithm or multiple. The algorithms are those
# supported by Python standard hashlib.new(). The hashes will
# be tried in the order given, so put the preferred one first
# for performance. The result of the first hash will be stored
# in the cache. This will typically be set to multiple values
# only while migrating from a less secure algorithm to a more
# secure one. Once all the old tokens are expired this option
# should be set to a single value for better performance.
# (list value)
#hash_algorithms=md5
[matchmaker_redis]
#
160
CHAPTER 2. BLOCK STORAGE
# Options defined in oslo.messaging
#
# Host to locate redis. (string value)
#host=127.0.0.1
# Use this port to connect to redis host. (integer value)
#port=6379
# Password for Redis server (optional). (string value)
#password=<None>
[matchmaker_ring]
#
# Options defined in oslo.messaging
#
# Matchmaker ring file (JSON). (string value)
# Deprecated group/name - [DEFAULT]/matchmaker_ringfile
#ringfile=/etc/oslo/matchmaker_ring.json
[oslo_messaging_amqp]
#
# Options defined in oslo.messaging
#
# address prefix used when sending to a specific server
# (string value)
#server_request_prefix=exclusive
# address prefix used when broadcasting to all servers (string
# value)
#broadcast_prefix=broadcast
# address prefix when sending to any server in group (string
# value)
#group_request_prefix=unicast
# Name for the AMQP container (string value)
#container_name=<None>
# Timeout for inactive connections (in seconds) (integer
# value)
#idle_timeout=0
# Debug: dump AMQP frames to stdout (boolean value)
#trace=false
# CA certificate PEM file for verifing server certificate
# (string value)
#ssl_ca_file=
161
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Identifying certificate PEM file to present to clients
# (string value)
#ssl_cert_file=
# Private key PEM file used to sign cert_file certificate
# (string value)
#ssl_key_file=
# Password for decrypting ssl_key_file (if encrypted) (string
# value)
#ssl_key_password=<None>
# Accept clients using either SSL or plain TCP (boolean value)
#allow_insecure_clients=false
[oslo_messaging_qpid]
#
# Options defined in oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
#amqp_durable_queues=false
# Auto-delete queues in AMQP. (boolean value)
#amqp_auto_delete=false
# Size of RPC connection pool. (integer value)
#rpc_conn_pool_size=30
# Qpid broker hostname. (string value)
#qpid_hostname=localhost
# Qpid broker port. (integer value)
#qpid_port=5672
# Qpid HA cluster host:port pairs. (list value)
#qpid_hosts=$qpid_hostname:$qpid_port
# Username for Qpid connection. (string value)
#qpid_username=
# Password for Qpid connection. (string value)
#qpid_password=
# Space separated list of SASL mechanisms to use for auth.
# (string value)
#qpid_sasl_mechanisms=
# Seconds between connection keepalive heartbeats. (integer
# value)
#qpid_heartbeat=60
# Transport to use, either 'tcp' or 'ssl'. (string value)
162
CHAPTER 2. BLOCK STORAGE
#qpid_protocol=tcp
# Whether to disable the Nagle algorithm. (boolean value)
#qpid_tcp_nodelay=true
# The number of prefetched messages held by receiver. (integer
# value)
#qpid_receiver_capacity=1
# The qpid topology version to use. Version 1 is what was
# originally used by impl_qpid. Version 2 includes some
# backwards-incompatible changes that allow broker federation
# to work. Users should update to version 2 when they are
# able to take everything down, as it requires a clean break.
# (integer value)
#qpid_topology_version=1
[oslo_messaging_rabbit]
#
# Options defined in oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
#amqp_durable_queues=false
# Auto-delete queues in AMQP. (boolean value)
#amqp_auto_delete=false
# Size of RPC connection pool. (integer value)
#rpc_conn_pool_size=30
# SSL version to use (valid only if SSL enabled). Valid values
# are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may
# be available on some distributions. (string value)
#kombu_ssl_version=
# SSL key file (valid only if SSL enabled). (string value)
#kombu_ssl_keyfile=
# SSL cert file (valid only if SSL enabled). (string value)
#kombu_ssl_certfile=
# SSL certification authority file (valid only if SSL
# enabled). (string value)
#kombu_ssl_ca_certs=
# How long to wait before reconnecting in response to an AMQP
# consumer cancel notification. (floating point value)
#kombu_reconnect_delay=1.0
# The RabbitMQ broker address where a single node is used.
# (string value)
#rabbit_host=localhost
163
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The RabbitMQ broker port where a single node is used.
# (integer value)
#rabbit_port=5672
# RabbitMQ HA cluster host:port pairs. (list value)
#rabbit_hosts=$rabbit_host:$rabbit_port
# Connect over SSL for RabbitMQ. (boolean value)
#rabbit_use_ssl=false
# The RabbitMQ userid. (string value)
#rabbit_userid=guest
# The RabbitMQ password. (string value)
#rabbit_password=guest
# The RabbitMQ login method. (string value)
#rabbit_login_method=AMQPLAIN
# The RabbitMQ virtual host. (string value)
#rabbit_virtual_host=/
# How frequently to retry connecting with RabbitMQ. (integer
# value)
#rabbit_retry_interval=1
# How long to backoff for between retries when connecting to
# RabbitMQ. (integer value)
#rabbit_retry_backoff=2
# Maximum number of RabbitMQ connection retries. Default is 0
# (infinite retry count). (integer value)
#rabbit_max_retries=0
# Use HA queues in RabbitMQ (x-ha-policy: all). If you change
# this option, you must wipe the RabbitMQ database. (boolean
# value)
#rabbit_ha_queues=false
# Number of seconds after which the Rabbit broker is
# considered down if heartbeat's keep-alive fails (0 disables
# the heartbeat, >0 enables it. Enabling heartbeats requires
# kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL (integer value)
#heartbeat_timeout_threshold=0
# How often times during the heartbeat_timeout_threshold we
# check the heartbeat. (integer value)
#heartbeat_rate=2
# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
# (boolean value)
#fake_rabbit=false
[profiler]
164
CHAPTER 2. BLOCK STORAGE
#
# Options defined in cinder.service
#
# If False fully disable profiling feature. (boolean value)
#profiler_enabled=false
# If False doesn't trace SQL requests. (boolean value)
#trace_sqlalchemy=false
[DEFAULT]
[keystone_authtoken]
#
# From keystonemiddleware.auth_token
#
# Complete public Identity API endpoint. (string value)
#auth_uri = <None>
# API version of the admin Identity API endpoint. (string value)
#auth_version = <None>
# Do not handle authorization requests within the middleware, but
# delegate the authorization decision to downstream WSGI components.
# (boolean value)
#delay_auth_decision = false
# Request timeout value for communicating with Identity API server.
# (integer value)
#http_connect_timeout = <None>
# How many times are we trying to reconnect when communicating with
# Identity API Server. (integer value)
#http_request_max_retries = 3
# Env key for the swift cache. (string value)
#cache = <None>
# Required if identity server requires client certificate (string
# value)
#certfile = <None>
# Required if identity server requires client certificate (string
# value)
#keyfile = <None>
# A PEM encoded Certificate Authority to use when verifying HTTPs
# connections. Defaults to system CAs. (string value)
#cafile = <None>
# Verify HTTPS connections. (boolean value)
165
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#insecure = false
# Directory used to cache files related to PKI tokens. (string value)
#signing_dir = <None>
# Optionally specify a list of memcached server(s) to use for caching.
# If left undefined, tokens will instead be cached in-process. (list
# value)
# Deprecated group/name - [DEFAULT]/memcache_servers
#memcached_servers = <None>
# In order to prevent excessive effort spent validating tokens, the
# middleware caches previously-seen tokens for a configurable duration
# (in seconds). Set to -1 to disable caching completely. (integer
# value)
#token_cache_time = 300
# Determines the frequency at which the list of revoked tokens is
# retrieved from the Identity service (in seconds). A high number of
# revocation events combined with a low cache duration may
# significantly reduce performance. (integer value)
#revocation_cache_time = 10
# (Optional) If defined, indicate whether token data should be
# authenticated or authenticated and encrypted. Acceptable values are
# MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in
# the cache. If ENCRYPT, token data is encrypted and authenticated in
# the cache. If the value is not one of these options or empty,
# auth_token will raise an exception on initialization. (string value)
#memcache_security_strategy = <None>
# (Optional, mandatory if memcache_security_strategy is defined) This
# string is used for key derivation. (string value)
#memcache_secret_key = <None>
# (Optional) Number of seconds memcached server is considered dead
# before it is tried again. (integer value)
#memcache_pool_dead_retry = 300
# (Optional) Maximum total number of open connections to every
# memcached server. (integer value)
#memcache_pool_maxsize = 10
# (Optional) Socket timeout in seconds for communicating with a
# memcache server. (integer value)
#memcache_pool_socket_timeout = 3
# (Optional) Number of seconds a connection to memcached is held
# unused in the pool before it is closed. (integer value)
#memcache_pool_unused_timeout = 60
# (Optional) Number of seconds that an operation will wait to get a
# memcache client connection from the pool. (integer value)
#memcache_pool_conn_get_timeout = 10
# (Optional) Use the advanced (eventlet safe) memcache client pool.
166
CHAPTER 2. BLOCK STORAGE
# The advanced pool will only work under python 2.x. (boolean value)
#memcache_use_advanced_pool = false
# (Optional) Indicate whether to set the X-Service-Catalog header. If
# False, middleware will not ask for service catalog on token
# validation and will not set the X-Service-Catalog header. (boolean
# value)
#include_service_catalog = true
# Used to control the use and type of token binding. Can be set to:
# "disabled" to not check token binding. "permissive" (default) to
# validate binding information if the bind type is of a form known to
# the server and ignore it if not. "strict" like "permissive" but if
# the bind type is unknown the token will be rejected. "required" any
# form of token binding is needed to be allowed. Finally the name of a
# binding method that must be present in tokens. (string value)
#enforce_token_bind = permissive
# If true, the revocation list will be checked for cached tokens. This
# requires that PKI tokens are configured on the identity server.
# (boolean value)
#check_revocations_for_cached = false
# Hash algorithms to use for hashing PKI tokens. This may be a single
# algorithm or multiple. The algorithms are those supported by Python
# standard hashlib.new(). The hashes will be tried in the order given,
# so put the preferred one first for performance. The result of the
# first hash will be stored in the cache. This will typically be set
# to multiple values only while migrating from a less secure algorithm
# to a more secure one. Once all the old tokens are expired this
# option should be set to a single value for better performance. (list
# value)
#hash_algorithms = md5
# Prefix to prepend at the beginning of the path. Deprecated, use
# identity_uri. (string value)
#auth_admin_prefix =
# Host providing the admin Identity API endpoint. Deprecated, use
# identity_uri. (string value)
#auth_host = 127.0.0.1
# Port of the admin Identity API endpoint. Deprecated, use
# identity_uri. (integer value)
#auth_port = 35357
# Protocol of the admin Identity API endpoint (http or https).
# Deprecated, use identity_uri. (string value)
#auth_protocol = https
# Complete admin Identity API endpoint. This should specify the
# unversioned root endpoint e.g. https://localhost:35357/ (string
# value)
#identity_uri = <None>
# This option is deprecated and may be removed in a future release.
167
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Single shared secret with the Keystone configuration used for
# bootstrapping a Keystone installation, or otherwise bypassing the
# normal authentication process. This option should not be used, use
# `admin_user` and `admin_password` instead. (string value)
#admin_token = <None>
# Service username. (string value)
#admin_user = <None>
# Service user password. (string value)
#admin_password = <None>
# Service tenant name. (string value)
#admin_tenant_name = admin
2.4.2. api-paste.ini
168
Use the api-paste.ini file to configure the Block Storage API service.
#############
# OpenStack #
#############
[composite:osapi_volume] use = call:cinder.api:root_app_factory
/: apiversions
/v1: openstack_volume_api_v1
/v2: openstack_volume_api_v2
[composite:openstack_volume_api_v1] use = call:cinder.api.middleware.auth:pipeline_factory noauth = request_id faultwrap sizelimit osprofiler noauth apiv1 keystone = request_id faultwrap sizelimit osprofiler authtoken keystonecontext apiv1 keystone_nolimit = request_id faultwrap sizelimit osprofiler authtoken keystonecontext apiv1
[composite:openstack_volume_api_v2] use = call:cinder.api.middleware.auth:pipeline_factory noauth = request_id faultwrap sizelimit osprofiler noauth apiv2 keystone = request_id faultwrap sizelimit osprofiler authtoken keystonecontext apiv2 keystone_nolimit = request_id faultwrap sizelimit osprofiler authtoken keystonecontext apiv2
[filter:request_id] paste.filter_factory = oslo_middleware.request_id:RequestId.factory
[filter:faultwrap] paste.filter_factory = cinder.api.middleware.fault:FaultWrapper.factory
[filter:osprofiler]
CHAPTER 2. BLOCK STORAGE
paste.filter_factory = osprofiler.web:WsgiMiddleware.factory
hmac_keys = SECRET_KEY enabled = yes
[filter:noauth] paste.filter_factory = cinder.api.middleware.auth:NoAuthMiddleware.factory
[filter:sizelimit] paste.filter_factory = cinder.api.middleware.sizelimit:RequestBodySizeLimiter.factory
[app:apiv1] paste.app_factory = cinder.api.v1.router:APIRouter.factory
[app:apiv2] paste.app_factory = cinder.api.v2.router:APIRouter.factory
[pipeline:apiversions] pipeline = faultwrap osvolumeversionapp
[app:osvolumeversionapp] paste.app_factory = cinder.api.versions:Versions.factory
##########
# Shared #
##########
[filter:keystonecontext] paste.filter_factory = cinder.api.middleware.auth:CinderKeystoneContext.factory
[filter:authtoken] paste.filter_factory = keystonemiddleware.auth_token:filter_factory
2.4.3. policy.json
The policy.json file defines additional access controls that apply to the Block Storage service.
{
"context_is_admin": "role:admin",
"admin_or_owner": "is_admin:True or project_id:%(project_id)s",
"default": "rule:admin_or_owner",
"admin_api": "is_admin:True",
"volume:create": "",
"volume:delete": "",
"volume:get": "",
"volume:get_all": "",
"volume:get_volume_metadata": "",
169
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"volume:get_volume_admin_metadata": "rule:admin_api",
"volume:delete_volume_admin_metadata": "rule:admin_api",
"volume:update_volume_admin_metadata": "rule:admin_api",
"volume:get_snapshot": "",
"volume:get_all_snapshots": "",
"volume:extend": "",
"volume:update_readonly_flag": "",
"volume:retype": "",
"volume_extension:types_manage": "rule:admin_api",
"volume_extension:types_extra_specs": "rule:admin_api",
"volume_extension:volume_type_access": "",
"volume_extension:volume_type_access:addProjectAccess":
"rule:admin_api",
"volume_extension:volume_type_access:removeProjectAccess":
"rule:admin_api",
"volume_extension:volume_type_encryption": "rule:admin_api",
"volume_extension:volume_encryption_metadata": "rule:admin_or_owner",
"volume_extension:extended_snapshot_attributes": "",
"volume_extension:volume_image_metadata": "",
"volume_extension:quotas:show": "",
"volume_extension:quotas:update": "rule:admin_api",
"volume_extension:quota_classes": "",
"volume_extension:volume_admin_actions:reset_status":
"rule:admin_api",
"volume_extension:snapshot_admin_actions:reset_status":
"rule:admin_api",
"volume_extension:backup_admin_actions:reset_status":
"rule:admin_api",
"volume_extension:volume_admin_actions:force_delete":
"rule:admin_api",
"volume_extension:volume_admin_actions:force_detach":
"rule:admin_api",
"volume_extension:snapshot_admin_actions:force_delete":
"rule:admin_api",
"volume_extension:volume_admin_actions:migrate_volume":
"rule:admin_api",
"volume_extension:volume_admin_actions:migrate_volume_completion":
"rule:admin_api",
"volume_extension:volume_host_attribute": "rule:admin_api",
"volume_extension:volume_tenant_attribute": "rule:admin_or_owner",
"volume_extension:volume_mig_status_attribute": "rule:admin_api",
"volume_extension:hosts": "rule:admin_api",
"volume_extension:services": "rule:admin_api",
"volume_extension:volume_manage": "rule:admin_api",
"volume_extension:volume_unmanage": "rule:admin_api",
"volume:services": "rule:admin_api",
"volume:create_transfer": "",
"volume:accept_transfer": "",
"volume:delete_transfer": "",
170
CHAPTER 2. BLOCK STORAGE
"volume:get_all_transfers": "",
"volume_extension:replication:promote": "rule:admin_api",
"volume_extension:replication:reenable": "rule:admin_api",
"backup:create" : "",
"backup:delete": "",
"backup:get": "",
"backup:get_all": "",
"backup:restore": "",
"backup:backup-import": "rule:admin_api",
"backup:backup-export": "rule:admin_api",
"snapshot_extension:snapshot_actions:update_snapshot_status": "",
"consistencygroup:create" : "group:nobody",
"consistencygroup:delete": "group:nobody",
"consistencygroup:update": "group:nobody",
"consistencygroup:get": "group:nobody",
"consistencygroup:get_all": "group:nobody",
"consistencygroup:create_cgsnapshot" : "group:nobody",
"consistencygroup:delete_cgsnapshot": "group:nobody",
"consistencygroup:get_cgsnapshot": "group:nobody",
"consistencygroup:get_all_cgsnapshots": "group:nobody",
"scheduler_extension:scheduler_stats:get_pools" : "rule:admin_api"
}
2.4.4. rootwrap.conf
The rootwrap.conf file defines configuration values used by the rootwrap script when the Block
Storage service must escalate its privileges to those of the root user.
# Configuration for cinder-rootwrap
# This file should be owned by (and only-writeable by) the root user
[DEFAULT]
# List of directories to load filter definitions from (separated by ',').
# These directories MUST all be only writeable by root !
filters_path=/etc/cinder/rootwrap.d,/usr/share/cinder/rootwrap
# List of directories to search executables in, in case filters do not
# explicitely specify a full path (separated by ',')
# If not specified, defaults to system PATH environment variable.
# These directories MUST all be only writeable by root !
exec_dirs=/sbin,/usr/sbin,/bin,/usr/bin,/usr/local/bin,/usr/local/sbin
# Enable logging to syslog
# Default value is False use_syslog=False
# Which syslog facility to use.
# Valid values include auth, authpriv, syslog, local0, local1...
# Default value is 'syslog'
171
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
syslog_log_facility=syslog
# Which messages to log.
# INFO means log all usage
# ERROR means only log unsuccessful attempts syslog_log_level=ERROR
2.5. LOG FILES USED BY BLOCK STORAGE
The corresponding log file of each Block Storage service is stored in the /var/log/cinder/ directory of the host on which each service runs.
Table 2.25. Log files used by Block Storage services
Log file
api.log
cinder-manage.log
scheduler.log
volume.log
Service/interface
openstack-cinder-api cinder-manage openstack-cinderscheduler openstack-cinder-volume
2.6. FIBRE CHANNEL ZONE MANAGER
The Fibre Channel Zone Manager allows FC SAN Zone/Access control management in conjunction with Fibre Channel block storage. The configuration of Fibre Channel Zone Manager and various zone drivers are described in this section.
2.6.1. Configure Block Storage to use Fibre Channel Zone Manager
If Block Storage is configured to use a Fibre Channel volume driver that supports Zone Manager, update cinder.conf to add the following configuration options to enable Fibre Channel Zone
Manager.
Make the following changes in the /etc/cinder/cinder.conf file.
Table 2.26. Description of zoning configuration options
Configuration option = Default value
[DEFAULT]
Description
172
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value zoning_mode
= none
[fc-zone-manager]
Description
(StrOpt) FC Zoning mode configured
fc_fabric_names
= None (StrOpt) Comma separated list of Fibre Channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric
fc_san_lookup_service
=
cinder.zonemanager.drivers.brocade.brcd_fc_san_
lookup_service.BrcdFCSanLookupService
(StrOpt) FC SAN Lookup Service
zone_driver
=
cinder.zonemanager.drivers.brocade.brcd_fc_zone
_driver.BrcdFCZoneDriver
(StrOpt) FC Zone Driver responsible for zone management
zoning_policy
= initiator-target (StrOpt) Zoning policy configured by user; valid values include "initiator-target" or "initiator"
To use different Fibre Channel Zone Drivers, use the parameters described in this section.
Note
When multi backend configuration is used, provide the zoning_mode configuration option as part of the volume driver configuration where volume_driver option is specified.
Note
Default value of zoning_mode is None and this needs to be changed to fabric to allow fabric zoning.
Note
zoning_policy can be configured as initiator-target or initiator
2.6.2. Brocade Fibre Channel Zone Driver
Brocade Fibre Channel Zone Driver performs zoning operations through SSH. Configure Brocade
Zone Driver and lookup service by specifying the following parameters:
Table 2.27. Description of zoning manager configuration options
173
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[fc-zone-manager]
Description brcd_sb_connector
=
cinder.zonemanager.drivers.brocade.brcd_fc_zone
_client_cli.BrcdFCZoneClientCLI
(StrOpt) Southbound connector for zoning operation
Configure SAN fabric parameters in the form of fabric groups as described in the example below:
Table 2.28. Description of zoning fabrics configuration options
Configuration option = Default value
[BRCD_FABRIC_EXAMPLE] fc_fabric_address
=
fc_fabric_password
=
fc_fabric_port
= 22
fc_fabric_user
=
principal_switch_wwn
= None
zone_activate
= True
zone_name_prefix
= None
zoning_policy
= initiator-target
Description
(StrOpt) Management IP of fabric
(StrOpt) Password for user
(IntOpt) Connecting port
(StrOpt) Fabric user ID
(StrOpt) Principal switch WWN of the fabric
(BoolOpt) overridden zoning activation state
(StrOpt) overridden zone name prefix
(StrOpt) overridden zoning policy
Note
Define a fabric group for each fabric using the fabric names used in fc_fabric_names configuration option as group name.
2.6.2.1. System requirements
Brocade Fibre Channel Zone Driver requires firmware version FOS v6.4 or higher.
As a best practice for zone management, use a user account with zoneadmin role. Users with
admin role (including the default admin user account) are limited to a maximum of two concurrent
SSH sessions.
174
For information about how to manage Brocade Fibre Channel switches, see the Brocade Fabric OS
CHAPTER 2. BLOCK STORAGE
user documentation.
2.6.3. Cisco Fibre Channel Zone Driver
Cisco Fibre Channel Zone Driver automates the zoning operations through SSH. Configure Cisco
Zone Driver, Cisco Southbound connector, FC SAN lookup service and Fabric name.
Set the following options in the cinder.conf configuration file.
[fc-zone-manager] zone_driver = cinder.zonemanager.drivers.cisco.cisco_fc_zone_driver.CiscoFCZoneDriver
fc_san_lookup_service = cinder.zonemanager.drivers.cisco.cisco_fc_san_lookup_service.CiscoFCSanLo
okupService fc_fabric_names = CISCO_FABRIC_EXAMPLE cisco_sb_connector = cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClie
ntCLI
Table 2.29. Description of cisco zoning manager configuration options
Configuration option = Default value Description
[fc-zone-manager] cisco_sb_connector
=
cinder.zonemanager.drivers.cisco.cisco_fc_zone_c
lient_cli.CiscoFCZoneClientCLI
(StrOpt) Southbound connector for zoning operation
Configure SAN fabric parameters in the form of fabric groups as described in the example below:
Table 2.30. Description of cisco zoning fabrics configuration options
Configuration option = Default value
[CISCO_FABRIC_EXAMPLE] cisco_fc_fabric_address
=
cisco_fc_fabric_password
=
cisco_fc_fabric_port
= 22
cisco_fc_fabric_user
=
cisco_zone_activate
= True
Description
(StrOpt) Management IP of fabric
(StrOpt) Password for user
(IntOpt) Connecting port
(StrOpt) Fabric user ID
(BoolOpt) overridden zoning activation state
175
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value cisco_zone_name_prefix
= None
cisco_zoning_policy
= initiator-target
cisco_zoning_vsan
= None
Description
(StrOpt) overridden zone name prefix
(StrOpt) overridden zoning policy
(StrOpt) VSAN of the Fabric
176
Note
Define a fabric group for each fabric using the fabric names used in fc_fabric_names configuration option as group name.
The Cisco Fibre Channel Zone Driver supports basic and enhanced zoning modes.The
zoning VSAN must exist with an active zone set name which is same as the
fc_fabric_names option.
2.6.3.1. System requirements
Cisco MDS 9000 Family Switches.
Cisco MDS NX-OS Release 6.2(9) or later.
For information about how to manage Cisco Fibre Channel switches, see the Cisco MDS 9000 user documentation.
2.7. ADDITIONAL OPTIONS
These options can also be set in the cinder.conf file.
Table 2.31. Description of API configuration options
Description Configuration option = Default value
[DEFAULT] api_paste_config
= api-paste.ini
api_rate_limit
= True
az_cache_duration
= 3600
backend_host
= None
(StrOpt) File name for the paste.deploy config for cinder-api
(BoolOpt) Enables or disables rate limit of the API.
(IntOpt) Cache volume availability zones in memory for the provided duration in seconds
(StrOpt) Backend override of host value.
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value default_timeout
= 525600
enable_v1_api enable_v2_api
= True
= True
extra_capabilities max_header_line
= {}
= 16384
Description
(IntOpt) Default timeout for CLI operations in minutes. For example, LUN migration is a typical long running operation, which depends on the LUN size and the load of the array. An upper bound in the specific deployment can be set to avoid unnecessary long wait. By default, it is 365 days long.
(BoolOpt) DEPRECATED: Deploy v1 of the Cinder
API.
(BoolOpt) Deploy v2 of the Cinder API.
(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the
CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
osapi_max_limit
= 1000 (IntOpt) The maximum number of items that a collection resource returns in a single response
osapi_max_request_body_size
= 114688 (IntOpt) Max size for body of a request
osapi_volume_base_URL
= None (StrOpt) Base URL that will be presented to users in links to the OpenStack Volume API
osapi_volume_ext_list
= (ListOpt) Specify list of extensions to load when using osapi_volume_extension option with cinder.api.contrib.select_extensions
(MultiStrOpt) osapi volume extension to load
osapi_volume_extension
=
['cinder.api.contrib.standard_extensions']
osapi_volume_listen
= 0.0.0.0
osapi_volume_listen_port
= 8776
(StrOpt) IP address on which OpenStack Volume
API listens
(IntOpt) Port on which OpenStack Volume API listens
177
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value osapi_volume_workers
= None
public_endpoint
= None
transfer_api_class
=
cinder.transfer.api.API
volume_api_class
= cinder.volume.api.API
volume_name_template
= volume-%s
volume_number_multiplier
= -1.0
volume_transfer_key_length
= 16
volume_transfer_salt_length
= 8
Description
(IntOpt) Number of workers for OpenStack Volume
API service. The default is equal to the number of
CPUs available.
(StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If
Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.
(StrOpt) The full class name of the volume transfer
API class
(StrOpt) The full class name of the volume API class to use
(StrOpt) Template string to be used to generate volume names
(FloatOpt) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.
(IntOpt) The number of characters in the autogenerated auth key.
(IntOpt) The number of characters in the salt.
178
Table 2.32. Description of AMQP configuration options
Description Configuration option = Default value
[DEFAULT] control_exchange
= openstack
notification_driver notification_topics transport_url
= None
= []
= notifications
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
(MultiStrOpt) Driver or drivers to handle sending notifications.
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
CHAPTER 2. BLOCK STORAGE
Table 2.33. Description of authorization configuration options
Description Configuration option = Default value
[DEFAULT] auth_strategy
= noauth (StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.
Table 2.34. Description of authorization token configuration options
Description Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
admin_token
= None
admin_user auth_admin_prefix auth_host
= None
= 127.0.0.1
auth_plugin auth_port auth_section auth_uri
= None
= 35357
auth_protocol
= https
= None
= None
=
(StrOpt) Service user password.
(StrOpt) Service tenant name.
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
179
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value auth_version
= None
cache
= None
cafile
= None
certfile
= None
check_revocations_for_cached
= False
delay_auth_decision enforce_token_bind hash_algorithms
= False
= permissive
= md5
http_connect_timeout
= None
http_request_max_retries
= 3
Description
(StrOpt) API version of the admin Identity API endpoint.
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times are we trying to reconnect when communicating with Identity API
Server.
180
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value identity_uri
= None
include_service_catalog insecure keyfile
= False
= None
memcache_pool_maxsize memcache_secret_key
= True
memcache_pool_conn_get_timeout
= 10
memcache_pool_dead_retry
= 10
= 300
memcache_pool_socket_timeout memcache_pool_unused_timeout
= None
memcache_security_strategy memcache_use_advanced_pool
= 3
= 60
= None
= False
Description
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
181
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value revocation_cache_time
= 10
signing_dir
= None
token_cache_time
= 300
Description
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
Table 2.35. Description of backups configuration options
Configuration option = Default value
[DEFAULT] backup_api_class
= cinder.backup.api.API
Description backup_compression_algorithm
= zlib
backup_driver
= cinder.backup.drivers.swift
backup_manager
=
cinder.backup.manager.BackupManager
backup_metadata_version backup_name_template
= 2
= backup-%s
(StrOpt) The full class name of the volume backup
API class
(StrOpt) Compression algorithm (None to disable)
(StrOpt) Driver to use for backups.
(StrOpt) Full class name for the Manager for volume backup
(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.
(StrOpt) Template string to be used to generate backup names
backup_object_number_per_notificat ion
= 10
(IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent
backup_timer_interval
= 120 (IntOpt) Interval, in seconds, between two progress notifications reporting the backup status
backup_topic
= cinder-backup (StrOpt) The topic that volume backup nodes listen on
182
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value snapshot_name_template
= snapshot-%s
snapshot_same_host
= True
Description
(StrOpt) Template string to be used to generate snapshot names
(BoolOpt) Create volume from snapshot at the host where snapshot resides
Table 2.36. Description of block device configuration options
Description Configuration option = Default value
[DEFAULT] available_devices
= (ListOpt) List of all available devices
Table 2.37. Description of CA and SSL configuration options
Description Configuration option = Default value
[DEFAULT] ssl_ca_file
= None
ssl_cert_file ssl_key_file
= None
= None
(StrOpt) CA certificate file to use to verify connecting clients
(StrOpt) Certificate file to use when starting the server securely
(StrOpt) Private key file to use when starting the server securely
Table 2.38. Description of CloudByte volume driver configuration options
Configuration option = Default value
[DEFAULT] cb_account_name
= None
Description cb_add_qosgroup
= {'latency': '15', 'iops': '10',
'graceallowed': 'false', 'iopscontrol': 'true',
'memlimit': '0', 'throughput': '0', 'tpcontrol': 'false',
'networkspeed': '0'}
(StrOpt) CloudByte storage specific account name.
This maps to a project name in OpenStack.
(DictOpt) These values will be used for CloudByte storage's addQos API call.
183
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value cb_apikey
= None
cb_confirm_volume_create_retries
3
=
Description
(StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface.
(IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.
cb_confirm_volume_create_retry_int erval
= 5
(IntOpt) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage.
cb_create_volume
= {'compression': 'off',
'deduplication': 'off', 'blocklength': '512B', 'sync':
'always', 'protocoltype': 'ISCSI', 'recordsize': '16k'}
cb_tsm_name
= None
(DictOpt) These values will be used for CloudByte storage's createVolume API call.
(StrOpt) This corresponds to the name of Tenant
Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM.
184
Table 2.39. Description of common configuration options
Configuration option = Default value
[DEFAULT] chap_password
=
chap_username
=
chiscsi_conf
= /etc/chelsio-iscsi/chiscsi.conf
client_socket_timeout compute_api_class
cinder.compute.nova.API
=
= 900
consistencygroup_api_class
=
cinder.consistencygroup.api.API
default_availability_zone
= None
Description
(StrOpt) Password for specified CHAP account name.
(StrOpt) CHAP user name.
(StrOpt) Chiscsi (CXT) global defaults configuration file
(IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.
(StrOpt) The full class name of the compute API class to use
(StrOpt) The full class name of the consistencygroup API class
(StrOpt) Default availability zone for new volumes.
If not set, the storage_availability_zone option value is used as the default for new volumes.
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value default_volume_type
= None
driver_data_namespace
= None
enable_new_services end_time
= None
= 10.0.0.1
= True
enforce_multipath_for_image_xfer
=
False
host
= localhost
iet_conf
= /etc/iet/ietd.conf
iscsi_secondary_ip_addresses lio_initiator_iqns max_over_subscription_ratio memcached_servers monkey_patch my_ip
= False
=
= None
monkey_patch_modules
=
=
= 20.0
Description
(StrOpt) Default volume type to use
(StrOpt) Namespace for driver private data values to be saved in.
(BoolOpt) Services to be added to the available pool on create
(StrOpt) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.
(BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.
(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.
(StrOpt) IET configuration file
(ListOpt) The list of secondary IP addresses of the iSCSI daemon
(StrOpt) This option is deprecated and unused. It will be removed in the next release.
(FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead.
(ListOpt) Memcached servers or None for in process cache.
(BoolOpt) Enable monkey patching
(ListOpt) List of modules/decorators to monkey patch
(StrOpt) IP address of this host
185
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value no_snapshot_gb_quota
= False
num_shell_tries os_privileged_user_name policy_dirs policy_file
= 3
= ['policy.d']
= policy.json
replication_api_class
=
cinder.replication.api.API
report_interval request_timeout
= 10
= 300
reserved_percentage
= 0
= None
os_privileged_user_password os_privileged_user_tenant periodic_fuzzy_delay periodic_interval
= 60
policy_default_rule
= 60
= default
= None
= None
rootwrap_config
= /etc/cinder/rootwrap.conf
Description
(BoolOpt) Whether snapshots count against gigabyte quota
(IntOpt) Number of times to attempt to run flakey shell commands
(StrOpt) OpenStack privileged account username.
Used for requests to other services (such as Nova) that require an account with special rights.
(StrOpt) Password associated with the OpenStack privileged account.
(StrOpt) Tenant name associated with the
OpenStack privileged account.
(IntOpt) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
(IntOpt) Interval, in seconds, between running periodic tasks
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
(StrOpt) The full class name of the volume replication API class
(IntOpt) Interval, in seconds, between nodes reporting state to datastore
(IntOpt) Global backend request timeout, in seconds
(IntOpt) The percentage of backend capacity is reserved
(StrOpt) Path to the rootwrap configuration file to use for running commands as root
186
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value run_external_periodic_tasks
= True
send_actions sqlite_clean_db
= clean.sqlite
ssh_hosts_key_file
=
$state_path/ssh_known_hosts
start_time state_path
= /var/lib/cinder
tcp_keepalive_count tcp_keepalive_interval tcp_keepidle
= False
service_down_time
= None
= 60
storage_availability_zone tcp_keepalive
= True
= 600
until_refresh
= 0
= None
= nova
strict_ssh_host_key_policy
= False
= None
Description
(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?
(BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period.
(IntOpt) Maximum time since last check-in for a service to be considered up
(StrOpt) File name of clean sqlite db
(StrOpt) File containing SSH host keys for the systems with which Cinder needs to communicate.
OPTIONAL: Default=$state_path/ssh_known_hosts
(StrOpt) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.
(StrOpt) Top-level directory for maintaining cinder's state
(StrOpt) Availability zone of this node
(BoolOpt) Option to enable strict host key checking. When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file". When set to
"False" the host key will be saved upon first connection and used for subsequent connections.
Default=False
(BoolOpt) Sets the value of TCP_KEEPALIVE
(True/False) for each server socket.
(IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.
(IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on
OS X.
(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on
OS X.
(IntOpt) Count of reservations until usage is refreshed
187
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value use_chap_auth
= False
use_forwarded_for wsgi_keep_alive
= False
= True
Description
(BoolOpt) Option to enable/disable CHAP authentication for targets.
(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
(BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False.
[keystone_authtoken] memcached_servers
= None (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Table 2.40. Description of Compute configuration options
Configuration option = Default value
[DEFAULT] nova_api_insecure
= False
Description nova_ca_certificates_file nova_catalog_admin_info nova_catalog_info
= compute:Compute
Service:publicURL
=
compute:Compute Service:adminURL
nova_endpoint_admin_template
= None
nova_endpoint_template os_region_name
= None
= None
= None
(BoolOpt) Allow to perform insecure SSL requests to nova
(StrOpt) Location of ca certificates file to use for nova client requests.
(StrOpt) Same as nova_catalog_info, but for admin endpoint.
(StrOpt) Match this value when searching for nova in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:
<endpoint_type>
(StrOpt) Same as nova_endpoint_template, but for admin endpoint.
(StrOpt) Override service catalog lookup with template for nova endpoint e.g.
http://localhost:8774/v2/%(project_id)s
(StrOpt) Region name of this node
188
CHAPTER 2. BLOCK STORAGE
Table 2.41. Description of database configuration options
Description Configuration option = Default value
[DEFAULT] db_driver
= cinder.db
[database] backend
= sqlalchemy
connection
= None
(StrOpt) Driver to use for database access
connection_debug connection_trace db_inc_retry_interval db_max_retries db_max_retry_interval db_retry_interval idle_timeout max_overflow max_retries
= 0
= False
= 3600
= None
max_pool_size
= None
= 10
min_pool_size
= 20
= 1
= 1
= True
= 10
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
189
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value mysql_sql_mode
= TRADITIONAL
pool_timeout retry_interval sqlite_db
= 10
slave_connection
= None
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
use_tpool
= None
= False
Description
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
(BoolOpt) Enable the experimental use of thread pooling for all DB API calls
Table 2.42. Description of logging configuration options
Description Configuration option = Default value
[DEFAULT] backdoor_port
= None (StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
Table 2.43. Description of IBM FlashSystem volume river configuration options
190
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value
[DEFAULT] flashsystem_connection_protocol
=
FC
flashsystem_multihostmap_enabled
=
True
flashsystem_multipath_enabled
=
False
Description
(StrOpt) Connection protocol should be FC.
(BoolOpt) Allows vdisk to multi host mapping.
(BoolOpt) Connect with multipath (FC only).
Table 2.44. Description of IBM NAS volume driver configuration options
Description Configuration option = Default value
[DEFAULT] ibmnas_platform_type
= v7ku (StrOpt) IBMNAS platform type to be used as backend storage; valid values are - v7ku : for using
IBM Storwize V7000 Unified, sonas : for using IBM
Scale Out NAS, gpfs-nas : for using NFS based
IBM GPFS deployments.
Table 2.45. Description of images configuration options
Description Configuration option = Default value
[DEFAULT] allowed_direct_url_schemes
=
glance_api_insecure glance_api_servers
$glance_host:$glance_port
glance_api_version
=
= False
glance_api_ssl_compression
= 1
= False
(ListOpt) A list of url schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].
(BoolOpt) Allow to perform insecure SSL (https) requests to glance
(ListOpt) A list of the glance API servers available to cinder ([hostname|ip]:port)
(BoolOpt) Enables or disables negotiation of SSL layer compression. In some cases disabling compression can improve data throughput, such as when high network bandwidth is available and you use compressed image formats like qcow2.
(IntOpt) Version of the glance API to use
191
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value glance_ca_certificates_file
= None
Description
(StrOpt) Location of ca certificates file to use for glance client requests.
(ListOpt) Default core properties of image
glance_core_properties
= checksum,
container_format, disk_format, image_name, image_id, min_disk, min_ram, name, size
glance_host glance_port
= $my_ip
glance_num_retries
= 9292
= 0
glance_request_timeout
= None
image_conversion_dir
=
$state_path/conversion
use_multipath_for_image_xfer
= False
(StrOpt) Default glance host name or IP
(IntOpt) Number retries when downloading an image from glance
(IntOpt) Default glance port
(IntOpt) http/https timeout value for glance operations. If no value (None) is supplied here, the glanceclient default value is used.
(StrOpt) Directory used for temporary storage during image conversion
(BoolOpt) Do we attach/detach volumes in cinder using multipath for volume to image and image to volume transfers?
Table 2.46. Description of key manager configuration options
Description Configuration option = Default value
[keymgr] api_class
=
cinder.keymgr.conf_key_mgr.ConfKeyManager
encryption_api_url
=
http://localhost:9311/v1
encryption_auth_url
=
http://localhost:5000/v3
fixed_key
= None
(StrOpt) The full class name of the key manager
API class
(StrOpt) Url for encryption service.
(StrOpt) Authentication url for encryption service.
(StrOpt) Fixed key returned by key manager, specified in hex
Table 2.47. Description of logging configuration options
192
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value
[DEFAULT]
Description debug
= False
default_log_levels
= 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
(ListOpt) List of logger=LEVEL pairs.
fatal_deprecations
= False
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
(BoolOpt) Enables or disables fatal status of deprecations.
fatal_exception_format_errors
=
False
instance_format
= "[instance: %(uuid)s] "
instance_uuid_format
(uuid)s] "
log_config_append
= "[instance: %
= None
(BoolOpt) Make exception message format errors fatal.
(StrOpt) The format for an instance that is passed with the log message.
(StrOpt) The format for an instance UUID that is passed with the log message.
(StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None (StrOpt) (Optional) The base directory used for relative --log-file paths.
log_file
= None
log_format
= None
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
193
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value log_config_append
= None
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None
log_file
= None
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None
Description
(StrOpt) 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.
logging_context_format_string
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
= %
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
(StrOpt) Prefix each line of exception output with this format.
syslog_log_facility syslog_log_facility use_syslog
= False
= LOG_USER
= LOG_USER
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
194
Configuration option = Default value use_syslog_rfc_format
= False
use_stderr use_syslog
= True
= False
use_syslog_rfc_format verbose
= False
= False
CHAPTER 2. BLOCK STORAGE
Description
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Log output to standard error.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 2.48. Description of NAS configuration options
Description Configuration option = Default value
[DEFAULT] nas_ip
=
nas_login
= admin
nas_mount_options
= None
nas_password
=
nas_private_key
=
nas_secure_file_operations
= auto
(StrOpt) IP address or Hostname of NAS system.
(StrOpt) User name to connect to NAS system.
(StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored.
(StrOpt) Password to connect to NAS system.
(StrOpt) Filename of private key to use for SSH authentication.
(StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.
195
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value nas_secure_file_permissions
= auto
nas_share_path nas_ssh_port
=
= 22
Description
(StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation:
True is used if so, otherwise False. Default is auto.
(StrOpt) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 .
(IntOpt) SSH port to use to connect to NAS system.
Table 2.49. Description of Open vStorage driver configuration options
Description Configuration option = Default value
[DEFAULT] vpool_name
= (StrOpt) Vpool to use for volumes - backend is defined by vpool not by us.
Table 2.50. Description of oslo_middleware configuration options
Description Configuration option = Default value
[oslo_middleware] max_request_body_size
= 114688 (IntOpt) The maximum body size for each request, in bytes.
Table 2.51. Description of profiler configuration options
Description Configuration option = Default value
[profiler] profiler_enabled
= False
trace_sqlalchemy
= False
(BoolOpt) If False fully disable profiling feature.
(BoolOpt) If False doesn't trace SQL requests.
196
Table 2.52. Description of Pure Storage driver configuration options
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value
[DEFAULT] pure_api_token
= None
Description
(StrOpt) REST API authorization token.
Table 2.53. Description of Qpid configuration options
Description Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname qpid_hosts qpid_password qpid_topology_version qpid_username
= localhost
= $qpid_hostname:$qpid_port
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity qpid_sasl_mechanisms qpid_tcp_nodelay
=
=
= True
= 1
= 1
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
197
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rpc_conn_pool_size
= 30
Description
(IntOpt) Size of RPC connection pool.
Table 2.54. Description of quota configuration options
Configuration option = Default value
[DEFAULT] max_age
= 0
Description quota_backup_gigabytes quota_backups
= 1000
quota_consistencygroups quota_driver
= cinder.quota.DbQuotaDriver
quota_gigabytes
= 1000
quota_snapshots quota_volumes
= 10
= 10
= 10
reservation_expire
= 86400
use_default_quota_class
= 10
= True
(IntOpt) Number of seconds between subsequent usage refreshes
(IntOpt) Total amount of storage, in gigabytes, allowed for backups per project
(IntOpt) Number of volume backups allowed per project
(IntOpt) Number of consistencygroups allowed per project
(StrOpt) Default driver to use for quota checks
(IntOpt) Total amount of storage, in gigabytes, allowed for volumes and snapshots per project
(IntOpt) Number of volume snapshots allowed per project
(IntOpt) Number of volumes allowed per project
(IntOpt) Number of seconds until a reservation expires
(BoolOpt) Enables or disables use of default quota class with default quota.
198
Table 2.55. Description of RabbitMQ configuration options
Description Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
amqp_durable_queues
= False
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
Configuration option = Default value fake_rabbit
= False
heartbeat_rate
= 2
heartbeat_timeout_threshold kombu_reconnect_delay kombu_ssl_ca_certs
=
kombu_ssl_certfile
=
kombu_ssl_keyfile
=
kombu_ssl_version
=
rabbit_ha_queues
= 1.0
= False
= 0
rabbit_host
= localhost
rabbit_hosts
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_password
= guest
rabbit_port
= 5672
CHAPTER 2. BLOCK STORAGE
Description
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
199
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rabbit_retry_backoff
= 2
rabbit_retry_interval rabbit_use_ssl
= False
rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 1
= 30
Description
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
Table 2.56. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
200
Table 2.57. Description of RPC configuration options
Description Configuration option = Default value
[DEFAULT] matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
rpc_cast_timeout
= 30
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value Description rpc_response_timeout disable_process_locking
= False
lock_path
= None
= 60
rpc_thread_pool_size
= 64
volume_topic
= cinder-volume
[oslo_concurrency]
[oslo_messaging_amqp] allow_insecure_clients
= False
broadcast_prefix
= broadcast
container_name
= None
group_request_prefix
= unicast
idle_timeout
= 0
server_request_prefix
= exclusive
ssl_ca_file
=
ssl_cert_file
=
ssl_key_file
=
(IntOpt) Seconds to wait for a response from a call.
(IntOpt) Size of RPC thread pool.
(StrOpt) The topic that volume nodes listen on
(BoolOpt) Enables or disables inter-process locks.
(StrOpt) 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 external locks are used, a lock path must be set.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
201
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value ssl_key_password
= None
trace
= False
Description
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
Table 2.58. Description of SAN configuration options
Description Configuration option = Default value
[DEFAULT] san_clustername
=
san_ip
=
san_is_local
= False
san_login
= admin
san_password
=
san_private_key
=
san_secondary_ip
= None
san_ssh_port
= 22
san_thin_provision
= True
ssh_conn_timeout
= 30
ssh_max_pool_conn
= 5
ssh_min_pool_conn
= 1
(StrOpt) Cluster name to use for creating volumes
(StrOpt) IP address of SAN controller
(BoolOpt) Execute commands locally instead of over SSH; use if the volume service is running on the SAN device
(StrOpt) Username for SAN controller
(StrOpt) Password for SAN controller
(StrOpt) Filename of private key to use for SSH authentication
(StrOpt) VNX secondary SP IP Address.
(IntOpt) SSH port to use with SAN
(BoolOpt) Use thin provisioning for SAN volumes?
(IntOpt) SSH connection timeout in seconds
(IntOpt) Maximum ssh connections in the pool
(IntOpt) Minimum ssh connections in the pool
Table 2.59. Description of scheduler configuration options
Description Configuration option = Default value
[DEFAULT]
202
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value filter_function
= None
goodness_function
= None
scheduler_default_filters
=
AvailabilityZoneFilter, CapacityFilter,
CapabilitiesFilter
scheduler_default_weighers
=
CapacityWeigher
scheduler_driver
=
cinder.scheduler.filter_scheduler.FilterScheduler
scheduler_host_manager
=
cinder.scheduler.host_manager.HostManager
scheduler_json_config_location
=
scheduler_manager scheduler_topic
=
cinder.scheduler.manager.SchedulerManager
scheduler_max_attempts
= 3
= cinder-scheduler
Description
(StrOpt) String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler.
(StrOpt) String representation for an equation that will be used to determine the goodness of a host.
Only used when using the goodness weigher is set to be used by the Cinder scheduler.
(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.
(ListOpt) Which weigher class names to use for weighing hosts.
(StrOpt) Default scheduler driver to use
(StrOpt) The scheduler host manager class to use
(StrOpt) Absolute path to scheduler configuration
JSON file.
(StrOpt) Full class name for the Manager for scheduler
(IntOpt) Maximum number of attempts to schedule an volume
(StrOpt) The topic that scheduler nodes listen on
Table 2.60. Description of SCST volume driver configuration options
Description Configuration option = Default value
[DEFAULT] scst_target_driver
= iscsi
scst_target_iqn_name
= None
(StrOpt) SCST target implementation can choose from multiple SCST target drivers.
(StrOpt) Certain ISCSI targets have predefined target names, SCST target driver uses this name.
Table 2.61. Description of Scality REST Block storage driver configuration options
203
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] srb_base_urls
= None (StrOpt) Comma-separated list of REST servers IP to connect to. (eg http://IP1/,http://IP2:81/path
Table 2.62. Description of storage configuration options
Configuration option = Default value
[DEFAULT]
Description allocated_capacity_weight_multipli er
= -1.0
(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.
capacity_weight_multiplier
= 1.0
enabled_backends iscsi_helper iscsi_iotype iscsi_port
= 3260
= None
= tgtadm
= fileio
iscsi_ip_address
= $my_ip
iscsi_num_targets
= None
(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.
(ListOpt) A list of backend names to use. These backend names should be backed by a unique
[CONFIG] group with its options
(StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, iseradm for the
ISER protocol, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing.
(StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device
(StrOpt) The IP address that the iSCSI daemon is listening on
(IntOpt) This option is deprecated and unused. It will be removed in the Liberty release.
(IntOpt) The port that the iSCSI daemon is listening on
204
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value iscsi_protocol
= iscsi
Description
(StrOpt) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and
"iser".
(StrOpt) Prefix for iSCSI volumes
iscsi_target_prefix
= iqn.2010-
10.org.openstack:
iscsi_write_cache
= on
iser_helper iser_port
= tgtadm
iser_ip_address
= $my_ip
iser_num_targets
= 3260
volume_backend_name volume_clear
= None
= zero
= None
(StrOpt) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off).
This parameter is valid if iscsi_helper is set to tgtadm or iseradm.
(StrOpt) The name of the iSER target user-land tool to use
(StrOpt) The IP address that the iSER daemon is listening on
(IntOpt) This option is deprecated and unused. It will be removed in the Liberty release.
(IntOpt) The port that the iSER daemon is listening on
(StrOpt) Prefix for iSER volumes
iser_target_prefix
= iqn.2010-
10.org.openstack:
max_gigabytes
= 10000 (IntOpt) This configure option has been deprecated along with the SimpleScheduler. New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed. It's safe to remove this configure from cinder.conf.
migration_create_volume_timeout_se cs
= 300
(IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds)
num_iser_scan_tries
= 3 (IntOpt) The maximum number of times to rescan iSER targetto find volume
num_volume_device_scan_tries
= 3 (IntOpt) The maximum number of times to rescan targets to find volume
(StrOpt) The backend name for a given driver implementation
(StrOpt) Method used to wipe old volumes
205
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value volume_clear_ionice
= None
volume_clear_size volume_copy_blkio_cgroup_name
cinder-volume-copy
volume_copy_bps_limit volume_dd_blocksize
= 0
=
volume_driver
=
cinder.volume.drivers.lvm.LVMISCSIDriver
volume_manager
=
cinder.volume.manager.VolumeManager
volume_service_inithost_offload
=
False
volume_usage_audit_period
= month
volumes_dir
= 0
= 1M
= $state_path/volumes
Description
(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority.
(IntOpt) Size in MiB to wipe at start of old volumes.
0 => all
(StrOpt) The blkio cgroup name to be used to limit bandwidth of volume copy
(IntOpt) The upper limit of bandwidth of volume copy. 0 => unlimited
(StrOpt) The default block size used when copying/clearing volumes
(StrOpt) Driver to use for volume creation
(StrOpt) Full class name for the Manager for volume
(BoolOpt) Offload pending volume delete during volume service startup
(StrOpt) Time period for which to generate volume usages. The options are hour, day, month, or year.
(StrOpt) Volume configuration file storage directory
Table 2.63. Description of Violin volume driver configuration options
Description Configuration option = Default value
[DEFAULT] gateway_mga
= None
gateway_mgb
= None
use_igroups
= False
(StrOpt) IP address or hostname of mg-a
(StrOpt) IP address or hostname of mg-b
(BoolOpt) Use igroups to manage targets and initiators
Table 2.64. Description of zones configuration options
206
CHAPTER 2. BLOCK STORAGE
Configuration option = Default value
[DEFAULT] cloned_volume_same_az
= True
Description
(BoolOpt) Ensure that the new volumes are the same AZ as snapshot or source volume
2.8. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
OPENSTACK BLOCK STORAGE
Table 2.65. New options
Option = default value
[DEFAULT] backend_host = None
(Type) Help string
(StrOpt) Backend override of host value.
[DEFAULT] backup_container = None (StrOpt) Custom container to use for backups.
[DEFAULT] backup_enable_progress_timer = True (BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage.
The default value is True to enable the timer.
[DEFAULT] backup_file_size = 1999994880 (IntOpt) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files.
[DEFAULT] backup_mount_options = None
[DEFAULT] backup_mount_point_base =
$state_path/backup_mount
(StrOpt) Mount options passed to the NFS client.
See NFS man page for details.
(StrOpt) Base dir containing mount point for NFS share.
[DEFAULT] backup_object_number_per_notification = 10
[DEFAULT] backup_sha_block_size_bytes =
32768
[DEFAULT] backup_share = None
[DEFAULT] backup_swift_block_size = 32768
(IntOpt) The number of chunks or objects, for which one Ceilometer notification will be sent
(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.
(StrOpt) NFS share in fqdn:path, ipv4addr:path, or
"[ipv6addr]:path" format.
(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.
207
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] backup_swift_enable_progress_timer
= True
[DEFAULT] backup_timer_interval = 120
(Type) Help string
(BoolOpt) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the Swift backend storage. The default value is True to enable the timer.
(IntOpt) Interval, in seconds, between two progress notifications reporting the backup status
[DEFAULT] cb_account_name = None
[DEFAULT] cb_add_qosgroup = {'latency': '15',
'iops': '10', 'graceallowed': 'false', 'iopscontrol':
'true', 'memlimit': '0', 'throughput': '0', 'tpcontrol':
'false', 'networkspeed': '0'}
[DEFAULT] cb_apikey = None
(StrOpt) CloudByte storage specific account name.
This maps to a project name in OpenStack.
(DictOpt) These values will be used for CloudByte storage's addQos API call.
(StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface.
[DEFAULT] cb_confirm_volume_create_retries = 3 (IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.
[DEFAULT] cb_confirm_volume_create_retry_interval = 5
(IntOpt) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage.
(DictOpt) These values will be used for CloudByte storage's createVolume API call.
[DEFAULT] cb_create_volume = {'compression':
'off', 'deduplication': 'off', 'blocklength': '512B',
'sync': 'always', 'protocoltype': 'ISCSI', 'recordsize':
'16k'}
[DEFAULT] cb_tsm_name = None (StrOpt) This corresponds to the name of Tenant
Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM.
[DEFAULT] chap_password =
[DEFAULT] chap_username =
(StrOpt) Password for specified CHAP account name.
(StrOpt) CHAP user name.
[DEFAULT] check_max_pool_luns_threshold =
False
[DEFAULT] chiscsi_conf = /etc/chelsioiscsi/chiscsi.conf
(BoolOpt) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached.
By default, the value is False.
(StrOpt) Chiscsi (CXT) global defaults configuration file
208
CHAPTER 2. BLOCK STORAGE
Option = default value
[DEFAULT] dell_sc_api_port = 3033
[DEFAULT] dell_sc_server_folder = openstack
[DEFAULT] dell_sc_ssn = 64702
[DEFAULT] dell_sc_volume_folder = openstack
[DEFAULT] driver_data_namespace = None
[DEFAULT] driver_use_ssl = False
[DEFAULT] end_time = None
[DEFAULT] enforce_multipath_for_image_xfer =
False
[DEFAULT] filter_function = None
(Type) Help string
(IntOpt) Dell API port
(StrOpt) Name of the server folder to use on the
Storage Center
(IntOpt) Storage Center System Serial Number
(StrOpt) Name of the volume folder to use on the
Storage Center
(StrOpt) Namespace for driver private data values to be saved in.
(BoolOpt) Tell driver to use SSL for connection to backend storage if the driver supports it.
(StrOpt) If this option is specified then the end time specified is used instead of the end time of the last completed audit period.
(BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.
(StrOpt) String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler.
[DEFAULT] flashsystem_connection_protocol = FC (StrOpt) Connection protocol should be FC.
[DEFAULT] flashsystem_multihostmap_enabled =
True
(BoolOpt) Allows vdisk to multi host mapping.
(BoolOpt) Connect with multipath (FC only).
[DEFAULT] flashsystem_multipath_enabled =
False
[DEFAULT] force_delete_lun_in_storagegroup =
False
[DEFAULT] gateway_mga = None
[DEFAULT] gateway_mgb = None
[DEFAULT] goodness_function = None
(BoolOpt) Delete a LUN even if it is in Storage
Groups.
(StrOpt) IP address or hostname of mg-a
(StrOpt) IP address or hostname of mg-b
(StrOpt) String representation for an equation that will be used to determine the goodness of a host.
Only used when using the goodness weigher is set to be used by the Cinder scheduler.
209
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] initiator_auto_deregistration = False
[DEFAULT] iscsi_protocol = iscsi
[DEFAULT] iscsi_secondary_ip_addresses =
[DEFAULT] ise_completion_retries = 30
[DEFAULT] ise_connection_retries = 5
[DEFAULT] ise_raid = 1
[DEFAULT] ise_retry_interval = 1
[DEFAULT] ise_storage_pool = 1
[DEFAULT] log-config-append = None
[DEFAULT] log-date-format = %Y-%m-%d
%H:%M:%S
[DEFAULT] log-dir = None
[DEFAULT] log-file = None
[DEFAULT] log-format = None
(Type) Help string
(BoolOpt) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False.
(StrOpt) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and
"iser".
(ListOpt) The list of secondary IP addresses of the iSCSI daemon
(IntOpt) Number on retries to get completion status after issuing a command to ISE.
(IntOpt) Number of retries (per port) when establishing connection to ISE management port.
(IntOpt) Raid level for ISE volumes.
(IntOpt) Interval (secs) between retries.
(IntOpt) Default storage pool for volumes.
(StrOpt) 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.
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
210
CHAPTER 2. BLOCK STORAGE
Option = default value
[DEFAULT] lvm_conf_file = /etc/cinder/lvm.conf
[DEFAULT] max_over_subscription_ratio = 20.0
[DEFAULT] nas_mount_options = None
[DEFAULT] nas_secure_file_operations = auto
[DEFAULT] nas_secure_file_permissions = auto
[DEFAULT] nas_share_path =
[DEFAULT] netapp_partner_backend_name =
None
(Type) Help string
(StrOpt) LVM conf file to use for the LVM driver in
Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists).
(FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead.
(StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored.
(StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.
(StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation:
True is used if so, otherwise False. Default is auto.
(StrOpt) Path to the share to use for storing Cinder volumes. For example: "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 .
(StrOpt) The name of the config.conf stanza for a
Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.
211
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] nfs_mount_attempts = 3
[DEFAULT] os_privileged_user_name = None
[DEFAULT] os_privileged_user_password = None
[DEFAULT] os_privileged_user_tenant = None
[DEFAULT] policy_dirs = ['policy.d']
[DEFAULT] public_endpoint = None
[DEFAULT] quobyte_client_cfg = None
[DEFAULT] quobyte_mount_point_base =
$state_path/mnt
[DEFAULT] quobyte_qcow2_volumes = True
[DEFAULT] quobyte_sparsed_volumes = True
[DEFAULT] quobyte_volume_url = None
[DEFAULT] request_timeout = 300
[DEFAULT] scst_target_driver = iscsi
(Type) Help string
(IntOpt) The number of attempts to mount nfs shares before raising an error. At least one attempt will be made to mount an nfs share, regardless of the value specified.
(StrOpt) OpenStack privileged account username.
Used for requests to other services (such as Nova) that require an account with special rights.
(StrOpt) Password associated with the OpenStack privileged account.
(StrOpt) Tenant name associated with the
OpenStack privileged account.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If
Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.
(StrOpt) Path to a Quobyte Client configuration file.
(StrOpt) Base dir containing the mount point for the
Quobyte volume.
(BoolOpt) Create volumes as QCOW2 files rather than raw files.
(BoolOpt) Create volumes as sparse files which take no space. If set to False, volume is created as regular file.In such case volume creation takes a lot of time.
(StrOpt) URL to the Quobyte volume e.g., quobyte://<DIR host>/<volume name>
(IntOpt) Global backend request timeout, in seconds
(StrOpt) SCST target implementation can choose from multiple SCST target drivers.
212
Option = default value
[DEFAULT] scst_target_iqn_name = None
[DEFAULT] send_actions = False
[DEFAULT] sf_allow_template_caching = True
[DEFAULT] sf_template_account_name = openstack-vtemplate
[DEFAULT] srb_base_urls = None
[DEFAULT] start_time = None
[DEFAULT] syslog-log-facility = LOG_USER
[DEFAULT] use-syslog = False
[DEFAULT] use-syslog-rfc-format = False
[DEFAULT] use_chap_auth = False
[DEFAULT] use_igroups = False
[DEFAULT] vpool_name =
[DEFAULT] xtremio_cluster_name =
[DEFAULT] zfssa_data_ip = None
[DEFAULT] zfssa_https_port = 443
CHAPTER 2. BLOCK STORAGE
(Type) Help string
(StrOpt) Certain ISCSI targets have predefined target names, SCST target driver uses this name.
(BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period.
(BoolOpt) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls.
(StrOpt) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist).
(StrOpt) Comma-separated list of REST servers IP to connect to. (eg http://IP1/,http://IP2:81/path
(StrOpt) If this option is specified then the start time specified is used instead of the start time of the last completed audit period.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Option to enable/disable CHAP authentication for targets.
(BoolOpt) Use igroups to manage targets and initiators
(StrOpt) Vpool to use for volumes - backend is defined by vpool not by us.
(StrOpt) XMS cluster id in multi-cluster environment
(StrOpt) Data path IP address
(StrOpt) HTTPS port number
213
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] zfssa_nfs_mount_options =
[DEFAULT] zfssa_nfs_pool =
[DEFAULT] zfssa_nfs_project = NFSProject
[DEFAULT] zfssa_nfs_share = nfs_share
[DEFAULT] zfssa_nfs_share_compression = off
[DEFAULT] zfssa_nfs_share_logbias = latency
(Type) Help string
(StrOpt) Options to be passed while mounting share over nfs
(StrOpt) Storage pool name.
(StrOpt) Project name.
(StrOpt) Share name.
(StrOpt) Data compression.
(StrOpt) Synchronous write bias-latency, throughput.
(BoolOpt) Enables or disables inter-process locks.
[oslo_concurrency] disable_process_locking =
False
[oslo_concurrency] lock_path = None
[oslo_messaging_amqp] allow_insecure_clients =
False
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
[oslo_messaging_amqp] ssl_key_file =
(StrOpt) 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 external locks are used, a lock path must be set.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
214
CHAPTER 2. BLOCK STORAGE
Option = default value
[oslo_messaging_amqp] ssl_key_password =
None
[oslo_messaging_amqp] trace = False
(Type) Help string
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] amqp_durable_queues =
False
[oslo_messaging_qpid] qpid_heartbeat = 60
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
(IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
[oslo_messaging_qpid] qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
[oslo_messaging_qpid] qpid_sasl_mechanisms = (StrOpt) Space separated list of SASL mechanisms to use for auth.
[oslo_messaging_qpid] qpid_tcp_nodelay = True
[oslo_messaging_qpid] qpid_topology_version = 1
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30
[oslo_messaging_rabbit] amqp_auto_delete =
False
[oslo_messaging_rabbit] amqp_durable_queues =
False
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
215
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] fake_rabbit = False
[oslo_messaging_rabbit] heartbeat_rate = 2
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(Type) Help string
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
[oslo_messaging_rabbit] rabbit_port = 5672
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
216
CHAPTER 2. BLOCK STORAGE
Option = default value
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
[oslo_messaging_rabbit] rabbit_retry_interval = 1
[oslo_messaging_rabbit] rabbit_use_ssl = False
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
(Type) Help string
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
[oslo_messaging_rabbit] rpc_conn_pool_size = 30 (IntOpt) Size of RPC connection pool.
[oslo_middleware] max_request_body_size =
114688
(IntOpt) The maximum body size for each request, in bytes.
Table 2.66. New default values
Option
[DEFAULT] backup_metadata_version
[DEFAULT] client_socket_timeout
[DEFAULT] default_log_levels
Previous default value
1
0
New default value
2
900
[DEFAULT] iscsi_num_targets
[DEFAULT] iser_num_targets
[DEFAULT] iser_target_prefix amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retr
y=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN
100 None
100 iqn.2010-10.org.iser.openstack:
None iqn.2010-10.org.openstack:
217
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option
[DEFAULT] nova_catalog_admin_info
[DEFAULT] nova_catalog_info
[DEFAULT] rpc_zmq_matchmaker
[keymgr] encryption_auth_url
Previous default value compute:nova:adminURL compute:nova:publicURL
New default value compute:Compute
Service:adminURL compute:Compute
Service:publicURL oslo.messaging._drivers.matchm
aker.MatchMakerLocalhost
local http://localhost:5000/v2.0
http://localhost:5000/v3
Table 2.67. Deprecated options
Deprecated option
[DEFAULT] log-format
[DEFAULT] use-syslog
[DEFAULT] use_syslog
[DEFAULT] osapi_max_request_body_size
[DEFAULT] eqlx_chap_password
[DEFAULT] datera_api_token
[DEFAULT] eqlx_use_chap
[DEFAULT] enable_v1_api
[DEFAULT] db_backend
[DEFAULT] host
[DEFAULT] eqlx_chap_login
[DEFAULT] log_format
New Option
None
None
None
[oslo_middleware] max_request_body_size
[DEFAULT] chap_password
None
[DEFAULT] use_chap_auth
None
[database] backend
[DEFAULT] backend_host
[DEFAULT] chap_username
None
The configuration file location may differ.
There is no relative precedence or weight among these four labels.
218
Do not confuse differentiated services with the OpenStack Block Storage volume services.
CHAPTER 2. BLOCK STORAGE
[3]
Do not confuse differentiated services with the OpenStack Block Storage volume services.
It is okay to manage multiple HUS arrays by using multiple OpenStack Block Storage instances (or
servers).
The configuration file location may differ.
Each of these four labels has no relative precedence or weight.
The get_volume_stats() always provides the available capacity based on the combined sum of all the
HDPs that are used in these services labels.
219
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
CHAPTER 3. COMPUTE
The OpenStack Compute service is a cloud computing fabric controller, which is the main part of an
IaaS system. You can use OpenStack Compute to host and manage cloud computing systems. This section describes the OpenStack Compute configuration options.
To configure your Compute installation, you must define configuration options in these files:
nova.conf. Contains most of the Compute configuration options. Resides in the /etc/nova/ directory.
api-paste.ini. Defines Compute limits. Resides in the /etc/nova/ directory.
Related Image service and Identity service management configuration files.
Ephemeral Storage Discrepancy with Ceph
When using Red Hat Ceph as a back end for ephemeral storage, the Compute service does not calculate the amount of available storage correctly. Specifically, Compute simply adds up the amount of available storage without factoring in replication. This results in grossly overstated available storage, which in turn could cause unexpected storage oversubscription.
To determine the correct ephemeral storage capacity, query the Ceph service directly instead. For more information, see BZ#1236473 .
3.1. OVERVIEW OF NOVA.CONF
You can use a particular configuration option file by using the option (nova.conf) parameter when you run one of the nova-* services. This parameter inserts configuration option definitions from the specified configuration file name, which might be useful for debugging or performance tuning.
For a list of configuration options, see the tables in this guide.
To learn more about the nova.conf configuration file, review the general purpose configuration options documented in
Table 3.19, “Description of common configuration options” .
Important
Do not specify quotes around Nova options.
Sections
Configuration options are grouped by section. The Compute configuration file supports the following sections:
220
CHAPTER 3. COMPUTE
[DEFAULT]
Contains most configuration options. If the documentation for a configuration option does not specify its section, assume that it appears in this section.
[baremetal]
Configures the baremetal hypervisor driver.
[cells]
Configures cells functionality. For details, see Section 3.13, “Cells” .
[conductor]
Configures the nova-conductor service.
[database]
Configures the database that Compute uses.
[glance]
Configures how to access the Image service.
[image_file_url]
Configures additional filesystems to access the Image Service.
[keymgr]
Configures the key manager.
[keystone_authtoken]
Configures authorization via Identity service.
[libvirt]
Configures the hypervisor drivers using the Libvirt library: KVM, LXC, Qemu, UML, Xen.
[matchmaker_redis]
Configures a Redis server.
[matchmaker_ring]
221
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configures a matchmaker ring.
[metrics]
Configures weights for the metrics weighter.
[neutron]
Configures Networking specific options.
[osapi_v3]
Configures the OpenStack Compute API v3.
[rdp]
Configures RDP proxying.
[serial_console]
Configures serial console.
[spice]
Configures virtual consoles using SPICE.
[ssl]
Configures certificate authority using SSL.
[trusted_computing]
Configures the trusted computing pools functionality and how to connect to a remote attestation service.
[upgrade_levels]
Configures version locking on the RPC (message queue) communications between the various Compute services to allow live upgrading an OpenStack installation.
[vmware]
Configures the VMware hypervisor driver.
[xenserver]
Configures the XenServer hypervisor driver.
222
CHAPTER 3. COMPUTE
[zookeeper]
Configures the ZooKeeper ServiceGroup driver.
3.2. CONFIGURE LOGGING
You can use the nova.conf file to configure where Compute logs events, the level of logging, and log formats.
To customize log formats for OpenStack Compute, use the configuration option settings
documented in Table 3.37, “Description of logging configuration options”
.
3.3. CONFIGURE AUTHENTICATION AND AUTHORIZATION
There are different methods of authentication for the OpenStack Compute project, including no authentication. The preferred system is the OpenStack Identity service, code-named Keystone.
To customize authorization settings for Compute, use the configuration options documented in
Table 3.13, “Description of authentication configuration options”
.
To customize certificate authority settings for Compute, use the configuration options documented in
Table 3.17, “Description of CA and SSL configuration options” .
To customize Compute and the Identity service to use LDAP as a backend, refer to the configuration options documented in
Table 3.34, “Description of LDAP configuration options”
.
3.4. CONFIGURE RESIZE
Resize (or Server resize) is the ability to change the flavor of a server, thus allowing it to upscale or downscale according to user needs. For this feature to work properly, you might need to configure some underlying virt layers.
3.4.1. KVM
Resize on KVM is implemented currently by transferring the images between compute nodes over ssh. For KVM you need hostnames to resolve properly and passwordless ssh access between your compute hosts. Direct access from one compute host to another is needed to copy the VM file across.
3.5. DATABASE CONFIGURATION
You can configure OpenStack Compute to use any SQLAlchemy-compatible database. The database name is nova. The nova-conductor service is the only service that writes to the database. The other Compute services access the database through the nova-conductor service.
223
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
To ensure that the database schema is current, run the following command:
# nova-manage db sync
If nova-conductor is not used, entries to the database are mostly written by the nova-
scheduler service, although all services must be able to update entries in the database.
3.6. CONFIGURE THE OSLO RPC MESSAGING SYSTEM
OpenStack projects use AMQP, an open standard for messaging middleware. OpenStack services that run on multiple servers to talk to each other. OpenStack Oslo RPC supports two implementations of AMQP: RabbitMQ and Qpid.
3.6.1. Configure RabbitMQ
OpenStack Oslo RPC uses RabbitMQ by default. Use these options to configure the RabbitMQ message system. The rpc_backend option is not required as long as RabbitMQ is the default messaging system. However, if it is included the configuration, you must set it to rabbit.
rpc_backend=rabbit
You can use these additional options to configure the RabbitMQ messaging system. You can configure messaging communication for different installation scenarios, tune retries for RabbitMQ, and define the size of the RPC thread pool. To monitor notifications through RabbitMQ, you must set the notification_driver option to
nova.openstack.common.notifier.rpc_notifier in the nova.conf file. The default for sending usage data is sixty seconds plus a random number of seconds from zero to sixty.
Table 3.1. Description of RabbitMQ configuration options
Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
amqp_durable_queues
= False
fake_rabbit
= False
Description
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
224
Configuration option = Default value heartbeat_rate
= 2
heartbeat_timeout_threshold
= 0
kombu_reconnect_delay
= 1.0
kombu_ssl_ca_certs
=
kombu_ssl_certfile
=
kombu_ssl_keyfile
=
kombu_ssl_version
=
rabbit_ha_queues
= False
rabbit_host
= localhost
rabbit_hosts
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_password
= guest
rabbit_port
= 5672
rabbit_retry_backoff
= 2
rabbit_retry_interval
= 1
CHAPTER 3. COMPUTE
Description
(IntOpt) How often times during the heartbeat_timeout_threshold to check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 are also available.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
225
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rabbit_use_ssl
= False
rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
Description
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
3.6.2. Configure Qpid
Use these options to configure the Qpid messaging system for OpenStack Oslo RPC. Qpid is not the default messaging system, so you must enable it by setting the rpc_backend option in the
nova.conf file.
rpc_backend=qpid
This critical option points the compute nodes to the Qpid broker (server). Set qpid_hostname to the host name where the broker runs in the nova.conf file.
Note
The --qpid_hostname parameter accepts a host name or IP address value.
qpid_hostname=hostname.example.com
If the Qpid broker listens on a port other than the AMQP default of 5672, you must set the
qpid_port option to that value: qpid_port=12345
If you configure the Qpid broker to require authentication, you must add a user name and password to the configuration: qpid_username=username qpid_password=password
By default, TCP is used as the transport. To enable SSL, set the qpid_protocol option: qpid_protocol=ssl
This table lists additional options that you use to configure the Qpid messaging driver for OpenStack
Oslo RPC. These options are used infrequently.
226
CHAPTER 3. COMPUTE
Table 3.2. Description of Qpid configuration options
Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname
= localhost
qpid_hosts
= $qpid_hostname:$qpid_port
qpid_password
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity
= 1
qpid_sasl_mechanisms
=
qpid_tcp_nodelay
= True
qpid_topology_version
= 1
Description
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
qpid_username
=
rpc_conn_pool_size
= 30
3.6.3. Configure messaging
Use these options to configure the RabbitMQ and Qpid messaging drivers.
Table 3.3. Description of AMQP configuration options
227
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] control_exchange
= openstack
default_publisher_id notification_driver notification_topics transport_url
= None
= None
= []
= notifications
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
(StrOpt) Default publisher_id for outgoing notifications
(MultiStrOpt) Driver or drivers to handle sending notifications.
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, fall back to the rpc_backend option and driver specific configuration.
Table 3.4. Description of RPC configuration options
Description Configuration option = Default value
[DEFAULT] matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
rpc_cast_timeout
[cells]
= 30
rpc_response_timeout rpc_thread_pool_size
= 60
= 64
rpc_driver_queue_base
= cells.intercell
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
(IntOpt) Size of RPC thread pool.
(StrOpt) Base queue name to use when communicating between cells. Various topics by message type will be appended to this.
[oslo_concurrency]
228
Configuration option = Default value disable_process_locking
= False
lock_path
= None
CHAPTER 3. COMPUTE
Description
(BoolOpt) Enables or disables inter-process locks.
(StrOpt) 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 external locks are used, a lock path must be set.
[oslo_messaging_amqp] allow_insecure_clients
= False
broadcast_prefix
= broadcast
container_name
= None
group_request_prefix
= unicast
idle_timeout
= 0
server_request_prefix
= exclusive
ssl_ca_file
=
ssl_cert_file
=
ssl_key_file
=
ssl_key_password
= None
trace
= False
[upgrade_levels] baseapi
= None
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
(StrOpt) Set a version cap for messages sent to the base api in any service
3.7. CONFIGURE THE COMPUTE API
229
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The Compute API, run by the nova-api daemon, is the component of OpenStack Compute that receives and responds to user requests, whether they be direct API calls, or via the CLI tools or dashboard.
Configure Compute API password handling
The OpenStack Compute API enables users to specify an administrative password when they create or rebuild a server instance. If the user does not specify a password, a random password is generated and returned in the API response.
In practice, how the admin password is handled depends on the hypervisor in use and might require additional configuration of the instance. For example, you might have to install an agent to handle the password setting. If the hypervisor and instance configuration do not support setting a password at server create time, the password that is returned by the create API call is misleading because it was ignored.
To prevent this confusion, use the enable_instance_password configuration option to disable the return of the admin password for installations that do not support setting instance passwords.
Configure Compute API rate limiting
OpenStack Compute supports API rate limiting for the OpenStack API. The rate limiting allows an administrator to configure limits on the type and number of API calls that can be made in a specific time interval.
When API rate limits are exceeded, HTTP requests return an error with a status code of 403
Forbidden.
Rate limiting is not available for the EC2 API.
Define limits
To define limits, set these values:
The HTTP method used in the API call, typically one of GET, PUT, POST, or DELETE.
A human readable URI that is used as a friendly description of where the limit is applied.
A regular expression. The limit is applied to all URIs that match the regular expression and
HTTP method.
A limit value that specifies the maximum count of units before the limit takes effect.
An interval that specifies time frame to which the limit is applied. The interval can be SECOND,
MINUTE, HOUR, or DAY.
230
Rate limits are applied in relative order to the HTTP method, going from least to most specific.
CHAPTER 3. COMPUTE
Default limits
Normally, you install OpenStack Compute with the following limits enabled:
Table 3.5. Default API rate limits
HTTP method
POST
POST
PUT
GET
DELETE
GET
API URI
any URI (*)
/servers any URI (*)
*changes-since* any URI (*)
*/os-fping
API regular expression
.*
^/servers
.*
.*changes-since.*
.*
^/os-fping
Limit
120 per minute
120 per minute
120 per minute
120 per minute
120 per minute
12 per minute
Configure and change limits
As part of the WSGI pipeline, the /etc/nova/api-paste.ini file defines the actual limits.
To enable limits, include the ratelimit filter in the API pipeline specification. If the ratelimit filter is removed from the pipeline, limiting is disabled. You must also define the rate limit filter. The lines appear as follows:
[pipeline:openstack_compute_api_v2] pipeline = faultwrap authtoken keystonecontext ratelimit osapi_compute_app_v2
[pipeline:openstack_volume_api_v1] pipeline = faultwrap authtoken keystonecontext ratelimit osapi_volume_app_v1
[filter:ratelimit] paste.filter_factory = nova.api.openstack.compute.limits:RateLimitingMiddleware.factory
To modify the limits, add a limits specification to the [filter:ratelimit] section of the file.
Specify the limits in this order:
1. HTTP method
2. friendly URI
231
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
3. regex
4. limit
5. interval
The following example shows the default rate-limiting values:
[filter:ratelimit] paste.filter_factory = nova.api.openstack.compute.limits:RateLimitingMiddleware.factory
limits =(POST, "*", .*, 120, MINUTE);(POST, "*/servers", ^/servers, 120,
MINUTE);(PUT, "*", .*, 120, MINUTE);(GET, "*changes-since*", .*changessince.*, 120, MINUTE);(DELETE, "*", .*, 120, MINUTE);(GET, "*/os-fping",
^/os-fping, 12, MINUTE)
Configuration reference
3.8. CONFIGURE THE EC2 API
You can set options in the nova.conf configuration file to control which network address and port the EC2 API listens on, the formatting of some API responses, and authentication related options.
To customize these options for OpenStack EC2 API, use the configuration option settings
documented in Table 3.26, “Description of EC2 configuration options”
.
3.9. FIBRE CHANNEL SUPPORT IN COMPUTE
Fibre Channel support in OpenStack Compute is remote block storage attached to compute nodes for VMs.
In the Grizzly release, Fibre Channel supported only the KVM hypervisor.
Compute and Block Storage support Fibre Channel automatic zoning on Brocade and Cisco switches. On other hardware Fibre Channel arrays must be pre-zoned or directly attached to the
KVM hosts.
3.9.1. KVM host requirements
You must install these packages on the KVM host: sysfsutils - Nova uses the systool application in this package.
232
CHAPTER 3. COMPUTE
sg3-utils or sg3_utils - Nova uses the sg_scan and sginfo applications.
Installing the multipath-tools package is optional.
3.9.2. Install required packages
Use this command to install the system packages:
# yum install sysfsutils sg3_utils multipath-tools
3.10. ISCSI INTERFACE AND OFFLOAD SUPPORT IN COMPUTE
Note
iSCSI interface and offload support is only present since Kilo.
Compute supports open-iscsi iSCSI interfaces for offload cards. Offload hardware must be present and configured on every compute node where offload is desired. Once an open-iscsi interface is configured, the iface name (iface.iscsi_ifacename) should be passed to libvirt via the
iscsi_iface parameter for use. All iscsi sessions will be bound to this iSCSI interface.
Currently supported transports (iface.transport_name) are be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs . No configuration changes are needed outside of Compute node.
iSER is currently supported via the separate iSER LibvirtISERVolumeDriver and will be rejected if used via the iscsi_iface parameter.
3.10.1. iSCSI iface configuration
Note the distinction between the transport name (iface.transport_name) and iface name
(iface.iscsi_ifacename). The actual iface name must be specified via the iscsi_iface parameter to libvirt for offload to work.
The default name for an iscsi iface (open-iscsi parameter iface.iscsi_ifacename) is in the format transport_name.hwaddress when generated by iscsiadm.
iscsiadm can be used to view and generate current iface configuration. Every network interface that supports an open-iscsi transport can have one or more iscsi ifaces associated with it. If no ifaces have been configured for a network interface supported by an open-iscsi transport, this command will create a default iface configuration for that network interface. For example :
# iscsiadm -m iface
default tcp,<empty>,<empty>,<empty>,<empty>
iser iser,<empty>,<empty>,<empty>,<empty>
bnx2i.00:05:b5:d2:a0:c2 bnx2i,00:05:b5:d2:a0:c2,5.10.10.20,
<empty>,<empty>
233
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
cxgb4i.00:07:43:28:b2:58 cxgb4i,00:07:43:28:b2:58,102.50.50.80,
<empty>,<empty>
qla4xxx.00:c0:dd:08:63:ea qla4xxx,00:c0:dd:08:63:ea,20.15.0.9,
<empty>,<empty>
The output is in the format : iface_name transport_name,hwaddress,ipaddress,net_ifacename,initiatorname.
Individual iface configuration can be viewed via
# iscsiadm -m iface -I IFACE_NAME
# BEGIN RECORD 2.0-873
iface.iscsi_ifacename = cxgb4i.00:07:43:28:b2:58
iface.net_ifacename = <empty>
iface.ipaddress = 102.50.50.80
iface.hwaddress = 00:07:43:28:b2:58
iface.transport_name = cxgb4i
iface.initiatorname = <empty>
# END RECORD
Configuration can be updated as desired via
# iscsiadm -m iface-I IFACE_NAME--op=update -n iface.SETTING -v
VALUE
All iface configurations need a minimum of iface.iface_name, iface.transport_name and iface.hwaddress to be correctly configured to work. Some transports may require
iface.ipaddress and iface.net_ifacename as well to bind correctly.
Detailed configuration instructions can be found in the Linux* Open-iSCSI README file .
3.11. HYPERVISORS
Red Hat Enterprise Linux OpenStack Platform is only supported for use with the libvirt driver (using
KVM as the hypervisor on Compute nodes) or the VMware vCenter hypervisor driver. See the
VMware Integration Guide for more information regarding the configuration of the VMware vCenter driver.
With this release of Red Hat Enterprise Linux OpenStack Platform, Ironic is now fully supported.
Ironic allows you to provision bare-metal machines using common technologies (such as PXE boot and IPMI) to cover a wide range of hardware while supporting pluggable drivers to allow the addition of vendor-specific functionality.
Red Hat does not provide support for other Compute virtualization drivers such as the deprecated
VMware "direct-to-ESX" hypervisor, and non-KVM libvirt hypervisors.
3.11.1. Hypervisor configuration basics
234
CHAPTER 3. COMPUTE
The node where the nova-compute service is installed and operates on the same node that runs all of the virtual machines. This is referred to as the compute node in this guide.
By default, the selected hypervisor is KVM. To change to another hypervisor, change the
virt_type option in the [libvirt] section of nova.conf and restart the nova-compute service.
Here are the general nova.conf options that are used to configure the compute node's hypervisor:
Table 3.30, “Description of hypervisor configuration options” .
Specific options for particular hypervisors can be found in the following sections.
3.11.2. KVM
KVM is configured as the default hypervisor for Compute.
Note
This document contains several sections about hypervisor selection. If you are reading this document linearly, you do not want to load the KVM module before you install nova-
compute. The nova-compute service depends on qemu-kvm, which installs
/lib/udev/rules.d/45-qemu-kvm.rules, which sets the correct permissions on the
/dev/kvm device node.
To enable KVM explicitly, add the following configuration options to the /etc/nova/nova.conf file: compute_driver = libvirt.LibvirtDriver
[libvirt] virt_type = kvm
The KVM hypervisor supports the following virtual machine image formats:
Raw
QEMU Copy-on-write (qcow2)
QED Qemu Enhanced Disk
VMware virtual machine disk format (vmdk)
This section describes how to enable KVM on your system. For more information, see Installing virtualization packages on an existing Red Hat Enterprise Linux system from the Red Hat Enterprise
Linux Virtualization Host Configuration and Guest Installation Guide.
235
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
3.11.2.1. Enable KVM
The following sections outline how to enable KVM based hardware virtualisation on different architectures and platforms. To perform these steps, you must be logged in as the root user.
3.11.2.1.1. For x86 based systems
1. To determine whether the svm or vmx CPU extensions are present, run this command:
# grep -E 'svm|vmx' /proc/cpuinfo
This command generates output if the CPU is capable of hardware virtualization. Even if output is shown, you might still need to enable virtualization in the system BIOS for full support.
If no output appears, consult your system documentation to ensure that your CPU and motherboard support hardware virtualization. Verify that any relevant hardware virtualization options are enabled in the system BIOS.
The BIOS for each manufacturer is different. If you must enable virtualization in the BIOS, look for an option containing the words virtualization, VT, VMX, or SVM.
2. To list the loaded kernel modules and verify that the kvm modules are loaded, run this command:
# lsmod | grep kvm
If the output includes kvm_intel or kvm_amd, the kvm hardware virtualization modules are loaded and your kernel meets the module requirements for OpenStack Compute.
If the output does not show that the kvm module is loaded, run this command to load it:
# modprobe -a kvm
Run the command for your CPU. For Intel, run this command:
# modprobe -a kvm-intel
For AMD, run this command:
# modprobe -a kvm-amd
Because a KVM installation can change user group membership, you might need to log in again for changes to take effect.
236
CHAPTER 3. COMPUTE
If the kernel modules do not load automatically, use the procedures listed in these subsections.
If the checks indicate that required hardware virtualization support or kernel modules are disabled or unavailable, you must either enable this support on the system or find a system with this support.
Note
Some systems require that you enable VT support in the system BIOS. If you believe your processor supports hardware acceleration but the previous command did not produce output, reboot your machine, enter the system BIOS, and enable the VT option.
If KVM acceleration is not supported, configure Compute to use a different hypervisor, such as
QEMU or Xen .
These procedures help you load the kernel modules for Intel-based and AMD-based processors if they do not load automatically during KVM installation.
3.11.2.1.1.1. Intel-based processors
If your compute host is Intel-based, run these commands as root to load the kernel modules:
# modprobe kvm
# modprobe kvm-intel
See Persistent Module Loading in Red Hat Enterprise Linux 6 , or Persistent Module Loading in Red
Hat Enterprise Linux 7 respectively, for instructions on how to load the kvm and kvm-amd modules automatically.
3.11.2.1.1.2. AMD-based processors
If your compute host is AMD-based, run these commands as root to load the kernel modules:
# modprobe kvm
# modprobe kvm-amd
See Persistent Module Loading in Red Hat Enterprise Linux 6 , or Persistent Module Loading in Red
Hat Enterprise Linux 7 respectively, for instructions on how to load the kvm and kvm-intel modules automatically.
3.11.2.1.2. For POWER based systems
KVM as a hypervisor is supported on POWER system's PowerNV platform.
1. To determine if your POWER platform supports KVM based virtualization run the following command:
237
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# grep PowerNV /proc/cpuinfo
If the previous command generates the following output, then CPU supports KVM based virtualization platform: PowerNV
If no output is displayed, then your POWER platform does not support KVM based hardware virtualization.
2. To list the loaded kernel modules and verify that the kvm modules are loaded, run the following command:
# lsmod | grep kvm
If the output includes kvm_hv, the kvm hardware virtualization modules are loaded and your kernel meets the module requirements for OpenStack Compute.
If the output does not show that the kvm module is loaded, run the following command to load it:
# modprobe -a kvm
For PowerNV platform, run the following command:
# modprobe -a kvm-hv
Because a KVM installation can change user group membership, you might need to log in again for changes to take effect.
3.11.2.2. Specify the CPU model of KVM guests
The Compute service enables you to control the guest CPU model that is exposed to KVM virtual machines. Use cases include:
To maximize performance of virtual machines by exposing new host CPU features to the guest
To ensure a consistent default CPU across all machines, removing reliance of variable QEMU defaults
In libvirt, the CPU is specified by providing a base CPU model name (which is a shorthand for a set of feature flags), a set of additional feature flags, and the topology (sockets/cores/threads). The libvirt KVM driver provides a number of standard CPU model names. These models are defined in the /usr/share/libvirt/cpu_map.xml file. Check this file to determine which models are supported by your local installation.
238
CHAPTER 3. COMPUTE
Two Compute configuration options in the [libvirt] group of nova.conf define which type of
CPU model is exposed to the hypervisor when using KVM: cpu_mode and cpu_model.
The cpu_mode option can take one of the following values: none, host-passthrough, host-
model, and custom.
Host model (default for KVM & QEMU)
If your nova.conf file contains cpu_mode=host-model, libvirt identifies the CPU model in
/usr/share/libvirt/cpu_map.xml file that most closely matches the host, and requests additional CPU flags to complete the match. This configuration provides the maximum functionality and performance and maintains good reliability and compatibility if the guest is migrated to another host with slightly different host CPUs.
Host pass through
If your nova.conf file contains cpu_mode=host-passthrough, libvirt tells KVM to pass through the host CPU with no modifications. The difference to host-model, instead of only matching feature flags, every last detail of the host CPU is matched. This gives the best performance, and can be important to some apps which check low level CPU details, but it comes at a cost with respect to migration. The guest can only be migrated to a matching host CPU.
Custom
If your nova.conf file contains cpu_mode=custom, you can explicitly specify one of the supported named models using the cpu_model configuration option. For example, to configure the KVM guests to expose Nehalem CPUs, your nova.conf file should contain:
[libvirt] cpu_mode = custom cpu_model = Nehalem
None (default for all libvirt-driven hypervisors other than KVM & QEMU)
If your nova.conf file contains cpu_mode=none, libvirt does not specify a CPU model. Instead, the hypervisor chooses the default model.
3.11.2.3. Guest agent support
Use guest agents to enable optional access between compute nodes and guests through a socket, using the QMP protocol.
To enable this feature, you must set hw_qemu_guest_agent=yes as a metadata parameter on the image you want to use to create the guest-agent-capable instances from. You can explicitly disable the feature by setting hw_qemu_guest_agent=no in the image metadata.
3.11.2.4. KVM performance tweaks
239
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The VHostNet kernel module improves network performance. To load the kernel module, run the following command as root:
# modprobe vhost_net
3.11.2.5. Troubleshoot KVM
Trying to launch a new virtual machine instance fails with the ERRORstate, and the following error appears in the /var/log/nova/nova-compute.log file: libvirtError: internal error no supported architecture for os type
'hvm'
This message indicates that the KVM kernel modules were not loaded.
If you cannot start VMs after installation without rebooting, the permissions might not be set correctly. This can happen if you load the KVM module before you install nova-compute. To check whether the group is set to kvm, run:
# ls -l /dev/kvm
If it is not set to kvm, run:
# udevadm trigger
3.11.3. QEMU
From the perspective of the Compute service, the QEMU hypervisor is very similar to the KVM hypervisor. Both are controlled through libvirt, both support the same feature set, and all virtual machine images that are compatible with KVM are also compatible with QEMU. The main difference is that QEMU does not support native virtualization. Consequently, QEMU has worse performance than KVM and is a poor choice for a production deployment.
The typical uses cases for QEMU are
Running on older hardware that lacks virtualization support.
Running the Compute service inside of a virtual machine for development or testing purposes, where the hypervisor does not support native virtualization for guests.
To enable QEMU, add these settings to nova.conf: compute_driver = libvirt.LibvirtDriver
[libvirt] virt_type = qemu
240
CHAPTER 3. COMPUTE
For some operations you may also have to install the guestmount utility:
# yum install libguestfs-tools
The QEMU hypervisor supports the following virtual machine image formats:
Raw
QEMU Copy-on-write (qcow2)
VMware virtual machine disk format (vmdk)
3.11.4. VMware vSphere
3.11.4.1. Introduction
OpenStack Compute supports the VMware vSphere product family and enables access to advanced features such as vMotion, High Availability, and Dynamic Resource Scheduling (DRS).
This section describes how to configure VMware-based virtual machine images for launch. vSphere versions 4.1 and later are supported.
The VMware vCenter driver enables the nova-compute service to communicate with a VMware vCenter server that manages one or more ESX host clusters. The driver aggregates the ESX hosts in each cluster to present one large hypervisor entity for each cluster to the Compute scheduler.
Because individual ESX hosts are not exposed to the scheduler, Compute schedules to the granularity of clusters and vCenter uses DRS to select the actual ESX host within the cluster. When a virtual machine makes its way into a vCenter cluster, it can use all vSphere features.
The following sections describe how to configure the VMware vCenter driver.
3.11.4.2. High-level architecture
After OpenStack boots a VM into a vSphere cluster, the VM becomes visible in vCenter and can access vSphere advanced features. At the same time, the VM is visible in the OpenStack dashboard and you can manage it as you would any other OpenStack VM. You can perform advanced vSphere operations in vCenter while you configure OpenStack resources such as VMs through the OpenStack dashboard.
Both nova-network and the OpenStack Networking Service are supported. For details, see
Section 3.11.4.8, “Networking with VMware vSphere”
.
3.11.4.3. Configuration overview
To get started with the VMware vCenter driver, complete the following high-level steps:
241
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
1. Configure vCenter. See
Section 3.11.4.4, “Prerequisites and limitations” .
2. Configure the VMware vCenter driver in the nova.conf file. See Section 3.11.4.6,
3. Load desired VMDK images into the OpenStack Image Service. See Section 3.11.4.7,
“Images with VMware vSphere” .
4. Configure networking with either nova-network or the OpenStack Networking Service.
See
Section 3.11.4.8, “Networking with VMware vSphere” .
3.11.4.4. Prerequisites and limitations
Use the following list to prepare a vSphere environment that runs with the VMware vCenter driver:
Copying VMDK files (vSphere 5.1 only). In vSphere 5.1, copying large image files (for example, 12 GB and greater) from Glance can take a long time. To improve performance,
VMware recommends that you upgrade to VMware vCenter Server 5.1 Update 1 or later.
For more information, see the Release Notes .
DRS. For any cluster that contains multiple ESX hosts, enable DRS and enable fully automated placement.
Shared storage. Only shared storage is supported and data stores must be shared among all hosts in a cluster. It is recommended to remove data stores not intended for OpenStack from clusters being configured for OpenStack.
Clusters and data stores. Do not use OpenStack clusters and data stores for other purposes. If you do, OpenStack displays incorrect usage information.
Networking. The networking configuration depends on the desired networking model. See
Section 3.11.4.8, “Networking with VMware vSphere” .
Security groups. If you use the VMware driver with OpenStack Networking and the NSX plug-in, security groups are supported. If you use nova-network, security groups are not supported.
Note
The NSX plug-in is the only plug-in that is validated for vSphere.
VNC. The port range 5900 - 6105 (inclusive) is automatically enabled for VNC connections on every ESX host in all clusters under OpenStack control. For more information about using a VNC client to connect to virtual machine, see http://kb.vmware.com/selfservice/microsites/search.do?
language=en_US&cmd=displayKC&externalId=1246 .
242
CHAPTER 3. COMPUTE
Note
In addition to the default VNC port numbers (5900 to 6000) specified in the above document, the following ports are also used: 6101, 6102, and 6105.
You must modify the ESXi firewall configuration to allow the VNC ports. Additionally, for the firewall modifications to persist after a reboot, you must create a custom vSphere
Installation Bundle (VIB) which is then installed onto the running ESXi host or added to a custom image profile used to install ESXi hosts. For details about how to create a VIB for persisting the firewall configuration modifications, see http://kb.vmware.com/selfservice/microsites/search.do?
language=en_US&cmd=displayKC&externalId=2007381 .
Note
The VIB can be downloaded from https://github.com/openstack-vmwareapiteam/Tools .
Availability Zones. To use multiple vCenter installations with OpenStack, each vCenter must be assigned to a separate availability zone. This is required as the OpenStack Block
Storage VMDK driver does not currently work across multiple vCenter installations.
3.11.4.5. VMware vCenter service account
OpenStack integration requires a vCenter service account with the following minimum permissions.
Apply the permissions to the Datacenter root object, and select the Propagate to Child
Objects option.
Table 3.6. vCenter permissions tree
All Privileges
Datastore
Allocate space
Browse datastore
Low level file operation
Remove file
Extension
Register extension
Folder
243
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Create folder
Host
Configuration
Network
Resource
Assign network
Virtual Machine
Assign virtual machine to resource pool
Migrate powered off virtual machine
Migrate powered on virtual machine
Configuration
Maintenance
Network configuration
Storage partition configuration
Add existing disk
Add new disk
Add or remove device
Advanced
CPU count
Disk change tracking
Host USB device
Memory
Raw device
Remove disk
Rename
244
vApp
Interaction
Inventory
Provisioning
Sessions
Snapshot management
CHAPTER 3. COMPUTE
Swapfile placement
Configure CD media
Power Off
Power On
Reset
Suspend
Create from existing
Create new
Move
Remove
Unregister
Clone virtual machine
Customize
Validate session
View and stop sessions
Create snapshot
Remove snapshot
Export
Import
245
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
3.11.4.6. VMware vCenter driver
Use the VMware vCenter driver (VMwareVCDriver) to connect OpenStack Compute with vCenter.
This recommended configuration enables access through vCenter to advanced vSphere features like vMotion, High Availability, and Dynamic Resource Scheduling (DRS).
3.11.4.6.1. VMwareVCDriver configuration options
When you use the VMwareVCDriver (vCenter versions 5.1 and later) with OpenStack Compute, add the following VMware-specific configuration options to the nova.conf file:
[DEFAULT] compute_driver=vmwareapi.VMwareVCDriver
[vmware] host_ip=<vCenter host IP> host_username=<vCenter username> host_password=<vCenter password> cluster_name=<vCenter cluster name> datastore_regex=<optional datastore regex>
Note
vSphere vCenter versions 5.0 and earlier: You must specify the location of the WSDL files by adding the
wsdl_location=http://127.0.0.1:8080/vmware/SDK/wsdl/vim25/vimSe
rvice.wsdl setting to the above configuration. For more information, see vSphere
5.0 and earlier additional set up .
Clusters: The vCenter driver can support multiple clusters. To use more than one cluster, simply add multiple cluster_name lines in nova.conf with the appropriate cluster name. Clusters and data stores used by the vCenter driver should not contain any VMs other than those created by the driver.
Data stores: The datastore_regex setting specifies the data stores to use with
Compute. For example, datastore_regex="nas.*" selects all the data stores that have a name starting with "nas". If this line is omitted, Compute uses the first data store returned by the vSphere API. It is recommended not to use this field and instead remove data stores that are not intended for OpenStack.
Reserved host memory: The reserved_host_memory_mb option value is 512 MB by default. However, VMware recommends that you set this option to 0 MB because the vCenter driver reports the effective memory available to the virtual machines.
The vCenter driver generates instance name by instance ID. Instance name template is ignored.
246
CHAPTER 3. COMPUTE
A nova-compute service can control one or more clusters containing multiple ESX hosts, making
nova-compute a critical service from a high-availability perspective. Because the host that runs
nova-compute can fail while the vCenter and ESX still run, you must protect the nova-compute service against host failures.
Note
Many nova.conf options are relevant to libvirt but do not apply to this driver.
You must complete additional configuration for environments that use vSphere 5.0 and earlier. See
Section 3.11.4.10, “vSphere 5.0 and earlier additional set up”
.
3.11.4.7. Images with VMware vSphere
The vCenter driver supports images in the VMDK format. Disks in this format can be obtained from
VMware Fusion or from an ESX environment. It is also possible to convert other formats, such as qcow2, to the VMDK format using the qemu-img utility. After a VMDK disk is available, load it into the OpenStack Image service. Then, you can use it with the VMware vCenter driver. The following sections provide additional details on the supported disks and the commands used for conversion and upload.
3.11.4.7.1. Supported image types
Upload images to the OpenStack Image service in VMDK format. The following VMDK disk types are supported:
VMFS Flat Disks (includes thin, thick, zeroedthick, and eagerzeroedthick). Note that once a
VMFS thin disk is exported from VMFS to a non-VMFS location, like the OpenStack Image service, it becomes a preallocated flat disk. This impacts the transfer time from the OpenStack
Image service to the data store when the full preallocated flat disk, rather than the thin disk, must be transferred.
Monolithic Sparse disks. Sparse disks get imported from the OpenStack Image service into ESX as thin provisioned disks. Monolithic Sparse disks can be obtained from VMware Fusion or can be created by converting from other virtual disk formats using the qemu-img utility.
The following table shows the vmware_disktype property that applies to each of the supported
VMDK disk types:
Table 3.7. OpenStack Image service disk type settings vmware_disktype property
sparse
VMDK disk type
Monolithic Sparse
247
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
VMDK disk type vmware_disktype property
thin
VMFS flat, thin provisioned preallocated (default)
VMFS flat, thick/zeroedthick/eagerzeroedthick
The vmware_disktype property is set when an image is loaded into the OpenStack Image service.
Note
Specifying thin does not provide any advantage over preallocated with the current version of the driver. Future versions might restore the thin properties of the disk after it is downloaded to a vSphere data store.
3.11.4.7.2. Convert and load images
Using the qemu-img utility, disk images in several formats (such as, qcow2) can be converted to the
VMDK format.
For example, the following command can be used to convert a qcow2 cloud image:
$ qemu-img convert -f qcow2 qcow-image.img -O vmdk vmdk-image.vmdk
VMDK disks converted through qemu-img are always monolithic sparse VMDK disks with an IDE adapter type. Using the previous example of the image after the qemu-img conversion, the command to upload the VMDK disk should be something like:
$ glance image-create --name cloud_name --is-public False \ -container-format bare --disk-format vmdk \ --property vmware_disktype="sparse" \ --property vmware_adaptertype="ide" < \
vmdk-image.vmdk
Note that the vmware_disktype is set to sparse and the vmware_adaptertype is set to ide in the previous command.
If the image did not come from the qemu-img utility, the vmware_disktype and
vmware_adaptertype might be different. To determine the image adapter type from an image file, use the following command and look for the ddb.adapterType= line:
$ head -20 vmdk_file_ name
248
Currently, OS boot VMDK disks with an IDE adapter type cannot be attached to a virtual SCSI controller and likewise disks with one of the SCSI adapter types (such as, busLogic, lsiLogic,
CHAPTER 3. COMPUTE
lsiLogicsas, paraVirtual) cannot be attached to the IDE controller. Therefore, as the previous examples show, it is important to set the vmware_adaptertype property correctly. The default adapter type is lsiLogic, which is SCSI, so you can omit the vmware_adaptertype property if you are certain that the image adapter type is lsiLogic.
3.11.4.7.3. Tag VMware images
In a mixed hypervisor environment, OpenStack Compute uses the hypervisor_type tag to match images to the correct hypervisor type. For VMware images, set the hypervisor type to vmware.
Other valid hypervisor types include: xen, qemu, lxc, uml, and hyperv. Note that qemu is used for both QEMU and KVM hypervisor types.
3.11.4.7.4. Optimize images
Monolithic Sparse disks are considerably faster to download but have the overhead of an additional conversion step. When imported into ESX, sparse disks get converted to VMFS flat, thin provisioned disks. The download and conversion steps only affect the first launched instance that uses the sparse disk image. The converted disk image is cached, so subsequent instances that use this disk image can simply use the cached version.
To avoid the conversion step (at the cost of longer download times) consider converting sparse disks to thin provisioned or preallocated disks before loading them into the OpenStack Image service.
Use one of the following tools to pre-convert sparse disks.
vSphere CLI tools
Sometimes called the remote CLI or rCLI.
Assuming that the sparse disk is made available on a data store accessible by an ESX host, the following command converts it to preallocated format: vmkfstools --server=ip_of_some_ESX_host -i
/vmfs/volumes/datastore1/sparse.vmdk
/vmfs/volumes/datastore1/converted.vmdk
Note
The vifs tool from the same CLI package can be used to upload the disk to be converted. The vifs tool can also be used to download the converted disk if necessary.
vmkfstools directly on the ESX host
If the SSH service is enabled on an ESX host, the sparse disk can be uploaded to the ESX data store through scp and the vmkfstools local to the ESX host can use used to perform the conversion. After you log in to the host through ssh, run this command:
249
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
vmkfstools -i /vmfs/volumes/datastore1/sparse.vmdk
/vmfs/volumes/datastore1/converted.vmdk
vmware-vdiskmanager
vmware-vdiskmanager is a utility that comes bundled with VMware Fusion and VMware
Workstation. The following example converts a sparse disk to preallocated format: vmware-vdiskmanager -r sparse.vmdk -t 4 converted.vmdk
In the previous cases, the converted vmdk is actually a pair of files:
The descriptor file converted.vmdk.
The actual virtual disk data file converted-flat.vmdk.
The file to be uploaded to the OpenStack Image Service is converted-flat.vmdk.
3.11.4.7.5. Image handling
The ESX hypervisor requires a copy of the VMDK file in order to boot up a virtual machine. As a result, the vCenter OpenStack Compute driver must download the VMDK using HTTP from the
OpenStack Image service to a data store that is visible to the hypervisor. To optimize this process, the first time a VMDK file is used, it gets cached in the data store. A cached image is stored in a folder named after the image ID. Subsequent virtual machines that need the VMDK use the cached version and do not have to copy the file again from the OpenStack Image service.
Even with a cached VMDK, there is still a copy operation from the cache location to the hypervisor file directory in the shared data store. To avoid this copy, boot the image in linked_clone mode.
To learn how to enable this mode, see Section 3.11.4.11, “Configuration reference” .
Note
You can also use the vmware_linked_clone property in the OpenStack Image service to override the linked_clone mode on a per-image basis.
If multiple compute nodes are running on the same host, or have a shared file system, you can enable them to use the same cache folder on the back-end data store. To configure this action, set the cache_prefix option in the nova.conf file. Its value stands for the name prefix of the folder where cached images are stored.
Note
This can take effect only if compute nodes are running on the same host, or have a shared file system.
250
CHAPTER 3. COMPUTE
You can automatically purge unused images after a specified period of time. To configure this action, set these options in the DEFAULT section in the nova.conf file:
remove_unused_base_images
Set this option to True to specify that unused images should be removed after the duration specified in the remove_unused_original_minimum_age_seconds option. The default is True.
remove_unused_original_minimum_age_seconds
Set this parameter to specify the duration in seconds after which an unused image is purged from the cache. The default is 86400 (24 hours).
3.11.4.8. Networking with VMware vSphere
The VMware driver supports networking with the nova-network service or the OpenStack
Networking Service. Depending on your installation, complete these configuration steps before you provision VMs:
The nova-network service with the FlatManager or FlatDHCPManager. Create a port group with the same name as the flat_network_bridge value in the nova.conf file. The default value is br100. If you specify another value, the new value must be a valid Linux bridge identifier that adheres to Linux bridge naming conventions.
All VM NICs are attached to this port group.
Ensure that the flat interface of the node that runs the nova-network service has a path to this network.
Note
When configuring the port binding for this port group in vCenter, specify ephemeral for the port binding type. For more information, see Choosing a port binding type in
ESX/ESXi in the VMware Knowledge Base.
The nova-network service with the VlanManager. Set the vlan_interface configuration option to match the ESX host interface that handles VLAN-tagged VM traffic.
OpenStack Compute automatically creates the corresponding port groups.
If you are using the OpenStack Networking Service: Before provisioning VMs, create a port group with the same name as the vmware.integration_bridge value in nova.conf
(default is br-int). All VM NICs are attached to this port group for management by the
OpenStack Networking plug-in.
3.11.4.9. Volumes with VMware vSphere
251
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The VMware driver supports attaching volumes from the OpenStack Block Storage service. The
VMware VMDK driver for OpenStack Block Storage is recommended and should be used for managing volumes based on vSphere data stores. For more information about the VMware VMDK driver, see VMware VMDK Driver . Also an iSCSI volume driver provides limited support and can be used only for attachments.
3.11.4.10. vSphere 5.0 and earlier additional set up
Users of vSphere 5.0 or earlier must host their WSDL files locally. These steps are applicable for vCenter 5.0 or ESXi 5.0 and you can either mirror the WSDL from the vCenter or ESXi server that you intend to use or you can download the SDK directly from VMware. These workaround steps fix a known issue with the WSDL that was resolved in later versions.
When setting the VMwareVCDriver configuration options, you must include the wsdl_location option. For more information, see
VMwareVCDriver configuration options
above.
Procedure 3.1. To mirror WSDL from vCenter (or ESXi)
1. Set the VMWAREAPI_IP shell variable to the IP address for your vCenter or ESXi host from where you plan to mirror files. For example:
$ export VMWAREAPI_IP=your_vsphere_host_ip
2. Create a local file system directory to hold the WSDL files:
$ mkdir -p /opt/stack/vmware/wsdl/5.0
3. Change into the new directory.
$ cd /opt/stack/vmware/wsdl/5.0
4. Use your OS-specific tools to install a command-line tool that can download files like wget.
5. Download the files to the local file cache: wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/vimService.wsdl
wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/vim.wsdl
wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/coretypes.xsd
wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/querymessagetypes.xsd
wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/querytypes.xsd
wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/vimmessagetypes.xsd
wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/vimtypes.xsd
252
CHAPTER 3. COMPUTE
wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/reflectmessagetypes.xsd
wget --no-check-certificate https:// $VMWAREAPI_IP /sdk/reflecttypes.xsd
Because the reflect-types.xsd and reflect-messagetypes.xsd files do not fetch properly, you must stub out these files. Use the following XML listing to replace the missing file content. The XML parser underneath Python can be very particular and if you put a space in the wrong place, it can break the parser. Copy the following contents and formatting carefully.
<?xml version= "1.0" encoding= "UTF-8" ?>
<schema
targetNamespace= "urn:reflect"
xmlns= "http://www.w3.org/2001/XMLSchema"
xmlns:xsd= "http://www.w3.org/2001/XMLSchema"
elementFormDefault= "qualified" >
</schema>
6. Now that the files are locally present, tell the driver to look for the SOAP service WSDLs in the local file system and not on the remote vSphere server. Add the following setting to the
nova.conf file for your nova-compute node:
[vmware] wsdl_location=file:///opt/stack/vmware/wsdl/5.0/vimService.wsdl
Alternatively, download the version appropriate SDK from http://www.vmware.com/support/developer/vc-sdk/ and copy it to the /opt/stack/vmware file.
Make sure that the WSDL is available, in for example
/opt/stack/vmware/SDK/wsdl/vim25/vimService.wsdl. You must point nova.conf to fetch this WSDL file from the local file system by using a URL.
When using the VMwareVCDriver (vCenter) with OpenStack Compute with vSphere version 5.0 or earlier, nova.conf must include the following extra config option:
[vmware] wsdl_location=file:///opt/stack/vmware/SDK/wsdl/vim25/vimService.wsdl
3.11.4.11. Configuration reference
To customize the VMware driver, use the configuration option settings documented in Table 3.56,
“Description of VMware configuration options” .
3.12. SCHEDULING
Compute uses the nova-scheduler service to determine how to dispatch compute requests. For example, the nova-scheduler service determines on which host a VM should launch. In the context of filters, the term host means a physical node that has a nova-compute service running on it. You can configure the scheduler through a variety of options.
253
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Compute is configured with the following default scheduler options in the /etc/nova/nova.conf file: scheduler_driver_task_period = 60 scheduler_driver = nova.scheduler.filter_scheduler.FilterScheduler
scheduler_available_filters = nova.scheduler.filters.all_filters
scheduler_default_filters = RetryFilter, AvailabilityZoneFilter,
RamFilter, ComputeFilter, ComputeCapabilitiesFilter,
ImagePropertiesFilter, ServerGroupAntiAffinityFilter,
ServerGroupAffinityFilter
By default, the scheduler_driver is configured as a filter scheduler, as described in the next section. In the default configuration, this scheduler considers hosts that meet all the following criteria:
Have not been attempted for scheduling purposes (RetryFilter).
Are in the requested availability zone (AvailabilityZoneFilter).
Have sufficient RAM available (RamFilter).
Can service the request (ComputeFilter).
Satisfy the extra specs associated with the instance type (ComputeCapabilitiesFilter).
Satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties (ImagePropertiesFilter).
Are on a different host than other instances of a group (if requested)
(ServerGroupAntiAffinityFilter).
Are in a set of group hosts (if requested) (ServerGroupAffinityFilter).
The scheduler caches its list of available hosts; use the scheduler_driver_task_period option to specify how often the list is updated.
Note
Do not configure service_down_time to be much smaller than
scheduler_driver_task_period; otherwise, hosts appear to be dead while the host list is being cached.
The scheduler chooses a new host when an instance is migrated.
254
When evacuating instances from a host, the scheduler service honors the target host defined by the administrator on the evacuate command. If a target is not defined by the administrator, the scheduler determines the target host..
CHAPTER 3. COMPUTE
3.12.1. Filter scheduler
The filter scheduler (nova.scheduler.filter_scheduler.FilterScheduler) is the default scheduler for scheduling virtual machine instances. It supports filtering and weighting to make informed decisions on where a new instance should be created.
3.12.2. Filters
When the filter scheduler receives a request for a resource, it first applies filters to determine which hosts are eligible for consideration when dispatching a resource. Filters are binary: either a host is accepted by the filter, or it is rejected. Hosts that are accepted by the filter are then processed by a different algorithm to decide which hosts to use for that request, described in the
section.
The scheduler_available_filters configuration option in nova.conf provides the Compute service with the list of the filters that are used by the scheduler. The default setting specifies all of the filter that are included with the Compute service: scheduler_available_filters = nova.scheduler.filters.all_filters
This configuration option can be specified multiple times. For example, if you implemented your own custom filter in Python called myfilter.MyFilter and you wanted to use both the built-in filters and your custom filter, your nova.conf file would contain: scheduler_available_filters = nova.scheduler.filters.all_filters
scheduler_available_filters = myfilter.MyFilter
The scheduler_default_filters configuration option in nova.conf defines the list of filters that are applied by the nova-scheduler service. The default filters are: scheduler_default_filters = RetryFilter, AvailabilityZoneFilter,
RamFilter, ComputeFilter, ComputeCapabilitiesFilter,
ImagePropertiesFilter, ServerGroupAntiAffinityFilter,
ServerGroupAffinityFilter
The following sections describe the available filters.
3.12.2.1. AggregateCoreFilter
Filters host by CPU core numbers with a per-aggregate cpu_allocation_ratio value. If the peraggregate value is not found, the value falls back to the global setting. If the host is in more than one aggregate and more than one value is found, the minimum value will be used. For information about how to use this filter, see
Section 3.12.5, “Host aggregates and availability zones”
. See also
Section 3.12.2.14, “CoreFilter” .
3.12.2.2. AggregateDiskFilter
Filters host by disk allocation with a per-aggregate disk_allocation_ratio value. If the peraggregate value is not found, the value falls back to the global setting. If the host is in more than one
255
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
aggregate and more than one value is found, the minimum value will be used. For information about how to use this filter, see
Section 3.12.5, “Host aggregates and availability zones”
. See also
Section 3.12.2.17, “DiskFilter”
.
3.12.2.3. AggregateImagePropertiesIsolation
Matches properties defined in an image's metadata against those of aggregates to determine host matches:
If a host belongs to an aggregate and the aggregate defines one or more metadata that matches an image's properties, that host is a candidate to boot the image's instance.
If a host does not belong to any aggregate, it can boot instances from all images.
You can configure the AggregateImagePropertiesIsolation filter by using the following options in the nova.conf file:
# Considers only keys matching the given namespace (string).
aggregate_image_properties_isolation_namespace = <None>
# Separator used between the namespace and keys (string).
aggregate_image_properties_isolation_separator = .
3.12.2.4. AggregateInstanceExtraSpecsFilter
Matches properties defined in extra specs for an instance type against admin-defined properties on a host aggregate. Works with specifications that are scoped with
aggregate_instance_extra_specs. For backward compatibility, also works with non-scoped specifications; this action is highly discouraged because it conflicts with
3.12.2.5. AggregateIoOpsFilter
Filters host by disk allocation with a per-aggregate max_io_ops_per_host value. If the peraggregate value is not found, the value falls back to the global setting. If the host is in more than one aggregate and more than one value is found, the minimum value will be used. For information about how to use this filter, see
Section 3.12.5, “Host aggregates and availability zones”
. See also
Section 3.12.2.22, “IoOpsFilter” .
3.12.2.6. AggregateMultiTenancyIsolation
Isolates tenants to specific
. If a host is in an aggregate that has the
filter_tenant_id metadata key, the host creates instances from only that tenant or list of tenants. A host can be in different aggregates. If a host does not belong to an aggregate with the metadata key, the host can create instances from all tenants.
3.12.2.7. AggregateNumInstancesFilter
256
CHAPTER 3. COMPUTE
Filters host by number of instances with a per-aggregate max_instances_per_host value. If the per-aggregate value is not found, the value falls back to the global setting. If the host is in more than one aggregate and thus more than one value is found, the minimum value will be used. For information about how to use this filter, see
Section 3.12.5, “Host aggregates and availability zones”
.
See also
Section 3.12.2.25, “NumInstancesFilter”
.
3.12.2.8. AggregateRamFilter
Filters host by RAM allocation of instances with a per-aggregate ram_allocation_ratio value. If the per-aggregate value is not found, the value falls back to the global setting. If the host is in more than one aggregate and thus more than one value is found, the minimum value will be used. For information about how to use this filter, see
Section 3.12.5, “Host aggregates and availability zones”
.
See also
Section 3.12.2.27, “RamFilter”
.
3.12.2.9. AggregateTypeAffinityFilter
Filters host by per-aggregate instance_type value. For information about how to use this filter,
Section 3.12.5, “Host aggregates and availability zones”
3.12.2.10. AllHostsFilter
This is a no-op filter. It does not eliminate any of the available hosts.
3.12.2.11. AvailabilityZoneFilter
Filters hosts by availability zone. You must enable this filter for the scheduler to respect availability zones in requests.
3.12.2.12. ComputeCapabilitiesFilter
Matches properties defined in extra specs for an instance type against compute capabilities.
If an extra specs key contains a colon (:), anything before the colon is treated as a namespace and anything after the colon is treated as the key to be matched. If a namespace is present and is not
capabilities, the filter ignores the namespace. For backward compatibility, also treats the extra specs key as the key to be matched if no namespace is present; this action is highly discouraged
because it conflicts with AggregateInstanceExtraSpecsFilter filter when you enable both filters.
3.12.2.13. ComputeFilter
Passes all hosts that are operational and enabled.
In general, you should always enable this filter.
3.12.2.14. CoreFilter
257
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Only schedules instances on hosts if sufficient CPU cores are available. If this filter is not set, the scheduler might over-provision a host based on cores. For example, the virtual cores running on an instance may exceed the physical cores.
You can configure this filter to enable a fixed amount of vCPU overcommitment by using the
cpu_allocation_ratio configuration option in nova.conf. The default setting is: cpu_allocation_ratio = 16.0
With this setting, if 8 vCPUs are on a node, the scheduler allows instances up to 128 vCPU to be run on that node.
To disallow vCPU overcommitment set: cpu_allocation_ratio = 1.0
Note
The Compute API always returns the actual number of CPU cores available on a compute node regardless of the value of the cpu_allocation_ratio configuration key. As a result changes to the cpu_allocation_ratio are not reflected via the command line clients or the dashboard. Changes to this configuration key are only taken into account internally in the scheduler.
3.12.2.15. NUMATopologyFilter
Filters hosts based on the NUMA topology that was specified for the instance through the use of flavor extra_specsin combination with the image properties, as described in detail in the related nova-spec document: Filter will try to match the exact NUMA cells of the instance to those of the host. It will consider the standard over-subscription limits each cell, and provide limits to the compute host accordingly.
Note
If instance has no topology defined, it will be considered for any host. If instance has a topology defined, it will be considered only for NUMA capable hosts.
3.12.2.16. DifferentHostFilter
Schedules the instance on a different host from a set of instances. To take advantage of this filter, the requester must pass a scheduler hint, using different_host as the key and a list of instance
UUIDs as the value. This filter is the opposite of the SameHostFilter. Using the nova commandline tool, use the --hint flag. For example:
$ nova boot --image cedef40a-ed67-4d10-800e-17455edce175 --flavor 1 -hint different_host=a0cf03a5-d921-4877-bb5c-86d26cf818e1 --hint different_host=8c19174f-4220-44f0-824a-cd1eeef10287 server-1
258
CHAPTER 3. COMPUTE
With the API, use the os:scheduler_hints key. For example:
{
"server": {
"name": "server-1",
"imageRef": "cedef40a-ed67-4d10-800e-17455edce175",
"flavorRef": "1"
},
"os:scheduler_hints": {
"different_host": [
"a0cf03a5-d921-4877-bb5c-86d26cf818e1",
"8c19174f-4220-44f0-824a-cd1eeef10287"
]
}
}
3.12.2.17. DiskFilter
Only schedules instances on hosts if there is sufficient disk space available for root and ephemeral storage.
You can configure this filter to enable a fixed amount of disk overcommitment by using the
disk_allocation_ratio configuration option in the nova.conf configuration file. The default setting disables the possibility of the overcommitment and allows launching a VM only if there is a sufficient amount of disk space available on a host: disk_allocation_ratio = 1.0
DiskFilter always considers the value of the disk_available_least property and not the one of the free_disk_gb property of a hypervisor's statistics:
$ nova hypervisor-stats
+----------------------+-------+
| Property | Value |
+----------------------+-------+
| count | 1 |
| current_workload | 0 |
| disk_available_least | 29 |
| free_disk_gb | 35 |
| free_ram_mb | 3441 |
| local_gb | 35 |
| local_gb_used | 0 |
| memory_mb | 3953 |
| memory_mb_used | 512 |
| running_vms | 0 |
| vcpus | 2 |
| vcpus_used | 0 |
+----------------------+-------+
As it can be viewed from the command output above, the amount of the available disk space can be less than the amount of the free disk space. It happens because the disk_available_least property accounts for the virtual size rather than the actual size of images. If you use an image
259
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
format that is sparse or copy on write so that each virtual instance does not require a 1:1 allocation of a virtual disk to a physical storage, it may be useful to allow the overcommitment of disk space.
To enable scheduling instances while overcommitting disk resources on the node, adjust the value of the disk_allocation_ratio configuration option to greater than 1.0: disk_allocation_ratio > 1.0
Note
If the value is set to >1, keep track of the free disk space, as the value approaching 0 may result in the incorrect functioning of instances using it at the moment.
3.12.2.18. GroupAffinityFilter
Note
This filter is deprecated in favor of
The GroupAffinityFilter ensures that an instance is scheduled on to a host from a set of group hosts.
To take advantage of this filter, the requester must pass a scheduler hint, using group as the key and an arbitrary name as the value. Using the nova command-line tool, use the --hint flag. For example:
$ nova boot --image IMAGE_ID --flavor 1 --hint group=GROUP server-1
This filter should not be enabled at the same time as
or neither filter will work properly.
3.12.2.19. GroupAntiAffinityFilter
Note
This filter is deprecated in favor of
.
The GroupAntiAffinityFilter ensures that each instance in a group is on a different host. To take advantage of this filter, the requester must pass a scheduler hint, using group as the key and an arbitrary name as the value. Using the nova command-line tool, use the --hint flag. For example:
$ nova boot --image IMAGE_ID --flavor 1 --hint group=GROUP server-1
This filter should not be enabled at the same time as
GroupAffinityFilter or neither filter will work
properly.
3.12.2.20. ImagePropertiesFilter
260
CHAPTER 3. COMPUTE
Filters hosts based on properties defined on the instance's image. It passes hosts that can support the specified image properties contained in the instance. Properties include the architecture, hypervisor type, hypervisor version (for Xen hypervisor type only), and virtual machine mode.
For example, an instance might require a host that runs an ARM-based processor, and QEMU as the hypervisor. You can decorate an image with these properties by using:
$ glance image-update img-uuid --property architecture=arm --property hypervisor_type=qemu
The image properties that the filter checks for are:
architecture: describes the machine architecture required by the image. Examples are i686,
x86_64, arm, and ppc64.
hypervisor_type: describes the hypervisor required by the image. Examples are xen, qemu, and xenapi.
Note
qemu is used for both QEMU and KVM hypervisor types.
hypervisor_version_requires: describes the hypervisor version required by the image.
The property is supported for Xen hypervisor type only. It can be used to enable support for multiple hypervisor versions, and to prevent instances with newer Xen tools from being provisioned on an older version of a hypervisor. If available, the property value is compared to the hypervisor version of the compute host.
To filter the hosts by the hypervisor version, add the hypervisor_version_requires property on the image as metadata and pass an operator and a required hypervisor version as its value:
$ glance image-update img-uuid --property hypervisor_type=xen -property hypervisor_version_requires=">=4.3"
vm_mode: describes the hypervisor application binary interface (ABI) required by the image.
Examples are xen for Xen 3.0 paravirtual ABI, hvm for native ABI, uml for User Mode Linux paravirtual ABI, exe for container virt executable ABI.
3.12.2.21. IsolatedHostsFilter
Allows the admin to define a special (isolated) set of images and a special (isolated) set of hosts, such that the isolated images can only run on the isolated hosts, and the isolated hosts can only run isolated images. The flag restrict_isolated_hosts_to_isolated_images can be used to force isolated hosts to only run isolated images.
261
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The admin must specify the isolated set of images and hosts in the nova.conf file using the
isolated_hosts and isolated_images configuration options. For example: isolated_hosts = server1, server2 isolated_images = 342b492c-128f-4a42-8d3a-c5088cf27d13, ebd267a6-ca86-
4d6c-9a0e-bd132d6b7d09
3.12.2.22. IoOpsFilter
The IoOpsFilter filters hosts by concurrent I/O operations on it. Hosts with too many concurrent I/O operations will be filtered out. The max_io_ops_per_host option specifies the maximum number of I/O intensive instances allowed to run on a host. A host will be ignored by the scheduler if more than max_io_ops_per_host instances in build, resize, snapshot, migrate, rescue or unshelve task states are running on it.
3.12.2.23. JsonFilter
The JsonFilter allows a user to construct a custom filter by passing a scheduler hint in JSON format.
The following operators are supported:
=
<
<=
>=
> in not or and
The filter supports the following variables:
$free_ram_mb
$free_disk_mb
$total_usable_ram_mb
262
CHAPTER 3. COMPUTE
$vcpus_total
$vcpus_used
Using the nova command-line tool, use the --hint flag:
$ nova boot --image 827d564a-e636-4fc4-a376-d36f7ebe1747 --flavor 1 -hint query='[">=","$free_ram_mb",1024]' server1
With the API, use the os:scheduler_hints key:
{
"server": {
"name": "server-1",
"imageRef": "cedef40a-ed67-4d10-800e-17455edce175",
"flavorRef": "1"
},
"os:scheduler_hints": {
"query": "[>=,$free_ram_mb,1024]"
}
}
3.12.2.24. MetricsFilter
Filters hosts based on metrics weight_setting. Only hosts with the available metrics are passed so that the metrics weigher will not fail due to these hosts.
3.12.2.25. NumInstancesFilter
Hosts that have more instances running than specified by the max_instances_per_host option are filtered out when this filter is in place.
3.12.2.26. PciPassthroughFilter
The filter schedules instances on a host if the host has devices that meet the device requests in the
extra_specs attribute for the flavor.
3.12.2.27. RamFilter
Only schedules instances on hosts that have sufficient RAM available. If this filter is not set, the scheduler may over provision a host based on RAM (for example, the RAM allocated by virtual machine instances may exceed the physical RAM).
You can configure this filter to enable a fixed amount of RAM overcommitment by using the
ram_allocation_ratio configuration option in nova.conf. The default setting is: ram_allocation_ratio = 1.5
263
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
This setting enables 1.5 GB instances to run on any compute node with 1 GB of free RAM.
Warning
Overcommitting is not an ideal solution for all memory issues. Rather, the recommended methods to deal with memory shortage are to allocate less memory per guest, add more physical memory to the host, or utilize swap space. If you decide to leave memory overcommitment enabled, ensure sufficient testing is performed. Contact Red Hat's support services for assistance with overcommitting.
To disable RAM overcommitment, set ram_allocation_ratio to 1.0.
3.12.2.28. RetryFilter
Filters out hosts that have already been attempted for scheduling purposes. If the scheduler selects a host to respond to a service request, and the host fails to respond to the request, this filter prevents the scheduler from retrying that host for the service request.
This filter is only useful if the scheduler_max_attempts configuration option is set to a value greater than zero.
3.12.2.29. SameHostFilter
Schedules the instance on the same host as another instance in a set of instances. To take advantage of this filter, the requester must pass a scheduler hint, using same_host as the key and a list of instance UUIDs as the value. This filter is the opposite of the DifferentHostFilter.
Using the nova command-line tool, use the --hint flag:
$ nova boot --image cedef40a-ed67-4d10-800e-17455edce175 --flavor 1 -hint same_host=a0cf03a5-d921-4877-bb5c-86d26cf818e1 \ --hint same_host=8c19174f-4220-44f0-824a-cd1eeef10287 server-1
With the API, use the os:scheduler_hints key:
{
"server": {
"name": "server-1",
"imageRef": "cedef40a-ed67-4d10-800e-17455edce175",
"flavorRef": "1"
},
"os:scheduler_hints": {
"same_host": [
"a0cf03a5-d921-4877-bb5c-86d26cf818e1",
"8c19174f-4220-44f0-824a-cd1eeef10287"
]
}
}
264
3.12.2.30. ServerGroupAffinityFilter
CHAPTER 3. COMPUTE
The ServerGroupAffinityFilter ensures that an instance is scheduled on to a host from a set of group hosts. To take advantage of this filter, the requester must create a server group with an affinity policy, and pass a scheduler hint, using group as the key and the server group UUID as the value.
Using the nova command-line tool, use the --hint flag. For example:
$ nova server-group-create --policy affinity group-1
$ nova boot --image IMAGE_ID --flavor 1 --hint group=SERVER_GROUP_UUID server-1
3.12.2.31. ServerGroupAntiAffinityFilter
The ServerGroupAntiAffinityFilter ensures that each instance in a group is on a different host. To take advantage of this filter, the requester must create a server group with an anti-affinity policy, and pass a scheduler hint, using group as the key and the server group UUID as the value.
Using the nova command-line tool, use the --hint flag. For example:
$ nova server-group-create --policy anti-affinity group-1
$ nova boot --image IMAGE_ID --flavor 1 --hint group=SERVER_GROUP_UUID server-1
3.12.2.32. SimpleCIDRAffinityFilter
Schedules the instance based on host IP subnet range. To take advantage of this filter, the requester must specify a range of valid IP address in CIDR format, by passing two scheduler hints:
build_near_host_ip
The first IP address in the subnet (for example, 192.168.1.1)
cidr
The CIDR that corresponds to the subnet (for example, /24)
Using the nova command-line tool, use the --hint flag. For example, to specify the IP subnet
192.168.1.1/24
$ nova boot --image cedef40a-ed67-4d10-800e-17455edce175 --flavor 1 -hint build_near_host_ip=192.168.1.1 --hint cidr=/24 server-1
With the API, use the os:scheduler_hints key:
{
"server": {
"name": "server-1",
"imageRef": "cedef40a-ed67-4d10-800e-17455edce175",
"flavorRef": "1"
},
"os:scheduler_hints": {
265
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"build_near_host_ip": "192.168.1.1",
"cidr": "24"
}
}
3.12.2.33. TrustedFilter
Filters hosts based on their trust. Only passes hosts that meet the trust requirements specified in the instance properties.
3.12.2.34. TypeAffinityFilter
Dynamically limits hosts to one instance type. An instance can only be launched on a host, if no instance with different instances types are running on it, or if the host has no running instances at all.
3.12.3. Weights
When resourcing instances, the filter scheduler filters and weights each host in the list of acceptable hosts. Each time the scheduler selects a host, it virtually consumes resources on it, and subsequent selections are adjusted accordingly. This process is useful when the customer asks for the same large amount of instances, because weight is computed for each requested instance.
All weights are normalized before being summed up; the host with the largest weight is given the highest priority.
If cells are used, cells are weighted by the scheduler in the same manner as hosts.
Hosts and cells are weighted based on the following options in the /etc/nova/nova.conf file:
Table 3.8. Host weighting options
Section
[DEFAULT]
Option ram_weight_multiplier
Description
By default, the scheduler spreads instances across all hosts evenly. Set the
ram_weight_multiplier
option to a negative number if you prefer stacking instead of spreading. Use a floating-point value.
266
Section
[DEFAULT]
[DEFAULT]
[metrics]
[metrics]
[metrics]
[metrics]
CHAPTER 3. COMPUTE
Option Description scheduler_host_subset_s ize
New instances are scheduled on a host that is chosen randomly from a subset of the N best hosts. This property defines the subset size from which a host is chosen. A value of 1 chooses the first host returned by the weighting functions. This value must be at least 1. A value less than 1 is ignored, and 1 is used instead. Use an integer value.
scheduler_weight_classe s
Defaults to
nova.scheduler.weights.all_wei
ghers
, which selects the RamWeigher and
MetricsWeigher. Hosts are then weighted and sorted with the largest weight winning.
weight_multiplier weight_setting
Multiplier for weighting metrics. Use a floating-point value.
Determines how metrics are weighted. Use a comma-separated list of metricName=ratio.
For example: "name1=1.0, name2=-1.0" results in:
name1.value * 1.0 + name2.value * -1.0
required
Specifies how to treat unavailable metrics:
True—Raises an exception. To avoid the raised exception, you should use the scheduler filter
MetricFilter
to filter out hosts with unavailable metrics.
False—Treated as a negative factor in the weighting process (uses the
weight_of_unavailable
option).
weight_of_unavailable
If
required
is set to False, and any one of the metrics set by
weight_setting
is unavailable, the
weight_of_unavailable
value is returned to the scheduler.
For example:
[DEFAULT] scheduler_host_subset_size = 1 scheduler_weight_classes = nova.scheduler.weights.all_weighers
ram_weight_multiplier = 1.0
[metrics]
267
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
weight_multiplier = 1.0
weight_setting = name1=1.0, name2=-1.0
required = false weight_of_unavailable = -10000.0
Table 3.9. Cell weighting options
Sectio n
Option
[cells]
mute_weight_multipl ier
[cells]
[cells]
[cells]
[cells]
mute_weight_value
(deprecated)
offset_weight_multi plier ram_weight_multipli er scheduler_weight_cl asses
Description
Multiplier to weight mute children (hosts which have not sent capacity or capacity updates for some time). Use a negative, floating-point value.
Weight value assigned to mute children. Use a positive, floating-point value with a maximum of '1.0'. This option is deprecated, use
mute_weight_multiplier
instead.
Multiplier to weight cells, so you can specify a preferred cell.
Use a floating point value.
By default, the scheduler spreads instances across all cells evenly. Set the
ram_weight_multiplier
option to a negative number if you prefer stacking instead of spreading.
Use a floating-point value.
Defaults to
nova.cells.weights.all_weighers
, which maps to all cell weighers included with Compute. Cells are then weighted and sorted with the largest weight winning.
For example:
[cells] scheduler_weight_classes = nova.cells.weights.all_weighers
mute_weight_multiplier = -10.0
ram_weight_multiplier = 1.0
offset_weight_multiplier = 1.0
3.12.4. Chance scheduler
As an administrator, you work with the filter scheduler. However, the Compute service also uses the
Chance Scheduler, nova.scheduler.chance.ChanceScheduler, which randomly selects from lists of filtered hosts.
3.12.5. Host aggregates and availability zones
268
Host aggregates are a mechanism for partitioning hosts in an OpenStack cloud, or a region of an
OpenStack cloud, based on arbitrary characteristics. Examples where an administrator may want to do this include where a group of hosts have additional hardware or performance characteristics.
CHAPTER 3. COMPUTE
Host aggregates are not explicitly exposed to users. Instead administrators map flavors to host aggregates. Administrators do this by setting metadata on a host aggregate, and matching flavor extra specifications. The scheduler then endeavors to match user requests for instance of the given flavor to a host aggregate with the same key-value pair in its metadata. Compute nodes can be in more than one host aggregate.
Administrators are able to optionally expose a host aggregate as an availability zone. Availability zones are different from host aggregates in that they are explicitly exposed to the user, and hosts can only be in a single availability zone. Administrators can configure a default availability zone where instances will be scheduled when the user fails to specify one.
Command-line interface
The nova command-line tool supports the following aggregate-related commands.
nova aggregate-list
Print a list of all aggregates.
nova aggregate-create <name> [availability-zone]
Create a new aggregate named <name>, and optionally in availability zone [availability-
zone] if specified. The command returns the ID of the newly created aggregate. Hosts can be made available to multiple host aggregates. Be careful when adding a host to an additional host aggregate when the host is also in an availability zone. Pay attention when using the aggregate-set-metadata and aggregate-update commands to avoid user confusion when they boot instances in different availability zones. An error occurs if you cannot add a particular host to an aggregate zone for which it is not intended.
nova aggregate-delete <id>
Delete an aggregate with id <id>.
nova aggregate-details <id>
Show details of the aggregate with id <id>.
nova aggregate-add-host <id> <host>
Add host with name <host> to aggregate with id <id>.
nova aggregate-remove-host <id> <host>
Remove the host with name <host> from the aggregate with id <id>.
nova aggregate-set-metadata <id> <key=value> [<key=value> ...]
Add or update metadata (key-value pairs) associated with the aggregate with id <id>.
269
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference nova aggregate-update <id> <name> [<availability_zone>]
Update the name and availability zone (optional) for the aggregate.
nova host-list
List all hosts by service.
nova host-update --maintenance [enable | disable]
Put/resume host into/from maintenance.
Note
Only administrators can access these commands. If you try to use these commands and the user name and tenant that you use to access the Compute service do not have the
admin role or the appropriate privileges, these errors occur:
ERROR: Policy does not allow compute_extension:aggregates to be performed. (HTTP 403) (Request-ID: req-299fbff6-6729-4cef-93b2e7e1f96b4864)
ERROR: Policy does not allow compute_extension:hosts to be performed. (HTTP 403) (Request-ID: req-ef2400f6-6776-4ea3-b6f1-
7704085c27d1)
Configure scheduler to support host aggregates
One common use case for host aggregates is when you want to support scheduling instances to a subset of compute hosts because they have a specific capability. For example, you may want to allow users to request compute hosts that have SSD drives if they need access to faster disk I/O, or access to compute hosts that have GPU cards to take advantage of GPU-accelerated code.
To configure the scheduler to support host aggregates, the scheduler_default_filters configuration option must contain the AggregateInstanceExtraSpecsFilter in addition to the other filters used by the scheduler. Add the following line to /etc/nova/nova.conf on the host that runs the nova-scheduler service to enable host aggregates filtering, as well as the other filters that are typically enabled: scheduler_default_filters=AggregateInstanceExtraSpecsFilter,RetryFilter,A vailabilityZoneFilter,RamFilter,ComputeFilter,ComputeCapabilitiesFilter,I magePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFil ter
Example: Specify compute hosts with SSDs
270
CHAPTER 3. COMPUTE
This example configures the Compute service to enable users to request nodes that have solidstate drives (SSDs). You create a fast-io host aggregate in the nova availability zone and you add the ssd=true key-value pair to the aggregate. Then, you add the node1, and node2 compute nodes to it.
$ nova aggregate-create fast-io nova
+----+---------+-------------------+-------+----------+
| Id | Name | Availability Zone | Hosts | Metadata |
+----+---------+-------------------+-------+----------+
| 1 | fast-io | nova | | |
+----+---------+-------------------+-------+----------+
$ nova aggregate-set-metadata 1 ssd=true
+----+---------+-------------------+-------+-------------------+
| Id | Name | Availability Zone | Hosts | Metadata |
+----+---------+-------------------+-------+-------------------+
| 1 | fast-io | nova | [] | {u'ssd': u'true'} |
+----+---------+-------------------+-------+-------------------+
$ nova aggregate-add-host 1 node1
+----+---------+-------------------+------------+-------------------
+
| Id | Name | Availability Zone | Hosts | Metadata |
+----+---------+-------------------+------------+-------------------
+
| 1 | fast-io | nova | [u'node1'] | {u'ssd': u'true'} |
+----+---------+-------------------+------------+-------------------
+
$ nova aggregate-add-host 1 node2
+----+---------+-------------------+----------------------+---------
----------+
| Id | Name | Availability Zone | Hosts | Metadata
|
+----+---------+-------------------+----------------------+---------
----------+
| 1 | fast-io | nova | [u'node1', u'node2'] | {u'ssd': u'true'} |
+----+---------+-------------------+----------------------+---------
----------+
Use the nova flavor-create command to create the ssd.large flavor called with an ID of 6,
8 GB of RAM, 80 GB root disk, and four vCPUs.
$ nova flavor-create ssd.large 6 8192 80 4
+----+-----------+-----------+------+-----------+------+-------+----
---------+-----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs |
RXTX_Factor | Is_Public |
+----+-----------+-----------+------+-----------+------+-------+----
---------+-----------+
| 6 | ssd.large | 8192 | 80 | 0 | | 4 | 1.0
| True |
+----+-----------+-----------+------+-----------+------+-------+----
---------+-----------+
271
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Once the flavor is created, specify one or more key-value pairs that match the key-value pairs on the host aggregates with scope aggregate_instance_extra_specs. In this case, that is the
aggregate_instance_extra_specs:ssd=true key-value pair. Setting a key-value pair on a flavor is done using the nova flavor-key command.
$ nova flavor-key ssd.large set aggregate_instance_extra_specs:ssd=true
Once it is set, you should see the extra_specs property of the ssd.large flavor populated with a key of ssd and a corresponding value of true.
$ nova flavor-show ssd.large
+----------------------------+-------------------------------------
-------------+
| Property | Value
|
+----------------------------+-------------------------------------
-------------+
| OS-FLV-DISABLED:disabled | False
|
| OS-FLV-EXT-DATA:ephemeral | 0
|
| disk | 80
|
| extra_specs | {u'aggregate_instance_extra_specs:ssd': u'true'} |
| id | 6
|
| name | ssd.large
|
| os-flavor-access:is_public | True
|
| ram | 8192
|
| rxtx_factor | 1.0
|
| swap |
|
| vcpus | 4
|
+----------------------------+-------------------------------------
-------------+
Now, when a user requests an instance with the ssd.large flavor, the scheduler only considers hosts with the ssd=true key-value pair. In this example, these are node1 and node2.
XenServer hypervisor pools to support live migration
When using the XenAPI-based hypervisor, the Compute service uses host aggregates to manage
XenServer Resource pools, which are used in supporting live migration.
272
3.12.6. Configuration reference
CHAPTER 3. COMPUTE
3.12.6. Configuration reference
To customize the Compute scheduler, use the configuration option settings documented in
Table 3.50, “Description of scheduler configuration options”
.
3.13. CELLS
Cells functionality enables you to scale an OpenStack Compute cloud in a more distributed fashion without having to use complicated technologies like database and message queue clustering. It supports very large deployments.
When this functionality is enabled, the hosts in an OpenStack Compute cloud are partitioned into groups called cells. Cells are configured as a tree. The top-level cell should have a host that runs a
nova-api service, but no nova-compute services. Each child cell should run all of the typical
nova-* services in a regular Compute cloud except for nova-api. You can think of cells as a normal Compute deployment in that each cell has its own database server and message queue broker.
The nova-cells service handles communication between cells and selects cells for new instances. This service is required for every cell. Communication between cells is pluggable, and currently the only option is communication through RPC.
Cells scheduling is separate from host scheduling. nova-cells first picks a cell. Once a cell is selected and the new build request reaches its nova-cells service, it is sent over to the host scheduler in that cell and the build proceeds as it would have without cells.
Warning
Cell functionality is currently considered experimental.
3.13.1. Cell configuration options
Cells are disabled by default. All cell-related configuration options appear in the [cells] section in
nova.conf. The following cell-related options are currently supported:
enable
Set to True to turn on cell functionality. Default is false.
name
Name of the current cell. Must be unique for each cell.
capabilities
273
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
List of arbitrary key=value pairs defining capabilities of the current cell. Values include
hypervisor=xenserver;kvm,os=linux.
call_timeout
How long in seconds to wait for replies from calls between cells.
scheduler_filter_classes
Filter classes that the cells scheduler should use. By default, uses
"nova.cells.filters.all_filters" to map to all cells filters included with Compute.
scheduler_weight_classes
Weight classes that the scheduler for cells uses. By default, uses
nova.cells.weights.all_weighers to map to all cells weight algorithms included with
Compute.
ram_weight_multiplier
Multiplier used to weight RAM. Negative numbers indicate that Compute should stack VMs on one host instead of spreading out new VMs to more hosts in the cell. The default value is
10.0.
3.13.2. Configure the API (top-level) cell
The cell type must be changed in the API cell so that requests can be proxied through nova-cells down to the correct cell properly. Edit the nova.conf file in the API cell, and specify api in the
cell_type key:
[DEFAULT] compute_api_class=nova.compute.cells_api.ComputeCellsAPI
...
[cells] cell_type= api
3.13.3. Configure the child cells
Edit the nova.conf file in the child cells, and specify compute in the cell_type key:
[DEFAULT]
# Disable quota checking in child cells. Let API cell do it exclusively.
quota_driver=nova.quota.NoopQuotaDriver
[cells] cell_type = compute
274
CHAPTER 3. COMPUTE
3.13.4. Configure the database in each cell
Before bringing the services online, the database in each cell needs to be configured with information about related cells. In particular, the API cell needs to know about its immediate children, and the child cells must know about their immediate agents. The information needed is the
RabbitMQ server credentials for the particular cell.
Use the nova-manage cell create command to add this information to the database in each cell:
# nova-manage cell create -h
Options:
-h, --help show this help message and exit
--name=<name> Name for the new cell
--cell_type=<parent|child>
Whether the cell is a parent or child
--username=<username>
Username for the message broker in this cell
--password=<password>
Password for the message broker in this cell
--hostname=<hostname>
Address of the message broker in this cell
--port=<number> Port number of the message broker in this cell
--virtual_host=<virtual_host>
The virtual host of the message broker in this cell
--woffset=<float>
(weight offset) It might be used by some cell scheduling code in the future
--wscale=<float>
(weight scale) It might be used by some cell scheduling code in the future
As an example, assume an API cell named api and a child cell named cell1.
Within the api cell, specify the following RabbitMQ server information: rabbit_host=10.0.0.10
rabbit_port=5672 rabbit_username=api_user rabbit_password=api_passwd rabbit_virtual_host=api_vhost
Within the cell1 child cell, specify the following RabbitMQ server information: rabbit_host=10.0.1.10
rabbit_port=5673 rabbit_username=cell1_user rabbit_password=cell1_passwd rabbit_virtual_host=cell1_vhost
275
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
You can run this in the API cell as root:
# nova-manage cell create --name cell1 --cell_type child --username cell1_user --password cell1_passwd --hostname 10.0.1.10 --port 5673 -virtual_host cell1_vhost --woffset 1.0 --wscale 1.0
Repeat the previous steps for all child cells.
In the child cell, run the following, as root:
# nova-manage cell create --name api --cell_type parent --username api_user --password api_passwd --hostname 10.0.0.10 --port 5672 -virtual_host api_vhost --woffset 1.0 --wscale 1.0
To customize the Compute cells, use the configuration option settings documented in Table 3.18,
“Description of cell configuration options” .
3.13.5. Cell scheduling configuration
To determine the best cell to use to launch a new instance, Compute uses a set of filters and weights defined in the /etc/nova/nova.conf file. The following options are available to prioritize cells for scheduling:
scheduler_filter_classes
List of filter classes. By default nova.cells.filters.all_filters is specified, which maps to all cells filters included with Compute (see
).
scheduler_weight_classes
List of weight classes. By default nova.cells.weights.all_weighers is specified, which maps to all cell weight algorithms included with Compute. The following modules are available:
mute_child. Downgrades the likelihood of child cells being chosen for scheduling requests, which have not sent capacity or capability updates in a while. Options include
mute_weight_multiplier (multiplier for mute children; value should be negative) and mute_weight_value (assigned to mute children; should be a positive value).
Warning
The mute_weight_value is deprecated, use
mute_weight_multiplier instead.
ram_by_instance_type. Select cells with the most RAM capacity for the instance type being requested. Because higher weights win, Compute returns the number of
276
CHAPTER 3. COMPUTE
available units for the instance type requested. The ram_weight_multiplier option defaults to 10.0 that adds to the weight by a factor of 10. Use a negative number to stack
VMs on one host instead of spreading out new VMs to more hosts in the cell.
weight_offset. Allows modifying the database to weight a particular cell. You can use this when you want to disable a cell (for example, '0'), or to set a default cell by making its weight_offset very high (for example, '999999999999999'). The highest weight will be the first cell to be scheduled for launching an instance.
Additionally, the following options are available for the cell scheduler:
scheduler_retries
Specifies how many times the scheduler tries to launch a new instance when no cells are available (default=10).
scheduler_retry_delay
Specifies the delay (in seconds) between retries (default=2).
As an admin user, you can also add a filter that directs builds to a particular cell. The policy.json file must have a line with "cells_scheduler_filter:TargetCellFilter" :
"is_admin:True" to let an admin user specify a scheduler hint to direct a build to a particular cell.
3.13.6. Optional cell configuration
Cells store all inter-cell communication data, including user names and passwords, in the database.
Because the cells data is not updated very frequently, use the [cells]cells_config option to specify a JSON file to store cells data. With this configuration, the database is no longer consulted when reloading the cells data. The file must have columns present in the Cell model (excluding common database fields and the id column). You must specify the queue connection information through a transport_url field, instead of username, password, and so on. The
transport_url has the following form: rabbit://USERNAME:PASSWORD@HOSTNAME:PORT/VIRTUAL_HOST
The scheme can be either qpid or rabbit, as shown previously. The following sample shows this optional configuration:
{
"parent": {
"name": "parent",
"api_url": "http://api.example.com:8774",
"transport_url": "rabbit://rabbit.example.com",
"weight_offset": 0.0,
"weight_scale": 1.0,
"is_parent": true
},
"cell1": {
277
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"name": "cell1",
"api_url": "http://api.example.com:8774",
"transport_url": "rabbit://rabbit1.example.com",
"weight_offset": 0.0,
"weight_scale": 1.0,
"is_parent": false
},
"cell2": {
"name": "cell2",
"api_url": "http://api.example.com:8774",
"transport_url": "rabbit://rabbit2.example.com",
"weight_offset": 0.0,
"weight_scale": 1.0,
"is_parent": false
}
}
3.14. CONDUCTOR
The nova-conductor service enables OpenStack to function without compute nodes accessing the database. Conceptually, it implements a new layer on top of nova-compute. It should not be deployed on compute nodes, or else the security benefits of removing database access from nova-
compute are negated. Just like other nova services such as nova-api or nova-scheduler, it can be scaled horizontally. You can run multiple instances of nova-conductor on different machines as needed for scaling purposes.
The methods exposed by nova-conductor are relatively simple methods used by nova-
compute to offload its database operations. Places where nova-compute previously performed database access are now talking to nova-conductor. However, there are plans in the medium to long term to move more and more of what is currently in nova-compute up to the nova-
conductor layer. The Compute service will start to look like a less intelligent slave service to
nova-conductor. The conductor service will implement long running complex operations, ensuring forward progress and graceful error handling. This will be especially beneficial for operations that cross multiple compute nodes, such as migrations or resizes.
To customize the Conductor, use the configuration option settings documented in Table 3.21,
“Description of conductor configuration options” .
3.15. EXAMPLE
NOVA.CONF
CONFIGURATION FILES
The following sections describe the configuration options in the nova.conf file. You must copy the
nova.conf file to each compute node. The sample nova.conf files show examples of specific configurations.
Small, private cloud
This example nova.conf file configures a small private cloud with cloud controller services, database server, and messaging server on the same server. In this case, CONTROLLER_IP represents the IP address of a central server, BRIDGE_INTERFACE represents the bridge such as
278
CHAPTER 3. COMPUTE
br100, the NETWORK_INTERFACE represents an interface to your VLAN setup, and passwords are represented as DB_PASSWORD_COMPUTE for your Compute (nova) database password, and
RABBIT PASSWORD represents the password to your message queue installation.
[DEFAULT]
# LOGS/STATE verbose=True logdir=/var/log/nova state_path=/var/lib/nova lock_path=/var/lock/nova rootwrap_config=/etc/nova/rootwrap.conf
# SCHEDULER compute_scheduler_driver=nova.scheduler.filter_scheduler.FilterScheduler
# VOLUMES
# configured in cinder.conf
# COMPUTE compute_driver=libvirt.LibvirtDriver
instance_name_template=instance-%08x api_paste_config=/etc/nova/api-paste.ini
# COMPUTE/APIS: if you have separate configs for separate services
# this flag is required for both nova-api and nova-compute allow_resize_to_same_host=True
# APIS osapi_compute_extension=nova.api.openstack.compute.contrib.standard_exten
sions ec2_dmz_host=192.168.206.130
s3_host=192.168.206.130
# RABBITMQ rabbit_host=192.168.206.130
# GLANCE image_service=nova.image.glance.GlanceImageService
# NETWORK network_manager=nova.network.manager.FlatDHCPManager
force_dhcp_release=True dhcpbridge_flagfile=/etc/nova/nova.conf
firewall_driver=nova.virt.libvirt.firewall.IptablesFirewallDriver
# Change my_ip to match each host my_ip=192.168.206.130
public_interface=eth0 vlan_interface=eth0 flat_network_bridge=br100 flat_interface=eth0
# NOVNC CONSOLE novncproxy_base_url=http://192.168.206.130:6080/vnc_auto.html
# Change vncserver_proxyclient_address and vncserver_listen to match each compute host
279
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
vncserver_proxyclient_address=192.168.206.130
vncserver_listen=192.168.206.130
# AUTHENTICATION auth_strategy=keystone
[keystone_authtoken] auth_host = 127.0.0.1
auth_port = 35357 auth_protocol = http admin_tenant_name = service admin_user = nova admin_password = nova signing_dirname = /tmp/keystone-signing-nova
# GLANCE
[glance] api_servers=192.168.206.130:9292
# DATABASE
[database] connection=mysql://nova:[email protected]/nova
# LIBVIRT
[libvirt] virt_type=qemu
KVM, Flat, MySQL, and Glance, OpenStack or EC2 API
280
This example nova.conf file, from an internal Rackspace test system, is used for demonstrations.
[DEFAULT]
# LOGS/STATE verbose=True logdir=/var/log/nova state_path=/var/lib/nova lock_path=/var/lock/nova rootwrap_config=/etc/nova/rootwrap.conf
# SCHEDULER compute_scheduler_driver=nova.scheduler.filter_scheduler.FilterScheduler
# VOLUMES
# configured in cinder.conf
# COMPUTE compute_driver=libvirt.LibvirtDriver
instance_name_template=instance-%08x api_paste_config=/etc/nova/api-paste.ini
# COMPUTE/APIS: if you have separate configs for separate services
# this flag is required for both nova-api and nova-compute allow_resize_to_same_host=True
# APIS
CHAPTER 3. COMPUTE
osapi_compute_extension=nova.api.openstack.compute.contrib.standard_exten
sions ec2_dmz_host=192.168.206.130
s3_host=192.168.206.130
# RABBITMQ rabbit_host=192.168.206.130
# GLANCE image_service=nova.image.glance.GlanceImageService
# NETWORK network_manager=nova.network.manager.FlatDHCPManager
force_dhcp_release=True dhcpbridge_flagfile=/etc/nova/nova.conf
firewall_driver=nova.virt.libvirt.firewall.IptablesFirewallDriver
# Change my_ip to match each host my_ip=192.168.206.130
public_interface=eth0 vlan_interface=eth0 flat_network_bridge=br100 flat_interface=eth0
# NOVNC CONSOLE novncproxy_base_url=http://192.168.206.130:6080/vnc_auto.html
# Change vncserver_proxyclient_address and vncserver_listen to match each compute host vncserver_proxyclient_address=192.168.206.130
vncserver_listen=192.168.206.130
# AUTHENTICATION auth_strategy=keystone
[keystone_authtoken] auth_host = 127.0.0.1
auth_port = 35357 auth_protocol = http admin_tenant_name = service admin_user = nova admin_password = nova signing_dirname = /tmp/keystone-signing-nova
# GLANCE
[glance] api_servers=192.168.206.130:9292
# DATABASE
[database] connection=mysql://nova:[email protected]/nova
# LIBVIRT
[libvirt] virt_type=qemu
XenServer, Flat networking, MySQL, and Glance, OpenStack API
281
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
This example nova.conf file is from an internal Rackspace test system.
verbose nodaemon network_manager=nova.network.manager.FlatManager
image_service=nova.image.glance.GlanceImageService
flat_network_bridge=xenbr0 compute_driver=xenapi.XenAPIDriver
xenapi_connection_url=https://<XenServer IP> xenapi_connection_username=root xenapi_connection_password=supersecret xenapi_image_upload_handler=nova.virt.xenapi.image.glance.GlanceStore
rescue_timeout=86400 use_ipv6=true
3.16. COMPUTE LOG FILES
The corresponding log file of each Compute service is stored in the /var/log/nova/ directory of the host on which each service runs.
Table 3.10. Log files used by Compute services
Log file
api.log
cert.log
compute.log
conductor.log
consoleauth.log
network.log
nova-manage.log
scheduler.log
Service name openstack-nova-api
openstack-nova-cert openstack-nova-compute openstack-nova-conductor openstack-nova-consoleauth openstack-nova-network nova-manage openstack-nova-scheduler
The X509 certificate service (
openstack-nova-cert
/
nova-cert
) is only required by the EC2 API to the Compute service.
The
nova
network service (
openstack-nova-network
/
nova-network
) only runs in deployments that are not configured to use the Networking service (
neutron
).
282
3.17. COMPUTE SAMPLE CONFIGURATION FILES
CHAPTER 3. COMPUTE
3.17.1. nova.conf - configuration options
For a complete list of all available configuration options for each OpenStack Compute service, run nova-<servicename> --help.
Table 3.11. Description of API configuration options
Configuration option = Default value
[DEFAULT]
Description api_paste_config api_rate_limit
= api-paste.ini
= False
client_socket_timeout enable_new_services
= 900
= True
(StrOpt) File name for the paste.deploy config for nova-api
(BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api.
(IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.
(BoolOpt) Services to be added to the available pool on create
(ListOpt) A list of APIs to enable by default
enabled_apis
= ec2, osapi_compute,
metadata
enabled_ssl_apis
= (ListOpt) A list of APIs with enabled SSL
instance_name_template
= instance-%08x (StrOpt) Template string to be used to generate instance names
max_header_line
= 16384 (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
multi_instance_display_name_templa te
= %(name)s-%(count)d
(StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s".
Valid keys for the template are: name, uuid, count.
non_inheritable_image_properties
=
cache_in_nova, bittorrent
(ListOpt) These are image properties which a snapshot should not inherit from an instance
283
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value null_kernel
= nokernel
osapi_compute_ext_list
=
Description
(StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead
(ListOpt) Specify list of extensions to load when using osapi_compute_extension option with nova.api.openstack.compute.contrib.select_extensi
ons
osapi_compute_extension
=
['nova.api.openstack.compute.contrib.standard_ext
ensions']
(MultiStrOpt) osapi compute extension to load
osapi_compute_link_prefix
= None (StrOpt) Base URL that will be presented to users in links to the OpenStack Compute API
osapi_compute_listen
= 0.0.0.0
osapi_compute_listen_port osapi_compute_workers snapshot_name_template tcp_keepidle
= 600
use_forwarded_for
= 8774
= None
osapi_hide_server_address_states
building
servicegroup_driver wsgi_keep_alive
= db
= True
=
= snapshot-%s
= False
wsgi_default_pool_size
= 1000
(StrOpt) The IP address on which the OpenStack
API will listen.
(IntOpt) The port on which the OpenStack API will listen.
(IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available.
(ListOpt) List of instance states that should hide network info
(StrOpt) The driver for servicegroup service (valid options are: db, zk, mc)
(StrOpt) Template string to be used to generate snapshot names
(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on
OS X.
(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
(IntOpt) Size of the pool of greenthreads used by wsgi
(BoolOpt) If False, closes the client socket connection explicitly.
284
Configuration option = Default value wsgi_log_format
= %(client_ip)s "%
(request_line)s" status: %(status_code)s len: %
(body_length)s time: %(wall_seconds).7f
CHAPTER 3. COMPUTE
Description
(StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.
Table 3.12. Description of API v3 configuration options
Description Configuration option = Default value
[osapi_v3] enabled
= False
extensions_blacklist
=
extensions_whitelist
=
(BoolOpt) Whether the V3 API is enabled or not
(ListOpt) A list of v3 API extensions to never load.
Specify the extension aliases here.
(ListOpt) If the list is not empty then a v3 API extension will only be loaded if it exists in this list.
Specify the extension aliases here.
Table 3.13. Description of authentication configuration options
Description Configuration option = Default value
[DEFAULT] auth_strategy
= keystone (StrOpt) The strategy to use for auth: keystone, noauth (deprecated), or noauth2. Both noauth and noauth2 are designed for testing only, as they do no actual credential checking. noauth provides administrative credentials regardless of the passed in user, noauth2 only does if 'admin' is specified as the username.
Table 3.14. Description of authorization token configuration options
Description Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
(StrOpt) Service user password.
(StrOpt) Service tenant name.
285
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value admin_token
= None
admin_user auth_port auth_protocol auth_section cache
= None
cafile
= None
certfile
= None
auth_admin_prefix auth_host auth_plugin auth_uri
= 127.0.0.1
= None
= 35357
= None
auth_version
= None
=
= https
= None
= None
check_revocations_for_cached
= False
delay_auth_decision
= False
Description
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
286
CHAPTER 3. COMPUTE
Configuration option = Default value enforce_token_bind
= permissive
hash_algorithms http_connect_timeout http_request_max_retries identity_uri insecure keyfile
= False
= None
= md5
= None
= None
include_service_catalog memcache_pool_conn_get_timeout
= 10
memcache_pool_dead_retry memcache_pool_maxsize
= True
= 10
= 3
= 300
Description
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times to try to reconnect when communicating with Identity API Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
287
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value memcache_pool_socket_timeout
= 3
memcache_pool_unused_timeout memcache_secret_key memcache_security_strategy memcache_use_advanced_pool revocation_cache_time signing_dir
= None
token_cache_time
= None
= 300
= 10
= 60
= None
= False
Description
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
Table 3.15. Description of availability zones configuration options
Description Configuration option = Default value
[DEFAULT] default_availability_zone
= nova (StrOpt) Default compute node availability_zone
288
CHAPTER 3. COMPUTE
Configuration option = Default value default_schedule_zone
= None
Description
(StrOpt) Availability zone to use when user does not specify one
internal_service_availability_zone
= internal
(StrOpt) The availability_zone to show internal services under
Table 3.16. Description of Barbican configuration options
Configuration option = Default value
[barbican] cafile
= None
Description catalog_info
= key-manager:barbican:public
certfile endpoint_template insecure keyfile timeout
= None
= False
= None
os_region_name
= None
= None
= None
(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
(StrOpt) Info to match when looking for barbican in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:
<endpoint_type>
(StrOpt) PEM encoded client certificate cert file
(StrOpt) Override service catalog lookup with template for barbican endpoint e.g.
http://localhost:9311/v1/%(project_id)s
(BoolOpt) Verify HTTPS connections.
(StrOpt) PEM encoded client certificate key file
(StrOpt) Region name of this node
(IntOpt) Timeout value for http requests
Table 3.17. Description of CA and SSL configuration options
Description Configuration option = Default value
[DEFAULT] ca_file
= cacert.pem
ca_path
= $state_path/CA
cert
= self.pem
(StrOpt) Filename of root CA
(StrOpt) Where to keep the root CA
(StrOpt) SSL certificate file
289
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value cert_manager
=
nova.cert.manager.CertManager
cert_topic crl_file
= cert
= crl.pem
Description
(StrOpt) Full class name for the Manager for cert
(StrOpt) The topic cert nodes listen on
(StrOpt) Filename of root Certificate Revocation
List
key_file
= private/cakey.pem
keys_path
= $state_path/keys
(StrOpt) Filename of private key
(StrOpt) Where to keep the keys
project_cert_subject
=
/C=US/ST=California/O=OpenStack/OU=NovaDev/
CN=project-ca-%.16s-%s
(StrOpt) Subject for certificate for projects, %s for project, timestamp
ssl_ca_file
= None (StrOpt) CA certificate file to use to verify connecting clients
ssl_cert_file
= None
ssl_key_file
= None
(StrOpt) SSL certificate of API server
(StrOpt) SSL private key of API server
use_project_ca
= False (BoolOpt) Should a CA be used for each project?
user_cert_subject
=
/C=US/ST=California/O=OpenStack/OU=NovaDev/
CN=%.16s-%.16s-%s
(StrOpt) Subject for certificate for users, %s for project, user, timestamp
[ssl] ca_file
= None
cert_file key_file
= None
= None
(StrOpt) CA certificate file to use to verify connecting clients.
(StrOpt) Certificate file to use when starting the server securely.
(StrOpt) Private key file to use when starting the server securely.
Table 3.18. Description of cell configuration options
Description Configuration option = Default value
[cells]
290
Configuration option = Default value call_timeout
= 60
capabilities
os=linux
= hypervisor=xenserver;kvm,
cell_type
= compute
cells_config
= None
Description
(IntOpt) Seconds to wait for response from a call to a cell.
(ListOpt) Key/Multi-value list with the capabilities of the cell
(StrOpt) Type of cell: api or compute
(StrOpt) Configuration file from which to read cells configuration. If given, overrides reading cells from the database.
db_check_interval topic
= cells
= 60 (IntOpt) Interval, in seconds, for getting fresh cell information from the database.
(StrOpt) Cells communication driver to use
driver
= nova.cells.rpc_driver.CellsRPCDriver
enable
= False
instance_update_num_instances
= 1
mute_weight_value
= 1000.0
(BoolOpt) Enable cell functionality
instance_updated_at_threshold
= 3600 (IntOpt) Number of seconds after an instance was updated or deleted to continue to update cells
(StrOpt) Manager for cells
manager
= nova.cells.manager.CellsManager
max_hop_count
= 10
mute_child_interval
= 300
(IntOpt) Maximum number of hops for cells routing.
(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.
mute_weight_multiplier
= -10.0
(IntOpt) Number of instances to update per periodic task run
(FloatOpt) Multiplier used to weigh mute children.
(The value should be negative.)
(FloatOpt) Weight value assigned to mute children.
(The value should be positive.)
(StrOpt) Name of this cell
name
= nova
offset_weight_multiplier
= 1.0
reserve_percent
= 10.0
(FloatOpt) Multiplier used to weigh offset weigher.
(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization
(StrOpt) The topic cells nodes listen on
Table 3.19. Description of common configuration options
CHAPTER 3. COMPUTE
291
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[DEFAULT] bindir compute_topic
= compute
console_topic
= console
consoleauth_topic host
= /usr/local/bin
= localhost
memcached_servers
= consoleauth
= None
Description
(StrOpt) Directory where nova binaries are installed
(StrOpt) The topic compute nodes listen on
(StrOpt) The topic console proxy nodes listen on
(StrOpt) The topic console auth proxy nodes listen on
(StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key.
(ListOpt) Memcached servers or None for in process cache.
my_ip
= 10.0.0.1
notify_api_faults
= False
notify_on_state_change
= None
(StrOpt) IP address of this host
(BoolOpt) If set, send api.fault notifications on caught exceptions in the API service.
(StrOpt) If set, send compute.instance.update
notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or
"vm_and_task_state" for notifications on VM and task state changes.
pybasedir
= /usr/lib/python/site-packages/nova (StrOpt) Directory where the nova python module is installed
report_interval
= 10
rootwrap_config
= /etc/nova/rootwrap.conf
(IntOpt) Seconds between nodes reporting state to datastore
(StrOpt) Path to the rootwrap configuration file to use for running commands as root
service_down_time
= 60
state_path tempdir
= $pybasedir
= None
(IntOpt) Maximum time since last check-in for up service
(StrOpt) Top-level directory for maintaining nova's state
(StrOpt) Explicitly specify the temporary working directory
292
CHAPTER 3. COMPUTE
Configuration option = Default value
[keystone_authtoken] memcached_servers
= None
Description
(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
[workarounds] destroy_after_evacuate
= True
disable_libvirt_livesnapshot
= True
disable_rootwrap
= False
(BoolOpt) Whether to destroy instances on startup when it is suspected that they have previously been evacuated. This can result in data loss if undesired. See https://launchpad.net/bugs/1419785
(BoolOpt) When using libvirt 1.2.2 fails live snapshots intermittently under load. This config option provides mechanism to disable livesnapshot while this is resolved. See https://bugs.launchpad.net/nova/+bug/1334398
(BoolOpt) This option allows a fallback to sudo for performance reasons. For example see https://bugs.launchpad.net/nova/+bug/1415106
Table 3.20. Description of Compute configuration options
Description Configuration option = Default value
[DEFAULT] compute_available_monitors
=
['nova.compute.monitors.all_monitors']
compute_driver
= None
compute_manager
=
nova.compute.manager.ComputeManager
compute_monitors
=
compute_resources
= vcpu
(MultiStrOpt) Monitor classes available to the compute which may be specified more than once.
(StrOpt) Driver to use for controlling virtualization.
Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver
(StrOpt) Full class name for the Manager for compute
(ListOpt) A list of monitors that can be used for getting compute metrics.
(ListOpt) The names of the extra resources to track.
293
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value compute_stats_class
=
nova.compute.stats.Stats
console_host
= localhost
console_manager
nova.console.manager.ConsoleProxyManager
default_flavor
=
= m1.small
default_notification_level enable_instance_password instance_build_timeout
= 0
instance_delete_interval instance_usage_audit instances_path
= INFO
= True
heal_instance_info_cache_interval
= 60
image_cache_manager_interval
= 2400
image_cache_subdirectory_name
_base
= 300
= False
instance_usage_audit_period
=
= month
= $state_path/instances
Description
(StrOpt) Class that will manage stats for the local compute host
(StrOpt) Console proxy host to use to connect to instances on this host.
(StrOpt) Full class name for the Manager for console proxy
(StrOpt) Default flavor to use for the EC2 API only.
The Nova API does not support a default flavor.
(StrOpt) Default notification level for outgoing notifications
(BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct
(IntOpt) Number of seconds between instance network information cache updates
(IntOpt) Number of seconds to wait between runs of the image cache manager. Set to -1 to disable.
Setting this to 0 will run at the default rate.
(StrOpt) Where cached images are stored under
$instances_path. This is NOT the full path - only a folder name. For per-compute-host cached images, set to _base_$my_ip
(IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status.
Set to 0 to disable.
(IntOpt) Interval in seconds for retrying failed instance file deletes. Set to -1 to disable. Setting this to 0 will run at the default rate.
(BoolOpt) Generate periodic compute.instance.exists notifications
(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year
(StrOpt) Where instances are stored on disk
294
CHAPTER 3. COMPUTE
Configuration option = Default value max_concurrent_builds
= 10
maximum_instance_delete_attempts
5
reboot_timeout
= 0
reclaim_instance_interval
= 0
=
Description
(IntOpt) Maximum number of instance builds to run concurrently
(IntOpt) The number of times to attempt to reap an instance's files.
(IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable.
(IntOpt) Interval in seconds for reclaiming deleted instances
rescue_timeout
= 0 (IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable.
resize_confirm_window
= 0
resume_guests_state_on_host_boot
False
running_deleted_instance_action
=
reap
=
(IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable.
(BoolOpt) Whether to start guests that were running before the host rebooted
(StrOpt) Action to take if a running deleted instance is detected. Valid options are 'noop', 'log',
'shutdown', or 'reap'. Set to 'noop' to take no action.
running_deleted_instance_poll_inte rval
= 1800
(IntOpt) Number of seconds to wait between runs of the cleanup task.
running_deleted_instance_timeout
=
0
(IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup.
shelved_offload_time
= 0
shelved_poll_interval shutdown_timeout
= 60
sync_power_state_interval vif_plugging_is_fatal
= 3600
= 600
= True
(IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload when shelved
(IntOpt) Interval in seconds for polling shelved instances to offload. Set to -1 to disable.Setting this to 0 will run at the default rate.
(IntOpt) Total amount of time to wait in seconds for an instance to perform a clean shutdown.
(IntOpt) Interval to sync power states between the database and the hypervisor. Set to -1 to disable.
Setting this to 0 will run at the default rate.
(BoolOpt) Fail instance boot if vif plugging fails
295
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value vif_plugging_timeout
= 300
Description
(IntOpt) Number of seconds to wait for neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal). If this is set to zero and vif_plugging_is_fatal is False, events should not be expected to arrive at all.
Table 3.21. Description of conductor configuration options
Description Configuration option = Default value
[DEFAULT] migrate_max_retries
= -1 (IntOpt) Number of times to retry live-migration before failing. If set to -1, try until out of hosts. If set to 0, only try once, no retries.
[conductor] manager
=
nova.conductor.manager.ConductorManager
topic
= conductor
use_local
= False
workers
= None
(StrOpt) Full class name for the Manager for conductor
(StrOpt) The topic on which conductor nodes listen
(BoolOpt) Perform nova-conductor operations locally
(IntOpt) Number of workers for OpenStack
Conductor service. The default will be the number of CPUs available.
296
Table 3.22. Description of config drive configuration options
Configuration option = Default value
[DEFAULT]
Description config_drive_format
= iso9660
config_drive_skip_versions
= 1.0 2007-
01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-
15 2008-02-01 2008-09-01
(StrOpt) List of metadata versions to skip placing into the config drive
force_config_drive
= None
(StrOpt) Config drive format. One of iso9660
(default) or vfat
(StrOpt) Set to "always" to force injection to take place on a config drive. NOTE: The "always" will be deprecated in the Liberty release cycle.
CHAPTER 3. COMPUTE
Configuration option = Default value mkisofs_cmd
= genisoimage
Description
(StrOpt) Name and optionally path of the tool used for ISO image creation
[hyperv] config_drive_cdrom
= False
config_drive_inject_password
= False
(BoolOpt) Attaches the Config Drive image as a cdrom drive instead of a disk drive
(BoolOpt) Sets the admin password in the config drive image
Table 3.23. Description of console configuration options
Configuration option = Default value
[DEFAULT] console_public_hostname
= localhost
console_token_ttl
= 600
consoleauth_manager
=
nova.consoleauth.manager.ConsoleAuthManager
Description
(StrOpt) Publicly visible name for this console host
(IntOpt) How many seconds before deleting tokens
(StrOpt) Manager for console auth
Table 3.24. Description of database configuration options
Description Configuration option = Default value
[DEFAULT] db_driver
= nova.db
[api_database] connection
= None
(StrOpt) The driver to use for database access
connection_debug connection_trace idle_timeout
= 0
= False
= 3600
(StrOpt) The SQLAlchemy connection string to use to connect to the Nova API database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(IntOpt) Timeout before idle SQL connections are reaped.
297
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value max_overflow
= None
max_pool_size max_retries pool_timeout
= None
= 10
mysql_sql_mode
= TRADITIONAL
= None
retry_interval
= 10
slave_connection
= None
Description
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(BoolOpt) If True, SQLite uses synchronous mode.
sqlite_synchronous
= True
[database] backend
= sqlalchemy
connection
= None
connection_debug
= 0
connection_trace db_inc_retry_interval db_max_retries
= False
= 20
= True
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
298
Configuration option = Default value db_max_retry_interval
= 10
db_retry_interval
= 1
idle_timeout
= 3600
max_overflow
= None
max_pool_size
= None
max_retries
= 10
min_pool_size
= 1
mysql_sql_mode
= TRADITIONAL
pool_timeout
= None
retry_interval
= 10
slave_connection
= None
sqlite_db
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
use_tpool
= False
CHAPTER 3. COMPUTE
Description
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
(BoolOpt) Enable the experimental use of thread pooling for all DB API calls
299
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 3.25. Description of logging configuration options
Configuration option = Default value
[DEFAULT] backdoor_port
= None
Description
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
[guestfs] debug
= False (BoolOpt) Enable guestfs debug
Table 3.26. Description of EC2 configuration options
Description Configuration option = Default value
[DEFAULT] ec2_dmz_host
= $my_ip
ec2_host ec2_listen ec2_listen_port ec2_path ec2_port
= $my_ip
= /
= 0.0.0.0
= 8773
= 8773
ec2_private_dns_show_ip ec2_scheme
= http
ec2_strict_validation
= False
= True
(StrOpt) The internal IP address of the EC2 API server
(StrOpt) The IP address of the EC2 API server
(StrOpt) The IP address on which the EC2 API will listen.
(IntOpt) The port on which the EC2 API will listen.
(StrOpt) The path prefix used to call the ec2 API server
(IntOpt) The port of the EC2 API server
(BoolOpt) Return the IP address as private dns hostname in describe instances
(StrOpt) The protocol to use when connecting to the EC2 API server (http, https)
(BoolOpt) Validate security group names according to EC2 specification
300
Configuration option = Default value ec2_timestamp_expiry
= 300
ec2_workers
= None
keystone_ec2_insecure keystone_ec2_url
=
= False
http://localhost:5000/v2.0/ec2tokens
lockout_attempts
= 5
lockout_minutes
= 15
lockout_window
= 15
region_list
=
CHAPTER 3. COMPUTE
Description
(IntOpt) Time in seconds before ec2 timestamp expires
(IntOpt) Number of workers for EC2 API service.
The default will be equal to the number of CPUs available.
(BoolOpt) Disable SSL certificate verification.
(StrOpt) URL to get token from ec2 request.
(IntOpt) Number of failed auths before lockout.
(IntOpt) Number of minutes to lockout if triggered.
(IntOpt) Number of minutes for lockout window.
(ListOpt) List of region=fqdn pairs separated by commas
Table 3.27. Description of ephemeral storage encryption configuration options
Description Configuration option = Default value
[ephemeral_storage_encryption] cipher
= aes-xts-plain64
enabled
= False
key_size
= 512
(StrOpt) The cipher and mode to be used to encrypt ephemeral storage. Which ciphers are available ciphers depends on kernel support. See
/proc/crypto for the list of available options.
(BoolOpt) Whether to encrypt ephemeral storage
(IntOpt) The bit length of the encryption key to be used to encrypt ephemeral storage (in XTS mode only half of the bits are used for encryption key)
Table 3.28. Description of fping configuration options
Description Configuration option = Default value
[DEFAULT] fping_path
= /usr/sbin/fping (StrOpt) Full path to fping.
301
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 3.29. Description of glance configuration options
Description Configuration option = Default value
[DEFAULT] osapi_glance_link_prefix
= None
[glance] allowed_direct_url_schemes
=
(StrOpt) Base URL that will be presented to users in links to glance resources
api_insecure api_servers host num_retries port
= $my_ip
= 9292
protocol
= False
= None
= 0
= http
(ListOpt) A list of url scheme that can be downloaded directly via the direct_url. Currently supported schemes: [file].
(BoolOpt) Allow to perform insecure SSL (https) requests to glance
(ListOpt) A list of the glance api servers available to nova. Prefix with https:// for ssl-based glance api servers. ([hostname|ip]:port)
(StrOpt) Default glance hostname or IP address
(IntOpt) Number of retries when uploading / downloading an image to / from glance.
(IntOpt) Default glance port
(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.
[image_file_url] filesystems
= (ListOpt) List of file systems that are configured in this file in the image_file_url:<list entry name> sections
Table 3.30. Description of hypervisor configuration options
Description Configuration option = Default value
[DEFAULT] default_ephemeral_format
= None
force_raw_images
= True
(StrOpt) The default format an ephemeral_volume will be formatted with on creation.
(BoolOpt) Force backing images to raw format
302
Configuration option = Default value preallocate_images
= none
timeout_nbd
= 10
use_cow_images
= True
vcpu_pin_set
= None
virt_mkfs
= []
CHAPTER 3. COMPUTE
Description
(StrOpt) VM image preallocation mode: "none" => no storage provisioning is done up front, "space"
=> storage is fully allocated at instance start
(IntOpt) Amount of time, in seconds, to wait for
NBD device start up.
(BoolOpt) Whether to use cow images
(StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15"
(MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command>
Table 3.31. Description of bare metal configuration options
Description Configuration option = Default value
[ironic] admin_auth_token
= None
admin_password
= None
admin_tenant_name
= None
admin_url
= None
admin_username
= None
api_endpoint
= None
api_max_retries
= 60
api_retry_interval
= 2
api_version
= 1
client_log_level
= None
(StrOpt) Ironic keystone auth token.
(StrOpt) Ironic keystone admin password.
(StrOpt) Ironic keystone tenant name.
(StrOpt) Keystone public API endpoint.
(StrOpt) Ironic keystone admin name
(StrOpt) URL for Ironic API endpoint.
(IntOpt) How many retries when a request does conflict.
(IntOpt) How often to retry in seconds when a request does conflict
(IntOpt) Version of Ironic API service endpoint.
(StrOpt) Log level override for ironicclient. Set this in order to override the global "default_log_levels",
"verbose", and "debug" settings. DEPRECATED: use standard logging configuration.
303
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 3.32. Description of IPv6 configuration options
Configuration option = Default value
[DEFAULT] fixed_range_v6
= fd00::/48
gateway_v6
= None
ipv6_backend
= rfc2462
use_ipv6
= False
Description
(StrOpt) Fixed IPv6 address block
(StrOpt) Default IPv6 gateway
(StrOpt) Backend to use for IPv6 generation
(BoolOpt) Use IPv6
Table 3.33. Description of key manager configuration options
Description Configuration option = Default value
[keymgr] api_class
=
nova.keymgr.conf_key_mgr.ConfKeyManager
fixed_key
= None
(StrOpt) The full class name of the key manager
API class
(StrOpt) Fixed key returned by key manager, specified in hex
Table 3.34. Description of LDAP configuration options
Description Configuration option = Default value
[DEFAULT] ldap_dns_base_dn
=
ou=hosts,dc=example,dc=org
ldap_dns_password
= password
ldap_dns_servers
= ['dns.example.org']
ldap_dns_soa_expiry
= 86400
ldap_dns_soa_hostmaster
=
(StrOpt) Base DN for DNS entries in LDAP
(StrOpt) Password for LDAP DNS
(MultiStrOpt) DNS Servers for LDAP DNS driver
(StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority
(StrOpt) Hostmaster for LDAP DNS driver
Statement of Authority
304
CHAPTER 3. COMPUTE
Configuration option = Default value ldap_dns_soa_minimum
= 7200
ldap_dns_soa_refresh ldap_dns_soa_retry ldap_dns_url
= ldap://ldap.example.com:389
ldap_dns_user
=
= 1800
= 3600
uid=admin,ou=people,dc=example,dc=org
Description
(StrOpt) Minimum interval (in seconds) for LDAP
DNS driver Statement of Authority
(StrOpt) Refresh interval (in seconds) for LDAP
DNS driver Statement of Authority
(StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority
(StrOpt) URL for LDAP server which will store DNS entries
(StrOpt) User for LDAP DNS
Table 3.35. Description of Libvirt configuration options
Configuration option = Default value
[DEFAULT]
Description remove_unused_base_images
= True (BoolOpt) Should unused base images be removed?
remove_unused_original_minimum_age
_seconds
= 86400
[libvirt]
(IntOpt) Unused unresized base images younger than this will not be removed
block_migration_flag
=
VIR_MIGRATE_UNDEFINE_SOURCE,
VIR_MIGRATE_PEER2PEER,
VIR_MIGRATE_LIVE,
VIR_MIGRATE_TUNNELLED,
VIR_MIGRATE_NON_SHARED_INC
checksum_base_images
= False
(StrOpt) Migration flags to be set for block migration
checksum_interval_seconds connection_uri
=
= 3600
(BoolOpt) Write a checksum for files in _base to disk
(IntOpt) How frequently to checksum base images
(StrOpt) Override the default libvirt URI (which is dependent on virt_type)
305
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value cpu_mode
= None
cpu_model disk_cachemodes disk_prefix gid_maps
=
= None
= None
hw_disk_discard
=
= None
Description
(StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host
CPU model exactly; to "custom" to use a named
CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "hostmodel", otherwise it will default to "none"
(StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml).
Only has effect if cpu_mode="custom" and virt_type="kvm|qemu"
(ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none
(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd)
(ListOpt) List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5 allowed.
(StrOpt) Discard option for nova managed disks
(valid options are: ignore, unmap). Need
Libvirt(1.0.6) Qemu1.5 (raw format)
Qemu1.6(qcow2 format)
hw_machine_type
= None (ListOpt) For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is hostarch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2
image_info_filename_pattern
=
$instances_path/$image_cache_subdirectory_nam e/%(image)s.info
(StrOpt) Allows image information files to be stored in non-standard locations
(StrOpt) Path to the ceph configuration file to use
images_rbd_ceph_conf
=
images_rbd_pool
= rbd (StrOpt) The RADOS pool in which rbd volumes are stored
images_type
= default (StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm, rbd, default. If default is specified, then use_cow_images flag is used instead of this one.
306
CHAPTER 3. COMPUTE
Configuration option = Default value images_volume_group
= None
inject_key
= False
inject_partition inject_password iscsi_iface
= -2
= False
= None
iscsi_use_multipath iser_use_multipath
= False
= False
mem_stats_period_seconds remove_unused_kernels
= 10
= False
Description
(StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm.
(BoolOpt) Inject the ssh public key at boot time
(IntOpt) The partition to inject to : -2 => disable, -1
=> inspect (libguestfs only), 0 => not partitioned, >0
=> partition number
(BoolOpt) Inject the admin password at boot time, without an agent.
(StrOpt) The iSCSI transport iface to use to connect to target in case offload support is desired.
Supported transports are be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx and ocs. Default format is transport_name.hwaddress and can be generated manually or via iscsiadm -m iface
(BoolOpt) Use multipath connection of the iSCSI volume
(BoolOpt) Use multipath connection of the iSER volume
(IntOpt) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics.
(BoolOpt) Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option.
This will be enabled by default in future.
remove_unused_resized_minimum_age_ seconds
= 3600
rescue_image_id
= None
(IntOpt) Unused resized base images younger than this will not be removed
(StrOpt) Rescue ami image. This will not be used if an image id is provided by the user.
(StrOpt) Rescue aki image
rescue_kernel_id
= None
rescue_ramdisk_id
= None
rng_dev_path
= None
(StrOpt) Rescue ari image
(StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng
307
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value snapshot_compression
= False
snapshot_image_format snapshots_directory
$instances_path/snapshots
= zero
=
= None
sparse_logical_volumes sysinfo_serial uid_maps
=
use_usb_tablet use_virtio_for_bridges virt_type
= kvm
volume_clear
= auto
= True
volume_clear_size
= 0
= False
= True
wait_soft_reboot_seconds
= 120
Description
(BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images
(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image
(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service
(BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True.
(StrOpt) The data source used to the populate the host "serial" UUID exposed to guest in the virtual
BIOS. Permitted options are "hardware", "os",
"none" or "auto" (default).
(ListOpt) List of uid targets and ranges. Syntax is
guest-uid:host-uid:count
. Maximum of 5 allowed.
(BoolOpt) Sync virtual and real mouse cursors (Not applicable to Red Hat Enterprise Linux VMs)
(BoolOpt) Use virtio for bridge interfaces with
KVM/QEMU
(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen and parallels)
(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred)
(IntOpt) Size in MiB to wipe at start of old volumes.
0 => all
(IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. Fall back to hard reboot if instance does not shut down within this window.
308
Table 3.36. Description of live migration configuration options
Description Configuration option = Default value
[DEFAULT]
Configuration option = Default value live_migration_retry_count
= 30
[libvirt] live_migration_bandwidth
= 0
live_migration_flag
=
VIR_MIGRATE_UNDEFINE_SOURCE,
VIR_MIGRATE_PEER2PEER,
VIR_MIGRATE_LIVE,
VIR_MIGRATE_TUNNELLED
live_migration_uri
=
qemu+tcp://%s/system
CHAPTER 3. COMPUTE
Description
(IntOpt) Number of 1 second retries needed in live_migration
(IntOpt) Maximum bandwidth to be used during migration, in Mbps
(StrOpt) Migration flags to be set for live migration
(StrOpt) Migration target URI (any included "%s" is replaced with the migration target hostname)
Table 3.37. Description of logging configuration options
Configuration option = Default value
[DEFAULT]
Description debug
= False
default_log_levels
= 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
(ListOpt) List of logger=LEVEL pairs.
fatal_deprecations
= False
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
fatal_exception_format_errors
False
instance_format
=
= "[instance: %(uuid)s] "
instance_uuid_format
(uuid)s] "
= "[instance: %
(BoolOpt) Enables or disables fatal status of deprecations.
(BoolOpt) Make exception message format errors fatal
(StrOpt) The format for an instance that is passed with the log message.
(StrOpt) The format for an instance UUID that is passed with the log message.
309
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value log_config_append
= None
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None
log_file
= None
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None
log_config_append
= None
Description
(StrOpt) 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.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Use logging_context_format_string and logging_default_format_string instead.
(StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None
log_file
= None
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
logging_context_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
(StrOpt) Data to append to log format when level is
DEBUG.
310
CHAPTER 3. COMPUTE
Configuration option = Default value logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
Description
(StrOpt) Format string to use for log messages without context.
(StrOpt) Prefix each line of exception output with this format.
syslog_log_facility
= LOG_USER
syslog_log_facility
= LOG_USER
use_syslog
= False
use_syslog_rfc_format use_stderr use_syslog
= True
= False
use_syslog_rfc_format verbose
= False
= False
= False
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Log output to standard error.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 3.38. Description of metadata configuration options
Description Configuration option = Default value
[DEFAULT]
311
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value metadata_cache_expiration
= 15
metadata_host
= $my_ip
metadata_listen
= 0.0.0.0
metadata_listen_port
= 8775
Description
(IntOpt) Time in seconds to cache metadata; 0 to disable metadata caching entirely (not recommended). Increasingthis should improve response times of the metadata API when under heavy load. Higher values may increase memoryusage and result in longer times for host metadata changes to take effect.
(StrOpt) The IP address for the metadata API server
(StrOpt) The IP address on which the metadata API will listen.
(IntOpt) The port on which the metadata API will listen.
(StrOpt) OpenStack metadata service manager
metadata_manager
=
nova.api.manager.MetadataManager
metadata_port
= 8775
metadata_workers
= None
vendordata_driver
=
nova.api.metadata.vendordata_json.JsonFileVend
orData
vendordata_jsonfile_path
= None
(IntOpt) The port for the metadata API port
(IntOpt) Number of workers for metadata service.
The default will be the number of CPUs available.
(StrOpt) Driver to use for vendor data
(StrOpt) File to load JSON formatted vendor data from
312
Table 3.39. Description of network configuration options
Configuration option = Default value
[DEFAULT] allow_same_net_traffic
= True
Description auto_assign_floating_ip cnt_vpn_clients
= 0
= False
(BoolOpt) Whether to allow network traffic from same network
(BoolOpt) Autoassigning floating IP to VM
(IntOpt) Number of addresses reserved for vpn clients
create_unique_mac_address_attempts
= 5
(IntOpt) Number of attempts to create unique mac address
CHAPTER 3. COMPUTE
Configuration option = Default value default_access_ip_network_name
=
None
default_floating_pool
= nova
defer_iptables_apply
= False
dhcp_domain
= novalocal
dhcp_lease_time
= 86400
dhcpbridge
= $bindir/nova-dhcpbridge
dhcpbridge_flagfile
= ['/etc/nova/nova-
dhcpbridge.conf']
dns_server
= []
Description
(StrOpt) Name of network to use to set access IPs for instances
(StrOpt) Default pool for floating IPs
(BoolOpt) Whether to batch up the application of
IPTables rules during a host restart and apply all at the end of the init phase
(StrOpt) Domain to use for building the hostnames
(IntOpt) Lifetime of a DHCP lease in seconds
(StrOpt) Location of nova-dhcpbridge
(MultiStrOpt) Location of flagfiles for dhcpbridge
dns_update_periodic_interval dnsmasq_config_file ebtables_exec_attempts ebtables_retry_interval firewall_driver flat_injected flat_interface
= None
= False
= None
flat_network_bridge flat_network_dns
=
= 3
= None
= 8.8.4.4
= 1.0
= -1
fixed_ip_disassociate_timeout
= 600
(MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times.
(IntOpt) Number of seconds to wait between runs of updates to DNS entries.
(StrOpt) Override the default dnsmasq settings with this file
(IntOpt) Number of times to retry ebtables commands on failure.
(FloatOpt) Number of seconds to wait between ebtables retries.
(StrOpt) Firewall driver (defaults to hypervisor specific iptables driver)
(IntOpt) Seconds after which a deallocated IP is disassociated
(BoolOpt) Whether to attempt to inject network setup into guest
(StrOpt) FlatDhcp will bridge into this interface if set
(StrOpt) Bridge for simple network instances
(StrOpt) DNS server for simple network
313
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value floating_ip_dns_manager
=
nova.network.noop_dns_driver.NoopDNSDriver
force_dhcp_release
= True
force_snat_range
= []
forward_bridge_interface
= ['all']
Description
(StrOpt) Full class name for the DNS Manager for floating IPs
(BoolOpt) If True, send a dhcp release on instance termination
(MultiStrOpt) Traffic to this range will always be snatted to the fallback ip, even if it would normally be bridged out of the node. Can be specified multiple times.
(MultiStrOpt) An interface that bridges can forward to. If this is set to all then all traffic will be forwarded. Can be specified multiple times.
(StrOpt) Default IPv4 gateway
(StrOpt) Template file for injected network
gateway
= None
injected_network_template
=
$pybasedir/nova/virt/interfaces.template
instance_dns_domain
=
instance_dns_manager iptables_drop_action
=
nova.network.noop_dns_driver.NoopDNSDriver
iptables_bottom_regex
=
= DROP
(StrOpt) Full class name for the DNS Zone for instance IPs
(StrOpt) Full class name for the DNS Manager for instance IPs
(StrOpt) Regular expression to match the iptables rule that should always be on the bottom.
(StrOpt) The table that iptables to jump to when a packet is to be dropped.
iptables_top_regex
= (StrOpt) Regular expression to match the iptables rule that should always be on the top.
l3_lib
= nova.network.l3.LinuxNetL3
linuxnet_interface_driver
=
nova.network.linux_net.LinuxBridgeInterfaceDriver
linuxnet_ovs_integration_bridge
=
br-int
(StrOpt) Indicates underlying L3 management library
(StrOpt) Driver used to create ethernet devices.
(StrOpt) Name of Open vSwitch bridge used with linuxnet
multi_host
= False
network_allocate_retries
= 0
(BoolOpt) Default value for multi_host in networks.
Also, if set, some rpc network calls will be sent directly to host.
(IntOpt) Number of times to retry network allocation on failures
314
CHAPTER 3. COMPUTE
Configuration option = Default value network_api_class
= nova.network.api.API
network_device_mtu network_driver network_size
= nova.network.linux_net
network_manager
=
nova.network.manager.VlanManager
= 256
network_topic networks_path num_networks
= network
= $state_path/networks
= 1
ovs_vsctl_timeout public_interface
= 120
= eth0
routing_source_ip
= $my_ip
security_group_api
= nova
send_arp_for_ha
= None
= False
send_arp_for_ha_count share_dhcp_address
= 3
= False
teardown_unused_network_gateway
False
=
Description
(StrOpt) The full class name of the network API class to use
(IntOpt) DEPRECATED: THIS VALUE SHOULD
BE SET WHEN CREATING THE NETWORK. MTU setting for network interface.
(StrOpt) Driver to use for network creation
(StrOpt) Full class name for the Manager for network
(IntOpt) Number of addresses in each private subnet
(StrOpt) The topic network nodes listen on
(StrOpt) Location to keep network config files
(IntOpt) Number of networks to support
(IntOpt) Amount of time, in seconds, that ovs_vsctl should wait for a response from the database. 0 is to wait forever.
(StrOpt) Interface for public IP addresses
(StrOpt) Public IP of network host
(StrOpt) The full class name of the security API class
(BoolOpt) Send gratuitous ARPs for HA setup
(IntOpt) Send this many gratuitous ARPs for HA setup
(BoolOpt) DEPRECATED: THIS VALUE SHOULD
BE SET WHEN CREATING THE NETWORK. If
True in multi_host mode, all compute hosts share the same dhcp address. The same IP address used for DHCP will be added on each nova-network node which is only visible to the vms on the same host.
(BoolOpt) If True, unused gateway devices (VLAN and bridge) are deleted in VLAN network mode with multi hosted networks
315
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value update_dns_entries
= False
use_network_dns_servers use_neutron_default_nets use_single_default_gateway vlan_interface vlan_start
[vmware]
= 100
= None
vlan_interface
= vmnic0
= False
= False
= False
Description
(BoolOpt) If True, when a DNS entry must be updated, it sends a fanout cast to all network hosts to update their DNS entries in multi host mode
(BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers.
(StrOpt) Control for checking for default networks
(BoolOpt) Use single default gateway. Only first nic of vm will get default gateway from dhcp server
(StrOpt) VLANs will bridge into this interface if set
(IntOpt) First VLAN for private networks
(StrOpt) Physical ethernet adapter name for vlan networking
Table 3.40. Description of neutron configuration options
Configuration option = Default value
[DEFAULT] neutron_default_tenant_id
= default
Description
(StrOpt) Default tenant id when creating neutron networks
[neutron] admin_auth_url
= http://localhost:5000/v2.0
admin_password
= None
admin_tenant_id
= None
(StrOpt) Authorization URL for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead.
(StrOpt) Password for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead.
(StrOpt) Tenant id for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead.
316
Configuration option = Default value admin_tenant_name
= None
admin_user_id
= None
admin_username
= None
allow_duplicate_networks
= False
auth_plugin auth_section auth_strategy cafile
= None
= None
= None
certfile
= None
= keystone
extension_sync_interval
= 600
insecure
= False
keyfile
= None
metadata_proxy_shared_secret
=
CHAPTER 3. COMPUTE
Description
(StrOpt) Tenant name for connecting to neutron in admin context. This option will be ignored if neutron_admin_tenant_id is set. Note that with
Keystone V3 tenant names are only unique within a domain. DEPRECATED: specify an auth_plugin and appropriate credentials instead.
(StrOpt) User id for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead.
(StrOpt) Username for connecting to neutron in admin context DEPRECATED: specify an auth_plugin and appropriate credentials instead.
(BoolOpt) DEPRECATED: Allow an instance to have multiple vNICs attached to the same Neutron network. This option is deprecated in the 2015.1
release and will be removed in the 2015.2 release where the default behavior will be to always allow multiple ports from the same network to be attached to an instance.
(StrOpt) Name of the plugin to load
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Authorization strategy for connecting to neutron in admin context. DEPRECATED: specify an auth_plugin and appropriate credentials instead.
If an auth_plugin is specified strategy will be ignored.
(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
(StrOpt) PEM encoded client certificate cert file
(IntOpt) Number of seconds before querying neutron for extensions
(BoolOpt) Verify HTTPS connections.
(StrOpt) PEM encoded client certificate key file
(StrOpt) Shared secret to validate proxies Neutron metadata requests
317
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value ovs_bridge
= br-int
region_name service_metadata_proxy timeout url
= None
= None
= http://127.0.0.1:9696
= False
Description
(StrOpt) Name of Integration Bridge used by Open vSwitch
(StrOpt) Region name for connecting to neutron in admin context
(BoolOpt) Set flag to indicate Neutron will proxy metadata requests and resolve instance ids.
(IntOpt) Timeout value for http requests
(StrOpt) URL for connecting to neutron
Table 3.41. Description of oslo_middleware configuration options
Description Configuration option = Default value
[oslo_middleware] max_request_body_size
= 114688 (IntOpt) The maximum body size for each request, in bytes.
Table 3.42. Description of PCI configuration options
Description Configuration option = Default value
[DEFAULT] pci_alias
= []
pci_passthrough_whitelist
= []
(MultiStrOpt) An alias for a PCI passthrough device requirement. This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements. For example: pci_alias = { "name": "QuicAssist",
"product_id": "0443", "vendor_id": "8086",
"device_type": "ACCEL" } defines an alias for the
Intel QuickAssist card. (multi valued)
(MultiStrOpt) White list of PCI devices available to
VMs. For example: pci_passthrough_whitelist =
[{"vendor_id": "8086", "product_id": "0443"}]
Table 3.43. Description of periodic configuration options
318
CHAPTER 3. COMPUTE
Configuration option = Default value
[DEFAULT] periodic_enable
= True
periodic_fuzzy_delay
= 60
run_external_periodic_tasks
= True
Description
(BoolOpt) Enable periodic tasks
(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
(BoolOpt) Some periodic tasks can be run in a separate process. Should they run here?
Table 3.44. Description of policy configuration options
Configuration option = Default value
[DEFAULT] allow_instance_snapshots allow_migrate_to_same_host allow_resize_to_same_host max_age
= 0
= True
= False
= False
Description
(BoolOpt) Permit instance snapshot operations.
(BoolOpt) Allow migrate machine to the same host.
Useful when testing in single-host environments.
(BoolOpt) Allow destination machine to match source for resize. Useful when testing in singlehost environments.
(IntOpt) Number of seconds between subsequent usage refreshes. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues. Note that quotas are not updated on a periodic task, they will update on a new reservation if max_age has passed since the last reservation
max_local_block_devices
= 3 (IntOpt) Maximum number of devices that will result in a local image being created on the hypervisor node. Setting this to 0 means nova will allow only boot from volume. A negative number means unlimited.
osapi_compute_unique_server_name_s cope
=
(StrOpt) When set, compute API will consider duplicate hostnames invalid within the specified scope, regardless of case. Should be empty,
"project" or "global".
osapi_max_limit
= 1000 (IntOpt) The maximum number of items returned in a single response from a collection resource
319
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value password_length
= 12
policy_default_rule policy_dirs policy_file
= default
= ['policy.d']
= policy.json
reservation_expire until_refresh
= 0
= 86400
resize_fs_using_block_device
= False
Description
(IntOpt) Length of generated instance admin passwords
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
(IntOpt) Number of seconds until a reservation expires
(BoolOpt) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init.
Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw).
(IntOpt) Count of reservations until usage is refreshed. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues.
Table 3.45. Description of Quobyte USP volume driver configuration options
Description Configuration option = Default value
[libvirt] quobyte_client_cfg
= None
quobyte_mount_point_base
=
$state_path/mnt
(StrOpt) Path to a Quobyte Client configuration file.
(StrOpt) Directory where the Quobyte volume is mounted on the compute node
Table 3.46. Description of quota configuration options
320
CHAPTER 3. COMPUTE
Configuration option = Default value
[DEFAULT] bandwidth_poll_interval
= 600
Description enable_network_quota quota_cores quota_fixed_ips quota_floating_ips
= 10
quota_injected_file_content_bytes
= 10240
quota_injected_file_path_length
=
255
quota_injected_files
= 5
quota_instances
= 10
quota_key_pairs
= 100
quota_metadata_items
= 128
quota_networks quota_ram
= 20
quota_driver
= False
= nova.quota.DbQuotaDriver
= 51200
= -1
= 3
quota_security_group_rules quota_security_groups quota_server_groups
= 10
quota_server_group_members
= 10
= 20
= 10
(IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to -1 to disable. Setting this to 0 will run at the default rate.
(BoolOpt) Enables or disables quota checking for tenant networks
(IntOpt) Number of instance cores allowed per project
(StrOpt) Default driver to use for quota checks
(IntOpt) Number of fixed IPs allowed per project
(this should be at least the number of instances allowed)
(IntOpt) Number of floating IPs allowed per project
(IntOpt) Number of bytes allowed per injected file
(IntOpt) Length of injected file path
(IntOpt) Number of injected files allowed
(IntOpt) Number of instances allowed per project
(IntOpt) Number of key pairs per user
(IntOpt) Number of metadata items allowed per instance
(IntOpt) Number of private networks allowed per project
(IntOpt) Megabytes of instance RAM allowed per project
(IntOpt) Number of security rules per security group
(IntOpt) Number of security groups per project
(IntOpt) Number of servers per server group
(IntOpt) Number of server groups per project
321
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[cells] bandwidth_update_interval
= 600 (IntOpt) Seconds between bandwidth updates for cells.
Table 3.47. Description of RDP configuration options
Description Configuration option = Default value
[rdp] enabled
= False
html5_proxy_base_url
=
http://127.0.0.1:6083/
(BoolOpt) Enable RDP related features
(StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/"
Table 3.48. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
Table 3.49. Description of S3 configuration options
Description Configuration option = Default value
[DEFAULT] buckets_path
= $state_path/buckets
image_decryption_dir
= /tmp
(StrOpt) Path to S3 buckets
(StrOpt) Parent directory for tempdir used for image decryption
322
Configuration option = Default value s3_access_key
= notchecked
s3_affix_tenant
= False
s3_host
= $my_ip
s3_listen
= 0.0.0.0
s3_listen_port
= 3333
s3_port
= 3333
s3_secret_key
= notchecked
s3_use_ssl
= False
Table 3.50. Description of scheduler configuration options
CHAPTER 3. COMPUTE
Description
(StrOpt) Access key to use for S3 server for images
(BoolOpt) Whether to affix the tenant id to the access key when downloading from S3
(StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api
(StrOpt) IP address for S3 API to listen
(IntOpt) Port for S3 API to listen
(IntOpt) Port used when accessing the S3 api
(StrOpt) Secret key to use for S3 server for images
(BoolOpt) Whether to use SSL when talking to S3
Configuration option = Default value
[DEFAULT]
Description aggregate_image_properties_isolati on_namespace
= None
(StrOpt) Force the filter to consider only keys matching the given namespace.
aggregate_image_properties_isolati on_separator
= .
(StrOpt) The separator used between the namespace and keys
baremetal_scheduler_default_filter s
= RetryFilter, AvailabilityZoneFilter,
ComputeFilter, ComputeCapabilitiesFilter,
ImagePropertiesFilter, ExactRamFilter,
ExactDiskFilter, ExactCoreFilter
(ListOpt) Which filter class names to use for filtering baremetal hosts when not specified in the request.
cpu_allocation_ratio
= 16.0
disk_allocation_ratio
= 1.0
(FloatOpt) Virtual CPU to physical CPU allocation ratio which affects all CPU filters. This configuration specifies a global ratio for CoreFilter. For
AggregateCoreFilter, it will fall back to this configuration value if no per-aggregate setting found.
(FloatOpt) Virtual disk to physical disk allocation ratio
323
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value io_ops_weight_multiplier
= -1.0
isolated_hosts
=
isolated_images
=
max_instances_per_host max_io_ops_per_host
= 8
ram_allocation_ratio
= 50
= 1.5
ram_weight_multiplier reserved_host_disk_mb
= 1.0
= 0
reserved_host_memory_mb
= 512
Description
(FloatOpt) Multiplier used for weighing host io ops.
Negative numbers mean a preference to choose light workload compute hosts.
(ListOpt) Host reserved for specific images
(ListOpt) Images to run on isolated host
(IntOpt) Ignore hosts that have too many instances
(IntOpt) Tells filters to ignore hosts that have this many or more instances currently in build, resize, snapshot, migrate, rescue or unshelve task states
(FloatOpt) Virtual ram to physical ram allocation ratio which affects all ram filters. This configuration specifies a global ratio for RamFilter. For
AggregateRamFilter, it will fall back to this configuration value if no per-aggregate setting found.
(FloatOpt) Multiplier used for weighing ram.
Negative numbers mean to stack vs spread.
(IntOpt) Amount of disk in MB to reserve for the host
(IntOpt) Amount of memory in MB to reserve for the host
restrict_isolated_hosts_to_isolate d_images
= True
(BoolOpt) Whether to force isolated hosts to run only isolated images
scheduler_available_filters
=
['nova.scheduler.filters.all_filters']
(MultiStrOpt) Filter classes available to the scheduler which may be specified more than once.
An entry of "nova.scheduler.filters.all_filters" maps to all filters included with nova.
scheduler_default_filters
= RetryFilter,
AvailabilityZoneFilter, RamFilter, ComputeFilter,
ComputeCapabilitiesFilter, ImagePropertiesFilter,
ServerGroupAntiAffinityFilter,
ServerGroupAffinityFilter
(ListOpt) Which filter class names to use for filtering hosts when not specified in the request.
scheduler_driver
=
nova.scheduler.filter_scheduler.FilterScheduler
(StrOpt) Default driver to use for the scheduler
324
CHAPTER 3. COMPUTE
Configuration option = Default value scheduler_driver_task_period
= 60
scheduler_host_manager
=
nova.scheduler.host_manager.HostManager
scheduler_host_subset_size
= 1
scheduler_instance_sync_interval
=
120
scheduler_json_config_location scheduler_manager
nova.scheduler.manager.SchedulerManager
scheduler_max_attempts scheduler_topic
= True
=
= 3
= scheduler
=
scheduler_tracks_instance_changes scheduler_use_baremetal_filters
=
False
scheduler_weight_classes
=
nova.scheduler.weights.all_weighers
[cells] ram_weight_multiplier
= 10.0
Description
(IntOpt) How often (in seconds) to run periodic tasks in the scheduler driver of your choice. Note this is likely to interact with the value of service_down_time, but exactly how they interact will depend on your choice of scheduler driver.
(StrOpt) The scheduler host manager class to use
(IntOpt) New instances will be scheduled on a host chosen randomly from a subset of the N best hosts. This property defines the subset size that a host is chosen from. A value of 1 chooses the first host returned by the weighing functions. This value must be at least 1. Any value less than 1 will be ignored, and 1 will be used instead
(IntOpt) Waiting time interval (seconds) between sending the scheduler a list of current instance
UUIDs to verify that its view of instances is in sync with nova. If the CONF option
`scheduler_tracks_instance_changes` is False, changing this option will have no effect.
(StrOpt) Absolute path to scheduler configuration
JSON file.
(StrOpt) Full class name for the Manager for scheduler
(IntOpt) Maximum number of attempts to schedule an instance
(StrOpt) The topic scheduler nodes listen on
(BoolOpt) Determines if the Scheduler tracks changes to instances to help with its filtering decisions.
(BoolOpt) Flag to decide whether to use baremetal_scheduler_default_filters or not.
(ListOpt) Which weight class names to use for weighing hosts
(FloatOpt) Multiplier used for weighing ram.
Negative numbers mean to stack vs spread.
325
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value scheduler_filter_classes
=
nova.cells.filters.all_filters
scheduler_retries
= 10
scheduler_retry_delay
= 2
scheduler_weight_classes
nova.cells.weights.all_weighers
=
Description
(ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova.
(IntOpt) How many retries when no cells are available.
(IntOpt) How often to retry in seconds when no cells are available.
(ListOpt) Weigher classes the cells scheduler should use. An entry of
"nova.cells.weights.all_weighers" maps to all cell weighers included with nova.
[metrics] required
= True
weight_multiplier weight_setting
=
= 1.0
weight_of_unavailable
= -10000.0
(BoolOpt) How to treat the unavailable metrics.
When a metric is NOT available for a host, if it is set to be True, it would raise an exception, so it is recommended to use the scheduler filter
MetricFilter to filter out those hosts. If it is set to be
False, the unavailable metric would be treated as a negative factor in weighing process, the returned value would be set by the option weight_of_unavailable.
(FloatOpt) Multiplier used for weighing metrics.
(FloatOpt) The final weight value to be returned if required is set to False and any one of the metrics set by weight_setting is unavailable.
(ListOpt) How the metrics are going to be weighed.
This should be in the form of "<name1>=<ratio1>,
<name2>=<ratio2>, ...", where <nameX> is one of the metrics to be weighed, and <ratioX> is the corresponding ratio. So for "name1=1.0, name2=-
1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0.
Table 3.51. Description of serial console configuration options
Description Configuration option = Default value
[serial_console] base_url
= ws://127.0.0.1:6083/ (StrOpt) Location of serial console proxy.
326
Configuration option = Default value enabled
= False
listen
= 127.0.0.1
port_range
= 10000:20000
proxyclient_address
= 127.0.0.1
serialproxy_host
= 0.0.0.0
serialproxy_port
= 6083
CHAPTER 3. COMPUTE
Description
(BoolOpt) Enable serial console related features
(StrOpt) IP address on which instance serial console should listen
(StrOpt) Range of TCP ports to use for serial ports on compute hosts
(StrOpt) The address to which proxy clients (like nova-serialproxy) should connect
(StrOpt) Host on which to listen for incoming requests
(IntOpt) Port on which to listen for incoming requests
Table 3.52. Description of SPICE configuration options
Configuration option = Default value
[spice] agent_enabled enabled
= False
= True
html5proxy_base_url
=
http://127.0.0.1:6082/spice_auto.html
html5proxy_host html5proxy_port
= 0.0.0.0
= 6082
Description
(BoolOpt) Enable spice guest agent support
(BoolOpt) Enable spice related features
(StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html"
(StrOpt) Host on which to listen for incoming requests
(IntOpt) Port on which to listen for incoming requests
keymap
= en-us
server_listen
= 127.0.0.1
(StrOpt) Keymap for spice
(StrOpt) IP address on which instance spice server should listen
server_proxyclient_address
= 127.0.0.1 (StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect
Table 3.53. Description of testing configuration options
327
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[DEFAULT] fake_call
= False
Description fake_network
= False
(BoolOpt) If True, skip using the queue and make local calls
(BoolOpt) If passed, use fake network devices and addresses
monkey_patch
= False (BoolOpt) Whether to log monkey patching
monkey_patch_modules
=
nova.api.ec2.cloud:nova.notifications.notify_decora
tor, nova.compute.api:nova.notifications.notify_decorat
or
(ListOpt) List of modules/decorators to monkey patch
Table 3.54. Description of trusted computing configuration options
Description Configuration option = Default value
[trusted_computing] attestation_api_url
=
/OpenAttestationWebServices/V1.0
attestation_auth_blob
= None
attestation_auth_timeout
= 60
attestation_insecure_ssl
= False
attestation_port
= 8443
attestation_server
= None
attestation_server_ca_file
= None
(StrOpt) Attestation web API URL
(StrOpt) Attestation authorization blob - must change
(IntOpt) Attestation status cache valid period length
(BoolOpt) Disable SSL cert verification for
Attestation service
(StrOpt) Attestation server port
(StrOpt) Attestation server HTTP
(StrOpt) Attestation server Cert file for Identity verification
Table 3.55. Description of upgrade levels configuration options
Description Configuration option = Default value
[cells]
328
CHAPTER 3. COMPUTE
Configuration option = Default value scheduler
=
nova.cells.scheduler.CellsScheduler
[upgrade_levels] cells
= None
cert
= None
compute
= None
conductor console intercell network
= None
= None
consoleauth
= None
= None
= None
scheduler
= None
Description
(StrOpt) Cells scheduler to use
(StrOpt) Set a version cap for messages sent to local cells services
(StrOpt) Set a version cap for messages sent to cert services
(StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from havana to icehouse, you should set this option to "icehouse-compat" before beginning the live upgrade procedure.
(StrOpt) Set a version cap for messages sent to conductor services
(StrOpt) Set a version cap for messages sent to console services
(StrOpt) Set a version cap for messages sent to consoleauth services
(StrOpt) Set a version cap for messages sent between cells services
(StrOpt) Set a version cap for messages sent to network services
(StrOpt) Set a version cap for messages sent to scheduler services
Table 3.56. Description of VMware configuration options
Description Configuration option = Default value
[vmware] api_retry_count
= 10 (IntOpt) The number of times to retry on failures, e.g., socket error, etc.
329
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value cache_prefix
= None
cluster_name datastore_regex host_ip
= None
host_password host_port pbm_enabled
= None
= 443
host_username
= None
= None
= None
integration_bridge maximum_objects
= 100
pbm_default_policy
= False
pbm_wsdl_location
= None
task_poll_interval use_linked_clone
= br-int
= None
= 0.5
= True
Description
(StrOpt) The prefix for Where cached images are stored. This is NOT the full path - only a folder prefix. This should only be used when a datastore cache should be shared between compute nodes.
Note: this should only be used when the compute nodes have a shared file system.
(MultiStrOpt) Name of a VMware Cluster
ComputeResource.
(StrOpt) Regex to match the name of a datastore.
(StrOpt) Hostname or IP address for connection to
VMware VC host.
(StrOpt) Password for connection to VMware VC host.
(IntOpt) Port for connection to VMware VC host.
(StrOpt) Username for connection to VMware VC host.
(StrOpt) Name of Integration Bridge
(IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests.
(StrOpt) The PBM default policy. If pbm_wsdl_location is set and there is no defined storage policy for the specific request then this policy will be used.
(BoolOpt) The PBM status.
(StrOpt) PBM service WSDL file location URL. e.g.
file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this will disable storage policy based placement of instances.
(FloatOpt) The interval used for polling of remote tasks.
(BoolOpt) Whether to use linked clone
330
Configuration option = Default value wsdl_location
= None
CHAPTER 3. COMPUTE
Description
(StrOpt) Optional VIM Service WSDL Location e.g
http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds
Table 3.57. Description of VNC configuration options
Description Configuration option = Default value
[DEFAULT] daemon
= False
key
= None
novncproxy_base_url
=
http://127.0.0.1:6080/vnc_auto.html
novncproxy_host novncproxy_port record
= False
source_is_ipv6 ssl_only
= False
vnc_keymap
= 0.0.0.0
= 6080
= False
vnc_enabled
= True
= en-us
vncserver_listen
= 127.0.0.1
vncserver_proxyclient_address
127.0.0.1
web
= /usr/share/spice-html5
=
(BoolOpt) Become a daemon (background process)
(StrOpt) SSL key file (if separate from cert)
(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html"
(StrOpt) Host on which to listen for incoming requests
(IntOpt) Port on which to listen for incoming requests
(BoolOpt) Record sessions to FILE.
[session_number]
(BoolOpt) Source is ipv6
(BoolOpt) Disallow non-encrypted connections
(BoolOpt) Enable VNC related features
(StrOpt) Keymap for VNC
(StrOpt) IP address on which instance vncservers should listen
(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect
(StrOpt) Run webserver on same port. Serve files from DIR.
[vmware] vnc_port
= 5900 (IntOpt) VNC starting port
331
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value vnc_port_total
= 10000
Description
(IntOpt) Total number of VNC ports
Table 3.58. Description of volumes configuration options
Configuration option = Default value
[DEFAULT] block_device_allocate_retries
= 60
Description
(IntOpt) Number of times to retry block device allocation on failures
block_device_allocate_retries_inte rval
= 3
(IntOpt) Waiting time interval (seconds) between block device allocation retries on failures
my_block_storage_ip
= $my_ip (StrOpt) Block storage IP address of this host
volume_api_class
= nova.volume.cinder.API (StrOpt) The full class name of the volume API class to use
volume_usage_poll_interval
= 0 (IntOpt) Interval in seconds for gathering volume usages
[cinder] cafile
= None (StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
catalog_info
= volumev2:cinderv2:publicURL (StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:
<endpoint_type>
certfile
= None
cross_az_attach
= True
endpoint_template http_retries insecure keyfile
= 3
= False
= None
= None
(StrOpt) PEM encoded client certificate cert file
(BoolOpt) Allow attach between instance and volume in different availability zones.
(StrOpt) Override service catalog lookup with template for cinder endpoint e.g.
http://localhost:8776/v1/%(project_id)s
(IntOpt) Number of cinderclient retries on failed http calls
(BoolOpt) Verify HTTPS connections.
(StrOpt) PEM encoded client certificate key file
332
CHAPTER 3. COMPUTE
Configuration option = Default value os_region_name
= None
timeout
= None
[hyperv] force_volumeutils_v1
= False
volume_attach_retry_count
= 10
Description
(StrOpt) Region name of this node
(IntOpt) Timeout value for http requests
volume_attach_retry_interval
= 5
(BoolOpt) Force V1 volume utility class
(IntOpt) The number of times to retry to attach a volume
(IntOpt) Interval between volume attachment attempts, in seconds
[libvirt] glusterfs_mount_point_base
=
$state_path/mnt
nfs_mount_options
= None
nfs_mount_point_base
= $state_path/mnt
num_aoe_discover_tries num_iscsi_scan_tries num_iser_scan_tries scality_sofs_config
= 5
= 5
= 3
qemu_allowed_storage_drivers rbd_secret_uuid rbd_user
= None
= None
= None
scality_sofs_mount_point
$state_path/scality
=
=
(StrOpt) Directory where the glusterfs volume is mounted on the compute node
(StrOpt) Mount options passed to the NFS client.
See section of the nfs man page for details
(StrOpt) Directory where the NFS volume is mounted on the compute node
(IntOpt) Number of times to rediscover AoE target to find volume
(IntOpt) Number of times to rescan iSCSI target to find volume
(IntOpt) Number of times to rescan iSER target to find volume
(ListOpt) Protocols listed here will be accessed directly from QEMU. Currently supported protocols:
[gluster]
(StrOpt) The libvirt UUID of the secret for the rbd_uservolumes
(StrOpt) The RADOS client name for accessing rbd volumes
(StrOpt) Path or URL to Scality SOFS configuration file
(StrOpt) Base dir where Scality SOFS shall be mounted
333
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value smbfs_mount_options
=
smbfs_mount_point_base
=
$state_path/mnt
[xenserver] block_device_creation_timeout
= 10
Description
(StrOpt) Mount options passed to the SMBFS client. See mount.cifs man page for details. Note that the libvirt-qemu uid and gid must be specified.
(StrOpt) Directory where the SMBFS shares are mounted on the compute node
(IntOpt) Time to wait for a block device to be created
Table 3.59. Description of VPN configuration options
Description Configuration option = Default value
[DEFAULT] boot_script_template
=
$pybasedir/nova/cloudpipe/bootscript.template
dmz_cidr
=
dmz_mask
= 255.255.255.0
dmz_net
= 10.0.0.0
vpn_flavor
= m1.tiny
vpn_image_id
= 0
vpn_ip
= $my_ip
vpn_key_suffix vpn_start
= 1000
= -vpn
(StrOpt) Template for cloudpipe instance boot script
(ListOpt) A list of dmz ranges that should be accepted
(StrOpt) Netmask to push into openvpn config
(StrOpt) Network to push into openvpn config
(StrOpt) Flavor for vpn instances
(StrOpt) Image ID used when starting up a cloudpipe vpn server
(StrOpt) Public IP for the cloudpipe VPN servers
(StrOpt) Suffix to add to project name for vpn key and secgroups
(IntOpt) First Vpn port for private networks
Table 3.60. Description of Xen configuration options
Description Configuration option = Default value
[DEFAULT]
334
CHAPTER 3. COMPUTE
Configuration option = Default value console_driver
=
nova.console.xvp.XVPConsoleProxy
console_xvp_conf
= /etc/xvp.conf
console_xvp_conf_template
=
$pybasedir/nova/console/xvp.conf.template
console_xvp_log
= /var/log/xvp.log
console_xvp_multiplex_port
= 5900
Description
(StrOpt) Driver to use for the console proxy
(StrOpt) Generated XVP conf file
(StrOpt) XVP conf template
console_xvp_pid
= /var/run/xvp.pid
stub_compute
= False
[libvirt] xen_hvmloader_path
=
/usr/lib/xen/boot/hvmloader
[xenserver] agent_path
= usr/sbin/xe-update-networking
agent_resetnetwork_timeout agent_timeout cache_images check_host
= 30
agent_version_timeout
= all
= True
= 300
= 60
(StrOpt) XVP log file
(IntOpt) Port for XVP to multiplex VNC connections on
(StrOpt) XVP master process pid file
(BoolOpt) Stub calls to compute worker for tests
(StrOpt) Location where the Xen hvmloader is kept
(StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True
(IntOpt) Number of seconds to wait for agent reply to resetnetwork request
(IntOpt) Number of seconds to wait for agent reply
(IntOpt) Number of seconds to wait for agent to be fully operational
(StrOpt) Cache glance images locally. `all` will cache all images, `some` will only cache images that have the image_property
`cache_in_nova=True`, and `none` turns off caching entirely
(BoolOpt) Ensure compute service is running on host XenAPI connects to.
335
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value connection_concurrent
= 5
connection_password connection_url disable_agent iqn_prefix
= False
= None
= None
connection_username default_os_type
= root
= linux
image_compression_level image_upload_handler ipxe_network_name
=
= None
nova.virt.xenapi.image.glance.GlanceStore
introduce_vdi_retry_wait ipxe_boot_menu_url ipxe_mkisofs_cmd
= None
= mkisofs
= None
= 20
= iqn.2010-10.org.openstack
login_timeout
= 10
max_kernel_ramdisk_size num_vbd_unplug_retries
= 16777216
= 10
Description
(IntOpt) Maximum number of concurrent XenAPI connections. Used only if compute_driver=xenapi.XenAPIDriver
(StrOpt) Password for connection to
XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver
(StrOpt) URL for connection to XenServer/Xen
Cloud Platform. A special value of unix://local can be used to connect to the local unix socket.
Required if compute_driver=xenapi.XenAPIDriver
(StrOpt) Username for connection to
XenServer/Xen Cloud Platform. Used only if compute_driver=xenapi.XenAPIDriver
(StrOpt) Default OS type
(BoolOpt) Disables the use of the XenAPI agent in any image regardless of what image properties are present.
(IntOpt) Compression level for images, e.g., 9 for gzip -9. Range is 1-9, 9 being most compressed but most CPU intensive on dom0.
(StrOpt) Dom0 plugin driver used to handle image uploads.
(IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced
(StrOpt) URL to the iPXE boot menu
(StrOpt) Name and optionally path of the tool used for ISO image creation
(StrOpt) Name of network to use for booting iPXE
ISOs
(StrOpt) IQN Prefix
(IntOpt) Timeout in seconds for XenAPI login.
(IntOpt) Maximum size in bytes of kernel or ramdisk images
(IntOpt) Maximum number of retries to unplug
VBD. if <=0, should try once and no retry
336
CHAPTER 3. COMPUTE
Configuration option = Default value ovs_integration_bridge
= xapi1
remap_vbd_dev
= False
remap_vbd_dev_prefix running_timeout sparse_copy sr_base_path target_host
= None
target_port
= 3260
torrent_base_url
= None
torrent_download_stall_cutoff
= 600
torrent_images
= 60
= True
= sd
= /var/run/sr-mount
sr_matching_filter
= default-sr:true
= none
torrent_listen_port_end
= 6891
torrent_listen_port_start
= 6881
torrent_max_last_accessed
= 86400
Description
(StrOpt) Name of Integration Bridge used by Open vSwitch
(BoolOpt) Used to enable the remapping of VBD dev
(StrOpt) Specify prefix to remap VBD dev to (ex.
/dev/xvdb -> /dev/sdb)
(IntOpt) Number of seconds to wait for instance to go to running state
(BoolOpt) Whether to use sparse_copy for copying data on a resize down (False will use standard dd).
This speeds up resizes down considerably since large runs of zeros will not have to be rsynced
(StrOpt) Base path to the storage repository
(StrOpt) Filter for finding the SR to be used to install guest instances on. To use the Local
Storage in default XenServer/XCP installations set this flag to other-config:i18n-key=local-storage. To select an SR with a different matching criteria, you could set it to other-config:my_favorite_sr=true. On the other hand, to fall back on the Default SR, as displayed by XenCenter, set this flag to: defaultsr:true
(StrOpt) The iSCSI Target Host
(StrOpt) The iSCSI Target Port, default is port 3260
(StrOpt) Base URL for torrent files.
(IntOpt) Number of seconds a download can remain at the same progress percentage w/o being considered a stall
(StrOpt) Whether or not to download images via Bit
Torrent (all|some|none).
(IntOpt) End of port range to listen on
(IntOpt) Beginning of port range to listen on
(IntOpt) Cached torrent files not accessed within this number of seconds can be reaped
337
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description torrent_max_seeder_processes_per_h ost
= 1
(IntOpt) Maximum number of seeder processes to run concurrently within a given dom0. (-1 = no limit)
torrent_seed_chance
= 1.0 (FloatOpt) Probability that peer will become a seeder. (1.0 = 100%)
torrent_seed_duration
= 3600
use_agent_default use_join_force
= True
vhd_coalesce_max_attempts
= 20
vhd_coalesce_poll_interval vif_driver
=
= False
= 5.0
nova.virt.xenapi.vif.XenAPIBridgeDriver
(IntOpt) Number of seconds after downloading an image via BitTorrent that it should be seeded for other peers.
(BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times.
(BoolOpt) To use for hosts with different CPUs
(IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver
(FloatOpt) The interval used for polling of coalescing vhds. Used only if compute_driver=xenapi.XenAPIDriver
(StrOpt) The XenAPI VIF driver using XenServer
Network APIs.
Table 3.61. Description of XCP VNC proxy configuration options
Description Configuration option = Default value
[DEFAULT] xvpvncproxy_base_url
=
http://127.0.0.1:6081/console
xvpvncproxy_host
= 0.0.0.0
xvpvncproxy_port
= 6081
(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console"
(StrOpt) Address that the XCP VNC proxy should bind to
(IntOpt) Port that the XCP VNC proxy should bind to
338
Table 3.62. Description of Zookeeper configuration options
CHAPTER 3. COMPUTE
Configuration option = Default value
[zookeeper] address
= None
recv_timeout
= 4000
sg_prefix
= /servicegroups
sg_retry_interval
= 5
Description
(StrOpt) The ZooKeeper addresses for servicegroup service in the format of host1:port,host2:port,host3:port
(IntOpt) The recv_timeout parameter for the zk session
(StrOpt) The prefix used in ZooKeeper to store ephemeral nodes
(IntOpt) Number of seconds to wait until retrying to join the session
3.17.2. Additional sample configuration files
Files in this section can be found in /etc/nova.
3.17.2.1. api-paste.ini
The Compute service stores its API configuration settings in the api-paste.ini file.
############
# Metadata #
############
[composite:metadata] use = egg:Paste#urlmap
/: meta
[pipeline:meta] pipeline = ec2faultwrap logrequest metaapp
[app:metaapp] paste.app_factory = nova.api.metadata.handler:MetadataRequestHandler.factory
#######
# EC2 #
#######
[composite:ec2] use = egg:Paste#urlmap
/: ec2cloud
[composite:ec2cloud] use = call:nova.api.auth:pipeline_factory noauth = ec2faultwrap logrequest ec2noauth cloudrequest validator ec2executor
339
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
noauth2 = ec2faultwrap logrequest ec2noauth cloudrequest validator ec2executor keystone = ec2faultwrap logrequest ec2keystoneauth cloudrequest validator ec2executor
[filter:ec2faultwrap] paste.filter_factory = nova.api.ec2:FaultWrapper.factory
[filter:logrequest] paste.filter_factory = nova.api.ec2:RequestLogging.factory
[filter:ec2lockout] paste.filter_factory = nova.api.ec2:Lockout.factory
[filter:ec2keystoneauth] paste.filter_factory = nova.api.ec2:EC2KeystoneAuth.factory
[filter:ec2noauth] paste.filter_factory = nova.api.ec2:NoAuth.factory
[filter:cloudrequest] controller = nova.api.ec2.cloud.CloudController
paste.filter_factory = nova.api.ec2:Requestify.factory
[filter:authorizer] paste.filter_factory = nova.api.ec2:Authorizer.factory
[filter:validator] paste.filter_factory = nova.api.ec2:Validator.factory
[app:ec2executor] paste.app_factory = nova.api.ec2:Executor.factory
#############
# OpenStack #
#############
[composite:osapi_compute] use = call:nova.api.openstack.urlmap:urlmap_factory
/: oscomputeversions
/v1.1: openstack_compute_api_v2
/v2: openstack_compute_api_v2
/v2.1: openstack_compute_api_v21
/v3: openstack_compute_api_v3
[composite:openstack_compute_api_v2] use = call:nova.api.auth:pipeline_factory noauth = compute_req_id faultwrap sizelimit noauth ratelimit osapi_compute_app_v2 noauth2 = compute_req_id faultwrap sizelimit noauth2 ratelimit osapi_compute_app_v2 keystone = compute_req_id faultwrap sizelimit authtoken keystonecontext ratelimit osapi_compute_app_v2 keystone_nolimit = compute_req_id faultwrap sizelimit authtoken keystonecontext osapi_compute_app_v2
340
CHAPTER 3. COMPUTE
[composite:openstack_compute_api_v21] use = call:nova.api.auth:pipeline_factory_v21 noauth = compute_req_id faultwrap sizelimit noauth osapi_compute_app_v21 noauth2 = compute_req_id faultwrap sizelimit noauth2 osapi_compute_app_v21 keystone = compute_req_id faultwrap sizelimit authtoken keystonecontext osapi_compute_app_v21
[composite:openstack_compute_api_v3] use = call:nova.api.auth:pipeline_factory_v21 noauth = request_id faultwrap sizelimit noauth_v3 osapi_compute_app_v3 noauth2 = request_id faultwrap sizelimit noauth_v3 osapi_compute_app_v3 keystone = request_id faultwrap sizelimit authtoken keystonecontext osapi_compute_app_v3
[filter:request_id] paste.filter_factory = oslo.middleware:RequestId.factory
[filter:compute_req_id] paste.filter_factory = nova.api.compute_req_id:ComputeReqIdMiddleware.factory
[filter:faultwrap] paste.filter_factory = nova.api.openstack:FaultWrapper.factory
[filter:noauth] paste.filter_factory = nova.api.openstack.auth:NoAuthMiddlewareOld.factory
[filter:noauth2] paste.filter_factory = nova.api.openstack.auth:NoAuthMiddleware.factory
[filter:noauth_v3] paste.filter_factory = nova.api.openstack.auth:NoAuthMiddlewareV3.factory
[filter:ratelimit] paste.filter_factory = nova.api.openstack.compute.limits:RateLimitingMiddleware.factory
[filter:sizelimit] paste.filter_factory = oslo.middleware:RequestBodySizeLimiter.factory
[app:osapi_compute_app_v2] paste.app_factory = nova.api.openstack.compute:APIRouter.factory
[app:osapi_compute_app_v21] paste.app_factory = nova.api.openstack.compute:APIRouterV21.factory
[app:osapi_compute_app_v3] paste.app_factory = nova.api.openstack.compute:APIRouterV3.factory
[pipeline:oscomputeversions] pipeline = faultwrap oscomputeversionapp
[app:oscomputeversionapp] paste.app_factory = nova.api.openstack.compute.versions:Versions.factory
341
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
##########
# Shared #
##########
[filter:keystonecontext] paste.filter_factory = nova.api.auth:NovaKeystoneContext.factory
[filter:authtoken] paste.filter_factory = keystonemiddleware.auth_token:filter_factory
3.17.2.2. policy.json
342
The policy.json file defines additional access controls that apply to the Compute service.
{
"context_is_admin": "role:admin",
"admin_or_owner": "is_admin:True or project_id:%(project_id)s",
"default": "rule:admin_or_owner",
"cells_scheduler_filter:TargetCellFilter": "is_admin:True",
"compute:create": "",
"compute:create:attach_network": "",
"compute:create:attach_volume": "",
"compute:create:forced_host": "is_admin:True",
"compute:get_all": "",
"compute:get_all_tenants": "",
"compute:start": "rule:admin_or_owner",
"compute:stop": "rule:admin_or_owner",
"compute:unlock_override": "rule:admin_api",
"compute:shelve": "",
"compute:shelve_offload": "",
"compute:unshelve": "",
"compute:resize": "",
"compute:confirm_resize": "",
"compute:revert_resize": "",
"compute:rebuild": "",
"compute:reboot": "",
"compute:volume_snapshot_create": "",
"compute:volume_snapshot_delete": "",
"admin_api": "is_admin:True",
"compute_extension:accounts": "rule:admin_api",
"compute_extension:admin_actions": "rule:admin_api",
"compute_extension:admin_actions:pause": "rule:admin_or_owner",
"compute_extension:admin_actions:unpause": "rule:admin_or_owner",
"compute_extension:admin_actions:suspend": "rule:admin_or_owner",
"compute_extension:admin_actions:resume": "rule:admin_or_owner",
"compute_extension:admin_actions:lock": "rule:admin_or_owner",
CHAPTER 3. COMPUTE
"compute_extension:admin_actions:unlock": "rule:admin_or_owner",
"compute_extension:admin_actions:resetNetwork": "rule:admin_api",
"compute_extension:admin_actions:injectNetworkInfo":
"rule:admin_api",
"compute_extension:admin_actions:createBackup":
"rule:admin_or_owner",
"compute_extension:admin_actions:migrateLive": "rule:admin_api",
"compute_extension:admin_actions:resetState": "rule:admin_api",
"compute_extension:admin_actions:migrate": "rule:admin_api",
"compute_extension:aggregates": "rule:admin_api",
"compute_extension:agents": "rule:admin_api",
"compute_extension:attach_interfaces": "",
"compute_extension:baremetal_nodes": "rule:admin_api",
"compute_extension:cells": "rule:admin_api",
"compute_extension:cells:create": "rule:admin_api",
"compute_extension:cells:delete": "rule:admin_api",
"compute_extension:cells:update": "rule:admin_api",
"compute_extension:cells:sync_instances": "rule:admin_api",
"compute_extension:certificates": "",
"compute_extension:cloudpipe": "rule:admin_api",
"compute_extension:cloudpipe_update": "rule:admin_api",
"compute_extension:console_output": "",
"compute_extension:consoles": "",
"compute_extension:createserverext": "",
"compute_extension:deferred_delete": "",
"compute_extension:disk_config": "",
"compute_extension:evacuate": "rule:admin_api",
"compute_extension:extended_server_attributes": "rule:admin_api",
"compute_extension:extended_status": "",
"compute_extension:extended_availability_zone": "",
"compute_extension:extended_ips": "",
"compute_extension:extended_ips_mac": "",
"compute_extension:extended_vif_net": "",
"compute_extension:extended_volumes": "",
"compute_extension:fixed_ips": "rule:admin_api",
"compute_extension:flavor_access": "",
"compute_extension:flavor_access:addTenantAccess": "rule:admin_api",
"compute_extension:flavor_access:removeTenantAccess":
"rule:admin_api",
"compute_extension:flavor_disabled": "",
"compute_extension:flavor_rxtx": "",
"compute_extension:flavor_swap": "",
"compute_extension:flavorextradata": "",
"compute_extension:flavorextraspecs:index": "",
"compute_extension:flavorextraspecs:show": "",
"compute_extension:flavorextraspecs:create": "rule:admin_api",
"compute_extension:flavorextraspecs:update": "rule:admin_api",
"compute_extension:flavorextraspecs:delete": "rule:admin_api",
"compute_extension:flavormanage": "rule:admin_api",
"compute_extension:floating_ip_dns": "",
"compute_extension:floating_ip_pools": "",
"compute_extension:floating_ips": "",
"compute_extension:floating_ips_bulk": "rule:admin_api",
"compute_extension:fping": "",
"compute_extension:fping:all_tenants": "rule:admin_api",
"compute_extension:hide_server_addresses": "is_admin:False",
343
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"compute_extension:hosts": "rule:admin_api",
"compute_extension:hypervisors": "rule:admin_api",
"compute_extension:image_size": "",
"compute_extension:instance_actions": "",
"compute_extension:instance_actions:events": "rule:admin_api",
"compute_extension:instance_usage_audit_log": "rule:admin_api",
"compute_extension:keypairs": "",
"compute_extension:keypairs:index": "",
"compute_extension:keypairs:show": "",
"compute_extension:keypairs:create": "",
"compute_extension:keypairs:delete": "",
"compute_extension:multinic": "",
"compute_extension:networks": "rule:admin_api",
"compute_extension:networks:view": "",
"compute_extension:networks_associate": "rule:admin_api",
"compute_extension:quotas:show": "",
"compute_extension:quotas:update": "rule:admin_api",
"compute_extension:quotas:delete": "rule:admin_api",
"compute_extension:quota_classes": "",
"compute_extension:rescue": "",
"compute_extension:security_group_default_rules": "rule:admin_api",
"compute_extension:security_groups": "",
"compute_extension:server_diagnostics": "rule:admin_api",
"compute_extension:server_groups": "",
"compute_extension:server_password": "",
"compute_extension:server_usage": "",
"compute_extension:services": "rule:admin_api",
"compute_extension:shelve": "",
"compute_extension:shelveOffload": "rule:admin_api",
"compute_extension:simple_tenant_usage:show": "rule:admin_or_owner",
"compute_extension:simple_tenant_usage:list": "rule:admin_api",
"compute_extension:unshelve": "",
"compute_extension:users": "rule:admin_api",
"compute_extension:virtual_interfaces": "",
"compute_extension:virtual_storage_arrays": "",
"compute_extension:volumes": "",
"compute_extension:volume_attachments:index": "",
"compute_extension:volume_attachments:show": "",
"compute_extension:volume_attachments:create": "",
"compute_extension:volume_attachments:update": "",
"compute_extension:volume_attachments:delete": "",
"compute_extension:volumetypes": "",
"compute_extension:availability_zone:list": "",
"compute_extension:availability_zone:detail": "rule:admin_api",
"compute_extension:used_limits_for_admin": "rule:admin_api",
"compute_extension:migrations:index": "rule:admin_api",
"compute_extension:os-assisted-volume-snapshots:create":
"rule:admin_api",
"compute_extension:os-assisted-volume-snapshots:delete":
"rule:admin_api",
"compute_extension:console_auth_tokens": "rule:admin_api",
"compute_extension:os-server-external-events:create":
"rule:admin_api",
"network:get_all": "",
"network:get": "",
344
CHAPTER 3. COMPUTE
"network:create": "",
"network:delete": "",
"network:associate": "",
"network:disassociate": "",
"network:get_vifs_by_instance": "",
"network:allocate_for_instance": "",
"network:deallocate_for_instance": "",
"network:validate_networks": "",
"network:get_instance_uuids_by_ip_filter": "",
"network:get_instance_id_by_floating_address": "",
"network:setup_networks_on_host": "",
"network:get_backdoor_port": "",
"network:get_floating_ip": "",
"network:get_floating_ip_pools": "",
"network:get_floating_ip_by_address": "",
"network:get_floating_ips_by_project": "",
"network:get_floating_ips_by_fixed_address": "",
"network:allocate_floating_ip": "",
"network:associate_floating_ip": "",
"network:disassociate_floating_ip": "",
"network:release_floating_ip": "",
"network:migrate_instance_start": "",
"network:migrate_instance_finish": "",
"network:get_fixed_ip": "",
"network:get_fixed_ip_by_address": "",
"network:add_fixed_ip_to_instance": "",
"network:remove_fixed_ip_from_instance": "",
"network:add_network_to_project": "",
"network:get_instance_nw_info": "",
"network:get_dns_domains": "",
"network:add_dns_entry": "",
"network:modify_dns_entry": "",
"network:delete_dns_entry": "",
"network:get_dns_entries_by_address": "",
"network:get_dns_entries_by_name": "",
"network:create_private_dns_domain": "",
"network:create_public_dns_domain": "",
"network:delete_dns_domain": "",
"network:attach_external_network": "rule:admin_api",
"os_compute_api:servers:start": "rule:admin_or_owner",
"os_compute_api:servers:stop": "rule:admin_or_owner",
"os_compute_api:os-access-ips:discoverable": "",
"os_compute_api:os-access-ips": "",
"os_compute_api:os-admin-actions": "rule:admin_api",
"os_compute_api:os-admin-actions:discoverable": "",
"os_compute_api:os-admin-actions:reset_network": "rule:admin_api",
"os_compute_api:os-admin-actions:inject_network_info":
"rule:admin_api",
"os_compute_api:os-admin-actions:reset_state": "rule:admin_api",
"os_compute_api:os-admin-password": "",
"os_compute_api:os-admin-password:discoverable": "",
"os_compute_api:os-aggregates:discoverable": "",
345
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"os_compute_api:os-aggregates:index": "rule:admin_api",
"os_compute_api:os-aggregates:create": "rule:admin_api",
"os_compute_api:os-aggregates:show": "rule:admin_api",
"os_compute_api:os-aggregates:update": "rule:admin_api",
"os_compute_api:os-aggregates:delete": "rule:admin_api",
"os_compute_api:os-aggregates:add_host": "rule:admin_api",
"os_compute_api:os-aggregates:remove_host": "rule:admin_api",
"os_compute_api:os-aggregates:set_metadata": "rule:admin_api",
"os_compute_api:os-agents": "rule:admin_api",
"os_compute_api:os-agents:discoverable": "",
"os_compute_api:os-attach-interfaces": "",
"os_compute_api:os-attach-interfaces:discoverable": "",
"os_compute_api:os-baremetal-nodes": "rule:admin_api",
"os_compute_api:os-baremetal-nodes:discoverable": "",
"os_compute_api:os-block-device-mapping-v1:discoverable": "",
"os_compute_api:os-cells": "rule:admin_api",
"os_compute_api:os-cells:create": "rule:admin_api",
"os_compute_api:os-cells:delete": "rule:admin_api",
"os_compute_api:os-cells:update": "rule:admin_api",
"os_compute_api:os-cells:sync_instances": "rule:admin_api",
"os_compute_api:os-cells:discoverable": "",
"os_compute_api:os-certificates:create": "",
"os_compute_api:os-certificates:show": "",
"os_compute_api:os-certificates:discoverable": "",
"os_compute_api:os-cloudpipe": "rule:admin_api",
"os_compute_api:os-cloudpipe:discoverable": "",
"os_compute_api:os-consoles:discoverable": "",
"os_compute_api:os-consoles:create": "",
"os_compute_api:os-consoles:delete": "",
"os_compute_api:os-consoles:index": "",
"os_compute_api:os-consoles:show": "",
"os_compute_api:os-console-output:discoverable": "",
"os_compute_api:os-console-output": "",
"os_compute_api:os-remote-consoles": "",
"os_compute_api:os-remote-consoles:discoverable": "",
"os_compute_api:os-create-backup:discoverable": "",
"os_compute_api:os-create-backup": "rule:admin_or_owner",
"os_compute_api:os-deferred-delete": "",
"os_compute_api:os-deferred-delete:discoverable": "",
"os_compute_api:os-disk-config": "",
"os_compute_api:os-disk-config:discoverable": "",
"os_compute_api:os-evacuate": "rule:admin_api",
"os_compute_api:os-evacuate:discoverable": "",
"os_compute_api:os-extended-server-attributes": "rule:admin_api",
"os_compute_api:os-extended-server-attributes:discoverable": "",
"os_compute_api:os-extended-status": "",
"os_compute_api:os-extended-status:discoverable": "",
"os_compute_api:os-extended-availability-zone": "",
"os_compute_api:os-extended-availability-zone:discoverable": "",
"os_compute_api:extension_info:discoverable": "",
"os_compute_api:os-extended-volumes": "",
"os_compute_api:os-extended-volumes:discoverable": "",
"os_compute_api:os-fixed-ips": "rule:admin_api",
"os_compute_api:os-fixed-ips:discoverable": "",
"os_compute_api:os-flavor-access": "",
"os_compute_api:os-flavor-access:discoverable": "",
346
CHAPTER 3. COMPUTE
"os_compute_api:os-flavor-access:remove_tenant_access":
"rule:admin_api",
"os_compute_api:os-flavor-access:add_tenant_access":
"rule:admin_api",
"os_compute_api:os-flavor-rxtx": "",
"os_compute_api:os-flavor-rxtx:discoverable": "",
"os_compute_api:flavors:discoverable": "",
"os_compute_api:os-flavor-extra-specs:discoverable": "",
"os_compute_api:os-flavor-extra-specs:index": "",
"os_compute_api:os-flavor-extra-specs:show": "",
"os_compute_api:os-flavor-extra-specs:create": "rule:admin_api",
"os_compute_api:os-flavor-extra-specs:update": "rule:admin_api",
"os_compute_api:os-flavor-extra-specs:delete": "rule:admin_api",
"os_compute_api:os-flavor-manage:discoverable": "",
"os_compute_api:os-flavor-manage": "rule:admin_api",
"os_compute_api:os-floating-ip-dns": "",
"os_compute_api:os-floating-ip-dns:discoverable": "",
"os_compute_api:os-floating-ip-pools": "",
"os_compute_api:os-floating-ip-pools:discoverable": "",
"os_compute_api:os-floating-ips": "",
"os_compute_api:os-floating-ips:discoverable": "",
"os_compute_api:os-floating-ips-bulk": "rule:admin_api",
"os_compute_api:os-floating-ips-bulk:discoverable": "",
"os_compute_api:os-fping": "",
"os_compute_api:os-fping:discoverable": "",
"os_compute_api:os-fping:all_tenants": "rule:admin_api",
"os_compute_api:os-hide-server-addresses": "is_admin:False",
"os_compute_api:os-hide-server-addresses:discoverable": "",
"os_compute_api:os-hosts": "rule:admin_api",
"os_compute_api:os-hosts:discoverable": "",
"os_compute_api:os-hypervisors": "rule:admin_api",
"os_compute_api:os-hypervisors:discoverable": "",
"os_compute_api:images:discoverable": "",
"os_compute_api:image-size": "",
"os_compute_api:image-size:discoverable": "",
"os_compute_api:os-instance-actions": "",
"os_compute_api:os-instance-actions:discoverable": "",
"os_compute_api:os-instance-actions:events": "rule:admin_api",
"os_compute_api:os-instance-usage-audit-log": "rule:admin_api",
"os_compute_api:os-instance-usage-audit-log:discoverable": "",
"os_compute_api:ips:discoverable": "",
"os_compute_api:ips:index": "rule:admin_or_owner",
"os_compute_api:ips:show": "rule:admin_or_owner",
"os_compute_api:os-keypairs:discoverable": "",
"os_compute_api:os-keypairs": "",
"os_compute_api:os-keypairs:index": "",
"os_compute_api:os-keypairs:show": "",
"os_compute_api:os-keypairs:create": "",
"os_compute_api:os-keypairs:delete": "",
"os_compute_api:limits:discoverable": "",
"os_compute_api:os-lock-server:discoverable": "",
"os_compute_api:os-lock-server:lock": "rule:admin_or_owner",
"os_compute_api:os-lock-server:unlock": "rule:admin_or_owner",
"os_compute_api:os-migrate-server:discoverable": "",
"os_compute_api:os-migrate-server:migrate": "rule:admin_api",
"os_compute_api:os-migrate-server:migrate_live": "rule:admin_api",
347
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"os_compute_api:os-multinic": "",
"os_compute_api:os-multinic:discoverable": "",
"os_compute_api:os-networks": "rule:admin_api",
"os_compute_api:os-networks:view": "",
"os_compute_api:os-networks:discoverable": "",
"os_compute_api:os-networks-associate": "rule:admin_api",
"os_compute_api:os-networks-associate:discoverable": "",
"os_compute_api:os-pause-server:discoverable": "",
"os_compute_api:os-pause-server:pause": "rule:admin_or_owner",
"os_compute_api:os-pause-server:unpause": "rule:admin_or_owner",
"os_compute_api:os-pci:pci_servers": "",
"os_compute_api:os-pci:discoverable": "",
"os_compute_api:os-pci:index": "rule:admin_api",
"os_compute_api:os-pci:detail": "rule:admin_api",
"os_compute_api:os-pci:show": "rule:admin_api",
"os_compute_api:os-personality:discoverable": "",
"os_compute_api:os-preserve-ephemeral-rebuild:discoverable": "",
"os_compute_api:os-quota-sets:discoverable": "",
"os_compute_api:os-quota-sets:show": "",
"os_compute_api:os-quota-sets:update": "rule:admin_api",
"os_compute_api:os-quota-sets:delete": "rule:admin_api",
"os_compute_api:os-quota-sets:detail": "rule:admin_api",
"os_compute_api:os-quota-class-sets": "",
"os_compute_api:os-quota-class-sets:discoverable": "",
"os_compute_api:os-rescue": "",
"os_compute_api:os-rescue:discoverable": "",
"os_compute_api:os-scheduler-hints:discoverable": "",
"os_compute_api:os-security-group-default-rules:discoverable": "",
"os_compute_api:os-security-group-default-rules": "rule:admin_api",
"os_compute_api:os-security-groups": "",
"os_compute_api:os-security-groups:discoverable": "",
"os_compute_api:os-server-diagnostics": "rule:admin_api",
"os_compute_api:os-server-diagnostics:discoverable": "",
"os_compute_api:os-server-password": "",
"os_compute_api:os-server-password:discoverable": "",
"os_compute_api:os-server-usage": "",
"os_compute_api:os-server-usage:discoverable": "",
"os_compute_api:os-server-groups": "",
"os_compute_api:os-server-groups:discoverable": "",
"os_compute_api:os-services": "rule:admin_api",
"os_compute_api:os-services:discoverable": "",
"os_compute_api:server-metadata:discoverable": "",
"os_compute_api:server-metadata:index": "rule:admin_or_owner",
"os_compute_api:server-metadata:show": "rule:admin_or_owner",
"os_compute_api:server-metadata:delete": "rule:admin_or_owner",
"os_compute_api:server-metadata:create": "rule:admin_or_owner",
"os_compute_api:server-metadata:update": "rule:admin_or_owner",
"os_compute_api:server-metadata:update_all": "rule:admin_or_owner",
"os_compute_api:servers:discoverable": "",
"os_compute_api:os-shelve:shelve": "",
"os_compute_api:os-shelve:shelve:discoverable": "",
"os_compute_api:os-shelve:shelve_offload": "rule:admin_api",
"os_compute_api:os-simple-tenant-usage:discoverable": "",
"os_compute_api:os-simple-tenant-usage:show": "rule:admin_or_owner",
"os_compute_api:os-simple-tenant-usage:list": "rule:admin_api",
"os_compute_api:os-suspend-server:discoverable": "",
348
CHAPTER 3. COMPUTE
"os_compute_api:os-suspend-server:suspend": "rule:admin_or_owner",
"os_compute_api:os-suspend-server:resume": "rule:admin_or_owner",
"os_compute_api:os-tenant-networks": "rule:admin_or_owner",
"os_compute_api:os-tenant-networks:discoverable": "",
"os_compute_api:os-shelve:unshelve": "",
"os_compute_api:os-user-data:discoverable": "",
"os_compute_api:os-virtual-interfaces": "",
"os_compute_api:os-virtual-interfaces:discoverable": "",
"os_compute_api:os-volumes": "",
"os_compute_api:os-volumes:discoverable": "",
"os_compute_api:os-volumes-attachments:index": "",
"os_compute_api:os-volumes-attachments:show": "",
"os_compute_api:os-volumes-attachments:create": "",
"os_compute_api:os-volumes-attachments:update": "",
"os_compute_api:os-volumes-attachments:delete": "",
"os_compute_api:os-volumes-attachments:discoverable": "",
"os_compute_api:os-availability-zone:list": "",
"os_compute_api:os-availability-zone:discoverable": "",
"os_compute_api:os-availability-zone:detail": "rule:admin_api",
"os_compute_api:os-used-limits": "rule:admin_api",
"os_compute_api:os-used-limits:discoverable": "",
"os_compute_api:os-migrations:index": "rule:admin_api",
"os_compute_api:os-migrations:discoverable": "",
"os_compute_api:os-assisted-volume-snapshots:create":
"rule:admin_api",
"os_compute_api:os-assisted-volume-snapshots:delete":
"rule:admin_api",
"os_compute_api:os-assisted-volume-snapshots:discoverable": "",
"os_compute_api:os-console-auth-tokens": "rule:admin_api",
"os_compute_api:os-server-external-events:create": "rule:admin_api"
}
3.17.2.3. rootwrap.conf
The rootwrap.conf file defines configuration values used by the rootwrap script when the
Compute service needs to escalate its privileges to those of the root user.
It is also possible to disable the root wrapper, and default to sudo only. Configure the
disable_rootwrap option in the [workaround] section of the nova.conf configuration file.
# Configuration for nova-rootwrap
# This file should be owned by (and only-writeable by) the root user
[DEFAULT]
# List of directories to load filter definitions from (separated by ',').
# These directories MUST all be only writeable by root !
filters_path=/etc/nova/rootwrap.d,/usr/share/nova/rootwrap
# List of directories to search executables in, in case filters do not
# explicitely specify a full path (separated by ',')
# If not specified, defaults to system PATH environment variable.
349
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# These directories MUST all be only writeable by root !
exec_dirs=/sbin,/usr/sbin,/bin,/usr/bin
# Enable logging to syslog
# Default value is False use_syslog=False
# Which syslog facility to use.
# Valid values include auth, authpriv, syslog, local0, local1...
# Default value is 'syslog' syslog_log_facility=syslog
# Which messages to log.
# INFO means log all usage
# ERROR means only log unsuccessful attempts syslog_log_level=ERROR
3.18. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
OPENSTACK COMPUTE
Table 3.63. New options
Option = default value
[DEFAULT] ebtables_exec_attempts = 3
[DEFAULT] ebtables_retry_interval = 1.0
[DEFAULT] io_ops_weight_multiplier = -1.0
[DEFAULT] keystone_ec2_insecure = False
[DEFAULT] log-config-append = None
[DEFAULT] log-date-format = %Y-%m-%d
%H:%M:%S
[DEFAULT] log-dir = None
(Type) Help string
(IntOpt) Number of times to retry ebtables commands on failure.
(FloatOpt) Number of seconds to wait between ebtables retries.
(FloatOpt) Multiplier used for weighing host io ops.
Negative numbers mean a preference to choose light workload compute hosts.
(BoolOpt) Disable SSL certificate verification.
(StrOpt) 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.
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
(StrOpt) (Optional) The base directory used for relative --log-file paths.
350
CHAPTER 3. COMPUTE
Option = default value
[DEFAULT] log-file = None
[DEFAULT] log-format = None
(Type) Help string
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Use logging_context_format_string and logging_default_format_string instead.
[DEFAULT] max_concurrent_builds = 10
[DEFAULT] metadata_cache_expiration = 15
(IntOpt) Maximum number of instance builds to run concurrently
(IntOpt) Time in seconds to cache metadata; 0 to disable metadata caching entirely (not recommended). Increasingthis should improve response times of the metadata API when under heavy load. Higher values may increase memoryusage and result in longer times for host metadata changes to take effect.
(StrOpt) Block storage IP address of this host [DEFAULT] my_block_storage_ip = $my_ip
[DEFAULT] novncproxy_host = 0.0.0.0
[DEFAULT] novncproxy_port = 6080
[DEFAULT] policy_dirs = ['policy.d']
[DEFAULT] quota_networks = 3
[DEFAULT] scheduler_instance_sync_interval =
120
(StrOpt) Host on which to listen for incoming requests
(IntOpt) Port on which to listen for incoming requests
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(IntOpt) Number of private networks allowed per project
(IntOpt) Waiting time interval (seconds) between sending the scheduler a list of current instance
UUIDs to verify that its view of instances is in sync with nova. If the CONF option
`scheduler_tracks_instance_changes` is False, changing this option will have no effect.
[DEFAULT] scheduler_tracks_instance_changes =
True
(BoolOpt) Determines if the Scheduler tracks changes to instances to help with its filtering decisions.
351
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] syslog-log-facility = LOG_USER
[DEFAULT] use-syslog = False
[DEFAULT] use-syslog-rfc-format = False
[api_database] connection = None
[api_database] connection_debug = 0
[api_database] connection_trace = False
[api_database] idle_timeout = 3600
[api_database] max_overflow = None
[api_database] max_pool_size = None
[api_database] max_retries = 10
[api_database] mysql_sql_mode = TRADITIONAL
[api_database] pool_timeout = None
[api_database] retry_interval = 10
[api_database] slave_connection = None
(Type) Help string
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(StrOpt) The SQLAlchemy connection string to use to connect to the Nova API database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
352
Option = default value
[api_database] sqlite_synchronous = True
[barbican] cafile = None
[barbican] catalog_info = keymanager:barbican:public
[barbican] certfile = None
[barbican] endpoint_template = None
[barbican] insecure = False
[barbican] keyfile = None
[barbican] os_region_name = None
[barbican] timeout = None
[cinder] cafile = None
[cinder] certfile = None
[cinder] insecure = False
[cinder] keyfile = None
[cinder] timeout = None
[database] backend = sqlalchemy
[database] connection = None
[database] connection_debug = 0
[database] connection_trace = False
[database] db_inc_retry_interval = True
CHAPTER 3. COMPUTE
(Type) Help string
(BoolOpt) If True, SQLite uses synchronous mode.
(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
(StrOpt) Info to match when looking for barbican in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:
<endpoint_type>
(StrOpt) PEM encoded client certificate cert file
(StrOpt) Override service catalog lookup with template for barbican endpoint e.g.
http://localhost:9311/v1/%(project_id)s
(BoolOpt) Verify HTTPS connections.
(StrOpt) PEM encoded client certificate key file
(StrOpt) Region name of this node
(IntOpt) Timeout value for http requests
(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
(StrOpt) PEM encoded client certificate cert file
(BoolOpt) Verify HTTPS connections.
(StrOpt) PEM encoded client certificate key file
(IntOpt) Timeout value for http requests
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
353
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[database] db_max_retries = 20
[database] db_max_retry_interval = 10
[database] db_retry_interval = 1
[database] idle_timeout = 3600
[database] max_overflow = None
[database] max_pool_size = None
[database] max_retries = 10
[database] min_pool_size = 1
[database] mysql_sql_mode = TRADITIONAL
[database] pool_timeout = None
[database] retry_interval = 10
[database] slave_connection = None
[database] sqlite_db = oslo.sqlite
[database] sqlite_synchronous = True
[database] use_db_reconnect = False
(Type) Help string
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
354
CHAPTER 3. COMPUTE
Option = default value
[guestfs] debug = False
[libvirt] iscsi_iface = None
[libvirt] quobyte_client_cfg = None
[libvirt] quobyte_mount_point_base =
$state_path/mnt
[libvirt] smbfs_mount_options =
[libvirt] smbfs_mount_point_base =
$state_path/mnt
[neutron] auth_plugin = None
[neutron] auth_section = None
[neutron] cafile = None
[neutron] certfile = None
[neutron] insecure = False
[neutron] keyfile = None
[neutron] timeout = None
[oslo_concurrency] disable_process_locking =
False
[oslo_concurrency] lock_path = None
(Type) Help string
(BoolOpt) Enable guestfs debug
(StrOpt) The iSCSI transport iface to use to connect to target in case offload support is desired.
Supported transports are be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx and ocs. Default format is transport_name.hwaddress and can be generated manually or via iscsiadm -m iface
(StrOpt) Path to a Quobyte Client configuration file.
(StrOpt) Directory where the Quobyte volume is mounted on the compute node
(StrOpt) Mount options passed to the SMBFS client. See mount.cifs man page for details. Note that the libvirt-qemu uid and gid must be specified.
(StrOpt) Directory where the SMBFS shares are mounted on the compute node
(StrOpt) Name of the plugin to load
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
(StrOpt) PEM encoded client certificate cert file
(BoolOpt) Verify HTTPS connections.
(StrOpt) PEM encoded client certificate key file
(IntOpt) Timeout value for http requests
(BoolOpt) Enables or disables inter-process locks.
[oslo_messaging_amqp] allow_insecure_clients =
False
(StrOpt) 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 external locks are used, a lock path must be set.
(BoolOpt) Accept clients using either SSL or plain
TCP
355
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
(Type) Help string
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
[oslo_messaging_amqp] ssl_key_file =
[oslo_messaging_amqp] ssl_key_password =
None
[oslo_messaging_amqp] trace = False
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] amqp_durable_queues =
False
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_qpid] qpid_heartbeat = 60 (IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
[oslo_messaging_qpid] qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
356
CHAPTER 3. COMPUTE
Option = default value
[oslo_messaging_qpid] qpid_sasl_mechanisms =
[oslo_messaging_qpid] qpid_tcp_nodelay = True
[oslo_messaging_qpid] qpid_topology_version = 1
(Type) Help string
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30
[oslo_messaging_rabbit] amqp_auto_delete =
False
[oslo_messaging_rabbit] amqp_durable_queues =
False
[oslo_messaging_rabbit] fake_rabbit = False
[oslo_messaging_rabbit] heartbeat_rate = 2
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold to check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
357
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(Type) Help string
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 are also available.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
[oslo_messaging_rabbit] rabbit_port = 5672
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
[oslo_messaging_rabbit] rabbit_retry_interval = 1
[oslo_messaging_rabbit] rabbit_use_ssl = False
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
[oslo_messaging_rabbit] rpc_conn_pool_size = 30
[oslo_middleware] max_request_body_size =
114688
[serial_console] serialproxy_host = 0.0.0.0
[serial_console] serialproxy_port = 6083
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
(IntOpt) The maximum body size for each request, in bytes.
(StrOpt) Host on which to listen for incoming requests
(IntOpt) Port on which to listen for incoming requests
358
CHAPTER 3. COMPUTE
Option = default value
[vmware] cache_prefix = None
[vmware] pbm_default_policy = None
[vmware] pbm_enabled = False
[vmware] pbm_wsdl_location = None
[workarounds] destroy_after_evacuate = True
[workarounds] disable_libvirt_livesnapshot = True
[workarounds] disable_rootwrap = False
(Type) Help string
(StrOpt) The prefix for Where cached images are stored. This is NOT the full path - only a folder prefix. This should only be used when a datastore cache should be shared between compute nodes.
Note: this should only be used when the compute nodes have a shared file system.
(StrOpt) The PBM default policy. If pbm_wsdl_location is set and there is no defined storage policy for the specific request then this policy will be used.
(BoolOpt) The PBM status.
(StrOpt) PBM service WSDL file location URL. e.g.
file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this will disable storage policy based placement of instances.
(BoolOpt) Whether to destroy instances on startup when it is suspected that they have previously been evacuated. This can result in data loss if undesired. See https://launchpad.net/bugs/1419785
(BoolOpt) When using libvirt 1.2.2 fails live snapshots intermittently under load. This config option provides mechanism to disable livesnapshot while this is resolved. See https://bugs.launchpad.net/nova/+bug/1334398
(BoolOpt) This option allows a fallback to sudo for performance reasons. For example see https://bugs.launchpad.net/nova/+bug/1415106
Table 3.64. New default values
Option
[DEFAULT] client_socket_timeout
Previous default value
0
New default value
900
359
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option
[DEFAULT] default_log_levels
Previous default value amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retr
y=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN
/services/Cloud /
New default value
[DEFAULT] ec2_path
[DEFAULT] multi_instance_display_name_te mplate
%(name)s-%(uuid)s %(name)s-%(count)d
[DEFAULT] rpc_zmq_matchmaker
[cinder] catalog_info oslo.messaging._drivers.matchm
aker.MatchMakerLocalhost
local volume:cinder:publicURL volumev2:cinderv2:publicURL
360
Table 3.65. Deprecated options
Deprecated option
[DEFAULT] network_device_mtu
[DEFAULT] log-format
[DEFAULT] use-syslog
[cinder] http_timeout
[DEFAULT] use_syslog
[ironic] client_log_level
[neutron] admin_username
[DEFAULT] osapi_max_request_body_size
[neutron] ca_certificates_file
New Option
None
None
None
[cinder] timeout
None
None
None
[oslo_middleware] max_request_body_size
[neutron] cafile
Deprecated option
[neutron] auth_strategy
[neutron] admin_user_id
[neutron] admin_tenant_id
[DEFAULT] log_format
[cinder] api_insecure
[neutron] admin_tenant_name
[neutron] admin_password
[DEFAULT] share_dhcp_address
[neutron] api_insecure
[cinder] ca_certificates_file
[neutron] admin_auth_url
[neutron] url_timeout
[neutron] allow_duplicate_networks
New Option
None
None
None
None
[cinder] insecure
None
None
None
[neutron] insecure
[cinder] cafile
None
[neutron] timeout
None
CHAPTER 3. COMPUTE
361
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
CHAPTER 4. DASHBOARD
This chapter describes how to configure the OpenStack dashboard with Apache web server.
4.1. CONFIGURE THE DASHBOARD
You can configure the dashboard for a simple HTTP deployment.
You can configure the dashboard for a secured HTTPS deployment. While the standard installation uses a non-encrypted HTTP channel, you can enable SSL support for the dashboard.
Also, you can configure the size of the VNC window in the dashboard.
4.1.1. Configure the dashboard for HTTP
362
You can configure the dashboard for a simple HTTP deployment. The standard installation uses a non-encrypted HTTP channel.
1. Specify the host for your OpenStack Identity Service endpoint in the /etc/openstack-
dashboard/local_settings file with the OPENSTACK_HOST setting.
The following example shows this setting: import os from django.utils.translation import ugettext_lazy as _
DEBUG = False
TEMPLATE_DEBUG = DEBUG
# WEBROOT is the location relative to Webserver root
# should end with a slash.
WEBROOT = '/dashboard/'
# Required for Django 1.5.
# If horizon is running in production (DEBUG is False), set this
# with the list of host/domain names that the application can serve.
# For more information see:
# https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hosts
#ALLOWED_HOSTS = ['horizon.example.com', ]
ALLOWED_HOSTS = [ '*' , ]
# Specify a regular expression to validate user passwords.
# HORIZON_CONFIG = {
# "password_validator": {
# "regex": '.*',
# "help_text": _("Your password does not meet the requirements.")
CHAPTER 4. DASHBOARD
# }
# }
LOCAL_PATH = os.path.dirname(os.path.abspath(__file__))
CACHES = {
'default' : {
'BACKEND' :
'django.core.cache.backends.memcached.MemcachedCache' ,
'LOCATION' : '127.0.0.1:11211'
}
}
# Send email to the console by default
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
# Or send them to /dev/null
#EMAIL_BACKEND = 'django.core.mail.backends.dummy.EmailBackend'
# Configure these for your outgoing email host
# EMAIL_HOST = 'smtp.my-company.com'
# EMAIL_PORT = 25
# EMAIL_HOST_USER = 'djangomail'
# EMAIL_HOST_PASSWORD = 'top-secret!'
# For multiple regions uncomment this configuration, and add
(endpoint, title).
# AVAILABLE_REGIONS = [
# ('http://cluster1.example.com:5000/v2.0', 'cluster1'),
# ('http://cluster2.example.com:5000/v2.0', 'cluster2'),
# ]
OPENSTACK_HOST = "127.0.0.1"
OPENSTACK_KEYSTONE_URL = "http://%s:5000/v2.0" % OPENSTACK_HOST
OPENSTACK_KEYSTONE_DEFAULT_ROLE = "Member"
# The OPENSTACK_KEYSTONE_BACKEND settings can be used to identify the
# capabilities of the auth backend for Keystone.
# If Keystone has been configured to use LDAP as the auth backend then set
# can_edit_user to False and name to 'ldap'.
#
# TODO(tres): Remove these once Keystone has an API to identify auth backend.
OPENSTACK_KEYSTONE_BACKEND = {
'name' : 'native' ,
'can_edit_user' : True
}
# OPENSTACK_ENDPOINT_TYPE specifies the endpoint type to use for the endpoints
# in the Keystone service catalog. Use this setting when Horizon is running
# external to the OpenStack environment. The default is
'internalURL'.
#OPENSTACK_ENDPOINT_TYPE = "publicURL"
363
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The number of Swift containers and objects to display on a single page before
# providing a paging element (a "more" link) to paginate results.
API_RESULT_LIMIT = 1000
# If you have external monitoring links, eg:
# EXTERNAL_MONITORING = [
# ['Nagios','http://foo.com'],
# ['Ganglia','http://bar.com'],
# ]
LOGGING = {
'version' : 1 ,
# When set to True this will disable all logging except
# for loggers specified in this configuration dictionary.
Note that
# if nothing is specified here and disable_existing_loggers is True,
# django.db.backends will still log unless it is disabled explicitly.
'disable_existing_loggers' : False ,
'handlers' : {
'null' : {
'level' : 'DEBUG' ,
'class' : 'django.utils.log.NullHandler' ,
},
'console' : {
# Set the level to "DEBUG" for verbose output logging.
'level' : 'INFO' ,
'class' : 'logging.StreamHandler' ,
},
},
'loggers' : {
# Logging from django.db.backends is VERY verbose, send to null
# by default.
'django.db.backends' : {
'handlers' : [ 'null' ],
'propagate' : False ,
},
'horizon' : {
'handlers' : [ 'console' ],
'propagate' : False ,
},
'novaclient' : {
'handlers' : [ 'console' ],
'propagate' : False ,
},
'keystoneclient' : {
'handlers' : [ 'console' ],
'propagate' : False ,
},
'nose.plugins.manager' : {
'handlers' : [ 'console' ],
364
CHAPTER 4. DASHBOARD
'propagate' : False ,
}
}
}
The service catalog configuration in the Identity Service determines whether a service appears in the dashboard..
2. Restart Apache http server.
# systemctl restart httpd
Next, restart memcached:
# systemctl restart memcached
4.1.2. Configure the dashboard for HTTPS
You can configure the dashboard for a secured HTTPS deployment. While the standard installation uses a non-encrypted HTTP channel, you can enable SSL support for the dashboard.
This example uses the http://openstack.example.com domain. Use a domain that fits your current setup.
1. In the /etc/openstack-dashboard/local_settings file, update the following options:
USE_SSL = True
CSRF_COOKIE_SECURE = True
SESSION_COOKIE_SECURE = True
SESSION_COOKIE_HTTPONLY = True
To enable HTTPS, the USE_SSL = True option is required.
The other options require that HTTPS is enabled; these options defend against cross-site scripting.
2. Edit the /etc/httpd/conf.d/openstack-dashboard.conf file as shown in
:
Example 4.1. Before
WSGIScriptAlias / /usr/share/openstackdashboard/openstack_dashboard/wsgi/django.wsgi
WSGIDaemonProcess horizon user=apache group=apache processes=3 threads=10
Alias /static /usr/share/openstack-
365
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
dashboard/openstack_dashboard/static/
<Directory /usr/share/openstackdashboard/openstack_dashboard/wsgi>
# For Apache http server 2.2 and earlier:
Order allow,deny
Allow from all
# For Apache http server 2.4 and later:
# Require all granted
</Directory>
Example 4.2. After
<VirtualHost *:80>
ServerName openstack.example.com
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteCond %{HTTPS} off
RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
</IfModule>
<IfModule !mod_rewrite.c>
RedirectPermanent / https://openstack.example.com
</IfModule>
</VirtualHost>
<VirtualHost *:443>
ServerName openstack.example.com
SSLEngine On
# Remember to replace certificates and keys with valid paths in your environment
SSLCertificateFile /etc/httpd/SSL/openstack.example.com.crt
SSLCACertificateFile /etc/httpd/SSL/openstack.example.com.crt
SSLCertificateKeyFile /etc/httpd/SSL/openstack.example.com.key
SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
# HTTP Strict Transport Security (HSTS) enforces that all communications
# with a server go over SSL. This mitigates the threat from attacks such
# as SSL-Strip which replaces links on the wire, stripping away https prefixes
# and potentially allowing an attacker to view confidential information on the
# wire
Header add Strict-Transport-Security "max-age=15768000"
WSGIScriptAlias / /usr/share/openstackdashboard/openstack_dashboard/wsgi/django.wsgi
WSGIDaemonProcess horizon user=apache group=apache processes=3 threads=10
Alias /static /usr/share/openstackdashboard/openstack_dashboard/static/
<Directory /usr/share/openstack-
366
CHAPTER 4. DASHBOARD
dashboard/openstack_dashboard/wsgi>
# For Apache http server 2.2 and earlier:
Order allow,deny
Allow from all
# For Apache http server 2.4 and later:
# Require all granted
</Directory>
</VirtualHost>
In this configuration, the Apache HTTP server listens on port 443 and redirects all nonsecure requests to the HTTPS protocol. The secured section defines the private key, public key, and certificate to use.
3. Restart the Apache HTTP server.
# systemctl restart httpd
4. Restart memcached:
# systemctl restart memcached
If you try to access the dashboard through HTTP, the browser redirects you to the HTTPS page.
4.2. CUSTOMIZE THE DASHBOARD
Once you have the dashboard installed you can customize the way it looks and feels to suit your own needs.
Note
The OpenStack dashboard by default installs the openstack-dashboard-theme package.
If you do not want to use this theme you can remove it and its dependencies using the following command:
# yum erase openstack-dashboard-theme
Note
This guide focuses on the local_settings file, stored in /openstack-
dashboard/openstack_dashboard/local/.
367
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The following can easily be customized:
Site colors
Logo
HTML title
Site branding link
Help URL
Procedure 4.1. Logo and site colors
1. Create two logo files, png format, with transparent backgrounds using the following sizes:
Login screen: 365 x 50
Logged in banner: 216 x 35
2. Upload your new images to the following location: /usr/share/openstack-
dashboard/openstack_dashboard/static/dashboard/img/
3. Create a CSS style sheet in the following directory: /usr/share/openstack-
dashboard/openstack_dashboard/static/dashboard/css/
4. Change the colors and image file names as appropriate, though the relative directory paths should be the same. The following example file shows you how to customize your CSS file:
/*
* New theme colors for dashboard that override the defaults:
* dark blue: #355796 / rgb(53, 87, 150)
* light blue: #BAD3E1 / rgb(186, 211, 225)
*
* By Preston Lee <[email protected]>
*/ h1.brand { background: #355796 repeat-x top left; border-bottom: 2px solid #BAD3E1;
} h1.brand a { background: url(../img/my_cloud_logo_small.png) top left no-repeat;
}
#splash .login { background: #355796 url(../img/my_cloud_logo_medium.png) no-repeat center 35px;
}
#splash .login .modal-header { border-top: 1px solid #BAD3E1;
368
CHAPTER 4. DASHBOARD
}
.btn-primary { background-image: none !important; background-color: #355796 !important; border: none !important; box-shadow: none;
}
.btn-primary:hover,
.btn-primary:active { border: none; box-shadow: none; background-color: #BAD3E1 !important; text-decoration: none;
}
5. Open the following HTML template in an editor of your choice: /usr/share/openstack-
dashboard/openstack_dashboard/templates/_stylesheets.html
6. Add a line to include your newly created style sheet. For example custom.css file:
...
<link href='{{ STATIC_URL }}bootstrap/css/bootstrap.min.css' media='screen' rel='stylesheet' />
<link href='{{ STATIC_URL }}dashboard/css/{% choose_css %}' media='screen' rel='stylesheet' />
<link href='{{ STATIC_URL }}dashboard/css/custom.css'
media='screen' rel='stylesheet' />
...
7.
Restart Apache:
# systemctl restart httpd
8. To view your changes simply reload your dashboard. If necessary go back and modify your
CSS file as appropriate.
Procedure 4.2. HTML title
1. Set the HTML title, which appears at the top of the browser window, by adding the following line to local_settings:
SITE_BRANDING = "Example, Inc. Cloud"
2. Restart Apache for this change to take effect.
Procedure 4.3. HTML title
1. The logo also acts as a hyperlink. The default behavior is to redirect to
horizon:user_home. To change this, add the following attribute to local_settings
369
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
SITE_BRANDING_LINK = "http://example.com"
2. Restart Apache for this change to take effect.
Procedure 4.4. Help URL
1. By default the help URL points to https://access.redhat.com/documentation/en-
US/Red_Hat_Enterprise_Linux_OpenStack_Platform/7/index.html
. Change this by editing the following arritbute to the URL of your choice in local_settings
'help_url': "http://openstack.mycompany.org",
2. Restart Apache for this change to take effect.
4.3. ADDITIONAL SAMPLE CONFIGURATION FILES
Find the following files in /etc/openstack-dashboard.
4.3.1. keystone_policy.json
The keystone_policy.json file defines additional access controls for the dashboard that apply to the Identity service.
Note
The keystone_policy.json file must match the Identity service
/etc/keystone/policy.json policy file.
{
"admin_required": [
[
"role:admin"
],
[
"is_admin:1"
]
],
"service_role": [
[
"role:service"
]
],
"service_or_admin": [
[
"rule:admin_required"
],
[
"rule:service_role"
370
]
],
"owner": [
[
"user_id:%(user_id)s"
]
],
"admin_or_owner": [
[
"rule:admin_required"
],
[
"rule:owner"
]
],
"default": [
[
"rule:admin_required"
]
],
"identity:get_service": [
[
"rule:admin_required"
]
],
"identity:list_services": [
[
"rule:admin_required"
]
],
"identity:create_service": [
[
"rule:admin_required"
]
],
"identity:update_service": [
[
"rule:admin_required"
]
],
"identity:delete_service": [
[
"rule:admin_required"
]
],
"identity:get_endpoint": [
[
"rule:admin_required"
]
],
"identity:list_endpoints": [
[
"rule:admin_required"
]
],
"identity:create_endpoint": [
CHAPTER 4. DASHBOARD
371
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
[
"rule:admin_required"
]
],
"identity:update_endpoint": [
[
"rule:admin_required"
]
],
"identity:delete_endpoint": [
[
"rule:admin_required"
]
],
"identity:get_domain": [
[
"rule:admin_required"
]
],
"identity:list_domains": [
[
"rule:admin_required"
]
],
"identity:create_domain": [
[
"rule:admin_required"
]
],
"identity:update_domain": [
[
"rule:admin_required"
]
],
"identity:delete_domain": [
[
"rule:admin_required"
]
],
"identity:get_project": [
[
"rule:admin_required"
]
],
"identity:list_projects": [
[
"rule:admin_required"
]
],
"identity:list_user_projects": [
[
"rule:admin_or_owner"
]
],
"identity:create_project": [
[
372
"rule:admin_required"
]
],
"identity:update_project": [
[
"rule:admin_required"
]
],
"identity:delete_project": [
[
"rule:admin_required"
]
],
"identity:get_user": [
[
"rule:admin_required"
]
],
"identity:list_users": [
[
"rule:admin_required"
]
],
"identity:create_user": [
[
"rule:admin_required"
]
],
"identity:update_user": [
[
"rule:admin_or_owner"
]
],
"identity:delete_user": [
[
"rule:admin_required"
]
],
"identity:get_group": [
[
"rule:admin_required"
]
],
"identity:list_groups": [
[
"rule:admin_required"
]
],
"identity:list_groups_for_user": [
[
"rule:admin_or_owner"
]
],
"identity:create_group": [
[
"rule:admin_required"
CHAPTER 4. DASHBOARD
373
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
]
],
"identity:update_group": [
[
"rule:admin_required"
]
],
"identity:delete_group": [
[
"rule:admin_required"
]
],
"identity:list_users_in_group": [
[
"rule:admin_required"
]
],
"identity:remove_user_from_group": [
[
"rule:admin_required"
]
],
"identity:check_user_in_group": [
[
"rule:admin_required"
]
],
"identity:add_user_to_group": [
[
"rule:admin_required"
]
],
"identity:get_credential": [
[
"rule:admin_required"
]
],
"identity:list_credentials": [
[
"rule:admin_required"
]
],
"identity:create_credential": [
[
"rule:admin_required"
]
],
"identity:update_credential": [
[
"rule:admin_required"
]
],
"identity:delete_credential": [
[
"rule:admin_required"
]
374
],
"identity:get_role": [
[
"rule:admin_required"
]
],
"identity:list_roles": [
[
"rule:admin_required"
]
],
"identity:create_role": [
[
"rule:admin_required"
]
],
"identity:update_role": [
[
"rule:admin_required"
]
],
"identity:delete_role": [
[
"rule:admin_required"
]
],
"identity:check_grant": [
[
"rule:admin_required"
]
],
"identity:list_grants": [
[
"rule:admin_required"
]
],
"identity:create_grant": [
[
"rule:admin_required"
]
],
"identity:revoke_grant": [
[
"rule:admin_required"
]
],
"identity:list_role_assignments": [
[
"rule:admin_required"
]
],
"identity:get_policy": [
[
"rule:admin_required"
]
],
CHAPTER 4. DASHBOARD
375
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"identity:list_policies": [
[
"rule:admin_required"
]
],
"identity:create_policy": [
[
"rule:admin_required"
]
],
"identity:update_policy": [
[
"rule:admin_required"
]
],
"identity:delete_policy": [
[
"rule:admin_required"
]
],
"identity:check_token": [
[
"rule:admin_required"
]
],
"identity:validate_token": [
[
"rule:service_or_admin"
]
],
"identity:validate_token_head": [
[
"rule:service_or_admin"
]
],
"identity:revocation_list": [
[
"rule:service_or_admin"
]
],
"identity:revoke_token": [
[
"rule:admin_or_owner"
]
],
"identity:create_trust": [
[
"user_id:%(trust.trustor_user_id)s"
]
],
"identity:get_trust": [
[
"rule:admin_or_owner"
]
],
"identity:list_trusts": [
376
CHAPTER 4. DASHBOARD
[
"@"
]
],
"identity:list_roles_for_trust": [
[
"@"
]
],
"identity:check_role_for_trust": [
[
"@"
]
],
"identity:get_role_for_trust": [
[
"@"
]
],
"identity:delete_trust": [
[
"@"
]
]
}
4.3.2. nova_policy.json
The nova_policy.json file defines additional access controls for the dashboard that apply to the
Compute service.
Note
The nova_policy.json file must match the Compute /etc/nova/policy.json policy file.
{
"context_is_admin": "role:admin",
"admin_or_owner": "is_admin:True or project_id:%(project_id)s",
"default": "rule:admin_or_owner",
"cells_scheduler_filter:TargetCellFilter": "is_admin:True",
"compute:create": "",
"compute:create:attach_network": "",
"compute:create:attach_volume": "",
"compute:create:forced_host": "is_admin:True",
"compute:get_all": "",
"compute:get_all_tenants": "",
"compute:unlock_override": "rule:admin_api",
"compute:shelve": "",
"compute:shelve_offload": "",
"compute:unshelve": "",
"admin_api": "is_admin:True",
377
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"compute_extension:accounts": "rule:admin_api",
"compute_extension:admin_actions": "rule:admin_api",
"compute_extension:admin_actions:pause": "rule:admin_or_owner",
"compute_extension:admin_actions:unpause": "rule:admin_or_owner",
"compute_extension:admin_actions:suspend": "rule:admin_or_owner",
"compute_extension:admin_actions:resume": "rule:admin_or_owner",
"compute_extension:admin_actions:lock": "rule:admin_or_owner",
"compute_extension:admin_actions:unlock": "rule:admin_or_owner",
"compute_extension:admin_actions:resetNetwork": "rule:admin_api",
"compute_extension:admin_actions:injectNetworkInfo":
"rule:admin_api",
"compute_extension:admin_actions:createBackup":
"rule:admin_or_owner",
"compute_extension:admin_actions:migrateLive": "rule:admin_api",
"compute_extension:admin_actions:resetState": "rule:admin_api",
"compute_extension:admin_actions:migrate": "rule:admin_api",
"compute_extension:v3:os-admin-actions": "rule:admin_api",
"compute_extension:v3:os-admin-actions:pause": "rule:admin_or_owner",
"compute_extension:v3:os-admin-actions:unpause":
"rule:admin_or_owner",
"compute_extension:v3:os-admin-actions:suspend":
"rule:admin_or_owner",
"compute_extension:v3:os-admin-actions:resume":
"rule:admin_or_owner",
"compute_extension:v3:os-admin-actions:lock": "rule:admin_or_owner",
"compute_extension:v3:os-admin-actions:unlock":
"rule:admin_or_owner",
"compute_extension:v3:os-admin-actions:reset_network":
"rule:admin_api",
"compute_extension:v3:os-admin-actions:inject_network_info":
"rule:admin_api",
"compute_extension:v3:os-admin-actions:create_backup":
"rule:admin_or_owner",
"compute_extension:v3:os-admin-actions:migrate_live":
"rule:admin_api",
"compute_extension:v3:os-admin-actions:reset_state":
"rule:admin_api",
"compute_extension:v3:os-admin-actions:migrate": "rule:admin_api",
"compute_extension:v3:os-admin-password": "",
"compute_extension:aggregates": "rule:admin_api",
"compute_extension:v3:os-aggregates": "rule:admin_api",
"compute_extension:agents": "rule:admin_api",
"compute_extension:v3:os-agents": "rule:admin_api",
"compute_extension:attach_interfaces": "",
"compute_extension:v3:os-attach-interfaces": "",
"compute_extension:baremetal_nodes": "rule:admin_api",
"compute_extension:v3:os-baremetal-nodes": "rule:admin_api",
"compute_extension:cells": "rule:admin_api",
"compute_extension:v3:os-cells": "rule:admin_api",
"compute_extension:certificates": "",
"compute_extension:v3:os-certificates": "",
"compute_extension:cloudpipe": "rule:admin_api",
"compute_extension:cloudpipe_update": "rule:admin_api",
"compute_extension:console_output": "",
"compute_extension:v3:consoles:discoverable": "",
"compute_extension:v3:os-console-output": "",
378
CHAPTER 4. DASHBOARD
"compute_extension:consoles": "",
"compute_extension:v3:os-remote-consoles": "",
"compute_extension:coverage_ext": "rule:admin_api",
"compute_extension:v3:os-coverage": "rule:admin_api",
"compute_extension:createserverext": "",
"compute_extension:deferred_delete": "",
"compute_extension:v3:os-deferred-delete": "",
"compute_extension:disk_config": "",
"compute_extension:evacuate": "rule:admin_api",
"compute_extension:v3:os-evacuate": "rule:admin_api",
"compute_extension:extended_server_attributes": "rule:admin_api",
"compute_extension:v3:os-extended-server-attributes":
"rule:admin_api",
"compute_extension:extended_status": "",
"compute_extension:v3:os-extended-status": "",
"compute_extension:extended_availability_zone": "",
"compute_extension:v3:os-extended-availability-zone": "",
"compute_extension:extended_ips": "",
"compute_extension:extended_ips_mac": "",
"compute_extension:extended_vif_net": "",
"compute_extension:v3:extension_info:discoverable": "",
"compute_extension:extended_volumes": "",
"compute_extension:v3:os-extended-volumes": "",
"compute_extension:v3:os-extended-volumes:attach": "",
"compute_extension:v3:os-extended-volumes:detach": "",
"compute_extension:fixed_ips": "rule:admin_api",
"compute_extension:v3:os-fixed-ips:discoverable": "",
"compute_extension:v3:os-fixed-ips": "rule:admin_api",
"compute_extension:flavor_access": "",
"compute_extension:v3:os-flavor-access": "",
"compute_extension:flavor_disabled": "",
"compute_extension:v3:os-flavor-disabled": "",
"compute_extension:flavor_rxtx": "",
"compute_extension:v3:os-flavor-rxtx": "",
"compute_extension:flavor_swap": "",
"compute_extension:flavorextradata": "",
"compute_extension:flavorextraspecs:index": "",
"compute_extension:flavorextraspecs:show": "",
"compute_extension:flavorextraspecs:create": "rule:admin_api",
"compute_extension:flavorextraspecs:update": "rule:admin_api",
"compute_extension:flavorextraspecs:delete": "rule:admin_api",
"compute_extension:v3:flavor-extra-specs:index": "",
"compute_extension:v3:flavor-extra-specs:show": "",
"compute_extension:v3:flavor-extra-specs:create": "rule:admin_api",
"compute_extension:v3:flavor-extra-specs:update": "rule:admin_api",
"compute_extension:v3:flavor-extra-specs:delete": "rule:admin_api",
"compute_extension:flavormanage": "rule:admin_api",
"compute_extension:floating_ip_dns": "",
"compute_extension:floating_ip_pools": "",
"compute_extension:floating_ips": "",
"compute_extension:floating_ips_bulk": "rule:admin_api",
"compute_extension:fping": "",
"compute_extension:fping:all_tenants": "rule:admin_api",
"compute_extension:hide_server_addresses": "is_admin:False",
"compute_extension:v3:os-hide-server-addresses": "is_admin:False",
"compute_extension:hosts": "rule:admin_api",
379
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"compute_extension:v3:os-hosts": "rule:admin_api",
"compute_extension:hypervisors": "rule:admin_api",
"compute_extension:v3:os-hypervisors": "rule:admin_api",
"compute_extension:image_size": "",
"compute_extension:v3:os-image-metadata": "",
"compute_extension:v3:os-images": "",
"compute_extension:instance_actions": "",
"compute_extension:v3:os-instance-actions": "",
"compute_extension:instance_actions:events": "rule:admin_api",
"compute_extension:v3:os-instance-actions:events": "rule:admin_api",
"compute_extension:instance_usage_audit_log": "rule:admin_api",
"compute_extension:v3:os-instance-usage-audit-log": "rule:admin_api",
"compute_extension:v3:ips:discoverable": "",
"compute_extension:keypairs": "",
"compute_extension:keypairs:index": "",
"compute_extension:keypairs:show": "",
"compute_extension:keypairs:create": "",
"compute_extension:keypairs:delete": "",
"compute_extension:v3:os-keypairs:discoverable": "",
"compute_extension:v3:os-keypairs": "",
"compute_extension:v3:os-keypairs:index": "",
"compute_extension:v3:os-keypairs:show": "",
"compute_extension:v3:os-keypairs:create": "",
"compute_extension:v3:os-keypairs:delete": "",
"compute_extension:multinic": "",
"compute_extension:v3:os-multinic": "",
"compute_extension:networks": "rule:admin_api",
"compute_extension:networks:view": "",
"compute_extension:networks_associate": "rule:admin_api",
"compute_extension:quotas:show": "",
"compute_extension:quotas:update": "rule:admin_api",
"compute_extension:quotas:delete": "rule:admin_api",
"compute_extension:v3:os-quota-sets:show": "",
"compute_extension:v3:os-quota-sets:update": "rule:admin_api",
"compute_extension:v3:os-quota-sets:delete": "rule:admin_api",
"compute_extension:quota_classes": "",
"compute_extension:v3:os-quota-class-sets": "",
"compute_extension:rescue": "",
"compute_extension:v3:os-rescue": "",
"compute_extension:security_group_default_rules": "rule:admin_api",
"compute_extension:security_groups": "",
"compute_extension:v3:os-security-groups": "",
"compute_extension:server_diagnostics": "rule:admin_api",
"compute_extension:v3:os-server-diagnostics": "rule:admin_api",
"compute_extension:server_password": "",
"compute_extension:v3:os-server-password": "",
"compute_extension:server_usage": "",
"compute_extension:v3:os-server-usage": "",
"compute_extension:services": "rule:admin_api",
"compute_extension:v3:os-services": "rule:admin_api",
"compute_extension:v3:servers:discoverable": "",
"compute_extension:shelve": "",
"compute_extension:shelveOffload": "rule:admin_api",
"compute_extension:v3:os-shelve:shelve": "",
"compute_extension:v3:os-shelve:shelve_offload": "rule:admin_api",
"compute_extension:simple_tenant_usage:show": "rule:admin_or_owner",
380
CHAPTER 4. DASHBOARD
"compute_extension:v3:os-simple-tenant-usage:show":
"rule:admin_or_owner",
"compute_extension:simple_tenant_usage:list": "rule:admin_api",
"compute_extension:v3:os-simple-tenant-usage:list": "rule:admin_api",
"compute_extension:unshelve": "",
"compute_extension:v3:os-shelve:unshelve": "",
"compute_extension:users": "rule:admin_api",
"compute_extension:virtual_interfaces": "",
"compute_extension:virtual_storage_arrays": "",
"compute_extension:volumes": "",
"compute_extension:volume_attachments:index": "",
"compute_extension:volume_attachments:show": "",
"compute_extension:volume_attachments:create": "",
"compute_extension:volume_attachments:update": "",
"compute_extension:volume_attachments:delete": "",
"compute_extension:volumetypes": "",
"compute_extension:availability_zone:list": "",
"compute_extension:v3:os-availability-zone:list": "",
"compute_extension:availability_zone:detail": "rule:admin_api",
"compute_extension:v3:os-availability-zone:detail": "rule:admin_api",
"compute_extension:used_limits_for_admin": "rule:admin_api",
"compute_extension:v3:os-used-limits": "",
"compute_extension:v3:os-used-limits:tenant": "rule:admin_api",
"compute_extension:migrations:index": "rule:admin_api",
"compute_extension:v3:os-migrations:index": "rule:admin_api",
"volume:create": "",
"volume:get_all": "",
"volume:get_volume_metadata": "",
"volume:get_snapshot": "",
"volume:get_all_snapshots": "",
"volume_extension:types_manage": "rule:admin_api",
"volume_extension:types_extra_specs": "rule:admin_api",
"volume_extension:volume_admin_actions:reset_status":
"rule:admin_api",
"volume_extension:snapshot_admin_actions:reset_status":
"rule:admin_api",
"volume_extension:volume_admin_actions:force_delete":
"rule:admin_api",
"network:get_all": "",
"network:get": "",
"network:create": "",
"network:delete": "",
"network:associate": "",
"network:disassociate": "",
"network:get_vifs_by_instance": "",
"network:allocate_for_instance": "",
"network:deallocate_for_instance": "",
"network:validate_networks": "",
"network:get_instance_uuids_by_ip_filter": "",
"network:get_instance_id_by_floating_address": "",
"network:setup_networks_on_host": "",
"network:get_backdoor_port": "",
"network:get_floating_ip": "",
"network:get_floating_ip_pools": "",
"network:get_floating_ip_by_address": "",
"network:get_floating_ips_by_project": "",
381
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"network:get_floating_ips_by_fixed_address": "",
"network:allocate_floating_ip": "",
"network:deallocate_floating_ip": "",
"network:associate_floating_ip": "",
"network:disassociate_floating_ip": "",
"network:release_floating_ip": "",
"network:migrate_instance_start": "",
"network:migrate_instance_finish": "",
"network:get_fixed_ip": "",
"network:get_fixed_ip_by_address": "",
"network:add_fixed_ip_to_instance": "",
"network:remove_fixed_ip_from_instance": "",
"network:add_network_to_project": "",
"network:get_instance_nw_info": "",
"network:get_dns_domains": "",
"network:add_dns_entry": "",
"network:modify_dns_entry": "",
"network:delete_dns_entry": "",
"network:get_dns_entries_by_address": "",
"network:get_dns_entries_by_name": "",
"network:create_private_dns_domain": "",
"network:create_public_dns_domain": "",
"network:delete_dns_domain": ""
}
4.4. DASHBOARD LOG FILES
The dashboard is served to users through the Apache web server (httpd).
As a result, dashboard-related logs appear in files in the /var/log/httpd directory on the system where the dashboard is hosted. The following table describes these files:
Table 4.1. Dashboard/httpd log files
Log file
access_log error_log
Description
Logs all attempts to access the web server.
Logs all unsuccessful attempts to access the web server, along with the reason that each attempt failed.
382
CHAPTER 5. DATABASE SERVICE
CHAPTER 5. DATABASE SERVICE
The Database service provides a scalable and reliable Cloud Database-as-a-Service functionality for both relational and non-relational database engines.
The following tables provide a comprehensive list of the Database service configuration options.
Table 5.1. Description of API configuration options
Description Configuration option = Default value
[DEFAULT] admin_roles
= admin
api_paste_config
= api-paste.ini
bind_host
= 0.0.0.0
bind_port
= 8779
black_list_regex
= None
db_api_implementation
=
trove.db.sqlalchemy.api
hostname_require_valid_ip
= True
http_delete_rate
= 200
http_get_rate
= 200
http_mgmt_post_rate
= 200
http_post_rate
= 200
http_put_rate
= 200
injected_config_location
=
/etc/trove/conf.d
(ListOpt) Roles to add to an admin user.
(StrOpt) File name for the paste.deploy config for trove-api.
(StrOpt) IP address the API server will listen on.
(IntOpt) Port the API server will listen on.
(StrOpt) Exclude IP addresses that match this regular expression.
(StrOpt) API Implementation for Trove database access.
(BoolOpt) Require user hostnames to be valid IP addresses.
(IntOpt) Maximum number of HTTP 'DELETE' requests (per minute).
(IntOpt) Maximum number of HTTP 'GET' requests
(per minute).
(IntOpt) Maximum number of management HTTP
'POST' requests (per minute).
(IntOpt) Maximum number of HTTP 'POST' requests (per minute).
(IntOpt) Maximum number of HTTP 'PUT' requests
(per minute).
(StrOpt) Path to folder on the Guest where config files will be injected during instance creation.
383
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value instances_page_size
= 20
max_header_line
= 16384
os_region_name region
= RegionOne
= LOCAL_DEV
tcp_keepidle
= 600
trove_api_workers trove_auth_url
= None
= http://0.0.0.0:5000/v2.0
trove_conductor_workers
= None
trove_security_group_name_prefix
SecGroup
trove_security_group_rule_cidr
=
0.0.0.0/0
=
Description
(IntOpt) Page size for listing instances.
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
(StrOpt) Region name of this node. Used when searching catalog.
(StrOpt) The region this service is located.
(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on
OS X.
(IntOpt) Number of workers for the API service.
The default will be the number of CPUs available.
(StrOpt) Trove authentication URL.
(IntOpt) Number of workers for the Conductor service. The default will be the number of CPUs available.
(StrOpt) Prefix to use when creating Security
Groups.
(StrOpt) CIDR to use when creating Security Group
Rules.
trove_security_groups_support
= True (BoolOpt) Whether Trove should add Security
Groups on create.
users_page_size
= 20 (IntOpt) Page size for listing users.
Table 5.2. Description of authorization token configuration options
Description Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
(StrOpt) Service user password.
(StrOpt) Service tenant name.
384
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value admin_token
= None
admin_user auth_port auth_protocol auth_section cache
= None
cafile
= None
certfile
= None
auth_admin_prefix auth_host auth_plugin auth_uri
= 127.0.0.1
= None
= 35357
= None
auth_version
= None
=
= https
= None
= None
check_revocations_for_cached
= False
delay_auth_decision
= False
Description
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
385
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value enforce_token_bind
= permissive
hash_algorithms identity_uri insecure keyfile
= False
= None
= md5
http_connect_timeout
= None
http_request_max_retries
= None
include_service_catalog
= True
memcache_pool_conn_get_timeout
= 10
memcache_pool_dead_retry
= 3
= 300
Description
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times are we trying to reconnect when communicating with Identity API
Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
386
Configuration option = Default value memcache_pool_maxsize
= 10
memcache_pool_socket_timeout
= 3
memcache_pool_unused_timeout
= 60
memcache_secret_key memcache_security_strategy memcache_use_advanced_pool revocation_cache_time signing_dir
= None
token_cache_time
= None
= 300
= 10
= None
= False
CHAPTER 5. DATABASE SERVICE
Description
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
Table 5.3. Description of backup configuration options
Description Configuration option = Default value
[DEFAULT]
387
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description backup_aes_cbc_key
= default_aes_cbc_key (StrOpt) Default OpenSSL aes_cbc key.
backup_chunk_size
= 65536 (IntOpt) Chunk size (in bytes) to stream to the Swift container. This should be in multiples of 128 bytes, since this is the size of an md5 digest block allowing the process to update the file checksum during streaming. See: http://stackoverflow.com/questions/1131220/
backup_runner
=
trove.guestagent.backup.backup_types.InnoBacku
pEx
(StrOpt) Runner to use for backups.
backup_runner_options
= {}
backup_segment_max_size
= 2147483648
(DictOpt) Additional options to be passed to the backup runner.
(IntOpt) Maximum size (in bytes) of each segment of the backup file.
backup_swift_container
=
database_backups
(StrOpt) Swift container to put backups in.
backup_use_gzip_compression
= True (BoolOpt) Compress backups using gzip.
backup_use_openssl_encryption
= True (BoolOpt) Encrypt backups using OpenSSL.
(BoolOpt) Send backup files over snet.
backup_use_snet
= False
backups_page_size
= 20 (IntOpt) Page size for listing backups.
Table 5.4. Description of CA and SSL configuration options
Description Configuration option = Default value
[ssl] ca_file
= None
cert_file key_file
= None
= None
(StrOpt) CA certificate file to use to verify connecting clients
(StrOpt) Certificate file to use when starting the server securely
(StrOpt) Private key file to use when starting the server securely
Table 5.5. Description of clients configuration options
388
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value
[DEFAULT] remote_cinder_client
=
trove.common.remote.cinder_client
remote_dns_client
=
trove.common.remote.dns_client
remote_guest_client
=
trove.common.remote.guest_client
remote_heat_client
=
trove.common.remote.heat_client
remote_neutron_client
=
trove.common.remote.neutron_client
remote_nova_client
=
trove.common.remote.nova_client
remote_swift_client
=
trove.common.remote.swift_client
Description
(StrOpt) Client to send Cinder calls to.
(StrOpt) Client to send DNS calls to.
(StrOpt) Client to send Guest Agent calls to.
(StrOpt) Client to send Heat calls to.
(StrOpt) Client to send Neutron calls to.
(StrOpt) Client to send Nova calls to.
(StrOpt) Client to send Swift calls to.
Table 5.6. Description of cluster configuration options
Description Configuration option = Default value
[DEFAULT] cluster_delete_time_out
= 180
cluster_usage_timeout clusters_page_size
= 675
= 20
(IntOpt) Maximum time (in seconds) to wait for a cluster delete.
(IntOpt) Maximum time (in seconds) to wait for a cluster to become active.
(IntOpt) Page size for listing clusters.
Table 5.7. Description of common configuration options
Description Configuration option = Default value
[DEFAULT] configurations_page_size
= 20 (IntOpt) Page size for listing configurations.
389
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value databases_page_size
= 20
default_datastore
= None
default_neutron_networks default_password_length host
= 0.0.0.0
memcached_servers pybasedir
= /usr/lib/python/site-
packages/trove/trove
pydev_path
= None
taskmanager_queue
= taskmanager
template_path
= /etc/trove/templates/
usage_timeout
= 600
= None
=
= 36
expected_filetype_suffixes
= json
Description
(IntOpt) Page size for listing databases.
(StrOpt) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance create request.
(ListOpt) List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create
API call.
(IntOpt) Character length of generated passwords.
(ListOpt) Filetype endings not to be reattached to an ID by the utils method correct_id_with_req.
(StrOpt) Host to listen for RPC messages.
(ListOpt) Memcached servers or None for in process cache.
(StrOpt) Directory where the Trove python module is installed.
(StrOpt) Set path to pydevd library, used if pydevd is not found in python sys.path.
(StrOpt) Message queue name the Taskmanager will listen to.
(StrOpt) Path which leads to datastore templates.
(IntOpt) Maximum time (in seconds) to wait for a
Guest to become active.
[keystone_authtoken] memcached_servers
= None (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Table 5.8. Description of Compute configuration options
Description Configuration option = Default value
[DEFAULT]
390
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value ip_regex
= None
nova_compute_endpoint_type
=
publicURL
nova_compute_service_type
= compute
nova_compute_url root_grant
= ALL
= None
root_grant_option
= True
Description
(StrOpt) List IP addresses that match this regular expression.
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) Service type to use when searching catalog.
(StrOpt) URL without the tenant segment.
(ListOpt) Permissions to grant to the 'root' user.
(BoolOpt) Assign the 'root' user GRANT permissions.
Table 5.9. Description of logging configuration options
Description Configuration option = Default value
[DEFAULT] backdoor_port
= None
backlog
= 4096
pydev_debug
= disabled
pydev_debug_host
= None
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
(IntOpt) Number of backlog requests to configure the socket with
(StrOpt) Enable or disable pydev remote debugging. If value is 'auto' tries to connect to remote debugger server, but in case of error continues running with debugging disabled.
(StrOpt) Pydev debug server host (localhost by default).
(IntOpt) Pydev debug server port (5678 by default).
pydev_debug_port
= None
[profiler] enabled
= False (BoolOpt) If False fully disable profiling feature.
391
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value trace_sqlalchemy
= True
Description
(BoolOpt) If False doesn't trace SQL requests.
Table 5.10. Description of DNS configuration options
Description Configuration option = Default value
[DEFAULT] dns_account_id
=
dns_auth_url
=
dns_domain_id
=
dns_domain_name
=
dns_driver
= trove.dns.driver.DnsDriver
dns_endpoint_url
= 0.0.0.0
dns_hostname
=
dns_instance_entry_factory
=
trove.dns.driver.DnsInstanceEntryFactory
dns_management_base_url
=
dns_passkey
=
dns_region
=
dns_service_type
=
dns_time_out
= 120
dns_ttl
= 300
dns_username
=
trove_dns_support
= False
(StrOpt) Tenant ID for DNSaaS.
(StrOpt) Authentication URL for DNSaaS.
(StrOpt) Domain ID used for adding DNS entries.
(StrOpt) Domain name used for adding DNS entries.
(StrOpt) Driver for DNSaaS.
(StrOpt) Endpoint URL for DNSaaS.
(StrOpt) Hostname used for adding DNS entries.
(StrOpt) Factory for adding DNS entries.
(StrOpt) Management URL for DNSaaS.
(StrOpt) Passkey for DNSaaS.
(StrOpt) Region name for DNSaaS.
(StrOpt) Service Type for DNSaaS.
(IntOpt) Maximum time (in seconds) to wait for a
DNS entry add.
(IntOpt) Time (in seconds) before a refresh of DNS information occurs.
(StrOpt) Username for DNSaaS.
(BoolOpt) Whether Trove should add DNS entries on create (using Designate DNSaaS).
392
Table 5.11. Description of guest agent configuration options
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value
[DEFAULT] agent_call_high_timeout
= 60
Description agent_call_low_timeout agent_heartbeat_expiry
= 5
= 60
(IntOpt) Maximum time (in seconds) to wait for
Guest Agent 'slow' requests (such as restarting the database).
(IntOpt) Maximum time (in seconds) to wait for
Guest Agent 'quick'requests (such as retrieving a list of users or databases).
(IntOpt) Time (in seconds) after which a guest is considered unreachable
agent_heartbeat_time
= 10 (IntOpt) Maximum time (in seconds) for the Guest
Agent to reply to a heartbeat request.
agent_replication_snapshot_timeout
= 36000
(IntOpt) Maximum time (in seconds) to wait for taking a Guest Agent replication snapshot.
guest_config
= /etc/trove/trove-
guestagent.conf
(StrOpt) Path to the Guest Agent config file to be injected during instance creation.
(StrOpt) ID of the Guest Instance.
guest_id
= None
guest_info
= guest_info.conf (StrOpt) The guest info filename found in the injected config location. If a full path is specified then it will be used as the path to the guest info file
ignore_dbs
= lost+found,
#mysql50#lost+found, mysql, information_schema
ignore_users
= os_admin, root
mount_options
= defaults,noatime
storage_namespace
=
trove.guestagent.strategies.storage.swift
storage_strategy
= SwiftStorage
usage_sleep_time
= 5
(ListOpt) Databases to exclude when listing databases.
(ListOpt) Users to exclude when listing users.
(StrOpt) Options to use when mounting a volume.
(StrOpt) Namespace to load the default storage strategy from.
(StrOpt) Default strategy to store backups.
(IntOpt) Time to sleep during the check for an active Guest.
Table 5.12. Description of Orchestration module configuration options
393
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] heat_endpoint_type
= publicURL
heat_service_type heat_time_out heat_url
= 60
= None
= orchestration
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) Service type to use when searching catalog.
(IntOpt) Maximum time (in seconds) to wait for a
Heat request to complete.
(StrOpt) URL without the tenant segment.
Table 5.13. Description of logging configuration options
Configuration option = Default value Description
[DEFAULT] debug
= False (BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
default_log_levels
= 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, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN
(ListOpt) List of logger=LEVEL pairs.
fatal_deprecations
= False
format_options
= -m 5
instance_format
= "[instance: %(uuid)s] "
instance_uuid_format
(uuid)s] "
log_config_append
= "[instance: %
= None
(BoolOpt) Enables or disables fatal status of deprecations.
(StrOpt) Options to use when formatting a volume.
(StrOpt) The format for an instance that is passed with the log message.
(StrOpt) The format for an instance UUID that is passed with the log message.
(StrOpt) 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.
394
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value Description log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None (StrOpt) (Optional) The base directory used for relative --log-file paths.
log_file
= None
log_format
= None
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
logging_context_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
network_label_regex
= ^private$
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
(StrOpt) Prefix each line of exception output with this format.
publish_errors
= False
syslog_log_facility use_stderr use_syslog
= True
= False
= LOG_USER
(StrOpt) Regular expression to match Trove network labels.
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Log output to standard error.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
395
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value use_syslog_rfc_format
= False
verbose
= False
Description
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 5.14. Description of network configuration options
Description Configuration option = Default value
[DEFAULT] network_driver
=
trove.network.nova.NovaNetwork
neutron_endpoint_type neutron_service_type neutron_url
= None
= publicURL
= network
(StrOpt) Describes the actual network manager used for the management of network attributes
(security groups, floating IPs, etc.).
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) Service type to use when searching catalog.
(StrOpt) URL without the tenant segment.
Table 5.15. Description of nova configuration options
Description Configuration option = Default value
[DEFAULT] nova_proxy_admin_pass
=
nova_proxy_admin_tenant_name
=
nova_proxy_admin_user
=
(StrOpt) Admin password used to connect to Nova.
(StrOpt) Admin tenant used to connect to Nova.
(StrOpt) Admin username used to connect to Nova.
Table 5.16. Description of quota configuration options
396
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value
[DEFAULT] max_accepted_volume_size
= 5
max_backups_per_user
= 50
max_instances_per_user
= 5
max_volumes_per_user
= 20
quota_driver
=
trove.quota.quota.DbQuotaDriver
Description
(IntOpt) Default maximum volume size (in GB) for an instance.
(IntOpt) Default maximum number of backups created by a tenant.
(IntOpt) Default maximum number of instances per tenant.
(IntOpt) Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant.
(StrOpt) Default driver to use for quota checks.
Table 5.17. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
Table 5.18. Description of swift configuration options
Description Configuration option = Default value
[DEFAULT] swift_endpoint_type
= publicURL
swift_service_type
= object-store
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) Service type to use when searching catalog.
397
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value swift_url
= None
Description
(StrOpt) URL ending in AUTH_.
Table 5.19. Description of taskmanager configuration options
Configuration option = Default value
[DEFAULT] cloudinit_location datastore_manager
= /etc/trove/cloudinit
= None
datastore_registry_ext
= {}
exists_notification_ticks
= 360
Description
(StrOpt) Path to folder with cloudinit scripts.
(StrOpt) Manager class in the Guest Agent, set up by the Taskmanager on instance provision.
(DictOpt) Extension for default datastore managers. Allows the use of custom managers for each of the datastores supported by Trove.
(IntOpt) Number of report_intervals to wait between pushing events (see report_interval).
(StrOpt) Transformer for exists notifications.
exists_notification_transformer
=
None
reboot_time_out
= 120
resize_time_out restore_usage_timeout revert_time_out
= 600
= 600
server_delete_time_out state_change_wait_time update_status_on_fail
= 36000
= 60
= 180
= True
(IntOpt) Maximum time (in seconds) to wait for a server reboot.
(IntOpt) Maximum time (in seconds) to wait for a server resize.
(IntOpt) Maximum time (in seconds) to wait for a
Guest instance restored from a backup to become active.
(IntOpt) Maximum time (in seconds) to wait for a server resize revert.
(IntOpt) Maximum time (in seconds) to wait for a server delete.
(IntOpt) Maximum time (in seconds) to wait for a state change.
(BoolOpt) Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout.
398
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value usage_sleep_time
= 5
use_heat
= False
use_nova_server_config_drive
= False
use_nova_server_volume
= False
verify_swift_checksum_on_restore
True
=
Description
(IntOpt) Time to sleep during the check for an active Guest.
(BoolOpt) Use Heat for provisioning.
(BoolOpt) Use config drive for file injection when booting instance.
(BoolOpt) Whether to provision a Cinder volume for the Nova instance.
(BoolOpt) Enable verification of Swift checksum before starting restore. Makes sure the checksum of original backup matches the checksum of the
Swift backup file.
Table 5.20. Description of upgrades configuration options
Description Configuration option = Default value
[upgrade_levels] conductor
= icehouse
guestagent
= icehouse
taskmanager
= icehouse
(StrOpt) Set a version cap for messages sent to conductor services
(StrOpt) Set a version cap for messages sent to guestagent services
(StrOpt) Set a version cap for messages sent to taskmanager services
Table 5.21. Description of volume configuration options
Description Configuration option = Default value
[DEFAULT] block_device_mapping
= vdb
cinder_endpoint_type cinder_service_type
= publicURL
= volumev2
(StrOpt) Block device to map onto the created instance.
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) Service type to use when searching catalog.
399
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value cinder_url
= None
cinder_volume_type
= None
device_path
= /dev/vdb
trove_volume_support volume_fstype
= ext3
volume_time_out
= 60
= True
volume_format_timeout
= 120
Description
(StrOpt) URL without the tenant segment.
(StrOpt) Volume type to use when provisioning a
Cinder volume.
(StrOpt) Device path for volume if volume support is enabled.
(BoolOpt) Whether to provision a Cinder volume for datadir.
(IntOpt) Maximum time (in seconds) to wait for a volume format.
(StrOpt) File system type used to format a volume.
(IntOpt) Maximum time (in seconds) to wait for a volume attach.
5.1. CONFIGURE THE DATABASE
Use the options to configure the used databases:
Table 5.22. Description of database configuration options
Description Configuration option = Default value
[DEFAULT] sql_query_logging
= False
[database] connection
= sqlite:///trove_test.sqlite
idle_timeout
= 3600
query_log
= False
(BoolOpt) Allow insecure logging while executing queries through SQLAlchemy.
(StrOpt) SQL Connection.
(IntOpt) No help text available for this option.
(BoolOpt) No help text available for this option.
Table 5.23. Description of Cassandra database configuration options
400
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value
[cassandra] backup_incremental_strategy
= {}
backup_namespace backup_strategy
= None
device_path
= /dev/vdb
mount_point
= /var/lib/cassandra
replication_strategy
= None
restore_namespace
= None
tcp_ports udp_ports
=
volume_support
= None
= 7000, 7001, 9042, 9160
= True
Description
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(StrOpt) Device path for volume if volume support is enabled.
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.24. Description of Couchbase database configuration options
Configuration option = Default value
[couchbase]
Description backup_incremental_strategy
= {} (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
backup_namespace
=
trove.guestagent.strategies.backup.experimental.c
ouchbase_impl
(StrOpt) Namespace to load backup strategies from.
401
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value backup_strategy
= CbBackup
device_path
= /dev/vdb
mount_point
= /var/lib/couchbase
replication_strategy
= None
restore_namespace
=
trove.guestagent.strategies.restore.experimental.c
ouchbase_impl
root_on_create
= True
Description
(StrOpt) Default strategy to perform backups.
(StrOpt) Device path for volume if volume support is enabled.
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
tcp_ports
21100-21199
udp_ports
= 8091, 8092, 4369, 11209-11211,
=
volume_support
= True
(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instancecreate as the 'password' field.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
[couchdb] backup_incremental_strategy
= {}
backup_namespace backup_strategy device_path mount_point
= None
= None
= /dev/vdb
= /var/lib/couchdb
replication_strategy
= None
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(StrOpt) Device path for volume if volume support is enabled.
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Default strategy for replication.
402
Configuration option = Default value restore_namespace
= None
root_on_create tcp_ports udp_ports
= 5984
=
volume_support
= False
= True
CHAPTER 5. DATABASE SERVICE
Description
(StrOpt) Namespace to load restore strategies from.
(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instancecreate as the "password" field.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.25. Description of DB2 database configuration options
Description Configuration option = Default value
[db2] backup_incremental_strategy
= {}
backup_namespace backup_strategy device_path ignore_users mount_point
= None
= None
= /dev/vdb
= PUBLIC, DB2INST1
= /home/db2inst1/db2inst1
replication_strategy restore_namespace
= None
= None
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(StrOpt) Device path for volume if volume support is enabled.
(ListOpt) No help text available for this option.
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
403
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value root_on_create
= False
tcp_ports udp_ports
= 50000
=
volume_support
= True
Description
(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instancecreate as the 'password' field.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.26. Description of MongoDB database configuration options
Configuration option = Default value
[mongodb]
Description api_strategy
=
trove.common.strategies.cluster.experimental.mon
godb.api.MongoDbAPIStrategy
(StrOpt) Class that implements datastore-specific
API logic.
backup_incremental_strategy
= {}
backup_namespace backup_strategy cluster_support device_path
= None
= None
= True
= /dev/vdb
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(BoolOpt) Enable clusters to be created and managed.
(StrOpt) Device path for volume if volume support is enabled.
guestagent_strategy
=
trove.common.strategies.cluster.experimental.mon
godb.guestagent.MongoDbGuestAgentStrategy
(StrOpt) Class that implements datastore-specific
Guest Agent API logic.
404
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value mount_point
= /var/lib/mongodb
num_config_servers_per_cluster num_query_routers_per_cluster
= 3
= 1
Description
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(IntOpt) The number of config servers to create per cluster.
(IntOpt) The number of query routers (mongos) to create per cluster.
replication_strategy restore_namespace
= None
= None
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
taskmanager_strategy
=
trove.common.strategies.cluster.experimental.mon
godb.taskmanager.MongoDbTaskManagerStrateg
y
(StrOpt) Class that implements datastore-specific task manager logic.
tcp_ports
= 2500, 27017
udp_ports
=
volume_support
= True
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UPD ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.27. Description of MySQL database configuration options
Description Configuration option = Default value
[mysql] backup_incremental_strategy
=
{'InnoBackupEx': 'InnoBackupExIncremental'}
backup_namespace
=
trove.guestagent.strategies.backup.mysql_impl
backup_strategy
= InnoBackupEx
device_path
= /dev/vdb
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(StrOpt) Device path for volume if volume support is enabled.
405
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value mount_point
= /var/lib/mysql
replication_namespace
=
trove.guestagent.strategies.replication.mysql_gtid
replication_strategy
=
MysqlGTIDReplication
restore_namespace
=
trove.guestagent.strategies.restore.mysql_impl
root_on_create
= False
tcp_ports udp_ports
= 3306
=
usage_timeout
= 400
volume_support
= True
Description
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Namespace to load replication strategies from.
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instancecreate as the 'password' field.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(IntOpt) Maximum time (in seconds) to wait for a
Guest to become active.
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.28. Description of Percona database configuration options
Description Configuration option = Default value
[percona] backup_incremental_strategy
=
{'InnoBackupEx': 'InnoBackupExIncremental'}
backup_namespace
trove.guestagent.strategies.backup.mysql_impl
backup_strategy
=
= InnoBackupEx
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
406
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value device_path
= /dev/vdb
mount_point tcp_ports udp_ports
=
= /var/lib/mysql
replication_namespace
=
trove.guestagent.strategies.replication.mysql_gtid
replication_password
=
NETOU7897NNLOU
replication_strategy
=
MysqlGTIDReplication
replication_user
= slave_user
restore_namespace
=
trove.guestagent.strategies.restore.mysql_impl
root_on_create
= False
= 3306
usage_timeout
= 450
volume_support
= True
Description
(StrOpt) Device path for volume if volume support is enabled.
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Namespace to load replication strategies from.
(StrOpt) Password for replication slave user.
(StrOpt) Default strategy for replication.
(StrOpt) Userid for replication slave.
(StrOpt) Namespace to load restore strategies from.
(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instancecreate as the 'password' field.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(IntOpt) Maximum time (in seconds) to wait for a
Guest to become active.
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.29. Description of PostgreSQL database configuration options
Description Configuration option = Default value
[postgresql]
407
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value backup_incremental_strategy
= {}
Description
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
backup_namespace
=
trove.guestagent.strategies.backup.experimental.p
ostgresql_impl
(StrOpt) Namespace to load backup strategies from.
backup_strategy
= PgDump
device_path
= /dev/vdb
ignore_dbs
= postgres
ignore_users
= os_admin, postgres, root
mount_point
= /var/lib/postgresql
(StrOpt) Default strategy to perform backups.
(StrOpt) No help text available for this option.
(ListOpt) No help text available for this option.
(ListOpt) No help text available for this option.
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
restore_namespace
=
trove.guestagent.strategies.restore.experimental.p
ostgresql_impl
root_on_create
= False
(StrOpt) Namespace to load restore strategies from.
tcp_ports udp_ports
= 5432
=
volume_support
= True
(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instancecreate as the 'password' field.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UPD ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.30. Description of Redis database configuration options
Description Configuration option = Default value
[redis]
408
Configuration option = Default value backup_incremental_strategy
= {}
backup_namespace udp_ports
= None
backup_strategy
= None
device_path
= None
mount_point
= /var/lib/redis
replication_strategy
= None
restore_namespace
= None
tcp_ports
= 6379
=
volume_support
= False
CHAPTER 5. DATABASE SERVICE
Description
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(StrOpt) Device path for volume if volume support is enabled.
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.31. Description of Vertica database configuration options
Configuration option = Default value
[vertica]
Description api_strategy
=
trove.common.strategies.cluster.experimental.verti
ca.api.VerticaAPIStrategy
(StrOpt) Class that implements datastore-specific
API logic.
backup_incremental_strategy
= {} (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
409
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value backup_namespace
= None
backup_strategy
= None
cluster_member_count
= 3
cluster_support
= True
device_path
= /dev/vdb
Description
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(IntOpt) Number of members in Vertica cluster.
(BoolOpt) Enable clusters to be created and managed.
(StrOpt) Device path for volume if volume support is enabled.
guestagent_strategy
=
trove.common.strategies.cluster.experimental.verti
ca.guestagent.VerticaGuestAgentStrategy
(StrOpt) Class that implements datastore-specific
Guest Agent API logic.
mount_point
= /var/lib/vertica
readahead_size
= 2048
replication_strategy restore_namespace
= None
= None
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(IntOpt) Size(MB) to be set as readahead_size for data volume
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
taskmanager_strategy
=
trove.common.strategies.cluster.experimental.verti
ca.taskmanager.VerticaTaskManagerStrategy
(StrOpt) Class that implements datastore-specific task manager logic.
tcp_ports
= 5433, 5434, 22, 5444, 5450, 4803
udp_ports
= 5433, 4803, 4804, 6453
volume_support
= True
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
410
5.2. CONFIGURE THE RPC MESSAGING SYSTEM
OpenStack projects use an open standard for messaging middleware known as AMQP. This messaging middleware enables the OpenStack services that run on multiple servers to talk to each other. OpenStack Trove RPC supports two implementations of AMQP: RabbitMQ and Qpid.
CHAPTER 5. DATABASE SERVICE
5.2.1. Configure RabbitMQ
Use these options to configure the RabbitMQ messaging system:
Table 5.32. Description of RabbitMQ configuration options
Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
amqp_durable_queues
= False
fake_rabbit
= False
Description heartbeat_rate
= 2
heartbeat_timeout_threshold
= 0
kombu_reconnect_delay
= 1.0
kombu_ssl_ca_certs
=
kombu_ssl_certfile
=
kombu_ssl_keyfile
=
kombu_ssl_version
=
rabbit_ha_queues
= False
rabbit_host
= localhost
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
411
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rabbit_hosts
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_password
= guest
rabbit_port
= 5672
rabbit_retry_backoff
= 2
rabbit_retry_interval
= 1
rabbit_use_ssl
= False
rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
5.2.2. Configure Qpid
Use these options to configure the Qpid messaging system:
Table 5.33. Description of Qpid configuration options
Description
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
Description Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname
= localhost
qpid_hosts
= $qpid_hostname:$qpid_port
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
412
Configuration option = Default value qpid_password
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity
= 1
qpid_sasl_mechanisms
=
qpid_tcp_nodelay
= True
qpid_topology_version
= 1
Description
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
qpid_username
=
rpc_conn_pool_size
= 30
5.2.3. Configure messaging
Use these common options to configure the RabbitMQ, and Qpid messaging drivers:
Table 5.34. Description of AMQP configuration options
Description
CHAPTER 5. DATABASE SERVICE
Configuration option = Default value
[DEFAULT] conductor_manager
=
trove.conductor.manager.Manager
conductor_queue
= trove-conductor
control_exchange
= openstack
(StrOpt) Qualified class name to use for conductor manager.
(StrOpt) Message queue name the Conductor will listen on.
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
413
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value notification_driver
= []
notification_service_id
= {'vertica':
'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae', 'db2':
'e040cd37-263d-4869-aaa6-c62aa97523b5',
'postgresql': 'ac277e0d-4f21-40aa-b347-
1ea31e571720', 'mysql': '2f3ff068-2bfb-4f70-9a9da6bb65bc084b', 'couchbase': 'fa62fe68-74d9-
4779-a24e-36f19602c415', 'mongodb': 'c8c907af-
7375-456f-b929-b637ff9209ee', 'couchdb':
'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'redis':
'b216ffc5-1947-456c-a4cf-70f94c05f7d0',
'cassandra': '459a230d-4e97-4344-9067-
2a54a310b0ed'}
notification_topics
= notifications
transport_url
= None
Description
(MultiStrOpt) Driver or drivers to handle sending notifications.
(DictOpt) Unique ID to tag notification events.
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
Table 5.35. Description of RPC configuration options
Description Configuration option = Default value
[DEFAULT] matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
num_tries
= 3
report_interval rpc_backend
= 10
= rabbit
rpc_cast_timeout
= 30
rpc_response_timeout
= 60
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(IntOpt) Number of times to check if a volume exists.
(IntOpt) The interval (in seconds) which periodic tasks are run.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
414
Configuration option = Default value rpc_thread_pool_size
= 64
[oslo_messaging_amqp] allow_insecure_clients
= False
broadcast_prefix
= broadcast
container_name
= None
group_request_prefix
= unicast
idle_timeout
= 0
server_request_prefix
= exclusive
ssl_ca_file
=
ssl_cert_file
=
ssl_key_file
=
ssl_key_password
= None
trace
= False
CHAPTER 5. DATABASE SERVICE
Description
(IntOpt) Size of RPC thread pool.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
5.3. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
DATABASE SERVICE
Table 5.36. New options
Option = default value
[DEFAULT] agent_heartbeat_expiry = 60
(Type) Help string
(IntOpt) Time (in seconds) after which a guest is considered unreachable
415
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] cinder_endpoint_type = publicURL
[DEFAULT] guest_info = guest_info.conf
[DEFAULT] heat_endpoint_type = publicURL
[DEFAULT] injected_config_location =
/etc/trove/conf.d
[DEFAULT] neutron_endpoint_type = publicURL
[DEFAULT] nova_compute_endpoint_type = publicURL
[DEFAULT] swift_endpoint_type = publicURL
[DEFAULT] transport_url = None
[couchdb] backup_incremental_strategy = {}
[couchdb] backup_namespace = None
[couchdb] backup_strategy = None
[couchdb] device_path = /dev/vdb
[couchdb] mount_point = /var/lib/couchdb
[couchdb] replication_strategy = None
[couchdb] restore_namespace = None
(Type) Help string
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) The guest info filename found in the injected config location. If a full path is specified then it will be used as the path to the guest info file
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) Path to folder on the Guest where config files will be injected during instance creation.
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) Service endpoint type to use when searching catalog.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(StrOpt) Device path for volume if volume support is enabled.
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
416
CHAPTER 5. DATABASE SERVICE
Option = default value
[couchdb] root_on_create = False
[couchdb] tcp_ports = 5984
[couchdb] udp_ports =
[couchdb] volume_support = True
[database] connection = sqlite:///trove_test.sqlite
[database] idle_timeout = 3600
[database] query_log = False
[db2] backup_incremental_strategy = {}
[db2] backup_namespace = None
[db2] backup_strategy = None
[db2] device_path = /dev/vdb
[db2] ignore_users = PUBLIC, DB2INST1
[db2] mount_point = /home/db2inst1/db2inst1
[db2] replication_strategy = None
[db2] restore_namespace = None
(Type) Help string
(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instancecreate as the "password" field.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
(StrOpt) SQL Connection.
(IntOpt) None
(BoolOpt) None
(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(StrOpt) Device path for volume if volume support is enabled.
(ListOpt) None
(StrOpt) Filesystem path for mounting volumes if volume support is enabled.
(StrOpt) Default strategy for replication.
(StrOpt) Namespace to load restore strategies from.
417
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[db2] root_on_create = False
[db2] tcp_ports = 50000
[db2] udp_ports =
(Type) Help string
(BoolOpt) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instancecreate as the 'password' field.
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
[db2] volume_support = True
[oslo_messaging_amqp] allow_insecure_clients =
False
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
(BoolOpt) Whether to provision a Cinder volume for datadir.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
[oslo_messaging_amqp] ssl_key_file =
[oslo_messaging_amqp] ssl_key_password =
None
[oslo_messaging_amqp] trace = False
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
418
CHAPTER 5. DATABASE SERVICE
Option = default value
[oslo_messaging_qpid] amqp_durable_queues =
False
[oslo_messaging_qpid] qpid_heartbeat = 60
(Type) Help string
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
[oslo_messaging_qpid] qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
[oslo_messaging_qpid] qpid_sasl_mechanisms = (StrOpt) Space separated list of SASL mechanisms to use for auth.
[oslo_messaging_qpid] qpid_tcp_nodelay = True
[oslo_messaging_qpid] qpid_topology_version = 1
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30
[oslo_messaging_rabbit] amqp_auto_delete =
False
[oslo_messaging_rabbit] amqp_durable_queues =
False
[oslo_messaging_rabbit] fake_rabbit = False
(IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_rabbit] heartbeat_rate = 2
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
419
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(Type) Help string
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
[oslo_messaging_rabbit] rabbit_port = 5672
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
[oslo_messaging_rabbit] rabbit_retry_interval = 1
[oslo_messaging_rabbit] rabbit_use_ssl = False
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
420
CHAPTER 5. DATABASE SERVICE
Option = default value
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
[oslo_messaging_rabbit] rpc_conn_pool_size = 30
[profiler] enabled = False
[profiler] trace_sqlalchemy = True
[upgrade_levels] conductor = icehouse
[upgrade_levels] guestagent = icehouse
[upgrade_levels] taskmanager = icehouse
(Type) Help string
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
(BoolOpt) If False fully disable profiling feature.
(BoolOpt) If False doesn't trace SQL requests.
(StrOpt) Set a version cap for messages sent to conductor services
(StrOpt) Set a version cap for messages sent to guestagent services
(StrOpt) Set a version cap for messages sent to taskmanager services
[vertica] api_strategy = trove.common.strategies.cluster.experimental.verti
ca.api.VerticaAPIStrategy
(StrOpt) Class that implements datastore-specific
API logic.
[vertica] backup_incremental_strategy = {} (DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
[vertica] backup_namespace = None
[vertica] backup_strategy = None
[vertica] cluster_member_count = 3
[vertica] cluster_support = True
[vertica] device_path = /dev/vdb
(StrOpt) Namespace to load backup strategies from.
(StrOpt) Default strategy to perform backups.
(IntOpt) Number of members in Vertica cluster.
(BoolOpt) Enable clusters to be created and managed.
(StrOpt) Device path for volume if volume support is enabled.
[vertica] guestagent_strategy = trove.common.strategies.cluster.experimental.verti
ca.guestagent.VerticaGuestAgentStrategy
(StrOpt) Class that implements datastore-specific
Guest Agent API logic.
[vertica] mount_point = /var/lib/vertica (StrOpt) Filesystem path for mounting volumes if volume support is enabled.
421
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[vertica] readahead_size = 2048
(Type) Help string
(IntOpt) Size(MB) to be set as readahead_size for data volume
(StrOpt) Default strategy for replication.
[vertica] replication_strategy = None
[vertica] restore_namespace = None (StrOpt) Namespace to load restore strategies from.
[vertica] taskmanager_strategy = trove.common.strategies.cluster.experimental.verti
ca.taskmanager.VerticaTaskManagerStrategy
(StrOpt) Class that implements datastore-specific task manager logic.
[vertica] tcp_ports = 5433, 5434, 22, 5444, 5450,
4803
[vertica] udp_ports = 5433, 4803, 4804, 6453
[vertica] volume_support = True
(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
(BoolOpt) Whether to provision a Cinder volume for datadir.
Table 5.37. New default values
Option
[DEFAULT] default_log_levels
[DEFAULT] guest_config
[DEFAULT] ignore_dbs
Previous default value New default value amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN
/etc/trove/trove-guestagent.conf
$pybasedir/etc/trove/troveguestagent.conf.sample
lost+found, mysql, information_schema lost+found,
#mysql50#lost+found, mysql, information_schema
422
CHAPTER 5. DATABASE SERVICE
Option
[DEFAULT] notification_service_id
[DEFAULT] os_region_name
[DEFAULT] rpc_backend
[DEFAULT] rpc_zmq_matchmaker
[couchbase] backup_namespace
Previous default value New default value
{'postgresql': 'ac277e0d-4f21-
40aa-b347-1ea31e571720',
'couchbase': 'fa62fe68-74d9-
4779-a24e-36f19602c415',
'mongodb': 'c8c907af-7375-456fb929-b637ff9209ee', 'redis':
'b216ffc5-1947-456c-a4cf-
70f94c05f7d0', 'mysql': '2f3ff068-
2bfb-4f70-9a9d-a6bb65bc084b',
'cassandra': '459a230d-4e97-
4344-9067-2a54a310b0ed'}
{'vertica': 'a8d805ae-a3b2-c4fdgb23-b62cee5201ae', 'db2':
'e040cd37-263d-4869-aaa6c62aa97523b5', 'postgresql':
'ac277e0d-4f21-40aa-b347-
1ea31e571720', 'mysql':
'2f3ff068-2bfb-4f70-9a9da6bb65bc084b', 'couchbase':
'fa62fe68-74d9-4779-a24e-
36f19602c415', 'mongodb':
'c8c907af-7375-456f-b929b637ff9209ee', 'couchdb':
'f0a9ab7b-66f7-4352-93d7-
071521d44c7c', 'redis':
'b216ffc5-1947-456c-a4cf-
70f94c05f7d0', 'cassandra':
'459a230d-4e97-4344-9067-
2a54a310b0ed'}
None trove.openstack.common.rpc.im
pl_kombu
RegionOne rabbit trove.openstack.common.rpc.ma
tchmaker.MatchMakerLocalhost
local trove.guestagent.strategies.back
up.couchbase_impl
trove.guestagent.strategies.back
up.experimental.couchbase_impl
[couchbase] restore_namespace trove.guestagent.strategies.resto
re.couchbase_impl
trove.guestagent.strategies.resto
re.experimental.couchbase_impl
[mongodb] api_strategy trove.common.strategies.mongo
db.api.MongoDbAPIStrategy
trove.common.strategies.cluster.
experimental.mongodb.api.Mong
oDbAPIStrategy
[mongodb] guestagent_strategy
[mongodb] taskmanager_strategy
[mysql] replication_namespace
[mysql] replication_strategy trove.common.strategies.mongo
db.guestagent.MongoDbGuestA
gentStrategy trove.common.strategies.cluster.
experimental.mongodb.guestage
nt.MongoDbGuestAgentStrategy
trove.common.strategies.mongo
db.taskmanager.MongoDbTask
ManagerStrategy trove.common.strategies.cluster.
experimental.mongodb.taskman
ager.MongoDbTaskManagerStra
tegy trove.guestagent.strategies.repli
cation.mysql_binlog
MysqlBinlogReplication trove.guestagent.strategies.repli
cation.mysql_gtid
MysqlGTIDReplication
423
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option
[percona] replication_namespace
[percona] replication_strategy
Previous default value trove.guestagent.strategies.repli
cation.mysql_binlog
MysqlBinlogReplication
New default value trove.guestagent.strategies.repli
cation.mysql_gtid
MysqlGTIDReplication
[postgresql] backup_namespace trove.guestagent.strategies.back
up.postgresql_impl
trove.guestagent.strategies.back
up.experimental.postgresql_impl
[postgresql] restore_namespace trove.guestagent.strategies.resto
re.postgresql_impl
trove.guestagent.strategies.resto
re.experimental.postgresql_impl
Table 5.38. Deprecated options
Deprecated option
[DEFAULT] use_syslog
[rpc_notifier2] topics
[DEFAULT] sql_query_log
[DEFAULT] sql_connection
[DEFAULT] sql_idle_timeout
[DEFAULT] log_format
New Option
None
[DEFAULT] notification_topics
[database] query_log
[database] connection
[database] idle_timeout
None
424
CHAPTER 6. DATA PROCESSING SERVICE
CHAPTER 6. DATA PROCESSING SERVICE
The Data processing service (sahara) provides a scalable data-processing stack and associated management interfaces.
The following tables provide a comprehensive list of the Data processing service configuration options.
Table 6.1. Description of AMQP configuration options
Configuration option = Default value
[DEFAULT] control_exchange
= openstack
Description notification_driver
= []
notification_level
= INFO
notification_publisher_id
= None
notification_topics
= notifications
transport_url
= None
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
(MultiStrOpt) Driver or drivers to handle sending notifications.
(StrOpt) Notification level for outgoing notifications
(StrOpt) Notification publisher_id for outgoing notifications
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
Table 6.2. Description of authorization token configuration options
Description Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
(StrOpt) Service user password.
(StrOpt) Service tenant name.
425
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value admin_token
= None
admin_user auth_port auth_protocol auth_section cache
= None
cafile
= None
certfile
= None
auth_admin_prefix auth_host auth_plugin auth_uri
= 127.0.0.1
= None
= 35357
= None
auth_version
= None
=
= https
= None
= None
check_revocations_for_cached
= False
delay_auth_decision
= False
Description
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
426
CHAPTER 6. DATA PROCESSING SERVICE
Configuration option = Default value enforce_token_bind
= permissive
hash_algorithms identity_uri insecure keyfile
= False
= None
= md5
http_connect_timeout
= None
http_request_max_retries
= None
include_service_catalog
= True
memcache_pool_conn_get_timeout
= 10
memcache_pool_dead_retry
= 3
= 300
Description
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times are we trying to reconnect when communicating with Identity API
Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
427
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value memcache_pool_maxsize
= 10
memcache_pool_socket_timeout memcache_pool_unused_timeout memcache_secret_key memcache_security_strategy memcache_use_advanced_pool revocation_cache_time signing_dir
= None
token_cache_time
= None
= 300
= 10
= 3
= 60
= None
= False
Description
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
Table 6.3. Description of CA and SSL configuration options
Description Configuration option = Default value
[ssl]
428
Configuration option = Default value ca_file
= None
cert_file
= None
key_file
= None
CHAPTER 6. DATA PROCESSING SERVICE
Description
(StrOpt) CA certificate file to use to verify connecting clients.
(StrOpt) Certificate file to use when starting the server securely.
(StrOpt) Private key file to use when starting the server securely.
Table 6.4. Description of clients configuration options
Description Configuration option = Default value
[cinder] api_insecure
= False
api_version ca_file
= 2
= None
(BoolOpt) Allow to perform insecure SSL requests to cinder.
(IntOpt) Version of the Cinder API to use.
(StrOpt) Location of ca certificates file to use for cinder client requests.
[heat] api_insecure
= False
ca_file
= None
(BoolOpt) Allow to perform insecure SSL requests to heat.
(StrOpt) Location of ca certificates file to use for heat client requests.
[keystone] api_insecure
= False
ca_file
= None
(BoolOpt) Allow to perform insecure SSL requests to keystone.
(StrOpt) Location of ca certificates file to use for keystone client requests.
[neutron] api_insecure
= False
ca_file
= None
(BoolOpt) Allow to perform insecure SSL requests to neutron.
(StrOpt) Location of ca certificates file to use for neutron client requests.
429
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[nova] api_insecure
= False
ca_file
= None
(BoolOpt) Allow to perform insecure SSL requests to nova.
(StrOpt) Location of ca certificates file to use for nova client requests.
[swift] api_insecure
= False
ca_file
= None
(BoolOpt) Allow to perform insecure SSL requests to swift.
(StrOpt) Location of ca certificates file to use for swift client requests.
430
Table 6.5. Description of common configuration options
Configuration option = Default value
[DEFAULT] admin_project_domain_name
= default
Description admin_user_domain_name
= default
(StrOpt) The name of the domain for the service project(ex. tenant).
(StrOpt) The name of the domain to which the admin user belongs.
api_workers
= 0
cleanup_time_for_incomplete_cluste rs
= 0
(IntOpt) Maximal time (in hours) for clusters allowed to be in states other than "Active",
"Deleting" or "Error". If a cluster is not in "Active",
"Deleting" or "Error" state and last update of it was longer than
"cleanup_time_for_incomplete_clusters" hours ago then it will be deleted automatically. (0 value means that automatic clean up is disabled).
cluster_remote_threshold
= 70
(IntOpt) Number of workers for Sahara API service
(0 means all-in-one-thread configuration).
(IntOpt) The same as global_remote_threshold, but for a single cluster.
compute_topology_file
=
etc/sahara/compute.topology
disable_event_log
= False
(StrOpt) File with nova compute topology. It should contain mapping between nova computes and racks.
(BoolOpt) Disables event log feature.
CHAPTER 6. DATA PROCESSING SERVICE
Configuration option = Default value enable_data_locality
= False
enable_hypervisor_awareness enable_notifications global_remote_threshold infrastructure_engine job_binary_max_KB
= 5120
job_canceling_timeout job_workflow_postfix max_header_line
= 16384
memcached_servers node_domain
= novalocal
os_region_name
= None
= False
=
= direct
= None
= 100
= 300
= True
min_transient_cluster_active_time
= 30
Description
(BoolOpt) Enables data locality for hadoop cluster.
Also enables data locality for Swift used by hadoop.
If enabled, 'compute_topology' and 'swift_topology' configuration parameters should point to
OpenStack and Swift topology correspondingly.
(BoolOpt) Enables four-level topology for data locality. Works only if corresponding plugin supports such mode.
(BoolOpt) Enables sending notifications to
Ceilometer
(IntOpt) Maximum number of remote operations that will be running at the same time. Note that each remote operation requires its own process to run.
(StrOpt) An engine which will be used to provision infrastructure for Hadoop cluster.
(IntOpt) Maximum length of job binary data in kilobytes that may be stored or retrieved in a single operation.
(IntOpt) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time.
(StrOpt) Postfix for storing jobs in hdfs. Will be added to '/user/<hdfs user>/' path.
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
(ListOpt) Memcached servers or None for in process cache.
(IntOpt) Minimal "lifetime" in seconds for a transient cluster. Cluster is guaranteed to be "alive" within this time period.
(StrOpt) The suffix of the node's FQDN. In novanetwork that is the dhcp_domain config parameter.
(StrOpt) Region name used to get services endpoints.
431
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value periodic_enable
= True
periodic_fuzzy_delay
= 60
periodic_interval_max plugins remote
= 60
= vanilla, hdp, spark, cdh
proxy_command
= ssh
=
rootwrap_command
= sudo sahara-rootwrap
/etc/sahara/rootwrap.conf
run_external_periodic_tasks
= True
swift_topology_file
etc/sahara/swift.topology
use_floating_ips use_identity_api_v3
=
use_external_key_manager
= True
= True
= False
Description
(BoolOpt) Enable periodic tasks.
(IntOpt) Range in seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0).
(IntOpt) Max interval size between periodic tasks execution in seconds.
(ListOpt) List of plugins to be loaded. Sahara preserves the order of the list when returning it.
(StrOpt) Proxy command used to connect to instances. If set, this command should open a netcat socket, that Sahara will use for SSH and
HTTP connections. Use {host} and {port} to describe the destination. Other available keywords:
{tenant_id}, {network_id}, {router_id}.
(StrOpt) A method for Sahara to execute commands on VMs.
(StrOpt) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True
(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?
(StrOpt) File with Swift topology.It should contain mapping between Swift nodes and racks.
(BoolOpt) Enable Sahara to use an external key manager service provided by the identity service catalog. Sahara will store all keys with the manager service.
(BoolOpt) If set to True, Sahara will use floating IPs to communicate with instances. To make sure that all instances have floating IPs assigned in Nova
Network set "auto_assign_floating_ip=True" in nova.conf. If Neutron is used for networking, make sure that all Node Groups have "floating_ip_pool" parameter defined.
(BoolOpt) Enables Sahara to use Keystone API v3.
If that flag is disabled, per-job clusters will not be terminated automatically.
432
Configuration option = Default value use_namespaces
= False
use_neutron
= False
use_rootwrap
= False
CHAPTER 6. DATA PROCESSING SERVICE
Description
(BoolOpt) Use network namespaces for communication (only valid to use in conjunction with use_neutron=True).
(BoolOpt) Use Neutron Networking (False indicates the use of Nova networking).
(BoolOpt) Use rootwrap facility to allow non-root users to run the sahara-all server instance and access private network IPs (only valid to use in conjunction with use_namespaces=True)
[conductor] use_local
= True
[keystone_authtoken] memcached_servers
= None
(BoolOpt) Perform sahara-conductor operations locally.
(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Table 6.6. Description of database configuration options
Description Configuration option = Default value
[DEFAULT] db_driver
= sahara.db
[database] backend
= sqlalchemy
connection
= None
(StrOpt) Driver to use for database access.
connection_debug connection_trace
= 0
= False
db_inc_retry_interval
= True
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
433
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value db_max_retries
= 20
db_max_retry_interval db_retry_interval idle_timeout max_overflow max_pool_size max_retries
= 10
min_pool_size mysql_sql_mode pool_timeout
= None
= None
retry_interval
= 10
slave_connection sqlite_db
= 3600
= None
= 1
= 1
= 10
= TRADITIONAL
= None
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
Description
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
434
CHAPTER 6. DATA PROCESSING SERVICE
Table 6.7. Description of domain configuration options
Description Configuration option = Default value
[DEFAULT] proxy_user_domain_name
= None
proxy_user_role_names
= Member
use_domain_for_proxy_users
= False
(StrOpt) The domain Sahara will use to create new proxy users for Swift object access.
(ListOpt) A list of the role names that the proxy user should assume through trust for Swift object access.
(BoolOpt) Enables Sahara to use a domain for creating temporary proxy users to access Swift. If this is enabled a domain must be created for
Sahara to use.
Table 6.8. Description of logging configuration options
Configuration option = Default value
[DEFAULT] debug
= False
instance_format
= "[instance: %(uuid)s] "
instance_uuid_format
(uuid)s] "
log_config_append
= "[instance: %
= None
Description default_log_levels
= amqplib=WARN,
qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN, oslo_messaging=INFO
fatal_deprecations
= False
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
(ListOpt) List of logger=LEVEL pairs.
(BoolOpt) Enables or disables fatal status of deprecations.
(StrOpt) The format for an instance that is passed with the log message.
(StrOpt) The format for an instance UUID that is passed with the log message.
(StrOpt) 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.
435
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None (StrOpt) (Optional) The base directory used for relative --log-file paths.
log_file
= None (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None
log_config_append
= None
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None
log_file
= None
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
logging_context_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
436
CHAPTER 6. DATA PROCESSING SERVICE
Configuration option = Default value logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
Description
(StrOpt) Prefix each line of exception output with this format.
syslog_log_facility
= LOG_USER
syslog_log_facility
= LOG_USER
use_syslog
= False
use_syslog_rfc_format use_stderr use_syslog
= True
= False
use_syslog_rfc_format verbose
= False
= False
= False
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Log output to standard error.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 6.9. Description of oslo_middleware configuration options
Description Configuration option = Default value
[oslo_middleware] max_request_body_size
= 114688 (IntOpt) The maximum body size for each request, in bytes.
Table 6.10. Description of policy configuration options
437
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[oslo_policy] policy_default_rule
= default
policy_dirs policy_file
= ['policy.d']
= policy.json
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
Table 6.11. Description of Qpid configuration options
Description Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname
= localhost
qpid_hosts
= $qpid_hostname:$qpid_port
qpid_password
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity
= 1
qpid_sasl_mechanisms
=
qpid_tcp_nodelay
= True
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
438
Configuration option = Default value qpid_topology_version
= 1
CHAPTER 6. DATA PROCESSING SERVICE
Description
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
qpid_username
=
rpc_conn_pool_size
= 30
Table 6.12. Description of RabbitMQ configuration options
Description Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
amqp_durable_queues
= False
fake_rabbit
= False
heartbeat_rate
= 2
heartbeat_timeout_threshold kombu_reconnect_delay kombu_ssl_ca_certs kombu_ssl_certfile kombu_ssl_keyfile
=
=
=
= 1.0
= 0
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
439
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value kombu_ssl_version
=
rabbit_ha_queues rabbit_host
= localhost
rabbit_hosts rabbit_port
= False
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_password
= guest
= 5672
rabbit_retry_backoff
= 2
rabbit_retry_interval rabbit_use_ssl
= False
rabbit_userid
= guest
= 1
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
Description
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
Table 6.13. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
440
Configuration option = Default value port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
CHAPTER 6. DATA PROCESSING SERVICE
Description
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
Table 6.14. Description of RPC configuration options
Description Configuration option = Default value
[DEFAULT] matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
rpc_cast_timeout
= 30
rpc_response_timeout rpc_thread_pool_size
[oslo_messaging_amqp]
= 60
= 64
allow_insecure_clients
= False
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
(IntOpt) Size of RPC thread pool.
broadcast_prefix container_name idle_timeout ssl_ca_file
=
= broadcast
= None
group_request_prefix
= 0
= unicast
server_request_prefix
= exclusive
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
441
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value ssl_cert_file
=
ssl_key_file trace
= False
=
ssl_key_password
= None
Description
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
Table 6.15. Description of timeouts configuration options
Configuration option = Default value
[timeouts] await_attach_volumes
= 10
Description await_for_instances_active
= 10800
delete_instances_timeout detach_volume_timeout ips_assign_timeout
= 300
= 10800
volume_available_timeout wait_until_accessible
= 10800
= 10800
= 10800
(IntOpt) Wait for attaching volumes to instances, in seconds
(IntOpt) Wait for instances to become active, in seconds
(IntOpt) Wait for instances to be deleted, in seconds
(IntOpt) Timeout for detaching volumes from instance, in seconds
(IntOpt) Assign IPs timeout, in seconds
(IntOpt) Wait for volumes to become available, in seconds
(IntOpt) Wait for instance accessibility, in seconds
6.1. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
DATA PROCESSING SERVICE
Table 6.16. New options
442
CHAPTER 6. DATA PROCESSING SERVICE
Option = default value
[DEFAULT] admin_project_domain_name = default
[DEFAULT] admin_user_domain_name = default
[DEFAULT] api_workers = 0 (IntOpt) Number of workers for Sahara API service
(0 means all-in-one-thread configuration).
[DEFAULT] cleanup_time_for_incomplete_clusters
= 0
(IntOpt) Maximal time (in hours) for clusters allowed to be in states other than "Active",
"Deleting" or "Error". If a cluster is not in "Active",
"Deleting" or "Error" state and last update of it was longer than
"cleanup_time_for_incomplete_clusters" hours ago then it will be deleted automatically. (0 value means that automatic clean up is disabled).
[DEFAULT] disable_event_log = False
[DEFAULT] job_canceling_timeout = 300
(Type) Help string
(StrOpt) The name of the domain for the service project(ex. tenant).
(StrOpt) The name of the domain to which the admin user belongs.
[DEFAULT] log-config-append = None
[DEFAULT] log-date-format = %Y-%m-%d
%H:%M:%S
[DEFAULT] log-dir = None
[DEFAULT] log-file = None
[DEFAULT] log-format = None
(BoolOpt) Disables event log feature.
(IntOpt) Timeout for canceling job execution (in seconds). Sahara will try to cancel job execution during this time.
(StrOpt) 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.
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
443
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] max_header_line = 16384
[DEFAULT] proxy_command =
[DEFAULT] rootwrap_command = sudo sahararootwrap /etc/sahara/rootwrap.conf
[DEFAULT] syslog-log-facility = LOG_USER
[DEFAULT] use-syslog = False
[DEFAULT] use-syslog-rfc-format = False
[DEFAULT] use_external_key_manager = False
[DEFAULT] use_rootwrap = False
[cinder] api_insecure = False
[cinder] api_version = 2
[cinder] ca_file = None
[heat] api_insecure = False
(Type) Help string
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
(StrOpt) Proxy command used to connect to instances. If set, this command should open a netcat socket, that Sahara will use for SSH and
HTTP connections. Use {host} and {port} to describe the destination. Other available keywords:
{tenant_id}, {network_id}, {router_id}.
(StrOpt) Rootwrap command to leverage. Use in conjunction with use_rootwrap=True
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Enable Sahara to use an external key manager service provided by the identity service catalog. Sahara will store all keys with the manager service.
(BoolOpt) Use rootwrap facility to allow non-root users to run the sahara-all server instance and access private network IPs (only valid to use in conjunction with use_namespaces=True)
(BoolOpt) Allow to perform insecure SSL requests to cinder.
(IntOpt) Version of the Cinder API to use.
(StrOpt) Location of ca certificates file to use for cinder client requests.
(BoolOpt) Allow to perform insecure SSL requests to heat.
444
CHAPTER 6. DATA PROCESSING SERVICE
Option = default value
[heat] ca_file = None
[keystone] api_insecure = False
[keystone] ca_file = None
[neutron] api_insecure = False
[neutron] ca_file = None
[nova] api_insecure = False
[nova] ca_file = None
[oslo_messaging_amqp] allow_insecure_clients =
False
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
[oslo_messaging_amqp] ssl_key_file =
[oslo_messaging_amqp] ssl_key_password =
None
(Type) Help string
(StrOpt) Location of ca certificates file to use for heat client requests.
(BoolOpt) Allow to perform insecure SSL requests to keystone.
(StrOpt) Location of ca certificates file to use for keystone client requests.
(BoolOpt) Allow to perform insecure SSL requests to neutron.
(StrOpt) Location of ca certificates file to use for neutron client requests.
(BoolOpt) Allow to perform insecure SSL requests to nova.
(StrOpt) Location of ca certificates file to use for nova client requests.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
445
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_amqp] trace = False
(Type) Help string
(BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] amqp_durable_queues =
False
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_qpid] qpid_heartbeat = 60 (IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
[oslo_messaging_qpid] qpid_protocol = tcp
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
[oslo_messaging_qpid] qpid_sasl_mechanisms =
[oslo_messaging_qpid] qpid_tcp_nodelay = True
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
[oslo_messaging_qpid] qpid_topology_version = 1 (IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30 (IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_rabbit] amqp_auto_delete =
False
[oslo_messaging_rabbit] amqp_durable_queues =
False
[oslo_messaging_rabbit] fake_rabbit = False
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
446
CHAPTER 6. DATA PROCESSING SERVICE
Option = default value
[oslo_messaging_rabbit] heartbeat_rate = 2
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(Type) Help string
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
[oslo_messaging_rabbit] rabbit_port = 5672
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
447
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] rabbit_retry_interval = 1
[oslo_policy] policy_dirs = ['policy.d']
(Type) Help string
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
[oslo_messaging_rabbit] rabbit_use_ssl = False
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
[oslo_messaging_rabbit] rpc_conn_pool_size = 30
[oslo_middleware] max_request_body_size =
114688
[oslo_policy] policy_default_rule = default
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
(IntOpt) The maximum body size for each request, in bytes.
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
[oslo_policy] policy_file = policy.json
[ssl] ca_file = None
[ssl] cert_file = None
[ssl] key_file = None
(StrOpt) The JSON file that defines policies.
(StrOpt) CA certificate file to use to verify connecting clients.
(StrOpt) Certificate file to use when starting the server securely.
(StrOpt) Private key file to use when starting the server securely.
[swift] api_insecure = False
[swift] ca_file = None
[timeouts] await_attach_volumes = 10
[timeouts] await_for_instances_active = 10800
(BoolOpt) Allow to perform insecure SSL requests to swift.
(StrOpt) Location of ca certificates file to use for swift client requests.
(IntOpt) Wait for attaching volumes to instances, in seconds
(IntOpt) Wait for instances to become active, in seconds
448
Option = default value
[timeouts] delete_instances_timeout = 10800
[timeouts] detach_volume_timeout = 300
[timeouts] ips_assign_timeout = 10800
[timeouts] volume_available_timeout = 10800
[timeouts] wait_until_accessible = 10800
CHAPTER 6. DATA PROCESSING SERVICE
(Type) Help string
(IntOpt) Wait for instances to be deleted, in seconds
(IntOpt) Timeout for detaching volumes from instance, in seconds
(IntOpt) Assign IPs timeout, in seconds
(IntOpt) Wait for volumes to become available, in seconds
(IntOpt) Wait for instance accessibility, in seconds
Table 6.17. New default values
Option
[DEFAULT] default_log_levels
[DEFAULT] plugins
[DEFAULT] rpc_zmq_matchmaker
Previous default value amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN
New default value amqplib=WARN, qpid.messaging=INFO, stevedore=INFO, eventlet.wsgi.server=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, paramiko=WARN, requests=WARN, iso8601=WARN, oslo_messaging=INFO vanilla, hdp, spark, cdh vanilla, hdp, spark oslo.messaging._drivers.matchm
aker.MatchMakerLocalhost
local
Table 6.18. Deprecated options
Deprecated option
[DEFAULT] log-format
[DEFAULT] use-syslog
[DEFAULT] detach_volume_timeout
[DEFAULT] log_format
New Option
None
None
[timeouts] detach_volume_timeout
None
449
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Deprecated option
[DEFAULT] use_syslog
New Option
None
450
CHAPTER 7. IDENTITY SERVICE
CHAPTER 7. IDENTITY SERVICE
This chapter details the OpenStack Identity service configuration options.
7.1. IDENTITY SERVICE CONFIGURATION FILE
The Identity service is configured in the /etc/keystone/keystone.conf file.
The following tables provide a comprehensive list of the Identity service options.
Table 7.1. Description of API configuration options
Configuration option = Default value
[DEFAULT] admin_endpoint
= None
Description admin_token
= ADMIN
compute_port
= 8774
(StrOpt) The base admin endpoint URL for
Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:35357/v3/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (e.g.
/prefix/v3) or the endpoint should be found on a different server.
(StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove
AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystonepaste.ini).
(IntOpt) (Deprecated) The port which the
OpenStack Compute service listens on. This option was only used for string replacement in the templated catalog backend. Templated catalogs should replace the "$(compute_port)s" substitution with the static port of the compute service. As of
Juno, this option is deprecated and will be removed in the L release.
451
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value domain_id_immutable
= True
list_limit
= None
max_param_size max_token_size member_role_id
= 64
max_project_tree_depth
= 8192
=
= 5
9fe2ff9ee4384b1894a90878d3e92bab
member_role_name public_endpoint
= _member_
= None
secure_proxy_ssl_header
= None
Description
(BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file
(see policy.v3cloudsample as an example).
(IntOpt) The maximum number of entities that will be returned in a collection, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]).
(IntOpt) Limit the sizes of user & project ID/names.
(IntOpt) Maximum depth of the project hierarchy.
WARNING: setting it to a large value may adversely impact performance.
(IntOpt) Similar to max_param_size, but provides an exception for token values.
(StrOpt) Similar to the member_role_name option, this represents the default role ID used to associate users with their default projects in the v2
API. This will be used as the explicit role where one is not specified by the v2 API.
(StrOpt) This is the role name used in combination with the member_role_id option; see that option for more detail.
(StrOpt) The base public endpoint URL for
Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:5000/v3/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (e.g.
/prefix/v3) or the endpoint should be found on a different server.
(StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO".
452
CHAPTER 7. IDENTITY SERVICE
Configuration option = Default value strict_password_check
= False
Description
(BoolOpt) If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length.
[endpoint_filter] driver
=
keystone.contrib.endpoint_filter.backends.sql.Endp
ointFilter
(StrOpt) Endpoint Filter backend driver
return_all_endpoints_if_no_filter
= True
[endpoint_policy]
(BoolOpt) Toggle to return all active endpoints if no filter exists.
driver
=
keystone.contrib.endpoint_policy.backends.sql.End
pointPolicy
(StrOpt) Endpoint policy backend driver
[eventlet_server] admin_bind_host
= 0.0.0.0
admin_port
= 35357
admin_workers public_bind_host public_port
= 5000
public_workers tcp_keepalive
= None
= 0.0.0.0
= None
= False
(StrOpt) The IP address of the network interface for the admin service to listen on.
(IntOpt) The port number which the admin service listens on.
(IntOpt) The number of worker processes to serve the admin eventlet application. Defaults to number of CPUs (minimum of 2).
(StrOpt) The IP address of the network interface for the public service to listen on.
(IntOpt) The port number which the public service listens on.
(IntOpt) The number of worker processes to serve the public eventlet application. Defaults to number of CPUs (minimum of 2).
(BoolOpt) Set this to true if you want to enable
TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections.
453
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value tcp_keepidle
= 600
Description
(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true.
[paste_deploy] config_file
= keystone-paste.ini (StrOpt) Name of the paste configuration file that defines the available pipelines.
[resource] cache_time
= None
caching driver
= True
= None
list_limit
= None
(IntOpt) TTL (in seconds) to cache resource data.
This has no effect unless global caching is enabled.
(BoolOpt) Toggle for resource caching. This has no effect unless global caching is enabled.
(StrOpt) Resource backend driver. If a resource driver is not specified, the assignment driver will choose the resource driver.
(IntOpt) Maximum number of entities that will be returned in a resource collection.
Table 7.2. Description of assignment configuration options
Description Configuration option = Default value
[assignment] driver
= None (StrOpt) Assignment backend driver.
Table 7.3. Description of authorization configuration options
Configuration option = Default value
[auth] external
=
keystone.auth.plugins.external.DefaultDomain
methods
= external, password, token, oauth1
oauth1
= keystone.auth.plugins.oauth1.OAuth
Description
(StrOpt) The external (REMOTE_USER) auth plugin module.
(ListOpt) Default auth methods.
(StrOpt) The oAuth1.0 auth plugin module.
454
Configuration option = Default value password
=
keystone.auth.plugins.password.Password
token
= keystone.auth.plugins.token.Token
CHAPTER 7. IDENTITY SERVICE
Description
(StrOpt) The password auth plugin module.
(StrOpt) The token auth plugin module.
Table 7.4. Description of authorization token configuration options
Description Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
admin_token
= None
admin_user auth_host auth_port auth_uri
= None
auth_admin_prefix
= 127.0.0.1
auth_plugin
= None
= 35357
auth_protocol auth_section
=
= https
= None
= None
auth_version
= None
(StrOpt) Service user password.
(StrOpt) Service tenant name.
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
455
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value cache
= None
cafile
= None
certfile
= None
check_revocations_for_cached
= False
delay_auth_decision enforce_token_bind hash_algorithms identity_uri
= None
= False
= permissive
= md5
http_connect_timeout
= None
http_request_max_retries
= 3
Description
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times are we trying to reconnect when communicating with Identity API
Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
456
CHAPTER 7. IDENTITY SERVICE
Configuration option = Default value include_service_catalog
= True
insecure keyfile
= False
= None
memcache_pool_conn_get_timeout
= 10
memcache_pool_dead_retry memcache_pool_maxsize revocation_cache_time
= 10
= 10
= 300
memcache_pool_socket_timeout memcache_pool_unused_timeout memcache_secret_key
= None
memcache_security_strategy memcache_use_advanced_pool
= 3
= 60
= None
= False
Description
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
457
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value signing_dir
= None
token_cache_time
= 300
Description
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
Table 7.5. Description of CA and SSL configuration options
Configuration option = Default value
[eventlet_server_ssl]
Description ca_certs certfile
= /etc/keystone/ssl/certs/ca.pem
cert_required
=
= False
/etc/keystone/ssl/certs/keystone.pem
enable
= False
key_size
= 2048
(StrOpt) Path of the CA cert file for SSL.
(BoolOpt) Require client certificate.
(StrOpt) Path of the certfile for SSL. For nonproduction environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates.
(BoolOpt) Toggle for SSL support on the Keystone eventlet servers.
(StrOpt) Path of the keyfile for SSL.
keyfile
=
/etc/keystone/ssl/private/keystonekey.pem
[signing] ca_certs
= /etc/keystone/ssl/certs/ca.pem
ca_key
= /etc/keystone/ssl/private/cakey.pem
(StrOpt) Path of the CA for token signing.
(StrOpt) Path of the CA key for token signing.
cert_subject
=
/C=US/ST=Unset/L=Unset/O=Unset/CN=www.exa
mple.com
(StrOpt) Certificate subject (auto generated certificate) for token signing.
certfile
=
/etc/keystone/ssl/certs/signing_cert.pem
(StrOpt) Path of the certfile for token signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates.
(IntOpt) Key size (in bits) for token signing cert
(auto generated certificate).
458
CHAPTER 7. IDENTITY SERVICE
Configuration option = Default value keyfile
=
/etc/keystone/ssl/private/signing_key.pem
valid_days
= 3650
Description
(StrOpt) Path of the keyfile for token signing.
(IntOpt) Days the token signing cert is valid for
(auto generated certificate).
[ssl] ca_key
= /etc/keystone/ssl/private/cakey.pem
cert_subject
=
/C=US/ST=Unset/L=Unset/O=Unset/CN=localhost
key_size
= 1024
valid_days
= 3650
(StrOpt) Path of the CA key file for SSL.
(StrOpt) SSL certificate subject (auto generated certificate).
(IntOpt) SSL key length (in bits) (auto generated certificate).
(IntOpt) Days the certificate is valid for once signed
(auto generated certificate).
Table 7.6. Description of catalog configuration options
Configuration option = Default value
[catalog] cache_time
= None
Description caching
= True
(IntOpt) Time to cache catalog data (in seconds).
This has no effect unless global and catalog caching are enabled.
(BoolOpt) Toggle for catalog caching. This has no effect unless global caching is enabled.
driver
= keystone.catalog.backends.sql.Catalog (StrOpt) Catalog backend driver.
list_limit
= None (IntOpt) Maximum number of entities that will be returned in a catalog collection.
template_file
= default_catalog.templates (StrOpt) Catalog template file name for use with the template catalog backend.
Table 7.7. Description of common configuration options
Description Configuration option = Default value
[DEFAULT]
459
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value memcached_servers
= None
Description
(ListOpt) Memcached servers or None for in process cache.
[keystone_authtoken] memcached_servers
= None (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Table 7.8. Description of credential configuration options
Description Configuration option = Default value
[credential] driver
=
keystone.credential.backends.sql.Credential
(StrOpt) Credential backend driver.
Table 7.9. Description of database configuration options
Description Configuration option = Default value
[database] backend
= sqlalchemy
connection
= None
connection_debug
= 0
connection_trace db_inc_retry_interval db_max_retries
= False
= 20
= True
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.
(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.
460
Configuration option = Default value db_max_retry_interval
= 10
db_retry_interval idle_timeout max_overflow
= 3600
= None
= 1
max_pool_size
= None
max_retries
= 10
min_pool_size mysql_sql_mode pool_timeout
= 1
= TRADITIONAL
= None
retry_interval
= 10
slave_connection
= None
sqlite_db
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
CHAPTER 7. IDENTITY SERVICE
Description
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.
(IntOpt) Seconds between database connection retries.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
Table 7.10. Description of logging configuration options
461
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] backdoor_port
= None
pydev_debug_host
= None
pydev_debug_port
= None
standard_threads
= False
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
(StrOpt) Host to connect to for remote debugger.
(IntOpt) Port to connect to for remote debugger.
(BoolOpt) Do not monkey-patch threading system modules.
[audit] namespace
= openstack (StrOpt) namespace prefix for generated id
Table 7.11. Description of domain configuration options
Configuration option = Default value Description
[domain_config] cache_time
= 300 (IntOpt) TTL (in seconds) to cache domain config data. This has no effect unless domain config caching is enabled.
caching
= True (BoolOpt) Toggle for domain config caching. This has no effect unless global caching is enabled.
driver
=
keystone.resource.config_backends.sql.DomainCo
nfig
(StrOpt) Domain config backend driver.
Table 7.12. Description of EC2 configuration options
Description Configuration option = Default value
[keystone_ec2_token]
462
Configuration option = Default value cafile
= None
certfile
= None
insecure
= False
keyfile
= None
url
= http://localhost:5000/v2.0/ec2tokens
CHAPTER 7. IDENTITY SERVICE
Description
(StrOpt) A PEM encoded certificate authority to use when verifying HTTPS connections. Defaults to the system CAs.
(StrOpt) Client certificate key filename. Required if
EC2 server requires client certificate.
(BoolOpt) Disable SSL certificate verification.
(StrOpt) Required if EC2 server requires client certificate.
(StrOpt) URL to get token from ec2 request.
Table 7.13. Description of federation configuration options
Configuration option = Default value sso_callback_template
=
/etc/keystone/sso_callback_template.html
Description
[federation] assertion_prefix
=
driver
=
keystone.contrib.federation.backends.sql.Federatio
n
(StrOpt) Federation backend driver.
federated_domain_name
= Federated
(StrOpt) Value to be used when filtering assertion parameters from the environment.
(StrOpt) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to.
Changing this option to empty string or None will not have any impact and default name will be used.
remote_id_attribute
= None (StrOpt) Value to be used to obtain the entity ID of the Identity Provider from the environment (e.g. if using the mod_shib plugin this value is `Shib-
Identity-Provider`).
(StrOpt) Location of Single Sign-On callback handler, will return a token to a trusted dashboard host.
463
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value trusted_dashboard
= []
Description
(MultiStrOpt) A list of trusted dashboard hosts.
Before accepting a Single Sign-On request to return a token, the origin host must be a member of the trusted_dashboard list. This configuration option may be repeated for multiple values. For example: trusted_dashboard=http://acme.com
trusted_dashboard=http://beta.com
Table 7.14. Description of Fernet tokens configuration options
Configuration option = Default value
[fernet_tokens] key_repository
= /etc/keystone/fernet-keys/
max_active_keys
= 3
Description
(StrOpt) Directory containing Fernet token keys.
(IntOpt) This controls how many keys are held in rotation by keystone-manage fernet_rotate before they are discarded. The default value of 3 means that keystone will maintain one staged key, one primary key, and one secondary key. Increasing this value means that additional secondary keys will be kept in the rotation.
Table 7.15. Description of identity configuration options
Description Configuration option = Default value
[identity] cache_time
= 600
caching
= True
default_domain_id
= default
(IntOpt) Time to cache identity data (in seconds).
This has no effect unless global and identity caching are enabled.
(BoolOpt) Toggle for identity caching. This has no effect unless global caching is enabled.
(StrOpt) This references the domain to use for all
Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration
008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients.
464
CHAPTER 7. IDENTITY SERVICE
Configuration option = Default value Description domain_config_dir
= /etc/keystone/domains (StrOpt) Path for Keystone to locate the domain specific identity configuration files if domain_specific_drivers_enabled is set to true.
domain_configurations_from_databas e
= False
(BoolOpt) Extract the domain specific configuration options from the resource backend where they have been stored with the domain data. This feature is disabled by default (in which case the domain specific options will be loaded from files in the domain configuration directory); set to true to enable.
domain_specific_drivers_enabled
False
= (BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration options, stored in either the resource backend or in a file in a domain configuration directory (depending on the setting of domain_configurations_from_database). Only values specific to the domain need to be specified in this manner. This feature is disabled by default; set to true to enable.
driver
= keystone.identity.backends.sql.Identity (StrOpt) Identity backend driver.
list_limit
= None (IntOpt) Maximum number of entities that will be returned in an identity collection.
max_password_length
= 4096 (IntOpt) Maximum supported length for user passwords; decrease to improve performance.
Table 7.16. Description of KVS configuration options
Description Configuration option = Default value
[kvs] backends
=
config_prefix
= keystone.kvs
default_lock_timeout
= 5
(ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library.
(StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name.
(IntOpt) Default lock timeout (in seconds) for distributed locking.
465
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value enable_key_mangler
= True
Description
(BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggleable for debugging purposes, it is highly recommended to always leave this set to true.
466
Table 7.17. Description of LDAP configuration options
Configuration option = Default value
[ldap] alias_dereferencing
= default
Description allow_subtree_delete
= False
auth_pool_connection_lifetime
= 60
(StrOpt) The LDAP dereferencing option for queries. This can be either "never", "searching",
"always", "finding" or "default". The "default" option falls back to using default dereferencing configured by your ldap.conf.
(BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion.
(IntOpt) End user auth connection lifetime in seconds.
auth_pool_size debug_level dumb_member
= 100
chase_referrals
= None
= None
= cn=dumb,dc=nonexistent
(IntOpt) End user auth connection pool size.
(BoolOpt) Override the system's default referral chasing behavior for queries.
(IntOpt) Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your
LDAP documentation for possible values.
(StrOpt) DN of the "dummy member" to use when
"use_dumb_member" is enabled.
group_additional_attribute_mapping
=
(ListOpt) Additional attribute mappings for groups.
Attribute mapping format is <ldap_attr>:
<user_attr>, where ldap_attr is the attribute in the
LDAP entry and user_attr is the Identity API attribute.
(BoolOpt) Allow group creation in LDAP backend.
group_allow_create
= True
group_allow_delete
= True
group_allow_update
= True
(BoolOpt) Allow group deletion in LDAP backend.
(BoolOpt) Allow group update in LDAP backend.
CHAPTER 7. IDENTITY SERVICE
Configuration option = Default value group_attribute_ignore
=
group_desc_attribute group_filter group_name_attribute
= ou
group_objectclass
= groupOfNames
group_tree_dn
= None
page_size
= 0
= None
group_id_attribute
= cn
group_member_attribute
= member
password
= None
= description
pool_connection_lifetime pool_connection_timeout pool_retry_delay
= 0.1
= 600
= -1
Description
(ListOpt) List of attributes stripped off the group on update.
(StrOpt) LDAP attribute mapped to group description.
(StrOpt) LDAP search filter for groups.
(StrOpt) LDAP attribute mapped to group id.
(StrOpt) LDAP attribute mapped to show group membership.
(StrOpt) LDAP attribute mapped to group name.
(StrOpt) LDAP objectclass for groups.
(StrOpt) Search base for groups.
(IntOpt) Maximum results per page; a value of zero
("0") disables paging.
(StrOpt) Password for the BindDN to query the
LDAP server.
(IntOpt) Connection lifetime in seconds.
(IntOpt) Connector timeout in seconds. Value -1 indicates indefinite wait for response.
(FloatOpt) Time span in seconds to wait between two reconnect trials.
pool_retry_max
= 3
pool_size
= 10
(IntOpt) Maximum count of reconnect trials.
(IntOpt) Connection pool size.
project_additional_attribute_mappi ng
=
(ListOpt) Additional attribute mappings for projects.
Attribute mapping format is <ldap_attr>:
<user_attr>, where ldap_attr is the attribute in the
LDAP entry and user_attr is the Identity API attribute.
(BoolOpt) Allow project creation in LDAP backend.
project_allow_create
= True
project_allow_delete
= True
project_allow_update
= True
(BoolOpt) Allow project deletion in LDAP backend.
(BoolOpt) Allow project update in LDAP backend.
467
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value project_attribute_ignore
=
project_desc_attribute project_domain_id_attribute
businessCategory
=
project_enabled_attribute
= enabled
project_enabled_emulation
= False
project_filter
= None
project_id_attribute project_name_attribute project_objectclass project_tree_dn query_scope
= one
= ou
= groupOfNames
= None
= cn
project_member_attribute
= member
role_additional_attribute_mapping
=
role_allow_create role_allow_delete role_allow_update
= True
= True
= True
= description
project_enabled_emulation_dn
= None
Description
(ListOpt) List of attributes stripped off the project on update.
(StrOpt) LDAP attribute mapped to project description.
(StrOpt) LDAP attribute mapped to project domain_id.
(StrOpt) LDAP attribute mapped to project enabled.
(BoolOpt) If true, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the
"project_enabled_emulation_dn" group.
(StrOpt) DN of the group entry to hold enabled projects when using enabled emulation.
(StrOpt) LDAP search filter for projects.
(StrOpt) LDAP attribute mapped to project id.
(StrOpt) LDAP attribute mapped to project membership for user.
(StrOpt) LDAP attribute mapped to project name.
(StrOpt) LDAP objectclass for projects.
(StrOpt) Search base for projects
(StrOpt) The LDAP scope for queries, this can be either "one" (onelevel/singleLevel) or "sub"
(subtree/wholeSubtree).
(ListOpt) Additional attribute mappings for roles.
Attribute mapping format is <ldap_attr>:
<user_attr>, where ldap_attr is the attribute in the
LDAP entry and user_attr is the Identity API attribute.
(BoolOpt) Allow role creation in LDAP backend.
(BoolOpt) Allow role deletion in LDAP backend.
(BoolOpt) Allow role update in LDAP backend.
468
Configuration option = Default value role_attribute_ignore
=
role_filter
= None
role_id_attribute
= cn
role_member_attribute
= roleOccupant
role_name_attribute
= ou
role_objectclass
= organizationalRole
role_tree_dn
= None
suffix
= cn=example,cn=com
tls_cacertdir
= None
tls_cacertfile tls_req_cert url
= None
= demand
= ldap://localhost
use_auth_pool
= False
use_dumb_member use_pool use_tls user
= False
= False
= None
= False
CHAPTER 7. IDENTITY SERVICE
Description
(ListOpt) List of attributes stripped off the role on update.
(StrOpt) LDAP search filter for roles.
(StrOpt) LDAP attribute mapped to role id.
(StrOpt) LDAP attribute mapped to role membership.
(StrOpt) LDAP attribute mapped to role name.
(StrOpt) LDAP objectclass for roles.
(StrOpt) Search base for roles.
(StrOpt) LDAP server suffix
(StrOpt) CA certificate directory path for communicating with LDAP servers.
(StrOpt) CA certificate file path for communicating with LDAP servers.
(StrOpt) Valid options for tls_req_cert are demand, never, and allow.
(StrOpt) URL for connecting to the LDAP server.
(BoolOpt) Enable LDAP connection pooling for end user authentication. If use_pool is disabled, then this setting is meaningless and is not used at all.
(BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute.
(BoolOpt) Enable LDAP connection pooling.
(BoolOpt) Enable TLS for communicating with
LDAP servers.
(StrOpt) User BindDN to query the LDAP server.
469
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value user_additional_attribute_mapping
=
user_allow_create
= True
user_allow_delete
= True
user_allow_update
= True
user_attribute_ignore
=
default_project_id, tenants
user_default_project_id_attribute
= None
user_enabled_attribute
= enabled
user_enabled_default user_enabled_emulation user_enabled_emulation_dn user_enabled_invert
= True
= False
= False
= None
Description
(ListOpt) List of additional LDAP attributes used for mapping additional attribute mappings for users.
Attribute mapping format is <ldap_attr>:
<user_attr>, where ldap_attr is the attribute in the
LDAP entry and user_attr is the Identity API attribute.
(BoolOpt) Allow user creation in LDAP backend.
(BoolOpt) Allow user deletion in LDAP backend.
(BoolOpt) Allow user updates in LDAP backend.
(ListOpt) List of attributes stripped off the user on update.
(StrOpt) LDAP attribute mapped to default_project_id for users.
(StrOpt) LDAP attribute mapped to user enabled flag.
(StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to
"True" the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl".
(BoolOpt) If true, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the
"user_enabled_emulation_dn" group.
(StrOpt) DN of the group entry to hold enabled users when using enabled emulation.
(BoolOpt) Invert the meaning of the boolean enabled values. Some LDAP servers use a boolean lock attribute where "true" means an account is disabled. Setting "user_enabled_invert
= true" will allow these lock attributes to be used.
This setting will have no effect if
"user_enabled_mask" or
"user_enabled_emulation" settings are in use.
470
Configuration option = Default value user_enabled_mask
= 0
user_filter
= None
user_id_attribute
= cn
user_mail_attribute
user_name_attribute
= sn
user_objectclass
= inetOrgPerson
user_pass_attribute
= userPassword
user_tree_dn
= None
CHAPTER 7. IDENTITY SERVICE
Description
(IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is
"2". This is typically used when
"user_enabled_attribute = userAccountControl".
(StrOpt) LDAP search filter for users.
(StrOpt) LDAP attribute mapped to user id.
WARNING: must not be a multivalued attribute.
(StrOpt) LDAP attribute mapped to user email.
(StrOpt) LDAP attribute mapped to user name.
(StrOpt) LDAP objectclass for users.
(StrOpt) LDAP attribute mapped to password.
(StrOpt) Search base for users.
Table 7.18. Description of logging configuration options
Configuration option = Default value
[DEFAULT]
Description debug
= False
default_log_levels
= 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
(ListOpt) List of logger=LEVEL pairs.
fatal_deprecations
= False
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
instance_format
= "[instance: %(uuid)s] "
(BoolOpt) Enables or disables fatal status of deprecations.
(StrOpt) The format for an instance that is passed with the log message.
471
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value instance_uuid_format
= "[instance: %
(uuid)s] "
log_config_append
= None
Description
(StrOpt) The format for an instance UUID that is passed with the log message.
(StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None (StrOpt) (Optional) The base directory used for relative --log-file paths.
log_file
= None
log_format
= None
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
logging_context_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
(StrOpt) Prefix each line of exception output with this format.
syslog_log_facility use_syslog
= False
= LOG_USER
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
472
Configuration option = Default value use_syslog_rfc_format
= False
use_stderr verbose
= True
= False
CHAPTER 7. IDENTITY SERVICE
Description
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Log output to standard error.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 7.19. Description of mapping configuration options
Configuration option = Default value
[identity_mapping] backward_compatible_ids
= True
Description driver
=
keystone.identity.mapping_backends.sql.Mapping
generator
=
keystone.identity.id_generators.sha256.Generator
(BoolOpt) The format of user and group IDs changed in Juno for backends that do not generate
UUIDs (e.g. LDAP), with keystone providing a hash mapping to the underlying attribute in LDAP. By default this mapping is disabled, which ensures that existing IDs will not change. Even when the mapping is enabled by using domain specific drivers, any users and groups from the default domain being handled by LDAP will still not be mapped to ensure their IDs remain backward compatible. Setting this value to False will enable the mapping for even the default LDAP driver. It is only safe to do this if you do not already have assignments for users and groups from the default
LDAP domain, and it is acceptable for Keystone to provide the different IDs to clients than it did previously. Typically this means that the only time you can set this value to False is when configuring a fresh installation.
(StrOpt) Keystone Identity Mapping backend driver.
(StrOpt) Public ID generator for user and group entities. The Keystone identity mapper only supports generators that produce no more than 64 characters.
Table 7.20. Description of memcache configuration options
473
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[memcache] servers
= localhost:11211
socket_timeout
= 3
(ListOpt) Memcache servers in the format of
"host:port".
(IntOpt) Timeout in seconds for every call to a server. This is used by the key value store system
(e.g. token pooled memcached persistence backend).
Table 7.21. Description of OAuth configuration options
Description Configuration option = Default value
[oauth1] access_token_duration
= 86400 (IntOpt) Duration (in seconds) for the OAuth
Access Token.
(StrOpt) Credential backend driver.
driver
=
keystone.contrib.oauth1.backends.sql.OAuth1
request_token_duration
= 28800 (IntOpt) Duration (in seconds) for the OAuth
Request Token.
Table 7.22. Description of os_inherit configuration options
Description Configuration option = Default value
[os_inherit] enabled
= False (BoolOpt) role-assignment inheritance to projects from owning domain or from projects higher in the hierarchy can be optionally enabled.
Table 7.23. Description of oslo_middleware configuration options
Description Configuration option = Default value
[oslo_middleware] max_request_body_size
= 114688 (IntOpt) The maximum body size for each request, in bytes.
474
CHAPTER 7. IDENTITY SERVICE
Table 7.24. Description of policy configuration options
Configuration option = Default value
[oslo_policy] policy_default_rule
= default
Description policy_dirs
= ['policy.d']
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
policy_file
= policy.json
[policy] driver
= keystone.policy.backends.sql.Policy
list_limit
= None
(StrOpt) Policy backend driver.
(IntOpt) Maximum number of entities that will be returned in a policy collection.
Table 7.25. Description of revoke configuration options
Description Configuration option = Default value
[revoke] cache_time
= 3600
caching driver
=
= True
keystone.contrib.revoke.backends.sql.Revoke
expiration_buffer
= 1800
(IntOpt) Time to cache the revocation list and the revocation events (in seconds). This has no effect unless global and token caching are enabled.
(BoolOpt) Toggle for revocation event caching.
This has no effect unless global caching is enabled.
(StrOpt) An implementation of the backend for persisting revocation events.
(IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend.
Table 7.26. Description of role configuration options
475
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[role] cache_time
= None
caching driver
= True
= None
list_limit
= None
(IntOpt) TTL (in seconds) to cache role data. This has no effect unless global caching is enabled.
(BoolOpt) Toggle for role caching. This has no effect unless global caching is enabled.
(StrOpt) Role backend driver.
(IntOpt) Maximum number of entities that will be returned in a role collection.
Table 7.27. Description of SAML configuration options
Description Configuration option = Default value
[saml] assertion_expiration_time
= 3600
certfile
=
/etc/keystone/ssl/certs/signing_cert.pem
idp_contact_company
= None
idp_contact_email
= None
idp_contact_name
= None
idp_contact_surname
= None
idp_contact_telephone
= None
idp_contact_type
= other
idp_entity_id
= None
(IntOpt) Default TTL, in seconds, for any generated
SAML assertion created by Keystone.
(StrOpt) Path of the certfile for SAML signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. Note, the path cannot contain a comma.
(StrOpt) Company of contact person.
(StrOpt) Email address of contact person.
(StrOpt) Given name of contact person
(StrOpt) Surname of contact person.
(StrOpt) Telephone number of contact person.
(StrOpt) Contact type. Allowed values are: technical, support, administrative billing, and other
(StrOpt) Entity ID value for unique Identity Provider identification. Usually FQDN is set with a suffix. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-
FEDERATION/saml2/idp
476
Configuration option = Default value idp_lang
= en
idp_metadata_path
=
/etc/keystone/saml2_idp_metadata.xml
idp_organization_display_name
=
None
idp_organization_name
= None
idp_organization_url
= None
idp_sso_endpoint
= None
keyfile
=
/etc/keystone/ssl/private/signing_key.pem
relay_state_prefix xmlsec1_binary
= ss:mem:
= xmlsec1
CHAPTER 7. IDENTITY SERVICE
Description
(StrOpt) Language used by the organization.
(StrOpt) Path to the Identity Provider Metadata file.
This file should be generated with the keystonemanage saml_idp_metadata command.
(StrOpt) Organization name to be displayed.
(StrOpt) Organization name the installation belongs to.
(StrOpt) URL of the organization.
(StrOpt) Identity Provider Single-Sign-On service value, required in the Identity Provider's metadata.
A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-
FEDERATION/saml2/sso
(StrOpt) Path of the keyfile for SAML signing. Note, the path cannot contain a comma.
(StrOpt) The prefix to use for the RelayState SAML attribute, used when generating ECP wrapped assertions.
(StrOpt) Binary to be called for XML signing. Install the appropriate package, specify absolute path or adjust your PATH environment variable if the binary cannot be found.
Table 7.28. Description of security configuration options
Description Configuration option = Default value
[DEFAULT] crypt_strength
= 40000 (IntOpt) The value passed as the keyword "rounds" to passlib's encrypt method.
Table 7.29. Description of token configuration options
Description Configuration option = Default value
[token]
477
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value allow_rescope_scoped_token
= True
bind
=
cache_time caching
= True
driver
=
keystone.token.persistence.backends.sql.Token
enforce_token_bind
= permissive
expiration hash_algorithm provider
=
= None
= 3600
keystone.token.providers.uuid.Provider
revoke_by_id
= md5
= True
Description
(BoolOpt) Allow rescoping of scoped token. Setting allow_rescoped_scoped_token to false prevents a user from exchanging a scoped token for any other token.
(ListOpt) External auth mechanisms that should add bind information to token, e.g., kerberos,x509.
(IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled.
(BoolOpt) Toggle for token system caching. This has no effect unless global caching is enabled.
(StrOpt) Token persistence backend driver.
(StrOpt) Enforcement policy on tokens presented to
Keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode, e.g., kerberos or x509 to require binding to that authentication.
(IntOpt) Amount of time a token should remain valid
(in seconds).
(StrOpt) The hash algorithm to use for PKI tokens.
This can be set to any algorithm that hashlib supports. WARNING: Before changing this value, the auth_token middleware must be configured with the hash_algorithms, otherwise token revocation will not be processed correctly.
(StrOpt) Controls the token construction, validation, and revocation operations. Core providers are
"keystone.token.providers.
[fernet|pkiz|pki|uuid].Provider".
(BoolOpt) Revoke token by token identifier. Setting revoke_by_id to true enables various forms of enumerating tokens, e.g. `list tokens for user`.
These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory.
Table 7.30. Description of trust configuration options
478
rpc_cast_timeout
= 30
rpc_response_timeout
= 60
rpc_thread_pool_size
= 64
[oslo_messaging_amqp] allow_insecure_clients
= False
CHAPTER 7. IDENTITY SERVICE
Configuration option = Default value
[trust] allow_redelegation enabled
= True
= False
driver
= keystone.trust.backends.sql.Trust
Description
(BoolOpt) Enable redelegation feature.
(StrOpt) Trust backend driver.
(BoolOpt) Delegation and impersonation features can be optionally disabled.
(IntOpt) Maximum depth of trust redelegation.
max_redelegation_count
= 3
Table 7.31. Description of RPC configuration options
Configuration option = Default value
[DEFAULT] matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
Description
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
(IntOpt) Size of RPC thread pool.
broadcast_prefix
= 0
= broadcast
container_name
= None
group_request_prefix
= unicast
idle_timeout
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
479
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value server_request_prefix
= exclusive
ssl_ca_file
=
ssl_cert_file ssl_key_file
=
=
ssl_key_password trace
= False
= None
Description
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
Table 7.32. Description of AMQP configuration options
Description Configuration option = Default value
[DEFAULT] control_exchange
= keystone
default_publisher_id notification_driver notification_format notification_topics transport_url
= None
= None
= []
= basic
= notifications
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
(StrOpt) Default publisher_id for outgoing notifications
(MultiStrOpt) Driver or drivers to handle sending notifications.
(StrOpt) Define the notification format for Identity
Service events. A "basic" notification has information about the resource being operated on.
A "cadf" notification has the same information, as well as information about the initiator of the event.
Valid options are: basic and cadf
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
480
CHAPTER 7. IDENTITY SERVICE
Table 7.33. Description of Qpid configuration options
Description Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname qpid_username
= localhost
qpid_hosts
= $qpid_hostname:$qpid_port
qpid_password
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity qpid_sasl_mechanisms qpid_tcp_nodelay
=
= True
qpid_topology_version
=
rpc_conn_pool_size
= 1
= 1
= 30
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
Table 7.34. Description of RabbitMQ configuration options
Description Configuration option = Default value
[oslo_messaging_rabbit]
481
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value amqp_auto_delete
= False
amqp_durable_queues
= False
fake_rabbit
= False
heartbeat_rate heartbeat_timeout_threshold kombu_reconnect_delay kombu_ssl_ca_certs kombu_ssl_certfile kombu_ssl_keyfile kombu_ssl_version rabbit_ha_queues rabbit_host
=
= localhost
rabbit_hosts
= 2
rabbit_password
=
=
=
= $rabbit_host:$rabbit_port
rabbit_login_method rabbit_max_retries
= AMQPLAIN
= 0
= guest
= 1.0
= False
= 0
Description
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
482
Configuration option = Default value rabbit_port
= 5672
rabbit_retry_backoff
= 2
rabbit_retry_interval
= 1
rabbit_use_ssl
= False
rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
CHAPTER 7. IDENTITY SERVICE
Description
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
Table 7.35. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
7.2. IDENTITY SERVICE SAMPLE CONFIGURATION FILES
You can find the files described in this section in the /etc/keystone directory.
7.2.1. keystone.conf
Use the keystone.conf file to configure most Identity service options:
[DEFAULT]
#
# From keystone
483
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#
# A "shared secret" that can be used to bootstrap Keystone. This "token" does
# not represent a user, and carries no explicit authorization. To disable in
# production (highly recommended), remove AdminTokenAuthMiddleware from your
# paste application pipelines (for example, in keystone-paste.ini).
(string
# value)
#admin_token = ADMIN
# (Deprecated) The port which the OpenStack Compute service listens on.
This
# option was only used for string replacement in the templated catalog backend.
# Templated catalogs should replace the "$(compute_port)s" substitution with
# the static port of the compute service. As of Juno, this option is deprecated
# and will be removed in the L release. (integer value)
#compute_port = 8774
# The base public endpoint URL for Keystone that is advertised to clients
# (NOTE: this does NOT affect how Keystone listens for connections).
Defaults
# to the base host URL of the request. E.g. a request to
# http://server:5000/v3/users will default to http://server:5000. You should
# only need to set this value if the base URL contains a path (e.g.
/prefix/v3)
# or the endpoint should be found on a different server. (string value)
#public_endpoint = <None>
# The base admin endpoint URL for Keystone that is advertised to clients
(NOTE:
# this does NOT affect how Keystone listens for connections). Defaults to the
# base host URL of the request. E.g. a request to http://server:35357/v3/users
# will default to http://server:35357. You should only need to set this value
# if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be
# found on a different server. (string value)
#admin_endpoint = <None>
# Maximum depth of the project hierarchy. WARNING: setting it to a large value
# may adversely impact performance. (integer value)
#max_project_tree_depth = 5
# Limit the sizes of user & project ID/names. (integer value)
#max_param_size = 64
484
CHAPTER 7. IDENTITY SERVICE
# Similar to max_param_size, but provides an exception for token values.
# (integer value)
#max_token_size = 8192
# Similar to the member_role_name option, this represents the default role ID
# used to associate users with their default projects in the v2 API. This will
# be used as the explicit role where one is not specified by the v2 API.
# (string value)
#member_role_id = 9fe2ff9ee4384b1894a90878d3e92bab
# This is the role name used in combination with the member_role_id option; see
# that option for more detail. (string value)
#member_role_name = _member_
# The value passed as the keyword "rounds" to passlib's encrypt method.
# (integer value)
#crypt_strength = 40000
# The maximum number of entities that will be returned in a collection, with no
# limit set by default. This global limit may be then overridden for a specific
# driver, by specifying a list_limit in the appropriate section (e.g.
# [assignment]). (integer value)
#list_limit = <None>
# Set this to false if you want to enable the ability for user, group and
# project entities to be moved between domains by updating their domain_id.
# Allowing such movement is not recommended if the scope of a domain admin is
# being restricted by use of an appropriate policy file (see
# policy.v3cloudsample as an example). (boolean value)
#domain_id_immutable = true
# If set to true, strict password length checking is performed for password
# manipulation. If a password exceeds the maximum length, the operation will
# fail with an HTTP 403 Forbidden error. If set to false, passwords are
# automatically truncated to the maximum length. (boolean value)
#strict_password_check = false
# The HTTP header used to determine the scheme for the original request, even
# if it was removed by an SSL terminating proxy. Typical value is
# "HTTP_X_FORWARDED_PROTO". (string value)
#secure_proxy_ssl_header = <None>
#
# From keystone.notifications
#
485
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Default publisher_id for outgoing notifications (string value)
#default_publisher_id = <None>
# Define the notification format for Identity Service events. A "basic"
# notification has information about the resource being operated on. A
"cadf"
# notification has the same information, as well as information about the
# initiator of the event. Valid options are: basic and cadf (string value)
#notification_format = basic
#
# From keystone.openstack.common.eventlet_backdoor
#
# Enable eventlet backdoor. Acceptable values are 0, <port>, and
# <start>:<end>, where 0 results in listening on a random tcp port number;
# <port> results in listening on the specified port number (and not enabling
# backdoor if that port is in use); and <start>:<end> results in listening on
# the smallest unused port number within the specified range of port numbers.
# The chosen port is displayed in the service's log file. (string value)
#backdoor_port = <None>
#
# From oslo.log
#
# Print debugging output (set logging level to DEBUG instead of default
WARNING
# level). (boolean value)
#debug = false
# Print more verbose output (set logging level to INFO instead of default
# WARNING level). (boolean value)
#verbose = 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. (string value)
# Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None>
# DEPRECATED. A logging.Formatter log message format string which may use any
# of the available logging.LogRecord attributes. This option is deprecated.
# Please use logging_context_format_string and logging_default_format_string
# instead. (string value)
#log_format = <None>
486
CHAPTER 7. IDENTITY SERVICE
# Format string for %%(asctime)s in log records. Default: %(default)s .
(string
# value)
#log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) Name of log file to output to. If no default is set, logging will
# go to stdout. (string value)
# Deprecated group/name - [DEFAULT]/logfile
#log_file = <None>
# (Optional) The base directory used for relative --log-file paths.
(string
# value)
# Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None>
# Use syslog for logging. Existing syslog format is DEPRECATED during I, and
# will change in J to honor RFC5424. (boolean value)
#use_syslog = false
# (Optional) Enables or disables syslog rfc5424 format for logging. If enabled,
# prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The
# format without the APP-NAME is deprecated in I, and will be removed in
J.
# (boolean value)
#use_syslog_rfc_format = false
# Syslog facility to receive log lines. (string value)
#syslog_log_facility = LOG_USER
# Log output to standard error. (boolean value)
#use_stderr = true
# 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 without context. (string value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%(message)s
# Data to append to log format when level 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 TRACE %
(name)s %(instance)s
# List of logger=LEVEL pairs. (list value)
#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo
.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WAR
487
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
N,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.ut
il.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.midd
leware=WARN,stevedore=WARN
# Enables or disables publication of error events. (boolean value)
#publish_errors = false
# Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = 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] "
#
# From oslo.messaging
#
# ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP.
# The "host" option should point or resolve to this address. (string value)
#rpc_zmq_bind_address = *
# MatchMaker driver. (string value)
#rpc_zmq_matchmaker = oslo_messaging._drivers.matchmaker.MatchMakerLocalhost
# ZeroMQ receiver listening port. (integer value)
#rpc_zmq_port = 9501
# Number of ZeroMQ contexts, defaults to 1. (integer value)
#rpc_zmq_contexts = 1
# Maximum number of ingress messages to locally buffer per topic. Default is
# unlimited. (integer value)
#rpc_zmq_topic_backlog = <None>
# Directory for holding IPC sockets. (string value)
#rpc_zmq_ipc_dir = /var/run/openstack
# Name of this node. Must be a valid hostname, FQDN, or IP address. Must match
# "host" option, if running Nova. (string value)
#rpc_zmq_host = localhost
# Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.
# (integer value)
#rpc_cast_timeout = 30
488
CHAPTER 7. IDENTITY SERVICE
# Heartbeat frequency. (integer value)
#matchmaker_heartbeat_freq = 300
# Heartbeat time-to-live. (integer value)
#matchmaker_heartbeat_ttl = 600
# Size of RPC thread pool. (integer value)
#rpc_thread_pool_size = 64
# Driver or drivers to handle sending notifications. (multi valued)
#notification_driver =
# AMQP topic used for OpenStack notifications. (list value)
# Deprecated group/name - [rpc_notifier2]/topics
#notification_topics = notifications
# Seconds to wait for a response from a call. (integer value)
#rpc_response_timeout = 60
# A URL representing the messaging driver to use and its full configuration. If
# not set, we fall back to the rpc_backend option and driver specific
# configuration. (string value)
#transport_url = <None>
# The messaging driver to use, defaults to rabbit. Other drivers include qpid
# and zmq. (string value)
#rpc_backend = rabbit
# The default exchange under which topics are scoped. May be overridden by an
# exchange name specified in the transport_url option. (string value)
#control_exchange = keystone
[assignment]
#
# From keystone
#
# Assignment backend driver. (string value)
#driver = <None>
[auth]
#
# From keystone
#
# Default auth methods. (list value)
#methods = external,password,token,oauth1
489
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The password auth plugin module. (string value)
#password = keystone.auth.plugins.password.Password
# The token auth plugin module. (string value)
#token = keystone.auth.plugins.token.Token
# The external (REMOTE_USER) auth plugin module. (string value)
#external = keystone.auth.plugins.external.DefaultDomain
# The oAuth1.0 auth plugin module. (string value)
#oauth1 = keystone.auth.plugins.oauth1.OAuth
[cache]
#
# From keystone
#
# Prefix for building the configuration dictionary for the cache region.
This
# should not need to be changed unless there is another dogpile.cache region
# with the same configuration name. (string value)
#config_prefix = cache.keystone
# Default TTL, in seconds, for any cached item in the dogpile.cache region.
# This applies to any cached method that doesn't have an explicit cache
# expiration time defined for it. (integer value)
#expiration_time = 600
# Dogpile.cache backend module. It is recommended that Memcache with pooling
# (keystone.cache.memcache_pool) or Redis (dogpile.cache.redis) be used in
# production deployments. Small workloads (single process) like devstack can
# use the dogpile.cache.memory backend. (string value)
#backend = keystone.common.cache.noop
# Arguments supplied to the backend module. Specify this option once per
# argument to be passed to the dogpile.cache backend. Example format:
# "<argname>:<value>". (multi valued)
#backend_argument =
# Proxy classes to import that will affect the way the dogpile.cache backend
# functions. See the dogpile.cache documentation on changing-backendbehavior.
# (list value)
#proxies =
# Global toggle for all caching using the should_cache_fn mechanism.
(boolean
# value)
490
CHAPTER 7. IDENTITY SERVICE
#enabled = false
# Extra debugging from the cache backend (cache keys, get/set/delete/etc
# calls). This is only really useful if you need to see the specific cache-
# backend get/set/delete calls with the keys/values. Typically this should be
# left set to false. (boolean value)
#debug_cache_backend = false
# Memcache servers in the format of "host:port". (dogpile.cache.memcache and
# keystone.cache.memcache_pool backends only). (list value)
#memcache_servers = localhost:11211
# Number of seconds memcached server is considered dead before it is tried
# again. (dogpile.cache.memcache and keystone.cache.memcache_pool backends
# only). (integer value)
#memcache_dead_retry = 300
# Timeout in seconds for every call to a server. (dogpile.cache.memcache and
# keystone.cache.memcache_pool backends only). (integer value)
#memcache_socket_timeout = 3
# Max total number of open connections to every memcached server.
# (keystone.cache.memcache_pool backend only). (integer value)
#memcache_pool_maxsize = 10
# Number of seconds a connection to memcached is held unused in the pool before
# it is closed. (keystone.cache.memcache_pool backend only). (integer value)
#memcache_pool_unused_timeout = 60
# Number of seconds that an operation will wait to get a memcache client
# connection. (integer value)
#memcache_pool_connection_get_timeout = 10
[catalog]
#
# From keystone
#
# Catalog template file name for use with the template catalog backend.
(string
# value)
#template_file = default_catalog.templates
# Catalog backend driver. (string value)
#driver = keystone.catalog.backends.sql.Catalog
# Toggle for catalog caching. This has no effect unless global caching is
491
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# enabled. (boolean value)
#caching = true
# Time to cache catalog data (in seconds). This has no effect unless global and
# catalog caching are enabled. (integer value)
#cache_time = <None>
# Maximum number of entities that will be returned in a catalog collection.
# (integer value)
#list_limit = <None>
[credential]
#
# From keystone
#
# Credential backend driver. (string value)
#driver = keystone.credential.backends.sql.Credential
[database]
#
# From oslo.db
#
# The file name to use with SQLite. (string value)
# Deprecated group/name - [DEFAULT]/sqlite_db
#sqlite_db = oslo.sqlite
# If True, SQLite uses synchronous mode. (boolean value)
# Deprecated group/name - [DEFAULT]/sqlite_synchronous
#sqlite_synchronous = true
# The back end to use for the database. (string value)
# Deprecated group/name - [DEFAULT]/db_backend
#backend = sqlalchemy
# The SQLAlchemy connection string to use to connect to the database.
(string
# value)
# Deprecated group/name - [DEFAULT]/sql_connection
# Deprecated group/name - [DATABASE]/sql_connection
# Deprecated group/name - [sql]/connection
#connection = <None>
# The SQLAlchemy connection string to use to connect to the slave database.
# (string value)
#slave_connection = <None>
# The SQL mode to be used for MySQL sessions. This option, including the
492
CHAPTER 7. IDENTITY SERVICE
# default, overrides any server-set SQL mode. To use whatever SQL mode is set
# by the server configuration, set this to no value. Example: mysql_sql_mode=
# (string value)
#mysql_sql_mode = TRADITIONAL
# Timeout before idle SQL connections are reaped. (integer value)
# Deprecated group/name - [DEFAULT]/sql_idle_timeout
# Deprecated group/name - [DATABASE]/sql_idle_timeout
# Deprecated group/name - [sql]/idle_timeout
#idle_timeout = 3600
# Minimum number of SQL connections to keep open in a pool. (integer value)
# Deprecated group/name - [DEFAULT]/sql_min_pool_size
# Deprecated group/name - [DATABASE]/sql_min_pool_size
#min_pool_size = 1
# Maximum number of SQL connections to keep open in a pool. (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_pool_size
# Deprecated group/name - [DATABASE]/sql_max_pool_size
#max_pool_size = <None>
# Maximum number of database connection retries during startup. Set to -1 to
# specify an infinite retry count. (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_retries
# Deprecated group/name - [DATABASE]/sql_max_retries
#max_retries = 10
# Interval between retries of opening a SQL connection. (integer value)
# Deprecated group/name - [DEFAULT]/sql_retry_interval
# Deprecated group/name - [DATABASE]/reconnect_interval
#retry_interval = 10
# If set, use this value for max_overflow with SQLAlchemy. (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_overflow
# Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
#max_overflow = <None>
# Verbosity of SQL debugging information: 0=None, 100=Everything.
(integer
# value)
# Deprecated group/name - [DEFAULT]/sql_connection_debug
#connection_debug = 0
# Add Python stack traces to SQL as comment strings. (boolean value)
# Deprecated group/name - [DEFAULT]/sql_connection_trace
#connection_trace = false
# If set, use this value for pool_timeout with SQLAlchemy. (integer value)
# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
493
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#pool_timeout = <None>
# Enable the experimental use of database reconnect on connection lost.
# (boolean value)
#use_db_reconnect = false
# Seconds between retries of a database transaction. (integer value)
#db_retry_interval = 1
# If True, increases the interval between retries of a database operation up to
# db_max_retry_interval. (boolean value)
#db_inc_retry_interval = true
# If db_inc_retry_interval is set, the maximum seconds between retries of a
# database operation. (integer value)
#db_max_retry_interval = 10
# Maximum retries in case of connection error or deadlock error before error is
# raised. Set to -1 to specify an infinite retry count. (integer value)
#db_max_retries = 20
[domain_config]
#
# From keystone
#
# Domain config backend driver. (string value)
#driver = keystone.resource.config_backends.sql.DomainConfig
# Toggle for domain config caching. This has no effect unless global caching is
# enabled. (boolean value)
#caching = true
# TTL (in seconds) to cache domain config data. This has no effect unless
# domain config caching is enabled. (integer value)
#cache_time = 300
[endpoint_filter]
#
# From keystone
#
# Endpoint Filter backend driver (string value)
#driver = keystone.contrib.endpoint_filter.backends.sql.EndpointFilter
# Toggle to return all active endpoints if no filter exists. (boolean value)
#return_all_endpoints_if_no_filter = true
494
CHAPTER 7. IDENTITY SERVICE
[endpoint_policy]
#
# From keystone
#
# Endpoint policy backend driver (string value)
#driver = keystone.contrib.endpoint_policy.backends.sql.EndpointPolicy
[eventlet_server]
#
# From keystone
#
# The number of worker processes to serve the public eventlet application.
# Defaults to number of CPUs (minimum of 2). (integer value)
# Deprecated group/name - [DEFAULT]/public_workers
#public_workers = <None>
# The number of worker processes to serve the admin eventlet application.
# Defaults to number of CPUs (minimum of 2). (integer value)
# Deprecated group/name - [DEFAULT]/admin_workers
#admin_workers = <None>
# The IP address of the network interface for the public service to listen on.
# (string value)
# Deprecated group/name - [DEFAULT]/bind_host
# Deprecated group/name - [DEFAULT]/public_bind_host
#public_bind_host = 0.0.0.0
# The port number which the public service listens on. (integer value)
# Deprecated group/name - [DEFAULT]/public_port
#public_port = 5000
# The IP address of the network interface for the admin service to listen on.
# (string value)
# Deprecated group/name - [DEFAULT]/bind_host
# Deprecated group/name - [DEFAULT]/admin_bind_host
#admin_bind_host = 0.0.0.0
# The port number which the admin service listens on. (integer value)
# Deprecated group/name - [DEFAULT]/admin_port
#admin_port = 35357
# Set this to true if you want to enable TCP_KEEPALIVE on server sockets, i.e.
# sockets used by the Keystone wsgi server for client connections.
(boolean
# value)
495
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Deprecated group/name - [DEFAULT]/tcp_keepalive
#tcp_keepalive = false
# Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only
# applies if tcp_keepalive is true. (integer value)
# Deprecated group/name - [DEFAULT]/tcp_keepidle
#tcp_keepidle = 600
[eventlet_server_ssl]
#
# From keystone
#
# Toggle for SSL support on the Keystone eventlet servers. (boolean value)
# Deprecated group/name - [ssl]/enable
#enable = false
# Path of the certfile for SSL. For non-production environments, you may be
# interested in using `keystone-manage ssl_setup` to generate self-signed
# certificates. (string value)
# Deprecated group/name - [ssl]/certfile
#certfile = /etc/keystone/ssl/certs/keystone.pem
# Path of the keyfile for SSL. (string value)
# Deprecated group/name - [ssl]/keyfile
#keyfile = /etc/keystone/ssl/private/keystonekey.pem
# Path of the CA cert file for SSL. (string value)
# Deprecated group/name - [ssl]/ca_certs
#ca_certs = /etc/keystone/ssl/certs/ca.pem
# Require client certificate. (boolean value)
# Deprecated group/name - [ssl]/cert_required
#cert_required = false
[federation]
#
# From keystone
#
# Federation backend driver. (string value)
#driver = keystone.contrib.federation.backends.sql.Federation
# Value to be used when filtering assertion parameters from the environment.
# (string value)
#assertion_prefix =
# Value to be used to obtain the entity ID of the Identity Provider from the
# environment (e.g. if using the mod_shib plugin this value is `Shib-
496
CHAPTER 7. IDENTITY SERVICE
Identity-
# Provider`). (string value)
#remote_id_attribute = <None>
# A domain name that is reserved to allow federated ephemeral users to have a
# domain concept. Note that an admin will not be able to create a domain with
# this name or update an existing domain to this name. You are not advised to
# change this value unless you really have to. Changing this option to empty
# string or None will not have any impact and default name will be used.
# (string value)
#federated_domain_name = Federated
# A list of trusted dashboard hosts. Before accepting a Single Sign-On request
# to return a token, the origin host must be a member of the trusted_dashboard
# list. This configuration option may be repeated for multiple values. For
# example: trusted_dashboard=http://acme.com trusted_dashboard=http://beta.com
# (multi valued)
#trusted_dashboard =
# Location of Single Sign-On callback handler, will return a token to a trusted
# dashboard host. (string value)
#sso_callback_template = /etc/keystone/sso_callback_template.html
[fernet_tokens]
#
# From keystone
#
# Directory containing Fernet token keys. (string value)
#key_repository = /etc/keystone/fernet-keys/
# This controls how many keys are held in rotation by keystone-manage
# fernet_rotate before they are discarded. The default value of 3 means that
# keystone will maintain one staged key, one primary key, and one secondary
# key. Increasing this value means that additional secondary keys will be kept
# in the rotation. (integer value)
#max_active_keys = 3
[identity]
#
# From keystone
497
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#
# This references the domain to use for all Identity API v2 requests
(which are
# not aware of domains). A domain with this ID will be created for you by
# keystone-manage db_sync in migration 008. The domain referenced by this
ID
# cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API.
# There is nothing special about this domain, other than the fact that it must
# exist to order to maintain support for your v2 clients. (string value)
#default_domain_id = default
# A subset (or all) of domains can have their own identity driver, each with
# their own partial configuration options, stored in either the resource
# backend or in a file in a domain configuration directory (depending on the
# setting of domain_configurations_from_database). Only values specific to the
# domain need to be specified in this manner. This feature is disabled by
# default; set to true to enable. (boolean value)
#domain_specific_drivers_enabled = false
# Extract the domain specific configuration options from the resource backend
# where they have been stored with the domain data. This feature is disabled by
# default (in which case the domain specific options will be loaded from files
# in the domain configuration directory); set to true to enable. (boolean
# value)
#domain_configurations_from_database = false
# Path for Keystone to locate the domain specific identity configuration files
# if domain_specific_drivers_enabled is set to true. (string value)
#domain_config_dir = /etc/keystone/domains
# Identity backend driver. (string value)
#driver = keystone.identity.backends.sql.Identity
# Toggle for identity caching. This has no effect unless global caching is
# enabled. (boolean value)
#caching = true
# Time to cache identity data (in seconds). This has no effect unless global
# and identity caching are enabled. (integer value)
#cache_time = 600
# Maximum supported length for user passwords; decrease to improve performance.
# (integer value)
#max_password_length = 4096
498
CHAPTER 7. IDENTITY SERVICE
# Maximum number of entities that will be returned in an identity collection.
# (integer value)
#list_limit = <None>
[identity_mapping]
#
# From keystone
#
# Keystone Identity Mapping backend driver. (string value)
#driver = keystone.identity.mapping_backends.sql.Mapping
# Public ID generator for user and group entities. The Keystone identity mapper
# only supports generators that produce no more than 64 characters.
(string
# value)
#generator = keystone.identity.id_generators.sha256.Generator
# The format of user and group IDs changed in Juno for backends that do not
# generate UUIDs (e.g. LDAP), with keystone providing a hash mapping to the
# underlying attribute in LDAP. By default this mapping is disabled, which
# ensures that existing IDs will not change. Even when the mapping is enabled
# by using domain specific drivers, any users and groups from the default
# domain being handled by LDAP will still not be mapped to ensure their
IDs
# remain backward compatible. Setting this value to False will enable the
# mapping for even the default LDAP driver. It is only safe to do this if you
# do not already have assignments for users and groups from the default
LDAP
# domain, and it is acceptable for Keystone to provide the different IDs to
# clients than it did previously. Typically this means that the only time you
# can set this value to False is when configuring a fresh installation.
# (boolean value)
#backward_compatible_ids = true
[kvs]
#
# From keystone
#
# Extra dogpile.cache backend modules to register with the dogpile.cache
# library. (list value)
499
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#backends =
# Prefix for building the configuration dictionary for the KVS region.
This
# should not need to be changed unless there is another dogpile.cache region
# with the same configuration name. (string value)
#config_prefix = keystone.kvs
# Toggle to disable using a key-mangling function to ensure fixed length keys.
# This is toggle-able for debugging purposes, it is highly recommended to
# always leave this set to true. (boolean value)
#enable_key_mangler = true
# Default lock timeout (in seconds) for distributed locking. (integer value)
#default_lock_timeout = 5
[ldap]
#
# From keystone
#
# URL for connecting to the LDAP server. (string value)
#url = ldap://localhost
# User BindDN to query the LDAP server. (string value)
#user = <None>
# Password for the BindDN to query the LDAP server. (string value)
#password = <None>
# LDAP server suffix (string value)
#suffix = cn=example,cn=com
# If true, will add a dummy member to groups. This is required if the
# objectclass for groups requires the "member" attribute. (boolean value)
#use_dumb_member = false
# DN of the "dummy member" to use when "use_dumb_member" is enabled.
(string
# value)
#dumb_member = cn=dumb,dc=nonexistent
# Delete subtrees using the subtree delete control. Only enable this option if
# your LDAP server supports subtree deletion. (boolean value)
#allow_subtree_delete = false
# The LDAP scope for queries, this can be either "one"
(onelevel/singleLevel)
# or "sub" (subtree/wholeSubtree). (string value)
#query_scope = one
500
CHAPTER 7. IDENTITY SERVICE
# Maximum results per page; a value of zero ("0") disables paging.
(integer
# value)
#page_size = 0
# The LDAP dereferencing option for queries. This can be either "never",
# "searching", "always", "finding" or "default". The "default" option falls
# back to using default dereferencing configured by your ldap.conf.
(string
# value)
#alias_dereferencing = default
# Sets the LDAP debugging level for LDAP calls. A value of 0 means that
# debugging is not enabled. This value is a bitmask, consult your LDAP
# documentation for possible values. (integer value)
#debug_level = <None>
# Override the system's default referral chasing behavior for queries.
(boolean
# value)
#chase_referrals = <None>
# Search base for users. (string value)
#user_tree_dn = <None>
# LDAP search filter for users. (string value)
#user_filter = <None>
# LDAP objectclass for users. (string value)
#user_objectclass = inetOrgPerson
# LDAP attribute mapped to user id. WARNING: must not be a multivalued
# attribute. (string value)
#user_id_attribute = cn
# LDAP attribute mapped to user name. (string value)
#user_name_attribute = sn
# LDAP attribute mapped to user email. (string value)
#user_mail_attribute = mail
# LDAP attribute mapped to password. (string value)
#user_pass_attribute = userPassword
# LDAP attribute mapped to user enabled flag. (string value)
#user_enabled_attribute = enabled
# Invert the meaning of the boolean enabled values. Some LDAP servers use a
# boolean lock attribute where "true" means an account is disabled.
Setting
# "user_enabled_invert = true" will allow these lock attributes to be used.
# This setting will have no effect if "user_enabled_mask" or
501
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# "user_enabled_emulation" settings are in use. (boolean value)
#user_enabled_invert = false
# Bitmask integer to indicate the bit that the enabled value is stored in if
# the LDAP server represents "enabled" as a bit on an integer rather than a
# boolean. A value of "0" indicates the mask is not used. If this is not set to
# "0" the typical value is "2". This is typically used when
# "user_enabled_attribute = userAccountControl". (integer value)
#user_enabled_mask = 0
# Default value to enable users. This should match an appropriate int value if
# the LDAP server uses non-boolean (bitmask) values to indicate if a user is
# enabled or disabled. If this is not set to "True" the typical value is
"512".
# This is typically used when "user_enabled_attribute = userAccountControl".
# (string value)
#user_enabled_default = True
# List of attributes stripped off the user on update. (list value)
#user_attribute_ignore = default_project_id,tenants
# LDAP attribute mapped to default_project_id for users. (string value)
#user_default_project_id_attribute = <None>
# Allow user creation in LDAP backend. (boolean value)
#user_allow_create = true
# Allow user updates in LDAP backend. (boolean value)
#user_allow_update = true
# Allow user deletion in LDAP backend. (boolean value)
#user_allow_delete = true
# If true, Keystone uses an alternative method to determine if a user is
# enabled or not by checking if they are a member of the
# "user_enabled_emulation_dn" group. (boolean value)
#user_enabled_emulation = false
# DN of the group entry to hold enabled users when using enabled emulation.
# (string value)
#user_enabled_emulation_dn = <None>
# List of additional LDAP attributes used for mapping additional attribute
# mappings for users. Attribute mapping format is <ldap_attr>:
<user_attr>,
# where ldap_attr is the attribute in the LDAP entry and user_attr is the
# Identity API attribute. (list value)
#user_additional_attribute_mapping =
502
CHAPTER 7. IDENTITY SERVICE
# Search base for projects (string value)
# Deprecated group/name - [ldap]/tenant_tree_dn
#project_tree_dn = <None>
# LDAP search filter for projects. (string value)
# Deprecated group/name - [ldap]/tenant_filter
#project_filter = <None>
# LDAP objectclass for projects. (string value)
# Deprecated group/name - [ldap]/tenant_objectclass
#project_objectclass = groupOfNames
# LDAP attribute mapped to project id. (string value)
# Deprecated group/name - [ldap]/tenant_id_attribute
#project_id_attribute = cn
# LDAP attribute mapped to project membership for user. (string value)
# Deprecated group/name - [ldap]/tenant_member_attribute
#project_member_attribute = member
# LDAP attribute mapped to project name. (string value)
# Deprecated group/name - [ldap]/tenant_name_attribute
#project_name_attribute = ou
# LDAP attribute mapped to project description. (string value)
# Deprecated group/name - [ldap]/tenant_desc_attribute
#project_desc_attribute = description
# LDAP attribute mapped to project enabled. (string value)
# Deprecated group/name - [ldap]/tenant_enabled_attribute
#project_enabled_attribute = enabled
# LDAP attribute mapped to project domain_id. (string value)
# Deprecated group/name - [ldap]/tenant_domain_id_attribute
#project_domain_id_attribute = businessCategory
# List of attributes stripped off the project on update. (list value)
# Deprecated group/name - [ldap]/tenant_attribute_ignore
#project_attribute_ignore =
# Allow project creation in LDAP backend. (boolean value)
# Deprecated group/name - [ldap]/tenant_allow_create
#project_allow_create = true
# Allow project update in LDAP backend. (boolean value)
# Deprecated group/name - [ldap]/tenant_allow_update
#project_allow_update = true
# Allow project deletion in LDAP backend. (boolean value)
# Deprecated group/name - [ldap]/tenant_allow_delete
#project_allow_delete = true
# If true, Keystone uses an alternative method to determine if a project is
# enabled or not by checking if they are a member of the
503
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# "project_enabled_emulation_dn" group. (boolean value)
# Deprecated group/name - [ldap]/tenant_enabled_emulation
#project_enabled_emulation = false
# DN of the group entry to hold enabled projects when using enabled emulation.
# (string value)
# Deprecated group/name - [ldap]/tenant_enabled_emulation_dn
#project_enabled_emulation_dn = <None>
# Additional attribute mappings for projects. Attribute mapping format is
# <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry
# and user_attr is the Identity API attribute. (list value)
# Deprecated group/name - [ldap]/tenant_additional_attribute_mapping
#project_additional_attribute_mapping =
# Search base for roles. (string value)
#role_tree_dn = <None>
# LDAP search filter for roles. (string value)
#role_filter = <None>
# LDAP objectclass for roles. (string value)
#role_objectclass = organizationalRole
# LDAP attribute mapped to role id. (string value)
#role_id_attribute = cn
# LDAP attribute mapped to role name. (string value)
#role_name_attribute = ou
# LDAP attribute mapped to role membership. (string value)
#role_member_attribute = roleOccupant
# List of attributes stripped off the role on update. (list value)
#role_attribute_ignore =
# Allow role creation in LDAP backend. (boolean value)
#role_allow_create = true
# Allow role update in LDAP backend. (boolean value)
#role_allow_update = true
# Allow role deletion in LDAP backend. (boolean value)
#role_allow_delete = true
# Additional attribute mappings for roles. Attribute mapping format is
# <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry
# and user_attr is the Identity API attribute. (list value)
#role_additional_attribute_mapping =
# Search base for groups. (string value)
#group_tree_dn = <None>
504
CHAPTER 7. IDENTITY SERVICE
# LDAP search filter for groups. (string value)
#group_filter = <None>
# LDAP objectclass for groups. (string value)
#group_objectclass = groupOfNames
# LDAP attribute mapped to group id. (string value)
#group_id_attribute = cn
# LDAP attribute mapped to group name. (string value)
#group_name_attribute = ou
# LDAP attribute mapped to show group membership. (string value)
#group_member_attribute = member
# LDAP attribute mapped to group description. (string value)
#group_desc_attribute = description
# List of attributes stripped off the group on update. (list value)
#group_attribute_ignore =
# Allow group creation in LDAP backend. (boolean value)
#group_allow_create = true
# Allow group update in LDAP backend. (boolean value)
#group_allow_update = true
# Allow group deletion in LDAP backend. (boolean value)
#group_allow_delete = true
# Additional attribute mappings for groups. Attribute mapping format is
# <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry
# and user_attr is the Identity API attribute. (list value)
#group_additional_attribute_mapping =
# CA certificate file path for communicating with LDAP servers. (string value)
#tls_cacertfile = <None>
# CA certificate directory path for communicating with LDAP servers.
(string
# value)
#tls_cacertdir = <None>
# Enable TLS for communicating with LDAP servers. (boolean value)
#use_tls = false
# Valid options for tls_req_cert are demand, never, and allow. (string value)
#tls_req_cert = demand
# Enable LDAP connection pooling. (boolean value)
#use_pool = false
# Connection pool size. (integer value)
505
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#pool_size = 10
# Maximum count of reconnect trials. (integer value)
#pool_retry_max = 3
# Time span in seconds to wait between two reconnect trials. (floating point
# value)
#pool_retry_delay = 0.1
# Connector timeout in seconds. Value -1 indicates indefinite wait for
# response. (integer value)
#pool_connection_timeout = -1
# Connection lifetime in seconds. (integer value)
#pool_connection_lifetime = 600
# Enable LDAP connection pooling for end user authentication. If use_pool is
# disabled, then this setting is meaningless and is not used at all.
(boolean
# value)
#use_auth_pool = false
# End user auth connection pool size. (integer value)
#auth_pool_size = 100
# End user auth connection lifetime in seconds. (integer value)
#auth_pool_connection_lifetime = 60
[matchmaker_redis]
#
# From oslo.messaging
#
# Host to locate redis. (string value)
#host = 127.0.0.1
# Use this port to connect to redis host. (integer value)
#port = 6379
# Password for Redis server (optional). (string value)
#password = <None>
[matchmaker_ring]
#
# From oslo.messaging
#
# Matchmaker ring file (JSON). (string value)
# Deprecated group/name - [DEFAULT]/matchmaker_ringfile
#ringfile = /etc/oslo/matchmaker_ring.json
506
CHAPTER 7. IDENTITY SERVICE
[memcache]
#
# From keystone
#
# Memcache servers in the format of "host:port". (list value)
#servers = localhost:11211
# Number of seconds memcached server is considered dead before it is tried
# again. This is used by the key value store system (e.g. token pooled
# memcached persistence backend). (integer value)
#dead_retry = 300
# Timeout in seconds for every call to a server. This is used by the key value
# store system (e.g. token pooled memcached persistence backend).
(integer
# value)
#socket_timeout = 3
# Max total number of open connections to every memcached server. This is used
# by the key value store system (e.g. token pooled memcached persistence
# backend). (integer value)
#pool_maxsize = 10
# Number of seconds a connection to memcached is held unused in the pool before
# it is closed. This is used by the key value store system (e.g. token pooled
# memcached persistence backend). (integer value)
#pool_unused_timeout = 60
# Number of seconds that an operation will wait to get a memcache client
# connection. This is used by the key value store system (e.g. token pooled
# memcached persistence backend). (integer value)
#pool_connection_get_timeout = 10
[oauth1]
#
# From keystone
#
# Credential backend driver. (string value)
#driver = keystone.contrib.oauth1.backends.sql.OAuth1
# Duration (in seconds) for the OAuth Request Token. (integer value)
#request_token_duration = 28800
507
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Duration (in seconds) for the OAuth Access Token. (integer value)
#access_token_duration = 86400
[os_inherit]
#
# From keystone
#
# role-assignment inheritance to projects from owning domain or from projects
# higher in the hierarchy can be optionally enabled. (boolean value)
#enabled = false
[oslo_messaging_amqp]
#
# From oslo.messaging
#
# address prefix used when sending to a specific server (string value)
# Deprecated group/name - [amqp1]/server_request_prefix
#server_request_prefix = exclusive
# address prefix used when broadcasting to all servers (string value)
# Deprecated group/name - [amqp1]/broadcast_prefix
#broadcast_prefix = broadcast
# address prefix when sending to any server in group (string value)
# Deprecated group/name - [amqp1]/group_request_prefix
#group_request_prefix = unicast
# Name for the AMQP container (string value)
# Deprecated group/name - [amqp1]/container_name
#container_name = <None>
# Timeout for inactive connections (in seconds) (integer value)
# Deprecated group/name - [amqp1]/idle_timeout
#idle_timeout = 0
# Debug: dump AMQP frames to stdout (boolean value)
# Deprecated group/name - [amqp1]/trace
#trace = false
# CA certificate PEM file for verifing server certificate (string value)
# Deprecated group/name - [amqp1]/ssl_ca_file
#ssl_ca_file =
# Identifying certificate PEM file to present to clients (string value)
# Deprecated group/name - [amqp1]/ssl_cert_file
#ssl_cert_file =
# Private key PEM file used to sign cert_file certificate (string value)
# Deprecated group/name - [amqp1]/ssl_key_file
508
CHAPTER 7. IDENTITY SERVICE
#ssl_key_file =
# Password for decrypting ssl_key_file (if encrypted) (string value)
# Deprecated group/name - [amqp1]/ssl_key_password
#ssl_key_password = <None>
# Accept clients using either SSL or plain TCP (boolean value)
# Deprecated group/name - [amqp1]/allow_insecure_clients
#allow_insecure_clients = false
[oslo_messaging_qpid]
#
# From oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
#amqp_durable_queues = false
# Auto-delete queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/amqp_auto_delete
#amqp_auto_delete = false
# Size of RPC connection pool. (integer value)
# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size
#rpc_conn_pool_size = 30
# Qpid broker hostname. (string value)
# Deprecated group/name - [DEFAULT]/qpid_hostname
#qpid_hostname = localhost
# Qpid broker port. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_port
#qpid_port = 5672
# Qpid HA cluster host:port pairs. (list value)
# Deprecated group/name - [DEFAULT]/qpid_hosts
#qpid_hosts = $qpid_hostname:$qpid_port
# Username for Qpid connection. (string value)
# Deprecated group/name - [DEFAULT]/qpid_username
#qpid_username =
# Password for Qpid connection. (string value)
# Deprecated group/name - [DEFAULT]/qpid_password
#qpid_password =
# Space separated list of SASL mechanisms to use for auth. (string value)
# Deprecated group/name - [DEFAULT]/qpid_sasl_mechanisms
#qpid_sasl_mechanisms =
# Seconds between connection keepalive heartbeats. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_heartbeat
#qpid_heartbeat = 60
509
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Transport to use, either 'tcp' or 'ssl'. (string value)
# Deprecated group/name - [DEFAULT]/qpid_protocol
#qpid_protocol = tcp
# Whether to disable the Nagle algorithm. (boolean value)
# Deprecated group/name - [DEFAULT]/qpid_tcp_nodelay
#qpid_tcp_nodelay = true
# The number of prefetched messages held by receiver. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_receiver_capacity
#qpid_receiver_capacity = 1
# The qpid topology version to use. Version 1 is what was originally used by
# impl_qpid. Version 2 includes some backwards-incompatible changes that allow
# broker federation to work. Users should update to version 2 when they are
# able to take everything down, as it requires a clean break. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_topology_version
#qpid_topology_version = 1
[oslo_messaging_rabbit]
#
# From oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
#amqp_durable_queues = false
# Auto-delete queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/amqp_auto_delete
#amqp_auto_delete = false
# Size of RPC connection pool. (integer value)
# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size
#rpc_conn_pool_size = 30
# SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and
# SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some
# distributions. (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_version
#kombu_ssl_version =
# SSL key file (valid only if SSL enabled). (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_keyfile
#kombu_ssl_keyfile =
# SSL cert file (valid only if SSL enabled). (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_certfile
510
CHAPTER 7. IDENTITY SERVICE
#kombu_ssl_certfile =
# SSL certification authority file (valid only if SSL enabled). (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_ca_certs
#kombu_ssl_ca_certs =
# How long to wait before reconnecting in response to an AMQP consumer cancel
# notification. (floating point value)
# Deprecated group/name - [DEFAULT]/kombu_reconnect_delay
#kombu_reconnect_delay = 1.0
# The RabbitMQ broker address where a single node is used. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_host
#rabbit_host = localhost
# The RabbitMQ broker port where a single node is used. (integer value)
# Deprecated group/name - [DEFAULT]/rabbit_port
#rabbit_port = 5672
# RabbitMQ HA cluster host:port pairs. (list value)
# Deprecated group/name - [DEFAULT]/rabbit_hosts
#rabbit_hosts = $rabbit_host:$rabbit_port
# Connect over SSL for RabbitMQ. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_use_ssl
#rabbit_use_ssl = false
# The RabbitMQ userid. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_userid
#rabbit_userid = guest
# The RabbitMQ password. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_password
#rabbit_password = guest
# The RabbitMQ login method. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_login_method
#rabbit_login_method = AMQPLAIN
# The RabbitMQ virtual host. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_virtual_host
#rabbit_virtual_host = /
# How frequently to retry connecting with RabbitMQ. (integer value)
#rabbit_retry_interval = 1
# How long to backoff for between retries when connecting to RabbitMQ.
(integer
# value)
# Deprecated group/name - [DEFAULT]/rabbit_retry_backoff
#rabbit_retry_backoff = 2
# Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry
511
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# count). (integer value)
# Deprecated group/name - [DEFAULT]/rabbit_max_retries
#rabbit_max_retries = 0
# Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you
# must wipe the RabbitMQ database. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_ha_queues
#rabbit_ha_queues = false
# Number of seconds after which the Rabbit broker is considered down if
# heartbeat's keep-alive fails (0 disable the heartbeat). (integer value)
#heartbeat_timeout_threshold = 60
# How often times during the heartbeat_timeout_threshold we check the
# heartbeat. (integer value)
#heartbeat_rate = 2
# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value)
# Deprecated group/name - [DEFAULT]/fake_rabbit
#fake_rabbit = false
[oslo_middleware]
#
# From oslo.middleware
#
# The maximum body size for each request, in bytes. (integer value)
# Deprecated group/name - [DEFAULT]/osapi_max_request_body_size
# Deprecated group/name - [DEFAULT]/max_request_body_size
#max_request_body_size = 114688
[oslo_policy]
#
# From oslo.policy
#
# The JSON file that defines policies. (string value)
# Deprecated group/name - [DEFAULT]/policy_file
#policy_file = policy.json
# Default rule. Enforced when a requested rule is not found. (string value)
# Deprecated group/name - [DEFAULT]/policy_default_rule
#policy_default_rule = default
# Directories where policy configuration files are stored. They can be relative
# to any directory in the search path defined by the config_dir option, or
# absolute paths. The file defined by policy_file must exist for these
512
CHAPTER 7. IDENTITY SERVICE
# directories to be searched. Missing or empty directories are ignored.
(multi
# valued)
# Deprecated group/name - [DEFAULT]/policy_dirs
#policy_dirs = policy.d
[paste_deploy]
#
# From keystone
#
# Name of the paste configuration file that defines the available pipelines.
# (string value)
#config_file = keystone-paste.ini
[policy]
#
# From keystone
#
# Policy backend driver. (string value)
#driver = keystone.policy.backends.sql.Policy
# Maximum number of entities that will be returned in a policy collection.
# (integer value)
#list_limit = <None>
[resource]
#
# From keystone
#
# Resource backend driver. If a resource driver is not specified, the
# assignment driver will choose the resource driver. (string value)
#driver = <None>
# Toggle for resource caching. This has no effect unless global caching is
# enabled. (boolean value)
# Deprecated group/name - [assignment]/caching
#caching = true
# TTL (in seconds) to cache resource data. This has no effect unless global
# caching is enabled. (integer value)
# Deprecated group/name - [assignment]/cache_time
#cache_time = <None>
# Maximum number of entities that will be returned in a resource
513
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
collection.
# (integer value)
# Deprecated group/name - [assignment]/list_limit
#list_limit = <None>
[revoke]
#
# From keystone
#
# An implementation of the backend for persisting revocation events.
(string
# value)
#driver = keystone.contrib.revoke.backends.sql.Revoke
# This value (calculated in seconds) is added to token expiration before a
# revocation event may be removed from the backend. (integer value)
#expiration_buffer = 1800
# Toggle for revocation event caching. This has no effect unless global caching
# is enabled. (boolean value)
#caching = true
# Time to cache the revocation list and the revocation events (in seconds).
# This has no effect unless global and token caching are enabled. (integer
# value)
# Deprecated group/name - [token]/revocation_cache_time
#cache_time = 3600
[role]
#
# From keystone
#
# Role backend driver. (string value)
#driver = <None>
# Toggle for role caching. This has no effect unless global caching is enabled.
# (boolean value)
#caching = true
# TTL (in seconds) to cache role data. This has no effect unless global caching
# is enabled. (integer value)
#cache_time = <None>
# Maximum number of entities that will be returned in a role collection.
# (integer value)
514
CHAPTER 7. IDENTITY SERVICE
#list_limit = <None>
[saml]
#
# From keystone
#
# Default TTL, in seconds, for any generated SAML assertion created by
# Keystone. (integer value)
#assertion_expiration_time = 3600
# Binary to be called for XML signing. Install the appropriate package, specify
# absolute path or adjust your PATH environment variable if the binary cannot
# be found. (string value)
#xmlsec1_binary = xmlsec1
# Path of the certfile for SAML signing. For non-production environments, you
# may be interested in using `keystone-manage pki_setup` to generate self-
# signed certificates. Note, the path cannot contain a comma. (string value)
#certfile = /etc/keystone/ssl/certs/signing_cert.pem
# Path of the keyfile for SAML signing. Note, the path cannot contain a comma.
# (string value)
#keyfile = /etc/keystone/ssl/private/signing_key.pem
# Entity ID value for unique Identity Provider identification. Usually
FQDN is
# set with a suffix. A value is required to generate IDP Metadata. For example:
# https://keystone.example.com/v3/OS-FEDERATION/saml2/idp (string value)
#idp_entity_id = <None>
# Identity Provider Single-Sign-On service value, required in the Identity
# Provider's metadata. A value is required to generate IDP Metadata. For
# example: https://keystone.example.com/v3/OS-FEDERATION/saml2/sso
(string
# value)
#idp_sso_endpoint = <None>
# Language used by the organization. (string value)
#idp_lang = en
# Organization name the installation belongs to. (string value)
#idp_organization_name = <None>
# Organization name to be displayed. (string value)
#idp_organization_display_name = <None>
515
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# URL of the organization. (string value)
#idp_organization_url = <None>
# Company of contact person. (string value)
#idp_contact_company = <None>
# Given name of contact person (string value)
#idp_contact_name = <None>
# Surname of contact person. (string value)
#idp_contact_surname = <None>
# Email address of contact person. (string value)
#idp_contact_email = <None>
# Telephone number of contact person. (string value)
#idp_contact_telephone = <None>
# Contact type. Allowed values are: technical, support, administrative billing,
# and other (string value)
#idp_contact_type = other
# Path to the Identity Provider Metadata file. This file should be generated
# with the keystone-manage saml_idp_metadata command. (string value)
#idp_metadata_path = /etc/keystone/saml2_idp_metadata.xml
# The prefix to use for the RelayState SAML attribute, used when generating ECP
# wrapped assertions. (string value)
#relay_state_prefix = ss:mem:
[signing]
#
# From keystone
#
# Path of the certfile for token signing. For non-production environments, you
# may be interested in using `keystone-manage pki_setup` to generate self-
# signed certificates. (string value)
#certfile = /etc/keystone/ssl/certs/signing_cert.pem
# Path of the keyfile for token signing. (string value)
#keyfile = /etc/keystone/ssl/private/signing_key.pem
# Path of the CA for token signing. (string value)
#ca_certs = /etc/keystone/ssl/certs/ca.pem
# Path of the CA key for token signing. (string value)
#ca_key = /etc/keystone/ssl/private/cakey.pem
516
CHAPTER 7. IDENTITY SERVICE
# Key size (in bits) for token signing cert (auto generated certificate).
# (integer value)
#key_size = 2048
# Days the token signing cert is valid for (auto generated certificate).
# (integer value)
#valid_days = 3650
# Certificate subject (auto generated certificate) for token signing.
(string
# value)
#cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com
[ssl]
#
# From keystone
#
# Path of the CA key file for SSL. (string value)
#ca_key = /etc/keystone/ssl/private/cakey.pem
# SSL key length (in bits) (auto generated certificate). (integer value)
#key_size = 1024
# Days the certificate is valid for once signed (auto generated certificate).
# (integer value)
#valid_days = 3650
# SSL certificate subject (auto generated certificate). (string value)
#cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=localhost
[token]
#
# From keystone
#
# External auth mechanisms that should add bind information to token, e.g.,
# kerberos,x509. (list value)
#bind =
# Enforcement policy on tokens presented to Keystone with bind information. One
# of disabled, permissive, strict, required or a specifically required bind
# mode, e.g., kerberos or x509 to require binding to that authentication.
# (string value)
#enforce_token_bind = permissive
# Amount of time a token should remain valid (in seconds). (integer value)
517
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#expiration = 3600
# Controls the token construction, validation, and revocation operations.
Core
# providers are "keystone.token.providers.
[fernet|pkiz|pki|uuid].Provider".
# (string value)
#provider = keystone.token.providers.uuid.Provider
# Token persistence backend driver. (string value)
#driver = keystone.token.persistence.backends.sql.Token
# Toggle for token system caching. This has no effect unless global caching is
# enabled. (boolean value)
#caching = true
# Time to cache tokens (in seconds). This has no effect unless global and token
# caching are enabled. (integer value)
#cache_time = <None>
# Revoke token by token identifier. Setting revoke_by_id to true enables
# various forms of enumerating tokens, e.g. `list tokens for user`. These
# enumerations are processed to determine the list of tokens to revoke.
Only
# disable if you are switching to using the Revoke extension with a backend
# other than KVS, which stores events in memory. (boolean value)
#revoke_by_id = true
# Allow rescoping of scoped token. Setting allow_rescoped_scoped_token to false
# prevents a user from exchanging a scoped token for any other token.
(boolean
# value)
#allow_rescope_scoped_token = true
# The hash algorithm to use for PKI tokens. This can be set to any algorithm
# that hashlib supports. WARNING: Before changing this value, the auth_token
# middleware must be configured with the hash_algorithms, otherwise token
# revocation will not be processed correctly. (string value)
#hash_algorithm = md5
[trust]
#
# From keystone
#
# Delegation and impersonation features can be optionally disabled.
(boolean
# value)
518
CHAPTER 7. IDENTITY SERVICE
#enabled = true
# Enable redelegation feature. (boolean value)
#allow_redelegation = false
# Maximum depth of trust redelegation. (integer value)
#max_redelegation_count = 3
# Trust backend driver. (string value)
#driver = keystone.trust.backends.sql.Trust
7.2.2. keystone-paste.ini
Use the keystone-paste.ini file to configure the Web Service Gateway Interface (WSGI) middleware pipeline for the Identity service.
# Keystone PasteDeploy configuration file.
[filter:debug] paste.filter_factory = keystone.common.wsgi:Debug.factory
[filter:request_id] paste.filter_factory = oslo_middleware:RequestId.factory
[filter:build_auth_context] paste.filter_factory = keystone.middleware:AuthContextMiddleware.factory
[filter:token_auth] paste.filter_factory = keystone.middleware:TokenAuthMiddleware.factory
[filter:admin_token_auth] paste.filter_factory = keystone.middleware:AdminTokenAuthMiddleware.factory
[filter:json_body] paste.filter_factory = keystone.middleware:JsonBodyMiddleware.factory
[filter:user_crud_extension] paste.filter_factory = keystone.contrib.user_crud:CrudExtension.factory
[filter:crud_extension] paste.filter_factory = keystone.contrib.admin_crud:CrudExtension.factory
[filter:ec2_extension] paste.filter_factory = keystone.contrib.ec2:Ec2Extension.factory
[filter:ec2_extension_v3] paste.filter_factory = keystone.contrib.ec2:Ec2ExtensionV3.factory
[filter:federation_extension] paste.filter_factory = keystone.contrib.federation.routers:FederationExtension.factory
519
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
[filter:oauth1_extension] paste.filter_factory = keystone.contrib.oauth1.routers:OAuth1Extension.factory
[filter:s3_extension] paste.filter_factory = keystone.contrib.s3:S3Extension.factory
[filter:endpoint_filter_extension] paste.filter_factory = keystone.contrib.endpoint_filter.routers:EndpointFilterExtension.factory
[filter:endpoint_policy_extension] paste.filter_factory = keystone.contrib.endpoint_policy.routers:EndpointPolicyExtension.factory
[filter:simple_cert_extension] paste.filter_factory = keystone.contrib.simple_cert:SimpleCertExtension.factory
[filter:revoke_extension] paste.filter_factory = keystone.contrib.revoke.routers:RevokeExtension.factory
[filter:url_normalize] paste.filter_factory = keystone.middleware:NormalizingFilter.factory
[filter:sizelimit] paste.filter_factory = oslo_middleware.sizelimit:RequestBodySizeLimiter.factory
[app:public_service] paste.app_factory = keystone.service:public_app_factory
[app:service_v3] paste.app_factory = keystone.service:v3_app_factory
[app:admin_service] paste.app_factory = keystone.service:admin_app_factory
[pipeline:public_api]
# The last item in this pipeline must be public_service or an equivalent
# application. It cannot be a filter.
pipeline = sizelimit url_normalize request_id build_auth_context token_auth admin_token_auth json_body ec2_extension user_crud_extension public_service
[pipeline:admin_api]
# The last item in this pipeline must be admin_service or an equivalent
# application. It cannot be a filter.
pipeline = sizelimit url_normalize request_id build_auth_context token_auth admin_token_auth json_body ec2_extension s3_extension crud_extension admin_service
[pipeline:api_v3]
# The last item in this pipeline must be service_v3 or an equivalent
520
CHAPTER 7. IDENTITY SERVICE
# application. It cannot be a filter.
pipeline = sizelimit url_normalize request_id build_auth_context token_auth admin_token_auth json_body ec2_extension_v3 s3_extension simple_cert_extension revoke_extension federation_extension oauth1_extension endpoint_filter_extension endpoint_policy_extension service_v3
[app:public_version_service] paste.app_factory = keystone.service:public_version_app_factory
[app:admin_version_service] paste.app_factory = keystone.service:admin_version_app_factory
[pipeline:public_version_api] pipeline = sizelimit url_normalize public_version_service
[pipeline:admin_version_api] pipeline = sizelimit url_normalize admin_version_service
[composite:main] use = egg:Paste#urlmap
/v2.0 = public_api
/v3 = api_v3
/ = public_version_api
[composite:admin] use = egg:Paste#urlmap
/v2.0 = admin_api
/v3 = api_v3
/ = admin_version_api
7.2.3. logging.conf
You can specify a special logging configuration file in the keystone.conf configuration file. For example, /etc/keystone/logging.conf.
For details, see the ( Python logging module documentation ).
[loggers] keys=root,access
[handlers] keys=production,file,access_file,devel
[formatters] keys=minimal,normal,debug
###########
# Loggers #
###########
521
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
[logger_root] level=WARNING handlers=file
[logger_access] level=INFO qualname=access handlers=access_file
################
# Log Handlers #
################
[handler_production] class=handlers.SysLogHandler
level=ERROR formatter=normal args=(('localhost', handlers.SYSLOG_UDP_PORT), handlers.SysLogHandler.LOG_USER)
[handler_file] class=handlers.WatchedFileHandler
level=WARNING formatter=normal args=('error.log',)
[handler_access_file] class=handlers.WatchedFileHandler
level=INFO formatter=minimal args=('access.log',)
[handler_devel] class=StreamHandler level=NOTSET formatter=debug args=(sys.stdout,)
##################
# Log Formatters #
##################
[formatter_minimal] format=%(message)s
[formatter_normal] format=(%(name)s): %(asctime)s %(levelname)s %(message)s
[formatter_debug] format=(%(name)s): %(asctime)s %(levelname)s %(module)s %(funcName)s %
522
CHAPTER 7. IDENTITY SERVICE
(message)s
7.2.4. policy.json
Use the policy.json file to define additional access controls that apply to the Identity service.
{
"admin_required": "role:admin or is_admin:1",
"service_role": "role:service",
"service_or_admin": "rule:admin_required or rule:service_role",
"owner" : "user_id:%(user_id)s",
"admin_or_owner": "rule:admin_required or rule:owner",
"token_subject": "user_id:%(target.token.user_id)s",
"admin_or_token_subject": "rule:admin_required or rule:token_subject",
"default": "rule:admin_required",
"identity:get_region": "",
"identity:list_regions": "",
"identity:create_region": "rule:admin_required",
"identity:update_region": "rule:admin_required",
"identity:delete_region": "rule:admin_required",
"identity:get_service": "rule:admin_required",
"identity:list_services": "rule:admin_required",
"identity:create_service": "rule:admin_required",
"identity:update_service": "rule:admin_required",
"identity:delete_service": "rule:admin_required",
"identity:get_endpoint": "rule:admin_required",
"identity:list_endpoints": "rule:admin_required",
"identity:create_endpoint": "rule:admin_required",
"identity:update_endpoint": "rule:admin_required",
"identity:delete_endpoint": "rule:admin_required",
"identity:get_domain": "rule:admin_required",
"identity:list_domains": "rule:admin_required",
"identity:create_domain": "rule:admin_required",
"identity:update_domain": "rule:admin_required",
"identity:delete_domain": "rule:admin_required",
"identity:get_project": "rule:admin_required",
"identity:list_projects": "rule:admin_required",
"identity:list_user_projects": "rule:admin_or_owner",
"identity:create_project": "rule:admin_required",
"identity:update_project": "rule:admin_required",
"identity:delete_project": "rule:admin_required",
"identity:get_user": "rule:admin_required",
"identity:list_users": "rule:admin_required",
"identity:create_user": "rule:admin_required",
523
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"identity:update_user": "rule:admin_required",
"identity:delete_user": "rule:admin_required",
"identity:change_password": "rule:admin_or_owner",
"identity:get_group": "rule:admin_required",
"identity:list_groups": "rule:admin_required",
"identity:list_groups_for_user": "rule:admin_or_owner",
"identity:create_group": "rule:admin_required",
"identity:update_group": "rule:admin_required",
"identity:delete_group": "rule:admin_required",
"identity:list_users_in_group": "rule:admin_required",
"identity:remove_user_from_group": "rule:admin_required",
"identity:check_user_in_group": "rule:admin_required",
"identity:add_user_to_group": "rule:admin_required",
"identity:get_credential": "rule:admin_required",
"identity:list_credentials": "rule:admin_required",
"identity:create_credential": "rule:admin_required",
"identity:update_credential": "rule:admin_required",
"identity:delete_credential": "rule:admin_required",
"identity:ec2_get_credential": "rule:admin_required or (rule:owner and user_id:%(target.credential.user_id)s)",
"identity:ec2_list_credentials": "rule:admin_or_owner",
"identity:ec2_create_credential": "rule:admin_or_owner",
"identity:ec2_delete_credential": "rule:admin_required or (rule:owner and user_id:%(target.credential.user_id)s)",
"identity:get_role": "rule:admin_required",
"identity:list_roles": "rule:admin_required",
"identity:create_role": "rule:admin_required",
"identity:update_role": "rule:admin_required",
"identity:delete_role": "rule:admin_required",
"identity:check_grant": "rule:admin_required",
"identity:list_grants": "rule:admin_required",
"identity:create_grant": "rule:admin_required",
"identity:revoke_grant": "rule:admin_required",
"identity:list_role_assignments": "rule:admin_required",
"identity:get_policy": "rule:admin_required",
"identity:list_policies": "rule:admin_required",
"identity:create_policy": "rule:admin_required",
"identity:update_policy": "rule:admin_required",
"identity:delete_policy": "rule:admin_required",
"identity:check_token": "rule:admin_required",
"identity:validate_token": "rule:service_or_admin",
"identity:validate_token_head": "rule:service_or_admin",
"identity:revocation_list": "rule:service_or_admin",
"identity:revoke_token": "rule:admin_or_token_subject",
"identity:create_trust": "user_id:%(trust.trustor_user_id)s",
"identity:get_trust": "rule:admin_or_owner",
"identity:list_trusts": "",
524
CHAPTER 7. IDENTITY SERVICE
"identity:list_roles_for_trust": "",
"identity:get_role_for_trust": "",
"identity:delete_trust": "",
"identity:create_consumer": "rule:admin_required",
"identity:get_consumer": "rule:admin_required",
"identity:list_consumers": "rule:admin_required",
"identity:delete_consumer": "rule:admin_required",
"identity:update_consumer": "rule:admin_required",
"identity:authorize_request_token": "rule:admin_required",
"identity:list_access_token_roles": "rule:admin_required",
"identity:get_access_token_role": "rule:admin_required",
"identity:list_access_tokens": "rule:admin_required",
"identity:get_access_token": "rule:admin_required",
"identity:delete_access_token": "rule:admin_required",
"identity:list_projects_for_endpoint": "rule:admin_required",
"identity:add_endpoint_to_project": "rule:admin_required",
"identity:check_endpoint_in_project": "rule:admin_required",
"identity:list_endpoints_for_project": "rule:admin_required",
"identity:remove_endpoint_from_project": "rule:admin_required",
"identity:create_endpoint_group": "rule:admin_required",
"identity:list_endpoint_groups": "rule:admin_required",
"identity:get_endpoint_group": "rule:admin_required",
"identity:update_endpoint_group": "rule:admin_required",
"identity:delete_endpoint_group": "rule:admin_required",
"identity:list_projects_associated_with_endpoint_group":
"rule:admin_required",
"identity:list_endpoints_associated_with_endpoint_group":
"rule:admin_required",
"identity:get_endpoint_group_in_project": "rule:admin_required",
"identity:add_endpoint_group_to_project": "rule:admin_required",
"identity:remove_endpoint_group_from_project": "rule:admin_required",
"identity:create_identity_provider": "rule:admin_required",
"identity:list_identity_providers": "rule:admin_required",
"identity:get_identity_providers": "rule:admin_required",
"identity:update_identity_provider": "rule:admin_required",
"identity:delete_identity_provider": "rule:admin_required",
"identity:create_protocol": "rule:admin_required",
"identity:update_protocol": "rule:admin_required",
"identity:get_protocol": "rule:admin_required",
"identity:list_protocols": "rule:admin_required",
"identity:delete_protocol": "rule:admin_required",
"identity:create_mapping": "rule:admin_required",
"identity:get_mapping": "rule:admin_required",
"identity:list_mappings": "rule:admin_required",
"identity:delete_mapping": "rule:admin_required",
"identity:update_mapping": "rule:admin_required",
"identity:create_service_provider": "rule:admin_required",
"identity:list_service_providers": "rule:admin_required",
525
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"identity:get_service_provider": "rule:admin_required",
"identity:update_service_provider": "rule:admin_required",
"identity:delete_service_provider": "rule:admin_required",
"identity:get_auth_catalog": "",
"identity:get_auth_projects": "",
"identity:get_auth_domains": "",
"identity:list_projects_for_groups": "",
"identity:list_domains_for_groups": "",
"identity:list_revoke_events": "",
"identity:create_policy_association_for_endpoint":
"rule:admin_required",
"identity:check_policy_association_for_endpoint":
"rule:admin_required",
"identity:delete_policy_association_for_endpoint":
"rule:admin_required",
"identity:create_policy_association_for_service":
"rule:admin_required",
"identity:check_policy_association_for_service":
"rule:admin_required",
"identity:delete_policy_association_for_service":
"rule:admin_required",
"identity:create_policy_association_for_region_and_service":
"rule:admin_required",
"identity:check_policy_association_for_region_and_service":
"rule:admin_required",
"identity:delete_policy_association_for_region_and_service":
"rule:admin_required",
"identity:get_policy_for_endpoint": "rule:admin_required",
"identity:list_endpoints_for_policy": "rule:admin_required",
"identity:create_domain_config": "rule:admin_required",
"identity:get_domain_config": "rule:admin_required",
"identity:update_domain_config": "rule:admin_required",
"identity:delete_domain_config": "rule:admin_required"
}
7.2.5. Domain-specific configuration
The Identity service enables you to configure domain-specific authentication drivers. For example, you can configure a domain to have its own LDAP or SQL server.
By default, the option to configure domain-specific drivers is disabled.
To enable domain-specific drivers, set these options in the [identity] section in the
keystone.conf file:
[identity] domain_specific_drivers_enabled = True domain_config_dir = /etc/keystone/domains
526
CHAPTER 7. IDENTITY SERVICE
When you enable domain-specific drivers, the Identity service looks in the domain_config_dir directory for configuration files that are named as follows: keystone.DOMAIN_NAME.conf, where
DOMAIN_NAME is the domain name.
Any options that you define in the domain-specific configuration file override options in the primary configuration file for the specified domain. Any domain without a domain-specific configuration file uses only the options in the primary configuration file.
7.3. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
OPENSTACK IDENTITY
Table 7.36. New options
Option = default value
[DEFAULT] log-config-append = None
[DEFAULT] log-date-format = %Y-%m-%d
%H:%M:%S
[DEFAULT] log-dir = None
[DEFAULT] log-file = None
[DEFAULT] log-format = None
[DEFAULT] max_project_tree_depth = 5
[DEFAULT] notification_format = basic
(Type) Help string
(StrOpt) 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.
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(IntOpt) Maximum depth of the project hierarchy.
WARNING: setting it to a large value may adversely impact performance.
(StrOpt) Define the notification format for Identity
Service events. A "basic" notification has information about the resource being operated on.
A "cadf" notification has the same information, as well as information about the initiator of the event.
Valid options are: basic and cadf
527
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] secure_proxy_ssl_header = None
[DEFAULT] syslog-log-facility = LOG_USER
[DEFAULT] use-syslog = False
[DEFAULT] use-syslog-rfc-format = False
(Type) Help string
(StrOpt) The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is "HTTP_X_FORWARDED_PROTO".
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(StrOpt) The oAuth1.0 auth plugin module.
[auth] oauth1 = keystone.auth.plugins.oauth1.OAuth
[domain_config] cache_time = 300
[domain_config] caching = True
[domain_config] driver = keystone.resource.config_backends.sql.DomainCo
nfig
(StrOpt) Domain config backend driver.
[eventlet_server] admin_bind_host = 0.0.0.0
[eventlet_server] admin_port = 35357
(StrOpt) The IP address of the network interface for the admin service to listen on.
(IntOpt) The port number which the admin service listens on.
[eventlet_server] admin_workers = None
(IntOpt) TTL (in seconds) to cache domain config data. This has no effect unless domain config caching is enabled.
(BoolOpt) Toggle for domain config caching. This has no effect unless global caching is enabled.
[eventlet_server] public_bind_host = 0.0.0.0
[eventlet_server] public_port = 5000
[eventlet_server] public_workers = None
(IntOpt) The number of worker processes to serve the admin eventlet application. Defaults to number of CPUs (minimum of 2).
(StrOpt) The IP address of the network interface for the public service to listen on.
(IntOpt) The port number which the public service listens on.
(IntOpt) The number of worker processes to serve the public eventlet application. Defaults to number of CPUs (minimum of 2).
528
CHAPTER 7. IDENTITY SERVICE
Option = default value
[eventlet_server] tcp_keepalive = False
[eventlet_server] tcp_keepidle = 600
[federation] remote_id_attribute = None
[federation] sso_callback_template =
/etc/keystone/sso_callback_template.html
[federation] trusted_dashboard = []
(Type) Help string
(BoolOpt) Set this to true if you want to enable
TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections.
(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true.
(StrOpt) Path of the CA cert file for SSL.
[eventlet_server_ssl] ca_certs =
/etc/keystone/ssl/certs/ca.pem
[eventlet_server_ssl] cert_required = False
[eventlet_server_ssl] certfile =
/etc/keystone/ssl/certs/keystone.pem
[eventlet_server_ssl] enable = False
[eventlet_server_ssl] keyfile =
/etc/keystone/ssl/private/keystonekey.pem
[federation] federated_domain_name = Federated
(BoolOpt) Require client certificate.
(StrOpt) Path of the certfile for SSL. For nonproduction environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates.
(BoolOpt) Toggle for SSL support on the Keystone eventlet servers.
(StrOpt) Path of the keyfile for SSL.
(StrOpt) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to.
Changing this option to empty string or None will not have any impact and default name will be used.
(StrOpt) Value to be used to obtain the entity ID of the Identity Provider from the environment (e.g. if using the mod_shib plugin this value is `Shib-
Identity-Provider`).
(StrOpt) Location of Single Sign-On callback handler, will return a token to a trusted dashboard host.
(MultiStrOpt) A list of trusted dashboard hosts.
Before accepting a Single Sign-On request to return a token, the origin host must be a member of the trusted_dashboard list. This configuration option may be repeated for multiple values. For example: trusted_dashboard=http://acme.com
trusted_dashboard=http://beta.com
529
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[fernet_tokens] key_repository =
/etc/keystone/fernet-keys/
[fernet_tokens] max_active_keys = 3
[identity] cache_time = 600
[identity] caching = True
[identity] domain_configurations_from_database =
False
[oslo_messaging_amqp] allow_insecure_clients =
False
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
(Type) Help string
(StrOpt) Directory containing Fernet token keys.
(IntOpt) This controls how many keys are held in rotation by keystone-manage fernet_rotate before they are discarded. The default value of 3 means that keystone will maintain one staged key, one primary key, and one secondary key. Increasing this value means that additional secondary keys will be kept in the rotation.
(IntOpt) Time to cache identity data (in seconds).
This has no effect unless global and identity caching are enabled.
(BoolOpt) Toggle for identity caching. This has no effect unless global caching is enabled.
(BoolOpt) Extract the domain specific configuration options from the resource backend where they have been stored with the domain data. This feature is disabled by default (in which case the domain specific options will be loaded from files in the domain configuration directory); set to true to enable.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
530
CHAPTER 7. IDENTITY SERVICE
Option = default value
[oslo_messaging_amqp] ssl_key_file =
[oslo_messaging_amqp] ssl_key_password =
None
[oslo_messaging_amqp] trace = False
(Type) Help string
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] amqp_durable_queues =
False
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_qpid] qpid_heartbeat = 60 (IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
[oslo_messaging_qpid] qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
[oslo_messaging_qpid] qpid_sasl_mechanisms = (StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
[oslo_messaging_qpid] qpid_tcp_nodelay = True
[oslo_messaging_qpid] qpid_topology_version = 1 (IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30
[oslo_messaging_rabbit] amqp_auto_delete =
False
(IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
531
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] amqp_durable_queues =
False
[oslo_messaging_rabbit] fake_rabbit = False
(Type) Help string
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_rabbit] heartbeat_rate = 2
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
532
CHAPTER 7. IDENTITY SERVICE
Option = default value
[oslo_messaging_rabbit] rabbit_port = 5672
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
[oslo_messaging_rabbit] rabbit_retry_interval = 1
[oslo_messaging_rabbit] rabbit_use_ssl = False
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
[oslo_policy] policy_file = policy.json
[resource] cache_time = None
[resource] caching = True
[resource] driver = None
[resource] list_limit = None
[revoke] cache_time = 3600
(Type) Help string
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
[oslo_messaging_rabbit] rpc_conn_pool_size = 30
[oslo_middleware] max_request_body_size =
114688
[oslo_policy] policy_default_rule = default
[oslo_policy] policy_dirs = ['policy.d']
(IntOpt) Size of RPC connection pool.
(IntOpt) The maximum body size for each request, in bytes.
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
(IntOpt) TTL (in seconds) to cache resource data.
This has no effect unless global caching is enabled.
(BoolOpt) Toggle for resource caching. This has no effect unless global caching is enabled.
(StrOpt) Resource backend driver. If a resource driver is not specified, the assignment driver will choose the resource driver.
(IntOpt) Maximum number of entities that will be returned in a resource collection.
(IntOpt) Time to cache the revocation list and the revocation events (in seconds). This has no effect unless global and token caching are enabled.
533
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[role] cache_time = None
[role] caching = True
[role] driver = None
[role] list_limit = None
[saml] relay_state_prefix = ss:mem:
[token] allow_rescope_scoped_token = True
[trust] allow_redelegation = False
[trust] max_redelegation_count = 3
(Type) Help string
(IntOpt) TTL (in seconds) to cache role data. This has no effect unless global caching is enabled.
(BoolOpt) Toggle for role caching. This has no effect unless global caching is enabled.
(StrOpt) Role backend driver.
(IntOpt) Maximum number of entities that will be returned in a role collection.
(StrOpt) The prefix to use for the RelayState SAML attribute, used when generating ECP wrapped assertions.
(BoolOpt) Allow rescoping of scoped token. Setting allow_rescoped_scoped_token to false prevents a user from exchanging a scoped token for any other token.
(BoolOpt) Enable redelegation feature.
(IntOpt) Maximum depth of trust redelegation.
Table 7.37. New default values
Option
[DEFAULT] default_log_levels
[DEFAULT] rpc_zmq_matchmaker
Previous default value New default value amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retr
y=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN oslo.messaging._drivers.matchm
aker.MatchMakerLocalhost
local
534
Option
[auth] methods
[revoke] driver
[token] provider
Table 7.38. Deprecated options
Deprecated option
[DEFAULT] admin_bind_host
[DEFAULT] log-format
[DEFAULT] use-syslog
[DEFAULT] admin_workers
[assignment] list_limit
[DEFAULT] admin_port
[assignment] caching
[DEFAULT] max_request_body_size
[assignment] cache_time
[DEFAULT] tcp_keepidle
[ssl] cert_required
[DEFAULT] public_port
[DEFAULT] public_bind_host
[DEFAULT] tcp_keepalive
[token] revocation_cache_time
[DEFAULT] public_workers
[ssl] keyfile
CHAPTER 7. IDENTITY SERVICE
Previous default value external, password, token
New default value external, password, token, oauth1 keystone.contrib.revoke.backend
s.kvs.Revoke
keystone.contrib.revoke.backend
s.sql.Revoke
None keystone.token.providers.uuid.Pr
ovider
New Option
[eventlet_server] admin_bind_host
None
None
[eventlet_server] admin_workers
[resource] list_limit
[eventlet_server] admin_port
[resource] caching
[oslo_middleware] max_request_body_size
[resource] cache_time
[eventlet_server] tcp_keepidle
[eventlet_server_ssl] cert_required
[eventlet_server] public_port
[eventlet_server] public_bind_host
[eventlet_server] tcp_keepalive
[revoke] cache_time
[eventlet_server] public_workers
[eventlet_server_ssl] keyfile
535
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Deprecated option
[ssl] ca_certs
[ssl] enable
[ssl] certfile
New Option
[eventlet_server_ssl] ca_certs
[eventlet_server_ssl] enable
[eventlet_server_ssl] certfile
536
CHAPTER 8. IMAGE SERVICE
CHAPTER 8. IMAGE SERVICE
Compute relies on an external image service to store virtual machine images and maintain a catalog of available images. By default, Compute is configured to use the OpenStack Image service
(glance), which is currently the only supported image service.
If your installation requires euca2ools to register new images, you must run the nova-
objectstore service. This service provides an Amazon S3 front-end for Image service, which is required by euca2ools.
To customize the Compute service, use the configuration option settings documented in Table 3.29,
“Description of glance configuration options” and Table 3.49, “Description of S3 configuration
You can modify many options in the OpenStack Image service. The following tables provide a comprehensive list.
Table 8.1. Description of authorization token configuration options
Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
admin_token
= None
Description admin_user
= None
auth_admin_prefix
=
auth_host
= 127.0.0.1
auth_plugin
= None
auth_port
= 35357
(StrOpt) Service user password.
(StrOpt) Service tenant name.
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
537
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value auth_protocol
= https
auth_section auth_uri cache
= None
cafile
= None
certfile
= None
= None
auth_version
= None
= None
check_revocations_for_cached
= False
delay_auth_decision enforce_token_bind hash_algorithms
= False
= permissive
= md5
Description
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
538
CHAPTER 8. IMAGE SERVICE
Configuration option = Default value http_connect_timeout
= None
http_request_max_retries identity_uri include_service_catalog insecure keyfile
= None
= False
= None
memcache_pool_dead_retry memcache_pool_maxsize memcache_secret_key
= 10
= None
= 3
= True
memcache_pool_conn_get_timeout
= 10
= 300
memcache_pool_socket_timeout memcache_pool_unused_timeout
= 3
= 60
Description
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times are we trying to reconnect when communicating with Identity API
Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
539
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value memcache_security_strategy
= None
memcache_use_advanced_pool revocation_cache_time signing_dir
= None
token_cache_time
= 300
= 10
= False
Description
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
Table 8.2. Description of common configuration options
Configuration option = Default value
[DEFAULT] allow_additional_image_properties
= True
api_limit_max backlog
= 4096
bind_host
= 1000
= 0.0.0.0
Description
(BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides
(IntOpt) Maximum permissible number of items that could be returned by a request
(IntOpt) The backlog value that will be used when creating the TCP listener socket.
(StrOpt) Address to bind the server. Useful when selecting a particular network interface.
540
Configuration option = Default value bind_port
= None
data_api
= glance.db.sqlalchemy.api
digest_algorithm
= sha1
host
= localhost
image_location_quota
= 10
image_member_quota
= 128
image_property_quota
= 128
image_tag_quota
= 128
limit_param_default
= 25
listener_workers
= 1
memcached_servers
= None
metadata_encryption_key
= None
metadata_source_path
/etc/glance/metadefs/
=
CHAPTER 8. IMAGE SERVICE
Description
(IntOpt) The port on which the server will listen.
(StrOpt) Python module path of data access API
(StrOpt) Digest algorithm which will be used for digital signature; the default is sha1 the default in
Kilo for a smooth upgrade process, and it will be updated with sha256 in next release(L). Use the command "openssl list-message-digest-algorithms" to get the available algorithms supported by the version of OpenSSL on the platform. Examples are
"sha1", "sha256", "sha512", etc.
(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier.
(IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited.
(IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited.
(IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited.
(IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited.
(IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request
(IntOpt) Number of workers for notification service.
A single notification agent is enabled by default.
(ListOpt) Memcached servers or None for in process cache.
(StrOpt) AES key for encrypting store 'location' metadata. This includes, if used, Swift or S3 credentials. Should be set to a random string of length 16, 24 or 32 bytes
(StrOpt) Path to the directory where json metadata files are stored
541
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value property_protection_file
= None
property_protection_rule_format
roles
show_image_direct_url user_storage_quota workers
= 4
= 0
= False
=
Description
(StrOpt) The location of the property protection file.This file contains the rules for property protections and the roles/policies associated with it.
If this config value is not specified, by default, property protections won't be enforced. If a value is specified and the file is not found, then the glanceapi service will not start.
(StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file.
(BoolOpt) Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!
(StrOpt) Set a system wide quota for every user.
This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes,
GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.
(IntOpt) The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available.
[glance_store] os_region_name
= None
[image_format]
(StrOpt) Region name of this node
container_formats
= ami, ari, aki, bare, ovf,
ova
(ListOpt) Supported values for the
'container_format' image attribute
disk_formats
qcow2, vdi, iso
= ami, ari, aki, vhd, vmdk, raw,
[keystone_authtoken] memcached_servers
= None
(ListOpt) Supported values for the 'disk_format' image attribute
(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
[service_credentials]
542
Configuration option = Default value insecure
= False
os_auth_url
= http://localhost:5000/v2.0
os_cacert
= None
os_endpoint_type
= publicURL
os_password
= admin
os_region_name
= None
os_tenant_id
=
os_tenant_name
= admin
os_username
= glance
[task] task_executor
= taskflow
task_time_to_live
= 48
CHAPTER 8. IMAGE SERVICE
Description
(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.
(StrOpt) Auth URL to use for OpenStack service access.
(StrOpt) Certificate chain for SSL validation.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
(StrOpt) Password to use for OpenStack service access.
(StrOpt) Region name to use for OpenStack service endpoints.
(StrOpt) Tenant ID to use for OpenStack service access.
(StrOpt) Tenant name to use for OpenStack service access.
(StrOpt) User name to use for OpenStack service access.
(StrOpt) Specifies which task executor to be used to run the task scripts.
(IntOpt) Time in hours for which a task lives after, either succeeding or failing
543
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value work_dir
= None
Description
(StrOpt) Work dir for asynchronous task operations.
The directory set here will be used to operate over images - normally before they are imported in the destination store. When providing work dir, make sure enough space is provided for concurrent tasks to run efficiently without running out of space. A rough estimation can be done by multiplying the number of `max_workers` - or the N of workers running - by an average image size (e.g 500MB).
The image size estimation should be done based on the average size in your deployment. Note that depending on the tasks running you may need to multiply this number by some factor depending on what the task does. For example, you may want to double the available size if image conversion is enabled. All this being said, remember these are just estimations and you should do them based on the worst case scenario and be prepared to act in case they were wrong.
Table 8.3. Description of database configuration options
Description Configuration option = Default value
[database] backend
= sqlalchemy
connection
= None
connection_debug connection_trace
= 0
= False
db_inc_retry_interval db_max_retries
= 20
db_max_retry_interval
= True
= 10
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
544
Configuration option = Default value db_retry_interval
= 1
idle_timeout
= 3600
max_overflow
= None
max_pool_size max_retries
= None
= 10
min_pool_size mysql_sql_mode pool_timeout
= 1
= TRADITIONAL
= None
retry_interval
= 10
slave_connection
= None
sqlite_db
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
CHAPTER 8. IMAGE SERVICE
Description
(IntOpt) Seconds between retries of a database transaction.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
Table 8.4. Description of logging configuration options
Description Configuration option = Default value
[DEFAULT]
545
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value backdoor_port
= None
Description
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
Table 8.5. Description of Elasticsearch configuration options
Description Configuration option = Default value
[elasticsearch] hosts
= 127.0.0.1:9200 (ListOpt) List of nodes where Elasticsearch instances are running. A single node should be defined as an IP address and port number.
Table 8.6. Description of flagmappings configuration options
Description Configuration option = Default value
[DEFAULT] cleanup_scrubber
= False
cleanup_scrubber_time delayed_delete
= False
image_cache_dir
= None
image_cache_driver
= sqlite
image_cache_max_size
= 86400
= 10737418240
(BoolOpt) A boolean that determines if the scrubber should clean up the files it uses for taking data. Only one server in your deployment should be designated the cleanup host.
(IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup.
(BoolOpt) Turn on/off delayed delete.
(StrOpt) Base directory that the Image Cache uses.
(StrOpt) The driver to use for image cache management.
(IntOpt) The upper limit (the maximum size of accumulated cache in bytes) beyond which pruner, if running, starts cleaning the images cache.
546
CHAPTER 8. IMAGE SERVICE
Configuration option = Default value image_cache_sqlite_db
= cache.db
image_cache_stall_time scrub_time
= 0
= 86400
scrubber_datadir
= /var/lib/glance/scrubber
Description
(StrOpt) The path to the sqlite file database that will be used for image cache management.
(IntOpt) The amount of time to let an image remain in the cache without being accessed.
(IntOpt) The amount of time in seconds to delay before performing a delete.
(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is set in glance-api.conf and glance-scrubber.conf.
Table 8.7. Description of logging configuration options
Configuration option = Default value
[DEFAULT]
Description debug
= False
default_log_levels
= 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
(ListOpt) List of logger=LEVEL pairs.
fatal_deprecations
= False
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
instance_format
= "[instance: %(uuid)s] "
instance_uuid_format
(uuid)s] "
log_config_append
= "[instance: %
= None
(BoolOpt) Enables or disables fatal status of deprecations.
(StrOpt) The format for an instance that is passed with the log message.
(StrOpt) The format for an instance UUID that is passed with the log message.
(StrOpt) 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.
547
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None (StrOpt) (Optional) The base directory used for relative --log-file paths.
log_file
= None (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None
log_config_append
= None
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None
log_file
= None
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
logging_context_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
548
CHAPTER 8. IMAGE SERVICE
Configuration option = Default value logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
Description
(StrOpt) Prefix each line of exception output with this format.
syslog_log_facility
= LOG_USER
syslog_log_facility
= LOG_USER
use_syslog
= False
use_syslog_rfc_format use_stderr use_syslog
= True
= False
use_syslog_rfc_format verbose
= False
= False
= False
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Log output to standard error.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 8.8. Description of policy configuration options
Description Configuration option = Default value
[oslo_policy] policy_default_rule
= default (StrOpt) Default rule. Enforced when a requested rule is not found.
549
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value policy_dirs
= ['policy.d']
policy_file
= policy.json
Description
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
Table 8.9. Description of profiler configuration options
Description Configuration option = Default value
[profiler] enabled
= False
trace_sqlalchemy
= False
(BoolOpt) If False fully disable profiling feature.
(BoolOpt) If False doesn't trace SQL requests.
Table 8.10. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
Table 8.11. Description of registry configuration options
Description Configuration option = Default value
[DEFAULT]
550
Configuration option = Default value admin_password
= None
admin_tenant_name
= None
admin_user
= None
auth_region
= None
auth_strategy
= noauth
auth_url
= None
registry_client_ca_file
= None
registry_client_cert_file
= None
registry_client_insecure
= False
registry_client_key_file
= None
registry_client_protocol
= http
CHAPTER 8. IMAGE SERVICE
Description
(StrOpt) The administrators password. If
"use_user_token" is not in effect, then admin credentials can be specified.
(StrOpt) The tenant name of the administrative user. If "use_user_token" is not in effect, then admin tenant name can be specified.
(StrOpt) The administrators user name. If
"use_user_token" is not in effect, then admin credentials can be specified.
(StrOpt) The region for the authentication service. If
"use_user_token" is not in effect and using keystone auth, then region name can be specified.
(StrOpt) The strategy to use for authentication. If
"use_user_token" is not in effect, then auth strategy can be specified.
(StrOpt) The URL to the keystone service. If
"use_user_token" is not in effect and using keystone auth, then URL of keystone can be specified.
(StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server, if any. Alternately, you may set the
GLANCE_CLIENT_CA_FILE environment variable to a filepath of the CA cert file.
(StrOpt) The path to the cert file to use in SSL connections to the registry server, if any.
Alternately, you may set the
GLANCE_CLIENT_CERT_FILE environment variable to a filepath of the CA cert file
(BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority. This is the registry's equivalent of specifying --insecure on the command line using glanceclient for the API.
(StrOpt) The path to the key file to use in SSL connections to the registry server, if any.
Alternately, you may set the
GLANCE_CLIENT_KEY_FILE environment variable to a filepath of the key file
(StrOpt) The protocol to use for communication with the registry server. Either http or https.
551
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value registry_client_timeout
= 600
registry_host registry_port
= 0.0.0.0
= 9191
Description
(IntOpt) The period of time, in seconds, that the
API server will wait for a registry request to complete. A value of 0 implies no timeout.
(StrOpt) Address to find the registry server.
(IntOpt) Port the registry server is listening on.
Table 8.12. Description of replicator configuration options
Configuration option = Default value
[DEFAULT] args
= None
chunksize
= 65536
command
= None
dontreplicate
= created_at date deleted_at
location updated_at
mastertoken
=
metaonly token
=
= False
slavetoken
=
Description
(ListOpt) Arguments for the command
(IntOpt) Amount of data to transfer per HTTP write.
(StrOpt) Command to be given to replicator
(StrOpt) List of fields to not replicate.
(StrOpt) Pass in your authentication token if you have one. This is the token used for the master.
(BoolOpt) Only replicate metadata, not images.
(StrOpt) Pass in your authentication token if you have one. This is the token used for the slave.
(StrOpt) Pass in your authentication token if you have one. If you use this option the same token is used for both the master and the slave.
Table 8.13. Description of scrubber configuration options
Description Configuration option = Default value
[DEFAULT] wakeup_time
= 300 (IntOpt) Loop time between checking for new items to schedule for delete.
552
Table 8.14. Description of TaskFlow configuration options
CHAPTER 8. IMAGE SERVICE
Configuration option = Default value
[taskflow_executor] conversion_format
= None
engine_mode max_workers
= parallel
= 10
Description
(StrOpt) The format to which images will be automatically converted. Can be 'qcow2' or 'raw'.
(StrOpt) The mode in which the engine will run.
Can be 'serial' or 'parallel'.
(IntOpt) The number of parallel activities executed at the same time by the engine. The value can be greater than one when the engine mode is
'parallel'.
Table 8.15. Description of testing configuration options
Description Configuration option = Default value
[DEFAULT] pydev_worker_debug_host
= None
pydev_worker_debug_port
= 5678
(StrOpt) The hostname/IP of the pydev process listening for debug connections
(IntOpt) The port on which a pydev process is listening for connections.
8.1. CONFIGURE THE API
The Image service has two APIs: the user-facing API, and the registry API, which is for internal requests that require access to the database.
Both of the APIs currently have two major versions, v1 and v2. It is possible to run either or both versions, by setting appropriate values of enable_v1_api, enable_v2_api,
enable_v1_registry and enable_v2_registry. If the v2 API is used, running glance-
registry is optional, as v2 of glance-api can connect directly to the database.
Tables of all the options used to configure the APIs, including enabling SSL and modifying WSGI settings are found below.
Table 8.16. Description of API configuration options
Configuration option = Default value
[DEFAULT]
Description
553
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value admin_role
= admin
allow_anonymous_access available_plugins enable_v1_api http_timeout
= True
enable_v1_registry
= True
enable_v2_api
= True
enable_v2_registry http_keepalive
= True
= True
= 600
image_size_cap load_enabled
= 1099511627776
= True
location_strategy
=
= False
= location_order
Description
(StrOpt) Role used to identify an authenticated user as administrator.
(BoolOpt) Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.
(ListOpt) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded.
(BoolOpt) Deploy the v1 OpenStack Images API.
(BoolOpt) Deploy the v1 OpenStack Registry API.
(BoolOpt) Deploy the v2 OpenStack Images API.
(BoolOpt) Deploy the v2 OpenStack Registry API.
(BoolOpt) If False, server will return the header
"Connection: close", If True, server will return
"Connection: Keep-Alive" in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server.
(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.
(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1
TB).WARNING: this value should only be increased after careful consideration and must be set to a value under 8 EB
(9223372036854775808).
(BoolOpt) When false, no artifacts can be loaded regardless of available_plugins. When true, artifacts can be loaded.
(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance
'location_order' and 'store_type'.
554
Configuration option = Default value max_header_line
= 16384
owner_is_tenant public_endpoint
= True
= None
send_identity_headers tcp_keepidle
= 600
use_user_token
[glance_store]
= True
default_store
= file
= False
show_multiple_locations
= False
CHAPTER 8. IMAGE SERVICE
Description
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs
(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.
(StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If
Glance is operating behind a proxy, you will want to change this to represent the proxy's URL.
(BoolOpt) Whether to pass through headers containing user and tenant information when making requests to the registry. This allows the registry to use the context middleware without keystonemiddleware's auth_token middleware, removing calls to the keystone auth service. It is recommended that when using this option, secure communication between glance api and glance registry is ensured by means other than auth_token middleware.
(BoolOpt) Whether to include the backend image locations in image properties. For example, if using the file system store a URL of "file:///path/to/image" will be returned to the user in the 'direct_url' metadata field. Revealing storage location can be a security risk, so use this setting with caution! The overrides show_image_direct_url.
(IntOpt) The value for the socket option
TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
(BoolOpt) Whether to pass through the user token when making requests to the registry.
(StrOpt) Default scheme to use to store image data. The scheme must be registered by one of the stores defined by the 'stores' config option.
555
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description store_capabilities_update_min_inte rval
= 0
(IntOpt) Minimum interval seconds to execute updating dynamic storage capabilities based on backend status then. It's not a periodic routine, the update logic will be executed only when interval seconds elapsed and an operation of store has triggered. The feature will be enabled only when the option value greater then zero.
(ListOpt) List of stores enabled
stores
= file, http
[paste_deploy] config_file
= None
flavor
= None
(StrOpt) Name of the paste configuration file.
(StrOpt) Partial name of a pipeline in your paste configuration file with the service name removed.
For example, if your paste section name is
[pipeline:glance-api-keystone] use the value
"keystone"
[store_type_location_strategy] store_type_preference
= (ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'stores' config option. This option will be applied when you using
'store_type' option as image location strategy defined by the 'location_strategy' config option.
Table 8.17. Description of CA and SSL configuration options
Description Configuration option = Default value
[DEFAULT] ca_file
= None
cert_file key_file
= None
= None
(StrOpt) CA certificate file to use to verify connecting clients.
(StrOpt) Certificate file to use when starting API server securely.
(StrOpt) Private key file to use when starting API server securely.
8.2. CONFIGURE THE RPC MESSAGING SYSTEM
556
CHAPTER 8. IMAGE SERVICE
OpenStack projects use an open standard for messaging middleware known as AMQP. This messaging middleware enables the OpenStack services that run on multiple servers to talk to each other. The OpenStack common library project, oslo, supports the following implementation of AMQP:
RabbitMQ, and Qpid .
The following tables contain settings to configure the messaging middleware for the Image service:
Table 8.18. Description of ZeroMQ configuration options
Configuration option = Default value
[DEFAULT] rpc_zmq_bind_address
= *
Description rpc_zmq_contexts rpc_zmq_host
= localhost
rpc_zmq_ipc_dir rpc_zmq_port
= 1
= /var/run/openstack
rpc_zmq_matchmaker
= 9501
= local
rpc_zmq_topic_backlog
= None
(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
(IntOpt) Number of ZeroMQ contexts, defaults to 1.
(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match
"host" option, if running Nova.
(StrOpt) Directory for holding IPC sockets.
(StrOpt) MatchMaker driver.
(IntOpt) ZeroMQ receiver listening port.
(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
Table 8.19. Description of AMQP configuration options
Configuration option = Default value
[DEFAULT] control_exchange
= openstack
Description default_publisher_id
= image.localhost
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
(StrOpt) Default publisher_id for outgoing notifications.
557
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value disabled_notifications
=
notification_driver notification_topics transport_url
= None
= []
= notifications
Description
(ListOpt) List of disabled notifications. A notification can be given either as a notification type to disable a single event, or as a notification group prefix to disable all events within a group. Example: if this config option is set to ["image.create",
"metadef_namespace"], then "image.create" notification will not be sent after image is created and none of the notifications for metadefinition namespaces will be sent.
(MultiStrOpt) Driver or drivers to handle sending notifications.
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
558
Table 8.20. Description of RPC configuration options
Description Configuration option = Default value
[DEFAULT] allowed_rpc_exception_modules
=
openstack.common.exception, glance.common.exception, exceptions
matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
rpc_cast_timeout
= 30
rpc_response_timeout
= 60
rpc_thread_pool_size
= 64
[oslo_concurrency] disable_process_locking
= False
(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
(IntOpt) Size of RPC thread pool.
(BoolOpt) Enables or disables inter-process locks.
Configuration option = Default value lock_path
= None
CHAPTER 8. IMAGE SERVICE
Description
(StrOpt) 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 external locks are used, a lock path must be set.
[oslo_messaging_amqp] allow_insecure_clients
= False
broadcast_prefix container_name group_request_prefix idle_timeout
= 0
ssl_key_password
= broadcast
= None
= unicast
server_request_prefix ssl_ca_file
=
ssl_cert_file ssl_key_file
=
=
= exclusive
= None
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
trace
= False
Table 8.21. Description of RabbitMQ configuration options
Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
Description
(BoolOpt) Auto-delete queues in AMQP.
559
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value amqp_durable_queues
= False
fake_rabbit
= False
heartbeat_rate rabbit_host rabbit_hosts
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_port
= 2
heartbeat_timeout_threshold kombu_reconnect_delay kombu_ssl_ca_certs kombu_ssl_certfile kombu_ssl_keyfile
=
kombu_ssl_version
=
rabbit_ha_queues rabbit_password
=
= guest
= 5672
=
= localhost
= 1.0
= False
= 0
Description
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
560
Configuration option = Default value rabbit_retry_backoff
= 2
rabbit_retry_interval
= 1
rabbit_use_ssl
= False
rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
CHAPTER 8. IMAGE SERVICE
Description
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
Table 8.22. Description of Qpid configuration options
Description Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname qpid_hosts qpid_password
= localhost
= $qpid_hostname:$qpid_port
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity qpid_sasl_mechanisms qpid_tcp_nodelay
=
= True
= 1
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
561
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value qpid_topology_version
= 1
qpid_username
=
rpc_conn_pool_size
= 30
Description
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
8.3. CONFIGURE IMAGE CACHE
You can configure the Image service API to have a local image cache. Caching of image files is transparent and can be performed by modifying some configuration parameters.
These parameters are configured in the PasteDeploy configuration file, component-paste.ini. You should not generally edit this file directly, as it ships with default options for all common deployment flavors.
8.3.1. Enable the Image Cache
To enable the image cache parameters, the cache parameters must occur in the application pipeline after the appropriate context parameters.
The cache parameters should be in your glance-api-paste.ini in a section titled
[filter:cache]. It should look like this:
[filter:cache] paste.filter_factory = glance.api.middleware.cache:CacheFilter.factory
A ready-made application parameter including this filter is defined in the glance-api-paste.ini file as follows:
[pipeline:glance-api-caching] pipeline = versionnegotiation context cache apiv1app
To enable the above application parameter, in your main glance-api.conf configuration file, select the appropriate deployment flavor as follows:
[paste_deploy] flavor = caching
8.3.2. Enable the Image Cache Management
562
CHAPTER 8. IMAGE SERVICE
There is an optional cachemanage option that allows you to directly interact with cache images.
Use this flavor in place of the cache flavor in your API config file.
[paste_deploy] flavor = cachemanage
8.3.3. Configuration Options Affecting the Image Cache
These configuration options must be set in both the glance-cache and glance-api configuration files.
Table 8.23. Description of Image Cache configuration options
Configuration option = Default value image_cache_dir
= /var/lib/glance/image-
cache
image_cache_driver
= sqlite
Description
Required when image cache middleware is enabled. This is the base directory the image cache can write files to. Make sure the directory is writable by the user running the
glance-api
server.
(Optional) The default
sqlite
cache driver has no special dependencies, other than the
pythonsqlite3
library, which is installed on almost all operating systems with modern versions of Python.
It stores information about the cached files in a
SQLite database.
image_cache_sqlite_db
= cache.db
image_cache_max_size
= 10737418240 (10
GB)
The
xattr
cache driver requires the
pythonxattr>=0.6.0
library and requires that the filesystem containing
image_cache_dir
has access times tracked for all files (in other words, the
noatime
option CANNOT be set for that filesystem). In addition,
user_xattr
must be set on the filesystem’s description line in fstab.
(Optional) When using the
sqlite
cache driver, you can set the name of the database that will be used to store the cached images information. The database is always contained in the
image_cache_dir
.
(Optional) Size, in bytes, that the image cache should be constrained to. Images files are cached automatically in the local image cache, even if the writing of that image file would put the total cache size over this size. The
glance-cachepruner
executable is what prunes the image cache to be equal to or less than this value. The
glance-cache-pruner
executable is designed to be run via cron on a regular basis.
563
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
8.4. SUPPORT FOR ISO IMAGES
You can load ISO images into the Image service. You can subsequently boot an ISO image using
Compute.
Procedure 8.1. To load an ISO image to an Image service data store
1. In the Image service, run the following command:
$ glance image-create --name "rhel-server-7.0.iso"
--copy-from https://access.redhat.com/downloads/content/69/ver=/rhel---
7/7.0/x86_64/product-downloads/rhel-server-7.0-x86_64-dvd.iso -is-public True --container-format bare --disk-format iso
In this command, rhel-server-7.0.iso is the name for the ISO image after it is loaded to the Image service, and rhel-server-7.0-x86_64-dvd.iso is the name of the source ISO image.
2. Optionally, to confirm the upload in Image service (glance), run this command:
$ glance image-list
Procedure 8.2. To boot an instance from an ISO image
OpenStack supports booting instances using ISO images, but in order to make the instances created using ISO images functional, follow a few more steps:
1. Boot instance with ISO image using the following command:
$ nova boot
--image rhel-server-7.0-x86_64-dvd.iso
--block-device source=blank,dest=volume,size=10,shutdown=preserve
--nic net-id=NETWORK_UUID --flavor 3 INSTANCE_NAME
In this command, rhel-server-7.0.iso is the ISO image, and INSTANCE_NAME is the name of the new instance. NETWORK_UUID is a valid network id in your system
You will need Block Storage service and setting the parameter shutdown=preserve will preserve the volume even after the shutting down an instance.
2. After the instance is successfully launched, connect to the instance using remote console and follow the instructions to install the system as using ISO images on regular computers.
When the installation is complete and system reboots, the instance prompts you to install the operating system, which implies your instance is not usable.
Procedure 8.3. To make an instance that was booted from an ISO image functional
564
CHAPTER 8. IMAGE SERVICE
Run the following commands to ensure the instances you created using ISO images are functional:
1. Delete the instance you just created:
$ nova delete INSTANCE_NAME
2. After you delete an instance, the system you just installed using your ISO image remains because the parameter shutdown=preserve was set, run the following command:
$ cinder list
You get a list with all the volumes in your system. In this list, you can find the volume that is attached to your ISO created instance, with the false bootable property.
3. Upload the volume to glance:
$ cinder upload-to-image VOLUME_UUID IMAGE_NAME
The VOLUME_UUID is the uuid of the volume that is attached to your ISO created instance, and the IMAGE_NAME is the name that you give to your new image.
4. After the image is successfully uploaded, you can now use the new image to boot instances, the instance launched using this image will contain the system you just installed using the
ISO image.
8.5. CONFIGURE BACK ENDS
The Image service supports several back ends for storing virtual machine images:
OpenStack Block Storage (cinder)
A directory on a local file system
GridFS
Ceph RBD
Amazon S3
Sheepdog
OpenStack Object Storage (swift)
VMware ESX
565
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The following tables detail the options available for each.
Table 8.24. Description of cinder configuration options
Configuration option = Default value
[glance_store] cinder_api_insecure
= False
Description cinder_ca_certificates_file
= None
cinder_catalog_info
volume:cinder:publicURL
=
cinder_endpoint_template cinder_http_retries
= 3
= None
(BoolOpt) Allow to perform insecure SSL requests to cinder
(StrOpt) Location of ca certicates file to use for cinder client requests.
(StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:
<endpoint_type>
(StrOpt) Override service catalog lookup with template for cinder endpoint e.g.
http://localhost:8776/v1/%(project_id)s
(IntOpt) Number of cinderclient retries on failed http calls
Table 8.25. Description of filesystem configuration options
Description Configuration option = Default value
[glance_store] filesystem_store_datadir
= None
filesystem_store_datadirs
= None
filesystem_store_file_perm
= 0
(StrOpt) Directory to which the Filesystem backend store writes images.
(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images.
(IntOpt) The required permission for created image file. In this way the user other service used, e.g.
Nova, who consumes the image could be the exclusive member of the group that owns the files created. Assigning it less then or equal to zero means don't change the default permission of the file. This value will be decoded as an octal digit.
566
Configuration option = Default value filesystem_store_metadata_file
=
None
CHAPTER 8. IMAGE SERVICE
Description
(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON object. The object should contain the keys 'id' and 'mountpoint'. The value for both keys should be 'string'.
Table 8.26. Description of GridFS configuration options
Description Configuration option = Default value
[glance_store] mongodb_store_db
= None
mongodb_store_uri
= None
(StrOpt) Database to use
(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost)
Table 8.27. Description of RBD configuration options
Configuration option = Default value Description
[glance_store] rbd_store_ceph_conf
= /etc/ceph/ceph.conf (StrOpt) Ceph configuration file path. If <None>, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.<USER> section
rbd_store_chunk_size
= 8 (IntOpt) RADOS images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.
rbd_store_pool
= localhost
rbd_store_user
= None
(StrOpt) RADOS pool in which images are stored.
(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If <None>, a default will be chosen based on the client. section in rbd_store_ceph_conf)
Table 8.28. Description of S3 configuration options
567
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[glance_store] s3_store_access_key s3_store_bucket
subdomain
False
s3_store_secret_key
= None
= None
s3_store_bucket_url_format s3_store_large_object_size s3_store_object_buffer_dir
= None
s3_store_thread_pools
= 10
=
s3_store_create_bucket_on_put
=
s3_store_host
= None
s3_store_large_object_chunk_size
=
10
= 100
= None
Description
(StrOpt) The S3 query token access key.
(StrOpt) The S3 bucket to be used to store the
Glance data.
(StrOpt) The S3 calling format used to determine the bucket. Either subdomain or path can be used.
(BoolOpt) A boolean to determine if the S3 bucket should be created on upload if it does not exist or if an error should be returned to the user.
(StrOpt) The host where the S3 server is listening.
(IntOpt) What multipart upload part size, in MB, should S3 use when uploading parts. The size must be greater than or equal to 5M.
(IntOpt) What size, in MB, should S3 start chunking image files and do a multipart upload in S3.
(StrOpt) The local directory where uploads will be staged before they are transferred into S3.
(StrOpt) The S3 query token secret key.
(IntOpt) The number of thread pools to perform a multipart upload in S3.
Table 8.29. Description of Sheepdog configuration options
Description Configuration option = Default value
[glance_store] sheepdog_store_address
= localhost
sheepdog_store_chunk_size
= 64
sheepdog_store_port
= 7000
(StrOpt) IP address of sheep daemon.
(IntOpt) Images will be chunked into objects of this size (in megabytes). For best performance, this should be a power of two.
(IntOpt) Port of sheep daemon.
Table 8.30. Description of swift configuration options
568
CHAPTER 8. IMAGE SERVICE
Configuration option = Default value
[DEFAULT] default_swift_reference
= ref1
swift_store_auth_address
= None
swift_store_config_file
= None
swift_store_key
= None
Description
(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.
(StrOpt) The address where the Swift authentication service is listening.(deprecated)
(StrOpt) The config file that has the swift account(s)configs.
(StrOpt) Auth key for the user authenticating against the Swift authentication service.
(deprecated)
(StrOpt) The user to authenticate against the Swift authentication service (deprecated)
swift_store_user
= None
[glance_store] default_swift_reference
= ref1
swift_store_admin_tenants
=
swift_store_auth_address
= None
swift_store_auth_insecure
= False
swift_store_auth_version
= 2
swift_store_cacert
= None
swift_store_config_file
= None
swift_store_container
= glance
(StrOpt) The reference to the default swift account/backing store parameters to use for adding new images.
(ListOpt) A list of tenants that will be granted read/write access on all Swift containers created by
Glance in multi-tenant mode.
(StrOpt) The address where the Swift authentication service is listening.(deprecated)
(BoolOpt) If True, swiftclient won't check for a valid
SSL certificate when authenticating.
(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace. (deprecated)
(StrOpt) A string giving the CA certificate file to use in SSL connections for verifying certs.
(StrOpt) The config file that has the swift account(s)configs.
(StrOpt) Container within the account that the account should use for storing images in Swift when using single container mode. In multiple container mode, this will be the prefix for all containers.
569
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description swift_store_create_container_on_pu t
= False
(BoolOpt) A boolean value that determines if we create the container if it does not exist.
swift_store_endpoint
= None (StrOpt) If set, the configured endpoint will be used.
If None, the storage url from the auth response will be used.
swift_store_endpoint_type
= publicURL (StrOpt) A string giving the endpoint type of the swift service to use (publicURL, adminURL or internalURL). This setting is only used if swift_store_auth_version is 2.
swift_store_key
= None (StrOpt) Auth key for the user authenticating against the Swift authentication service.
(deprecated)
swift_store_large_object_chunk_siz e
= 200
(IntOpt) The amount of data written to a temporary disk buffer during the process of chunking the image file.
swift_store_large_object_size
= 5120 (IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift.
swift_store_multi_tenant
= False (BoolOpt) If set to True, enables multi-tenant storage mode which causes Glance images to be stored in tenant specific Swift accounts.
swift_store_multiple_containers_se ed
= 0
(IntOpt) When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a singletenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. The total number of containers that will be used is equal to
16^N, so if this config option is set to 2, then
16^2=256 containers will be used to store images.
swift_store_region
= None
swift_store_retry_get_count
= 0
(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.
(IntOpt) The number of times a Swift download will be retried before the request fails.
swift_store_service_type
= object-store (StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.
570
CHAPTER 8. IMAGE SERVICE
Configuration option = Default value swift_store_ssl_compression
= True
swift_store_user
= None
Description
(BoolOpt) If set to False, disables SSL layer compression of https swift requests. Setting to
False may improve performance for images which are already in a compressed format, eg qcow2.
(StrOpt) The user to authenticate against the Swift authentication service (deprecated)
8.5.1. Configure vCenter data stores for the Image service back end
To use VMware vCenter datastores for the Image service back end, you must update the glance-
api.conf file, as follows:
Add data store parameters to the VMware Datastore Store Options section.
Specify vSphere as the back end.
Note
You must configure any configured Image service data stores for the Compute service.
You can specify vCenter data stores directly by using the data store name or Storage Policy Based
Management (SPBM), which requires vCenter Server 5.5 or later. For details, see Section 8.5.1.1,
“Configure vCenter data stores for the back end” .
Note
If you intend to use multiple data stores for the back end, use the SPBM feature.
In the glance_store section, set the default_store option to vsphere, as shown in this code sample:
[glance_store]
# Which back end scheme should Glance use by default is not specified
# in a request to add a new image to Glance? Known schemes are determined
# by the known_stores option below.
# Default: 'file' default_store = vsphere
The following table describes the parameters in the VMware Datastore Store Options section:
Table 8.31. Description of VMware configuration options
571
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[glance_store] vmware_api_insecure
= False
Description vmware_api_retry_count vmware_datacenter_path
= ha-datacenter
vmware_datastore_name vmware_datastores vmware_server_host
= None
= None
= None
vmware_server_password vmware_server_username
= 10
= None
= None
(BoolOpt) Allow to perform insecure SSL requests to ESX/VC.
(IntOpt) Number of times VMware ESX/VC server
API must be retried upon connection related issues.
(StrOpt) DEPRECATED. Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter".
This option is deprecated in favor of vmware_datastores and will be removed in the
Liberty release.
(StrOpt) DEPRECATED. Datastore associated with the datacenter. This option is deprecated in favor of vmware_datastores and will be removed in the
Liberty release.
(MultiStrOpt) A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores.
Either one of vmware_datastore_name or vmware_datastores is required. The datastore name should be specified after its datacenter path, seperated by ":". An optional weight may be given after the datastore name, seperated again by ":".
Thus, the required format becomes
<datacenter_path>:<datastore_name>:
<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected.
(StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name.
(StrOpt) Password for authenticating with VMware
ESX/VC server.
(StrOpt) Username for authenticating with VMware
ESX/VC server.
572
Configuration option = Default value vmware_store_image_dir
=
/openstack_glance
vmware_task_poll_interval
= 5
CHAPTER 8. IMAGE SERVICE
Description
(StrOpt) The name of the directory where the glance images will be stored in the VMware datastore.
(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server.
The following block of text shows a sample configuration:
# ============ VMware Datastore Store Options =====================
# ESX/ESXi or vCenter Server target system.
# The server value can be an IP address or a DNS name
# e.g. 127.0.0.1, 127.0.0.1:443, www.vmware-infra.com
vmware_server_host = 192.168.0.10
# Server username (string value) vmware_server_username = ADMINISTRATOR
# Server password (string value) vmware_server_password = password
# Inventory path to a datacenter (string value)
# Value optional when vmware_server_ip is an ESX/ESXi host: if specified
# should be `ha-datacenter`.
vmware_datacenter_path = DATACENTER
# Datastore associated with the datacenter (string value) vmware_datastore_name = datastore1
# PBM service WSDL file location URL. e.g.
# file:///opt/SDK/spbm/wsdl/pbmService.wsdl Not setting this
# will disable storage policy based placement of images.
# (string value)
#vmware_pbm_wsdl_location =
# The PBM policy. If `pbm_wsdl_location` is set, a PBM policy needs
# to be specified. This policy will be used to select the datastore
# in which the images will be stored.
#vmware_pbm_policy =
# The interval used for polling remote tasks
# invoked on VMware ESX/VC server in seconds (integer value) vmware_task_poll_interval = 5
# Absolute path of the folder containing the images in the datastore
# (string value) vmware_store_image_dir = /openstack_glance
# Allow to perform insecure SSL requests to the target system (boolean value) vmware_api_insecure = False
573
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
8.5.1.1. Configure vCenter data stores for the back end
You can specify a vCenter data store for the back end by setting the vmware_datastore_name parameter value to the vCenter name of the data store. This configuration limits the back end to a single data store.
Procedure 8.4. To configure a single data store
1. If present, comment or delete the vmware_pbm_wsdl_location and
vmware_pbm_policy parameters.
2. Uncomment and define the vmware_datastore_name parameter with the name of the vCenter data store.
3. Complete the other vCenter configuration parameters as appropriate.
8.6. IMAGE SERVICE SAMPLE CONFIGURATION FILES
You can find the files that are described in this section in the /etc/glance/ directory.
8.6.1. glance-api.conf
The configuration file for the Image service API is found in the glance-api.conf file.
This file must be modified after installation.
[DEFAULT]
# Show more verbose log output (sets INFO log level output)
#verbose = False
# Show debugging output in logs (sets DEBUG log level output)
#debug = False
# Maximum image size (in bytes) that may be uploaded through the
# Glance API server. Defaults to 1 TB.
# WARNING: this value should only be increased after careful consideration
# and must be set to a value under 8 EB (9223372036854775808).
#image_size_cap = 1099511627776
# Address to bind the API server bind_host = 0.0.0.0
# Port the bind the API server to bind_port = 9292
# Log to this file. Make sure you do not set the same log file for both the API
# and registry servers!
574
CHAPTER 8. IMAGE SERVICE
#
# If `log_file` is omitted and `use_syslog` is false, then log messages are
# sent to stdout as a fallback.
log_file = /var/log/glance/api.log
# Backlog requests when creating socket backlog = 4096
# TCP_KEEPIDLE value in seconds when creating socket.
# Not supported on OS X.
#tcp_keepidle = 600
# Timeout (in seconds) for client connections' socket operations. If an incoming
# connection is idle for this period it will be closed. A value of "0"
# means wait forever.
#client_socket_timeout = 0
# API to use for accessing data. Default value points to sqlalchemy
# package, it is also possible to use: glance.db.registry.api
# data_api = glance.db.sqlalchemy.api
# The number of child process workers that will be
# created to service API requests. The default will be
# equal to the number of CPUs available. (integer value)
#workers = 4
# Maximum line size of message headers to be accepted.
# max_header_line may need to be increased when using large tokens
# (typically those generated by the Keystone v3 API with big service
# catalogs)
# max_header_line = 16384
# Role used to identify an authenticated user as administrator
#admin_role = admin
# Allow unauthenticated users to access the API with read-only
# privileges. This only applies when using ContextMiddleware.
#allow_anonymous_access = False
# Allow access to version 1 of glance api
#enable_v1_api = True
# Allow access to version 2 of glance api
#enable_v2_api = True
# Return the URL that references where the data is stored on
# the backend storage system. For example, if using the
# file system store a URL of 'file:///path/to/image' will
# be returned to the user in the 'direct_url' meta-data field.
# The default value is false.
#show_image_direct_url = False
# Send headers containing user and tenant information when making requests to
575
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# the v1 glance registry. This allows the registry to function as if a user is
# authenticated without the need to authenticate a user itself using the
# auth_token middleware.
# The default value is false.
#send_identity_headers = False
# Supported values for the 'container_format' image attribute
#container_formats=ami,ari,aki,bare,ovf,ova
# Supported values for the 'disk_format' image attribute
#disk_formats=ami,ari,aki,vhd,vmdk,raw,qcow2,vdi,iso
# Property Protections config file
# This file contains the rules for property protections and the roles/policies
# associated with it.
# If this config value is not specified, by default, property protections
# won't be enforced.
# If a value is specified and the file is not found, then the glance-api
# service will not start.
#property_protection_file =
# Specify whether 'roles' or 'policies' are used in the
# property_protection_file.
# The default value for property_protection_rule_format is 'roles'.
#property_protection_rule_format = roles
# This value sets what strategy will be used to determine the image location
# order. Currently two strategies are packaged with Glance
'location_order'
# and 'store_type'.
#location_strategy = location_order
# Public url to use for versions endpoint. The default is None,
# which will use the request's host_url attribute to populate the URL base.
# If Glance is operating behind a proxy, you will want to change this to
# represent the proxy's URL.
#public_endpoint=<None>
# http_keepalive option. If False, server will return the header
# "Connection: close", If True, server will return "Connection: Keep-
Alive"
# in its responses. In order to close the client socket connection
# explicitly after the response is sent and read successfully by the client,
# you simply have to set this option to False when you create a wsgi server.
#http_keepalive = True
# ================= Syslog Options ============================
# Send logs to syslog (/dev/log) instead of to file specified
576
CHAPTER 8. IMAGE SERVICE
# by `log_file`
#use_syslog = False
# Facility to use. If unset defaults to LOG_USER.
#syslog_log_facility = LOG_LOCAL0
# ================= SSL Options ===============================
# Certificate file to use when starting API server securely
#cert_file = /path/to/certfile
# Private key file to use when starting API server securely
#key_file = /path/to/keyfile
# CA certificate file to use to verify connecting clients
#ca_file = /path/to/cafile
# ================= Security Options ==========================
# AES key for encrypting store 'location' metadata, including
# -- if used -- Swift or S3 credentials
# Should be set to a random string of length 16, 24 or 32 bytes
#metadata_encryption_key = <16, 24 or 32 char registry metadata key>
# Digest algorithm which will be used for digital signature, the default is
# sha1 in Kilo for a smooth upgrade process, and it will be updated with
# sha256 in next release(L). Use command
# "openssl list-message-digest-algorithms" to get the available algorithms
# supported by the version of OpenSSL on the platform. Examples are
'sha1',
# 'sha256', 'sha512', etc.
#digest_algorithm = sha1
# ============ Registry Options ===============================
# Address to find the registry server registry_host = 0.0.0.0
# Port the registry server is listening on registry_port = 9191
# What protocol to use when connecting to the registry server?
# Set to https for secure HTTP communication registry_client_protocol = http
# The path to the key file to use in SSL connections to the
# registry server, if any. Alternately, you may set the
# GLANCE_CLIENT_KEY_FILE environ variable to a filepath of the key file
#registry_client_key_file = /path/to/key/file
# The path to the cert file to use in SSL connections to the
# registry server, if any. Alternately, you may set the
# GLANCE_CLIENT_CERT_FILE environ variable to a filepath of the cert file
577
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#registry_client_cert_file = /path/to/cert/file
# The path to the certifying authority cert file to use in SSL connections
# to the registry server, if any. Alternately, you may set the
# GLANCE_CLIENT_CA_FILE environ variable to a filepath of the CA cert file
#registry_client_ca_file = /path/to/ca/file
# When using SSL in connections to the registry server, do not require
# validation via a certifying authority. This is the registry's equivalent of
# specifying --insecure on the command line using glanceclient for the
API
# Default: False
#registry_client_insecure = False
# The period of time, in seconds, that the API server will wait for a registry
# request to complete. A value of '0' implies no timeout.
# Default: 600
#registry_client_timeout = 600
# Enable DEBUG log messages from sqlalchemy which prints every database
# query and response.
# Default: False
#sqlalchemy_debug = True
# Pass the user's token through for API requests to the registry.
# Default: True
#use_user_token = True
# If 'use_user_token' is not in effect then admin credentials
# can be specified. Requests to the registry on behalf of
# the API will use these credentials.
# Admin user name
#admin_user = None
# Admin password
#admin_password = None
# Admin tenant name
#admin_tenant_name = None
# Keystone endpoint
#auth_url = None
# Keystone region
#auth_region = None
# Auth strategy
#auth_strategy = keystone
# ============ Notification System Options =====================
# Driver or drivers to handle sending notifications. Set to
# 'messaging' to send notifications to a message queue.
# notification_driver = noop
# Default publisher_id for outgoing notifications.
# default_publisher_id = image.localhost
578
CHAPTER 8. IMAGE SERVICE
# List of disabled notifications. A notification can be given either as a
# notification type to disable a single event, or as a notification group
# prefix to disable all events within a group.
# Example: if this config option is set to
# ["image.create", "metadef_namespace"], then "image.create" notification will
# not be sent after image is created and none of the notifications for
# metadefinition namespaces will be sent.
# disabled_notifications = []
# Messaging driver used for 'messaging' notifications driver
# rpc_backend = 'rabbit'
# Configuration options if sending notifications via rabbitmq (these are
# the defaults) rabbit_host = localhost rabbit_port = 5672 rabbit_use_ssl = false rabbit_userid = guest rabbit_password = guest rabbit_virtual_host = / rabbit_notification_exchange = glance rabbit_notification_topic = notifications rabbit_durable_queues = False
# Configuration options if sending notifications via Qpid (these are
# the defaults) qpid_notification_exchange = glance qpid_notification_topic = notifications qpid_hostname = localhost qpid_port = 5672 qpid_username = qpid_password = qpid_sasl_mechanisms = qpid_reconnect_timeout = 0 qpid_reconnect_limit = 0 qpid_reconnect_interval_min = 0 qpid_reconnect_interval_max = 0 qpid_reconnect_interval = 0 qpid_heartbeat = 5
# Set to 'ssl' to enable SSL qpid_protocol = tcp qpid_tcp_nodelay = True
# ============ Delayed Delete Options =============================
# Turn on/off delayed delete delayed_delete = False
# Delayed delete time in seconds scrub_time = 43200
# Directory that the scrubber will use to remind itself of what to delete
# Make sure this is also set in glance-scrubber.conf
scrubber_datadir = /var/lib/glance/scrubber
579
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# =============== Quota Options ==================================
# The maximum number of image members allowed per image
#image_member_quota = 128
# The maximum number of image properties allowed per image
#image_property_quota = 128
# The maximum number of tags allowed per image
#image_tag_quota = 128
# The maximum number of locations allowed per image
#image_location_quota = 10
# Set a system wide quota for every user. This value is the total number
# of bytes that a user can use across all storage systems. A value of
# 0 means unlimited.
#user_storage_quota = 0
# =============== Image Cache Options =============================
# Base directory that the Image Cache uses image_cache_dir = /var/lib/glance/image-cache/
# =============== Policy Options ==================================
[oslo_policy]
# The JSON file that defines policies.
# Deprecated group/name - [DEFAULT]/policy_file
#policy_file = policy.json
# Default rule. Enforced when a requested rule is not found.
# Deprecated group/name - [DEFAULT]/policy_default_rule
#policy_default_rule = default
# Directories where policy configuration files are stored.
# They can be relative to any directory in the search path
# defined by the config_dir option, or absolute paths.
# The file defined by policy_file must exist for these
# directories to be searched.
# Deprecated group/name - [DEFAULT]/policy_dirs
#policy_dirs = policy.d
# =============== Database Options =================================
[database]
# The file name to use with SQLite (string value)
#sqlite_db = oslo.sqlite
# If True, SQLite uses synchronous mode (boolean value)
#sqlite_synchronous = True
# The backend to use for db (string value)
# Deprecated group/name - [DEFAULT]/db_backend
#backend = sqlalchemy
580
CHAPTER 8. IMAGE SERVICE
# The SQLAlchemy connection string used to connect to the
# database (string value)
# Deprecated group/name - [DEFAULT]/sql_connection
# Deprecated group/name - [DATABASE]/sql_connection
# Deprecated group/name - [sql]/connection
#connection = <None>
# The SQL mode to be used for MySQL sessions. This option,
# including the default, overrides any server-set SQL mode. To
# use whatever SQL mode is set by the server configuration,
# set this to no value. Example: mysql_sql_mode= (string
# value)
#mysql_sql_mode = TRADITIONAL
# Timeout before idle sql connections are reaped (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_idle_timeout
# Deprecated group/name - [DATABASE]/sql_idle_timeout
# Deprecated group/name - [sql]/idle_timeout
#idle_timeout = 3600
# Minimum number of SQL connections to keep open in a pool
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_min_pool_size
# Deprecated group/name - [DATABASE]/sql_min_pool_size
#min_pool_size = 1
# Maximum number of SQL connections to keep open in a pool
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_pool_size
# Deprecated group/name - [DATABASE]/sql_max_pool_size
#max_pool_size = <None>
# Maximum db connection retries during startup. (setting -1
# implies an infinite retry count) (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_retries
# Deprecated group/name - [DATABASE]/sql_max_retries
#max_retries = 10
# Interval between retries of opening a sql connection
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_retry_interval
# Deprecated group/name - [DATABASE]/reconnect_interval
#retry_interval = 10
# If set, use this value for max_overflow with sqlalchemy
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_overflow
# Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
#max_overflow = <None>
# Verbosity of SQL debugging information. 0=None,
# 100=Everything (integer value)
# Deprecated group/name - [DEFAULT]/sql_connection_debug
#connection_debug = 0
581
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Add python stack traces to SQL as comment strings (boolean
# value)
# Deprecated group/name - [DEFAULT]/sql_connection_trace
#connection_trace = False
# If set, use this value for pool_timeout with sqlalchemy
# (integer value)
# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
#pool_timeout = <None>
# Enable the experimental use of database reconnect on
# connection lost (boolean value)
#use_db_reconnect = False
# seconds between db connection retries (integer value)
#db_retry_interval = 1
# Whether to increase interval between db connection retries,
# up to db_max_retry_interval (boolean value)
#db_inc_retry_interval = True
# max seconds between db connection retries, if
# db_inc_retry_interval is enabled (integer value)
#db_max_retry_interval = 10
# maximum db connection retries before error is raised.
# (setting -1 implies an infinite retry count) (integer value)
#db_max_retries = 20
[oslo_concurrency]
# Enables or disables inter-process locks. (boolean value)
# Deprecated group/name - [DEFAULT]/disable_process_locking
#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. It could be read from environment variable
# OSLO_LOCK_PATH. This setting needs to be the same for both
# glance-scrubber and glance-api service. Default to a temp directory.
# Deprecated group/name - [DEFAULT]/lock_path (string value)
#lock_path = /tmp
[keystone_authtoken] identity_uri = http://127.0.0.1:35357 admin_tenant_name = %SERVICE_TENANT_NAME% admin_user = %SERVICE_USER% admin_password = %SERVICE_PASSWORD% revocation_cache_time = 10
[paste_deploy]
# Name of the paste configuration file that defines the available pipelines
#config_file = glance-api-paste.ini
582
CHAPTER 8. IMAGE SERVICE
# Partial name of a pipeline in your paste configuration file with the
# service name removed. For example, if your paste section name is
# [pipeline:glance-api-keystone], you would configure the flavor below
# as 'keystone'.
#flavor=
[store_type_location_strategy]
# The scheme list to use to get store preference order. The scheme must be
# registered by one of the stores defined by the 'stores' config option.
# This option will be applied when you using 'store_type' option as image
# location strategy defined by the 'location_strategy' config option.
#store_type_preference =
[profiler]
# If False fully disable profiling feature.
#enabled = False
# If False doesn't trace SQL requests.
#trace_sqlalchemy = False
[task]
# ================= Glance Tasks Options ============================
# Specifies how long (in hours) a task is supposed to live in the tasks
DB
# after succeeding or failing before getting soft-deleted.
# The default value for task_time_to_live is 48 hours.
# task_time_to_live = 48
# Specifies which task executor to be used to run the task scripts.
# The default value for task_executor is taskflow.
# task_executor = taskflow
# Work dir for asynchronous task operations. The directory set here
# will be used to operate over images - normally before they are
# imported in the destination store. When providing work dir, make sure
# enough space is provided for concurrent tasks to run efficiently
# without running out of space. A rough estimation can be done by
# multiplying the number of `max_workers` - or the N of workers running
# - by an average image size (e.g 500MB). The image size estimation
# should be done based on the average size in your deployment. Note that
# depending on the tasks running you may need to multiply this number by
# some factor depending on what the task does. For example, you may want
# to double the available size if image conversion is enabled. All this
# being said, remember these are just estimations and you should do them
# based on the worst case scenario and be prepared to act in case they
# were wrong.
# work_dir=None
# Specifies the maximum number of eventlet threads which can be spun up by
# the eventlet based task executor to perform execution of Glance tasks.
# DEPRECATED: Use [taskflow_executor]/max_workers instead.
# eventlet_executor_pool_size = 1000
583
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
[taskflow_executor]
# The mode in which the engine will run. Can be 'default', 'serial',
# 'parallel' or 'worker-based'
#engine_mode = serial
# The number of parallel activities executed at the same time by
# the engine. The value can be greater than one when the engine mode is
# 'parallel' or 'worker-based', otherwise this value will be ignored.
#max_workers = 10
[glance_store]
# List of which store classes and store class locations are
# currently known to glance at startup.
# Deprecated group/name - [DEFAULT]/known_stores
# Existing but disabled stores:
# glance.store.rbd.Store,
# glance.store.s3.Store,
# glance.store.swift.Store,
# glance.store.sheepdog.Store,
# glance.store.cinder.Store,
# glance.store.gridfs.Store,
# glance.store.vmware_datastore.Store,
#stores = glance.store.filesystem.Store,
# glance.store.http.Store
# Which backend scheme should Glance use by default is not specified
# in a request to add a new image to Glance? Known schemes are determined
# by the stores option.
# Deprecated group/name - [DEFAULT]/default_store
# Default: 'file' default_store = file
# ============ Filesystem Store Options ========================
# Directory that the Filesystem backend store
# writes image data to filesystem_store_datadir = /var/lib/glance/images/
# A list of directories where image data can be stored.
# This option may be specified multiple times for specifying multiple store
# directories. Either one of filesystem_store_datadirs or
# filesystem_store_datadir option is required. A priority number may be given
# after each directory entry, separated by a ":".
# When adding an image, the highest priority directory will be selected, unless
# there is not enough space available in cases where the image size is already
# known. If no priority is given, it is assumed to be zero and the directory
# will be considered for selection last. If multiple directories have the same
# priority, then the one with the most free space available is selected.
# If same store is specified multiple times then BadStoreConfiguration
# exception will be raised.
584
CHAPTER 8. IMAGE SERVICE
#filesystem_store_datadirs = /var/lib/glance/images/:1
# A path to a JSON file that contains metadata describing the storage
# system. When show_multiple_locations is True the information in this
# file will be returned with any location that is contained in this
# store.
#filesystem_store_metadata_file = None
# ============ Swift Store Options =============================
# Version of the authentication service to use
# Valid versions are '2' for keystone and '1' for swauth and rackspace swift_store_auth_version = 2
# Address where the Swift authentication service lives
# Valid schemes are 'http://' and 'https://'
# If no scheme specified, default to 'https://'
# For swauth, use something like '127.0.0.1:8080/v1.0/' swift_store_auth_address = 127.0.0.1:5000/v2.0/
# User to authenticate against the Swift authentication service
# If you use Swift authentication service, set it to 'account':'user'
# where 'account' is a Swift storage account and 'user'
# is a user in that account swift_store_user = jdoe:jdoe
# Auth key for the user authenticating against the
# Swift authentication service swift_store_key = a86850deb2742ec3cb41518e26aa2d89
# Container within the account that the account should use
# for storing images in Swift swift_store_container = glance
# Do we create the container if it does not exist?
swift_store_create_container_on_put = False
# What size, in MB, should Glance start chunking image files
# and do a large object manifest in Swift? By default, this is
# the maximum object size in Swift, which is 5GB swift_store_large_object_size = 5120
# swift_store_config_file = glance-swift.conf
# This file contains references for each of the configured
# Swift accounts/backing stores. If used, this option can prevent
# credentials being stored in the database. Using Swift references
# is disabled if this config is left blank.
# The reference to the default Swift parameters to use for adding new images.
# default_swift_reference = 'ref1'
# When doing a large object manifest, what size, in MB, should
# Glance write chunks to Swift? This amount of data is written
# to a temporary disk buffer during the process of chunking
# the image file, and the default is 200MB
585
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
swift_store_large_object_chunk_size = 200
# If set, the configured endpoint will be used. If None, the storage URL
# from the auth response will be used. The location of an object is
# obtained by appending the container and object to the configured URL.
#
# swift_store_endpoint = https://www.example.com/v1/not_a_container
#swift_store_endpoint =
# If set to True enables multi-tenant storage mode which causes Glance images
# to be stored in tenant specific Swift accounts.
#swift_store_multi_tenant = False
# If set to an integer value between 1 and 32, a single-tenant store will
# use multiple containers to store images. If set to the default value of
0,
# only a single container will be used. Multi-tenant stores are not affected
# by this option. The max number of containers that will be used to store
# images is approximately 16^N where N is the value of this option.
Discuss
# the impact of this with your swift deployment team, as this option is only
# beneficial in the largest of deployments where swift rate limiting can lead
# to unwanted throttling on a single container.
#swift_store_multiple_containers_seed = 0
# A list of swift ACL strings that will be applied as both read and
# write ACLs to the containers created by Glance in multi-tenant
# mode. This grants the specified tenants/users read and write access
# to all newly created image objects. The standard swift ACL string
# formats are allowed, including:
# <tenant_id>:<username>
# <tenant_name>:<username>
# *:<username>
# Multiple ACLs can be combined using a comma separated list, for
# example: swift_store_admin_tenants = service:glance,*:admin
#swift_store_admin_tenants =
# The region of the swift endpoint to be used for single tenant. This setting
# is only necessary if the tenant has multiple swift endpoints.
#swift_store_region =
# If set to False, disables SSL layer compression of https swift requests.
# Setting to 'False' may improve performance for images which are already
# in a compressed format, eg qcow2. If set to True, enables SSL layer
# compression (provided it is supported by the target swift proxy).
#swift_store_ssl_compression = True
# The number of times a Swift download will be retried before the
# request fails
#swift_store_retry_get_count = 0
586
CHAPTER 8. IMAGE SERVICE
# Bypass SSL verification for Swift
#swift_store_auth_insecure = False
# The path to a CA certificate bundle file to use for SSL verification when
# communicating with Swift.
#swift_store_cacert =
# ============ S3 Store Options =============================
# Address where the S3 authentication service lives
# Valid schemes are 'http://' and 'https://'
# If no scheme specified, default to 'http://' s3_store_host = s3.amazonaws.com
# User to authenticate against the S3 authentication service s3_store_access_key = <20-char AWS access key>
# Auth key for the user authenticating against the
# S3 authentication service s3_store_secret_key = <40-char AWS secret key>
# Container within the account that the account should use
# for storing images in S3. Note that S3 has a flat namespace,
# so you need a unique bucket name for your glance images. An
# easy way to do this is append your AWS access key to "glance".
# S3 buckets in AWS *must* be lowercased, so remember to lowercase
# your AWS access key if you use it in your bucket name below!
s3_store_bucket = <lowercased 20-char aws access key>glance
# Do we create the bucket if it does not exist?
s3_store_create_bucket_on_put = False
# When sending images to S3, the data will first be written to a
# temporary buffer on disk. By default the platform's temporary directory
# will be used. If required, an alternative directory can be specified here.
#s3_store_object_buffer_dir = /path/to/dir
# When forming a bucket url, boto will either set the bucket name as the
# subdomain or as the first token of the path. Amazon's S3 service will
# accept it as the subdomain, but Swift's S3 middleware requires it be
# in the path. Set this to 'path' or 'subdomain' - defaults to
'subdomain'.
#s3_store_bucket_url_format = subdomain
# Size, in MB, should S3 start chunking image files
# and do a multipart upload in S3. The default is 100MB.
#s3_store_large_object_size = 100
# Multipart upload part size, in MB, should S3 use when uploading
# parts. The size must be greater than or equal to
# 5MB. The default is 10MB.
#s3_store_large_object_chunk_size = 10
587
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The number of thread pools to perform a multipart upload
# in S3. The default is 10.
#s3_store_thread_pools = 10
# ============ RBD Store Options =============================
# Ceph configuration file path
# If using cephx authentication, this file should
# include a reference to the right keyring
# in a client.<USER> section
#rbd_store_ceph_conf = /etc/ceph/ceph.conf
# RADOS user to authenticate as (only applicable if using cephx)
# If <None>, a default will be chosen based on the client. section
# in rbd_store_ceph_conf
#rbd_store_user = <None>
# RADOS pool in which images are stored
#rbd_store_pool = images
# RADOS images will be chunked into objects of this size (in megabytes).
# For best performance, this should be a power of two
#rbd_store_chunk_size = 8
# ============ Sheepdog Store Options ============================= sheepdog_store_address = localhost sheepdog_store_port = 7000
# Images will be chunked into objects of this size (in megabytes).
# For best performance, this should be a power of two sheepdog_store_chunk_size = 64
# ============ Cinder Store Options ===============================
# Info to match when looking for cinder in the service catalog
# Format is : separated values of the form:
# <service_type>:<service_name>:<endpoint_type> (string value)
#cinder_catalog_info = volume:cinder:publicURL
# Override service catalog lookup with template for cinder endpoint
# e.g. http://localhost:8776/v1/%(project_id)s (string value)
#cinder_endpoint_template = <None>
# Region name of this node (string value)
#os_region_name = <None>
# Location of ca certicates file to use for cinder client requests
# (string value)
#cinder_ca_certificates_file = <None>
# Number of cinderclient retries on failed http calls (integer value)
#cinder_http_retries = 3
# Allow to perform insecure SSL requests to cinder (boolean value)
588
CHAPTER 8. IMAGE SERVICE
#cinder_api_insecure = False
# ============ VMware Datastore Store Options =====================
# ESX/ESXi or vCenter Server target system.
# The server value can be an IP address or a DNS name
# e.g. 127.0.0.1, 127.0.0.1:443, www.vmware-infra.com
#vmware_server_host = <None>
# Server username (string value)
#vmware_server_username = <None>
# Server password (string value)
#vmware_server_password = <None>
# Inventory path to a datacenter (string value)
# Value optional when vmware_server_ip is an ESX/ESXi host: if specified
# should be `ha-datacenter`.
# Deprecated in favor of vmware_datastores.
#vmware_datacenter_path = <None>
# Datastore associated with the datacenter (string value)
# Deprecated in favor of vmware_datastores.
#vmware_datastore_name = <None>
# A list of datastores where the image can be stored.
# This option may be specified multiple times for specifying multiple
# datastores. Either one of vmware_datastore_name or vmware_datastores is
# required. The datastore name should be specified after its datacenter
# path, separated by ":". An optional weight may be given after the datastore
# name, separated again by ":". Thus, the required format becomes
# <datacenter_path>:<datastore_name>:<optional_weight>.
# When adding an image, the datastore with highest weight will be selected,
# unless there is not enough free space available in cases where the image size
# is already known. If no weight is given, it is assumed to be zero and the
# directory will be considered for selection last. If multiple datastores have
# the same weight, then the one with the most free space available is selected.
#vmware_datastores = <None>
# The number of times we retry on failures
# e.g., socket error, etc (integer value)
#vmware_api_retry_count = 10
# The interval used for polling remote tasks
# invoked on VMware ESX/VC server in seconds (integer value)
#vmware_task_poll_interval = 5
# Absolute path of the folder containing the images in the datastore
# (string value)
#vmware_store_image_dir = /openstack_glance
589
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Allow to perform insecure SSL requests to the target system (boolean value)
#vmware_api_insecure = False
8.6.2. glance-registry.conf
590
Configuration for the Image service's registry, which stores the metadata about images, is found in the glance-registry.conf file.
This file must be modified after installation.
[DEFAULT]
# Show more verbose log output (sets INFO log level output)
#verbose = False
# Show debugging output in logs (sets DEBUG log level output)
#debug = False
# Address to bind the registry server bind_host = 0.0.0.0
# Port the bind the registry server to bind_port = 9191
# Log to this file. Make sure you do not set the same log file for both the API
# and registry servers!
#
# If `log_file` is omitted and `use_syslog` is false, then log messages are
# sent to stdout as a fallback.
log_file = /var/log/glance/registry.log
# Backlog requests when creating socket backlog = 4096
# TCP_KEEPIDLE value in seconds when creating socket.
# Not supported on OS X.
#tcp_keepidle = 600
# Timeout (in seconds) for client connections' socket operations. If an incoming
# connection is idle for this period it will be closed. A value of "0"
# means wait forever.
#client_socket_timeout = 0
# API to use for accessing data. Default value points to sqlalchemy
# package.
#data_api = glance.db.sqlalchemy.api
# The number of child process workers that will be
# created to service Registry requests. The default will be
# equal to the number of CPUs available. (integer value)
CHAPTER 8. IMAGE SERVICE
#workers = None
# Enable Registry API versions individually or simultaneously
#enable_v1_registry = True
#enable_v2_registry = True
# Limit the api to return `param_limit_max` items in a call to a container. If
# a larger `limit` query param is provided, it will be reduced to this value.
api_limit_max = 1000
# If a `limit` query param is not provided in an api request, it will
# default to `limit_param_default` limit_param_default = 25
# Role used to identify an authenticated user as administrator
#admin_role = admin
# Enable DEBUG log messages from sqlalchemy which prints every database
# query and response.
# Default: False
#sqlalchemy_debug = True
# http_keepalive option. If False, server will return the header
# "Connection: close", If True, server will return "Connection: Keep-
Alive"
# in its responses. In order to close the client socket connection
# explicitly after the response is sent and read successfully by the client,
# you simply have to set this option to False when you create a wsgi server.
#http_keepalive = True
# ================= Syslog Options ============================
# Send logs to syslog (/dev/log) instead of to file specified
# by `log_file`
#use_syslog = False
# Facility to use. If unset defaults to LOG_USER.
#syslog_log_facility = LOG_LOCAL1
# ================= SSL Options ===============================
# Certificate file to use when starting registry server securely
#cert_file = /path/to/certfile
# Private key file to use when starting registry server securely
#key_file = /path/to/keyfile
# CA certificate file to use to verify connecting clients
#ca_file = /path/to/cafile
# ============ Notification System Options =====================
591
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Driver or drivers to handle sending notifications. Set to
# 'messaging' to send notifications to a message queue.
# notification_driver = noop
# Default publisher_id for outgoing notifications.
# default_publisher_id = image.localhost
# Messaging driver used for 'messaging' notifications driver
# rpc_backend = 'rabbit'
# Configuration options if sending notifications via rabbitmq (these are
# the defaults) rabbit_host = localhost rabbit_port = 5672 rabbit_use_ssl = false rabbit_userid = guest rabbit_password = guest rabbit_virtual_host = / rabbit_notification_exchange = glance rabbit_notification_topic = notifications rabbit_durable_queues = False
# Configuration options if sending notifications via Qpid (these are
# the defaults) qpid_notification_exchange = glance qpid_notification_topic = notifications qpid_hostname = localhost qpid_port = 5672 qpid_username = qpid_password = qpid_sasl_mechanisms = qpid_reconnect_timeout = 0 qpid_reconnect_limit = 0 qpid_reconnect_interval_min = 0 qpid_reconnect_interval_max = 0 qpid_reconnect_interval = 0 qpid_heartbeat = 5
# Set to 'ssl' to enable SSL qpid_protocol = tcp qpid_tcp_nodelay = True
# =============== Policy Options ==============================
[oslo_policy]
# The JSON file that defines policies.
# Deprecated group/name - [DEFAULT]/policy_file
#policy_file = policy.json
# Default rule. Enforced when a requested rule is not found.
# Deprecated group/name - [DEFAULT]/policy_default_rule
#policy_default_rule = default
# Directories where policy configuration files are stored.
# They can be relative to any directory in the search path
# defined by the config_dir option, or absolute paths.
592
CHAPTER 8. IMAGE SERVICE
# The file defined by policy_file must exist for these
# directories to be searched.
# Deprecated group/name - [DEFAULT]/policy_dirs
#policy_dirs = policy.d
# ================= Database Options ==========================
[database]
# The file name to use with SQLite (string value)
#sqlite_db = glance.sqlite
# If True, SQLite uses synchronous mode (boolean value)
#sqlite_synchronous = True
# The backend to use for db (string value)
# Deprecated group/name - [DEFAULT]/db_backend
#backend = sqlalchemy
# The SQLAlchemy connection string used to connect to the
# database (string value)
# Deprecated group/name - [DEFAULT]/sql_connection
# Deprecated group/name - [DATABASE]/sql_connection
# Deprecated group/name - [sql]/connection
#connection = <None>
# The SQL mode to be used for MySQL sessions. This option,
# including the default, overrides any server-set SQL mode. To
# use whatever SQL mode is set by the server configuration,
# set this to no value. Example: mysql_sql_mode= (string
# value)
#mysql_sql_mode = TRADITIONAL
# Timeout before idle sql connections are reaped (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_idle_timeout
# Deprecated group/name - [DATABASE]/sql_idle_timeout
# Deprecated group/name - [sql]/idle_timeout
#idle_timeout = 3600
# Minimum number of SQL connections to keep open in a pool
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_min_pool_size
# Deprecated group/name - [DATABASE]/sql_min_pool_size
#min_pool_size = 1
# Maximum number of SQL connections to keep open in a pool
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_pool_size
# Deprecated group/name - [DATABASE]/sql_max_pool_size
#max_pool_size = <None>
# Maximum db connection retries during startup. (setting -1
# implies an infinite retry count) (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_retries
# Deprecated group/name - [DATABASE]/sql_max_retries
#max_retries = 10
593
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Interval between retries of opening a sql connection
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_retry_interval
# Deprecated group/name - [DATABASE]/reconnect_interval
#retry_interval = 10
# If set, use this value for max_overflow with sqlalchemy
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_overflow
# Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
#max_overflow = <None>
# Verbosity of SQL debugging information. 0=None,
# 100=Everything (integer value)
# Deprecated group/name - [DEFAULT]/sql_connection_debug
#connection_debug = 0
# Add python stack traces to SQL as comment strings (boolean
# value)
# Deprecated group/name - [DEFAULT]/sql_connection_trace
#connection_trace = False
# If set, use this value for pool_timeout with sqlalchemy
# (integer value)
# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
#pool_timeout = <None>
# Enable the experimental use of database reconnect on
# connection lost (boolean value)
#use_db_reconnect = False
# seconds between db connection retries (integer value)
#db_retry_interval = 1
# Whether to increase interval between db connection retries,
# up to db_max_retry_interval (boolean value)
#db_inc_retry_interval = True
# max seconds between db connection retries, if
# db_inc_retry_interval is enabled (integer value)
#db_max_retry_interval = 10
# maximum db connection retries before error is raised.
# (setting -1 implies an infinite retry count) (integer value)
#db_max_retries = 20
[keystone_authtoken] identity_uri = http://127.0.0.1:35357 admin_tenant_name = %SERVICE_TENANT_NAME% admin_user = %SERVICE_USER% admin_password = %SERVICE_PASSWORD%
[paste_deploy]
# Name of the paste configuration file that defines the available pipelines
594
CHAPTER 8. IMAGE SERVICE
#config_file = glance-registry-paste.ini
# Partial name of a pipeline in your paste configuration file with the
# service name removed. For example, if your paste section name is
# [pipeline:glance-registry-keystone], you would configure the flavor below
# as 'keystone'.
#flavor=
[profiler]
# If False fully disable profiling feature.
#enabled = False
# If False doesn't trace SQL requests.
#trace_sqlalchemy = False
8.6.3. glance-api-paste.ini
Configuration for the Image service's API middleware pipeline is found in the glance-api-
paste.ini file.
You should not need to modify this file.
# Use this pipeline for no auth or image caching - DEFAULT
[pipeline:glance-api] pipeline = versionnegotiation osprofiler unauthenticated-context rootapp
# Use this pipeline for image caching and no auth
[pipeline:glance-api-caching] pipeline = versionnegotiation osprofiler unauthenticated-context cache rootapp
# Use this pipeline for caching w/ management interface but no auth
[pipeline:glance-api-cachemanagement] pipeline = versionnegotiation osprofiler unauthenticated-context cache cachemanage rootapp
# Use this pipeline for keystone auth
[pipeline:glance-api-keystone] pipeline = versionnegotiation osprofiler authtoken context rootapp
# Use this pipeline for keystone auth with image caching
[pipeline:glance-api-keystone+caching] pipeline = versionnegotiation osprofiler authtoken context cache rootapp
# Use this pipeline for keystone auth with caching and cache management
[pipeline:glance-api-keystone+cachemanagement] pipeline = versionnegotiation osprofiler authtoken context cache cachemanage rootapp
# Use this pipeline for authZ only. This means that the registry will treat a
# user as authenticated without making requests to keystone to reauthenticate
595
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# the user.
[pipeline:glance-api-trusted-auth] pipeline = versionnegotiation osprofiler context rootapp
# Use this pipeline for authZ only. This means that the registry will treat a
# user as authenticated without making requests to keystone to reauthenticate
# the user and uses cache management
[pipeline:glance-api-trusted-auth+cachemanagement] pipeline = versionnegotiation osprofiler context cache cachemanage rootapp
[composite:rootapp] paste.composite_factory = glance.api:root_app_factory
/: apiversions
/v1: apiv1app
/v2: apiv2app
[app:apiversions] paste.app_factory = glance.api.versions:create_resource
[app:apiv1app] paste.app_factory = glance.api.v1.router:API.factory
[app:apiv2app] paste.app_factory = glance.api.v2.router:API.factory
[filter:versionnegotiation] paste.filter_factory = glance.api.middleware.version_negotiation:VersionNegotiationFilter.factor
y
[filter:cache] paste.filter_factory = glance.api.middleware.cache:CacheFilter.factory
[filter:cachemanage] paste.filter_factory = glance.api.middleware.cache_manage:CacheManageFilter.factory
[filter:context] paste.filter_factory = glance.api.middleware.context:ContextMiddleware.factory
[filter:unauthenticated-context] paste.filter_factory = glance.api.middleware.context:UnauthenticatedContextMiddleware.factory
[filter:authtoken] paste.filter_factory = keystonemiddleware.auth_token:filter_factory delay_auth_decision = true
[filter:gzip] paste.filter_factory = glance.api.middleware.gzip:GzipMiddleware.factory
596
CHAPTER 8. IMAGE SERVICE
[filter:osprofiler] paste.filter_factory = osprofiler.web:WsgiMiddleware.factory
hmac_keys = SECRET_KEY enabled = yes
8.6.4. glance-manage.conf
The Image service's custom logging options are found in the glance-manage.conf file.
Note
Options set in glance-manage.conf will override options of the same section and name set in glance-registry.conf and glance-api.conf. Similarly, options in
glance-api.conf will override options set in glance-registry.conf.
[DEFAULT]
#
# From glance.manage
#
# Print debugging output (set logging level to DEBUG instead of
# default WARNING level). (boolean value)
#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.
# (string value)
# Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s
# . (string value)
#log_date_format = %Y-%m-%d %H:%M:%S
# (Optional) The base directory used for relative --log-file paths.
# (string value)
# Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None>
# (Optional) Name of log file to output to. If no default is set,
# logging will go to stdout. (string value)
# Deprecated group/name - [DEFAULT]/logfile log_file = /var/log/glance/manage.log
# DEPRECATED. A logging.Formatter log message format string which may
# use any of the available logging.LogRecord attributes. This option
# is deprecated. Please use logging_context_format_string and
# logging_default_format_string instead. (string value)
#log_format = <None>
597
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Syslog facility to receive log lines. (string value)
#syslog_log_facility = LOG_USER
# Use syslog for logging. Existing syslog format is DEPRECATED during
# I, and will change in J to honor RFC5424. (boolean value)
#use_syslog = false
# (Optional) Enables or disables syslog rfc5424 format for logging. If
# enabled, prefixes the MSG part of the syslog message with APP-NAME
# (RFC5424). The format without the APP-NAME is deprecated in I, and
# will be removed in J. (boolean value)
#use_syslog_rfc_format = false
# Print more verbose output (set logging level to INFO instead of
# default WARNING level). (boolean value)
#verbose = false
[database]
#
# From oslo.db
#
# The back end to use for the database. (string value)
# Deprecated group/name - [DEFAULT]/db_backend
#backend = sqlalchemy
# The SQLAlchemy connection string to use to connect to the database.
# (string value)
# Deprecated group/name - [DEFAULT]/sql_connection
# Deprecated group/name - [DATABASE]/sql_connection
# Deprecated group/name - [sql]/connection
#connection = <None>
# Verbosity of SQL debugging information: 0=None, 100=Everything.
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_connection_debug
#connection_debug = 0
# Add Python stack traces to SQL as comment strings. (boolean value)
# Deprecated group/name - [DEFAULT]/sql_connection_trace
#connection_trace = false
# If True, increases the interval between database connection retries
# up to db_max_retry_interval. (boolean value)
#db_inc_retry_interval = true
# Maximum database connection retries before error is raised. Set to
# -1 to specify an infinite retry count. (integer value)
#db_max_retries = 20
# If db_inc_retry_interval is set, the maximum seconds between
# database connection retries. (integer value)
#db_max_retry_interval = 10
598
CHAPTER 8. IMAGE SERVICE
# Seconds between database connection retries. (integer value)
#db_retry_interval = 1
# Timeout before idle SQL connections are reaped. (integer value)
# Deprecated group/name - [DEFAULT]/sql_idle_timeout
# Deprecated group/name - [DATABASE]/sql_idle_timeout
# Deprecated group/name - [sql]/idle_timeout
#idle_timeout = 3600
# If set, use this value for max_overflow with SQLAlchemy. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_max_overflow
# Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
#max_overflow = <None>
# Maximum number of SQL connections to keep open in a pool. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_max_pool_size
# Deprecated group/name - [DATABASE]/sql_max_pool_size
#max_pool_size = <None>
# Maximum number of database connection retries during startup. Set to
# -1 to specify an infinite retry count. (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_retries
# Deprecated group/name - [DATABASE]/sql_max_retries
#max_retries = 10
# Minimum number of SQL connections to keep open in a pool. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_min_pool_size
# Deprecated group/name - [DATABASE]/sql_min_pool_size
#min_pool_size = 1
# The SQL mode to be used for MySQL sessions. This option, including
# the default, overrides any server-set SQL mode. To use whatever SQL
# mode is set by the server configuration, set this to no value.
# Example: mysql_sql_mode= (string value)
#mysql_sql_mode = TRADITIONAL
# If set, use this value for pool_timeout with SQLAlchemy. (integer
# value)
# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
#pool_timeout = <None>
# Interval between retries of opening a SQL connection. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_retry_interval
# Deprecated group/name - [DATABASE]/reconnect_interval
#retry_interval = 10
# The SQLAlchemy connection string to use to connect to the slave
# database. (string value)
#slave_connection = <None>
# The file name to use with SQLite. (string value)
# Deprecated group/name - [DEFAULT]/sqlite_db
599
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#sqlite_db = oslo.sqlite
# If True, SQLite uses synchronous mode. (boolean value)
# Deprecated group/name - [DEFAULT]/sqlite_synchronous
#sqlite_synchronous = true
# Enable the experimental use of database reconnect on connection
# lost. (boolean value)
#use_db_reconnect = false
#
# From oslo.db.concurrency
#
# Enable the experimental use of thread pooling for all DB API calls
# (boolean value)
# Deprecated group/name - [DEFAULT]/dbapi_use_tpool
#use_tpool = false
8.6.5. glance-registry-paste.ini
The Image service's middleware pipeline for its registry is found in the glance-registry-
paste.ini file.
# Use this pipeline for no auth - DEFAULT
[pipeline:glance-registry] pipeline = osprofiler unauthenticated-context registryapp
# Use this pipeline for keystone auth
[pipeline:glance-registry-keystone] pipeline = osprofiler authtoken context registryapp
# Use this pipeline for authZ only. This means that the registry will treat a
# user as authenticated without making requests to keystone to reauthenticate
# the user.
[pipeline:glance-registry-trusted-auth] pipeline = osprofiler context registryapp
[app:registryapp] paste.app_factory = glance.registry.api:API.factory
[filter:context] paste.filter_factory = glance.api.middleware.context:ContextMiddleware.factory
[filter:unauthenticated-context] paste.filter_factory = glance.api.middleware.context:UnauthenticatedContextMiddleware.factory
[filter:authtoken] paste.filter_factory = keystonemiddleware.auth_token:filter_factory
600
CHAPTER 8. IMAGE SERVICE
[filter:osprofiler] paste.filter_factory = osprofiler.web:WsgiMiddleware.factory
hmac_keys = SECRET_KEY enabled = yes
8.6.6. glance-scrubber.conf
glance-scrubber is a utility for the Image service that cleans up images that have been deleted; its configuration is stored in the glance-scrubber.conf file.
Multiple instances of glance-scrubber can be run in a single deployment, but only one of them can be designated as the cleanup_scrubber in the glance-scrubber.conf file. The
cleanup_scrubber coordinates other glance-scrubber instances by maintaining the master queue of images that need to be removed.
[DEFAULT]
# Show more verbose log output (sets INFO log level output)
#verbose = False
# Show debugging output in logs (sets DEBUG log level output)
#debug = False
# Log to this file. Make sure you do not set the same log file for both the API
# and registry servers!
#
# If `log_file` is omitted and `use_syslog` is false, then log messages are
# sent to stdout as a fallback.
log_file = /var/log/glance/scrubber.log
# Send logs to syslog (/dev/log) instead of to file specified by
`log_file`
#use_syslog = False
# Should we run our own loop or rely on cron/scheduler to run us daemon = False
# Loop time between checking for new items to schedule for delete wakeup_time = 300
# Directory that the scrubber will use to remind itself of what to delete
# Make sure this is also set in glance-api.conf
scrubber_datadir = /var/lib/glance/scrubber
# Only one server in your deployment should be designated the cleanup host cleanup_scrubber = False
# pending_delete items older than this time are candidates for cleanup cleanup_scrubber_time = 86400
# Address to find the registry server for cleanups registry_host = 0.0.0.0
601
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Port the registry server is listening on registry_port = 9191
# Auth settings if using Keystone
# auth_url = http://127.0.0.1:5000/v2.0/
# admin_tenant_name = %SERVICE_TENANT_NAME%
# admin_user = %SERVICE_USER%
# admin_password = %SERVICE_PASSWORD%
# API to use for accessing data. Default value points to sqlalchemy
# package, it is also possible to use: glance.db.registry.api
#data_api = glance.db.sqlalchemy.api
# ================= Security Options ==========================
# AES key for encrypting store 'location' metadata, including
# -- if used -- Swift or S3 credentials
# Should be set to a random string of length 16, 24 or 32 bytes
#metadata_encryption_key = <16, 24 or 32 char registry metadata key>
# =============== Policy Options ==============================
# The JSON file that defines policies.
#policy_file = policy.json
# Default rule. Enforced when a requested rule is not found.
#policy_default_rule = default
# Directories where policy configuration files are stored.
# They can be relative to any directory in the search path
# defined by the config_dir option, or absolute paths.
# The file defined by policy_file must exist for these
# directories to be searched.
#policy_dirs = policy.d
# ================= Database Options ===============+==========
[database]
# The SQLAlchemy connection string used to connect to the
# database (string value)
#connection=sqlite:////glance/openstack/common/db/$sqlite_db
# The SQLAlchemy connection string used to connect to the
# slave database (string value)
#slave_connection=
# timeout before idle sql connections are reaped (integer
# value)
#idle_timeout=3600
# Minimum number of SQL connections to keep open in a pool
# (integer value)
#min_pool_size=1
602
CHAPTER 8. IMAGE SERVICE
# Maximum number of SQL connections to keep open in a pool
# (integer value)
#max_pool_size=<None>
# maximum db connection retries during startup. (setting -1
# implies an infinite retry count) (integer value)
#max_retries=10
# interval between retries of opening a sql connection
# (integer value)
#retry_interval=10
# If set, use this value for max_overflow with sqlalchemy
# (integer value)
#max_overflow=<None>
# Verbosity of SQL debugging information. 0=None,
# 100=Everything (integer value)
#connection_debug=0
# Add python stack traces to SQL as comment strings (boolean
# value)
#connection_trace=false
# If set, use this value for pool_timeout with sqlalchemy
# (integer value)
#pool_timeout=<None>
[oslo_concurrency]
# Enables or disables inter-process locks. (boolean value)
# Deprecated group/name - [DEFAULT]/disable_process_locking
#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. It could be read from environment variable
# OSLO_LOCK_PATH. This setting needs to be the same for both
# glance-scrubber and glance-api service. Default to a temp directory.
# Deprecated group/name - [DEFAULT]/lock_path (string value)
#lock_path = /tmp
8.6.7. policy.json
The /etc/glance/policy.json file defines additional access controls that apply to the Image service.
{
"context_is_admin": "role:admin",
"default": "",
"add_image": "",
"delete_image": "",
"get_image": "",
"get_images": "",
603
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"modify_image": "",
"publicize_image": "role:admin",
"copy_from": "",
"download_image": "",
"upload_image": "",
"delete_image_location": "",
"get_image_location": "",
"set_image_location": "",
"add_member": "",
"delete_member": "",
"get_member": "",
"get_members": "",
"modify_member": "",
"manage_image_cache": "role:admin",
"get_task": "",
"get_tasks": "",
"add_task": "",
"modify_task": "",
"deactivate": "",
"reactivate": "",
"get_metadef_namespace": "",
"get_metadef_namespaces":"",
"modify_metadef_namespace":"",
"add_metadef_namespace":"",
"get_metadef_object":"",
"get_metadef_objects":"",
"modify_metadef_object":"",
"add_metadef_object":"",
"list_metadef_resource_types":"",
"get_metadef_resource_type":"",
"add_metadef_resource_type_association":"",
"get_metadef_property":"",
"get_metadef_properties":"",
"modify_metadef_property":"",
"add_metadef_property":"",
"get_metadef_tag":"",
"get_metadef_tags":"",
"modify_metadef_tag":"",
"add_metadef_tag":"",
"add_metadef_tags":""
}
604
CHAPTER 8. IMAGE SERVICE
8.7. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
OPENSTACK IMAGE SERVICE
Table 8.32. New options
Option = default value
[DEFAULT] args = None
[DEFAULT] available_plugins =
[DEFAULT] backdoor_port = None
[DEFAULT] chunksize = 65536
[DEFAULT] command = None
[DEFAULT] digest_algorithm = sha1
[DEFAULT] disabled_notifications =
[DEFAULT] dontreplicate = created_at date deleted_at location updated_at
(Type) Help string
(ListOpt) Arguments for the command
(ListOpt) A list of artifacts that are allowed in the format name or name-version. Empty list means that any artifact can be loaded.
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
(IntOpt) Amount of data to transfer per HTTP write.
(StrOpt) Command to be given to replicator
(StrOpt) Digest algorithm which will be used for digital signature; the default is sha1 the default in
Kilo for a smooth upgrade process, and it will be updated with sha256 in next release(L). Use the command "openssl list-message-digest-algorithms" to get the available algorithms supported by the version of OpenSSL on the platform. Examples are
"sha1", "sha256", "sha512", etc.
(ListOpt) List of disabled notifications. A notification can be given either as a notification type to disable a single event, or as a notification group prefix to disable all events within a group. Example: if this config option is set to ["image.create",
"metadef_namespace"], then "image.create" notification will not be sent after image is created and none of the notifications for metadefinition namespaces will be sent.
(StrOpt) List of fields to not replicate.
605
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] host = localhost
[DEFAULT] http_keepalive = True
[DEFAULT] http_timeout = 600
[DEFAULT] listener_workers = 1
[DEFAULT] load_enabled = True
[DEFAULT] log-config-append = None
[DEFAULT] log-date-format = %Y-%m-%d
%H:%M:%S
[DEFAULT] log-dir = None
[DEFAULT] log-file = None
[DEFAULT] log-format = None
[DEFAULT] mastertoken =
[DEFAULT] metaonly = False
(Type) Help string
(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For
ZeroMQ only, must be a valid host name, FQDN, or IP address.
(BoolOpt) If False, server will return the header
"Connection: close", If True, server will return
"Connection: Keep-Alive" in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server.
(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.
(IntOpt) Number of workers for notification service.
A single notification agent is enabled by default.
(BoolOpt) When false, no artifacts can be loaded regardless of available_plugins. When true, artifacts can be loaded.
(StrOpt) 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.
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Pass in your authentication token if you have one. This is the token used for the master.
(BoolOpt) Only replicate metadata, not images.
606
Option = default value
[DEFAULT] public_endpoint = None
[DEFAULT] slavetoken =
[DEFAULT] syslog-log-facility = LOG_USER
[DEFAULT] token =
[DEFAULT] use-syslog = False
[DEFAULT] use-syslog-rfc-format = False
[database] backend = sqlalchemy
[database] connection = None
[database] connection_debug = 0
[database] connection_trace = False
[database] db_inc_retry_interval = True
[database] db_max_retries = 20
[database] db_max_retry_interval = 10
[database] db_retry_interval = 1
CHAPTER 8. IMAGE SERVICE
(Type) Help string
(StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If
Glance is operating behind a proxy, you will want to change this to represent the proxy's URL.
(StrOpt) Pass in your authentication token if you have one. This is the token used for the slave.
(StrOpt) Syslog facility to receive log lines.
(StrOpt) Pass in your authentication token if you have one. If you use this option the same token is used for both the master and the slave.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
607
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[database] idle_timeout = 3600
[database] max_overflow = None
[database] max_pool_size = None
[database] max_retries = 10
[database] min_pool_size = 1
[database] mysql_sql_mode = TRADITIONAL
[database] pool_timeout = None
[database] retry_interval = 10
[database] slave_connection = None
[database] sqlite_db = oslo.sqlite
[database] sqlite_synchronous = True
[database] use_db_reconnect = False
[elasticsearch] hosts = 127.0.0.1:9200
[glance_store] store_capabilities_update_min_interval = 0
(Type) Help string
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
(ListOpt) List of nodes where Elasticsearch instances are running. A single node should be defined as an IP address and port number.
(IntOpt) Minimum interval seconds to execute updating dynamic storage capabilities based on backend status then. It's not a periodic routine, the update logic will be executed only when interval seconds elapsed and an operation of store has triggered. The feature will be enabled only when the option value greater then zero.
608
CHAPTER 8. IMAGE SERVICE
Option = default value
[glance_store] swift_store_cacert = None
[glance_store] swift_store_endpoint = None
[glance_store] swift_store_multiple_containers_seed = 0
[glance_store] vmware_datastores = None
(Type) Help string
(StrOpt) A string giving the CA certificate file to use in SSL connections for verifying certs.
(StrOpt) If set, the configured endpoint will be used.
If None, the storage url from the auth response will be used.
(IntOpt) When set to 0, a single-tenant store will only use one container to store all images. When set to an integer value between 1 and 32, a singletenant store will use multiple containers to store images, and this value will determine how many containers are created.Used only when swift_store_multi_tenant is disabled. The total number of containers that will be used is equal to
16^N, so if this config option is set to 2, then
16^2=256 containers will be used to store images.
(MultiStrOpt) A list of datastores where the image can be stored. This option may be specified multiple times for specifying multiple datastores.
Either one of vmware_datastore_name or vmware_datastores is required. The datastore name should be specified after its datacenter path, seperated by ":". An optional weight may be given after the datastore name, seperated again by ":".
Thus, the required format becomes
<datacenter_path>:<datastore_name>:
<optional_weight>. When adding an image, the datastore with highest weight will be selected, unless there is not enough free space available in cases where the image size is already known. If no weight is given, it is assumed to be zero and the directory will be considered for selection last. If multiple datastores have the same weight, then the one with the most free space available is selected.
(BoolOpt) Enables or disables inter-process locks.
[oslo_concurrency] disable_process_locking =
False
[oslo_concurrency] lock_path = None
[oslo_messaging_amqp] allow_insecure_clients =
False
(StrOpt) 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 external locks are used, a lock path must be set.
(BoolOpt) Accept clients using either SSL or plain
TCP
609
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
(Type) Help string
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
[oslo_messaging_amqp] ssl_key_file =
[oslo_messaging_amqp] ssl_key_password =
None
[oslo_messaging_amqp] trace = False
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] amqp_durable_queues =
False
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_qpid] qpid_heartbeat = 60 (IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
[oslo_messaging_qpid] qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
610
CHAPTER 8. IMAGE SERVICE
Option = default value
[oslo_messaging_qpid] qpid_sasl_mechanisms =
[oslo_messaging_qpid] qpid_tcp_nodelay = True
[oslo_messaging_qpid] qpid_topology_version = 1
(Type) Help string
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30
[oslo_messaging_rabbit] amqp_auto_delete =
False
[oslo_messaging_rabbit] amqp_durable_queues =
False
[oslo_messaging_rabbit] fake_rabbit = False
[oslo_messaging_rabbit] heartbeat_rate = 2
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
611
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(Type) Help string
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
[oslo_messaging_rabbit] rabbit_port = 5672
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
[oslo_messaging_rabbit] rabbit_retry_interval = 1
[oslo_messaging_rabbit] rabbit_use_ssl = False
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
[oslo_messaging_rabbit] rpc_conn_pool_size = 30
[oslo_policy] policy_default_rule = default
[oslo_policy] policy_dirs = ['policy.d']
(IntOpt) Size of RPC connection pool.
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
612
Option = default value
[oslo_policy] policy_file = policy.json
[service_credentials] insecure = False
[service_credentials] os_auth_url = http://localhost:5000/v2.0
[service_credentials] os_cacert = None
[service_credentials] os_endpoint_type = publicURL
[service_credentials] os_password = admin
[service_credentials] os_region_name = None
[service_credentials] os_tenant_id =
[service_credentials] os_tenant_name = admin
[service_credentials] os_username = glance
[task] work_dir = None
CHAPTER 8. IMAGE SERVICE
(Type) Help string
(StrOpt) The JSON file that defines policies.
(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.
(StrOpt) Auth URL to use for OpenStack service access.
(StrOpt) Certificate chain for SSL validation.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
(StrOpt) Password to use for OpenStack service access.
(StrOpt) Region name to use for OpenStack service endpoints.
(StrOpt) Tenant ID to use for OpenStack service access.
(StrOpt) Tenant name to use for OpenStack service access.
(StrOpt) User name to use for OpenStack service access.
(StrOpt) Work dir for asynchronous task operations.
The directory set here will be used to operate over images - normally before they are imported in the destination store. When providing work dir, make sure enough space is provided for concurrent tasks to run efficiently without running out of space. A rough estimation can be done by multiplying the number of `max_workers` - or the N of workers running - by an average image size (e.g 500MB).
The image size estimation should be done based on the average size in your deployment. Note that depending on the tasks running you may need to multiply this number by some factor depending on what the task does. For example, you may want to double the available size if image conversion is enabled. All this being said, remember these are just estimations and you should do them based on the worst case scenario and be prepared to act in case they were wrong.
613
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[taskflow_executor] conversion_format = None
[taskflow_executor] engine_mode = parallel
[taskflow_executor] max_workers = 10
(Type) Help string
(StrOpt) The format to which images will be automatically converted. Can be 'qcow2' or 'raw'.
(StrOpt) The mode in which the engine will run.
Can be 'serial' or 'parallel'.
(IntOpt) The number of parallel activities executed at the same time by the engine. The value can be greater than one when the engine mode is
'parallel'.
Table 8.33. New default values
Option
[DEFAULT] default_log_levels
[DEFAULT] rpc_zmq_matchmaker
[task] task_executor
Previous default value New default value amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retr
y=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN oslo.messaging._drivers.matchm
aker.MatchMakerLocalhost
local eventlet taskflow
Table 8.34. Deprecated options
Deprecated option
[DEFAULT] log-format
[glance_store] vmware_datacenter_path
[DEFAULT] log_format
New Option
None
None
None
614
Deprecated option
[DEFAULT] use-syslog
[task] eventlet_executor_pool_size
[glance_store] vmware_datastore_name
[DEFAULT] use_syslog
CHAPTER 8. IMAGE SERVICE
New Option
None
[taskflow_executor] max_workers
None
None
615
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
CHAPTER 9. NETWORKING
This chapter explains the OpenStack Networking configuration options.
9.1. NETWORKING CONFIGURATION OPTIONS
The options and descriptions listed in this introduction are auto generated from the code in the
Networking service project, which provides software-defined networking between VMs run in
Compute. The list contains common options, while the subsections list the options for the various networking plug-ins.
Table 9.1. Description of common configuration options
Configuration option = Default value
[DEFAULT] admin_password
= None
admin_tenant_name
= None
admin_user
= None
agent_down_time
= 75
Description api_workers
= 0
auth_ca_cert
= None
auth_insecure
= False
auth_region
= None
auth_strategy
= keystone
auth_url
= None
base_mac
= fa:16:3e:00:00:00
bind_host
= 0.0.0.0
(StrOpt) Admin password.
(StrOpt) Admin tenant name.
(StrOpt) Admin username.
(IntOpt) Number of seconds required to flag the agent as down. Should be at least twice
'report_interval' to ensure the agent is permanently down.
(IntOpt) Number of separate API worker processes for service.
(StrOpt) Certificate Authority public key (CA cert) file for ssl.
(BoolOpt) Turn off verification of the certificate for ssl.
(StrOpt) Authentication region.
(StrOpt) The type of authentication to use.
(StrOpt) Authentication URL.
(StrOpt) The base MAC address Neutron will use for VIFs.
(StrOpt) The host IP to bind to.
616
Configuration option = Default value bind_port
= 9696
core_plugin
= None
default_ipv4_subnet_pool
= None
default_ipv6_subnet_pool
= None
dhcp_agent_notification
= True
dhcp_agents_per_network
= 1
dhcp_broadcast_reply
= False
dhcp_confs
= $state_path/dhcp
dhcp_delete_namespaces
= False
dhcp_domain
= openstacklocal
dhcp_driver
=
neutron.agent.linux.dhcp.Dnsmasq
dhcp_lease_duration
= 86400
dhcp_load_type
= networks
CHAPTER 9. NETWORKING
Description
(IntOpt) The port to bind to.
(StrOpt) The core plugin neutron will use.
(StrOpt) Default IPv4 subnet-pool to be used for automatic subnet CIDR allocation.
(StrOpt) Default IPv6 subnet-pool to be used for automatic subnet CIDR allocation.
(BoolOpt) Allow the sending of resource operation notifications to DHCP agents.
(IntOpt) Number of DHCP agents scheduled to host a network.
(BoolOpt) Use broadcasts in DHCP replies.
(StrOpt) Location to store DHCP server config files.
(BoolOpt) Delete namespace after removing a dhcp server.
(StrOpt) Domain to use for building the hostnames.
(StrOpt) The driver used to manage the DHCP server.
(IntOpt) DHCP lease duration (in seconds). Use -1 to configure dnsmasq for infinite lease times.
(StrOpt) Represents the resource type whose load is being reported by the agent. This can be
'networks', 'subnets' or 'ports'. When specified
(default is 'networks'), the server will extract the particular load sent as part of its agent configuration object from the agent report state, which is the number of resources being consumed.
'report_interval.dhcp_load_type' can be used in combination with 'network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.WeightS
cheduler'. When the 'network_scheduler_driver' is
'WeightScheduler', 'dhcp_load_type' can be configured to represent the choice for the resource being balanced. For example:
'dhcp_load_type=networks'.
617
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value enable_services_on_agents_with_adm in_state_down
= False
(BoolOpt) Enable services on an agent where
'admin_state_up' is 'False'. If this option is 'False', and the 'admin_state_up' of an agent is 'False', services on it will be disabled. Agents with
'admin_state_up' set to 'False' are not selected for automatic scheduling regardless of this option.
However, manual scheduling to such agents is available if this option is 'True'.
endpoint_type
= publicURL
Description
(StrOpt) Network service endpoint type to pull from the keystone catalog.
force_gateway_on_subnet
= True
host
= localhost
interface_driver
= None
ip_lib_force_root memcached_servers periodic_interval
= False
mac_generation_retries max_allowed_address_pair max_dns_nameservers
= 5
max_fixed_ips_per_port max_subnet_host_routes periodic_fuzzy_delay
= 16
= 5
= 20
= None
= 40
= 5
= 10
(BoolOpt) Ensure the configured gateway is on a subnet. For IPv6, validate only if gateway is not a link local address. Deprecated, to be removed during the K release, at which point the check will be mandatory.
(StrOpt) Hostname to be used by the neutron server, agents, and services running on this machine. All the agents and services running on this machine must use the same host value.
(StrOpt) The driver used to manage the virtual interface.
(BoolOpt) Force 'ip_lib' calls to use the root helper.
(IntOpt) Number of times neutron will retry MAC generation.
(IntOpt) Maximum number of allowed address pairs.
(IntOpt) Maximum number of DNS nameservers.
(IntOpt) Maximum number of fixed IPs per port.
(IntOpt) Maximum number of host routes per subnet.
(ListOpt) Memcached servers or 'None' for inprocess cache.
(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler. This reduces stampeding. (Disable by setting to 0)
(IntOpt) Seconds between running periodic tasks.
618
CHAPTER 9. NETWORKING
Configuration option = Default value periodic_monitoring_interval
= 5
report_interval state_path
= 300
= /var/lib/neutron
vlan_transparent
= False
Description
(IntOpt) Periodic interval at which the plugin checks for the monitoring L2 gateway agent.
(IntOpt) Interval between two metering reports.
(StrOpt) Location for storing neutron state files.
This directory must be writable by the agent.
(BoolOpt) If 'True', this allows plugins that support it to create VLAN transparent networks.
[AGENT] check_child_processes_action
=
respawn
check_child_processes_interval
= 60
root_helper
= sudo
root_helper_daemon
= None
(StrOpt) Action to be executed when a child process dies.
(IntOpt) Interval between checks of child process liveness (seconds), use '0' to disable.
(StrOpt) Root helper application.
(StrOpt) Root helper daemon application to use when possible.
[PROXY] admin_password
= None
admin_tenant_name
= None
admin_user
= None
auth_region
= None
auth_strategy
= keystone
auth_url
= None
[heleos] admin_password
= None
[keystone_authtoken] memcached_servers
= None
(StrOpt) Admin password.
(StrOpt) Admin tenant name.
(StrOpt) Admin user.
(StrOpt) Authentication region.
(StrOpt) The type of authentication to use.
(StrOpt) Authentication URL.
(StrOpt) ESM admin password.
(ListOpt) Optional. Specifies a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
619
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
9.1.1. Networking plug-ins
OpenStack Networking introduces the concept of a plug-in, which is a back-end implementation of the OpenStack Networking API. A plug-in can use a variety of technologies to implement the logical
API requests. Some OpenStack Networking plug-ins might use basic Linux VLANs and IP tables, while others might use more advanced technologies, such as L2-in-L3 tunneling or OpenFlow.
These sections detail the configuration options for the various plug-ins.
Note
The following plugins have been removed in Kilo:
Ryu plugin. The Ryu team recommends that you migrate to the ML2 plugin with the ofagent mechanism driver. However, note that the functionality is not the same. There is no upgrade procedure currently available.
Mellanox plugin.
9.1.1.1. BigSwitch configuration options
Table 9.2. Description of BigSwitch configuration options
Configuration option = Default value
[NOVA] node_override_vif_802.1qbg
=
Description node_override_vif_802.1qbh
node_override_vif_binding_failed
=
node_override_vif_bridge node_override_vif_dvs
=
=
node_override_vif_hostdev
=
=
node_override_vif_distributed
=
(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg
(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh
(ListOpt) Nova compute nodes to manually set VIF type to binding_failed
(ListOpt) Nova compute nodes to manually set VIF type to bridge
(ListOpt) Nova compute nodes to manually set VIF type to distributed
(ListOpt) Nova compute nodes to manually set VIF type to dvs
(ListOpt) Nova compute nodes to manually set VIF type to hostdev
620
CHAPTER 9. NETWORKING
Configuration option = Default value node_override_vif_hw_veb
=
node_override_vif_hyperv node_override_vif_ivs
=
node_override_vif_midonet node_override_vif_ovs vif_type
= ivs
auto_sync_on_failure cache_connections
= True
=
= True
=
node_override_vif_mlnx_direct node_override_vif_other
=
=
node_override_vif_unbound node_override_vif_vrouter
=
=
=
vif_types
= unbound, binding_failed, ovs, ivs,
bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, hw_veb, dvs, other, distributed, vrouter
[RESTPROXY] add_meta_server_route
= True
Description
(ListOpt) Nova compute nodes to manually set VIF type to hw_veb
(ListOpt) Nova compute nodes to manually set VIF type to hyperv
(ListOpt) Nova compute nodes to manually set VIF type to ivs
(ListOpt) Nova compute nodes to manually set VIF type to midonet
(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct
(ListOpt) Nova compute nodes to manually set VIF type to other
(ListOpt) Nova compute nodes to manually set VIF type to ovs
(ListOpt) Nova compute nodes to manually set VIF type to unbound
(ListOpt) Nova compute nodes to manually set VIF type to vrouter
(StrOpt) Virtual interface type to configure on Nova compute nodes
(ListOpt) List of allowed vif_type values.
(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM
(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.
(BoolOpt) Re-use HTTP/HTTPS connections to the controller.
621
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value consistency_interval
= 60
neutron_id no_ssl_validation server_auth server_ssl
= neutron-images
server_timeout servers
= 10
= localhost:8800
ssl_cert_directory ssl_sticky
= True
=
/etc/neutron/plugins/bigswitch/ssl
sync_data
= None
= True
= False
thread_pool_size
= False
= 4
Description
(IntOpt) Time between verifications that the backend controller database is consistent with
Neutron. (0 to disable)
(StrOpt) User defined identifier for this Neutron deployment
(BoolOpt) Disables SSL certificate validation for controllers
(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.
(BoolOpt) If True, Use SSL when connecting to the
Big Switch or Floodlight controller.
(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete.
(ListOpt) A comma separated list of Big Switch or
Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.
(StrOpt) Directory containing ca_certs and host_certs certificate directories.
(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address.
(BoolOpt) Sync data on connect
(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations.
[RESTPROXYAGENT] integration_bridge
= br-int
polling_interval
= 5
virtual_switch_type
= ivs
(StrOpt) Name of integration bridge on compute nodes used for security group insertion.
(IntOpt) Seconds between agent checks for port changes
(StrOpt) Virtual switch type.
622
CHAPTER 9. NETWORKING
Configuration option = Default value
[ROUTER] max_router_rules
= 200
tenant_default_router_rule
=
['*:any:any:permit']
Description
(IntOpt) Maximum number of router rules
(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:
<destination>:<action> Use an * to specify default for all tenants.
9.1.1.2. Brocade configuration options
Table 9.3. Description of Brocade configuration options
Configuration option = Default value
[PHYSICAL_INTERFACE] physical_interface
= eth0
Description
(StrOpt) The network interface to use when creating a port
[SWITCH] address
=
ostype
= NOS
password
=
username
=
(StrOpt) The address of the host to SSH to
(StrOpt) Currently unused
(StrOpt) The SSH password to use
(StrOpt) The SSH username to use
9.1.1.3. Brocade MLX L3 plug-in
Configure switch names to be used as group names as described below
Table 9.4. Description of Brocade MLX L3 plug-in configuration options
Configuration option = Default value
[l3_brocade_mlx] switch_names
=
Description
(StrOpt) Switches connected to the compute nodes
623
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
9.1.1.4. Brocade Vyatta layer 3 plug-in
The Brocade Vyatta Layer 3 plug-in configures Vyatta vRouter. More information about the plug-in is available at: Brocade_Vyatta_L3_Plugin .
Use the following options to configure the Brocade Vyatta Layer 3 plug-in.
Table 9.5. Description of Brocade Vyatta L3 plug-in configuration options
Description Configuration option = Default value
[VROUTER] flavor
= 2
image_id
= None
keystone_url
= None
management_network_id
= None
nova_poll_interval
= 5
nova_spawn_timeout
= 300
tenant_admin_name
= None
tenant_admin_password
= None
tenant_id
= None
vrouter_boot_timeout
= 300
vrouter_credentials
= vyatta:vyatta
vrouter_poll_interval
= 5
(StrOpt) Nova VM flavor for instances of Vyatta vRouter.
(StrOpt) Nova image id for instances of Vyatta vRouter.
(StrOpt) Keystone URL.
(StrOpt) Vyatta vRouter management network id.
(IntOpt) Number of seconds between consecutive
Nova queries when waiting for router instance status change.
(IntOpt) Number of seconds to wait for Nova to activate instance before setting resource to error state.
(StrOpt) Name of tenant admin user.
(StrOpt) Tenant admin password.
(StrOpt) UUID of tenant that holds Vyatta vRouter instances.
(IntOpt) Number of seconds to wait for Vyatta vRouter to boot before setting resource to error state.
(StrOpt) Vyatta vRouter login credentials
(IntOpt) Number of seconds between consecutive
Vyatta vRouter queries when waiting for router instance boot.
624
9.1.1.5. CISCO configuration options
CHAPTER 9. NETWORKING
Table 9.6. Description of Cisco configuration options
Configuration option = Default value
[CISCO]
Description model_class
=
neutron.plugins.cisco.models.virt_phy_sw_v2.Virtu
alPhysicalSwitchModelV2
(StrOpt) Model Class
nexus_l3_enable
= False
provider_vlan_auto_create provider_vlan_auto_trunk
= True
provider_vlan_name_prefix svi_round_robin
= False
= True
= p-
(BoolOpt) Enable L3 support on the Nexus switches
(BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch
(BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch
(StrOpt) VLAN Name prefix for provider vlans
(BoolOpt) Distribute SVI interfaces over all switches
(StrOpt) VLAN Name prefix
vlan_name_prefix
= q-
[CISCO_N1K] bridge_mappings
=
default_network_profile
=
default_network_profile
default_policy_profile
= service_profile
enable_tunneling
= True
http_pool_size
= 4
http_timeout
dhcp_pp
= 15
integration_bridge
= br-int
network_node_policy_profile
=
(StrOpt) N1K Bridge Mappings
(StrOpt) N1K default network profile
(StrOpt) N1K default policy profile
(BoolOpt) N1K Enable Tunneling
(IntOpt) Number of threads to use to make HTTP requests
(IntOpt) N1K http timeout duration in seconds
(StrOpt) N1K Integration Bridge
(StrOpt) N1K policy profile for network node
network_vlan_ranges
= vlan:1:4095 (StrOpt) N1K Network VLAN Ranges
625
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value poll_duration
= 60
restrict_network_profiles restrict_policy_profiles
= True
= False
tenant_network_type
= local
tunnel_bridge
= br-tun
vxlan_id_ranges
= 5000:10000
[cfg_agent] device_connection_timeout
= 30
Description
(IntOpt) N1K Policy profile polling duration in seconds
(BoolOpt) Restrict tenants from accessing network profiles belonging to some other tenant
(BoolOpt) Restrict the visibility of policy profiles to the tenants
(StrOpt) N1K Tenant Network Type
(StrOpt) N1K Tunnel Bridge
(StrOpt) N1K VXLAN ID Ranges
hosting_device_dead_timeout
= 300
(IntOpt) Time in seconds for connecting to a hosting device
(IntOpt) The time in seconds until a backlogged hosting device is presumed dead. This value should be set up high enough to recover from a period of connectivity loss or high load when the device may not be responding.
[general] backlog_processing_interval
= 10
cfg_agent_down_time
= 60
(IntOpt) Time in seconds between renewed scheduling attempts of non-scheduled routers.
(IntOpt) Seconds of no status update until a cfg agent is considered down.
default_security_group
= mgmt_sec_grp (StrOpt) Default security group applied on management port. Default value is mgmt_sec_grp.
ensure_nova_running
= True (BoolOpt) Ensure that Nova is running before attempting to create any VM.
(StrOpt) Name of the L3 admin tenant.
l3_admin_tenant
= L3AdminTenant
management_network
= osn_mgmt_nw (StrOpt) Name of management network for device configuration. Default value is osn_mgmt_nw
service_vm_config_path
=
/opt/stack/data/neutron/cisco/config_drive
(StrOpt) Path to config drive files for service VM instances.
626
CHAPTER 9. NETWORKING
Configuration option = Default value templates_path
=
/opt/stack/data/neutron/cisco/templates
[hosting_devices]
Description
(StrOpt) Path to templates for hosting devices.
csr1kv_booting_time
= 420 (IntOpt) Booting time in seconds before a CSR1kv becomes operational.
csr1kv_cfgagent_router_driver
=
networking_cisco.plugins.cisco.cfg_agent.device_d
rivers.csr1kv.csr1kv_routing_driver.CSR1kvRoutin
gDriver
(StrOpt) Config agent driver for CSR1kv.
csr1kv_device_driver
=
networking_cisco.plugins.cisco.l3.hosting_device_
drivers.csr1kv_hd_driver.CSR1kvHostingDeviceDri
ver
(StrOpt) Hosting device driver for CSR1kv.
csr1kv_flavor
= 621
csr1kv_image
= csr1kv_openstack_img
csr1kv_password
= cisco
(StrOpt) UUID of Nova flavor for CSR1kv.
(StrOpt) Name of Glance image for CSR1kv.
(StrOpt) Password to use for CSR1kv configurations.
csr1kv_plugging_driver
=
networking_cisco.plugins.cisco.l3.plugging_drivers.
n1kv_trunking_driver.N1kvTrunkingPlugDriver
(StrOpt) Plugging driver for CSR1kv.
csr1kv_username
= stack (StrOpt) Username to use for CSR1kv configurations.
9.1.1.6. CloudBase Hyper-V Agent configuration options
Table 9.7. Description of HyperV agent configuration options
Configuration option = Default value
[AGENT] enable_metrics_collection
= False
Description
(BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows
Server 2012 and above
627
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value local_network_vswitch
= private
metrics_max_retries polling_interval
= 2
= 100
physical_network_vswitch_mappings
=
Description
(StrOpt) Private vswitch name used for local networks
(IntOpt) Specifies the maximum number of retries to enable Hyper-V's port metrics collection. The agent will try to enable the feature once every polling_interval period for at most metrics_max_retries or until it succeedes.
(ListOpt) List of <physical_network>:<vswitch> where the physical networks can be expressed with wildcards, e.g.: ."*:external"
(IntOpt) The number of seconds the agent will wait between polling for local device changes.
[hyperv] force_hyperv_utils_v1
= False (BoolOpt) Force V1 WMI utility classes
9.1.1.7. Embrane configuration options
Table 9.8. Description of Embrane configuration options
Configuration option = Default value
[heleos] admin_username
= admin
async_requests
= True
dummy_utif_id
= None
esm_mgmt
= None
inband_id
= None
mgmt_id
= None
oob_id
= None
resource_pool_id
= default
router_image
= None
Description
(StrOpt) ESM admin username.
(BoolOpt) Define if the requests have run asynchronously or not
(StrOpt) Dummy user traffic Security Zone id
(StrOpt) ESM management root address
(StrOpt) In band Security Zone id
(StrOpt) Management Security Zone id
(StrOpt) Out of band Security Zone id
(StrOpt) Shared resource pool id
(StrOpt) Router image id (Embrane FW/VPN)
628
CHAPTER 9. NETWORKING
9.1.1.8. IBM SDN-VE configuration options
Table 9.9. Description of SDN-VE configuration options
Description Configuration option = Default value
[SDNVE] base_url
= /one/nb/v2/
controller_ips
= 127.0.0.1
default_tenant_type
= OVERLAY
format
= json
info
= sdnve_info_string
integration_bridge
= None
interface_mappings
=
of_signature
= SDNVE-OF
out_of_band
= True
overlay_signature
= SDNVE-OVERLAY
password
= admin
port
= 8443
reset_bridge
= True
use_fake_controller
= False
userid
= admin
[SDNVE_AGENT] polling_interval
= 2
rpc
= True
(StrOpt) Base URL for SDN-VE controller REST
API.
(ListOpt) List of IP addresses of SDN-VE controller(s).
(StrOpt) Tenant type: OVERLAY (default) or OF.
(StrOpt) SDN-VE request/response format.
(StrOpt) SDN-VE RPC subject.
(StrOpt) Integration bridge to use.
(ListOpt) List of <physical_network_name>:
<interface_name> mappings.
(StrOpt) The string in tenant description that indicates the tenant is a OF tenant.
(BoolOpt) Indicating if controller is out of band or not.
(StrOpt) The string in tenant description that indicates the tenant is a OVERLAY tenant.
(StrOpt) SDN-VE administrator password.
(StrOpt) SDN-VE controller port number.
(BoolOpt) Whether to reset the integration bridge before use.
(BoolOpt) Whether to use a fake controller.
(StrOpt) SDN-VE administrator user ID.
(IntOpt) Agent polling interval if necessary.
(BoolOpt) Whether to use rpc.
629
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
9.1.1.9. Layer 2 Gateway configuration options
Table 9.10. Description of Layer 2 Gateway configuration options
Configuration option = Default value
[DEFAULT] default_device_name
= Switch1
default_l2_gw_service_uuid default_l3_gw_service_uuid
= None
= None
l2gw_callback_class
=
networking_l2gw.services.l2gateway.ovsdb.data.L
2GatewayOVSDBCallbacks
quota_l2_gateway
= 5
Description
(StrOpt) default_device_name of the l2 gateway
(StrOpt) Unique identifier of the NSX L2 Gateway service which will be used by default for network gateways
(StrOpt) Unique identifier of the NSX L3 Gateway service which will be used for implementing routers and floating IPs
(StrOpt) L2 gateway plugin callback class where theRPCs from the agent are going to get invoked
(IntOpt) Number of l2 gateways allowed per tenant,
-1 for unlimited
[ovsdb] l2_gw_agent_ca_cert_base_path
=
None
l2_gw_agent_cert_base_path
= None
l2_gw_agent_priv_key_base_path
=
None
max_connection_retries
= 10
(StrOpt) Trusted issuer CA cert
(StrOpt) L2 gateway agent public certificate
(StrOpt) L2 gateway agent private key
ovsdb_hosts
= host1:127.0.0.1:6632
periodic_interval
= 20
(IntOpt) Maximum number of retries to open a socket with the OVSDB server
(StrOpt) OVSDB server name:host/IP:port
(IntOpt) Seconds between periodic task runs
9.1.1.10. Linux bridge Agent configuration options
Table 9.11. Description of Linux Bridge agent configuration options
630
CHAPTER 9. NETWORKING
Configuration option = Default value
[LINUX_BRIDGE] physical_interface_mappings
=
Description
(ListOpt) List of <physical_network>:
<physical_interface>
[VLANS] network_vlan_ranges
=
tenant_network_type
= local
(ListOpt) List of <physical_network>:<vlan_min>:
<vlan_max> or <physical_network>
(StrOpt) Network type for tenant networks (local, vlan, or none)
[VXLAN] enable_vxlan
= True
l2_population
= False
local_ip
= None
tos
= None
ttl
= None
vxlan_group
= 224.0.0.1
(BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver
(BoolOpt) Extension to use alongside ml2 plugin's l2population mechanism driver. It enables the plugin to populate VXLAN forwarding table.
(IPOpt) Local IP address of the VXLAN endpoints.
(IntOpt) TOS for vxlan interface protocol packets.
(IntOpt) TTL for vxlan interface protocol packets.
(StrOpt) Multicast group for vxlan interface.
9.1.1.11. Meta Plug-in configuration options
The Meta Plug-in allows you to use multiple plug-ins at the same time.
Table 9.12. Description of meta configuration options
Configuration option = Default value
[META] default_flavor
=
Description
(StrOpt) Default flavor to use, when flavor:network is not specified at network creation.
631
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value default_l3_flavor
=
extension_map l3_plugin_list plugin_list rpc_flavor
=
=
=
=
supported_extension_aliases
=
Description
(StrOpt) Default L3 flavor to use, when flavor:router is not specified at router creation. Ignored if
'l3_plugin_list' is blank.
(StrOpt) Comma separated list of method:flavor to select specific plugin for a method. This has priority over method search order based on 'plugin_list'.
(StrOpt) Comma separated list of flavor:neutron_plugin for L3 service plugins to load.
This is intended for specifying L2 plugins which support L3 functions. If you use a router service plugin, set this blank.
(StrOpt) Comma separated list of flavor:neutron_plugin for plugins to load. Extension method is searched in the list order and the first one is used.
(StrOpt) Specifies flavor for plugin to handle 'qplugin' RPC requests.
(StrOpt) Comma separated list of supported extension aliases.
9.1.1.12. Modular Layer 2 (ml2) configuration options
The Modular Layer 2 (ml2) plug-in has two components: network types and mechanisms. You can configure these components separately. This section describes these configuration options.
Configure MTU for VXLAN tunnelling
Specific MTU configuration is necessary for VXLAN to function as expected:
One option is to increase the MTU value of the physical interface and physical switch fabric by at least 50 bytes. For example, increase the MTU value to 1550. This value enables an automatic 50-byte MTU difference between the physical interface (1500) and the VXLAN interface (automatically 1500-50 = 1450). An MTU value of 1450 causes issues when virtual machine taps are configured at an MTU value of 1500.
Another option is to decrease the virtual Ethernet devices' MTU. Set the
network_device_mtu option to 1450 in the neutron.conf file, and set all guest virtual machines' MTU to the same value by using a DHCP option. For information about MTU settings, see the Networking Guide.
632
Table 9.13. Description of ML2 configuration options
CHAPTER 9. NETWORKING
Configuration option = Default value
[ml2] extension_drivers
=
mechanism_drivers path_mtu
= 0
type_drivers
=
physical_network_mtus segment_mtu
= 0
tenant_network_types
=
= local
= local, flat, vlan, gre, vxlan
Description
(ListOpt) An ordered list of extension driver entrypoints to be loaded from the neutron.ml2.extension_drivers namespace.
(ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace.
(IntOpt) The maximum permissible size of an unfragmented packet travelling from and to addresses where encapsulated Neutron traffic is sent. If <= 0, the path MTU is indeterminate.
(ListOpt) A list of mappings of physical networks to
MTU values. The format of the mapping is
<physnet>:<mtu val>. This mapping allows specifying a physical network MTU value that differs from the default segment_mtu value.
(IntOpt) The maximum permissible size of an unfragmented packet travelling a L2 network segment. If <= 0, the segment MTU is indeterminate.
(ListOpt) Ordered list of network_types to allocate as tenant networks.
(ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers
namespace.
9.1.1.12.1. Modular Layer 2 (ml2) Flat Type configuration options
Table 9.14. Description of ML2 Flat mechanism driver configuration options
Configuration option = Default value
[ml2_type_flat] flat_networks
=
Description
(ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names.
9.1.1.12.2. Modular Layer 2 (ml2) GRE Type configuration options
633
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 9.15. Description of ML2 GRE configuration options
Configuration option = Default value
[ml2_type_gre] tunnel_id_ranges
=
Description
(ListOpt) Comma-separated list of <tun_min>:
<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation
9.1.1.12.3. Modular Layer 2 (ml2) VLAN Type configuration options
Table 9.16. Description of ML2 VLAN configuration options
Configuration option = Default value
[ml2_type_vlan] network_vlan_ranges
=
Description
(ListOpt) List of <physical_network>:<vlan_min>:
<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks.
634
9.1.1.12.4. Modular Layer 2 (ml2) VXLAN Type configuration options
Table 9.17. Description of ML2 VXLN configuration options
Description Configuration option = Default value
[ml2_type_nexus_vxlan] mcast_ranges
=
vni_ranges
=
(ListOpt) List of multicast groups to be used for global VNIDsin the format - a:b,c,e:f.
(ListOpt) List of global VNID ranges in the format a:b, c:d.Multiple ranges can be separated by a comma
[ml2_type_vxlan] vni_ranges
= (ListOpt) Comma-separated list of <vni_min>:
<vni_max> tuples enumerating ranges of VXLAN
VNI IDs that are available for tenant network allocation
CHAPTER 9. NETWORKING
Configuration option = Default value Description vxlan_group
= None (StrOpt) Multicast group for VXLAN. If unset, disables VXLAN multicast mode.
9.1.1.12.5. Modular Layer 2 (ml2) Arista Mechanism configuration options
Table 9.18. Description of ML2 Arista mechanism driver configuration options
Configuration option = Default value
[ml2_arista] eapi_host
=
Description eapi_password eapi_username region_name sync_interval use_fqdn
= RegionOne
= True
=
=
= 180
(StrOpt) Arista EOS IP address. This is required field. If not set, all communications to Arista EOS will fail.
(StrOpt) Password for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail.
(StrOpt) Username for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail.
(StrOpt) Defines Region Name that is assigned to this OpenStack Controller. This is useful when multiple OpenStack/Neutron controllers are managing the same Arista HW clusters. Note that this name must match with the region name registered (or known) to keystone service.
Authentication with Keysotne is performed by EOS.
This is optional. If not set, a value of "RegionOne" is assumed.
(IntOpt) Sync interval in seconds between Neutron plugin and EOS. This interval defines how often the synchronization is performed. This is an optional field. If not set, a value of 180 seconds is assumed.
(BoolOpt) Defines if hostnames are sent to Arista
EOS as FQDNs ("node1.domain.com") or as short names ("node1"). This is optional. If not set, a value of "True" is assumed.
635
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 9.19. Description of Arista layer-3 service plug-in configuration options
Configuration option = Default value
[l3_arista] l3_sync_interval
= 180
Description mlag_config primary_l3_host use_vrf
= False
= False
=
primary_l3_host_password primary_l3_host_username secondary_l3_host
=
=
=
(IntOpt) Sync interval in seconds between L3
Service plugin and EOS. This interval defines how often the synchronization is performed. This is an optional field. If not set, a value of 180 seconds is assumed
(BoolOpt) This flag is used indicate if Arista
Switches are configured in MLAG mode. If yes, all
L3 config is pushed to both the switches automatically. If this flag is set to True, ensure to specify IP addresses of both switches. This is optional. If not set, a value of "False" is assumed.
(StrOpt) Arista EOS IP address. This is required field. If not set, all communications to Arista EOS will fail
(StrOpt) Password for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail
(StrOpt) Username for Arista EOS. This is required field. If not set, all communications to Arista EOS will fail
(StrOpt) Arista EOS IP address for second Switch
MLAGed with the first one. This an optional field, however, if mlag_config flag is set, then this is required. If not set, all communications to Arista
EOS will fail
(BoolOpt) A "True" value for this flag indicates to create a router in VRF. If not set, all routers are created in default VRF. This is optional. If not set, a value of "False" is assumed.
9.1.1.12.6. Modular Layer 2 (ml2) BigSwitch Mechanism configuration options
Table 9.20. Description of ML2 BigSwitch mechanism driver configuration options
Configuration option = Default value
[NOVA]
Description
636
CHAPTER 9. NETWORKING
Configuration option = Default value node_override_vif_802.1qbg
=
node_override_vif_802.1qbh
node_override_vif_other node_override_vif_ovs
=
=
node_override_vif_unbound node_override_vif_vrouter
=
=
=
node_override_vif_binding_failed
=
node_override_vif_bridge node_override_vif_distributed node_override_vif_dvs
=
=
node_override_vif_hostdev node_override_vif_hw_veb node_override_vif_hyperv node_override_vif_ivs
=
=
=
node_override_vif_midonet
=
=
node_override_vif_mlnx_direct
=
=
Description
(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbg
(ListOpt) Nova compute nodes to manually set VIF type to 802.1qbh
(ListOpt) Nova compute nodes to manually set VIF type to binding_failed
(ListOpt) Nova compute nodes to manually set VIF type to bridge
(ListOpt) Nova compute nodes to manually set VIF type to distributed
(ListOpt) Nova compute nodes to manually set VIF type to dvs
(ListOpt) Nova compute nodes to manually set VIF type to hostdev
(ListOpt) Nova compute nodes to manually set VIF type to hw_veb
(ListOpt) Nova compute nodes to manually set VIF type to hyperv
(ListOpt) Nova compute nodes to manually set VIF type to ivs
(ListOpt) Nova compute nodes to manually set VIF type to midonet
(ListOpt) Nova compute nodes to manually set VIF type to mlnx_direct
(ListOpt) Nova compute nodes to manually set VIF type to other
(ListOpt) Nova compute nodes to manually set VIF type to ovs
(ListOpt) Nova compute nodes to manually set VIF type to unbound
(ListOpt) Nova compute nodes to manually set VIF type to vrouter
637
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value vif_type
= ivs
vif_types
= unbound, binding_failed, ovs, ivs,
bridge, 802.1qbg, 802.1qbh, hyperv, midonet, mlnx_direct, hostdev, hw_veb, dvs, other, distributed, vrouter
[RESTPROXY] add_meta_server_route
= True
auto_sync_on_failure cache_connections consistency_interval neutron_id
= neutron-images
no_ssl_validation server_auth server_ssl server_timeout servers
= None
= True
= 10
= True
= localhost:8800
= True
= 60
= False
Description
(StrOpt) Virtual interface type to configure on Nova compute nodes
(ListOpt) List of allowed vif_type values.
(BoolOpt) Flag to decide if a route to the metadata server should be injected into the VM
(BoolOpt) If neutron fails to create a resource because the backend controller doesn't know of a dependency, the plugin automatically triggers a full data synchronization to the controller.
(BoolOpt) Re-use HTTP/HTTPS connections to the controller.
(IntOpt) Time between verifications that the backend controller database is consistent with
Neutron. (0 to disable)
(StrOpt) User defined identifier for this Neutron deployment
(BoolOpt) Disables SSL certificate validation for controllers
(StrOpt) The username and password for authenticating against the Big Switch or Floodlight controller.
(BoolOpt) If True, Use SSL when connecting to the
Big Switch or Floodlight controller.
(IntOpt) Maximum number of seconds to wait for proxy request to connect and complete.
(ListOpt) A comma separated list of Big Switch or
Floodlight servers and port numbers. The plugin proxies the requests to the Big Switch/Floodlight server, which performs the networking configuration. Only oneserver is needed per deployment, but you may wish todeploy multiple servers to support failover.
638
Configuration option = Default value ssl_cert_directory
=
/etc/neutron/plugins/bigswitch/ssl
ssl_sticky
= True
CHAPTER 9. NETWORKING
Description
(StrOpt) Directory containing ca_certs and host_certs certificate directories.
(BoolOpt) Trust and store the first certificate received for each controller address and use it to validate future connections to that address.
(BoolOpt) Sync data on connect
(IntOpt) Maximum number of threads to spawn to handle large volumes of port creations.
sync_data
= False
thread_pool_size
= 4
[RESTPROXYAGENT] integration_bridge
= br-int
polling_interval
= 5
virtual_switch_type
= ivs
[ROUTER] max_router_rules
= 200
tenant_default_router_rule
=
['*:any:any:permit']
(StrOpt) Name of integration bridge on compute nodes used for security group insertion.
(IntOpt) Seconds between agent checks for port changes
(StrOpt) Virtual switch type.
(IntOpt) Maximum number of router rules
(MultiStrOpt) The default router rules installed in new tenant routers. Repeat the config option for each rule. Format is <tenant>:<source>:
<destination>:<action> Use an * to specify default for all tenants.
9.1.1.12.7. Modular Layer 2 (ml2) Brocade Mechanism configuration options
Table 9.21. Description of ML2 Brocade mechanism driver configuration options
Configuration option = Default value
[ml2_brocade] address
=
ostype
= NOS
osversion
= 4.0.0
password
= password
Description
(StrOpt) The address of the host to SSH to
(StrOpt) OS Type of the switch
(StrOpt) OS Version number
(StrOpt) The SSH password to use
639
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value physical_networks
=
rbridge_id
= 1
username
= admin
Description
(StrOpt) Allowed physical networks
(StrOpt) Rbridge id of provider edge router(s)
(StrOpt) The SSH username to use
9.1.1.12.8. Modular Layer 3 (ml2) Brocade MLX ICX Mechanism configuration options
Configure switch names to be used as group names as described below
Table 9.22. Description of ML2 Brocade MLX ICX mechanism driver configuration options
Configuration option = Default value
[ml2_brocade_fi_ni] switch_names
=
Description
(StrOpt) Switches connected to the compute nodes
9.1.1.12.9. Modular Layer 2 (ml2) Cisco Mechanism configuration options
Table 9.23. Description of ML2 Cisco mechanism driver configuration options
Description Configuration option = Default value
[DEFAULT] apic_system_id
= openstack
[ml2_cisco] host_key_checks
= False
(StrOpt) Prefix for APIC domain/names/profiles created
managed_physical_network
= None
persistent_switch_config
= False
provider_vlan_auto_create
= True
(BoolOpt) Enable strict host key checks when connecting to Nexus switches
(StrOpt) The physical network managed by the switches.
(BoolOpt) To make Nexus configuration persistent
(BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch
640
Configuration option = Default value provider_vlan_auto_trunk
= True
provider_vlan_name_prefix svi_round_robin
= False
switch_heartbeat_time switch_replay_count vlan_name_prefix
= q-
= 0
= 3
vxlan_global_config
= False
= p-
CHAPTER 9. NETWORKING
Description
(BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch
(StrOpt) VLAN Name prefix for provider vlans
(BoolOpt) Distribute SVI interfaces over all switches
(IntOpt) Periodic time to check switch connection.
(0=disabled)
(IntOpt) Number of times to attempt config replay with switch.
(StrOpt) VLAN Name prefix
(BoolOpt) Create and delete Nexus switch VXLAN global settings; feature nv overlay, feature vnsegment-vlan-based, interface nve + sourceinterface loopback
[ml2_cisco_apic] apic_agent_poll_interval
= 2
apic_agent_report_interval
= 30
apic_app_profile_name
=
${apic_system_id}_app
apic_domain_name
= ${apic_system_id}
apic_entity_profile
=
${apic_system_id}_entity_profile
apic_function_profile
=
${apic_system_id}_function_profile
apic_host_uplink_ports
=
apic_hosts
=
apic_lacp_profile
=
${apic_system_id}_lacp_profile
(FloatOpt) Interval between agent poll for topology
(in sec)
(FloatOpt) Interval between agent status updates
(in sec)
(StrOpt) Name for the app profile used for
Openstack
(StrOpt) Name for the domain created on APIC
(StrOpt) Name of the entity profile to be created
(StrOpt) Name of the function profile to be created
(ListOpt) The uplink ports to check for ACI connectivity
(ListOpt) An ordered list of host names or IP addresses of the APIC controller(s).
(StrOpt) Name of the LACP profile to be created
641
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value apic_name_mapping
= use_name
Description
(StrOpt) Name mapping strategy to use: use_uuid | use_name
(StrOpt) Name of the node profile to be created
apic_node_profile
=
${apic_system_id}_node_profile
apic_password
= None
apic_sync_interval
= 0
apic_use_ssl
= True
apic_username
= None
apic_vlan_ns_name
=
${apic_system_id}_vlan_ns
apic_vlan_range
= 2:4093
apic_vpc_pairs
=
[ml2_cisco_n1kv] default_policy_profile
= default-pp
default_vlan_network_profile
=
default-vlan-np
default_vxlan_network_profile
=
default-vxlan-np
http_pool_size
= 4
http_timeout
= 15
n1kv_vsm_ips password
= None
= None
poll_duration
= 60
restrict_policy_profiles
= False
(StrOpt) Password for the APIC controller
(IntOpt) Synchronization interval in seconds
(BoolOpt) Use SSL to connect to the APIC controller
(StrOpt) Username for the APIC controller
(StrOpt) Name for the vlan namespace to be used for Openstack
(StrOpt) Range of VLAN's to be used for Openstack
(ListOpt) The switch pairs for VPC connectivity
(StrOpt) Cisco Nexus1000V default policy profile.
(StrOpt) Cisco Nexus1000V default network profile for VLAN networks.
(StrOpt) Cisco Nexus1000V default network profile for VXLAN networks.
(IntOpt) Number of threads to use to make HTTP requests.
(IntOpt) HTTP timeout, in seconds, for connections to the Cisco Nexus1000V VSMs.
(ListOpt) Comma Separated IP Addresses of the
Cisco Nexus1000V VSMs.
(StrOpt) Password for all configured Cisco
Nexus1000V VSMs.
(IntOpt) Cisco Nexus1000V policy profile polling duration in seconds.
(BoolOpt) Restrict the visibility of policy profiles to the tenants.
642
Configuration option = Default value sync_interval
= 300
username
= None
[ml2_cisco_ucsm] supported_pci_devs
= 1137:0071,
8086:10c9
CHAPTER 9. NETWORKING
Description
(IntOpt) Time interval between consecutive neutron-VSM syncs.
(StrOpt) Username for all configured Cisco
Nexus1000V VSMs.
ucsm_host_list ucsm_ip
= None
ucsm_password ucsm_username
= None
= None
= None
(ListOpt) List of comma separated vendor_id:product_id of SR_IOV capable devices supported by this MD. This MD supports both VM-
FEX and SR-IOV devices.
(ListOpt) List of comma separated Host:Service
Profile tuples providing the Service Profile associated with each Host to be supported by this
MD.
(StrOpt) Cisco UCS Manager IP address. This is a required field to communicate with a Cisco UCS
Manager.
(StrOpt) Password for UCS Manager. This is a required field to communicate with a Cisco UCS
Manager.
(StrOpt) Username for UCS Manager. This is a required field to communicate with a Cisco UCS
Manager.
9.1.1.12.10. Modular Layer 2 (ml2) Freescale SDN Mechanism configuration options
Table 9.24. Description of ML2 Freescale SDN mechanism driver configuration options
Description Configuration option = Default value
[ml2_fslsdn] crd_api_insecure
= False
crd_auth_strategy
= keystone
crd_auth_url
= http://127.0.0.1:5000/v2.0/
crd_ca_certificates_file
= None
(BoolOpt) If set, ignore any SSL validation issues.
(StrOpt) Auth strategy for connecting to neutron in admin context.
(StrOpt) CRD Auth URL.
(StrOpt) Location of ca certificates file to use for
CRD client requests.
643
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value crd_password
= password
crd_region_name
= RegionOne
crd_tenant_name crd_url crd_url_timeout crd_user_name
= service
= http://127.0.0.1:9797
= 30
= crd
Description
(StrOpt) CRD Service Password.
(StrOpt) Region name for connecting to CRD
Service in admin context.
(StrOpt) CRD Tenant Name.
(StrOpt) URL for connecting to CRD service.
(IntOpt) Timeout value for connecting to CRD service in seconds.
(StrOpt) CRD service Username.
9.1.1.12.11. Modular Layer 2 (ml2) OpenDaylight Mechanism configuration options
Table 9.25. Description of ML2 OpenDaylight mechanism driver configuration options
Configuration option = Default value
[ml2_odl] password
= None
session_timeout
= 30
timeout
= 10
url
= None
username
= None
Description
(StrOpt) HTTP password for authentication
(IntOpt) Tomcat session timeout in minutes.
(IntOpt) HTTP timeout in seconds.
(StrOpt) HTTP URL of OpenDaylight REST interface.
(StrOpt) HTTP username for authentication
9.1.1.12.12. Modular Layer 2 (ml2) OpenFlow Agent (ofagent) Mechanism configuration options
Table 9.26. Description of ML2 ofagent mechanism driver configuration options
Configuration option = Default value
[AGENT] dont_fragment
= True
Description
(BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel.
644
CHAPTER 9. NETWORKING
9.1.1.12.13. Modular Layer 2 (ml2) L2 Population Mechanism configuration options
Table 9.27. Description of ML2 L2 population configuration options
Configuration option = Default value
[l2pop] agent_boot_time
= 180
Description
(IntOpt) Delay within which agent is expected to update existing ports whent it restarts
9.1.1.12.14. Modular Layer 2 (ml2) Tail-f NCS Mechanism configuration options
Table 9.28. Description of ML2 NCS mechanism driver configuration options
Configuration option = Default value
[ml2_ncs] password
= None
timeout
= 10
url
= None
username
= None
Description
(StrOpt) HTTP password for authentication
(IntOpt) HTTP timeout in seconds.
(StrOpt) HTTP URL of Tail-f NCS REST interface.
(StrOpt) HTTP username for authentication
9.1.1.12.15. Modular Layer 2 (ml2) SR-IOV Mechanism configuration options
Table 9.29. Description of ML2 ML2 SR-IOV driver configuration options
Description Configuration option = Default value
[ml2_sriov] agent_required
= False
supported_pci_vendor_devs
=
15b3:1004, 8086:10ca
(BoolOpt) SRIOV neutron agent is required for port binding
(ListOpt) Supported PCI vendor devices, defined by vendor_id:product_id according to the PCI ID
Repository. Default enables support for Intel and
Mellanox SR-IOV capable NICs
9.1.1.13. MidoNet configuration options
645
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 9.30. Description of Midonet configuration options
Configuration option = Default value
[MIDONET] cluster_ip
= localhost
Description cluster_port
= 8088
tunnel_protocol
= vxlan
use_cluster
= False
(StrOpt) IP that the cluster service can be reached on
(StrOpt) Port that the cluster service can be reached on
(StrOpt) Tunnel protocol used by Midonet
(BoolOpt) Use the midonet plugin that interacts with the tasks-based architecture, rather than the plugin that interacts with the HTTP based architecture.
9.1.1.14. NEC configuration options
Table 9.31. Description of Nec configuration options
Configuration option = Default value
[OFC] api_max_attempts
= 3
Description cert_file
= None
driver
= trema
enable_packet_filter
= True
host
= 127.0.0.1
insecure_ssl
= False
key_file
= None
path_prefix
=
port
= 8888
(IntOpt) Maximum attempts per OFC API request.
NEC plugin retries API request to OFC when OFC returns ServiceUnavailable (503). The value must be greater than 0.
(StrOpt) Location of certificate file.
(StrOpt) Driver to use.
(BoolOpt) Enable packet filter.
(StrOpt) Host to connect to.
(BoolOpt) Disable SSL certificate verification.
(StrOpt) Location of key file.
(StrOpt) Base URL of OFC REST API. It is prepended to each API request.
(StrOpt) Port to connect to.
646
CHAPTER 9. NETWORKING
Configuration option = Default value Description support_packet_filter_on_ofc_route r
= True
(BoolOpt) Support packet filter on OFC router interface.
(BoolOpt) Use SSL to connect.
use_ssl
= False
[PROVIDER] default_router_provider
= l3-agent
router_providers
= l3-agent, openflow
[fwaas] driver
=
(StrOpt) Default router provider to use.
(ListOpt) List of enabled router providers.
(StrOpt) Name of the FWaaS Driver
9.1.1.15. One Convergence NVSD configuration options
Table 9.32. Description of NVSD driver configuration options
Configuration option = Default value
[AGENT] integration_bridge
= br-int
[nvsd] nvsd_ip
= 127.0.0.1
nvsd_passwd
= oc123
nvsd_port
= 8082
nvsd_retries
= 0
nvsd_user
= ocplugin
request_timeout
= 30
Description
(StrOpt) integration bridge
(StrOpt) NVSD Controller IP address
(StrOpt) NVSD Controller password
(IntOpt) NVSD Controller Port number
(IntOpt) Number of login retries to NVSD controller
(StrOpt) NVSD Controller username
(IntOpt) NVSD controller REST API request timeout in seconds
9.1.1.16. OpenContrail configuration options
Table 9.33. Description of OpenContrail configuration options
647
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[CONTRAIL] api_server_ip
= 127.0.0.1
Description
(StrOpt) IP address to connect to opencontrail controller
(IntOpt) Port to connect to opencontrail controller
api_server_port
= 8082
9.1.1.17. Open vSwitch Agent configuration options
Table 9.34. Description of Open vSwitch agent configuration options
Configuration option = Default value
[DEFAULT] ovs_integration_bridge ovs_use_veth
= False
ovs_vsctl_timeout
= 10
= br-int
Description
(StrOpt) Name of Open vSwitch bridge to use
(BoolOpt) Uses veth for an interface or not
(IntOpt) Timeout in seconds for ovs-vsctl commands
[AGENT] arp_responder
= False
dont_fragment
= True
enable_distributed_routing l2_population
= False
minimize_polling
= True
= False
ovsdb_monitor_respawn_interval
= 30
(BoolOpt) Enable local ARP responder if it is supported. Requires OVS 2.1 and ML2 l2population driver. Allows the switch (when supporting an overlay) to respond to an ARP request locally without performing a costly ARP broadcast into the overlay.
(BoolOpt) Set or un-set the don't fragment (DF) bit on outgoing IP packet carrying GRE/VXLAN tunnel.
(BoolOpt) Make the l2 agent run in DVR mode.
(BoolOpt) Use ML2 l2population mechanism driver to learn remote MAC and IPs and improve tunnel scalability.
(BoolOpt) Minimize polling by monitoring ovsdb for interface changes.
(IntOpt) The number of seconds to wait before respawning the ovsdb monitor after losing communication with it.
648
Configuration option = Default value prevent_arp_spoofing
= False
quitting_rpc_timeout
= 10
tunnel_types
=
veth_mtu
= None
vxlan_udp_port
= 4789
[CISCO_N1K] local_ip
= 10.0.0.3
[OVS] bridge_mappings
=
int_peer_patch_port
= patch-tun
integration_bridge
= br-int
local_ip
= None
ovsdb_interface
= vsctl
tun_peer_patch_port
= patch-int
tunnel_bridge
= br-tun
use_veth_interconnection
= False
CHAPTER 9. NETWORKING
Description
(BoolOpt) Enable suppression of ARP responses that don't match an IP address that belongs to the port from which they originate. Note: This prevents the VMs attached to this agent from spoofing, it doesn't protect them from other devices which have the capability to spoof (e.g. bare metal or
VMs attached to agents without this flag set to
True). Spoofing rules will not be added to any ports that have port security disabled. This requires a version of OVS that supports matching ARP headers.
(IntOpt) Set new timeout in seconds for new rpc calls after agent receives SIGTERM. If value is set to 0, rpc timeout won't be changed
(ListOpt) Network types supported by the agent
(gre and/or vxlan).
(IntOpt) MTU size of veth interfaces
(IntOpt) The UDP port to use for VXLAN tunnels.
(StrOpt) N1K Local IP
(ListOpt) List of <physical_network>:<bridge>.
Deprecated for ofagent.
(StrOpt) Peer patch port in integration bridge for tunnel bridge.
(StrOpt) Integration bridge to use.
(IPOpt) Local IP address of tunnel endpoint.
(StrOpt) The interface for interacting with the
OVSDB
(StrOpt) Peer patch port in tunnel bridge for integration bridge.
(StrOpt) Tunnel bridge to use.
(BoolOpt) Use veths instead of patch ports to interconnect the integration bridge to physical bridges.
649
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
9.1.1.18. PLUMgrid configuration options
Table 9.35. Description of PLUMgrid configuration options
Configuration option = Default value
[plumgriddirector] director_server
= localhost
director_server_port
= 8080
Description
(StrOpt) PLUMgrid Director server to connect to
(StrOpt) PLUMgrid Director server port to connect to
driver
=
networking_plumgrid.neutron.plugins.drivers.plumli
b.Plumlib
(StrOpt) PLUMgrid Driver
password
= password
servertimeout
= 5
username
= username
(StrOpt) PLUMgrid Director admin password
(IntOpt) PLUMgrid Director server timeout
(StrOpt) PLUMgrid Director admin username
9.1.1.19. SR-IOV configuration options
Table 9.36. Description of SR-IOV configuration options
Configuration option = Default value
[SRIOV_NIC] exclude_devices
=
Description physical_device_mappings
=
(ListOpt) List of <network_device>:
<excluded_devices> mapping network_device to the agent's node-specific list of virtual functions that should not be used for virtual networking.
excluded_devices is a semicolon separated list of virtual functions (BDF format).to exclude from network_device. The network_device in the mapping should appear in the physical_device_mappings list.
(ListOpt) List of <physical_network>:
<network_device> mapping physical network names to the agent's node-specific physical network device of SR-IOV physical function to be used for VLAN networks. All physical networks listed in network_vlan_ranges on the server should have mappings to appropriate interfaces on each agent
650
CHAPTER 9. NETWORKING
9.1.1.20. VMware vSphere configuration options
Table 9.37. Description of VMware configuration options
Configuration option = Default value
[DEFAULT] default_interface_name
= breth0
Description
(StrOpt) Name of the interface on a L2 Gateway transport nodewhich should be used by default when setting up a network connection
[OVSVAPP] agent_driver
=
networking_vsphere.agent.ovsvapp_agent.OVSvA
ppL2Agent
(StrOpt) OVSvApp Agent implementation.
agent_maintenance
= False (BoolOpt) Turn on this flag during agent updates to help prevent datapath outage.
bridge_mappings
=
dont_fragment
= True
integration_bridge local_ip
=
= br-int
(ListOpt) Bridge mappings.
(IntOpt) Do not fragment.
(StrOpt) Integration Bridge.
(StrOpt) Local IP address of VXLAN tunnel endpoint.
network_manager
=
networking_vsphere.drivers.manager.VcenterMana
ger
(StrOpt) Driver Manager implementation for
NetworkDriver.
polling_interval
= 2 (IntOpt) The number of seconds the agent will wait between polling for local device changes.
report_interval
= 4
tenant_network_type tunnel_bridge tunnel_types veth_mtu
= 1500
= br-tun
= vxlan
vxlan_udp_port
= 4789
= vlan
(IntOpt) Seconds between nodes reporting state to server.
(StrOpt) Network type for tenant networks
(StrOpt) Tunnel Bridge for tunneling.
(ListOpt) Tunnel network types supported by the
OVSvApp Agent.
(IntOpt) MTU size of veth interfaces.
(IntOpt) The UDP port to use for VXLAN tunnels.
651
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[VMWARE] cert_check
= False
cert_path
= /etc/ssl/certs/certs.pem
cluster_dvs_mapping
= ['']
esx_hostname
= None
esx_maintenance_mode
= True
https_port
= 443
vcenter_api_retry_count
= 5
vcenter_id
= None
vcenter_ip
= None
vcenter_password
= None
vcenter_username
= None
wsdl_location
= None
Description
(BoolOpt) Enable SSL certificate check for vCenter.
(StrOpt) Certificate chain path containing cacert of vCenters.
(MultiStrOpt) vCenter cluster to DVS mapping.
(StrOpt) ESX host name where this OVSvApp is hosted.
(BoolOpt) Set host into maintenance mode.
(IntOpt) Customized https_port for vCenter communication.
(StrOpt) Number of retries while connecting to vcenter server.
(StrOpt) Unique ID of the vCenter Server on which this OVSvApp ishosted
(StrOpt) vCenter server IP.
(StrOpt) vCenter server password.
(StrOpt) vCenter server user name.
(StrOpt) vCenter server wsdl location.
9.1.1.21. VMware NSX configuration options
Table 9.38. Description of VMware NSX configuration options
Configuration option = Default value
[DEFAULT] conn_idle_timeout
= 900
Description default_service_cluster_uuid
= None
(IntOpt) Reconnect connection to nsx if not used within this amount of time.
(StrOpt) Unique identifier of the Service Cluster which will be used by logical services like dhcp and metadata
652
Configuration option = Default value default_tz_uuid
= None
http_timeout
= 75
nsx_controllers
= None
nsx_password
= admin
nsx_user
= admin
redirects
= 2
retries
= 2
[NSX] agent_mode
= agent
concurrent_connections
= 10
default_transport_type
= stt
max_lp_per_bridged_ls
= 5000
max_lp_per_overlay_ls
= 256
metadata_mode
= access_network
nsx_gen_timeout
= -1
CHAPTER 9. NETWORKING
Description
(StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated
"Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin.
(IntOpt) Time before aborting a request
(ListOpt) Lists the NSX controllers in this cluster
(StrOpt) Password for NSX controllers in this cluster
(StrOpt) User name for NSX controllers in this cluster
(IntOpt) Number of times a redirect should be followed
(IntOpt) Number of time a request should be retried
(StrOpt) The mode used to implement
DHCP/metadata services.
(IntOpt) Maximum concurrent connections to each
NSX controller.
(StrOpt) The default network tranport type to use
(stt, gre, bridge, ipsec_gre, or ipsec_stt)
(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 5000)
(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 256)
(StrOpt) If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Neutron router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used.
(IntOpt) Number of seconds a generation id should be valid for (default -1 meaning do not time out)
653
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value replication_mode
= service
Description
(StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s). It must be set to 'service' for leveraging distributed routers.
[NSX_SYNC] always_read_status
= False
max_random_sync_delay min_chunk_size
= 500
min_sync_req_delay
= 1
state_sync_interval
= 0
= 10
(BoolOpt) Always read operational status from backend on show operations. Enabling this option might slow down the system.
(IntOpt) Maximum value for the additional random delay in seconds between runs of the state synchronization task
(IntOpt) Minimum number of resources to be retrieved from NSX during state synchronization
(IntOpt) Minimum delay, in seconds, between two state synchronization queries to NSX. It must not exceed state_sync_interval
(IntOpt) Interval in seconds between runs of the state synchronization task. Set it to 0 to disable it
[nsx_v3] default_edge_cluster_uuid
= None
[nsxv] backup_edge_pool
= service:large:4:10,
service:compact:4:10, vdr:large:4:10
(StrOpt) Default edge cluster identifier
cluster_moid datacenter_moid datastore_id
=
= None
= None
deployment_container_id
= None
(ListOpt) Defines edge pool using the format:
<edge_type>:[edge_size]:<min_edges>:
<max_edges>.edge_type: service,vdr. edge_size: compact, large, xlarge, quadlarge and default is large.
(ListOpt) Parameter listing the IDs of the clusters which are used by OpenStack.
(StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges
(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges
(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges
654
CHAPTER 9. NETWORKING
Configuration option = Default value dvs_id
= None
external_network
= None
manager_uri
= None
maximum_tunnels_per_vnic metadata_shared_secret mgt_net_moid mgt_net_proxy_ips mgt_net_proxy_netmask nova_metadata_ips nova_metadata_port password
= default
= 8775
resource_pool_id
= None
retries
= 10
= None
spoofguard_enabled
= 20
= None
mgt_net_default_gateway
= None
= None
= None
= None
= True
task_status_check_interval
= 2000
tenant_router_types
= shared, distributed,
exclusive
user
= admin
vdn_scope_id
= None
Description
(StrOpt) DVS ID for VLANs
(StrOpt) Network ID for physical network connectivity
(StrOpt) uri for vsm
(IntOpt) Maximum number of sub interfaces supported per vnic in edge. The value should be in
1-110.
(StrOpt) Shared secret to sign metadata requests
(StrOpt) Management network default gateway for metadata proxy
(StrOpt) Network ID for management network connectivity
(ListOpt) Management network IP address for metadata proxy
(StrOpt) Management network netmask for metadata proxy
(ListOpt) IP addresses used by Nova metadata service
(IntOpt) TCP Port used by Nova metadata server
(StrOpt) Password for vsm
(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges
(IntOpt) Maximum number of API retries on endpoint.
(BoolOpt) If True then plugin will use NSXV spoofguard component for port-security feature.
(IntOpt) Task status check interval
(ListOpt) Ordered list of router_types to allocate as tenant routers.
(StrOpt) User name for vsm
(StrOpt) Network scope ID for VXLAN virtual wires
655
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
9.1.2. Configure the Oslo RPC messaging system
OpenStack projects use an open standard for messaging middleware known as AMQP. This messaging middleware enables the OpenStack services that run on multiple servers to talk to each other. OpenStack Oslo RPC supports two implementations of AMQP: RabbitMQ and Qpid.
9.1.2.1. Configure RabbitMQ
OpenStack Oslo RPC uses RabbitMQ by default. Use these options to configure the RabbitMQ message system. The rpc_backend option is optional as long as RabbitMQ is the default messaging system. However, if it is included the configuration, you must set it to
neutron.openstack.common.rpc.impl_kombu.
rpc_backend=neutron.openstack.common.rpc.impl_kombu
Use these options to configure the RabbitMQ messaging system. You can configure messaging communication for different installation scenarios, tune retries for RabbitMQ, and define the size of the RPC thread pool. To monitor notifications through RabbitMQ, you must set the
notification_driver option to neutron.openstack.common.notifier.rpc_notifier in the neutron.conf file:
Table 9.39. Description of RabbitMQ configuration options
Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
amqp_durable_queues
= False
fake_rabbit
= False
Description heartbeat_rate
= 2
heartbeat_timeout_threshold
= 0
kombu_reconnect_delay
= 1.0
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
656
Configuration option = Default value kombu_ssl_ca_certs
=
kombu_ssl_certfile
=
kombu_ssl_keyfile
=
kombu_ssl_version
=
rabbit_ha_queues
= False
rabbit_host
= localhost
rabbit_hosts
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_password
= guest
rabbit_port
= 5672
rabbit_retry_backoff
= 2
rabbit_retry_interval
= 1
rabbit_use_ssl
= False
rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
9.1.2.2. Configure Qpid
CHAPTER 9. NETWORKING
Description
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
657
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Use these options to configure the Qpid messaging system for OpenStack Oslo RPC. Qpid is not the default messaging system, so you must enable it by setting the rpc_backend option in the
neutron.conf file: rpc_backend=neutron.openstack.common.rpc.impl_qpid
This critical option points the compute nodes to the Qpid broker (server). Set the qpid_hostname option to the host name where the broker runs in the neutron.conf file.
Note
The --qpid_hostname parameter accepts a host name or IP address value.
qpid_hostname=hostname.example.com
If the Qpid broker listens on a port other than the AMQP default of 5672, you must set the
qpid_port option to that value: qpid_port=12345
If you configure the Qpid broker to require authentication, you must add a user name and password to the configuration: qpid_username=username qpid_password=password
By default, TCP is used as the transport. To enable SSL, set the qpid_protocol option: qpid_protocol=ssl
Use these additional options to configure the Qpid messaging driver for OpenStack Oslo RPC.
These options are used infrequently.
Table 9.40. Description of Qpid configuration options
Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
Description
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
658
CHAPTER 9. NETWORKING
Configuration option = Default value qpid_hostname
= localhost
qpid_hosts
= $qpid_hostname:$qpid_port
qpid_password
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity
= 1
qpid_sasl_mechanisms
=
qpid_tcp_nodelay
= True
qpid_topology_version
= 1
Description
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
qpid_username
=
rpc_conn_pool_size
= 30
9.1.2.3. Configure messaging
Use these common options to configure the RabbitMQ, and Qpid messaging drivers:
Table 9.41. Description of RPC configuration options
Configuration option = Default value
[DEFAULT] matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
Description
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
659
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rpc_cast_timeout
= 30
rpc_response_timeout
= 60
rpc_thread_pool_size
= 64
rpc_workers
= 0
Description
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
(IntOpt) Size of RPC thread pool.
(IntOpt) Number of RPC worker processes for service
[AGENT] rpc_support_old_agents
= False (BoolOpt) Enable server RPC compatibility with old agents
[oslo_concurrency] disable_process_locking
= False
lock_path
= None
(BoolOpt) Enables or disables inter-process locks.
(StrOpt) 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 external locks are used, a lock path must be set.
[oslo_messaging_amqp] allow_insecure_clients
= False
broadcast_prefix container_name idle_timeout ssl_ca_file
=
= broadcast
= None
group_request_prefix
= 0
= unicast
server_request_prefix
= exclusive
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
660
Configuration option = Default value ssl_cert_file
=
ssl_key_file
=
ssl_key_password
= None
CHAPTER 9. NETWORKING
Description
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
trace
= False
Table 9.42. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
Table 9.43. Description of AMQP configuration options
Description Configuration option = Default value
[DEFAULT] control_exchange
= neutron
notification_driver notification_topics
= []
= notifications
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
(MultiStrOpt) Driver or drivers to handle sending notifications.
(ListOpt) AMQP topic used for OpenStack notifications.
661
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value transport_url
= None
Description
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
9.1.3. Agent
Use the following options to alter agent-related settings.
Table 9.44. Description of agent configuration options
Configuration option = Default value
[DEFAULT] external_pids
= $state_path/external/pids
network_device_mtu
= None
Configuration option = Default value
[DEFAULT] allow_bulk
= True
allow_pagination
= False
allow_sorting
= False
api_extensions_path
=
api_paste_config
= api-paste.ini
backlog
= 4096
Description
(StrOpt) Location to store child pid files
(IntOpt) MTU setting for device.
9.1.4. API
Use the following options to alter API-related settings.
Table 9.45. Description of API configuration options
Description
(BoolOpt) Allow the usage of the bulk API
(BoolOpt) Allow the usage of the pagination
(BoolOpt) Allow the usage of the sorting
(StrOpt) The path for API extensions
(StrOpt) The API paste config file to use
(IntOpt) Number of backlog requests to configure the socket with
662
CHAPTER 9. NETWORKING
Configuration option = Default value client_socket_timeout
= 900
max_header_line pagination_max_limit retry_until_window service_plugins tcp_keepidle
=
= 600
wsgi_keep_alive
= 16384
= True
= -1
= 30
run_external_periodic_tasks
= True
Description
(IntOpt) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.
(IntOpt) Max header line to accommodate large tokens
(StrOpt) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit
(IntOpt) Number of seconds to keep retrying to listen
(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?
(ListOpt) The service plugins Neutron will use
(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on
OS X.
(BoolOpt) Determines if connections are allowed to be held open by clients after a request is fulfilled. A value of False will ensure that the socket connection will be explicitly closed once a response has been sent to the client.
[service_providers] service_provider
= [] (MultiStrOpt) Defines providers for advanced services using the format: <service_type>:<name>:
<driver>[:default]
9.1.5. Token authentication
Use the following options to alter token authentication settings.
Table 9.46. Description of authorization token configuration options
Configuration option = Default value
[keystone_authtoken] admin_password
= None
Description
(StrOpt) Service user password.
663
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value admin_tenant_name
= admin
admin_token
= None
admin_user auth_port auth_protocol auth_section cache
= None
cafile
= None
certfile
= None
auth_admin_prefix auth_host auth_plugin auth_uri
= 127.0.0.1
= None
= 35357
= None
auth_version
= None
=
= https
= None
= None
check_revocations_for_cached
= False
Description
(StrOpt) Service tenant name.
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
664
CHAPTER 9. NETWORKING
Configuration option = Default value delay_auth_decision
= False
enforce_token_bind hash_algorithms http_connect_timeout http_request_max_retries identity_uri insecure keyfile
= False
= None
= md5
= None
= permissive
= None
include_service_catalog
= 3
= True
memcache_pool_conn_get_timeout
= 10
Description
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times are we trying to reconnect when communicating with Identity API
Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
665
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value memcache_pool_dead_retry
= 300
memcache_pool_maxsize memcache_pool_socket_timeout memcache_pool_unused_timeout memcache_secret_key memcache_security_strategy memcache_use_advanced_pool revocation_cache_time signing_dir
= None
token_cache_time
= None
= 300
= 10
= 10
= 3
= 60
= None
= False
Description
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
666
9.1.6. Compute
Use the following options to alter Compute-related settings.
CHAPTER 9. NETWORKING
Table 9.47. Description of Compute configuration options
Configuration option = Default value
[DEFAULT]
Description notify_nova_on_port_data_changes
True
=
notify_nova_on_port_status_changes
= True
(BoolOpt) Send notification to nova when port status changes
nova_admin_auth_url
=
http://localhost:5000/v2.0
(BoolOpt) Send notification to nova when port data
(fixed_ips/floatingip) changes so nova can update its cache.
nova_admin_password nova_admin_username nova_client_cert
=
= None
nova_admin_tenant_id nova_admin_tenant_name
= None
nova_client_priv_key nova_url
= None
=
= http://127.0.0.1:8774/v2
send_events_interval
= None
= 2
(StrOpt) Authorization URL for connecting to nova in admin context. Deprecated in favour of an auth plugin in [nova].
(StrOpt) Password for connection to nova in admin context. Deprecated in favour of an auth plugin in
[nova].
(StrOpt) The uuid of the admin nova tenant.
Deprecated in favour of an auth plugin in [nova].
(StrOpt) The name of the admin nova tenant.
Deprecated in favour of an auth plugin in [nova].
(StrOpt) Username for connecting to nova in admin context. Deprecated in favour of an auth plugin in
[nova].
(StrOpt) Client certificate for nova metadata api server.
(StrOpt) Private key of client certificate.
(StrOpt) URL for connection to nova. Deprecated in favour of an auth plugin in [nova].
(IntOpt) Number of seconds between sending events to nova if there are any events to send.
9.1.7. Database
Use the following options to alter Database-related settings.
Table 9.48. Description of database configuration options
667
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[database] backend
= sqlalchemy
connection
= None
connection_debug
= 0
connection_trace db_inc_retry_interval db_max_retries db_max_retry_interval db_retry_interval idle_timeout max_overflow
= False
= 20
= 3600
= None
max_pool_size max_retries
= None
= 10
min_pool_size
= 1
mysql_sql_mode
= 1
= True
= 10
= TRADITIONAL
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
668
Configuration option = Default value pool_timeout
= None
retry_interval
= 10
slave_connection
= None
sqlite_db
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
CHAPTER 9. NETWORKING
Description
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
9.1.8. Logging
Use the following options to alter debug settings.
Table 9.49. Description of logging configuration options
Configuration option = Default value
[DEFAULT] backdoor_port
= None
Description
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
9.1.9. DHCP agent
Use the following options to alter Database-related settings.
Table 9.50. Description of DHCP agent configuration options
669
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] advertise_mtu
= False
dnsmasq_config_file dnsmasq_dns_servers dnsmasq_lease_max enable_metadata_network num_sync_threads resync_interval use_namespaces
=
= None
= 16777216
enable_isolated_metadata
= 4
= 5
= True
= False
= False
(BoolOpt) If True, effort is made to advertise MTU settings to VMs via network methods (DHCP and
RA MTU options) when the network's preferred
MTU is known.
(StrOpt) Override the default dnsmasq settings with this file
(ListOpt) Comma-separated list of the DNS servers which will be used as forwarders.
(IntOpt) Limit number of leases to prevent a denialof-service.
(BoolOpt) Support Metadata requests on isolated networks.
(BoolOpt) Allows for serving metadata requests from a dedicated network. Requires enable_isolated_metadata = True
(IntOpt) Number of threads to use during sync process.
(IntOpt) Interval to resync.
(BoolOpt) Allow overlapping IP. This option is deprecated and will be removed in a future release.
670
9.1.10. Distributed virtual router
Use the following options to alter DVR-related settings.
Table 9.51. Description of DVR configuration options
Description Configuration option = Default value
[DEFAULT] dvr_base_mac
= fa:16:3f:00:00:00
router_distributed
= False
(StrOpt) The base mac address used for unique
DVR instances by Neutron
(BoolOpt) System-wide flag to determine the type of router that tenants can create. Only admin can override.
CHAPTER 9. NETWORKING
Configuration option = Default value Description
9.1.11. Firewall-as-a-Service driver
Use the following options in the fwaas_driver.ini file for the FWaaS driver.
Table 9.52. Description of FwaaS configuration options
Configuration option = Default value
[fwaas] enabled
= False
Description
(BoolOpt) Enable FWaaS
9.1.12. IPv6 router advertisement
Use the following options to alter IPv6 RA settings.
Table 9.53. Description of IPv6 router advertisement configuration options
Configuration option = Default value
[DEFAULT] ra_confs
= $state_path/ra
Description
(StrOpt) Location to store IPv6 RA config files
9.1.13. L3 agent
Use the following options in the l3_agent.ini file for the L3 agent.
Table 9.54. Description of L3 agent configuration options
Configuration option = Default value
[DEFAULT]
Description
671
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value agent_mode
= legacy
Description
(StrOpt) The working mode for the agent. Allowed modes are: 'legacy' - this preserves the existing behavior where the L3 agent is deployed on a centralized networking node to provide L3 services like DNAT, and SNAT. Use this mode if you do not want to adopt DVR. 'dvr' - this mode enables DVR functionality and must be used for an L3 agent that runs on a compute host. 'dvr_snat' - this enables centralized SNAT support in conjunction with DVR.
This mode must be used for an L3 agent running on a centralized node (or in single-host deployments, e.g. devstack)
allow_automatic_dhcp_failover
= True (BoolOpt) Automatically remove networks from offline DHCP agents.
allow_automatic_l3agent_failover
=
False
enable_metadata_proxy
= True
external_ingress_mark
= 0x2
external_network_bridge
= br-ex
gateway_external_network_id ha_confs_path
= $state_path/ha_confs
ha_vrrp_advert_int
= 2
ha_vrrp_auth_password
= None
ha_vrrp_auth_type
= PASS
=
handle_internal_only_routers
= True
(BoolOpt) Automatically reschedule routers from offline L3 agents to online L3 agents.
(BoolOpt) Allow running metadata proxy.
(StrOpt) Iptables mangle mark used to mark ingress from external network
(StrOpt) Name of bridge used for external network traffic.
(StrOpt) UUID of external network for routers implemented by the agents.
(StrOpt) Location to store keepalived/conntrackd config files
(IntOpt) The advertisement interval in seconds
(StrOpt) VRRP authentication password
(StrOpt) VRRP authentication type
(BoolOpt) Agent should implement routers with no gateway
672
Configuration option = Default value ipv6_gateway
=
l3_ha
= False
l3_ha_net_cidr
= 169.254.192.0/18
max_l3_agents_per_router
= 3
min_l3_agents_per_router
= 2
router_id
=
send_arp_for_ha
= 3
CHAPTER 9. NETWORKING
Description
(StrOpt) With IPv6, the network used for the external gateway does not need to have an associated subnet, since the automatically assigned link-local address (LLA) can be used.
However, an IPv6 gateway address is needed for use as the next-hop for the default route. If no IPv6 gateway address is configured here, (and only then) the neutron router will be configured to get its default route from router advertisements (RAs) from the upstream router; in which case the upstream router must also be configured to send these RAs. The ipv6_gateway, when configured, should be the LLA of the interface on the upstream router. If a next-hop using a global unique address
(GUA) is desired, it needs to be done via a subnet allocated to the network and not through this parameter.
(BoolOpt) Enable HA mode for virtual routers.
(StrOpt) Subnet used for the l3 HA admin network.
(IntOpt) Maximum number of agents on which a router will be scheduled.
(IntOpt) Minimum number of agents on which a router will be scheduled.
(StrOpt) If namespaces is disabled, the l3 agent can only configure a router that has the matching router ID.
(IntOpt) Send this many gratuitous ARPs for HA setup, if less than or equal to 0, the feature is disabled
[AGENT] comment_iptables_rules
= True
use_helper_for_ns_read
= True
(BoolOpt) Add comments to iptables rules.
(BoolOpt) Use the root helper to read the namespaces from the operating system.
9.1.14. Logging
Use the following options to alter logging settings.
Table 9.55. Description of logging configuration options
673
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value
[DEFAULT]
Description debug
= False
default_log_levels
= 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
(ListOpt) List of logger=LEVEL pairs.
fatal_deprecations
= False
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
instance_format
= "[instance: %(uuid)s] "
instance_uuid_format
(uuid)s] "
log_config_append
= "[instance: %
= None
(BoolOpt) Enables or disables fatal status of deprecations.
(StrOpt) The format for an instance that is passed with the log message.
(StrOpt) The format for an instance UUID that is passed with the log message.
(StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None
log_file
= None
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
674
CHAPTER 9. NETWORKING
Configuration option = Default value log_config_append
= None
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None
log_file
= None
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format
= None
Description
(StrOpt) 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.
logging_context_format_string
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
= %
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
(StrOpt) Prefix each line of exception output with this format.
syslog_log_facility syslog_log_facility use_syslog
= False
= LOG_USER
= LOG_USER
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
675
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value use_syslog_rfc_format
= False
use_ssl
= False
use_stderr use_syslog
= True
= False
use_syslog_rfc_format verbose
= False
= False
Description
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Enable SSL on the API server
(BoolOpt) Log output to standard error.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
9.1.15. Metadata Agent
Use the following options in the metadata_agent.ini file for the Metadata agent.
Table 9.56. Description of metadata configuration options
Configuration option = Default value
[DEFAULT] meta_flavor_driver_mappings
= None
metadata_access_mark metadata_backlog metadata_port
= 9697
= 0x1
= 4096
Description
(StrOpt) Mapping between flavor and
LinuxInterfaceDriver. It is specific to
MetaInterfaceDriver used with admin_user, admin_password, admin_tenant_name, admin_url, auth_strategy, auth_region and endpoint_type.
(StrOpt) Iptables mangle mark used to mark metadata valid requests
(IntOpt) Number of backlog requests to configure the metadata server socket with
(IntOpt) TCP Port used by Neutron metadata namespace proxy.
676
CHAPTER 9. NETWORKING
Configuration option = Default value metadata_proxy_group
=
metadata_proxy_shared_secret
=
metadata_proxy_socket
=
$state_path/metadata_proxy
metadata_proxy_socket_mode
= deduce
metadata_proxy_user
=
metadata_proxy_watch_log metadata_workers nova_metadata_insecure nova_metadata_ip
= 2
= False
= 127.0.0.1
nova_metadata_port
= 8775
= None
nova_metadata_protocol
= http
Description
(StrOpt) Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group).
(StrOpt) Shared secret to sign instance-id request
(StrOpt) Location for Metadata Proxy UNIX domain socket.
(StrOpt) Metadata Proxy UNIX domain socket mode, 3 values allowed: 'deduce': deduce mode from metadata_proxy_user/group values, 'user': set metadata proxy socket mode to 0o644, to use when metadata_proxy_user is agent effective user or root, 'group': set metadata proxy socket mode to
0o664, to use when metadata_proxy_group is agent effective group or root, 'all': set metadata proxy socket mode to 0o666, to use otherwise.
(StrOpt) User (uid or name) running metadata proxy after its initialization (if empty: agent effective user).
(BoolOpt) Enable/Disable log watch by metadata proxy. It should be disabled when metadata_proxy_user/group is not allowed to read/write its log file and copytruncate logrotate option must be used if logrotate is enabled on metadata proxy log files. Option default value is deduced from metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent effective user id/name.
(IntOpt) Number of separate worker processes for metadata server
(BoolOpt) Allow to perform insecure SSL (https) requests to nova metadata
(StrOpt) IP address used by Nova metadata server.
(IntOpt) TCP Port used by Nova metadata server.
(StrOpt) Protocol to access nova metadata, http or https
677
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Note
Previously, neutron metadata agent connected to a neutron server via REST API using a neutron client. This is ineffective because keystone is then fully involved into the authentication process and gets overloaded.
The neutron metadata agent has been reworked to use RPC by default to connect to a server since Kilo release. This is a typical way of interacting between neutron server and its agents. If neutron server does not support metadata RPC then neutron client will be used.
Warning
Do not run the neutron-ns-metadata-proxy proxy namespace as root on a node with the L3 agent running. In OpenStack Kilo and newer, you can change the permissions of neutron-ns-metadata-proxy after the proxy installation using the
metadata_proxy_user and metadata_proxy_group options.
9.1.16. Metering Agent
Use the following options in the metering_agent.ini file for the Metering agent.
Table 9.57. Description of metering agent configuration options
Configuration option = Default value Description
[DEFAULT] driver
=
neutron.services.metering.drivers.noop.noop_drive
r.NoopMeteringDriver
(StrOpt) Metering driver
(IntOpt) Interval between two metering measures
measure_interval
= 30
[AGENT] report_interval
= 30 (FloatOpt) Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time.
9.1.17. Nova
Use the following options in the neutron.conf file to change nova-related settings.
678
Table 9.58. Description of nova configuration options
CHAPTER 9. NETWORKING
Configuration option = Default value
[nova] auth_plugin
= None
auth_section
= None
cafile
= None
certfile
= None
insecure
= False
keyfile
= None
region_name
= None
Description
(StrOpt) Name of the plugin to load
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
(StrOpt) PEM encoded client certificate cert file
(BoolOpt) Verify HTTPS connections.
(StrOpt) PEM encoded client certificate key file
(StrOpt) Name of nova region to use. Useful if keystone manages more than one region.
(IntOpt) Timeout value for http requests
timeout
= None
9.1.18. Policy
Use the following options in the neutron.conf file to change oslo middleware settings.
Table 9.59. Description of oslo_middleware configuration options
Configuration option = Default value
[oslo_middleware] max_request_body_size
= 114688
Description
(IntOpt) The maximum body size for each request, in bytes.
9.1.19. Policy
Use the following options in the neutron.conf file to change policy settings.
Table 9.60. Description of policy configuration options
Configuration option = Default value
[DEFAULT]
Description
679
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value allow_overlapping_ips
= False
policy_default_rule
= default
policy_dirs
= ['policy.d']
Description
(BoolOpt) Allow overlapping IP support in Neutron
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
policy_file
= policy.json
9.1.20. Quotas
Use the following options in the neutron.conf file for the quota system.
Table 9.61. Description of quotas configuration options
Description Configuration option = Default value
[DEFAULT] max_routes
= 30
[QUOTAS] default_quota
= -1
quota_driver
=
neutron.db.quota_db.DbQuotaDriver
quota_floatingip
= 50
quota_health_monitor
= -1
quota_items
= network, subnet, port
quota_member
= -1
(IntOpt) Maximum number of routes
(IntOpt) Default number of resource allowed per tenant. A negative value means unlimited.
(StrOpt) Default driver to use for quota checks
(IntOpt) Number of floating IPs allowed per tenant.
A negative value means unlimited.
(IntOpt) Number of health monitors allowed per tenant. A negative value means unlimited.
(ListOpt) Resource name(s) that are supported in quota features
(IntOpt) Number of pool members allowed per tenant. A negative value means unlimited.
680
Configuration option = Default value quota_network
= 10
quota_network_gateway
= 5
quota_packet_filter
= 100
quota_pool
= 10
quota_port
= 50
quota_router
= 10
quota_security_group
= 10
quota_security_group_rule
= 100
quota_subnet
= 10
quota_vip
= 10
CHAPTER 9. NETWORKING
Description
(IntOpt) Number of networks allowed per tenant. A negative value means unlimited.
(IntOpt) Number of network gateways allowed per tenant, -1 for unlimited
(IntOpt) Number of packet_filters allowed per tenant, -1 for unlimited
(IntOpt) Number of pools allowed per tenant. A negative value means unlimited.
(IntOpt) Number of ports allowed per tenant. A negative value means unlimited.
(IntOpt) Number of routers allowed per tenant. A negative value means unlimited.
(IntOpt) Number of security groups allowed per tenant. A negative value means unlimited.
(IntOpt) Number of security rules allowed per tenant. A negative value means unlimited.
(IntOpt) Number of subnets allowed per tenant, A negative value means unlimited.
(IntOpt) Number of vips allowed per tenant. A negative value means unlimited.
9.1.21. Scheduler
Use the following options in the neutron.conf file to change scheduler settings.
Table 9.62. Description of scheduler configuration options
Configuration option = Default value
[DEFAULT] network_auto_schedule
= True
Description network_scheduler_driver
=
neutron.scheduler.dhcp_agent_scheduler.Chance
Scheduler
(BoolOpt) Allow auto scheduling networks to DHCP agent.
(StrOpt) Driver to use for scheduling network to
DHCP agent
681
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value router_auto_schedule
= True
router_delete_namespaces
= False
Description
(BoolOpt) Allow auto scheduling of routers to L3 agent.
(BoolOpt) Delete namespace after removing a router.
router_scheduler_driver
=
neutron.scheduler.l3_agent_scheduler.ChanceSch
eduler
(StrOpt) Driver to use for scheduling router to a default L3 agent
9.1.22. Security Groups
Use the following options in the configuration file for your driver to change security group settings.
Table 9.63. Description of security groups configuration options
Configuration option = Default value
[SECURITYGROUP]
Description defer_apply
= True
enable_ipset
= True
enable_security_group firewall_driver
= None
= True
(BoolOpt) Enable defer_apply on security bridge.
(BoolOpt) Use ipset to speed-up the iptables based security groups.
(BoolOpt) Controls whether the neutron security group API is enabled in the server. It should be false when using no security groups or using the nova security group API.
(StrOpt) Driver for security groups firewall in the L2 agent
ovsvapp_firewall_driver
=
networking_vsphere.drivers.ovs_firewall.OVSFirew
allDriver
(StrOpt) DriverManager implementation for OVS based Firewall.
security_bridge_mapping
= br-sec (StrOpt) <security_bridge>:<phy_interface>
682
CHAPTER 9. NETWORKING
Note
Now Networking uses iptables to achieve security group functions. In L2 agent with
enable_ipset option enabled, it makes use of IPset to improve security group's performance, as it represents a hash set which is insensitive to the number of elements.
When a port is created, L2 agent will add an additional IPset chain to it's iptables chain, if the security group that this port belongs to has rules between other security group, the member of that security group will be added to the ipset chain.
If a member of a security group is changed, it used to reload iptables rules which is expensive. However, when IPset option is enabled on L2 agent, it does not need to reload iptables if only members of security group were changed, it should just update an IPset.
Note
A single default security group has been introduced in order to avoid race conditions when creating a tenant's default security group. The race conditions are caused by the uniqueness check of a new security group name. A table default_security_group implements such a group. It has tenant_id field as a primary key and
security_group_id, which is an identifier of a default security group. The migration that introduces this table has a sanity check that verifies if a default security group is not duplicated in any tenant.
9.1.23. SSL and Certification Authority
Use the following options in the neutron.conf file to enable SSL.
Table 9.64. Description of CA and SSL configuration options
Description Configuration option = Default value
[DEFAULT] ssl_ca_file
= None
ssl_cert_file
= None
ssl_key_file
= None
(StrOpt) CA certificate file to use to verify connecting clients
(StrOpt) Certificate file to use when starting the server securely
(StrOpt) Private key file to use when starting the server securely
9.2. LOG FILES USED BY NETWORKING
683
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The corresponding log file of each Networking service is stored in the /var/log/neutron/ directory of the host on which each service runs.
Table 9.65. Log files used by Networking services
Log file
dhcp-agent.log
l3-agent.log
lbaas-agent.log
linuxbridge-agent.log
metadata-agent.log
metering-agent.log
openvswitch-agent.log
server.log
Service/interface
neutron-dhcp-agent neutron-l3-agent neutron-lbaas-agent
neutron-linuxbridge-agent neutron-metadata-agent neutron-metering-agent neutron-openvswitch-agent neutron-server
The
neutron-lbaas-agent
service only runs when Load-Balancer-as-a-Service is enabled.
9.3. NETWORKING SAMPLE CONFIGURATION FILES
All the files in this section can be found in /etc/neutron/.
9.3.1. neutron.conf
684
Use the neutron.conf file to configure the majority of the OpenStack Networking options.
[DEFAULT]
# Print more verbose output (set logging level to INFO instead of default
WARNING level).
# verbose = False
# =========Start Global Config Option for Distributed L3
Router===============
# Setting the "router_distributed" flag to "True" will default to the creation
# of distributed tenant routers. The admin can override this flag by specifying
# the type of the router on the create request (admin-only attribute).
Default
# value is "False" to support legacy mode (centralized) routers.
#
CHAPTER 9. NETWORKING
# router_distributed = False
#
# ===========End Global Config Option for Distributed L3
Router===============
# Print debugging output (set logging level to DEBUG instead of default
WARNING level).
# debug = False
# Where to store Neutron state files. This directory must be writable by the
# user executing the agent.
# state_path = /var/lib/neutron
# log_format = %(asctime)s %(levelname)8s [%(name)s] %(message)s
# log_date_format = %Y-%m-%d %H:%M:%S
# use_syslog -> syslog
# log_file and log_dir -> log_dir/log_file
# (not log_file) and log_dir -> log_dir/{binary_name}.log
# use_stderr -> stderr
# (not user_stderr) and (not log_file) -> stdout
# publish_errors -> notification system
# use_syslog = False
# syslog_log_facility = LOG_USER
# use_stderr = True
# log_file =
# log_dir =
# publish_errors = False
# Address to bind the API server to
# bind_host = 0.0.0.0
# Port the bind the API server to
# bind_port = 9696
# Path to the extensions. Note that this can be a colon-separated list of
# paths. For example:
# api_extensions_path = extensions:/path/to/more/extensions:/even/more/extensions
# The __path__ of neutron.extensions is appended to this, so if your
# extensions are in there you don't need to specify them here
# api_extensions_path =
# (StrOpt) Neutron core plugin entrypoint to be loaded from the
# neutron.core_plugins namespace. See setup.cfg for the entrypoint names of the
# plugins included in the neutron source distribution. For compatibility with
# previous versions, the class name of a plugin can be specified instead of its
# entrypoint name.
685
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#
# core_plugin =
# Example: core_plugin = ml2
# (ListOpt) List of service plugin entrypoints to be loaded from the
# neutron.service_plugins namespace. See setup.cfg for the entrypoint names of
# the plugins included in the neutron source distribution. For compatibility
# with previous versions, the class name of a plugin can be specified instead
# of its entrypoint name.
#
# service_plugins =
# Example: service_plugins = router,firewall,lbaas,vpnaas,metering
# Paste configuration file
# api_paste_config = api-paste.ini
# (StrOpt) Hostname to be used by the neutron server, agents and services
# running on this machine. All the agents and services running on this machine
# must use the same host value.
# The default value is hostname of the machine.
#
# host =
# The strategy to be used for auth.
# Supported values are 'keystone'(default), 'noauth'.
# auth_strategy = keystone
# Base MAC address. The first 3 octets will remain unchanged. If the
# 4h octet is not 00, it will also be used. The others will be
# randomly generated.
# 3 octet
# base_mac = fa:16:3e:00:00:00
# 4 octet
# base_mac = fa:16:3e:4f:00:00
# DVR Base MAC address. The first 3 octets will remain unchanged. If the
# 4th octet is not 00, it will also be used. The others will be randomly
# generated. The 'dvr_base_mac' *must* be different from 'base_mac' to
# avoid mixing them up with MAC's allocated for tenant ports.
# A 4 octet example would be dvr_base_mac = fa:16:3f:4f:00:00
# The default is 3 octet
# dvr_base_mac = fa:16:3f:00:00:00
# Maximum amount of retries to generate a unique MAC address
# mac_generation_retries = 16
# DHCP Lease duration (in seconds). Use -1 to
# tell dnsmasq to use infinite lease times.
# dhcp_lease_duration = 86400
# Allow sending resource operation notification to DHCP agent
# dhcp_agent_notification = True
686
CHAPTER 9. NETWORKING
# Enable or disable bulk create/update/delete operations
# allow_bulk = True
# Enable or disable pagination
# allow_pagination = False
# Enable or disable sorting
# allow_sorting = False
# Enable or disable overlapping IPs for subnets
# Attention: the following parameter MUST be set to False if Neutron is
# being used in conjunction with nova security groups
# allow_overlapping_ips = False
# Ensure that configured gateway is on subnet. For IPv6, validate only if
# gateway is not a link local address. Deprecated, to be removed during the
# K release, at which point the check will be mandatory.
# force_gateway_on_subnet = True
# Default maximum number of items returned in a single response,
# value == infinite and value < 0 means no max limit, and value must
# be greater than 0. If the number of items requested is greater than
# pagination_max_limit, server will just return pagination_max_limit
# of number of items.
# pagination_max_limit = -1
# Maximum number of DNS nameservers per subnet
# max_dns_nameservers = 5
# Maximum number of host routes per subnet
# max_subnet_host_routes = 20
# Maximum number of fixed ips per port
# max_fixed_ips_per_port = 5
# Maximum number of routes per router
# max_routes = 30
# Default Subnet Pool to be used for IPv4 subnet-allocation.
# Specifies by UUID the pool to be used in case of subnet-create being called
# without a subnet-pool ID. The default of None means that no pool will be
# used unless passed explicitly to subnet create. If no pool is used, then a
# CIDR must be passed to create a subnet and that subnet will not be allocated
# from any pool; it will be considered part of the tenant's private address
# space.
# default_ipv4_subnet_pool =
# Default Subnet Pool to be used for IPv6 subnet-allocation.
# Specifies by UUID the pool to be used in case of subnet-create being
# called without a subnet-pool ID. Set to "prefix_delegation"
# to enable IPv6 Prefix Delegation in a PD-capable environment.
# See the description for default_ipv4_subnet_pool for more information.
# default_ipv6_subnet_pool =
687
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# =========== items for MTU selection and advertisement =============
# Advertise MTU. If True, effort is made to advertise MTU
# settings to VMs via network methods (ie. DHCP and RA MTU options)
# when the network's preferred MTU is known.
# advertise_mtu = False
# ======== end of items for MTU selection and advertisement =========
# =========== items for agent management extension =============
# Seconds to regard the agent as down; should be at least twice
# report_interval, to be sure the agent is down for good
# agent_down_time = 75
# =========== end of items for agent management extension =====
# =========== items for agent scheduler extension =============
# Driver to use for scheduling network to DHCP agent
# network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.ChanceScheduler
# Driver to use for scheduling router to a default L3 agent
# router_scheduler_driver = neutron.scheduler.l3_agent_scheduler.ChanceScheduler
# Driver to use for scheduling a loadbalancer pool to an lbaas agent
# loadbalancer_pool_scheduler_driver = neutron.services.loadbalancer.agent_scheduler.ChanceScheduler
# (StrOpt) Representing the resource type whose load is being reported by
# the agent.
# This can be 'networks','subnets' or 'ports'. When specified (Default is networks),
# the server will extract particular load sent as part of its agent configuration object
# from the agent report state, which is the number of resources being consumed, at
# every report_interval.
# dhcp_load_type can be used in combination with network_scheduler_driver
=
# neutron.scheduler.dhcp_agent_scheduler.WeightScheduler
# When the network_scheduler_driver is WeightScheduler, dhcp_load_type can
# be configured to represent the choice for the resource being balanced.
# Example: dhcp_load_type = networks
# Values:
# networks - number of networks hosted on the agent
# subnets - number of subnets associated with the networks hosted on the agent
# ports - number of ports associated with the networks hosted on the agent
# dhcp_load_type = networks
# Allow auto scheduling networks to DHCP agent. It will schedule nonhosted
# networks to first DHCP agent which sends get_active_networks message to
# neutron server
# network_auto_schedule = True
# Allow auto scheduling routers to L3 agent. It will schedule non-hosted
688
CHAPTER 9. NETWORKING
# routers to first L3 agent which sends sync_routers message to neutron server
# router_auto_schedule = True
# Allow automatic rescheduling of routers from dead L3 agents with
# admin_state_up set to True to alive agents.
# allow_automatic_l3agent_failover = False
# Allow automatic removal of networks from dead DHCP agents with
# admin_state_up set to True.
# Networks could then be rescheduled if network_auto_schedule is True
# allow_automatic_dhcp_failover = True
# Number of DHCP agents scheduled to host a network. This enables redundant
# DHCP agents for configured networks.
# dhcp_agents_per_network = 1
# Enable services on agents with admin_state_up False.
# If this option is False, when admin_state_up of an agent is turned to
# False, services on it will be disabled. If this option is True, services
# on agents with admin_state_up False keep available and manual scheduling
# to such agents is available. Agents with admin_state_up False are not
# selected for automatic scheduling regardless of this option.
# enable_services_on_agents_with_admin_state_down = False
# =========== end of items for agent scheduler extension =====
# =========== items for l3 extension ==============
# Enable high availability for virtual routers.
# l3_ha = False
#
# Maximum number of l3 agents which a HA router will be scheduled on. If it
# is set to 0 the router will be scheduled on every agent.
# max_l3_agents_per_router = 3
#
# Minimum number of l3 agents which a HA router will be scheduled on. The
# default value is 2.
# min_l3_agents_per_router = 2
#
# CIDR of the administrative network if HA mode is enabled
# l3_ha_net_cidr = 169.254.192.0/18
# =========== end of items for l3 extension =======
# =========== items for metadata proxy configuration ==============
# User (uid or name) running metadata proxy after its initialization
# (if empty: agent effective user)
# metadata_proxy_user =
# Group (gid or name) running metadata proxy after its initialization
# (if empty: agent effective group)
# metadata_proxy_group =
689
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Enable/Disable log watch by metadata proxy, it should be disabled when
# metadata_proxy_user/group is not allowed to read/write its log file and
# 'copytruncate' logrotate option must be used if logrotate is enabled on
# metadata proxy log files. Option default value is deduced from
# metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent
# effective user id/name.
# metadata_proxy_watch_log =
# Location of Metadata Proxy UNIX domain socket
# metadata_proxy_socket = $state_path/metadata_proxy
# =========== end of items for metadata proxy configuration
==============
# ========== items for VLAN trunking networks ==========
# Setting this flag to True will allow plugins that support it to
# create VLAN transparent networks. This flag has no effect for
# plugins that do not support VLAN transparent networks.
# vlan_transparent = False
# ========== end of items for VLAN trunking networks ==========
# =========== WSGI parameters related to the API server ==============
# Number of separate worker processes to spawn. The default, 0, runs the
# worker thread in the current process. Greater than 0 launches that number of
# child processes as workers. The parent process manages them.
# api_workers = 0
# Number of separate RPC worker processes to spawn. The default, 0, runs the
# worker thread in the current process. Greater than 0 launches that number of
# child processes as RPC workers. The parent process manages them.
# This feature is experimental until issues are addressed and testing has been
# enabled for various plugins for compatibility.
# rpc_workers = 0
# Timeout for client connections socket operations. If an
# incoming connection is idle for this number of seconds it
# will be closed. A value of '0' means wait forever. (integer
# value)
# client_socket_timeout = 900
# wsgi keepalive option. Determines if connections are allowed to be held open
# by clients after a request is fulfilled. A value of False will ensure that
# the socket connection will be explicitly closed once a response has been
# sent to the client.
# wsgi_keep_alive = True
# Sets the value of TCP_KEEPIDLE in seconds to use for each server socket when
# starting API server. Not supported on OS X.
690
CHAPTER 9. NETWORKING
# tcp_keepidle = 600
# Number of seconds to keep retrying to listen
# retry_until_window = 30
# Number of backlog requests to configure the socket with.
# backlog = 4096
# Max header line to accommodate large tokens
# max_header_line = 16384
# Enable SSL on the API server
# use_ssl = False
# Certificate file to use when starting API server securely
# ssl_cert_file = /path/to/certfile
# Private key file to use when starting API server securely
# ssl_key_file = /path/to/keyfile
# CA certificate file to use when starting API server securely to
# verify connecting clients. This is an optional parameter only required if
# API clients need to authenticate to the API server using SSL certificates
# signed by a trusted CA
# ssl_ca_file = /path/to/cafile
# ======== end of WSGI parameters related to the API server ==========
# ======== neutron nova interactions ==========
# Send notification to nova when port status is active.
# notify_nova_on_port_status_changes = True
# Send notifications to nova when port data (fixed_ips/floatingips) change
# so nova can update it's cache.
# notify_nova_on_port_data_changes = True
# URL for connection to nova (Only supports one nova region currently).
# nova_url = http://127.0.0.1:8774/v2
# Name of nova region to use. Useful if keystone manages more than one region
# nova_region_name =
# Username for connection to nova in admin context
# nova_admin_username =
# The uuid of the admin nova tenant
# nova_admin_tenant_id =
# The name of the admin nova tenant. If the uuid of the admin nova tenant
# is set, this is optional. Useful for cases where the uuid of the admin
# nova tenant is not available when configuration is being done.
# nova_admin_tenant_name =
691
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Password for connection to nova in admin context.
# nova_admin_password =
# Authorization URL for connection to nova in admin context.
# nova_admin_auth_url =
# CA file for novaclient to verify server certificates
# nova_ca_certificates_file =
# Boolean to control ignoring SSL errors on the nova url
# nova_api_insecure = False
# Number of seconds between sending events to nova if there are any events to send
# send_events_interval = 2
# ======== end of neutron nova interactions ==========
#
# Options defined in oslo.messaging
#
# Use durable queues in amqp. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
# amqp_durable_queues=false
# Auto-delete queues in amqp. (boolean value)
# amqp_auto_delete=false
# Size of RPC connection pool. (integer value)
# rpc_conn_pool_size=30
# Qpid broker hostname. (string value)
# qpid_hostname=localhost
# Qpid broker port. (integer value)
# qpid_port=5672
# Qpid HA cluster host:port pairs. (list value)
# qpid_hosts=$qpid_hostname:$qpid_port
# Username for Qpid connection. (string value)
# qpid_username=
# Password for Qpid connection. (string value)
# qpid_password=
# Space separated list of SASL mechanisms to use for auth.
# (string value)
# qpid_sasl_mechanisms=
# Seconds between connection keepalive heartbeats. (integer
# value)
# qpid_heartbeat=60
# Transport to use, either 'tcp' or 'ssl'. (string value)
692
CHAPTER 9. NETWORKING
# qpid_protocol=tcp
# Whether to disable the Nagle algorithm. (boolean value)
# qpid_tcp_nodelay=true
# The qpid topology version to use. Version 1 is what was
# originally used by impl_qpid. Version 2 includes some
# backwards-incompatible changes that allow broker federation
# to work. Users should update to version 2 when they are
# able to take everything down, as it requires a clean break.
# (integer value)
# qpid_topology_version=1
# SSL version to use (valid only if SSL enabled). valid values
# are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some
# distributions. (string value)
# kombu_ssl_version=
# SSL key file (valid only if SSL enabled). (string value)
# kombu_ssl_keyfile=
# SSL cert file (valid only if SSL enabled). (string value)
# kombu_ssl_certfile=
# SSL certification authority file (valid only if SSL
# enabled). (string value)
# kombu_ssl_ca_certs=
# How long to wait before reconnecting in response to an AMQP
# consumer cancel notification. (floating point value)
# kombu_reconnect_delay=1.0
# The RabbitMQ broker address where a single node is used.
# (string value)
# rabbit_host=localhost
# The RabbitMQ broker port where a single node is used.
# (integer value)
# rabbit_port=5672
# RabbitMQ HA cluster host:port pairs. (list value)
# rabbit_hosts=$rabbit_host:$rabbit_port
# Connect over SSL for RabbitMQ. (boolean value)
# rabbit_use_ssl=false
# The RabbitMQ userid. (string value)
# rabbit_userid=guest
# The RabbitMQ password. (string value)
# rabbit_password=guest
# the RabbitMQ login method (string value)
# rabbit_login_method=AMQPLAIN
# The RabbitMQ virtual host. (string value)
693
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# rabbit_virtual_host=/
# How frequently to retry connecting with RabbitMQ. (integer
# value)
# rabbit_retry_interval=1
# How long to backoff for between retries when connecting to
# RabbitMQ. (integer value)
# rabbit_retry_backoff=2
# Maximum number of RabbitMQ connection retries. Default is 0
# (infinite retry count). (integer value)
# rabbit_max_retries=0
# Use HA queues in RabbitMQ (x-ha-policy: all). If you change
# this option, you must wipe the RabbitMQ database. (boolean
# value)
# rabbit_ha_queues=false
# If passed, use a fake RabbitMQ provider. (boolean value)
# fake_rabbit=false
# ZeroMQ bind address. Should be a wildcard (*), an ethernet
# interface, or IP. The "host" option should point or resolve
# to this address. (string value)
# rpc_zmq_bind_address=*
# MatchMaker driver. (string value)
# rpc_zmq_matchmaker=oslo.messaging._drivers.matchmaker.MatchMakerLocalhost
# ZeroMQ receiver listening port. (integer value)
# rpc_zmq_port=9501
# Number of ZeroMQ contexts, defaults to 1. (integer value)
# rpc_zmq_contexts=1
# Maximum number of ingress messages to locally buffer per
# topic. Default is unlimited. (integer value)
# rpc_zmq_topic_backlog=
# Directory for holding IPC sockets. (string value)
# rpc_zmq_ipc_dir=/var/run/openstack
# Name of this node. Must be a valid hostname, FQDN, or IP
# address. Must match "host" option, if running Nova. (string
# value)
# rpc_zmq_host=oslo
# Seconds to wait before a cast expires (TTL). Only supported
# by impl_zmq. (integer value)
# rpc_cast_timeout=30
# Heartbeat frequency. (integer value)
# matchmaker_heartbeat_freq=300
694
CHAPTER 9. NETWORKING
# Heartbeat time-to-live. (integer value)
# matchmaker_heartbeat_ttl=600
# Size of RPC greenthread pool. (integer value)
# rpc_thread_pool_size=64
# Driver or drivers to handle sending notifications. (multi
# valued)
# notification_driver=
# AMQP topic used for OpenStack notifications. (list value)
# Deprecated group/name - [rpc_notifier2]/topics
# notification_topics=notifications
# Seconds to wait for a response from a call. (integer value)
# rpc_response_timeout=60
# A URL representing the messaging driver to use and its full
# configuration. If not set, we fall back to the rpc_backend
# option and driver specific configuration. (string value)
# transport_url=
# The messaging driver to use, defaults to rabbit. Other
# drivers include qpid and zmq. (string value)
# rpc_backend=rabbit
# The default exchange under which topics are scoped. May be
# overridden by an exchange name specified in the
# transport_url option. (string value)
# control_exchange=openstack
[matchmaker_redis]
#
# Options defined in oslo.messaging
#
# Host to locate redis. (string value)
# host=127.0.0.1
# Use this port to connect to redis host. (integer value)
# port=6379
# Password for Redis server (optional). (string value)
# password=
[matchmaker_ring]
#
# Options defined in oslo.messaging
#
# Matchmaker ring file (JSON). (string value)
# Deprecated group/name - [DEFAULT]/matchmaker_ringfile
695
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# ringfile=/etc/oslo/matchmaker_ring.json
[quotas]
# Default driver to use for quota checks
# quota_driver = neutron.db.quota_db.DbQuotaDriver
# Resource name(s) that are supported in quota features
# quota_items = network,subnet,port
# Default number of resource allowed per tenant. A negative value means
# unlimited.
# default_quota = -1
# Number of networks allowed per tenant. A negative value means unlimited.
# quota_network = 10
# Number of subnets allowed per tenant. A negative value means unlimited.
# quota_subnet = 10
# Number of ports allowed per tenant. A negative value means unlimited.
# quota_port = 50
# Number of security groups allowed per tenant. A negative value means
# unlimited.
# quota_security_group = 10
# Number of security group rules allowed per tenant. A negative value means
# unlimited.
# quota_security_group_rule = 100
# Number of vips allowed per tenant. A negative value means unlimited.
# quota_vip = 10
# Number of pools allowed per tenant. A negative value means unlimited.
# quota_pool = 10
# Number of pool members allowed per tenant. A negative value means unlimited.
# The default is unlimited because a member is not a real resource consumer
# on Openstack. However, on back-end, a member is a resource consumer
# and that is the reason why quota is possible.
# quota_member = -1
# Number of health monitors allowed per tenant. A negative value means
# unlimited.
# The default is unlimited because a health monitor is not a real resource
# consumer on Openstack. However, on back-end, a member is a resource consumer
# and that is the reason why quota is possible.
# quota_health_monitor = -1
# Number of loadbalancers allowed per tenant. A negative value means
696
CHAPTER 9. NETWORKING
unlimited.
# quota_loadbalancer = 10
# Number of listeners allowed per tenant. A negative value means unlimited.
# quota_listener = -1
# Number of v2 health monitors allowed per tenant. A negative value means
# unlimited. These health monitors exist under the lbaas v2 API
# quota_healthmonitor = -1
# Number of routers allowed per tenant. A negative value means unlimited.
# quota_router = 10
# Number of floating IPs allowed per tenant. A negative value means unlimited.
# quota_floatingip = 50
# Number of firewalls allowed per tenant. A negative value means unlimited.
# quota_firewall = 1
# Number of firewall policies allowed per tenant. A negative value means
# unlimited.
# quota_firewall_policy = 1
# Number of firewall rules allowed per tenant. A negative value means
# unlimited.
# quota_firewall_rule = 100
[agent]
# Use "sudo neutron-rootwrap /etc/neutron/rootwrap.conf" to use the real
# root filter facility.
# Change to "sudo" to skip the filtering and just run the command directly
# root_helper = sudo
# Set to true to add comments to generated iptables rules that describe
# each rule's purpose. (System must support the iptables comments module.)
# comment_iptables_rules = True
# Root helper daemon application to use when possible.
# root_helper_daemon =
# Use the root helper when listing the namespaces on a system. This may not
# be required depending on the security configuration. If the root helper is
# not required, set this to False for a performance improvement.
# use_helper_for_ns_read = True
# The interval to check external processes for failure in seconds
(0=disabled)
# check_child_processes_interval = 60
# Action to take when an external process spawned by an agent dies
# Values:
697
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# respawn - Respawns the external process
# exit - Exits the agent
# check_child_processes_action = respawn
# =========== items for agent management extension =============
# seconds between nodes reporting state to server; should be less than
# agent_down_time, best if it is half or less than agent_down_time
# report_interval = 30
# =========== end of items for agent management extension =====
[keystone_authtoken] auth_uri = http://127.0.0.1:35357/v2.0/ identity_uri = http://127.0.0.1:5000 admin_tenant_name = %SERVICE_TENANT_NAME% admin_user = %SERVICE_USER% admin_password = %SERVICE_PASSWORD%
[database]
# This line MUST be changed to actually run the plugin.
# Example:
# connection = mysql://root:[email protected]:3306/neutron
# Replace 127.0.0.1 above with the IP address of the database used by the
# main neutron server. (Leave it as is if the database runs on this host.)
# connection = sqlite://
# NOTE: In deployment the [database] section and its connection attribute may
# be set in the corresponding core plugin '.ini' file. However, it is suggested
# to put the [database] section and its connection attribute in this
# configuration file.
# Database engine for which script will be generated when using offline
# migration
# engine =
# The SQLAlchemy connection string used to connect to the slave database
# slave_connection =
# Database reconnection retry times - in event connectivity is lost
# set to -1 implies an infinite retry count
# max_retries = 10
# Database reconnection interval in seconds - if the initial connection to the
# database fails
# retry_interval = 10
# Minimum number of SQL connections to keep open in a pool
# min_pool_size = 1
# Maximum number of SQL connections to keep open in a pool
# max_pool_size = 10
# Timeout in seconds before idle sql connections are reaped
698
CHAPTER 9. NETWORKING
# idle_timeout = 3600
# If set, use this value for max_overflow with sqlalchemy
# max_overflow = 20
# Verbosity of SQL debugging information. 0=None, 100=Everything
# connection_debug = 0
# Add python stack traces to SQL as comment strings
# connection_trace = False
# If set, use this value for pool_timeout with sqlalchemy
# pool_timeout = 10
[nova]
# Name of the plugin to load
# auth_plugin =
# Config Section from which to load plugin specific options
# auth_section =
# PEM encoded Certificate Authority to use when verifying HTTPs connections.
# cafile =
# PEM encoded client certificate cert file
# certfile =
# Verify HTTPS connections.
# insecure = False
# PEM encoded client certificate key file
# keyfile =
# Name of nova region to use. Useful if keystone manages more than one region.
# region_name =
# Timeout value for http requests
# timeout =
[oslo_concurrency]
# 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 external locks are used,
# a lock path must be set.
lock_path = $state_path/lock
# Enables or disables inter-process locks.
# disable_process_locking = False
[oslo_policy]
699
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The JSON file that defines policies.
# policy_file = policy.json
# Default rule. Enforced when a requested rule is not found.
# policy_default_rule = default
# Directories where policy configuration files are stored.
# They can be relative to any directory in the search path defined by the
# config_dir option, or absolute paths. The file defined by policy_file
# must exist for these directories to be searched. Missing or empty
# directories are ignored.
# policy_dirs = policy.d
[oslo_messaging_amqp]
#
# From oslo.messaging
#
# Address prefix used when sending to a specific server (string value)
# Deprecated group/name - [amqp1]/server_request_prefix
# server_request_prefix = exclusive
# Address prefix used when broadcasting to all servers (string value)
# Deprecated group/name - [amqp1]/broadcast_prefix
# broadcast_prefix = broadcast
# Address prefix when sending to any server in group (string value)
# Deprecated group/name - [amqp1]/group_request_prefix
# group_request_prefix = unicast
# Name for the AMQP container (string value)
# Deprecated group/name - [amqp1]/container_name
# container_name =
# Timeout for inactive connections (in seconds) (integer value)
# Deprecated group/name - [amqp1]/idle_timeout
# idle_timeout = 0
# Debug: dump AMQP frames to stdout (boolean value)
# Deprecated group/name - [amqp1]/trace
# trace = false
# CA certificate PEM file for verifing server certificate (string value)
# Deprecated group/name - [amqp1]/ssl_ca_file
# ssl_ca_file =
# Identifying certificate PEM file to present to clients (string value)
# Deprecated group/name - [amqp1]/ssl_cert_file
# ssl_cert_file =
# Private key PEM file used to sign cert_file certificate (string value)
# Deprecated group/name - [amqp1]/ssl_key_file
# ssl_key_file =
# Password for decrypting ssl_key_file (if encrypted) (string value)
700
CHAPTER 9. NETWORKING
# Deprecated group/name - [amqp1]/ssl_key_password
# ssl_key_password =
# Accept clients using either SSL or plain TCP (boolean value)
# Deprecated group/name - [amqp1]/allow_insecure_clients
# allow_insecure_clients = false
[oslo_messaging_qpid]
#
# From oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
# amqp_durable_queues = false
# Auto-delete queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/amqp_auto_delete
# amqp_auto_delete = false
# Size of RPC connection pool. (integer value)
# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size
# rpc_conn_pool_size = 30
# Qpid broker hostname. (string value)
# Deprecated group/name - [DEFAULT]/qpid_hostname
# qpid_hostname = localhost
# Qpid broker port. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_port
# qpid_port = 5672
# Qpid HA cluster host:port pairs. (list value)
# Deprecated group/name - [DEFAULT]/qpid_hosts
# qpid_hosts = $qpid_hostname:$qpid_port
# Username for Qpid connection. (string value)
# Deprecated group/name - [DEFAULT]/qpid_username
# qpid_username =
# Password for Qpid connection. (string value)
# Deprecated group/name - [DEFAULT]/qpid_password
# qpid_password =
# Space separated list of SASL mechanisms to use for auth. (string value)
# Deprecated group/name - [DEFAULT]/qpid_sasl_mechanisms
# qpid_sasl_mechanisms =
# Seconds between connection keepalive heartbeats. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_heartbeat
# qpid_heartbeat = 60
# Transport to use, either 'tcp' or 'ssl'. (string value)
# Deprecated group/name - [DEFAULT]/qpid_protocol
701
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# qpid_protocol = tcp
# Whether to disable the Nagle algorithm. (boolean value)
# Deprecated group/name - [DEFAULT]/qpid_tcp_nodelay
# qpid_tcp_nodelay = true
# The number of prefetched messages held by receiver. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_receiver_capacity
# qpid_receiver_capacity = 1
# The qpid topology version to use. Version 1 is what was originally used by
# impl_qpid. Version 2 includes some backwards-incompatible changes that allow
# broker federation to work. Users should update to version 2 when they are
# able to take everything down, as it requires a clean break. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_topology_version
# qpid_topology_version = 1
[oslo_messaging_rabbit]
#
# From oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
# amqp_durable_queues = false
# Auto-delete queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/amqp_auto_delete
# amqp_auto_delete = false
# Size of RPC connection pool. (integer value)
# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size
# rpc_conn_pool_size = 30
# SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and
# SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some
# distributions. (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_version
# kombu_ssl_version =
# SSL key file (valid only if SSL enabled). (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_keyfile
# kombu_ssl_keyfile =
# SSL cert file (valid only if SSL enabled). (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_certfile
# kombu_ssl_certfile =
# SSL certification authority file (valid only if SSL enabled). (string
702
CHAPTER 9. NETWORKING
value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_ca_certs
# kombu_ssl_ca_certs =
# How long to wait before reconnecting in response to an AMQP consumer cancel
# notification. (floating point value)
# Deprecated group/name - [DEFAULT]/kombu_reconnect_delay
# kombu_reconnect_delay = 1.0
# The RabbitMQ broker address where a single node is used. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_host
# rabbit_host = localhost
# The RabbitMQ broker port where a single node is used. (integer value)
# Deprecated group/name - [DEFAULT]/rabbit_port
# rabbit_port = 5672
# RabbitMQ HA cluster host:port pairs. (list value)
# Deprecated group/name - [DEFAULT]/rabbit_hosts
# rabbit_hosts = $rabbit_host:$rabbit_port
# Connect over SSL for RabbitMQ. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_use_ssl
# rabbit_use_ssl = false
# The RabbitMQ userid. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_userid
# rabbit_userid = guest
# The RabbitMQ password. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_password
# rabbit_password = guest
# The RabbitMQ login method. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_login_method
# rabbit_login_method = AMQPLAIN
# The RabbitMQ virtual host. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_virtual_host
# rabbit_virtual_host = /
# How frequently to retry connecting with RabbitMQ. (integer value)
# rabbit_retry_interval = 1
# How long to backoff for between retries when connecting to RabbitMQ.
(integer
# value)
# Deprecated group/name - [DEFAULT]/rabbit_retry_backoff
# rabbit_retry_backoff = 2
# Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry
# count). (integer value)
# Deprecated group/name - [DEFAULT]/rabbit_max_retries
# rabbit_max_retries = 0
703
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you
# must wipe the RabbitMQ database. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_ha_queues
# rabbit_ha_queues = false
# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value)
# Deprecated group/name - [DEFAULT]/fake_rabbit
# fake_rabbit = false
9.3.2. api-paste.ini
Use the api-paste.ini to configure the OpenStack Networking API.
[composite:neutron] use = egg:Paste#urlmap
/: neutronversions
/v2.0: neutronapi_v2_0
[composite:neutronapi_v2_0] use = call:neutron.auth:pipeline_factory noauth = request_id catch_errors extensions neutronapiapp_v2_0 keystone = request_id catch_errors authtoken keystonecontext extensions neutronapiapp_v2_0
[filter:request_id] paste.filter_factory = oslo.middleware:RequestId.factory
[filter:catch_errors] paste.filter_factory = oslo.middleware:CatchErrors.factory
[filter:keystonecontext] paste.filter_factory = neutron.auth:NeutronKeystoneContext.factory
[filter:authtoken] paste.filter_factory = keystonemiddleware.auth_token:filter_factory
[filter:extensions] paste.filter_factory = neutron.api.extensions:plugin_aware_extension_middleware_factory
[app:neutronversions] paste.app_factory = neutron.api.versions:Versions.factory
[app:neutronapiapp_v2_0] paste.app_factory = neutron.api.v2.router:APIRouter.factory
704
CHAPTER 9. NETWORKING
9.3.3. policy.json
Use the policy.json file to define additional access controls that apply to the OpenStack
Networking service.
{
"context_is_admin": "role:admin",
"admin_or_owner": "rule:context_is_admin or tenant_id:%(tenant_id)s",
"context_is_advsvc": "role:advsvc",
"admin_or_network_owner": "rule:context_is_admin or tenant_id:%
(network:tenant_id)s",
"admin_only": "rule:context_is_admin",
"regular_user": "",
"shared": "field:networks:shared=True",
"shared_firewalls": "field:firewalls:shared=True",
"shared_firewall_policies": "field:firewall_policies:shared=True",
"shared_subnetpools": "field:subnetpools:shared=True",
"external": "field:networks:router:external=True",
"default": "rule:admin_or_owner",
"create_subnet": "rule:admin_or_network_owner",
"get_subnet": "rule:admin_or_owner or rule:shared",
"update_subnet": "rule:admin_or_network_owner",
"delete_subnet": "rule:admin_or_network_owner",
"create_subnetpool": "",
"create_subnetpool:shared": "rule:admin_only",
"get_subnetpool": "rule:admin_or_owner or rule:shared_subnetpools",
"update_subnetpool": "rule:admin_or_owner",
"delete_subnetpool": "rule:admin_or_owner",
"create_network": "",
"get_network": "rule:admin_or_owner or rule:shared or rule:external or rule:context_is_advsvc",
"get_network:router:external": "rule:regular_user",
"get_network:segments": "rule:admin_only",
"get_network:provider:network_type": "rule:admin_only",
"get_network:provider:physical_network": "rule:admin_only",
"get_network:provider:segmentation_id": "rule:admin_only",
"get_network:queue_id": "rule:admin_only",
"create_network:shared": "rule:admin_only",
"create_network:router:external": "rule:admin_only",
"create_network:segments": "rule:admin_only",
"create_network:provider:network_type": "rule:admin_only",
"create_network:provider:physical_network": "rule:admin_only",
"create_network:provider:segmentation_id": "rule:admin_only",
"update_network": "rule:admin_or_owner",
"update_network:segments": "rule:admin_only",
"update_network:shared": "rule:admin_only",
"update_network:provider:network_type": "rule:admin_only",
"update_network:provider:physical_network": "rule:admin_only",
"update_network:provider:segmentation_id": "rule:admin_only",
"update_network:router:external": "rule:admin_only",
"delete_network": "rule:admin_or_owner",
705
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"create_port": "",
"create_port:mac_address": "rule:admin_or_network_owner or rule:context_is_advsvc",
"create_port:fixed_ips": "rule:admin_or_network_owner or rule:context_is_advsvc",
"create_port:port_security_enabled": "rule:admin_or_network_owner or rule:context_is_advsvc",
"create_port:binding:host_id": "rule:admin_only",
"create_port:binding:profile": "rule:admin_only",
"create_port:mac_learning_enabled": "rule:admin_or_network_owner or rule:context_is_advsvc",
"create_port:allowed_address_pairs": "rule:admin_or_network_owner",
"get_port": "rule:admin_or_owner or rule:context_is_advsvc",
"get_port:queue_id": "rule:admin_only",
"get_port:binding:vif_type": "rule:admin_only",
"get_port:binding:vif_details": "rule:admin_only",
"get_port:binding:host_id": "rule:admin_only",
"get_port:binding:profile": "rule:admin_only",
"update_port": "rule:admin_or_owner or rule:context_is_advsvc",
"update_port:mac_address": "rule:admin_only or rule:context_is_advsvc",
"update_port:fixed_ips": "rule:admin_or_network_owner or rule:context_is_advsvc",
"update_port:port_security_enabled": "rule:admin_or_network_owner or rule:context_is_advsvc",
"update_port:binding:host_id": "rule:admin_only",
"update_port:binding:profile": "rule:admin_only",
"update_port:mac_learning_enabled": "rule:admin_or_network_owner or rule:context_is_advsvc",
"update_port:allowed_address_pairs": "rule:admin_or_network_owner",
"delete_port": "rule:admin_or_owner or rule:context_is_advsvc",
"get_router:ha": "rule:admin_only",
"create_router": "rule:regular_user",
"create_router:external_gateway_info:enable_snat": "rule:admin_only",
"create_router:distributed": "rule:admin_only",
"create_router:ha": "rule:admin_only",
"get_router": "rule:admin_or_owner",
"get_router:distributed": "rule:admin_only",
"update_router:external_gateway_info:enable_snat": "rule:admin_only",
"update_router:distributed": "rule:admin_only",
"update_router:ha": "rule:admin_only",
"delete_router": "rule:admin_or_owner",
"add_router_interface": "rule:admin_or_owner",
"remove_router_interface": "rule:admin_or_owner",
"create_router:external_gateway_info:external_fixed_ips":
"rule:admin_only",
"update_router:external_gateway_info:external_fixed_ips":
"rule:admin_only",
"create_firewall": "",
"get_firewall": "rule:admin_or_owner",
"create_firewall:shared": "rule:admin_only",
"get_firewall:shared": "rule:admin_only",
706
CHAPTER 9. NETWORKING
"update_firewall": "rule:admin_or_owner",
"update_firewall:shared": "rule:admin_only",
"delete_firewall": "rule:admin_or_owner",
"create_firewall_policy": "",
"get_firewall_policy": "rule:admin_or_owner or rule:shared_firewall_policies",
"create_firewall_policy:shared": "rule:admin_or_owner",
"update_firewall_policy": "rule:admin_or_owner",
"delete_firewall_policy": "rule:admin_or_owner",
"create_firewall_rule": "",
"get_firewall_rule": "rule:admin_or_owner or rule:shared_firewalls",
"update_firewall_rule": "rule:admin_or_owner",
"delete_firewall_rule": "rule:admin_or_owner",
"create_qos_queue": "rule:admin_only",
"get_qos_queue": "rule:admin_only",
"update_agent": "rule:admin_only",
"delete_agent": "rule:admin_only",
"get_agent": "rule:admin_only",
"create_dhcp-network": "rule:admin_only",
"delete_dhcp-network": "rule:admin_only",
"get_dhcp-networks": "rule:admin_only",
"create_l3-router": "rule:admin_only",
"delete_l3-router": "rule:admin_only",
"get_l3-routers": "rule:admin_only",
"get_dhcp-agents": "rule:admin_only",
"get_l3-agents": "rule:admin_only",
"get_loadbalancer-agent": "rule:admin_only",
"get_loadbalancer-pools": "rule:admin_only",
"get_agent-loadbalancers": "rule:admin_only",
"get_loadbalancer-hosting-agent": "rule:admin_only",
"create_floatingip": "rule:regular_user",
"create_floatingip:floating_ip_address": "rule:admin_only",
"update_floatingip": "rule:admin_or_owner",
"delete_floatingip": "rule:admin_or_owner",
"get_floatingip": "rule:admin_or_owner",
"create_network_profile": "rule:admin_only",
"update_network_profile": "rule:admin_only",
"delete_network_profile": "rule:admin_only",
"get_network_profiles": "",
"get_network_profile": "",
"update_policy_profiles": "rule:admin_only",
"get_policy_profiles": "",
"get_policy_profile": "",
"create_metering_label": "rule:admin_only",
"delete_metering_label": "rule:admin_only",
"get_metering_label": "rule:admin_only",
"create_metering_label_rule": "rule:admin_only",
707
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"delete_metering_label_rule": "rule:admin_only",
"get_metering_label_rule": "rule:admin_only",
"get_service_provider": "rule:regular_user",
"get_lsn": "rule:admin_only",
"create_lsn": "rule:admin_only"
}
9.3.4. rootwrap.conf
Use the rootwrap.conf file to define configuration values used by the rootwrap script when the
OpenStack Networking service must escalate its privileges to those of the root user.
# Configuration for neutron-rootwrap
# This file should be owned by (and only-writeable by) the root user
[DEFAULT]
# List of directories to load filter definitions from (separated by ',').
# These directories MUST all be only writeable by root !
filters_path=/etc/neutron/rootwrap.d,/usr/share/neutron/rootwrap
# List of directories to search executables in, in case filters do not
# explicitely specify a full path (separated by ',')
# If not specified, defaults to system PATH environment variable.
# These directories MUST all be only writeable by root !
exec_dirs=/sbin,/usr/sbin,/bin,/usr/bin
# Enable logging to syslog
# Default value is False use_syslog=False
# Which syslog facility to use.
# Valid values include auth, authpriv, syslog, local0, local1...
# Default value is 'syslog' syslog_log_facility=syslog
# Which messages to log.
# INFO means log all usage
# ERROR means only log unsuccessful attempts syslog_log_level=ERROR
[xenapi]
# XenAPI configuration is only required by the L2 agent if it is to
# target a XenServer/XCP compute host's dom0.
xenapi_connection_url=<None> xenapi_connection_username=root xenapi_connection_password=<None>
708
CHAPTER 9. NETWORKING
9.3.5. Configuration files for plug-in agents
Each plug-in agent that runs on an OpenStack Networking node, to perform local networking configuration for the node's VMs and networking services, has its own configuration file.
9.3.5.1. dhcp_agent.ini
[DEFAULT]
# Show debugging output in log (sets DEBUG log level output)
# debug = False
# The DHCP agent will resync its state with Neutron to recover from any
# transient notification or rpc errors. The interval is number of
# seconds between attempts.
# resync_interval = 5
# The DHCP agent requires an interface driver be set. Choose the one that best
# matches your plugin.
# interface_driver =
# Example of interface_driver option for OVS based plugins(OVS, Ryu, NEC,
NVP,
# BigSwitch/Floodlight)
# interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver
# Name of Open vSwitch bridge to use
# ovs_integration_bridge = br-int
# Use veth for an OVS interface or not.
# Support kernels with limited namespace support
# (e.g. RHEL 6.5) so long as ovs_use_veth is set to True.
# ovs_use_veth = False
# Example of interface_driver option for LinuxBridge
# interface_driver = neutron.agent.linux.interface.BridgeInterfaceDriver
# The agent can use other DHCP drivers. Dnsmasq is the simplest and requires
# no additional setup of the DHCP server.
# dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq
# Allow overlapping IP (Must have kernel build with CONFIG_NET_NS=y and
# iproute2 package that supports namespaces). This option is deprecated and
# will be removed in a future release, at which point the old behavior of
# use_namespaces = True will be enforced.
# use_namespaces = True
# The DHCP server can assist with providing metadata support on isolated
# networks. Setting this value to True will cause the DHCP server to append
# specific host routes to the DHCP request. The metadata service will only
# be activated when the subnet does not contain any router port. The guest
709
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# instance must be configured to request host routes via DHCP (Option
121).
# enable_isolated_metadata = False
# Allows for serving metadata requests coming from a dedicated metadata
# access network whose cidr is 169.254.169.254/16 (or larger prefix), and
# is connected to a Neutron router from which the VMs send metadata
# request. In this case DHCP Option 121 will not be injected in VMs, as
# they will be able to reach 169.254.169.254 through a router.
# This option requires enable_isolated_metadata = True
# enable_metadata_network = False
# Number of threads to use during sync process. Should not exceed connection
# pool size configured on server.
# num_sync_threads = 4
# Location to store DHCP server config files
# dhcp_confs = $state_path/dhcp
# Domain to use for building the hostnames
# dhcp_domain = openstacklocal
# Override the default dnsmasq settings with this file
# dnsmasq_config_file =
# Comma-separated list of DNS servers which will be used by dnsmasq
# as forwarders.
# dnsmasq_dns_servers =
# Limit number of leases to prevent a denial-of-service.
# dnsmasq_lease_max = 16777216
# Location to DHCP lease relay UNIX domain socket
# dhcp_lease_relay_socket = $state_path/dhcp/lease_relay
# Use broadcast in DHCP replies
# dhcp_broadcast_reply = False
# dhcp_delete_namespaces, which is false by default, can be set to True if
# namespaces can be deleted cleanly on the host running the dhcp agent.
# Do not enable this until you understand the problem with the Linux iproute
# utility mentioned in https://bugs.launchpad.net/neutron/+bug/1052535 and
# you are sure that your version of iproute does not suffer from the problem.
# If True, namespaces will be deleted when a dhcp server is disabled.
# dhcp_delete_namespaces = False
# Timeout for ovs-vsctl commands.
# If the timeout expires, ovs commands will fail with ALARMCLOCK error.
710
CHAPTER 9. NETWORKING
# ovs_vsctl_timeout = 10
9.3.5.2. l3_agent.ini
[DEFAULT]
# Show debugging output in log (sets DEBUG log level output)
# debug = False
# L3 requires that an interface driver be set. Choose the one that best
# matches your plugin.
# interface_driver =
# Example of interface_driver option for OVS based plugins (OVS, Ryu,
NEC)
# that supports L3 agent
# interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver
# Use veth for an OVS interface or not.
# Support kernels with limited namespace support
# (e.g. RHEL 6.5) so long as ovs_use_veth is set to True.
# ovs_use_veth = False
# Example of interface_driver option for LinuxBridge
# interface_driver = neutron.agent.linux.interface.BridgeInterfaceDriver
# Allow overlapping IP (Must have kernel build with CONFIG_NET_NS=y and
# iproute2 package that supports namespaces). This option is deprecated and
# will be removed in a future release, at which point the old behavior of
# use_namespaces = True will be enforced.
# use_namespaces = True
# If use_namespaces is set as False then the agent can only configure one router.
# This is done by setting the specific router_id.
# router_id =
# When external_network_bridge is set, each L3 agent can be associated
# with no more than one external network. This value should be set to the
UUID
# of that external network. To allow L3 agent support multiple external
# networks, both the external_network_bridge and gateway_external_network_id
# must be left empty.
# gateway_external_network_id =
# With IPv6, the network used for the external gateway does not need
# to have an associated subnet, since the automatically assigned
# link-local address (LLA) can be used. However, an IPv6 gateway address
# is needed for use as the next-hop for the default route. If no IPv6
# gateway address is configured here, (and only then) the neutron router
711
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# will be configured to get its default route from router advertisements
(RAs)
# from the upstream router; in which case the upstream router must also be
# configured to send these RAs.
# The ipv6_gateway, when configured, should be the LLA of the interface
# on the upstream router. If a next-hop using a global unique address
(GUA)
# is desired, it needs to be done via a subnet allocated to the network
# and not through this parameter.
# ipv6_gateway =
# Indicates that this L3 agent should also handle routers that do not have
# an external network gateway configured. This option should be True only
# for a single agent in a Neutron deployment, and may be False for all agents
# if all routers must have an external network gateway
# handle_internal_only_routers = True
# Name of bridge used for external network traffic. This should be set to
# empty value for the linux bridge. when this parameter is set, each L3 agent
# can be associated with no more than one external network.
# external_network_bridge = br-ex
# TCP Port used by Neutron metadata server
# metadata_port = 9697
# Send this many gratuitous ARPs for HA setup. Set it below or equal to 0
# to disable this feature.
# send_arp_for_ha = 3
# seconds between re-sync routers' data if needed
# periodic_interval = 40
# seconds to start to sync routers' data after
# starting agent
# periodic_fuzzy_delay = 5
# enable_metadata_proxy, which is true by default, can be set to False
# if the Nova metadata server is not available
# enable_metadata_proxy = True
# Iptables mangle mark used to mark metadata valid requests
# metadata_access_mark = 0x1
# Iptables mangle mark used to mark ingress from external network
# external_ingress_mark = 0x2
# router_delete_namespaces, which is false by default, can be set to True if
# namespaces can be deleted cleanly on the host running the L3 agent.
# Do not enable this until you understand the problem with the Linux iproute
712
CHAPTER 9. NETWORKING
# utility mentioned in https://bugs.launchpad.net/neutron/+bug/1052535 and
# you are sure that your version of iproute does not suffer from the problem.
# If True, namespaces will be deleted when a router is destroyed.
# router_delete_namespaces = False
# Timeout for ovs-vsctl commands.
# If the timeout expires, ovs commands will fail with ALARMCLOCK error.
# ovs_vsctl_timeout = 10
# The working mode for the agent. Allowed values are:
# - legacy: this preserves the existing behavior where the L3 agent is
# deployed on a centralized networking node to provide L3 services
# like DNAT, and SNAT. Use this mode if you do not want to adopt DVR.
# - dvr: this mode enables DVR functionality, and must be used for an L3
# agent that runs on a compute host.
# - dvr_snat: this enables centralized SNAT support in conjunction with
# DVR. This mode must be used for an L3 agent running on a centralized
# node (or in single-host deployments, e.g. devstack).
# agent_mode = legacy
# Location to store keepalived and all HA configurations
# ha_confs_path = $state_path/ha_confs
# VRRP authentication type AH/PASS
# ha_vrrp_auth_type = PASS
# VRRP authentication password
# ha_vrrp_auth_password =
# The advertisement interval in seconds
# ha_vrrp_advert_int = 2
9.3.5.3. metadata_agent.ini
[DEFAULT]
# Show debugging output in log (sets DEBUG log level output)
# debug = True
# The Neutron user information for accessing the Neutron API.
auth_url = http://localhost:5000/v2.0
auth_region = RegionOne
# Turn off verification of the certificate for ssl
# auth_insecure = False
# Certificate Authority public key (CA cert) file for ssl
# auth_ca_cert = admin_tenant_name = %SERVICE_TENANT_NAME% admin_user = %SERVICE_USER% admin_password = %SERVICE_PASSWORD%
# Network service endpoint type to pull from the keystone catalog
713
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# endpoint_type = adminURL
# IP address used by Nova metadata server
# nova_metadata_ip = 127.0.0.1
# TCP Port used by Nova metadata server
# nova_metadata_port = 8775
# Which protocol to use for requests to Nova metadata server, http or https
# nova_metadata_protocol = http
# Whether insecure SSL connection should be accepted for Nova metadata server
# requests
# nova_metadata_insecure = False
# Client certificate for nova api, needed when nova api requires client
# certificates
# nova_client_cert =
# Private key for nova client certificate
# nova_client_priv_key =
# When proxying metadata requests, Neutron signs the Instance-ID header with a
# shared secret to prevent spoofing. You may select any string for a secret,
# but it must match here and in the configuration used by the Nova
Metadata
# Server. NOTE: Nova uses the same config key, but in [neutron] section.
# metadata_proxy_shared_secret =
# Location of Metadata Proxy UNIX domain socket
# metadata_proxy_socket = $state_path/metadata_proxy
# Metadata Proxy UNIX domain socket mode, 3 values allowed:
# 'deduce': deduce mode from metadata_proxy_user/group values,
# 'user': set metadata proxy socket mode to 0o644, to use when
# metadata_proxy_user is agent effective user or root,
# 'group': set metadata proxy socket mode to 0o664, to use when
# metadata_proxy_group is agent effective group,
# 'all': set metadata proxy socket mode to 0o666, to use otherwise.
# metadata_proxy_socket_mode = deduce
# Number of separate worker processes for metadata server. Defaults to
# half the number of CPU cores
# metadata_workers =
# Number of backlog requests to configure the metadata server socket with
# metadata_backlog = 4096
# URL to connect to the cache backend.
# default_ttl=0 parameter will cause cache entries to never expire.
# Otherwise default_ttl specifies time in seconds a cache entry is valid for.
714
CHAPTER 9. NETWORKING
# No cache is used in case no value is passed.
# cache_url = memory://?default_ttl=5
9.4. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
OPENSTACK NETWORKING
Table 9.66. New options
Option = default value
[DEFAULT] advertise_mtu = False
(Type) Help string
(BoolOpt) If True, effort is made to advertise MTU settings to VMs via network methods (DHCP and
RA MTU options) when the network's preferred
MTU is known.
[DEFAULT] allow_automatic_dhcp_failover = True (BoolOpt) Automatically remove networks from offline DHCP agents.
[DEFAULT] conn_idle_timeout = 900
[DEFAULT] default_ipv4_subnet_pool = None
[DEFAULT] default_ipv6_subnet_pool = None
[DEFAULT] dhcp_broadcast_reply = False
[DEFAULT] dhcp_load_type = networks
(IntOpt) Reconnect connection to nsx if not used within this amount of time.
(StrOpt) Default IPv4 subnet-pool to be used for automatic subnet CIDR allocation
(StrOpt) Default IPv6 subnet-pool to be used for automatic subnet CIDR allocation
(BoolOpt) Use broadcast in DHCP replies
(StrOpt) Represents the resource type whose load is being reported by the agent. This can be
'networks', 'subnets' or 'ports'. When specified
(default is 'networks'), the server will extract the particular load sent as part of its agent configuration object from the agent report state, which is the number of resources being consumed.
'report_interval.dhcp_load_type' can be used in combination with 'network_scheduler_driver = neutron.scheduler.dhcp_agent_scheduler.WeightS
cheduler'. When the 'network_scheduler_driver' is
'WeightScheduler', 'dhcp_load_type' can be configured to represent the choice for the resource being balanced. For example:
'dhcp_load_type=networks'.
715
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] enable_services_on_agents_with_admin_state_do wn = False
(BoolOpt) Enable services on an agent with admin_state_up False. If this option is False, when admin_state_up of an agent is turned False, services on it will be disabled. Agents with admin_state_up False are not selected for automatic scheduling regardless of this option. But manual scheduling to such agents is available if this option is True.
[DEFAULT] external_ingress_mark = 0x2
(Type) Help string
(StrOpt) Iptables mangle mark used to mark ingress from external network
[DEFAULT] ipv6_gateway =
[DEFAULT] log-config-append = None
[DEFAULT] log-date-format = %Y-%m-%d
%H:%M:%S
[DEFAULT] log-dir = None
(StrOpt) With IPv6, the network used for the external gateway does not need to have an associated subnet, since the automatically assigned link-local address (LLA) can be used.
However, an IPv6 gateway address is needed for use as the next-hop for the default route. If no IPv6 gateway address is configured here, (and only then) the neutron router will be configured to get its default route from router advertisements (RAs) from the upstream router; in which case the upstream router must also be configured to send these RAs. The ipv6_gateway, when configured, should be the LLA of the interface on the upstream router. If a next-hop using a global unique address
(GUA) is desired, it needs to be done via a subnet allocated to the network and not through this parameter.
(StrOpt) 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.
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
(StrOpt) (Optional) The base directory used for relative --log-file paths.
[DEFAULT] log-file = None
[DEFAULT] log-format = None
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
716
CHAPTER 9. NETWORKING
Option = default value
[DEFAULT] metadata_access_mark = 0x1
[DEFAULT] metadata_proxy_group =
[DEFAULT] metadata_proxy_socket_mode = deduce
[DEFAULT] metadata_proxy_user =
[DEFAULT] metadata_proxy_watch_log = None
[DEFAULT] nova_admin_tenant_name = None
[DEFAULT] policy_default_rule = default
[DEFAULT] policy_dirs = ['policy.d']
[DEFAULT] syslog-log-facility = LOG_USER
[DEFAULT] use-syslog = False
(Type) Help string
(StrOpt) Iptables mangle mark used to mark metadata valid requests
(StrOpt) Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group).
(StrOpt) Metadata Proxy UNIX domain socket mode, 3 values allowed: 'deduce': deduce mode from metadata_proxy_user/group values, 'user': set metadata proxy socket mode to 0o644, to use when metadata_proxy_user is agent effective user or root, 'group': set metadata proxy socket mode to
0o664, to use when metadata_proxy_group is agent effective group or root, 'all': set metadata proxy socket mode to 0o666, to use otherwise.
(StrOpt) User (uid or name) running metadata proxy after its initialization (if empty: agent effective user).
(BoolOpt) Enable/Disable log watch by metadata proxy. It should be disabled when metadata_proxy_user/group is not allowed to read/write its log file and copytruncate logrotate option must be used if logrotate is enabled on metadata proxy log files. Option default value is deduced from metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent effective user id/name.
(StrOpt) The name of the admin nova tenant.
Deprecated in favour of an auth plugin in [nova].
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
717
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[DEFAULT] use-syslog-rfc-format = False
[DEFAULT] vlan_transparent = False
[AGENT] check_child_processes_action = respawn
[AGENT] check_child_processes_interval = 60
[AGENT] comment_iptables_rules = True
[AGENT] prevent_arp_spoofing = False
[AGENT] root_helper_daemon = None
[AGENT] use_helper_for_ns_read = True
[MIDONET] client = midonet.neutron.client.api.MidonetApiClient
[MIDONET] cluster_ip = localhost
[MIDONET] cluster_port = 8088
[MIDONET] tunnel_protocol = vxlan
[OFC] support_packet_filter_on_ofc_router = True
(Type) Help string
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) If True, then allow plugins that support it to create VLAN transparent networks.
(StrOpt) Action to be executed when a child process dies
(IntOpt) Interval between checks of child process liveness (seconds), use 0 to disable
(BoolOpt) Add comments to iptables rules.
(BoolOpt) Enable suppression of ARP responses that don't match an IP address that belongs to the port from which they originate. Note: This prevents the VMs attached to this agent from spoofing, it doesn't protect them from other devices which have the capability to spoof (e.g. bare metal or
VMs attached to agents without this flag set to
True). Spoofing rules will not be added to any ports that have port security disabled. This requires a version of OVS that supports matching ARP headers.
(StrOpt) Root helper daemon application to use when possible.
(BoolOpt) Use the root helper to read the namespaces from the operating system.
(StrOpt) MidoNet client used to access MidoNet data storage.
(StrOpt) IP that the cluster service can be reached on
(StrOpt) Port that the cluster service can be reached on
(StrOpt) Tunnel protocol used by Midonet
(BoolOpt) Support packet filter on OFC router interface.
718
CHAPTER 9. NETWORKING
Option = default value
[OVSVAPP] agent_driver = networking_vsphere.agent.ovsvapp_agent.OVSvA
ppL2Agent
[OVSVAPP] agent_maintenance = False
[OVSVAPP] bridge_mappings =
(Type) Help string
(StrOpt) OVSvApp Agent implementation.
(BoolOpt) Turn on this flag during agent updates to help prevent datapath outage.
(ListOpt) Bridge mappings.
[OVSVAPP] dont_fragment = True
[OVSVAPP] integration_bridge = br-int
(IntOpt) Do not fragment.
(StrOpt) Integration Bridge.
[OVSVAPP] local_ip =
[OVSVAPP] network_manager = networking_vsphere.drivers.manager.VcenterMana
ger
(StrOpt) Driver Manager implementation for
NetworkDriver.
[OVSVAPP] polling_interval = 2
(StrOpt) Local IP address of VXLAN tunnel endpoint.
(IntOpt) The number of seconds the agent will wait between polling for local device changes.
[OVSVAPP] report_interval = 4
[OVSVAPP] tenant_network_type = vlan
[OVSVAPP] tunnel_bridge = br-tun
[OVSVAPP] tunnel_types = vxlan
(IntOpt) Seconds between nodes reporting state to server.
(StrOpt) Network type for tenant networks
(StrOpt) Tunnel Bridge for tunneling.
(ListOpt) Tunnel network types supported by the
OVSvApp Agent.
[OVSVAPP] veth_mtu = 1500
[OVSVAPP] vxlan_udp_port = 4789
(IntOpt) MTU size of veth interfaces.
(IntOpt) The UDP port to use for VXLAN tunnels.
[SECURITYGROUP] defer_apply = True (BoolOpt) Enable defer_apply on security bridge.
[SECURITYGROUP] ovsvapp_firewall_driver = networking_vsphere.drivers.ovs_firewall.OVSFirew
allDriver
(StrOpt) DriverManager implementation for OVS based Firewall.
(StrOpt) <security_bridge>:<phy_interface> [SECURITYGROUP] security_bridge_mapping = br-sec
[VMWARE] cert_check = False (BoolOpt) Enable SSL certificate check for vCenter.
719
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[VMWARE] cert_path = /etc/ssl/certs/certs.pem
[VMWARE] cluster_dvs_mapping = ['']
[VMWARE] esx_hostname = None
[VMWARE] esx_maintenance_mode = True
[VMWARE] https_port = 443
[VMWARE] vcenter_api_retry_count = 5
[VMWARE] vcenter_id = None
[VMWARE] vcenter_ip = None
[VMWARE] vcenter_password = None
[VMWARE] vcenter_username = None
[VMWARE] wsdl_location = None
[VROUTER] flavor = 2
[VROUTER] image_id = None
[VROUTER] keystone_url = None
[VROUTER] management_network_id = None
[VROUTER] nova_poll_interval = 5
[VROUTER] nova_spawn_timeout = 300
[VROUTER] tenant_admin_name = None
[VROUTER] tenant_admin_password = None
(Type) Help string
(StrOpt) Certificate chain path containing cacert of vCenters.
(MultiStrOpt) vCenter cluster to DVS mapping.
(StrOpt) ESX host name where this OVSvApp is hosted.
(BoolOpt) Set host into maintenance mode.
(IntOpt) Customized https_port for vCenter communication.
(StrOpt) Number of retries while connecting to vcenter server.
(StrOpt) Unique ID of the vCenter Server on which this OVSvApp ishosted
(StrOpt) vCenter server IP.
(StrOpt) vCenter server password.
(StrOpt) vCenter server user name.
(StrOpt) vCenter server wsdl location.
(StrOpt) Nova VM flavor for instances of Vyatta vRouter.
(StrOpt) Nova image id for instances of Vyatta vRouter.
(StrOpt) Keystone URL.
(StrOpt) Vyatta vRouter management network id.
(IntOpt) Number of seconds between consecutive
Nova queries when waiting for router instance status change.
(IntOpt) Number of seconds to wait for Nova to activate instance before setting resource to error state.
(StrOpt) Name of tenant admin user.
(StrOpt) Tenant admin password.
720
Option = default value
[VROUTER] tenant_id = None
[VROUTER] vrouter_boot_timeout = 300
[VROUTER] vrouter_credentials = vyatta:vyatta
[VROUTER] vrouter_poll_interval = 5
[l3_brocade_mlx] switch_names =
[ml2] path_mtu = 0
[ml2] physical_network_mtus =
[ml2] segment_mtu = 0
[ml2_brocade] rbridge_id = 1
[ml2_brocade_fi_ni] switch_names =
[ml2_cisco] host_key_checks = False
[ml2_cisco] persistent_switch_config = False
[ml2_cisco] provider_vlan_auto_create = True
[ml2_cisco] provider_vlan_auto_trunk = True
[ml2_cisco] provider_vlan_name_prefix = p-
CHAPTER 9. NETWORKING
(Type) Help string
(StrOpt) UUID of tenant that holds Vyatta vRouter instances.
(IntOpt) Number of seconds to wait for Vyatta vRouter to boot before setting resource to error state.
(StrOpt) Vyatta vRouter login credentials
(IntOpt) Number of seconds between consecutive
Vyatta vRouter queries when waiting for router instance boot.
(StrOpt) Switches connected to the compute nodes
(IntOpt) The maximum permissible size of an unfragmented packet travelling from and to addresses where encapsulated Neutron traffic is sent. If <= 0, the path MTU is indeterminate.
(ListOpt) A list of mappings of physical networks to
MTU values. The format of the mapping is
<physnet>:<mtu val>. This mapping allows specifying a physical network MTU value that differs from the default segment_mtu value.
(IntOpt) The maximum permissible size of an unfragmented packet travelling a L2 network segment. If <= 0, the segment MTU is indeterminate.
(StrOpt) Rbridge id of provider edge router(s)
(StrOpt) Switches connected to the compute nodes
(BoolOpt) Enable strict host key checks when connecting to Nexus switches
(BoolOpt) To make Nexus configuration persistent
(BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch
(BoolOpt) Provider VLANs are automatically trunked as needed on the ports of the Nexus switch
(StrOpt) VLAN Name prefix for provider vlans
721
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[ml2_cisco] switch_heartbeat_time = 0
[ml2_cisco] switch_replay_count = 3
[ml2_cisco] vxlan_global_config = False
[ml2_cisco_n1kv] default_policy_profile = defaultpp
[ml2_cisco_n1kv] default_vlan_network_profile = default-vlan-np
[ml2_cisco_n1kv] default_vxlan_network_profile = default-vxlan-np
[ml2_cisco_n1kv] http_pool_size = 4
(Type) Help string
(IntOpt) Periodic time to check switch connection.
(0=disabled)
(IntOpt) Number of times to attempt config replay with switch.
(BoolOpt) Create and delete Nexus switch VXLAN global settings; feature nv overlay, feature vnsegment-vlan-based, interface nve + sourceinterface loopback
(StrOpt) Cisco Nexus1000V default policy profile.
[ml2_cisco_n1kv] http_timeout = 15
[ml2_cisco_n1kv] n1kv_vsm_ips = None
[ml2_cisco_n1kv] password = None
[ml2_cisco_n1kv] poll_duration = 60
[ml2_cisco_n1kv] restrict_policy_profiles = False
[ml2_cisco_n1kv] sync_interval = 300
[ml2_cisco_n1kv] username = None
[ml2_cisco_ucsm] supported_pci_devs =
1137:0071, 8086:10c9
(StrOpt) Cisco Nexus1000V default network profile for VLAN networks.
(StrOpt) Cisco Nexus1000V default network profile for VXLAN networks.
(IntOpt) Number of threads to use to make HTTP requests.
(IntOpt) HTTP timeout, in seconds, for connections to the Cisco Nexus1000V VSMs.
(ListOpt) Comma Separated IP Addresses of the
Cisco Nexus1000V VSMs.
(StrOpt) Password for all configured Cisco
Nexus1000V VSMs.
(IntOpt) Cisco Nexus1000V policy profile polling duration in seconds.
(BoolOpt) Restrict the visibility of policy profiles to the tenants.
(IntOpt) Time interval between consecutive neutron-VSM syncs.
(StrOpt) Username for all configured Cisco
Nexus1000V VSMs.
(ListOpt) List of comma separated vendor_id:product_id of SR_IOV capable devices supported by this MD. This MD supports both VM-
FEX and SR-IOV devices.
722
Option = default value
[ml2_cisco_ucsm] ucsm_host_list = None
[ml2_cisco_ucsm] ucsm_ip = None
[ml2_cisco_ucsm] ucsm_password = None
[ml2_cisco_ucsm] ucsm_username = None
[nova] auth_plugin = None
[nova] auth_section = None
[nova] cafile = None
[nova] certfile = None
[nova] insecure = False
[nova] keyfile = None
[nova] region_name = None
[nova] timeout = None
[nsx_v3] default_edge_cluster_uuid = None
[nsxv] backup_edge_pool = service:large:4:10, service:compact:4:10, vdr:large:4:10
[nsxv] cluster_moid =
[nsxv] datacenter_moid = None
CHAPTER 9. NETWORKING
(Type) Help string
(ListOpt) List of comma separated Host:Service
Profile tuples providing the Service Profile associated with each Host to be supported by this
MD.
(StrOpt) Cisco UCS Manager IP address. This is a required field to communicate with a Cisco UCS
Manager.
(StrOpt) Password for UCS Manager. This is a required field to communicate with a Cisco UCS
Manager.
(StrOpt) Username for UCS Manager. This is a required field to communicate with a Cisco UCS
Manager.
(StrOpt) Name of the plugin to load
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.
(StrOpt) PEM encoded client certificate cert file
(BoolOpt) Verify HTTPS connections.
(StrOpt) PEM encoded client certificate key file
(StrOpt) Name of nova region to use. Useful if keystone manages more than one region.
(IntOpt) Timeout value for http requests
(StrOpt) Default edge cluster identifier
(ListOpt) Defines edge pool using the format:
<edge_type>:[edge_size]:<min_edges>:
<max_edges>.edge_type: service,vdr. edge_size: compact, large, xlarge, quadlarge and default is large.
(ListOpt) Parameter listing the IDs of the clusters which are used by OpenStack.
(StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges
723
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[nsxv] datastore_id = None
[nsxv] deployment_container_id = None
[nsxv] dvs_id = None
[nsxv] external_network = None
[nsxv] manager_uri = None
[nsxv] maximum_tunnels_per_vnic = 20
[nsxv] metadata_shared_secret = None
[nsxv] mgt_net_default_gateway = None
[nsxv] mgt_net_moid = None
[nsxv] mgt_net_proxy_ips = None
[nsxv] mgt_net_proxy_netmask = None
[nsxv] nova_metadata_ips = None
[nsxv] nova_metadata_port = 8775
[nsxv] password = default
[nsxv] resource_pool_id = None
[nsxv] retries = 10
[nsxv] spoofguard_enabled = True
[nsxv] task_status_check_interval = 2000
(Type) Help string
(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges
(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges
(StrOpt) DVS ID for VLANs
(StrOpt) Network ID for physical network connectivity
(StrOpt) uri for vsm
(IntOpt) Maximum number of sub interfaces supported per vnic in edge. The value should be in
1-110.
(StrOpt) Shared secret to sign metadata requests
(StrOpt) Management network default gateway for metadata proxy
(StrOpt) Network ID for management network connectivity
(ListOpt) Management network IP address for metadata proxy
(StrOpt) Management network netmask for metadata proxy
(ListOpt) IP addresses used by Nova metadata service
(IntOpt) TCP Port used by Nova metadata server
(StrOpt) Password for vsm
(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges
(IntOpt) Maximum number of API retries on endpoint.
(BoolOpt) If True then plugin will use NSXV spoofguard component for port-security feature.
(IntOpt) Task status check interval
724
CHAPTER 9. NETWORKING
Option = default value
[nsxv] tenant_router_types = shared, distributed, exclusive
[nsxv] user = admin
[nsxv] vdn_scope_id = None
[oslo_concurrency] disable_process_locking =
False
[oslo_concurrency] lock_path = None
[oslo_messaging_amqp] allow_insecure_clients =
False
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
(Type) Help string
(ListOpt) Ordered list of router_types to allocate as tenant routers.
(StrOpt) User name for vsm
(StrOpt) Network scope ID for VXLAN virtual wires
(BoolOpt) Enables or disables inter-process locks.
(StrOpt) 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 external locks are used, a lock path must be set.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
[oslo_messaging_amqp] ssl_key_file =
[oslo_messaging_amqp] ssl_key_password =
None
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
[oslo_messaging_amqp] trace = False
[oslo_messaging_qpid] amqp_auto_delete = False
(BoolOpt) Debug: dump AMQP frames to stdout
(BoolOpt) Auto-delete queues in AMQP.
725
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_qpid] amqp_durable_queues =
False
[oslo_messaging_qpid] qpid_heartbeat = 60
(Type) Help string
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
[oslo_messaging_qpid] qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
[oslo_messaging_qpid] qpid_sasl_mechanisms = (StrOpt) Space separated list of SASL mechanisms to use for auth.
[oslo_messaging_qpid] qpid_tcp_nodelay = True
[oslo_messaging_qpid] qpid_topology_version = 1
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30
[oslo_messaging_rabbit] amqp_auto_delete =
False
[oslo_messaging_rabbit] amqp_durable_queues =
False
[oslo_messaging_rabbit] fake_rabbit = False
(IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_rabbit] heartbeat_rate = 2
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
726
CHAPTER 9. NETWORKING
Option = default value
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(Type) Help string
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
[oslo_messaging_rabbit] rabbit_port = 5672
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
[oslo_messaging_rabbit] rabbit_retry_interval = 1
[oslo_messaging_rabbit] rabbit_use_ssl = False
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
727
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
(Type) Help string
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
[oslo_messaging_rabbit] rpc_conn_pool_size = 30
[oslo_middleware] max_request_body_size =
114688
(IntOpt) Size of RPC connection pool.
(IntOpt) The maximum body size for each request, in bytes.
Table 9.67. New default values
Option
[DEFAULT] default_log_levels
Previous default value New default value amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retr
y=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN oslo.messaging._drivers.matchm
aker.MatchMakerLocalhost
local
False True
[DEFAULT] rpc_zmq_matchmaker
[CISCO_N1K] restrict_network_profiles
[NOVA] vif_type
[OVS] local_ip
[OVS] ovsdb_interface
[RESTPROXYAGENT] virtual_switch_type
[VXLAN] enable_vxlan
[VXLAN] local_ip ovs
None ovs
False ivs
None vsctl ivs
True
None
728
CHAPTER 9. NETWORKING
Option
[hosting_devices] csr1kv_cfgagent_router_driver
[hosting_devices] csr1kv_device_driver
[hosting_devices] csr1kv_plugging_driver
Previous default value New default value neutron.plugins.cisco.cfg_agent.
device_drivers.csr1kv.csr1kv_ro
uting_driver.CSR1kvRoutingDriv
er networking_cisco.plugins.cisco.c
fg_agent.device_drivers.csr1kv.c
sr1kv_routing_driver.CSR1kvRo
utingDriver neutron.plugins.cisco.l3.hosting_
device_drivers.csr1kv_hd_driver.
CSR1kvHostingDeviceDriver networking_cisco.plugins.cisco.l
3.hosting_device_drivers.csr1kv
_hd_driver.CSR1kvHostingDevic
eDriver neutron.plugins.cisco.l3.plugging
_drivers.n1kv_trunking_driver.N1
kvTrunkingPlugDriver networking_cisco.plugins.cisco.l
3.plugging_drivers.n1kv_trunking
_driver.N1kvTrunkingPlugDriver
15b3:1004, 8086:10c9 15b3:1004, 8086:10ca [ml2_sriov] supported_pci_vendor_devs
[plumgriddirector] driver neutron.plugins.plumgrid.drivers.
plumlib.Plumlib
networking_plumgrid.neutron.plu
gins.drivers.plumlib.Plumlib
Table 9.68. Deprecated options
Deprecated option
[DEFAULT] use-syslog
[DEFAULT] use_syslog
[DEFAULT] max_request_body_size
[DEFAULT] nova_api_insecure
[DEFAULT] log-format
[DEFAULT] nova_ca_certificates_file
[DEFAULT] nova_region_name
[DEFAULT] log_format
New Option
None
None
[oslo_middleware] max_request_body_size
[nova] insecure
None
[nova] cafile
[nova] region_name
None
729
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
CHAPTER 10. OBJECT STORAGE
OpenStack Object Storage uses multiple configuration files for multiple services and background daemons, and paste.deploy to manage server configurations. Default configuration options appear in the [DEFAULT] section. You can override the default values by setting values in the other sections.
10.1. INTRODUCTION TO OBJECT STORAGE
Object Storage is a robust, highly scalable and fault tolerant storage platform for unstructured data such as objects. Objects are stored bits, accessed through a RESTful, HTTP-based interface. You cannot access data at the block or file level. Object Storage is commonly used to archive and back up data, with use cases in virtual machine image, photo, video and music storage.
Object Storage provides a high degree of availability, throughput, and performance with its scale out architecture. Each object is replicated across multiple servers, residing within the same data center or across data centers, which mitigates the risk of network and hardware failure. In the event of hardware failure, Object Storage will automatically copy objects to a new location to ensure that there are always three copies available. Object Storage is an eventually consistent distributed storage platform; it sacrifices consistency for maximum availability and partition tolerance. Object
Storage enables you to create a reliable platform by using commodity hardware and inexpensive storage.
10.2. OBJECT STORAGE GENERAL SERVICE CONFIGURATION
Most Object Storage services fall into two categories: Object Storage WSGI servers and background daemons.
Object Storage uses paste.deploy to manage server configurations. Read more at http://pythonpaste.org/deploy/ .
Default configuration options are set in the `[DEFAULT]` section, and any options specified there can be overridden in any of the other sections when the syntax set option_name = value is in place.
Configuration for servers and daemons can be expressed together in the same file for each type of server, or separately. If a required section for the service trying to start is missing, there will be an error. Sections not used by the service are ignored.
730
Consider the example of an Object Storage node. By convention configuration for the object-
server, object-updater, object-replicator, and object-auditor exist in a single file
/etc/swift/object-server.conf:
[DEFAULT]
[pipeline:main] pipeline = object-server
[app:object-server]
CHAPTER 10. OBJECT STORAGE
use = egg:swift#object
[object-replicator] reclaim_age = 259200
[object-updater]
[object-auditor]
Object Storage services expect a configuration path as the first argument:
$ swift-object-auditor
Usage: swift-object-auditor CONFIG [options]
Error: missing config path argument
If you omit the object-auditor section, this file cannot be used as the configuration path when starting the swift-object-auditor daemon:
$ swift-object-auditor /etc/swift/object-server.conf
Unable to find object-auditor config section in /etc/swift/objectserver.conf
If the configuration path is a directory instead of a file, all of the files in the directory with the file extension ".conf" will be combined to generate the configuration object which is delivered to the
Object Storage service. This is referred to generally as "directory-based configuration".
Directory-based configuration leverages ConfigParser's native multi-file support. Files ending in
".conf" in the given directory are parsed in lexicographical order. File names starting with '.' are ignored. A mixture of file and directory configuration paths is not supported - if the configuration path is a file, only that file will be parsed.
The Object Storage service management tool swift-init has adopted the convention of looking for /etc/swift/{type}-server.conf.d/ if the file /etc/swift/{type}-server.conf file does not exist.
When using directory-based configuration, if the same option under the same section appears more than once in different files, the last value parsed is said to override previous occurrences. You can ensure proper override precedence by prefixing the files in the configuration directory with numerical values, as in the following example file layout:
/etc/swift/
default.base
object-server.conf.d/
000_default.conf -> ../default.base
001_default-override.conf
010_server.conf
020_replicator.conf
030_updater.conf
040_auditor.conf
731
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
You can inspect the resulting combined configuration object using the swift-config commandline tool.
All the services of an Object Store deployment share a common configuration in the [swift-hash] section of the /etc/swift/swift.conf file. The swift_hash_path_suffix and
swift_hash_path_prefix values must be identical on all the nodes.
Table 10.1. Description of configuration options for [swift-hash] in swift.conf
Configuration option = Default value swift_hash_path_prefix
= changeme
swift_hash_path_suffix
= changeme
Description
A prefix used by hash_path to offer a bit more security when generating hashes for paths. It simply appends this value to all paths; if someone knows this suffix, it's easier for them to guess the hash a path will end up with. New installations are advised to set this parameter to a random secret, which would not be disclosed ouside the organization. The same secret needs to be used by all swift servers of the same cluster. Existing installations should set this parameter to an empty string.
A suffix used by hash_path to offer a bit more security when generating hashes for paths. It simply appends this value to all paths; if someone knows this suffix, it's easier for them to guess the hash a path will end up with. New installations are advised to set this parameter to a random secret, which would not be disclosed ouside the organization. The same secret needs to be used by all swift servers of the same cluster. Existing installations should set this parameter to an empty string.
732
10.3. OBJECT SERVER CONFIGURATION
Find an example object server configuration at etc/object-server.conf-sample in the source code repository.
The available configuration options are:
Table 10.2. Description of configuration options for [DEFAULT] in object-server.conf
Configuration option = Default value backlog
= 4096
Description
Maximum number of allowed pending TCP connections
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value Description
IP Address for server to bind to
bind_ip
= 0.0.0.0
bind_port
= 6000
bind_timeout
= 30
client_timeout
= 60
Port for server to bind to
Seconds to attempt bind before giving up
Timeout to read one chunk from a client external services
Connection timeout to external services
conn_timeout
= 0.5
devices
= /srv/node
disable_fallocate
= false
Parent directory of where devices are mounted
Disable "fast fail" fallocate checks if the underlying filesystem does not support it.
Size of chunks to read/write to disk
disk_chunk_size
= 65536
eventlet_debug
= false
expiring_objects_account_name
=
expiring_objects
If true, turn on debug logging for eventlet
No help text available for this option.
expiring_objects_container_divisor
= 86400
No help text available for this option.
fallocate_reserve
= 0
log_address log_facility
= LOG_LOCAL0
log_level
= INFO
log_max_line_length
= 0
log_name
= /dev/log
log_custom_handlers
= swift
=
You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server.
For most cases, this should be `egg:swift#object`.
Location where syslog sends the logs to
Comma-separated list of functions to call to setup custom log handlers.
Syslog log facility
Logging level
Caps the length of log lines to the value given; no limit if set to 0, the default.
Label used when logging
733
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description log_statsd_default_sample_rate
= 1.0 Defines the probability of sending a sample for any given event or timing measurement.
If not set, the StatsD feature is disabled.
log_statsd_host
= localhost
log_statsd_metric_prefix
= Value will be prepended to every metric sent to the
StatsD server.
log_statsd_port
= 8125
log_statsd_sample_rate_factor
= 1.0
log_udp_host mount_check
=
log_udp_port
= 514
max_clients
= 1024
= true
network_chunk_size node_timeout user
= swift
workers
= auto
= 3
swift_dir
= /etc/swift
= 65536
Port value for the StatsD server.
Not recommended to set this to a value less than
1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead.
If not set, the UDP receiver for syslog is disabled.
Port value for UDP receiver, if enabled.
Maximum number of clients one worker can process simultaneously Lowering the number of clients handled per worker, and raising the number of workers can lessen the impact that a CPU intensive, or blocking, request can have on other requests served by the same worker. If the maximum number of clients is set to one, then a given worker will not perform another call while processing, allowing other workers a chance to process it.
Whether or not check if the devices are mounted to prevent accidentally writing to the root device
Size of chunks to read/write over the network
Request timeout to external services
Swift configuration directory
User to run as a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
Table 10.3. Description of configuration options for [app-object-server] in objectserver.conf
734
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value Description allowed_headers
= Content-Disposition,
Content-Encoding, X-Delete-At, X-Object-Manifest,
X-Static-Large-Object
Comma-separated list of headers that can be set in metadata of an object
Prefix to use when automatically creating accounts
auto_create_account_prefix
= .
keep_cache_private
= false Allow non-public objects to stay in kernel's buffer cache
keep_cache_size
= 5242880
max_upload_time
= 86400
mb_per_sync
= 512
replication_concurrency
= 4
replication_failure_ratio replication_server set log_address
= false
= /dev/log
set log_facility
= LOG_LOCAL0
set log_level
= INFO
set log_name
= object-server
= 1.0
replication_failure_threshold replication_lock_timeout
= 15
replication_one_per_device
= 100
= True
Largest object size to keep in buffer cache
Maximum time allowed to upload an object
On PUT requests, sync file every n MB
Set to restrict the number of concurrent incoming
REPLICATION requests; set to 0 for unlimited
If the value of failures / successes of
REPLICATION subrequests exceeds this ratio, the overall REPLICATION request will be aborted
The number of subrequest failures before the replication_failure_ratio is checked
Number of seconds to wait for an existing replication device lock before giving up.
Restricts incoming REPLICATION requests to one per device, replication_currency above allowing.
This can help control I/O to each device, but you may wish to set this to False to allow multiple
REPLICATION requests (up to the above replication_concurrency setting) per device.
If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to
False, replication verbs will be rejected. When undefined, server will accept any verb in the request.
Location where syslog sends the logs to
Syslog log facility
Log level
Label to use when logging
735
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value set log_requests
= true
slow
= 0
splice use
= no
threads_per_disk
= egg:swift#object
= 0
Description
Whether or not to log requests
If > 0, Minimum time in seconds for a PUT or
DELETE request to complete
No help text available for this option.
Size of the per-disk thread pool used for performing disk I/O. The default of 0 means to not use a perdisk thread pool. It is recommended to keep this value small, as large values can result in high read latencies due to large queue depths. A good starting point is 4 threads per disk.
Entry point of paste.deploy in the server
Table 10.4. Description of configuration options for [pipeline-main] in objectserver.conf
Configuration option = Default value pipeline
= healthcheck recon object-server
Description
No help text available for this option.
Table 10.5. Description of configuration options for [object-replicator] in objectserver.conf
Configuration option = Default value concurrency
= 1
daemonize
= on
handoff_delete
= auto
handoffs_first
= False
Description
Number of replication workers to spawn
Whether or not to run replication as a daemon
By default handoff partitions will be removed when it has successfully replicated to all the canonical nodes. If set to an integer n, it will remove the partition if it is successfully replicated to n nodes.
The default setting should not be changed, except for extremem situations. This uses what's set here, or what's set in the DEFAULT section, or 10
(though other sections use 3 as the final default).
If set to True, partitions that are not supposed to be on the node will be replicated first. The default setting should not be changed, except for extreme situations.
736
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value http_timeout
= 60
lockup_timeout
= 1800
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= object-replicator
node_timeout
= <whatever's in the DEFAULT
section or 10>
reclaim_age
= 604800
Description
Maximum duration for an HTTP request
Attempts to kill all workers if nothing replications for lockup_timeout seconds
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
Request timeout to external services
recon_cache_path rsync_io_timeout rsync_timeout run_pause
= 30
stats_interval sync_method vm_test_mode
= no
= /var/cache/swift
ring_check_interval
= 15
rsync_bwlimit
= 0
rsync_error_log_line_length
= 30
= 900
= 300
= rsync
= 0
Time elapsed in seconds before an object can be reclaimed
Directory where stats for a few items will be stored
How often (in seconds) to check the ring
No help text available for this option.
No help text available for this option.
Passed to rsync for a max duration (seconds) of an
I/O op
Max duration (seconds) of a partition rsync
Time in seconds to wait between replication passes
Interval in seconds between logging replication statistics
No help text available for this option.
Indicates that you are using a VM environment
Table 10.6. Description of configuration options for [object-updater] in objectserver.conf
737
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value concurrency
= 1
interval
= 300
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= object-updater
node_timeout
= <whatever's in the DEFAULT
section or 10>
recon_cache_path
= /var/cache/swift
slowdown
= 0.01
Description
Number of replication workers to spawn
Minimum time for a pass to take
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
Request timeout to external services
Directory where stats for a few items will be stored
Time in seconds to wait between objects
Table 10.7. Description of configuration options for [object-auditor] in objectserver.conf
Configuration option = Default value bytes_per_second
= 10000000
concurrency
= 1
disk_chunk_size
= 65536
Description
Maximum bytes audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests. underlying filesystem does not support it. to setup custom log handlers.
bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early.
container server. For most cases, this should be
`egg:swift#container`.
Number of replication workers to spawn
Size of chunks to read/write to disk
738
Configuration option = Default value files_per_second
= 20
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= object-auditor
log_time
= 3600
object_size_stats
=
recon_cache_path
= /var/cache/swift
zero_byte_files_per_second
= 50
CHAPTER 10. OBJECT STORAGE
Description
Maximum files audited per second. Should be tuned according to individual system specs. 0 is unlimited.
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
Frequency of status logs in seconds.
No help text available for this option.
Directory where stats for a few items will be stored
Maximum zero byte files audited per second.
Table 10.8. Description of configuration options for [filter-healthcheck] in objectserver.conf
Configuration option = Default value disable_path
=
use
= egg:swift#healthcheck
Description
No help text available for this option.
Entry point of paste.deploy in the server
Table 10.9. Description of configuration options for [filter-recon] in objectserver.conf
Configuration option = Default value recon_cache_path
= /var/cache/swift
recon_lock_path
= /var/lock
use
= egg:swift#recon
Description
Directory where stats for a few items will be stored
No help text available for this option.
Entry point of paste.deploy in the server
Table 10.10. Description of configuration options for [filter-xprofile] in objectserver.conf
739
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value dump_interval
= 5.0
dump_timestamp
= false
flush_at_shutdown
= false
log_filename_prefix
=
/tmp/log/swift/profile/default.profile
path
= /__profile__
profile_module
= eventlet.green.profile
unwind
= false
use
= egg:swift#xprofile
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Entry point of paste.deploy in the server
740
10.3.1. Sample object server configuration file
[DEFAULT]
# bind_ip = 0.0.0.0
bind_port = 6000
# bind_timeout = 30
# backlog = 4096
# user = swift
# swift_dir = /etc/swift
# devices = /srv/node
# mount_check = true
# disable_fallocate = false
# expiring_objects_container_divisor = 86400
# expiring_objects_account_name = expiring_objects
#
# Use an integer to override the number of pre-forked processes that will
# accept connections.
# workers = auto
#
# Maximum concurrent requests per worker
# max_clients = 1024
#
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
# The following caps the length of log lines to the value given; no limit if
# set to 0, the default.
# log_max_line_length = 0
#
# comma separated list of functions to call to setup custom log handlers.
CHAPTER 10. OBJECT STORAGE
# functions get passed: conf, name, log_to_console, log_route, fmt, logger,
# adapted_logger
# log_custom_handlers =
#
# If set, log_udp_host will override log_address
# log_udp_host =
# log_udp_port = 514
#
# You can enable StatsD logging here:
# log_statsd_host = localhost
# log_statsd_port = 8125
# log_statsd_default_sample_rate = 1.0
# log_statsd_sample_rate_factor = 1.0
# log_statsd_metric_prefix =
#
# eventlet_debug = false
#
# You can set fallocate_reserve to the number of bytes you'd like fallocate to
# reserve, whether there is space for the given file size or not.
# fallocate_reserve = 0
#
# Time to wait while attempting to connect to another backend node.
# conn_timeout = 0.5
# Time to wait while sending each chunk of data to another backend node.
# node_timeout = 3
# Time to wait while receiving each chunk of data from a client or another
# backend node.
# client_timeout = 60
#
# network_chunk_size = 65536
# disk_chunk_size = 65536
[pipeline:main] pipeline = healthcheck recon object-server
[app:object-server] use = egg:swift#object
# You can override the default log routing for this app here:
# set log_name = object-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_requests = true
# set log_address = /dev/log
#
# max_upload_time = 86400
# slow = 0
#
# Objects smaller than this are not evicted from the buffercache once read
# keep_cache_size = 5242880
#
# If true, objects for authenticated GET requests may be kept in buffer cache
741
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# if small enough
# keep_cache_private = false
#
# on PUTs, sync data every n MB
# mb_per_sync = 512
#
# Comma separated list of headers that can be set in metadata on an object.
# This list is in addition to X-Object-Meta-* headers and cannot include
# Content-Type, etag, Content-Length, or deleted
# allowed_headers = Content-Disposition, Content-Encoding, X-Delete-At,
X-Object-Manifest, X-Static-Large-Object
#
# auto_create_account_prefix = .
#
# A value of 0 means "don't use thread pools". A reasonable starting point is
# 4.
# threads_per_disk = 0
#
# Configure parameter for creating specific server
# To handle all verbs, including replication verbs, do not specify
# "replication_server" (this is the default). To only handle replication,
# set to a True value (e.g. "True" or "1"). To handle only nonreplication
# verbs, set to "False". Unless you have a separate replication network, you
# should not specify any value for "replication_server".
# replication_server = false
#
# Set to restrict the number of concurrent incoming REPLICATION requests
# Set to 0 for unlimited
# Note that REPLICATION is currently an ssync only item
# replication_concurrency = 4
#
# Restricts incoming REPLICATION requests to one per device,
# replication_currency above allowing. This can help control I/O to each
# device, but you may wish to set this to False to allow multiple
REPLICATION
# requests (up to the above replication_concurrency setting) per device.
# replication_one_per_device = True
#
# Number of seconds to wait for an existing replication device lock before
# giving up.
# replication_lock_timeout = 15
#
# These next two settings control when the REPLICATION subrequest handler will
# abort an incoming REPLICATION attempt. An abort will occur if there are at
# least threshold number of failures and the value of failures / successes
# exceeds the ratio. The defaults of 100 and 1.0 means that at least 100
# failures have to occur and there have to be more failures than successes for
742
CHAPTER 10. OBJECT STORAGE
# an abort to occur.
# replication_failure_threshold = 100
# replication_failure_ratio = 1.0
#
# Use splice() for zero-copy object GETs. This requires Linux kernel
# version 3.0 or greater. If you set "splice = yes" but the kernel
# does not support it, error messages will appear in the object server
# logs at startup, but your object servers should continue to function.
#
# splice = no
[filter:healthcheck] use = egg:swift#healthcheck
# An optional filesystem path, which if present, will cause the healthcheck
# URL to return "503 Service Unavailable" with a body of "DISABLED BY
FILE"
# disable_path =
[filter:recon] use = egg:swift#recon
#recon_cache_path = /var/cache/swift
#recon_lock_path = /var/lock
[object-replicator]
# You can override the default log routing for this app here (don't use set!):
# log_name = object-replicator
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# vm_test_mode = no
# daemonize = on
# run_pause = 30
# concurrency = 1
# stats_interval = 300
#
# The sync method to use; default is rsync but you can use ssync to try the
# EXPERIMENTAL all-swift-code-no-rsync-callouts method. Once ssync is verified
# as having performance comparable to, or better than, rsync, we plan to
# deprecate rsync so we can move on with more features for replication.
# sync_method = rsync
#
# max duration of a partition rsync
# rsync_timeout = 900
#
# bandwidth limit for rsync in kB/s. 0 means unlimited
# rsync_bwlimit = 0
#
# passed to rsync for io op timeout
# rsync_io_timeout = 30
#
# node_timeout = <whatever's in the DEFAULT section or 10>
743
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# max duration of an http request; this is for REPLICATE finalization calls and
# so should be longer than node_timeout
# http_timeout = 60
#
# attempts to kill all workers if nothing replicates for lockup_timeout seconds
# lockup_timeout = 1800
#
# The replicator also performs reclamation
# reclaim_age = 604800
#
# ring_check_interval = 15
# recon_cache_path = /var/cache/swift
#
# limits how long rsync error log lines are
# 0 means to log the entire line
# rsync_error_log_line_length = 0
#
# handoffs_first and handoff_delete are options for a special case
# such as disk full in the cluster. These two options SHOULD NOT BE
# CHANGED, except for such an extreme situations. (e.g. disks filled up
# or are about to fill up. Anyway, DO NOT let your drives fill up)
# handoffs_first is the flag to replicate handoffs prior to canonical
# partitions. It allows to force syncing and deleting handoffs quickly.
# If set to a True value(e.g. "True" or "1"), partitions
# that are not supposed to be on the node will be replicated first.
# handoffs_first = False
#
# handoff_delete is the number of replicas which are ensured in swift.
# If the number less than the number of replicas is set, objectreplicator
# could delete local handoffs even if all replicas are not ensured in the
# cluster. Object-replicator would remove local handoff partition directories
# after syncing partition when the number of successful responses is greater
# than or equal to this number. By default(auto), handoff partitions will be
# removed when it has successfully replicated to all the canonical nodes.
# handoff_delete = auto
[object-reconstructor]
# You can override the default log routing for this app here (don't use set!):
# Unless otherwise noted, each setting below has the same meaning as described
# in the [object-replicator] section, however these settings apply to the
EC
# reconstructor
#
# log_name = object-reconstructor
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
744
CHAPTER 10. OBJECT STORAGE
#
# daemonize = on
# run_pause = 30
# concurrency = 1
# stats_interval = 300
# node_timeout = 10
# http_timeout = 60
# lockup_timeout = 1800
# reclaim_age = 604800
# ring_check_interval = 15
# recon_cache_path = /var/cache/swift
# handoffs_first = False
[object-updater]
# You can override the default log routing for this app here (don't use set!):
# log_name = object-updater
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# interval = 300
# concurrency = 1
# node_timeout = <whatever's in the DEFAULT section or 10>
# slowdown will sleep that amount between objects
# slowdown = 0.01
#
# recon_cache_path = /var/cache/swift
[object-auditor]
# You can override the default log routing for this app here (don't use set!):
# log_name = object-auditor
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# You can set the disk chunk size that the auditor uses making it larger if
# you like for more efficient local auditing of larger objects
# disk_chunk_size = 65536
# files_per_second = 20
# concurrency = 1
# bytes_per_second = 10000000
# log_time = 3600
# zero_byte_files_per_second = 50
# recon_cache_path = /var/cache/swift
# Takes a comma separated list of ints. If set, the object auditor will
# increment a counter for every object whose size is <= to the given break
# points and report the result after a full scan.
# object_size_stats =
# Note: Put it at the beginning of the pipleline to profile all middleware. But
745
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# it is safer to put this after healthcheck.
[filter:xprofile] use = egg:swift#xprofile
# This option enable you to switch profilers which should inherit from python
# standard profiler. Currently the supported value can be 'cProfile',
# 'eventlet.green.profile' etc.
# profile_module = eventlet.green.profile
#
# This prefix will be used to combine process ID and timestamp to name the
# profile data file. Make sure the executing user has permission to write
# into this path (missing path segments will be created, if necessary).
# If you enable profiling in more than one type of daemon, you must override
# it with an unique value like: /var/log/swift/profile/object.profile
# log_filename_prefix = /tmp/log/swift/profile/default.profile
#
# the profile data will be dumped to local disk based on above naming rule
# in this interval.
# dump_interval = 5.0
#
# Be careful, this option will enable profiler to dump data into the file with
# time stamp which means there will be lots of files piled up in the directory.
# dump_timestamp = false
#
# This is the path of the URL to access the mini web UI.
# path = /__profile__
#
# Clear the data when the wsgi server shutdown.
# flush_at_shutdown = false
#
# unwind the iterator of applications
# unwind = false
10.4. OBJECT EXPIRER CONFIGURATION
Find an example object expirer configuration at etc/object-expirer.conf-sample in the source code repository.
The available configuration options are:
Table 10.11. Description of configuration options for [DEFAULT] in object-expirer.conf
Configuration option = Default value log_address
= /dev/log
Description
Location where syslog sends the logs to
746
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value log_custom_handlers
=
Description
Comma-separated list of functions to call to setup custom log handlers.
Syslog log facility
log_facility
= LOG_LOCAL0
log_level
= INFO
log_max_line_length
= 0
Logging level
Caps the length of log lines to the value given; no limit if set to 0, the default.
log_name
= swift Label used when logging
log_statsd_default_sample_rate
= 1.0 Defines the probability of sending a sample for any given event or timing measurement.
log_statsd_host
= localhost
log_statsd_metric_prefix
=
log_statsd_port log_statsd_sample_rate_factor log_udp_host log_udp_port swift_dir user
= swift
=
= 8125
= 514
= /etc/swift
= 1.0
If not set, the StatsD feature is disabled.
Value will be prepended to every metric sent to the
StatsD server.
Port value for the StatsD server.
Not recommended to set this to a value less than
1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead.
If not set, the UDP receiver for syslog is disabled.
Port value for UDP receiver, if enabled.
Swift configuration directory
User to run as
Table 10.12. Description of configuration options for [app-proxy-server] in objectexpirer.conf
Configuration option = Default value use
= egg:swift#proxy
Description
Entry point of paste.deploy in the server
Table 10.13. Description of configuration options for [filter-cache] in objectexpirer.conf
747
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value use
= egg:swift#memcache
Description
Entry point of paste.deploy in the server
Table 10.14. Description of configuration options for [filter-catch_errors] in objectexpirer.conf
Configuration option = Default value use
= egg:swift#catch_errors
Description
Entry point of paste.deploy in the server
Table 10.15. Description of configuration options for [filter-proxy-logging] in objectexpirer.conf
Configuration option = Default value Description access_log_address
= /dev/log
access_log_facility
= LOG_LOCAL0
access_log_headers
= false
access_log_headers_only
=
No help text available for this option.
No help text available for this option.
No help text available for this option.
If access_log_headers is True and access_log_headers_only is set only these headers are logged. Multiple headers can be defined as comma separated list like this: access_log_headers_only = Host, X-Object-Meta-
Mtime
access_log_level
= INFO
access_log_name
= swift
No help text available for this option.
No help text available for this option.
access_log_statsd_default_sample_r ate
= 1.0
access_log_statsd_host
= localhost
No help text available for this option.
No help text available for this option.
access_log_statsd_metric_prefix
= No help text available for this option.
access_log_statsd_port
= 8125
access_log_statsd_sample_rate_fact or
= 1.0
No help text available for this option.
No help text available for this option.
access_log_udp_host
= No help text available for this option.
748
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value Description access_log_udp_port
= 514 No help text available for this option.
log_statsd_valid_http_methods
=
GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS
No help text available for this option.
No help text available for this option.
logged with access_log_headers
=
True.
reveal_sensitive_prefix
= 16
use
= egg:swift#proxy_logging
The X-Auth-Token is sensitive data. If revealed to an unauthorised person, they can now make requests against an account until the token expires. Set reveal_sensitive_prefix to the number of characters of the token that are logged. For example reveal_sensitive_prefix = 12 so only first
12 characters of the token are logged. Or, set to 0 to completely remove the token.
Entry point of paste.deploy in the server
Table 10.16. Description of configuration options for [object-expirer] in objectexpirer.conf
Configuration option = Default value auto_create_account_prefix
= .
concurrency
= 1
expiring_objects_account_name
=
expiring_objects
interval
= 300
process
= 0
Description
Prefix to use when automatically creating accounts
Number of replication workers to spawn
No help text available for this option.
processes
= 0
reclaim_age
= 604800
recon_cache_path report_interval
= /var/cache/swift
= 300
Minimum time for a pass to take
(it will actually accept(2) N + 1). Setting this to one
(1) will only handle one request at a time, without accepting another request concurrently.
No help text available for this option.
Time elapsed in seconds before an object can be reclaimed
Directory where stats for a few items will be stored
No help text available for this option.
749
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 10.17. Description of configuration options for [pipeline-main] in objectexpirer.conf
Configuration option = Default value pipeline
= catch_errors proxy-logging cache
proxy-server
Description
No help text available for this option.
750
10.4.1. Sample object expirer configuration file
[DEFAULT]
# swift_dir = /etc/swift
# user = swift
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
# The following caps the length of log lines to the value given; no limit if
# set to 0, the default.
# log_max_line_length = 0
#
# comma separated list of functions to call to setup custom log handlers.
# functions get passed: conf, name, log_to_console, log_route, fmt, logger,
# adapted_logger
# log_custom_handlers =
#
# If set, log_udp_host will override log_address
# log_udp_host =
# log_udp_port = 514
#
# You can enable StatsD logging here:
# log_statsd_host = localhost
# log_statsd_port = 8125
# log_statsd_default_sample_rate = 1.0
# log_statsd_sample_rate_factor = 1.0
# log_statsd_metric_prefix =
[object-expirer]
# interval = 300
# auto_create_account_prefix = .
# expiring_objects_account_name = expiring_objects
# report_interval = 300
# concurrency is the level of concurrency o use to do the work, this value
# must be set to at least 1
# concurrency = 1
# processes is how many parts to divide the work into, one part per process
# that will be doing the work
# processes set 0 means that a single process will be doing all the work
CHAPTER 10. OBJECT STORAGE
# processes can also be specified on the command line and will override the
# config value
# processes = 0
# process is which of the parts a particular process will work on
# process can also be specified on the command line and will overide the config
# value
# process is "zero based", if you want to use 3 processes, you should run
# processes with process set to 0, 1, and 2
# process = 0
# The expirer will re-attempt expiring if the source object is not available
# up to reclaim_age seconds before it gives up and deletes the entry in the
# queue.
# reclaim_age = 604800
# recon_cache_path = /var/cache/swift
[pipeline:main] pipeline = catch_errors proxy-logging cache proxy-server
[app:proxy-server] use = egg:swift#proxy
# See proxy-server.conf-sample for options
[filter:cache] use = egg:swift#memcache
# See proxy-server.conf-sample for options
[filter:catch_errors] use = egg:swift#catch_errors
# See proxy-server.conf-sample for options
[filter:proxy-logging] use = egg:swift#proxy_logging
# If not set, logging directives from [DEFAULT] without "access_" will be used
# access_log_name = swift
# access_log_facility = LOG_LOCAL0
# access_log_level = INFO
# access_log_address = /dev/log
#
# If set, access_log_udp_host will override access_log_address
# access_log_udp_host =
# access_log_udp_port = 514
#
# You can use log_statsd_* from [DEFAULT] or override them here:
# access_log_statsd_host = localhost
# access_log_statsd_port = 8125
# access_log_statsd_default_sample_rate = 1.0
# access_log_statsd_sample_rate_factor = 1.0
# access_log_statsd_metric_prefix =
# access_log_headers = false
#
# If access_log_headers is True and access_log_headers_only is set only
751
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# these headers are logged. Multiple headers can be defined as comma separated
# list like this: access_log_headers_only = Host, X-Object-Meta-Mtime
# access_log_headers_only =
#
# By default, the X-Auth-Token is logged. To obscure the value,
# set reveal_sensitive_prefix to the number of characters to log.
# For example, if set to 12, only the first 12 characters of the
# token appear in the log. An unauthorized access of the log file
# won't allow unauthorized usage of the token. However, the first
# 12 or so characters is unique enough that you can trace/debug
# token usage. Set to 0 to suppress the token completely (replaced
# by '...' in the log).
# Note: reveal_sensitive_prefix will not affect the value
# logged with access_log_headers=True.
# reveal_sensitive_prefix = 16
#
# What HTTP methods are allowed for StatsD logging (comma-sep); request methods
# not in this list will have "BAD_METHOD" for the <verb> portion of the metric.
# log_statsd_valid_http_methods = GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS
10.5. CONTAINER SERVER CONFIGURATION
Find an example container server configuration at etc/container-server.conf-sample in the source code repository.
The available configuration options are:
Table 10.18. Description of configuration options for [DEFAULT] in containerserver.conf
Configuration option = Default value allowed_sync_hosts
= 127.0.0.1
backlog
= 4096
bind_ip
= 0.0.0.0
bind_port
= 6001
bind_timeout
= 30
Description
No help text available for this option.
Maximum number of allowed pending TCP connections
IP Address for server to bind to
Port for server to bind to
Seconds to attempt bind before giving up
752
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value db_preallocation
= off
devices
= /srv/node
disable_fallocate eventlet_debug
= false
fallocate_reserve log_address
= /dev/log
log_custom_handlers log_facility log_level
= false
= 0
=
= LOG_LOCAL0
= INFO
log_max_line_length
= 0
Description
If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server.
For most cases, this should be `egg:swift#account`.
replication passes account can be reclaimed
Parent directory of where devices are mounted
Disable "fast fail" fallocate checks if the underlying filesystem does not support it.
If true, turn on debug logging for eventlet
You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server.
For most cases, this should be `egg:swift#object`.
Location where syslog sends the logs to
Comma-separated list of functions to call to setup custom log handlers.
Syslog log facility
Logging level
Caps the length of log lines to the value given; no limit if set to 0, the default.
log_name
= swift Label used when logging
log_statsd_default_sample_rate
= 1.0 Defines the probability of sending a sample for any given event or timing measurement.
log_statsd_host
= localhost
log_statsd_metric_prefix
=
If not set, the StatsD feature is disabled.
Value will be prepended to every metric sent to the
StatsD server.
753
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value log_statsd_port
= 8125
log_statsd_sample_rate_factor
= 1.0
log_udp_host swift_dir user
= swift
= /etc/swift
workers
= auto
=
log_udp_port
= 514
max_clients
= 1024
mount_check
= true
Description
Port value for the StatsD server.
Not recommended to set this to a value less than
1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead.
If not set, the UDP receiver for syslog is disabled.
Port value for UDP receiver, if enabled.
Maximum number of clients one worker can process simultaneously Lowering the number of clients handled per worker, and raising the number of workers can lessen the impact that a CPU intensive, or blocking, request can have on other requests served by the same worker. If the maximum number of clients is set to one, then a given worker will not perform another call while processing, allowing other workers a chance to process it.
Whether or not check if the devices are mounted to prevent accidentally writing to the root device
Swift configuration directory
User to run as a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
Table 10.19. Description of configuration options for [app-container-server] in container-server.conf
Configuration option = Default value allow_versions
= false
auto_create_account_prefix
= .
conn_timeout
= 0.5
node_timeout
= 3
Description
Enable/Disable object versioning feature
Prefix to use when automatically creating accounts
Connection timeout to external services
Request timeout to external services
754
Configuration option = Default value replication_server
= false
set log_address
= /dev/log
set log_facility
= LOG_LOCAL0
set log_level
= INFO
set log_name
= container-server
set log_requests
= true
use
= egg:swift#container
CHAPTER 10. OBJECT STORAGE
Description
If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to
False, replication verbs will be rejected. When undefined, server will accept any verb in the request.
Location where syslog sends the logs to
Syslog log facility
Log level
Label to use when logging
Whether or not to log requests
Entry point of paste.deploy in the server
Table 10.20. Description of configuration options for [pipeline-main] in containerserver.conf
Configuration option = Default value pipeline
= healthcheck recon container-server
Description
No help text available for this option.
Table 10.21. Description of configuration options for [container-replicator] in container-server.conf
Configuration option = Default value concurrency
= 8
conn_timeout
= 0.5
interval
= 30
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= container-replicator
Description
Number of replication workers to spawn
Connection timeout to external services
Minimum time for a pass to take
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
755
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value max_diffs
= 100
node_timeout
= 10
per_diff
= 1000
reclaim_age
= 604800
recon_cache_path run_pause
= 30
vm_test_mode
= no
= /var/cache/swift
Description
Caps how long the replicator spends trying to sync a database per pass
Request timeout to external services
Limit number of items to get per diff
Time elapsed in seconds before an object can be reclaimed
Directory where stats for a few items will be stored
Time in seconds to wait between replication passes
Indicates that you are using a VM environment
Table 10.22. Description of configuration options for [container-updater] in containerserver.conf
Configuration option = Default value account_suppression_time
= 60
concurrency conn_timeout interval log_address log_facility slowdown
= 4
= 300
= 0.5
= /dev/log
= LOG_LOCAL0
log_level
= INFO
log_name
= container-updater
node_timeout
= 3
recon_cache_path
= 0.01
= /var/cache/swift
Description
Seconds to suppress updating an account that has generated an error (timeout, not yet found, etc.)
Number of replication workers to spawn
Connection timeout to external services
Minimum time for a pass to take
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
Request timeout to external services
Directory where stats for a few items will be stored
Time in seconds to wait between objects
756
Table 10.23. Description of configuration options for [container-auditor] in containerserver.conf
Configuration option = Default value containers_per_second
= 200
interval
= 1800
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= container-auditor
recon_cache_path
= /var/cache/swift
CHAPTER 10. OBJECT STORAGE
Description
Maximum containers audited per second. Should be tuned according to individual system specs. 0 is unlimited. mounted to prevent accidentally writing to the root device process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
Minimum time for a pass to take
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
Directory where stats for a few items will be stored
Table 10.24. Description of configuration options for [container-sync] in containerserver.conf
Configuration option = Default value conn_timeout
= 5
container_time
= 60
internal_client_conf_path
=
/etc/swift/internal-client.conf
interval
= 300
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= container-sync
Description
Connection timeout to external services
Maximum amount of time to spend syncing each container
No help text available for this option.
Minimum time for a pass to take
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
757
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value request_tries
= 3
sync_proxy
=
http://10.1.1.1:8888,http://10.1.1.2:8888
Description
No help text available for this option.
If you need to use an HTTP proxy, set it here.
Defaults to no proxy.
Table 10.25. Description of configuration options for [filter-healthcheck] in container-server.conf
Configuration option = Default value disable_path
=
use
= egg:swift#healthcheck
Description
No help text available for this option.
Entry point of paste.deploy in the server
Table 10.26. Description of configuration options for [filter-recon] in containerserver.conf
Configuration option = Default value recon_cache_path
= /var/cache/swift
use
= egg:swift#recon
Description
Directory where stats for a few items will be stored
Entry point of paste.deploy in the server
Table 10.27. Description of configuration options for [filter-xprofile] in containerserver.conf
Configuration option = Default value dump_interval
= 5.0
dump_timestamp
= false
flush_at_shutdown
= false
log_filename_prefix
=
/tmp/log/swift/profile/default.profile
path
= /__profile__
profile_module
= eventlet.green.profile
unwind
= false
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
758
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value use
= egg:swift#xprofile
Description
Entry point of paste.deploy in the server
10.5.1. Sample container server configuration file
[DEFAULT]
# bind_ip = 0.0.0.0
bind_port = 6001
# bind_timeout = 30
# backlog = 4096
# user = swift
# swift_dir = /etc/swift
# devices = /srv/node
# mount_check = true
# disable_fallocate = false
#
# Use an integer to override the number of pre-forked processes that will
# accept connections.
# workers = auto
#
# Maximum concurrent requests per worker
# max_clients = 1024
#
# This is a comma separated list of hosts allowed in the X-Container-
Sync-To
# field for containers. This is the old-style of using container sync. It is
# strongly recommended to use the new style of a separate
# container-sync-realms.conf -- see container-sync-realms.conf-sample
# allowed_sync_hosts = 127.0.0.1
#
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
# The following caps the length of log lines to the value given; no limit if
# set to 0, the default.
# log_max_line_length = 0
#
# comma separated list of functions to call to setup custom log handlers.
# functions get passed: conf, name, log_to_console, log_route, fmt, logger,
# adapted_logger
# log_custom_handlers =
#
# If set, log_udp_host will override log_address
# log_udp_host =
# log_udp_port = 514
#
# You can enable StatsD logging here:
# log_statsd_host = localhost
759
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# log_statsd_port = 8125
# log_statsd_default_sample_rate = 1.0
# log_statsd_sample_rate_factor = 1.0
# log_statsd_metric_prefix =
#
# If you don't mind the extra disk space usage in overhead, you can turn this
# on to preallocate disk space with SQLite databases to decrease fragmentation.
# db_preallocation = off
#
# eventlet_debug = false
#
# You can set fallocate_reserve to the number of bytes you'd like fallocate to
# reserve, whether there is space for the given file size or not.
# fallocate_reserve = 0
[pipeline:main] pipeline = healthcheck recon container-server
[app:container-server] use = egg:swift#container
# You can override the default log routing for this app here:
# set log_name = container-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_requests = true
# set log_address = /dev/log
#
# node_timeout = 3
# conn_timeout = 0.5
# allow_versions = false
# auto_create_account_prefix = .
#
# Configure parameter for creating specific server
# To handle all verbs, including replication verbs, do not specify
# "replication_server" (this is the default). To only handle replication,
# set to a True value (e.g. "True" or "1"). To handle only nonreplication
# verbs, set to "False". Unless you have a separate replication network, you
# should not specify any value for "replication_server".
# replication_server = false
[filter:healthcheck] use = egg:swift#healthcheck
# An optional filesystem path, which if present, will cause the healthcheck
# URL to return "503 Service Unavailable" with a body of "DISABLED BY
FILE"
# disable_path =
[filter:recon] use = egg:swift#recon
#recon_cache_path = /var/cache/swift
760
CHAPTER 10. OBJECT STORAGE
[container-replicator]
# You can override the default log routing for this app here (don't use set!):
# log_name = container-replicator
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# vm_test_mode = no
# per_diff = 1000
# max_diffs = 100
# concurrency = 8
# interval = 30
# node_timeout = 10
# conn_timeout = 0.5
#
# The replicator also performs reclamation
# reclaim_age = 604800
#
# Time in seconds to wait between replication passes
# Note: if the parameter 'interval' is defined then it will be used in place
# of run_pause.
# run_pause = 30
#
# recon_cache_path = /var/cache/swift
[container-updater]
# You can override the default log routing for this app here (don't use set!):
# log_name = container-updater
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# interval = 300
# concurrency = 4
# node_timeout = 3
# conn_timeout = 0.5
#
# slowdown will sleep that amount between containers
# slowdown = 0.01
#
# Seconds to suppress updating an account that has generated an error
# account_suppression_time = 60
#
# recon_cache_path = /var/cache/swift
[container-auditor]
# You can override the default log routing for this app here (don't use set!):
# log_name = container-auditor
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
761
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#
# Will audit each container at most once per interval
# interval = 1800
#
# containers_per_second = 200
# recon_cache_path = /var/cache/swift
[container-sync]
# You can override the default log routing for this app here (don't use set!):
# log_name = container-sync
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# If you need to use an HTTP Proxy, set it here; defaults to no proxy.
# You can also set this to a comma separated list of HTTP Proxies and they will
# be randomly used (simple load balancing).
# sync_proxy = http://10.1.1.1:8888,http://10.1.1.2:8888
#
# Will sync each container at most once per interval
# interval = 300
#
# Maximum amount of time to spend syncing each container per pass
# container_time = 60
#
# Maximum amount of time in seconds for the connection attempt
# conn_timeout = 5
# Server errors from requests will be retried by default
# request_tries = 3
#
# Internal client config file path
# internal_client_conf_path = /etc/swift/internal-client.conf
# Note: Put it at the beginning of the pipeline to profile all middleware. But
# it is safer to put this after healthcheck.
[filter:xprofile] use = egg:swift#xprofile
# This option enable you to switch profilers which should inherit from python
# standard profiler. Currently the supported value can be 'cProfile',
# 'eventlet.green.profile' etc.
# profile_module = eventlet.green.profile
#
# This prefix will be used to combine process ID and timestamp to name the
# profile data file. Make sure the executing user has permission to write
# into this path (missing path segments will be created, if necessary).
# If you enable profiling in more than one type of daemon, you must override
# it with an unique value like: /var/log/swift/profile/container.profile
# log_filename_prefix = /tmp/log/swift/profile/default.profile
#
762
CHAPTER 10. OBJECT STORAGE
# the profile data will be dumped to local disk based on above naming rule
# in this interval.
# dump_interval = 5.0
#
# Be careful, this option will enable profiler to dump data into the file with
# time stamp which means there will be lots of files piled up in the directory.
# dump_timestamp = false
#
# This is the path of the URL to access the mini web UI.
# path = /__profile__
#
# Clear the data when the wsgi server shutdown.
# flush_at_shutdown = false
#
# unwind the iterator of applications
# unwind = false
10.6. CONTAINER SYNC REALMS CONFIGURATION
Find an example container sync realms configuration at etc/container-sync-realms.conf-
sample in the source code repository.
The available configuration options are:
Table 10.28. Description of configuration options for [DEFAULT] in container-syncrealms.conf
Configuration option = Default value mtime_check_interval
= 300
Description
No help text available for this option.
Table 10.29. Description of configuration options for [realm1] in container-syncrealms.conf
Configuration option = Default value cluster_name1
= https://host1/v1/
cluster_name2
= https://host2/v1/
key
= realm1key
key2
= realm1key2
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
763
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 10.30. Description of configuration options for [realm2] in container-syncrealms.conf
Configuration option = Default value cluster_name3
= https://host3/v1/
cluster_name4
= https://host4/v1/
key
= realm2key
key2
= realm2key2
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
764
10.6.1. Sample container sync realms configuration file
# [DEFAULT]
# The number of seconds between checking the modified time of this config file
# for changes and therefore reloading it.
# mtime_check_interval = 300
# [realm1]
# key = realm1key
# key2 = realm1key2
# cluster_name1 = https://host1/v1/
# cluster_name2 = https://host2/v1/
#
# [realm2]
# key = realm2key
# key2 = realm2key2
# cluster_name3 = https://host3/v1/
# cluster_name4 = https://host4/v1/
# Each section name is the name of a sync realm. A sync realm is a set of
# clusters that have agreed to allow container syncing with each other.
Realm
# names will be considered case insensitive.
#
# The key is the overall cluster-to-cluster key used in combination with the
# external users' key that they set on their containers' X-Container-
Sync-Key
# metadata header values. These keys will be used to sign each request the
# container sync daemon makes and used to validate each incoming container sync
# request.
#
# The key2 is optional and is an additional key incoming requests will be
# checked against. This is so you can rotate keys if you wish; you move
CHAPTER 10. OBJECT STORAGE
the
# existing key to key2 and make a new key value.
#
# Any values in the realm section whose names begin with cluster_ will indicate
# the name and endpoint of a cluster and will be used by external users in
# their containers' X-Container-Sync-To metadata header values with the format
# "realm_name/cluster_name/container_name". Realm and cluster names are
# considered case insensitive.
#
# The endpoint is what the container sync daemon will use when sending out
# requests to that cluster. Keep in mind this endpoint must be reachable by all
# container servers, since that is where the container sync daemon runs.
Note
# the the endpoint ends with /v1/ and that the container sync daemon will then
# add the account/container/obj name after that.
#
# Distribute this container-sync-realms.conf file to all your proxy servers
# and container servers.
10.7. CONTAINER RECONCILER CONFIGURATION
Find an example container sync realms configuration at etc/container-reconciler.conf-
sample in the source code repository.
The available configuration options are:
Table 10.31. Description of configuration options for [DEFAULT] in containerreconciler.conf
Configuration option = Default value log_address
= /dev/log
log_custom_handlers
=
Description
Location where syslog sends the logs to
Comma-separated list of functions to call to setup custom log handlers.
log_facility
= LOG_LOCAL0
log_level
= INFO
Syslog log facility
Logging level
log_name
= swift Label used when logging
log_statsd_default_sample_rate
= 1.0 Defines the probability of sending a sample for any given event or timing measurement.
765
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value log_statsd_host
= localhost
log_statsd_metric_prefix
=
log_statsd_port
= 8125
log_statsd_sample_rate_factor
= 1.0
log_udp_host log_udp_port swift_dir user
= swift
=
= 514
= /etc/swift
Description
If not set, the StatsD feature is disabled.
Value will be prepended to every metric sent to the
StatsD server.
Port value for the StatsD server.
Not recommended to set this to a value less than
1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead.
If not set, the UDP receiver for syslog is disabled.
Port value for UDP receiver, if enabled.
Swift configuration directory
User to run as
Table 10.32. Description of configuration options for [app-proxy-server] in containerreconciler.conf
Configuration option = Default value use
= egg:swift#proxy
Description
Entry point of paste.deploy in the server
Table 10.33. Description of configuration options for [container-reconciler] in container-reconciler.conf
Configuration option = Default value interval
= 30
reclaim_age
= 604800
Description
Minimum time for a pass to take
Time elapsed in seconds before an object can be reclaimed
No help text available for this option.
request_tries
= 3
Table 10.34. Description of configuration options for [filter-cache] in containerreconciler.conf
766
Configuration option = Default value use
= egg:swift#memcache
CHAPTER 10. OBJECT STORAGE
Description
Entry point of paste.deploy in the server
Table 10.35. Description of configuration options for [filter-catch_errors] in container-reconciler.conf
Configuration option = Default value use
= egg:swift#catch_errors
Description
Entry point of paste.deploy in the server
Table 10.36. Description of configuration options for [filter-proxy-logging] in container-reconciler.conf
Configuration option = Default value use
= egg:swift#proxy_logging
Description
Entry point of paste.deploy in the server
Table 10.37. Description of configuration options for [pipeline-main] in containerreconciler.conf
Configuration option = Default value pipeline
= catch_errors proxy-logging cache
proxy-server
Description
No help text available for this option.
10.7.1. Sample container sync reconciler configuration file
[DEFAULT]
# swift_dir = /etc/swift
# user = swift
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# comma separated list of functions to call to setup custom log handlers.
# functions get passed: conf, name, log_to_console, log_route, fmt, logger,
# adapted_logger
# log_custom_handlers =
#
# If set, log_udp_host will override log_address
# log_udp_host =
767
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# log_udp_port = 514
#
# You can enable StatsD logging here:
# log_statsd_host = localhost
# log_statsd_port = 8125
# log_statsd_default_sample_rate = 1.0
# log_statsd_sample_rate_factor = 1.0
# log_statsd_metric_prefix =
[container-reconciler]
# The reconciler will re-attempt reconciliation if the source object is not
# available up to reclaim_age seconds before it gives up and deletes the entry
# in the queue.
# reclaim_age = 604800
# The cycle time of the daemon
# interval = 30
# Server errors from requests will be retried by default
# request_tries = 3
[pipeline:main] pipeline = catch_errors proxy-logging cache proxy-server
[app:proxy-server] use = egg:swift#proxy
# See proxy-server.conf-sample for options
[filter:cache] use = egg:swift#memcache
# See proxy-server.conf-sample for options
[filter:proxy-logging] use = egg:swift#proxy_logging
[filter:catch_errors] use = egg:swift#catch_errors
# See proxy-server.conf-sample for options
10.8. ACCOUNT SERVER CONFIGURATION
Find an example account server configuration at etc/account-server.conf-sample in the source code repository.
The available configuration options are:
Table 10.38. Description of configuration options for [DEFAULT] in account-server.conf
Configuration option = Default value Description
768
Configuration option = Default value backlog
= 4096
bind_ip
= 0.0.0.0
bind_port
= 6002
bind_timeout
= 30
db_preallocation
= off
devices
= /srv/node
disable_fallocate
= false
eventlet_debug
= false
fallocate_reserve
= 0
log_address
= /dev/log
log_custom_handlers
=
log_facility
= LOG_LOCAL0
log_level
= INFO
log_max_line_length
= 0
log_name
= swift
CHAPTER 10. OBJECT STORAGE
Description
Maximum number of allowed pending TCP connections
IP Address for server to bind to
Port for server to bind to
Seconds to attempt bind before giving up
If you don't mind the extra disk space usage in overhead, you can turn this on to preallocate disk space with SQLite databases to decrease fragmentation. underlying filesystem does not support it. to setup custom log handlers. bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server.
For most cases, this should be `egg:swift#account`.
replication passes account can be reclaimed
Parent directory of where devices are mounted
Disable "fast fail" fallocate checks if the underlying filesystem does not support it.
If true, turn on debug logging for eventlet
You can set fallocate_reserve to the number of bytes you'd like fallocate to reserve, whether there is space for the given file size or not. This is useful for systems that behave badly when they completely run out of space; you can make the services pretend they're out of space early. server.
For most cases, this should be `egg:swift#object`.
Location where syslog sends the logs to
Comma-separated list of functions to call to setup custom log handlers.
Syslog log facility
Logging level
Caps the length of log lines to the value given; no limit if set to 0, the default.
Label used when logging
769
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description log_statsd_default_sample_rate
= 1.0 Defines the probability of sending a sample for any given event or timing measurement.
If not set, the StatsD feature is disabled.
log_statsd_host
= localhost
log_statsd_metric_prefix
= Value will be prepended to every metric sent to the
StatsD server.
log_statsd_port
= 8125
log_statsd_sample_rate_factor
= 1.0
log_udp_host swift_dir user
= swift
workers
= /etc/swift
= auto
=
log_udp_port
= 514
max_clients
= 1024
mount_check
= true
Port value for the StatsD server.
Not recommended to set this to a value less than
1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead.
If not set, the UDP receiver for syslog is disabled.
Port value for UDP receiver, if enabled.
Maximum number of clients one worker can process simultaneously Lowering the number of clients handled per worker, and raising the number of workers can lessen the impact that a CPU intensive, or blocking, request can have on other requests served by the same worker. If the maximum number of clients is set to one, then a given worker will not perform another call while processing, allowing other workers a chance to process it.
Whether or not check if the devices are mounted to prevent accidentally writing to the root device
Swift configuration directory
User to run as a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
Table 10.39. Description of configuration options for [app-account-server] in accountserver.conf
Configuration option = Default value auto_create_account_prefix
= .
Description
Prefix to use when automatically creating accounts
770
Configuration option = Default value replication_server
= false
set log_address
= /dev/log
set log_facility
= LOG_LOCAL0
set log_level
= INFO
set log_name
= account-server
set log_requests
= true
use
= egg:swift#account
CHAPTER 10. OBJECT STORAGE
Description
If defined, tells server how to handle replication verbs in requests. When set to True (or 1), only replication verbs will be accepted. When set to
False, replication verbs will be rejected. When undefined, server will accept any verb in the request.
Location where syslog sends the logs to
Syslog log facility
Log level
Label to use when logging
Whether or not to log requests
Entry point of paste.deploy in the server
Table 10.40. Description of configuration options for [pipeline-main] in accountserver.conf
Configuration option = Default value pipeline
= healthcheck recon account-server
Description
No help text available for this option.
Table 10.41. Description of configuration options for [account-replicator] in accountserver.conf
Configuration option = Default value concurrency
= 8
conn_timeout
= 0.5
error_suppression_interval
= 60
error_suppression_limit interval
= 30
log_address
= /dev/log
= 10
Description
Number of replication workers to spawn
Connection timeout to external services
Time in seconds that must elapse since the last error for a node to be considered no longer error limited
Error count to consider a node error limited
Minimum time for a pass to take
Location where syslog sends the logs to
771
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= account-replicator
max_diffs
= 100
node_timeout
= 10
per_diff
= 1000
reclaim_age
= 604800
recon_cache_path run_pause
= 30
vm_test_mode
= no
= /var/cache/swift
Description
Syslog log facility
Logging level
Label used when logging
Caps how long the replicator spends trying to sync a database per pass
Request timeout to external services
Limit number of items to get per diff
Time elapsed in seconds before an object can be reclaimed
Directory where stats for a few items will be stored
Time in seconds to wait between replication passes
Indicates that you are using a VM environment
Table 10.42. Description of configuration options for [account-auditor] in accountserver.conf
Configuration option = Default value accounts_per_second
= 200
interval
= 1800
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= account-auditor
recon_cache_path
= /var/cache/swift
Description
Maximum accounts audited per second. Should be tuned according to individual system specs. 0 is unlimited.
Minimum time for a pass to take
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
Directory where stats for a few items will be stored
Table 10.43. Description of configuration options for [account-reaper] in accountserver.conf
772
Configuration option = Default value concurrency
= 25
conn_timeout
= 0.5
delay_reaping
= 0
interval
= 3600
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_level
= INFO
log_name
= account-reaper
node_timeout
= 10
reap_warn_after
= 2592000
CHAPTER 10. OBJECT STORAGE
Description
Number of replication workers to spawn
Connection timeout to external services
Normally, the reaper begins deleting account information for deleted accounts immediately; you can set this to delay its work however. The value is in seconds, 2592000 = 30 days, for example. bind to giving up worker can process simultaneously (it will actually accept(2) N + 1). Setting this to one (1) will only handle one request at a time, without accepting another request concurrently. By increasing the number of workers to a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
Minimum time for a pass to take
Location where syslog sends the logs to
Syslog log facility
Logging level
Label used when logging
Request timeout to external services
No help text available for this option.
Table 10.44. Description of configuration options for [filter-healthcheck] in accountserver.conf
Configuration option = Default value disable_path
=
use
= egg:swift#healthcheck
Description
No help text available for this option.
Entry point of paste.deploy in the server
Table 10.45. Description of configuration options for [filter-recon] in accountserver.conf
773
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value recon_cache_path
= /var/cache/swift
use
= egg:swift#recon
Description
Directory where stats for a few items will be stored
Entry point of paste.deploy in the server
Table 10.46. Description of configuration options for [filter-xprofile] in accountserver.conf
Configuration option = Default value dump_interval
= 5.0
dump_timestamp
= false
flush_at_shutdown
= false
log_filename_prefix
=
/tmp/log/swift/profile/default.profile
path
= /__profile__
profile_module
= eventlet.green.profile
unwind
= false
use
= egg:swift#xprofile
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Entry point of paste.deploy in the server
774
10.8.1. Sample account server configuration file
[DEFAULT]
# bind_ip = 0.0.0.0
bind_port = 6002
# bind_timeout = 30
# backlog = 4096
# user = swift
# swift_dir = /etc/swift
# devices = /srv/node
# mount_check = true
# disable_fallocate = false
#
# Use an integer to override the number of pre-forked processes that will
# accept connections.
# workers = auto
#
# Maximum concurrent requests per worker
# max_clients = 1024
#
# You can specify default log routing here if you want:
CHAPTER 10. OBJECT STORAGE
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
# The following caps the length of log lines to the value given; no limit if
# set to 0, the default.
# log_max_line_length = 0
#
# comma separated list of functions to call to setup custom log handlers.
# functions get passed: conf, name, log_to_console, log_route, fmt, logger,
# adapted_logger
# log_custom_handlers =
#
# If set, log_udp_host will override log_address
# log_udp_host =
# log_udp_port = 514
#
# You can enable StatsD logging here:
# log_statsd_host = localhost
# log_statsd_port = 8125
# log_statsd_default_sample_rate = 1.0
# log_statsd_sample_rate_factor = 1.0
# log_statsd_metric_prefix =
#
# If you don't mind the extra disk space usage in overhead, you can turn this
# on to preallocate disk space with SQLite databases to decrease fragmentation.
# db_preallocation = off
#
# eventlet_debug = false
#
# You can set fallocate_reserve to the number of bytes you'd like fallocate to
# reserve, whether there is space for the given file size or not.
# fallocate_reserve = 0
[pipeline:main] pipeline = healthcheck recon account-server
[app:account-server] use = egg:swift#account
# You can override the default log routing for this app here:
# set log_name = account-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_requests = true
# set log_address = /dev/log
#
# auto_create_account_prefix = .
#
# Configure parameter for creating specific server
# To handle all verbs, including replication verbs, do not specify
# "replication_server" (this is the default). To only handle replication,
775
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# set to a True value (e.g. "True" or "1"). To handle only nonreplication
# verbs, set to "False". Unless you have a separate replication network, you
# should not specify any value for "replication_server".
# replication_server = false
[filter:healthcheck] use = egg:swift#healthcheck
# An optional filesystem path, which if present, will cause the healthcheck
# URL to return "503 Service Unavailable" with a body of "DISABLED BY
FILE"
# disable_path =
[filter:recon] use = egg:swift#recon
# recon_cache_path = /var/cache/swift
[account-replicator]
# You can override the default log routing for this app here (don't use set!):
# log_name = account-replicator
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# vm_test_mode = no
# per_diff = 1000
# max_diffs = 100
# concurrency = 8
# interval = 30
#
# How long without an error before a node's error count is reset. This will
# also be how long before a node is reenabled after suppression is triggered.
# error_suppression_interval = 60
#
# How many errors can accumulate before a node is temporarily ignored.
# error_suppression_limit = 10
#
# node_timeout = 10
# conn_timeout = 0.5
#
# The replicator also performs reclamation
# reclaim_age = 604800
#
# Time in seconds to wait between replication passes
# Note: if the parameter 'interval' is defined then it will be used in place
# of run_pause.
# run_pause = 30
#
# recon_cache_path = /var/cache/swift
776
CHAPTER 10. OBJECT STORAGE
[account-auditor]
# You can override the default log routing for this app here (don't use set!):
# log_name = account-auditor
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# Will audit each account at most once per interval
# interval = 1800
#
# log_facility = LOG_LOCAL0
# log_level = INFO
# accounts_per_second = 200
# recon_cache_path = /var/cache/swift
[account-reaper]
# You can override the default log routing for this app here (don't use set!):
# log_name = account-reaper
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_address = /dev/log
#
# concurrency = 25
# interval = 3600
# node_timeout = 10
# conn_timeout = 0.5
#
# Normally, the reaper begins deleting account information for deleted accounts
# immediately; you can set this to delay its work however. The value is in
# seconds; 2592000 = 30 days for example.
# delay_reaping = 0
#
# If the account fails to be be reaped due to a persistent error, the
# account reaper will log a message such as:
# Account <name> has not been reaped since <date>
# You can search logs for this message if space is not being reclaimed
# after you delete account(s).
# Default is 2592000 seconds (30 days). This is in addition to any time
# requested by delay_reaping.
# reap_warn_after = 2592000
# Note: Put it at the beginning of the pipeline to profile all middleware. But
# it is safer to put this after healthcheck.
[filter:xprofile] use = egg:swift#xprofile
# This option enable you to switch profilers which should inherit from python
# standard profiler. Currently the supported value can be 'cProfile',
# 'eventlet.green.profile' etc.
# profile_module = eventlet.green.profile
#
777
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# This prefix will be used to combine process ID and timestamp to name the
# profile data file. Make sure the executing user has permission to write
# into this path (missing path segments will be created, if necessary).
# If you enable profiling in more than one type of daemon, you must override
# it with an unique value like: /var/log/swift/profile/account.profile
# log_filename_prefix = /tmp/log/swift/profile/default.profile
#
# the profile data will be dumped to local disk based on above naming rule
# in this interval.
# dump_interval = 5.0
#
# Be careful, this option will enable profiler to dump data into the file with
# time stamp which means there will be lots of files piled up in the directory.
# dump_timestamp = false
#
# This is the path of the URL to access the mini web UI.
# path = /__profile__
#
# Clear the data when the wsgi server shutdown.
# flush_at_shutdown = false
#
# unwind the iterator of applications
# unwind = false
10.9. PROXY SERVER CONFIGURATION
Find an example proxy server configuration at etc/proxy-server.conf-sample in the source code repository.
The available configuration options are:
Table 10.47. Description of configuration options for [DEFAULT] in proxy-server.conf
Configuration option = Default value admin_key
= secret_admin_key
backlog
= 4096
bind_ip
= 0.0.0.0
Description
to use for admin calls that are HMAC signed.
Default is empty, which will disable admin calls to
/info. the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node
Maximum number of allowed pending TCP connections
IP Address for server to bind to
778
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value bind_port
= 8080
bind_timeout
= 30
cert_file
= /etc/swift/proxy.crt
client_timeout
= 60
cors_allow_origin
=
Description
Port for server to bind to
Seconds to attempt bind before giving up to the ssl .crt. This should be enabled for testing purposes only.
Timeout to read one chunk from a client external services is a list of hosts that are included with any CORS request by default and returned with the Access-
Control-Allow-Origin header in addition to what the container has set. to call to setup custom log handlers. for eventlet the proxy server. For most cases, this should be `egg:swift#proxy`. request whenever it has to failover to a handoff node
disallowed_sections
=
swift.valid_api_versions, container_quotas, tempurl
No help text available for this option.
eventlet_debug
= false
expiring_objects_account_name
=
expiring_objects
If true, turn on debug logging for eventlet
No help text available for this option.
expiring_objects_container_divisor
= 86400
No help text available for this option.
expose_info
= true
key_file
= /etc/swift/proxy.key
log_address
= /dev/log
log_custom_handlers log_facility
=
= LOG_LOCAL0
log_headers
= false
log_level
= INFO
log_max_line_length
= 0
Enables exposing configuration settings via HTTP
GET /info.
to the ssl .key. This should be enabled for testing purposes only.
Location where syslog sends the logs to
Comma-separated list of functions to call to setup custom log handlers.
Syslog log facility
No help text available for this option.
Logging level
Caps the length of log lines to the value given; no limit if set to 0, the default.
779
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value Description log_name
= swift Label used when logging
log_statsd_default_sample_rate
= 1.0 Defines the probability of sending a sample for any given event or timing measurement.
log_statsd_host
= localhost
log_statsd_metric_prefix
=
log_statsd_port
= 8125
log_statsd_sample_rate_factor log_udp_host log_udp_port max_clients
=
= 514
= 1024
strict_cors_mode swift_dir
= /etc/swift
trans_id_suffix
=
user
= swift
workers
= auto
= True
= 1.0
If not set, the StatsD feature is disabled.
Value will be prepended to every metric sent to the
StatsD server.
Port value for the StatsD server.
Not recommended to set this to a value less than
1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead.
If not set, the UDP receiver for syslog is disabled.
Port value for UDP receiver, if enabled.
Maximum number of clients one worker can process simultaneously Lowering the number of clients handled per worker, and raising the number of workers can lessen the impact that a CPU intensive, or blocking, request can have on other requests served by the same worker. If the maximum number of clients is set to one, then a given worker will not perform another call while processing, allowing other workers a chance to process it.
No help text available for this option.
Swift configuration directory
No help text available for this option.
User to run as a much higher value, one can reduce the impact of slow file system operations in one request from negatively impacting other requests.
Table 10.48. Description of configuration options for [app-proxy-server] in proxyserver.conf
780
Configuration option = Default value account_autocreate
= false
allow_account_management
= false
auto_create_account_prefix
= .
client_chunk_size
= 65536
conn_timeout
= 0.5
deny_host_headers
=
error_suppression_interval
= 60
error_suppression_limit log_handoffs
= true
= 10
max_containers_per_account
= 0
max_containers_whitelist
=
max_large_object_get_time
= 86400
node_timeout
= 10
object_chunk_size
= 65536
object_post_as_copy
= true
post_quorum_timeout
= 0.5
CHAPTER 10. OBJECT STORAGE
Description
If set to 'true' authorized accounts that do not yet exist within the Swift cluster will be automatically created.
Whether account PUTs and DELETEs are even callable
Prefix to use when automatically creating accounts
Chunk size to read from clients
Connection timeout to external services
No help text available for this option.
Time in seconds that must elapse since the last error for a node to be considered no longer error limited
Error count to consider a node error limited
No help text available for this option.
If set to a positive value, trying to create a container when the account already has at least this maximum containers will result in a 403
Forbidden. Note: This is a soft limit, meaning a user might exceed the cap for recheck_account_existence before the 403s kick in.
is a comma separated list of account names that ignore the max_containers_per_account cap.
No help text available for this option.
Request timeout to external services
Chunk size to read from object servers
Set object_post_as_copy = false to turn on fast posts where only the metadata changes are stored anew and the original data file is kept in place. This makes for quicker posts; but since the container metadata isn't updated in this mode, features like container sync won't be able to sync posts.
No help text available for this option.
781
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value put_queue_depth
= 10 No help text available for this option.
read_affinity
= r1z1=100, r1z2=200, r2=300 No help text available for this option.
recheck_account_existence
= 60 Cache timeout in seconds to send memcached for account existence
recheck_container_existence
= 60
Description recoverable_node_timeout
node_timeout
request_node_count
=
= 2 * replicas
Cache timeout in seconds to send memcached for container existence
Request timeout to external services for requests that, on failure, can be recovered from. For example, object GET. from a client external services
* replicas Set to the number of nodes to contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request
set log_address
= /dev/log
set log_facility
= LOG_LOCAL0
set log_level
= INFO
set log_name
= proxy-server
Location where syslog sends the logs to
Syslog log facility
Log level
Label to use when logging
sorting_method
= shuffle
swift_owner_headers
= x-container-read, x-
container-write, x-container-sync-key, x-containersync-to, x-account-meta-temp-url-key, x-accountmeta-temp-url-key-2, x-container-meta-temp-urlkey, x-container-meta-temp-url-key-2, x-accountaccess-control
No help text available for this option.
These are the headers whose conf file for values will only be shown to the list of swift_owners. The exact default definition of a swift_owner is headers> up to the auth system in use, but usually indicates administrative responsibilities.
paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request
timing_expiry
= 300
use
= egg:swift#proxy
No help text available for this option.
Entry point of paste.deploy in the server
782
Configuration option = Default value write_affinity
= r1, r2
write_affinity_node_count
replicas
= 2 *
CHAPTER 10. OBJECT STORAGE
Description
This setting lets you trade data distribution for throughput. It makes the proxy server prefer local back-end servers for object PUT requests over non-local ones. Note that only object PUT requests are affected by the write_affinity setting; POST,
GET, HEAD, DELETE, OPTIONS, and account/container PUT requests are not affected.
The format is r<N> for region N or r<N>z<M> for region N, zone M. If this is set, then when handling an object PUT request, some number (see the write_affinity_node_count setting) of local backend servers will be tried before any nonlocal ones.
Example: try to write to regions 1 and 2 before writing to any other nodes: write_affinity = r1, r2
This setting is only useful in conjunction with write_affinity; it governs how many local object servers will be tried before falling back to non-local ones. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request: write_affinity_node_count = 2 * replicas
Table 10.49. Description of configuration options for [pipeline-main] in proxyserver.conf
Configuration option = Default value pipeline
= catch_errors gatekeeper
healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas account-quotas slo dlo proxy-logging proxy-server
Description
No help text available for this option.
Table 10.50. Description of configuration options for [filter-account-quotas] in proxyserver.conf
Configuration option = Default value use
= egg:swift#account_quotas
Description
Entry point of paste.deploy in the server
Table 10.51. Description of configuration options for [filter-authtoken] in proxyserver.conf
783
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value admin_password
= password
admin_tenant_name
= service
admin_user
= swift
auth_uri
= http://keystonehost:5000/
cache
= swift.cache
delay_auth_decision
= False
identity_uri
= http://keystonehost:35357/
include_service_catalog
= False
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Table 10.52. Description of configuration options for [filter-cache] in proxyserver.conf
Configuration option = Default value memcache_max_connections
= 2
memcache_serialization_support
= 2
memcache_servers set log_address set log_facility set log_headers set log_level set log_name use
= 127.0.0.1:11211
= /dev/log
= LOG_LOCAL0
= false
= INFO
= cache
= egg:swift#memcache
Description
Max number of connections to each memcached server per worker services
Sets how memcache values are serialized and deserialized
Comma-separated list of memcached servers ip:port services
Location where syslog sends the logs to
Syslog log facility
If True, log headers in each request
Log level
Label to use when logging
Entry point of paste.deploy in the server
Table 10.53. Description of configuration options for [filter-catch_errors] in proxyserver.conf
784
Configuration option = Default value set log_address
= /dev/log
set log_facility
= LOG_LOCAL0
set log_headers
= false
set log_level
= INFO
set log_name
= catch_errors
use
= egg:swift#catch_errors
CHAPTER 10. OBJECT STORAGE
Description
Location where syslog sends the logs to
Syslog log facility
If True, log headers in each request
Log level
Label to use when logging
Entry point of paste.deploy in the server
Table 10.54. Description of configuration options for [filter-container_sync] in proxyserver.conf
Configuration option = Default value allow_full_urls
= true
current
= //REALM/CLUSTER
use
= egg:swift#container_sync
Description
No help text available for this option.
No help text available for this option.
Entry point of paste.deploy in the server
Table 10.55. Description of configuration options for [filter-dlo] in proxy-server.conf
Configuration option = Default value max_get_time
= 86400
rate_limit_after_segment
= 10
rate_limit_segments_per_sec
= 1
Description
No help text available for this option.
Rate limit the download of large object segments after this segment is downloaded.
Rate limit large object downloads at this rate.
contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request
Entry point of paste.deploy in the server
use
= egg:swift#dlo
Table 10.56. Description of configuration options for [filter-gatekeeper] in proxyserver.conf
785
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value set log_address
= /dev/log
set log_facility
= LOG_LOCAL0
set log_headers
= false
set log_level
= INFO
set log_name
= gatekeeper
use
= egg:swift#gatekeeper
Description
Location where syslog sends the logs to
Syslog log facility
If True, log headers in each request
Log level
Label to use when logging
Entry point of paste.deploy in the server
Table 10.57. Description of configuration options for [filter-healthcheck] in proxyserver.conf
Configuration option = Default value disable_path
=
use
= egg:swift#healthcheck
Description
No help text available for this option.
Entry point of paste.deploy in the server
Table 10.58. Description of configuration options for [filter-keystoneauth] in proxyserver.conf
Configuration option = Default value allow_names_in_acls
= true
allow_overrides
= true
default_domain_id
= default
Description
The backwards compatible behavior can be disabled by setting this option to False.
This option allows middleware higher in the WSGI pipeline to override auth processing, useful for middleware such as tempurl and formpost. If you know you are not going to use such middleware and you want a bit of extra security, you can set this to False.
Name of the default domain. It is identified by its
UUID, which by default has the value "default".
786
Configuration option = Default value is_admin
= false
operator_roles
= admin, swiftoperator
reseller_admin_role reseller_prefix service_roles
=
= ResellerAdmin
= AUTH
CHAPTER 10. OBJECT STORAGE
Description
If this option is set to True, it allows to give a user whose username is the same as the project name and who has any role in the project access rights elevated to be the same as if the user had one of the operator_roles. Note that the condition compares names rather than UUIDs. This option is deprecated. It is False by default.
Operator role defines the user which is allowed to manage a tenant and create containers or give
ACL to others. This parameter may be prefixed with an appropriate prefix.
The reseller admin role gives the ability to create and delete accounts.
The naming scope for the auth service. Swift
When present, this option requires that the X-
Service-Token header supplies a token from a user who has a role listed in service_roles. This parameter may be prefixed with an appropriate prefix.
Entry point of paste.deploy in the server
use
= egg:swift#keystoneauth
Table 10.59. Description of configuration options for [filter-list-endpoints] in proxyserver.conf
Configuration option = Default value list_endpoints_path
= /endpoints/
use
= egg:swift#list_endpoints
Description
No help text available for this option.
Entry point of paste.deploy in the server
Table 10.60. Description of configuration options for [filter-proxy-logging] in proxyserver.conf
Configuration option = Default value access_log_address
= /dev/log
access_log_facility
= LOG_LOCAL0
access_log_headers
= false
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
787
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value access_log_headers_only
=
Description
If access_log_headers is True and access_log_headers_only is set only these headers are logged. Multiple headers can be defined as comma separated list like this: access_log_headers_only = Host, X-Object-Meta-
Mtime
access_log_level
= INFO
access_log_name
= swift
No help text available for this option.
No help text available for this option.
access_log_statsd_default_sample_r ate
= 1.0
No help text available for this option.
No help text available for this option.
access_log_statsd_host
= localhost
access_log_statsd_metric_prefix
=
access_log_statsd_port
= 8125
No help text available for this option.
No help text available for this option.
access_log_statsd_sample_rate_fact or
= 1.0
No help text available for this option.
access_log_udp_host
=
access_log_udp_port
= 514
No help text available for this option.
No help text available for this option.
log_statsd_valid_http_methods
=
GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS
No help text available for this option.
No help text available for this option.
logged with access_log_headers
=
True.
reveal_sensitive_prefix
= 16
use
= egg:swift#proxy_logging
The X-Auth-Token is sensitive data. If revealed to an unauthorised person, they can now make requests against an account until the token expires. Set reveal_sensitive_prefix to the number of characters of the token that are logged. For example reveal_sensitive_prefix = 12 so only first
12 characters of the token are logged. Or, set to 0 to completely remove the token.
Entry point of paste.deploy in the server
Table 10.61. Description of configuration options for [filter-tempauth] in proxyserver.conf
788
Configuration option = Default value allow_overrides
= true
auth_prefix
= /auth/
require_group reseller_prefix set log_address set log_name
=
= AUTH
= /dev/log
set log_facility
= LOG_LOCAL0
set log_headers
= false
set log_level
= INFO
= tempauth
storage_url_scheme
= default
CHAPTER 10. OBJECT STORAGE
Description
This option allows middleware higher in the WSGI pipeline to override auth processing, useful for middleware such as tempurl and formpost. If you know you are not going to use such middleware and you want a bit of extra security, you can set this to False.
The HTTP request path prefix for the auth service.
Swift itself reserves anything beginning with the letter `v`.
No help text available for this option.
The naming scope for the auth service. Swift
Location where syslog sends the logs to
Syslog log facility
If True, log headers in each request
Log level
Label to use when logging
Scheme to return with storage urls: http, https, or default (chooses based on what the server is running as) This can be useful with an SSL load balancer in front of a non-SSL server.
The number of seconds a token is valid.
Entry point of paste.deploy in the server
No help text available for this option.
token_life
= 86400
use
= egg:swift#tempauth
user_admin_admin
= admin .admin
.reseller_admin
user_test2_tester2
= testing2 .admin
user_test5_tester5
= testing5 service
user_test_tester
= testing .admin
user_test_tester3
= testing3
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Table 10.62. Description of configuration options for [filter-xprofile] in proxyserver.conf
789
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value dump_interval
= 5.0
dump_timestamp
= false
flush_at_shutdown
= false
log_filename_prefix
=
/tmp/log/swift/profile/default.profile
path
= /__profile__
profile_module
= eventlet.green.profile
unwind
= false
use
= egg:swift#xprofile
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Entry point of paste.deploy in the server
790
10.9.1. Sample proxy server configuration file
[DEFAULT]
# bind_ip = 0.0.0.0
bind_port = 8080
# bind_timeout = 30
# backlog = 4096
# swift_dir = /etc/swift
# user = swift
# Enables exposing configuration settings via HTTP GET /info.
# expose_info = true
# Key to use for admin calls that are HMAC signed. Default is empty,
# which will disable admin calls to /info.
# admin_key = secret_admin_key
#
# Allows the ability to withhold sections from showing up in the public calls
# to /info. You can withhold subsections by separating the dict level with a
# ".". The following would cause the sections 'container_quotas' and
'tempurl'
# to not be listed, and the key max_failed_deletes would be removed from
# bulk_delete. Default value is 'swift.valid_api_versions' which allows all
# registered features to be listed via HTTP GET /info except
# swift.valid_api_versions information
# disallowed_sections = swift.valid_api_versions, container_quotas, tempurl
# Use an integer to override the number of pre-forked processes that will
# accept connections. Should default to the number of effective cpu
CHAPTER 10. OBJECT STORAGE
# cores in the system. It's worth noting that individual workers will
# use many eventlet co-routines to service multiple concurrent requests.
# workers = auto
#
# Maximum concurrent requests per worker
# max_clients = 1024
#
# Set the following two lines to enable SSL. This is for testing only.
# cert_file = /etc/swift/proxy.crt
# key_file = /etc/swift/proxy.key
#
# expiring_objects_container_divisor = 86400
# expiring_objects_account_name = expiring_objects
#
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
# log_headers = false
# log_address = /dev/log
# The following caps the length of log lines to the value given; no limit if
# set to 0, the default.
# log_max_line_length = 0
#
# This optional suffix (default is empty) that would be appended to the swift transaction
# id allows one to easily figure out from which cluster that X-Trans-Id belongs to.
# This is very useful when one is managing more than one swift cluster.
# trans_id_suffix =
#
# comma separated list of functions to call to setup custom log handlers.
# functions get passed: conf, name, log_to_console, log_route, fmt, logger,
# adapted_logger
# log_custom_handlers =
#
# If set, log_udp_host will override log_address
# log_udp_host =
# log_udp_port = 514
#
# You can enable StatsD logging here:
# log_statsd_host = localhost
# log_statsd_port = 8125
# log_statsd_default_sample_rate = 1.0
# log_statsd_sample_rate_factor = 1.0
# log_statsd_metric_prefix =
#
# Use a comma separated list of full url
(http://foo.bar:1234,https://foo.bar)
# cors_allow_origin =
# strict_cors_mode = True
#
# client_timeout = 60
# eventlet_debug = false
791
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
[pipeline:main] pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk tempurl ratelimit tempauth container-quotas accountquotas slo dlo proxy-logging proxy-server
[app:proxy-server] use = egg:swift#proxy
# You can override the default log routing for this app here:
# set log_name = proxy-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_address = /dev/log
#
# log_handoffs = true
# recheck_account_existence = 60
# recheck_container_existence = 60
# object_chunk_size = 65536
# client_chunk_size = 65536
#
# How long the proxy server will wait on responses from the a/c/o servers.
# node_timeout = 10
#
# How long the proxy server will wait for an initial response and to read a
# chunk of data from the object servers while serving GET / HEAD requests.
# Timeouts from these requests can be recovered from so setting this to
# something lower than node_timeout would provide quicker error recovery
# while allowing for a longer timeout for non-recoverable requests
(PUTs).
# Defaults to node_timeout, should be overriden if node_timeout is set to a
# high number to prevent client timeouts from firing before the proxy server
# has a chance to retry.
# recoverable_node_timeout = node_timeout
#
# conn_timeout = 0.5
#
# How long to wait for requests to finish after a quorum has been established.
# post_quorum_timeout = 0.5
#
# How long without an error before a node's error count is reset. This will
# also be how long before a node is reenabled after suppression is triggered.
# error_suppression_interval = 60
#
# How many errors can accumulate before a node is temporarily ignored.
# error_suppression_limit = 10
#
# If set to 'true' any authorized user may create and delete accounts; if
# 'false' no one, even authorized, can.
792
CHAPTER 10. OBJECT STORAGE
# allow_account_management = false
#
# Set object_post_as_copy = false to turn on fast posts where only the metadata
# changes are stored anew and the original data file is kept in place.
This
# makes for quicker posts; but since the container metadata isn't updated in
# this mode, features like container sync won't be able to sync posts.
# object_post_as_copy = true
#
# If set to 'true' authorized accounts that do not yet exist within the
Swift
# cluster will be automatically created.
# account_autocreate = false
#
# If set to a positive value, trying to create a container when the account
# already has at least this maximum containers will result in a 403
Forbidden.
# Note: This is a soft limit, meaning a user might exceed the cap for
# recheck_account_existence before the 403s kick in.
# max_containers_per_account = 0
#
# This is a comma separated list of account hashes that ignore the
# max_containers_per_account cap.
# max_containers_whitelist =
#
# Comma separated list of Host headers to which the proxy will deny requests.
# deny_host_headers =
#
# Prefix used when automatically creating accounts.
# auto_create_account_prefix = .
#
# Depth of the proxy put queue.
# put_queue_depth = 10
#
# Storage nodes can be chosen at random (shuffle), by using timing
# measurements (timing), or by using an explicit match (affinity).
# Using timing measurements may allow for lower overall latency, while
# using affinity allows for finer control. In both the timing and
# affinity cases, equally-sorting nodes are still randomly chosen to
# spread load.
# The valid values for sorting_method are "affinity", "shuffle", and
"timing".
# sorting_method = shuffle
#
# If the "timing" sorting_method is used, the timings will only be valid for
# the number of seconds configured by timing_expiry.
# timing_expiry = 300
#
# The maximum time (seconds) that a large object connection is allowed to last.
# max_large_object_get_time = 86400
793
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#
# Set to the number of nodes to contact for a normal request. You can use
# '* replicas' at the end to have it use the number given times the number of
# replicas for the ring being used for the request.
# request_node_count = 2 * replicas
#
# Which backend servers to prefer on reads. Format is r<N> for region
# N or r<N>z<M> for region N, zone M. The value after the equals is
# the priority; lower numbers are higher priority.
#
# Example: first read from region 1 zone 1, then region 1 zone 2, then
# anything in region 2, then everything else:
# read_affinity = r1z1=100, r1z2=200, r2=300
# Default is empty, meaning no preference.
# read_affinity =
#
# Which backend servers to prefer on writes. Format is r<N> for region
# N or r<N>z<M> for region N, zone M. If this is set, then when
# handling an object PUT request, some number (see setting
# write_affinity_node_count) of local backend servers will be tried
# before any nonlocal ones.
#
# Example: try to write to regions 1 and 2 before writing to any other
# nodes:
# write_affinity = r1, r2
# Default is empty, meaning no preference.
# write_affinity =
#
# The number of local (as governed by the write_affinity setting)
# nodes to attempt to contact first, before any non-local ones. You
# can use '* replicas' at the end to have it use the number given
# times the number of replicas for the ring being used for the
# request.
# write_affinity_node_count = 2 * replicas
#
# These are the headers whose values will only be shown to swift_owners.
The
# exact definition of a swift_owner is up to the auth system in use, but
# usually indicates administrative responsibilities.
# swift_owner_headers = x-container-read, x-container-write, x-containersync-key, x-container-sync-to, x-account-meta-temp-url-key, x-accountmeta-temp-url-key-2, x-container-meta-temp-url-key, x-container-meta-tempurl-key-2, x-account-access-control
[filter:tempauth] use = egg:swift#tempauth
# You can override the default log routing for this filter here:
# set log_name = tempauth
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = false
# set log_address = /dev/log
#
# The reseller prefix will verify a token begins with this prefix before even
794
CHAPTER 10. OBJECT STORAGE
# attempting to validate it. Also, with authorization, only Swift storage
# accounts with this prefix will be authorized by this middleware. Useful if
# multiple auth systems are in use for one Swift cluster.
# The reseller_prefix may contain a comma separated list of items. The first
# item is used for the token as mentioned above. If second and subsequent
# items exist, the middleware will handle authorization for an account with
# that prefix. For example, for prefixes "AUTH, SERVICE", a path of
# /v1/SERVICE_account is handled the same as /v1/AUTH_account. If an empty
# (blank) reseller prefix is required, it must be first in the list. Two
# single quote characters indicates an empty (blank) reseller prefix.
# reseller_prefix = AUTH
#
# The require_group parameter names a group that must be presented by
# either X-Auth-Token or X-Service-Token. Usually this parameter is
# used only with multiple reseller prefixes (e.g.,
SERVICE_require_group=blah).
# By default, no group is needed. Do not use .admin.
# require_group =
# The auth prefix will cause requests beginning with this prefix to be routed
# to the auth subsystem, for granting tokens, etc.
# auth_prefix = /auth/
# token_life = 86400
#
# This allows middleware higher in the WSGI pipeline to override auth
# processing, useful for middleware such as tempurl and formpost. If you know
# you're not going to use such middleware and you want a bit of extra security,
# you can set this to false.
# allow_overrides = true
#
# This specifies what scheme to return with storage urls:
# http, https, or default (chooses based on what the server is running as)
# This can be useful with an SSL load balancer in front of a non-SSL server.
# storage_url_scheme = default
#
# Lastly, you need to list all the accounts/users you want here. The format is:
# user_<account>_<user> = <key> [group] [group] [...] [storage_url]
# or if you want underscores in <account> or <user>, you can base64 encode them
# (with no equal signs) and use this format:
# user64_<account_b64>_<user_b64> = <key> [group] [group] [...]
[storage_url]
# There are special groups of:
# .reseller_admin = can do anything to any account for this auth
# .admin = can do anything within the account
795
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# If neither of these groups are specified, the user can only access containers
# that have been explicitly allowed for them by a .admin or
.reseller_admin.
# The trailing optional storage_url allows you to specify an alternate url to
# hand back to the user upon authentication. If not specified, this defaults to
# $HOST/v1/<reseller_prefix>_<account> where $HOST will do its best to resolve
# to what the requester would need to use to reach this host.
# Here are example entries, required for running the tests: user_admin_admin = admin .admin .reseller_admin
user_test_tester = testing .admin
user_test2_tester2 = testing2 .admin
user_test_tester3 = testing3 user_test5_tester5 = testing5 service
# To enable Keystone authentication you need to have the auth token
# middleware first to be configured. Here is an example below, please
# refer to the keystone's documentation for details about the
# different settings.
#
# You'll need to have as well the keystoneauth middleware enabled
# and have it in your main pipeline so instead of having tempauth in
# there you can change it to: authtoken keystoneauth
#
# [filter:authtoken]
# paste.filter_factory = keystonemiddleware.auth_token:filter_factory
# identity_uri = http://keystonehost:35357/
# auth_uri = http://keystonehost:5000/
# admin_tenant_name = service
# admin_user = swift
# admin_password = password
#
# delay_auth_decision defaults to False, but leaving it as false will
# prevent other auth systems, staticweb, tempurl, formpost, and ACLs from
# working. This value must be explicitly set to True.
# delay_auth_decision = False
#
# cache = swift.cache
# include_service_catalog = False
#
# [filter:keystoneauth]
# use = egg:swift#keystoneauth
# The reseller_prefix option lists account namespaces that this middleware is
# responsible for. The prefix is placed before the Keystone project id.
# For example, for project 12345678, and prefix AUTH, the account is
# named AUTH_12345678 (i.e., path is /v1/AUTH_12345678/...).
# Several prefixes are allowed by specifying a comma-separated list
# as in: "reseller_prefix = AUTH, SERVICE". The empty string indicates a
# single blank/empty prefix. If an empty prefix is required in a list of
# prefixes, a value of '' (two single quote characters) indicates a
# blank/empty prefix. Except for the blank/empty prefix, an underscore
('_')
796
CHAPTER 10. OBJECT STORAGE
# character is appended to the value unless already present.
# reseller_prefix = AUTH
#
# The user must have at least one role named by operator_roles on a
# project in order to create, delete and modify containers and objects
# and to set and read privileged headers such as ACLs.
# If there are several reseller prefix items, you can prefix the
# parameter so it applies only to those accounts (for example
# the parameter SERVICE_operator_roles applies to the
/v1/SERVICE_<project>
# path). If you omit the prefix, the option applies to all reseller
# prefix items. For the blank/empty prefix, prefix with '' (do not put
# underscore after the two single quote characters).
# operator_roles = admin, swiftoperator
#
# The reseller admin role has the ability to create and delete accounts
# reseller_admin_role = ResellerAdmin
#
# This allows middleware higher in the WSGI pipeline to override auth
# processing, useful for middleware such as tempurl and formpost. If you know
# you're not going to use such middleware and you want a bit of extra security,
# you can set this to false.
# allow_overrides = true
#
# If is_admin is true, a user whose username is the same as the project name
# and who has any role on the project will have access rights elevated to be
# the same as if the user had an operator role. Note that the condition
# compares names rather than UUIDs. This option is deprecated.
# is_admin = false
#
# If the service_roles parameter is present, an X-Service-Token must be
# present in the request that when validated, grants at least one role listed
# in the parameter. The X-Service-Token may be scoped to any project.
# If there are several reseller prefix items, you can prefix the
# parameter so it applies only to those accounts (for example
# the parameter SERVICE_service_roles applies to the
/v1/SERVICE_<project>
# path). If you omit the prefix, the option applies to all reseller
# prefix items. For the blank/empty prefix, prefix with '' (do not put
# underscore after the two single quote characters).
# By default, no service_roles are required.
# service_roles =
#
# For backwards compatibility, keystoneauth will match names in crosstenant
# access control lists (ACLs) when both the requesting user and the tenant
# are in the default domain i.e the domain to which existing tenants are
# migrated. The default_domain_id value configured here should be the same as
# the value used during migration of tenants to keystone domains.
797
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# default_domain_id = default
#
# For a new installation, or an installation in which keystone projects may
# move between domains, you should disable backwards compatible name matching
# in ACLs by setting allow_names_in_acls to false:
# allow_names_in_acls = true
[filter:healthcheck] use = egg:swift#healthcheck
# An optional filesystem path, which if present, will cause the healthcheck
# URL to return "503 Service Unavailable" with a body of "DISABLED BY
FILE".
# This facility may be used to temporarily remove a Swift node from a load
# balancer pool during maintenance or upgrade (remove the file to allow the
# node back into the load balancer pool).
# disable_path =
[filter:cache] use = egg:swift#memcache
# You can override the default log routing for this filter here:
# set log_name = cache
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = false
# set log_address = /dev/log
#
# If not set here, the value for memcache_servers will be read from
# memcache.conf (see memcache.conf-sample) or lacking that file, it will
# default to the value below. You can specify multiple servers separated with
# commas, as in: 10.1.2.3:11211,10.1.2.4:11211
# memcache_servers = 127.0.0.1:11211
#
# Sets how memcache values are serialized and deserialized:
# 0 = older, insecure pickle serialization
# 1 = json serialization but pickles can still be read (still insecure)
# 2 = json serialization only (secure and the default)
# If not set here, the value for memcache_serialization_support will be read
# from /etc/swift/memcache.conf (see memcache.conf-sample).
# To avoid an instant full cache flush, existing installations should
# upgrade with 0, then set to 1 and reload, then after some time (24 hours)
# set to 2 and reload.
# In the future, the ability to use pickle serialization will be removed.
# memcache_serialization_support = 2
#
# Sets the maximum number of connections to each memcached server per worker
# memcache_max_connections = 2
#
798
CHAPTER 10. OBJECT STORAGE
# More options documented in memcache.conf-sample
[filter:ratelimit] use = egg:swift#ratelimit
# You can override the default log routing for this filter here:
# set log_name = ratelimit
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = false
# set log_address = /dev/log
#
# clock_accuracy should represent how accurate the proxy servers' system clocks
# are with each other. 1000 means that all the proxies' clock are accurate to
# each other within 1 millisecond. No ratelimit should be higher than the
# clock accuracy.
# clock_accuracy = 1000
#
# max_sleep_time_seconds = 60
#
# log_sleep_time_seconds of 0 means disabled
# log_sleep_time_seconds = 0
#
# allows for slow rates (e.g. running up to 5 sec's behind) to catch up.
# rate_buffer_seconds = 5
#
# account_ratelimit of 0 means disabled
# account_ratelimit = 0
# DEPRECATED- these will continue to work but will be replaced
# by the X-Account-Sysmeta-Global-Write-Ratelimit flag.
# Please see ratelimiting docs for details.
# these are comma separated lists of account names
# account_whitelist = a,b
# account_blacklist = c,d
# with container_limit_x = r
# for containers of size x limit write requests per second to r. The container
# rate will be linearly interpolated from the values given. With the values
# below, a container of size 5 will get a rate of 75.
# container_ratelimit_0 = 100
# container_ratelimit_10 = 50
# container_ratelimit_50 = 20
# Similarly to the above container-level write limits, the following will limit
# container GET (listing) requests.
# container_listing_ratelimit_0 = 100
# container_listing_ratelimit_10 = 50
# container_listing_ratelimit_50 = 20
[filter:domain_remap]
799
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
use = egg:swift#domain_remap
# You can override the default log routing for this filter here:
# set log_name = domain_remap
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = false
# set log_address = /dev/log
#
# storage_domain = example.com
# path_root = v1
# reseller_prefixes = AUTH
[filter:catch_errors] use = egg:swift#catch_errors
# You can override the default log routing for this filter here:
# set log_name = catch_errors
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = false
# set log_address = /dev/log
[filter:cname_lookup]
# Note: this middleware requires python-dnspython use = egg:swift#cname_lookup
# You can override the default log routing for this filter here:
# set log_name = cname_lookup
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = false
# set log_address = /dev/log
#
# Specify the storage_domain that match your cloud, multiple domains
# can be specified separated by a comma
# storage_domain = example.com
#
# lookup_depth = 1
# Note: Put staticweb just after your auth filter(s) in the pipeline
[filter:staticweb] use = egg:swift#staticweb
# Note: Put tempurl before dlo, slo and your auth filter(s) in the pipeline
[filter:tempurl] use = egg:swift#tempurl
# The methods allowed with Temp URLs.
# methods = GET HEAD PUT POST DELETE
#
# The headers to remove from incoming requests. Simply a whitespace delimited
# list of header names and names can optionally end with '*' to indicate a
# prefix match. incoming_allow_headers is a list of exceptions to these
# removals.
# incoming_remove_headers = x-timestamp
#
800
CHAPTER 10. OBJECT STORAGE
# The headers allowed as exceptions to incoming_remove_headers. Simply a
# whitespace delimited list of header names and names can optionally end with
# '*' to indicate a prefix match.
# incoming_allow_headers =
#
# The headers to remove from outgoing responses. Simply a whitespace delimited
# list of header names and names can optionally end with '*' to indicate a
# prefix match. outgoing_allow_headers is a list of exceptions to these
# removals.
# outgoing_remove_headers = x-object-meta-*
#
# The headers allowed as exceptions to outgoing_remove_headers. Simply a
# whitespace delimited list of header names and names can optionally end with
# '*' to indicate a prefix match.
# outgoing_allow_headers = x-object-meta-public-*
# Note: Put formpost just before your auth filter(s) in the pipeline
[filter:formpost] use = egg:swift#formpost
# Note: Just needs to be placed before the proxy-server in the pipeline.
[filter:name_check] use = egg:swift#name_check
# forbidden_chars = '"`<>
# maximum_length = 255
# forbidden_regexp = /\./|/\.\./|/\.$|/\.\.$
[filter:list-endpoints] use = egg:swift#list_endpoints
# list_endpoints_path = /endpoints/
[filter:proxy-logging] use = egg:swift#proxy_logging
# If not set, logging directives from [DEFAULT] without "access_" will be used
# access_log_name = swift
# access_log_facility = LOG_LOCAL0
# access_log_level = INFO
# access_log_address = /dev/log
#
# If set, access_log_udp_host will override access_log_address
# access_log_udp_host =
# access_log_udp_port = 514
#
# You can use log_statsd_* from [DEFAULT] or override them here:
# access_log_statsd_host = localhost
# access_log_statsd_port = 8125
# access_log_statsd_default_sample_rate = 1.0
# access_log_statsd_sample_rate_factor = 1.0
# access_log_statsd_metric_prefix =
# access_log_headers = false
#
801
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# If access_log_headers is True and access_log_headers_only is set only
# these headers are logged. Multiple headers can be defined as comma separated
# list like this: access_log_headers_only = Host, X-Object-Meta-Mtime
# access_log_headers_only =
#
# By default, the X-Auth-Token is logged. To obscure the value,
# set reveal_sensitive_prefix to the number of characters to log.
# For example, if set to 12, only the first 12 characters of the
# token appear in the log. An unauthorized access of the log file
# won't allow unauthorized usage of the token. However, the first
# 12 or so characters is unique enough that you can trace/debug
# token usage. Set to 0 to suppress the token completely (replaced
# by '...' in the log).
# Note: reveal_sensitive_prefix will not affect the value
# logged with access_log_headers=True.
# reveal_sensitive_prefix = 16
#
# What HTTP methods are allowed for StatsD logging (comma-sep); request methods
# not in this list will have "BAD_METHOD" for the <verb> portion of the metric.
# log_statsd_valid_http_methods = GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS
#
# Note: The double proxy-logging in the pipeline is not a mistake. The
# left-most proxy-logging is there to log requests that were handled in
# middleware and never made it through to the right-most middleware (and
# proxy server). Double logging is prevented for normal requests. See
# proxy-logging docs.
# Note: Put before both ratelimit and auth in the pipeline.
[filter:bulk] use = egg:swift#bulk
# max_containers_per_extraction = 10000
# max_failed_extractions = 1000
# max_deletes_per_request = 10000
# max_failed_deletes = 1000
# In order to keep a connection active during a potentially long bulk request,
# Swift may return whitespace prepended to the actual response body. This
# whitespace will be yielded no more than every yield_frequency seconds.
# yield_frequency = 10
# Note: The following parameter is used during a bulk delete of objects and
# their container. This would frequently fail because it is very likely
# that all replicated objects have not been deleted by the time the middleware got a
# successful response. It can be configured the number of retries. And the
# number of seconds to wait between each retry will be 1.5**retry
# delete_container_retry_count = 0
# Note: Put after auth and staticweb in the pipeline.
802
CHAPTER 10. OBJECT STORAGE
[filter:slo] use = egg:swift#slo
# max_manifest_segments = 1000
# max_manifest_size = 2097152
# min_segment_size = 1048576
# Start rate-limiting SLO segment serving after the Nth segment of a
# segmented object.
# rate_limit_after_segment = 10
#
# Once segment rate-limiting kicks in for an object, limit segments served
# to N per second. 0 means no rate-limiting.
# rate_limit_segments_per_sec = 0
#
# Time limit on GET requests (seconds)
# max_get_time = 86400
# Note: Put after auth and staticweb in the pipeline.
# If you don't put it in the pipeline, it will be inserted for you.
[filter:dlo] use = egg:swift#dlo
# Start rate-limiting DLO segment serving after the Nth segment of a
# segmented object.
# rate_limit_after_segment = 10
#
# Once segment rate-limiting kicks in for an object, limit segments served
# to N per second. 0 means no rate-limiting.
# rate_limit_segments_per_sec = 1
#
# Time limit on GET requests (seconds)
# max_get_time = 86400
# Note: Put after auth in the pipeline.
[filter:container-quotas] use = egg:swift#container_quotas
# Note: Put after auth in the pipeline.
[filter:account-quotas] use = egg:swift#account_quotas
[filter:gatekeeper] use = egg:swift#gatekeeper
# You can override the default log routing for this filter here:
# set log_name = gatekeeper
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = false
# set log_address = /dev/log
[filter:container_sync] use = egg:swift#container_sync
# Set this to false if you want to disallow any full url values to be set for
# any new X-Container-Sync-To headers. This will keep any new full urls from
803
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# coming in, but won't change any existing values already in the cluster.
# Updating those will have to be done manually, as knowing what the true realm
# endpoint should be cannot always be guessed.
# allow_full_urls = true
# Set this to specify this clusters //realm/cluster as "current" in /info
# current = //REALM/CLUSTER
# Note: Put it at the beginning of the pipeline to profile all middleware. But
# it is safer to put this after catch_errors, gatekeeper and healthcheck.
[filter:xprofile] use = egg:swift#xprofile
# This option enable you to switch profilers which should inherit from python
# standard profiler. Currently the supported value can be 'cProfile',
# 'eventlet.green.profile' etc.
# profile_module = eventlet.green.profile
#
# This prefix will be used to combine process ID and timestamp to name the
# profile data file. Make sure the executing user has permission to write
# into this path (missing path segments will be created, if necessary).
# If you enable profiling in more than one type of daemon, you must override
# it with an unique value like: /var/log/swift/profile/proxy.profile
# log_filename_prefix = /tmp/log/swift/profile/default.profile
#
# the profile data will be dumped to local disk based on above naming rule
# in this interval.
# dump_interval = 5.0
#
# Be careful, this option will enable profiler to dump data into the file with
# time stamp which means there will be lots of files piled up in the directory.
# dump_timestamp = false
#
# This is the path of the URL to access the mini web UI.
# path = /__profile__
#
# Clear the data when the wsgi server shutdown.
# flush_at_shutdown = false
#
# unwind the iterator of applications
# unwind = false
10.10. PROXY SERVER MEMCACHE CONFIGURATION
Find an example memcache configuration for the proxy server at etc/memcache.conf-sample in the source code repository.
804
CHAPTER 10. OBJECT STORAGE
The available configuration options are:
Table 10.63. Description of configuration options for [memcache] in memcache.conf
Configuration option = Default value connect_timeout
= 0.3
io_timeout
= 2.0
memcache_max_connections
= 2
memcache_serialization_support
= 2
memcache_servers pool_timeout tries
= 3
= 1.0
= 127.0.0.1:11211
Description
Timeout in seconds (float) for connection
Timeout in seconds (float) for read and write
Max number of connections to each memcached server per worker services
Sets how memcache values are serialized and deserialized
Comma-separated list of memcached servers ip:port services
Timeout in seconds (float) for pooled connection
Number of servers to retry on failures getting a pooled connection
10.11. RSYNCD CONFIGURATION
Find an example rsyncd configuration at etc/rsyncd.conf-sample in the source code repository.
The available configuration options are:
Table 10.64. Description of configuration options for [account] in rsyncd.conf
Configuration option = Default value lock file
= /var/lock/account.lock
max connections
= 2
path
= /srv/node
read only
= false
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Table 10.65. Description of configuration options for [container] in rsyncd.conf
805
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value lock file
= /var/lock/container.lock
max connections
= 4
path
= /srv/node
read only
= false
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Table 10.66. Description of configuration options for [object] in rsyncd.conf
Configuration option = Default value lock file
= /var/lock/object.lock
max connections
= 8
path
= /srv/node
read only
= false
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
806
10.12. CONFIGURE OBJECT STORAGE FEATURES
10.12.1. Object Storage zones
In OpenStack Object Storage, data is placed across different tiers of failure domains. First, data is spread across regions, then zones, then servers, and finally across drives. Data is placed to get the highest failure domain isolation. If you deploy multiple regions, the Object Storage service places the data across the regions. Within a region, each replica of the data should be stored in unique zones, if possible. If there is only one zone, data should be placed on different servers. And if there is only one server, data should be placed on different drives.
Regions are widely separated installations with a high-latency or otherwise constrained network link between them. Zones are arbitrarily assigned, and it is up to the administrator of the Object Storage cluster to choose an isolation level and attempt to maintain the isolation level through appropriate zone assignment. For example, a zone may be defined as a rack with a single power source. Or a zone may be a DC room with a common utility provider. Servers are identified by a unique IP/port.
Drives are locally attached storage volumes identified by mount point.
In small clusters (five nodes or fewer), everything is normally in a single zone. Larger Object
Storage deployments may assign zone designations differently; for example, an entire cabinet or rack of servers may be designated as a single zone to maintain replica availability if the cabinet becomes unavailable (for example, due to failure of the top of rack switches or a dedicated circuit).
In very large deployments, such as service provider level deployments, each zone might have an entirely autonomous switching and power infrastructure, so that even the loss of an electrical circuit or switching aggregator would result in the loss of a single replica at most.
CHAPTER 10. OBJECT STORAGE
10.12.2. RAID controller configuration
OpenStack Object Storage does not require RAID. In fact, most RAID configurations cause significant performance degradation. The main reason for using a RAID controller is the batterybacked cache. It is very important for data integrity reasons that when the operating system confirms a write has been committed that the write has actually been committed to a persistent location. Most disks lie about hardware commits by default, instead writing to a faster write cache for performance reasons. In most cases, that write cache exists only in non-persistent memory. In the case of a loss of power, this data may never actually get committed to disk, resulting in discrepancies that the underlying file system must handle.
OpenStack Object Storage works best on the XFS file system, and this document assumes that the hardware being used is configured appropriately to be mounted with the nobarriers option. For more information, refer to the XFS FAQ: http://xfs.org/index.php/XFS_FAQ
To get the most out of your hardware, it is essential that every disk used in OpenStack Object
Storage is configured as a standalone, individual RAID 0 disk; in the case of 6 disks, you would have six RAID 0s or one JBOD. Some RAID controllers do not support JBOD or do not support battery backed cache with JBOD. To ensure the integrity of your data, you must ensure that the individual drive caches are disabled and the battery backed cache in your RAID card is configured and used. Failure to configure the controller properly in this case puts data at risk in the case of sudden loss of power.
You can also use hybrid drives or similar options for battery backed up cache configurations without a RAID controller.
10.12.3. Throttle resources through rate limits
Rate limiting in OpenStack Object Storage is implemented as a pluggable middleware that you configure on the proxy server. Rate limiting is performed on requests that result in database writes to the account and container SQLite databases. It uses memcached and is dependent on the proxy servers having highly synchronized time. The rate limits are limited by the accuracy of the proxy server clocks.
10.12.3.1. Configure rate limiting
All configuration is optional. If no account or container limits are provided, no rate limiting occurs.
Available configuration options include:
Table 10.67. Description of configuration options for [filter-ratelimit] in proxyserver.conf
Configuration option = Default value Description
807
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value account_blacklist
= c,d
account_ratelimit account_whitelist clock_accuracy
= 1000
container_listing_ratelimit_0
= 100
container_listing_ratelimit_10
= 50
container_listing_ratelimit_50
= 20
container_ratelimit_0
= 100
container_ratelimit_10
= 50
container_ratelimit_50
= 20
log_sleep_time_seconds
= 0
max_sleep_time_seconds rate_buffer_seconds set log_address
= 0
= a,b
= 5
= /dev/log
set log_facility
= 60
= LOG_LOCAL0
Description
Comma separated lists of account names that will not be allowed. Returns a 497 response. r: for containers of size x, limit requests per second to r.
Will limit PUT, DELETE, and POST requests to
/a/c/o. container_listing_ratelimit_x = r: for containers of size x, limit listing requests per second to r. Will limit GET requests to /a/c.
If set, will limit PUT and DELETE requests to
/account_name/container_name. Number is in requests per second.
Comma separated lists of account names that will not be rate limited.
Represents how accurate the proxy servers' system clocks are with each other. 1000 means that all the proxies' clock are accurate to each other within 1 millisecond. No ratelimit should be higher than the clock accuracy.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
To allow visibility into rate limiting set this value > 0 and all sleeps greater than the number will be logged.
App will immediately return a 498 response if the necessary sleep time ever exceeds the given max_sleep_time_seconds.
Number of seconds the rate counter can drop and be allowed to catch up (at a faster than listed rate).
A larger number will result in larger spikes in rate but better average accuracy.
Location where syslog sends the logs to
Syslog log facility
808
Configuration option = Default value set log_headers
= false
set log_level
= INFO
set log_name
= ratelimit
use
= egg:swift#ratelimit
with container_limit_x
= r
CHAPTER 10. OBJECT STORAGE
Description
If True, log headers in each request
Log level
Label to use when logging
Entry point of paste.deploy in the server
No help text available for this option.
The container rate limits are linearly interpolated from the values given. A sample container rate limiting could be: container_ratelimit_100 = 100 container_ratelimit_200 = 50 container_ratelimit_500 = 20
This would result in:
Table 10.68. Values for Rate Limiting with Sample Configuration Settings
Container Size
0-99
100
150
500
1000
20
20
Rate Limit
No limiting
100
75
10.12.4. Health check
Provides an easy way to monitor whether the Object Storage proxy server is alive. If you access the proxy with the path /healthcheck, it responds with OK in the response body, which monitoring tools can use.
Table 10.69. Description of configuration options for [filter-healthcheck] in accountserver.conf
809
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value disable_path
=
use
= egg:swift#healthcheck
Description
No help text available for this option.
Entry point of paste.deploy in the server
10.12.5. Domain remap
Middleware that translates container and account parts of a domain to path parameters that the proxy server understands.
Table 10.70. Description of configuration options for [filter-domain_remap] in proxyserver.conf
Configuration option = Default value path_root
= v1
reseller_prefixes
= AUTH
set log_address
= /dev/log
set log_facility
= LOG_LOCAL0
set log_headers
= false
set log_level
= INFO
set log_name
= domain_remap
storage_domain
= example.com
use
= egg:swift#domain_remap
Description
Root path
Reseller prefix
Location where syslog sends the logs to
Syslog log facility
If True, log headers in each request
Log level
Label to use when logging
Domain that matches your cloud. Multiple domains can be specified using a comma-separated list.
Entry point of paste.deploy in the server
10.12.6. CNAME lookup
Middleware that translates an unknown domain in the host header to something that ends with the configured storage_domain by looking up the given domain's CNAME record in DNS.
Table 10.71. Description of configuration options for [filter-cname_lookup] in proxyserver.conf
810
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value lookup_depth
= 1
set log_address
= /dev/log
set log_facility
= LOG_LOCAL0
set log_headers
= false
set log_level
= INFO
set log_name
= cname_lookup
storage_domain
= example.com
Description
Because CNAMES can be recursive, specifies the number of levels through which to search.
Location where syslog sends the logs to
Syslog log facility
If True, log headers in each request
Log level
Label to use when logging
Domain that matches your cloud. Multiple domains can be specified using a comma-separated list.
Entry point of paste.deploy in the server
use
= egg:swift#cname_lookup
10.12.7. Temporary URL
Allows the creation of URLs to provide temporary access to objects. For example, a website may wish to provide a link to download a large object in OpenStack Object Storage, but the Object
Storage account has no public access. The website can generate a URL that provides GET access for a limited time to the resource. When the web browser user clicks on the link, the browser downloads the object directly from Object Storage, eliminating the need for the website to act as a proxy for the request. If the user shares the link with all his friends, or accidentally posts it on a forum, the direct access is limited to the expiration time set when the website created the link.
A temporary URL is the typical URL associated with an object, with two additional query parameters:
temp_url_sig
A cryptographic signature
temp_url_expires
An expiration date, in Unix time
An example of a temporary URL:
https://swift-cluster.example.com/v1/AUTH_a422b2-91f3-2f46-74b7d7c9e8958f5d30/container/object?
temp_url_sig=da39a3ee5e6b4b0d3255bfef95601890afd80709&
temp_url_expires=1323479485
811
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
To create temporary URLs, first set the X-Account-Meta-Temp-URL-Key header on your Object
Storage account to an arbitrary string. This string serves as a secret key. For example, to set a key of b3968d0207b54ece87cccc06515a89d4 using the swift command-line tool:
$ swift post -m "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"
Next, generate an HMAC-SHA1 (RFC 2104) signature to specify:
Which HTTP method to allow (typically GET or PUT)
The expiry date as a Unix timestamp
The full path to the object
The secret key set as the X-Account-Meta-Temp-URL-Key
Here is code generating the signature for a GET for 24 hours on
/v1/AUTH_account/container/object: import hmac from hashlib import sha1 from time import time method = 'GET' duration_in_seconds = 60 * 60 * 24 expires = int(time() + duration_in_seconds) path = '/v1/AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30/container/object' key = 'mykey' hmac_body = '%s\n%s\n%s' % (method, expires, path) sig = hmac.new(key, hmac_body, sha1).hexdigest() s = 'https://{host}/{path}?temp_url_sig={sig}&temp_url_expires={expires}' url = s.format(host= 'swift-cluster.example.com' , path=path, sig=sig, expires=expires)
Any alteration of the resource path or query arguments results in a 401 Unauthorized error.
Similarly, a PUT where GET was the allowed method returns a 401. HEAD is allowed if GET or PUT is allowed. Using this in combination with browser form post translation middleware could also allow direct-from-browser uploads to specific locations in Object Storage.
Note
Changing the X-Account-Meta-Temp-URL-Key invalidates any previously generated temporary URLs within 60 seconds (the memcache time for the key). Object Storage supports up to two keys, specified by X-Account-Meta-Temp-URL-Key and X-
Account-Meta-Temp-URL-Key-2. Signatures are checked against both keys, if present. This is to allow for key rotation without invalidating all existing temporary URLs.
Object Storage includes a script called swift-temp-url that generates the query parameters automatically:
812
CHAPTER 10. OBJECT STORAGE
$ bin/swift-temp-url GET 3600 /v1/AUTH_account/container/object mykey
/v1/AUTH_account/container/object?
temp_url_sig=5c4cc8886f36a9d0919d708ade98bf0cc71c9e91& temp_url_expires=1374497657
Because this command only returns the path, you must prefix the Object Storage host name (for example, https://swift-cluster.example.com).
With GET Temporary URLs, a Content-Disposition header is set on the response so that browsers interpret this as a file attachment to be saved. The file name chosen is based on the object name, but you can override this with a filename query parameter. The following example specifies a filename of My Test File.pdf: https://swift-cluster.example.com/v1/AUTH_a422b2-91f3-2f46-74b7d7c9e8958f5d30/container/object?
temp_url_sig=da39a3ee5e6b4b0d3255bfef95601890afd80709& temp_url_expires=1323479485& filename=My+Test+File.pdf
If you do not want the object to be downloaded, you can cause Content-Disposition: inline to be set on the response by adding the inline parameter to the query string, as follows: https://swift-cluster.example.com/v1/AUTH_account/container/object?
temp_url_sig=da39a3ee5e6b4b0d3255bfef95601890afd80709& temp_url_expires=1323479485&inline
To enable Temporary URL functionality, edit /etc/swift/proxy-server.conf to add tempurl to the pipeline variable defined in the [pipeline:main] section. The tempurl entry should appear immediately before the authentication filters in the pipeline, such as authtoken, tempauth or keystoneauth. For example:
[pipeline:main] pipeline = pipeline = healthcheck cache tempurl authtoken keystoneauth proxy-server
Table 10.72. Description of configuration options for [filter-tempurl] in proxyserver.conf
Configuration option = Default value incoming_allow_headers
=
Description
Headers allowed as exceptions to incoming_remove_headers. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
813
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value incoming_remove_headers
= x-timestamp
methods
= GET HEAD PUT POST DELETE
outgoing_allow_headers
= x-object-meta-
public-*
outgoing_remove_headers
meta-*
use
= egg:swift#tempurl
= x-object-
Description
Headers to remove from incoming requests.
Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
HTTP methods allowed with Temporary URLs
Headers allowed as exceptions to outgoing_allow_headers. Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
Headers to remove from outgoing responses.
Simply a whitespace delimited list of header names and names can optionally end with '*' to indicate a prefix match.
Entry point of paste.deploy in the server
10.12.8. Name Check filter
Name Check is a filter that disallows any paths that contain defined forbidden characters or that exceed a defined length.
Table 10.73. Description of configuration options for [filter-name_check] in proxyserver.conf
Configuration option = Default value forbidden_chars
= '"`<>
forbidden_regexp
= /\./|/\.\./|/\.$|/\.\.$
Description
Characters that are not allowed in a name
Substrings to forbid, using regular expression syntax
Maximum length of a name
Entry point of paste.deploy in the server
maximum_length
= 255
use
= egg:swift#name_check
814
10.12.9. Constraints
To change the OpenStack Object Storage internal limits, update the values in the swift-
constraints section in the swift.conf file. Use caution when you update these values because they affect the performance in the entire cluster.
Table 10.74. Description of configuration options for [swift-constraints] in swift.conf
CHAPTER 10. OBJECT STORAGE
Configuration option = Default value account_listing_limit
= 10000
container_listing_limit
= 10000
max_account_name_length
= 256
max_container_name_length
= 256
max_file_size
= 5368709122
max_header_size
= 8192
max_meta_count
= 90
max_meta_name_length
= 128
max_meta_overall_size
= 4096
max_meta_value_length
= 256
max_object_name_length
= 1024
Description
The default (and maximum) number of items returned for an account listing request.
The default (and maximum) number of items returned for a container listing request.
The maximum number of bytes in the utf8 encoding of an account name.
The maximum number of bytes in the utf8 encoding of a container name.
The largest normal object that can be saved in the cluster. This is also the limit on the size of each segment of a large object when using the large object manifest support. This value is set in bytes.
Setting it to lower than 1MiB will cause some tests to fail. It is STRONGLY recommended to leave this value at the default (5 * 2**30 + 2).
The max number of bytes in the utf8 encoding of each header. Using 8192 as default because eventlet use 8192 as maximum size of header line.
You may need to increase this value when using identity v3 API tokens including more than 7 catalog entries. See also include_service_catalog in proxy-server.conf-sample (documented in overview_auth.rst).
The max number of metadata keys that can be stored on a single account, container, or object.
The max number of bytes in the utf8 encoding of the name portion of a metadata header.
The max number of bytes in the utf8 encoding of the metadata (keys + values).
The max number of bytes in the utf8 encoding of a metadata value.
The max number of bytes in the utf8 encoding of an object name.
No help text available for this option.
valid_api_versions
= v0,v1,v2
10.12.10. Cluster health
Use the swift-dispersion-report tool to measure overall cluster health. This tool checks if a
815
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
set of deliberately distributed containers and objects are currently in their proper places within the cluster. For instance, a common deployment has three replicas of each object. The health of that object can be measured by checking if each replica is in its proper place. If only two of the three is in place, the object's health can be said to be at 66.66%, where 100% would be perfect. A single object's health, especially an older object, usually reflects the health of that entire partition the object is in. If you make enough objects on a distinct percentage of the partitions in the cluster, you get a good estimate of the overall cluster health. In practice, about 1% partition coverage seems to balance well between accuracy and the amount of time it takes to gather results. First, to provide this health value, create a new account solely for this usage. Next, place the containers and objects throughout the system so that they are on distinct partitions. The swift-dispersion-populate tool does this by making up random container and object names until they fall on distinct partitions.
Last, and repeatedly for the life of the cluster, you must run the swift-dispersion-report tool to check the health of each of these containers and objects. These tools need direct access to the entire cluster and to the ring files (installing them on a proxy server suffices). The swift-
dispersion-populate and swift-dispersion-report commands both use the same configuration file, /etc/swift/dispersion.conf. Example dispersion.conf file:
[dispersion] auth_url = http://localhost:8080/auth/v1.0
auth_user = test:tester auth_key = testing
There are also configuration options for specifying the dispersion coverage, which defaults to 1%, retries, concurrency, and so on. However, the defaults are usually fine. Once the configuration is in place, run swift-dispersion-populate to populate the containers and objects throughout the cluster. Now that those containers and objects are in place, you can run swift-dispersion-
report to get a dispersion report, or the overall health of the cluster. Here is an example of a cluster in perfect health:
$ swift-dispersion-report
Queried 2621 containers for dispersion reporting, 19s, 0 retries
100.00% of container copies found (7863 of 7863)
Sample represents 1.00% of the container partition space
Queried 2619 objects for dispersion reporting, 7s, 0 retries
100.00% of object copies found (7857 of 7857)
Sample represents 1.00% of the object partition space
Now, deliberately double the weight of a device in the object ring (with replication turned off) and rerun the dispersion report to show what impact that has:
$ swift-ring-builder object.builder set_weight d0 200
$ swift-ring-builder object.builder rebalance
...
$ swift-dispersion-report
Queried 2621 containers for dispersion reporting, 8s, 0 retries
100.00% of container copies found (7863 of 7863)
Sample represents 1.00% of the container partition space
Queried 2619 objects for dispersion reporting, 7s, 0 retries
There were 1763 partitions missing one copy.
77.56% of object copies found (6094 of 7857)
Sample represents 1.00% of the object partition space
816
CHAPTER 10. OBJECT STORAGE
You can see the health of the objects in the cluster has gone down significantly. Of course, this test environment has just four devices, in a production environment with many devices the impact of one device change is much less. Next, run the replicators to get everything put back into place and then rerun the dispersion report:
... start object replicators and monitor logs until they're caught up ...
$ swift-dispersion-report
Queried 2621 containers for dispersion reporting, 17s, 0 retries
100.00% of container copies found (7863 of 7863)
Sample represents 1.00% of the container partition space
Queried 2619 objects for dispersion reporting, 7s, 0 retries
100.00% of object copies found (7857 of 7857)
Sample represents 1.00% of the object partition space
Alternatively, the dispersion report can also be output in JSON format. This allows it to be more easily consumed by third-party utilities:
$ swift-dispersion-report -j
{"object": {"retries:": 0, "missing_two": 0, "copies_found": 7863,
"missing_one": 0,
"copies_expected": 7863, "pct_found": 100.0, "overlapping": 0,
"missing_all": 0}, "container":
{"retries:": 0, "missing_two": 0, "copies_found": 12534, "missing_one":
0, "copies_expected":
12534, "pct_found": 100.0, "overlapping": 15, "missing_all": 0}}
Table 10.75. Description of configuration options for [dispersion] in dispersion.conf
Configuration option = Default value auth_key
= testing
auth_url
= http://localhost:8080/auth/v1.0
auth_user
= test:tester
auth_version
= 1.0
concurrency
= 25
container_populate
= yes
container_report
= yes
dispersion_coverage
= 1.0
dump_json
= no
Description
No help text available for this option.
Endpoint for auth server, such as keystone
Default user for dispersion in this context
Indicates which version of auth
Number of replication workers to spawn
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
817
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value endpoint_type
= publicURL
keystone_api_insecure
= no
object_populate
= yes
object_report
= yes
retries
= 5
swift_dir
= /etc/swift
Description
Indicates whether endpoint for auth is public or internal
Allow accessing insecure keystone server. The keystone's certificate will not be verified.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Swift configuration directory
10.12.11. Static Large Object (SLO) support
This feature is similar to Dynamic Large Object (DLO) support in that it enables the user to upload many objects concurrently and afterwards download them as a single object. It is different in that it does not rely on eventually consistent container listings to do so. Instead, a user-defined manifest of the object segments is used.
Table 10.76. Description of configuration options for [filter-slo] in proxy-server.conf
Configuration option = Default value max_get_time
= 86400
max_manifest_segments
= 1000
max_manifest_size
= 2097152
min_segment_size
= 1048576
rate_limit_after_segment
= 10
rate_limit_segments_per_sec
= 0
use
= egg:swift#slo
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Rate limit the download of large object segments after this segment is downloaded.
Rate limit large object downloads at this rate.
contact for a normal request. You can use '* replicas' at the end to have it use the number given times the number of replicas for the ring being used for the request. paste.deploy to use for auth. To use tempauth set to: `egg:swift#tempauth` each request
Entry point of paste.deploy in the server
818
CHAPTER 10. OBJECT STORAGE
10.12.12. Container quotas
The container_quotas middleware implements simple quotas that can be imposed on Object
Storage containers by a user with the ability to set container metadata, most likely the account administrator. This can be useful for limiting the scope of containers that are delegated to non-admin users, exposed to formpost uploads, or just as a self-imposed sanity check.
Any object PUT operations that exceed these quotas return a 403 response (forbidden).
Quotas are subject to several limitations: eventual consistency, the timeliness of the cached container_info (60 second TTL by default), and it is unable to reject chunked transfer uploads that exceed the quota (though once the quota is exceeded, new chunked transfers are refused).
Set quotas by adding meta values to the container. These values are validated when you set them:
X-Container-Meta-Quota-Bytes: Maximum size of the container, in bytes.
X-Container-Meta-Quota-Count: Maximum object count of the container.
Table 10.77. Description of configuration options for [filter-container-quotas] in proxy-server.conf
Configuration option = Default value use
= egg:swift#container_quotas
Description
Entry point of paste.deploy in the server
10.12.13. Account quotas
The x-account-meta-quota-bytes metadata entry must be requests (PUT, POST) if a given account quota (in bytes) is exceeded while DELETE requests are still allowed.
The x-account-meta-quota-bytes metadata entry must be set to store and enable the quota.
Write requests to this metadata entry are only permitted for resellers. There is no account quota limitation on a reseller account even if x-account-meta-quota-bytes is set.
Any object PUT operations that exceed the quota return a 413 response (request entity too large) with a descriptive body.
The following command uses an admin account that own the Reseller role to set a quota on the test account:
$ swift -A http://127.0.0.1:8080/auth/v1.0 -U admin:admin -K admin \ -os-storage-url http://127.0.0.1:8080/v1/AUTH_test post -m quotabytes:10000
Here is the stat listing of an account where quota has been set:
819
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
$ swift -A http://127.0.0.1:8080/auth/v1.0 -U test:tester -K testing stat
Account: AUTH_test
Containers: 0
Objects: 0
Bytes: 0
Meta Quota-Bytes: 10000
X-Timestamp: 1374075958.37454
X-Trans-Id: tx602634cf478546a39b1be-0051e6bc7a
This command removes the account quota:
$ swift -A http://127.0.0.1:8080/auth/v1.0 -U admin:admin -K admin -os-storage-url http://127.0.0.1:8080/v1/AUTH_test post -m quota-bytes:
10.12.14. Bulk delete
Use bulk-delete to delete multiple files from an account with a single request. Responds to
DELETE requests with a header 'X-Bulk-Delete: true_value'. The body of the DELETE request is a new line-separated list of files to delete. The files listed must be URL encoded and in the form:
/container_name/obj_name
If all files are successfully deleted (or did not exist), the operation returns HTTPOk. If any files failed to delete, the operation returns HTTPBadGateway. In both cases, the response body is a JSON dictionary that shows the number of files that were successfully deleted or not found. The files that failed are listed.
Table 10.78. Description of configuration options for [filter-bulk] in proxyserver.conf
Configuration option = Default value delete_container_retry_count
= 0
max_containers_per_extraction
=
10000
max_deletes_per_request
= 10000
max_failed_deletes
= 1000
max_failed_extractions
= 1000
use
= egg:swift#bulk
yield_frequency
= 10
Description
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
No help text available for this option.
Entry point of paste.deploy in the server
No help text available for this option.
820
CHAPTER 10. OBJECT STORAGE
10.12.15. Drive audit
The swift-drive-audit configuration items reference a script that can be run by using cron to watch for bad drives. If errors are detected, it unmounts the bad drive, so that OpenStack Object
Storage can work around it. It takes the following options:
Table 10.79. Description of configuration options for [drive-audit] in drive-audit.conf
Configuration option = Default value device_dir
= /srv/node
error_limit
= 1
log_address
= /dev/log
log_facility
= LOG_LOCAL0
log_file_pattern
= /var/log/kern.*[!.][!g][!z]
log_level log_max_line_length log_to_console minutes regex_pattern_1
= \berror\b.*\b(dm-[0-9]
{1,2}\d?)\b
= INFO
= 60
= 0
= False
recon_cache_path
= /var/cache/swift
unmount_failed_device
= True
Description
Directory devices are mounted under
Number of errors to find before a device is unmounted
Location where syslog sends the logs to
Syslog log facility
Location of the log file with globbing pattern to check against device errors locate device blocks with errors in the log file
Logging level
Caps the length of log lines to the value given; no limit if set to 0, the default.
No help text available for this option.
Number of minutes to look back in
`/var/log/kern.log`
Directory where stats for a few items will be stored
No help text available for this option.
No help text available for this option.
10.12.16. Form post
Middleware that provides the ability to upload objects to a cluster using an HTML form POST. The format of the form is:
<![CDATA[
<form action="<swift-url>" method="POST"
enctype="multipart/form-data">
<input type="hidden" name="redirect" value="<redirect-url>" />
821
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
<input type="hidden" name="max_file_size" value="<bytes>" />
<input type="hidden" name="max_file_count" value="<count>" />
<input type="hidden" name="expires" value="<unix-timestamp>" />
<input type="hidden" name="signature" value="<hmac>" />
<input type="file" name="file1" /><br />
<input type="submit" />
</form>]]>
The swift-url is the URL to the Object Storage destination, such as: https://swiftcluster.example.com/v1/AUTH_account/container/object_prefix The name of each file uploaded is appended to the specified swift-url. So, you can upload directly to the root of container with a
URL like: https://swift-cluster.example.com/v1/AUTH_account/container/ Optionally, you can include an object prefix to better separate different users' uploads, such as: https://swiftcluster.example.com/v1/AUTH_account/container/object_prefix
Note
The form method must be POST and the enctype must be set as multipart/form-
data.
The redirect attribute is the URL to redirect the browser to after the upload completes. The URL has status and message query parameters added to it, indicating the HTTP status code for the upload
(2xx is success) and a possible message for further information if there was an error (such as
"max_file_size exceeded").
The max_file_size attribute must be included and indicates the largest single file upload that can be done, in bytes.
The max_file_count attribute must be included and indicates the maximum number of files that can be uploaded with the form. Include additional <![CDATA[<input type="file"
name="filexx"/>]]> attributes if desired.
The expires attribute is the Unix timestamp before which the form must be submitted before it is invalidated.
The signature attribute is the HMAC-SHA1 signature of the form. This sample Python code shows how to compute the signature: import hmac from hashlib import sha1 from time import time path = '/v1/account/container/object_prefix' redirect = 'https://myserver.com/some-page' max_file_size = 104857600 max_file_count = 10 expires = int(time() + 600 ) key = 'mykey' hmac_body = '%s\n%s\n%s\n%s\n%s' % (path, redirect,
max_file_size, max_file_count, expires) signature = hmac.new(key, hmac_body, sha1).hexdigest()
822
CHAPTER 10. OBJECT STORAGE
The key is the value of the X-Account-Meta-Temp-URL-Key header on the account.
Be certain to use the full path, from the /v1/ onward.
The command-line tool swift-form-signature may be used (mostly just when testing) to compute expires and signature.
The file attributes must appear after the other attributes to be processed correctly. If attributes come after the file, they are not sent with the sub-request because on the server side, all attributes in the file cannot be parsed unless the whole file is read into memory and the server does not have enough memory to service these requests. So, attributes that follow the file are ignored.
Table 10.80. Description of configuration options for [filter-formpost] in proxyserver.conf
Configuration option = Default value use
= egg:swift#formpost
Description
Entry point of paste.deploy in the server
10.12.17. Static web sites
When configured, this middleware serves container data as a static web site with index file and error file resolution and optional file listings. This mode is normally only active for anonymous requests.
Table 10.81. Description of configuration options for [filter-staticweb] in proxyserver.conf
Configuration option = Default value use
= egg:swift#staticweb
Description
Entry point of paste.deploy in the server
10.12.18. Cross-origin resource sharing
Cross-Origin Resource Sharing (CORS) is a mechanism that allows code (JavaScript, for example) running in a browser to make requests to a domain, other than the one it was originated from.
OpenStack Object Storage supports CORS requests to containers and objects within the containers using metadata held on the container.
In addition to the metadata on containers, you can use the cors_allow_origin option in the
proxy-server.conf file to set a list of hosts that are included with any CORS request by default.
10.12.19. Endpoint listing middleware
823
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
The endpoint listing middleware enables third-party services that use data locality information to integrate with OpenStack Object Storage. This middleware reduces network overhead and is designed for third-party services that run inside the firewall. Deploy this middleware on a proxy server because usage of this middleware is not authenticated.
Format requests for endpoints, as follows:
/endpoints/{account}/{container}/{object}
/endpoints/{account}/{container} /endpoints/{account}
Use the list_endpoints_path configuration option in the proxy_server.conf file to customize the /endpoints/ path.
Responses are JSON-encoded lists of endpoints, as follows: http://{server}:{port}/{dev}/{part}/{acc}/{cont}/{obj} http://{server}:{port}/{dev}/{part}/{acc}/{cont} http://{server}:{port}/{dev}/{part}/{acc}
An example response is: http://10.1.1.1:6000/sda1/2/a/c2/o1 http://10.1.1.1:6000/sda1/2/a/c2 http://10.1.1.1:6000/sda1/2/a
10.13. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
OPENSTACK OBJECT STORAGE
Table 10.82. New options
Option = default value container-server.conf: [container-sync] conn_timeout = 5 container-server.conf: [container-sync] internal_client_conf_path = /etc/swift/internalclient.conf
container-server.conf: [container-sync] request_tries = 3 drive-audit.conf: [drive-audit] log_to_console =
False drive-audit.conf: [drive-audit] recon_cache_path =
/var/cache/swift
(Type) Help string
(StrOpt) Connection timeout to external services
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) Directory where stats for a few items will be stored
824
CHAPTER 10. OBJECT STORAGE
Option = default value drive-audit.conf: [drive-audit] unmount_failed_device = True internal-client.conf: [DEFAULT] log_address =
/dev/log internal-client.conf: [DEFAULT] log_custom_handlers = internal-client.conf: [DEFAULT] log_facility =
LOG_LOCAL0 internal-client.conf: [DEFAULT] log_level = INFO internal-client.conf: [DEFAULT] log_name = swift internal-client.conf: [DEFAULT] log_statsd_default_sample_rate = 1.0
internal-client.conf: [DEFAULT] log_statsd_host = localhost internal-client.conf: [DEFAULT] log_statsd_metric_prefix = internal-client.conf: [DEFAULT] log_statsd_port =
8125 internal-client.conf: [DEFAULT] log_statsd_sample_rate_factor = 1.0
internal-client.conf: [DEFAULT] log_udp_host =
(Type) Help string
(StrOpt) No help text available for this option.
(StrOpt) Location where syslog sends the logs to
(StrOpt) Comma-separated list of functions to call to setup custom log handlers.
(StrOpt) Syslog log facility
(StrOpt) Logging level
(StrOpt) Label used when logging
(StrOpt) Defines the probability of sending a sample for any given event or timing measurement.
(StrOpt) If not set, the StatsD feature is disabled.
(StrOpt) Value will be prepended to every metric sent to the StatsD server.
(StrOpt) Port value for the StatsD server.
(StrOpt) Not recommended to set this to a value less than 1.0, if frequency of logging is too high, tune the log_statsd_default_sample_rate instead.
(StrOpt) If not set, the UDP receiver for syslog is disabled.
(StrOpt) Port value for UDP receiver, if enabled.
internal-client.conf: [DEFAULT] log_udp_port =
514 internal-client.conf: [DEFAULT] swift_dir =
/etc/swift internal-client.conf: [DEFAULT] user = swift internal-client.conf: [app-proxy-server] use = egg:swift#proxy internal-client.conf: [filter-cache] use = egg:swift#memcache
(StrOpt) Swift configuration directory
(StrOpt) User to run as
(StrOpt) Entry point of paste.deploy in the server
(StrOpt) Entry point of paste.deploy in the server
825
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value internal-client.conf: [filter-catch_errors] use = egg:swift#catch_errors internal-client.conf: [filter-proxy-logging] use = egg:swift#proxy_logging internal-client.conf: [pipeline-main] pipeline = catch_errors proxy-logging cache proxy-server memcache.conf: [memcache] connect_timeout =
0.3
memcache.conf: [memcache] io_timeout = 2.0
(Type) Help string
(StrOpt) Entry point of paste.deploy in the server
(StrOpt) Entry point of paste.deploy in the server
(StrOpt) No help text available for this option.
(StrOpt) Timeout in seconds (float) for connection memcache.conf: [memcache] pool_timeout = 1.0
memcache.conf: [memcache] tries = 3
(StrOpt) Timeout in seconds (float) for read and write
(StrOpt) Timeout in seconds (float) for pooled connection
(StrOpt) Number of servers to retry on failures getting a pooled connection
(StrOpt) Number of replication workers to spawn object-server.conf: [object-reconstructor] concurrency = 1 object-server.conf: [object-reconstructor] daemonize = on object-server.conf: [object-reconstructor] handoffs_first = False
(StrOpt) Whether or not to run replication as a daemon
(StrOpt) If set to True, partitions that are not supposed to be on the node will be replicated first.
The default setting should not be changed, except for extreme situations.
(StrOpt) Maximum duration for an HTTP request object-server.conf: [object-reconstructor] http_timeout = 60 object-server.conf: [object-reconstructor] lockup_timeout = 1800 object-server.conf: [object-reconstructor] log_address = /dev/log object-server.conf: [object-reconstructor] log_facility = LOG_LOCAL0
(StrOpt) Attempts to kill all workers if nothing replications for lockup_timeout seconds
(StrOpt) Location where syslog sends the logs to
(StrOpt) Syslog log facility object-server.conf: [object-reconstructor] log_level
= INFO
(StrOpt) Logging level object-server.conf: [object-reconstructor] log_name
= object-reconstructor
(StrOpt) Label used when logging
826
CHAPTER 10. OBJECT STORAGE
Option = default value object-server.conf: [object-reconstructor] node_timeout = 10 object-server.conf: [object-reconstructor] reclaim_age = 604800 object-server.conf: [object-reconstructor] recon_cache_path = /var/cache/swift object-server.conf: [object-reconstructor] ring_check_interval = 15
(Type) Help string
(StrOpt) Request timeout to external services
(StrOpt) Time elapsed in seconds before an object can be reclaimed
(StrOpt) Directory where stats for a few items will be stored
(StrOpt) How often (in seconds) to check the ring object-server.conf: [object-reconstructor] run_pause = 30 object-server.conf: [object-reconstructor] stats_interval = 300 proxy-server.conf: [filter-authtoken] identity_uri = http://keystonehost:35357/ proxy-server.conf: [filter-keystoneauth] allow_overrides = true
(StrOpt) Time in seconds to wait between replication passes
(StrOpt) Interval in seconds between logging replication statistics
(StrOpt) No help text available for this option.
proxy-server.conf: [filter-keystoneauth] is_admin = false
(StrOpt) This option allows middleware higher in the WSGI pipeline to override auth processing, useful for middleware such as tempurl and formpost. If you know you are not going to use such middleware and you want a bit of extra security, you can set this to False.
(StrOpt) If this option is set to True, it allows to give a user whose username is the same as the project name and who has any role in the project access rights elevated to be the same as if the user had one of the operator_roles. Note that the condition compares names rather than UUIDs. This option is deprecated. It is False by default.
proxy-server.conf: [filter-keystoneauth] reseller_prefix = AUTH proxy-server.conf: [filter-tempauth] user_test5_tester5 = testing5 service
(StrOpt) The naming scope for the auth service.
Swift proxy-server.conf: [filter-keystoneauth] service_roles =
(StrOpt) When present, this option requires that the
X-Service-Token header supplies a token from a user who has a role listed in service_roles. This parameter may be prefixed with an appropriate prefix.
proxy-server.conf: [filter-tempauth] require_group = (StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
827
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value swift.conf: [storage-policy-0] policy_type = replication swift.conf: [storage-policy-1] policy_type = replication swift.conf: [storage-policy-2] ec_num_data_fragments = 10 swift.conf: [storage-policy-2] ec_num_parity_fragments = 4 swift.conf: [storage-policy-2] ec_object_segment_size = 1048576 swift.conf: [storage-policy-2] ec_type = jerasure_rs_vand swift.conf: [storage-policy-2] name = deepfreeze10-4 swift.conf: [storage-policy-2] policy_type = erasure_coding swift.conf: [swift-constraints] valid_api_versions = v0,v1,v2
(Type) Help string
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
(StrOpt) No help text available for this option.
828
Table 10.83. New default values
Option object-server.conf: [app-objectserver] keep_cache_size proxy-server.conf: [DEFAULT] disallowed_sections proxy-server.conf: [app-proxyserver] swift_owner_headers
Previous default value
5424880 proxy-server.conf: [filterauthtoken] delay_auth_decision
1
New default value
5242880 container_quotas, tempurl, bulk_delete.max_failed_deletes
x-container-read, x-containerwrite, x-container-sync-key, xcontainer-sync-to, x-accountmeta-temp-url-key, x-accountmeta-temp-url-key-2, x-accountaccess-control swift.valid_api_versions, container_quotas, tempurl x-container-read, x-containerwrite, x-container-sync-key, xcontainer-sync-to, x-accountmeta-temp-url-key, x-accountmeta-temp-url-key-2, xcontainer-meta-temp-url-key, xcontainer-meta-temp-url-key-2, x-account-access-control
False
CHAPTER 11. ORCHESTRATION
CHAPTER 11. ORCHESTRATION
The Orchestration service is designed to manage the lifecycle of infrastructure and applications within OpenStack clouds. Its various agents and services are configured in the
/etc/heat/heat.conf file.
The following tables provide a comprehensive list of the Orchestration configuration options.
Table 11.1. Description of authorization token configuration options
Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
admin_token
= None
Description admin_user
= None
auth_admin_prefix
=
auth_host
= 127.0.0.1
auth_plugin
= None
auth_port
= 35357
auth_protocol
= https
auth_section
= None
auth_uri
= None
auth_version
= None
(StrOpt) Service user password.
(StrOpt) Service tenant name.
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
829
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value cache
= None
cafile
= None
certfile
= None
check_revocations_for_cached
= False
delay_auth_decision enforce_token_bind hash_algorithms identity_uri
= None
= False
= permissive
= md5
http_connect_timeout
= None
http_request_max_retries
= 3
Description
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
(IntOpt) How many times are we trying to reconnect when communicating with Identity API
Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
830
CHAPTER 11. ORCHESTRATION
Configuration option = Default value include_service_catalog
= True
insecure keyfile
= False
= None
memcache_pool_conn_get_timeout
= 10
memcache_pool_dead_retry memcache_pool_maxsize revocation_cache_time
= 10
= 10
= 300
memcache_pool_socket_timeout memcache_pool_unused_timeout memcache_secret_key
= None
memcache_security_strategy memcache_use_advanced_pool
= 3
= 60
= None
= False
Description
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
831
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value signing_dir
= None
token_cache_time
= 300
Description
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
832
Table 11.2. Description of common configuration options
Configuration option = Default value
[DEFAULT]
Description convergence_engine
= False
default_deployment_signal_transpor t
= CFN_SIGNAL
(StrOpt) Template default for how the server should signal to heat with the deployment output values.
CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL (requires enabled heat-apicfn). TEMP_URL_SIGNAL will create a Swift
TempURL to be signaled via HTTP PUT (requires object-store endpoint which supports TempURL).
HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials
default_software_config_transport
= POLL_SERVER_CFN
(BoolOpt) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine .
deferred_auth_method environment_dir
= trusts
= /etc/heat/environment.d
(StrOpt) Template default for how the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair (requires enabled heat-api-cfn). POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials (requires keystone v3 API, and configured stack_user_* config options). POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling (requires object-store endpoint which supports TempURL).
(StrOpt) Select deferred auth method, stored password or trusts.
(StrOpt) The directory to search for environment files.
CHAPTER 11. ORCHESTRATION
Configuration option = Default value error_wait_time
= 240
event_purge_batch_size host
= localhost
instance_user
= ec2-user
keystone_backend
=
heat.common.heat_keystoneclient.KeystoneClient
V3
memcached_servers
= None
periodic_interval
= 60
= 10
plugin_dirs
= /usr/lib64/heat, /usr/lib/heat,
/usr/local/lib/heat, /usr/local/lib64/heat
[keystone_authtoken] memcached_servers
= None
Description
(IntOpt) Error wait time in seconds for stack action
(ie. create or update).
(IntOpt) Controls how many events will be pruned whenever a stack's events exceed max_events_per_stack. Set this lower to keep more events at the expense of more frequent purges.
(StrOpt) Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname,
FQDN, or IP address.
(StrOpt) The default user for new instances. This option is deprecated and may be removed after the
Kilo release. If it is explicitly set to an empty string,
Heat will use the default user set up with your cloud image (for OS::Nova::Server) or 'ec2-user'
(for AWS::EC2::Instance).
(StrOpt) Fully qualified class name to use as a keystone backend.
(ListOpt) Memcached servers or None for in process cache.
(IntOpt) Seconds between running periodic tasks.
(ListOpt) List of directories to search for plug-ins.
(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
[revision] heat_revision
= unknown (StrOpt) Heat build revision. If you would prefer to manage your build revision separately, you can move this section to a different file and add it as another config option.
Table 11.3. Description of crypt configuration options
833
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] auth_encryption_key
= notgood but just
long enough i t
(StrOpt) Key used to encrypt authentication info in the database. Length of this key must be 16, 24 or
32 characters.
Table 11.4. Description of database configuration options
Description Configuration option = Default value
[database] backend
= sqlalchemy
connection
= None
connection_debug connection_trace db_inc_retry_interval db_max_retries
= 20
db_max_retry_interval db_retry_interval idle_timeout max_overflow
= 0
= False
= 3600
= None
max_pool_size
= 1
= None
= True
= 10
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
(IntOpt) Timeout before idle SQL connections are reaped.
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
834
Configuration option = Default value max_retries
= 10
min_pool_size mysql_sql_mode pool_timeout
= 1
= TRADITIONAL
= None
retry_interval
= 10
slave_connection
= None
sqlite_db
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
CHAPTER 11. ORCHESTRATION
Description
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
Table 11.5. Description of logging configuration options
Description Configuration option = Default value
[DEFAULT] backdoor_port
= None (StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
Table 11.6. Description of load balancer configuration options
835
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] loadbalancer_template
= None (StrOpt) Custom template for the built-in loadbalancer nested stack.
Table 11.7. Description of logging configuration options
Configuration option = Default value
[DEFAULT]
Description debug
= False
default_log_levels
= 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
(ListOpt) List of logger=LEVEL pairs.
fatal_deprecations
= False
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
(BoolOpt) Enables or disables fatal status of deprecations.
fatal_exception_format_errors
=
False
instance_format
= "[instance: %(uuid)s] "
instance_uuid_format
(uuid)s] "
log_config_append
= "[instance: %
= None
(BoolOpt) Make exception message format errors fatal
(StrOpt) The format for an instance that is passed with the log message.
(StrOpt) The format for an instance UUID that is passed with the log message.
(StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None (StrOpt) (Optional) The base directory used for relative --log-file paths.
836
CHAPTER 11. ORCHESTRATION
Configuration option = Default value log_file
= None
log_format logging_context_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
syslog_log_facility use_syslog use_stderr verbose
= None
= False
= True
= False
= LOG_USER
use_syslog_rfc_format
= False
Description
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
(StrOpt) Prefix each line of exception output with this format.
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Log output to standard error.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 11.8. Description of oslo_middleware configuration options
837
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[oslo_middleware] max_request_body_size
= 114688 (IntOpt) The maximum body size for each request, in bytes.
Table 11.9. Description of quota configuration options
Description Configuration option = Default value
[DEFAULT] max_events_per_stack
= 1000
max_nested_stack_depth max_resources_per_stack max_stacks_per_tenant max_template_size
= 5
= 1000
= 100
= 524288
(IntOpt) Maximum events that will be available per stack. Older events will be deleted when this is reached. Set to 0 for unlimited events per stack.
(IntOpt) Maximum depth allowed when using nested stacks.
(IntOpt) Maximum resources allowed per top-level stack.
(IntOpt) Maximum number of stacks any one tenant may have active at one time.
(IntOpt) Maximum raw byte size of any template.
Table 11.10. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
Table 11.11. Description of testing configuration options
838
CHAPTER 11. ORCHESTRATION
Configuration option = Default value
[profiler] profiler_enabled
= False
trace_sqlalchemy
= False
Description
(BoolOpt) If False fully disable profiling feature.
(BoolOpt) If False do not trace SQL requests.
11.1. CONFIGURE APIS
The following options allow configuration of the APIs that Orchestration supports. Currently this includes compatibility APIs for CloudFormation and CloudWatch and a native API.
Table 11.12. Description of API configuration options
Configuration option = Default value
[DEFAULT] action_retry_limit
= 5
Description enable_stack_abandon num_engine_workers policy_default_rule
= False
enable_stack_adopt
= False
heat_metadata_server_url
=
heat_stack_user_role
= heat_stack_user
heat_waitcondition_server_url heat_watch_server_url max_json_body_size
= 4
=
= 1048576
= default
=
(IntOpt) Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries.
(BoolOpt) Enable the preview Stack Abandon feature.
(BoolOpt) Enable the preview Stack Adopt feature.
(StrOpt) URL of the Heat metadata server.
(StrOpt) Keystone role for heat template-defined users.
(StrOpt) URL of the Heat waitcondition server.
(StrOpt) URL of the Heat CloudWatch server.
(IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size.
(IntOpt) Number of heat-engine processes to fork and run.
(StrOpt) Default rule. Enforced when a requested rule is not found.
839
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value policy_dirs
= ['policy.d']
Description
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.
policy_file
= policy.json (StrOpt) The JSON file that defines policies.
secure_proxy_ssl_header
= X-Forwarded-
Proto
(StrOpt) The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminator proxy.
stack_action_timeout
= 3600
stack_domain_admin
= None
stack_domain_admin_password stack_scheduler_hints stack_user_domain_id
= False
= None
stack_user_domain_name trusts_delegated_roles
= None
=
= None
(IntOpt) Timeout in seconds for stack action (ie.
create or update).
(StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain.
(StrOpt) Keystone password for stack_domain_admin user.
(BoolOpt) When this feature is enabled, scheduler hints identifying the heat stack context of a server resource are passed to the configured schedulers in nova, for server creates done using heat resource types OS::Nova::Server and
AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of tuples,
(stackresourcename, stackname) with list[0] being
(None, rootstackname), and heat_resource_name will be set to the resource's name.
(StrOpt) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored.
(StrOpt) Keystone domain name which contains heat template-defined users. If
`stack_user_domain_id` option is set, this option is ignored.
(ListOpt) Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack.
840
Configuration option = Default value
[auth_password] allowed_auth_uris
=
multi_cloud
= False
[ec2authtoken] allowed_auth_uris
=
auth_uri
= None
ca_file
= None
cert_file
= None
insecure
= False
key_file
= None
multi_cloud
= False
[heat_api] backlog
= 4096
bind_host
= 0.0.0.0
bind_port
= 8004
cert_file
= None
key_file
= None
CHAPTER 11. ORCHESTRATION
Description
(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.
(BoolOpt) Allow orchestration of multiple clouds.
(ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.
(StrOpt) Authentication Endpoint URI.
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
(BoolOpt) Allow orchestration of multiple clouds.
(IntOpt) Number of backlog requests to configure the socket with.
(StrOpt) Address to bind the server. Useful when selecting a particular network interface.
(IntOpt) The port on which the server will listen.
(StrOpt) Location of the SSL certificate file to use for SSL mode.
(StrOpt) Location of the SSL key file to use for enabling SSL mode.
841
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value max_header_line
= 16384
Description
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
(IntOpt) Number of workers for Heat service.
workers
= 0
[paste_deploy] api_paste_config
= api-paste.ini
flavor
= None
(StrOpt) The API paste config file to use.
(StrOpt) The flavor to use.
Table 11.13. Description of Cloudformation-compatible API configuration options
Configuration option = Default value Description
[DEFAULT] instance_connection_https_validate
_certificates
= 1
instance_connection_is_secure
= 0
(StrOpt) Instance connection to CFN/CW API validate certs if SSL is used.
(StrOpt) Instance connection to CFN/CW API via https.
[heat_api_cfn] backlog
= 4096
bind_host bind_port cert_file key_file
= 0.0.0.0
= 8000
= None
= None
max_header_line
= 16384
(IntOpt) Number of backlog requests to configure the socket with.
(StrOpt) Address to bind the server. Useful when selecting a particular network interface.
(IntOpt) The port on which the server will listen.
(StrOpt) Location of the SSL certificate file to use for SSL mode.
(StrOpt) Location of the SSL key file to use for enabling SSL mode.
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
842
Configuration option = Default value workers
= 0
CHAPTER 11. ORCHESTRATION
Description
(IntOpt) Number of workers for Heat service.
Table 11.14. Description of CloudWatch API configuration options
Description Configuration option = Default value
[DEFAULT] enable_cloud_watch_lite
= True (BoolOpt) Enable the legacy
OS::Heat::CWLiteAlarm resource.
(StrOpt) URL of the Heat CloudWatch server.
heat_watch_server_url
=
[heat_api_cloudwatch] backlog
= 4096
bind_host bind_port cert_file key_file
= 8003
= None
= None
max_header_line workers
= 0.0.0.0
= 0
= 16384
(IntOpt) Number of backlog requests to configure the socket with.
(StrOpt) Address to bind the server. Useful when selecting a particular network interface.
(IntOpt) The port on which the server will listen.
(StrOpt) Location of the SSL certificate file to use for SSL mode.
(StrOpt) Location of the SSL key file to use for enabling SSL mode.
(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.)
(IntOpt) Number of workers for Heat service.
Table 11.15. Description of metadata API configuration options
Description Configuration option = Default value
[DEFAULT] heat_metadata_server_url
= (StrOpt) URL of the Heat metadata server.
843
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 11.16. Description of waitcondition API configuration options
Configuration option = Default value
[DEFAULT] heat_waitcondition_server_url
=
Description
(StrOpt) URL of the Heat waitcondition server.
11.2. CONFIGURE CLIENTS
The following options allow configuration of the clients that Orchestration uses to talk to other services.
Table 11.17. Description of clients configuration options
Description Configuration option = Default value
[DEFAULT] region_name_for_services
= None
[clients] ca_file
= None
cert_file
= None
endpoint_type
= publicURL
insecure
= False
key_file
= None
(StrOpt) Default region name used to get services endpoints.
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.18. Description of client backends configuration options
Description Configuration option = Default value
[DEFAULT]
844
Configuration option = Default value cloud_backend
=
heat.engine.clients.OpenStackClients
CHAPTER 11. ORCHESTRATION
Description
(StrOpt) Fully qualified class name to use as a client backend.
Table 11.19. Description of ceilometer clients configuration options
Description Configuration option = Default value
[clients_ceilometer] ca_file
= None
cert_file
= None
endpoint_type insecure key_file
= None
= None
= None
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.20. Description of cinder clients configuration options
Description Configuration option = Default value
[clients_cinder] ca_file
= None
cert_file
= None
endpoint_type
= None
http_log_debug insecure
= None
= False
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) Allow client's debug log output.
(BoolOpt) If set, then the server's certificate will not be verified.
845
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value key_file
= None
Description
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.21. Description of glance clients configuration options
Description Configuration option = Default value
[clients_glance] ca_file
= None
cert_file
= None
endpoint_type insecure key_file
= None
= None
= None
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.22. Description of heat clients configuration options
Description Configuration option = Default value
[clients_heat] ca_file
= None
cert_file insecure
= None
endpoint_type
= None
= None
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) If set, then the server's certificate will not be verified.
846
Configuration option = Default value key_file
= None
url
=
CHAPTER 11. ORCHESTRATION
Description
(StrOpt) Optional PEM-formatted file that contains the private key.
(StrOpt) Optional heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s.
Table 11.23. Description of keystone clients configuration options
Description Configuration option = Default value
[clients_keystone] ca_file
= None
cert_file
= None
endpoint_type insecure key_file
= None
= None
= None
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.24. Description of neutron clients configuration options
Description Configuration option = Default value
[clients_neutron] ca_file
= None
cert_file
= None
endpoint_type
= None
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
847
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value insecure
= None
key_file
= None
Description
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.25. Description of nova clients configuration options
Description Configuration option = Default value
[clients_nova] ca_file
= None
cert_file
= None
endpoint_type
= None
http_log_debug insecure key_file
= None
= None
= False
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) Allow client's debug log output.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.26. Description of sahara clients configuration options
Description Configuration option = Default value
[clients_sahara] ca_file
= None
cert_file
= None
endpoint_type
= None
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
848
Configuration option = Default value insecure
= None
key_file
= None
CHAPTER 11. ORCHESTRATION
Description
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.27. Description of swift clients configuration options
Description Configuration option = Default value
[clients_swift] ca_file
= None
cert_file
= None
endpoint_type insecure key_file
= None
= None
= None
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
Table 11.28. Description of trove clients configuration options
Description Configuration option = Default value
[clients_trove] ca_file
= None
cert_file
= None
endpoint_type
= None
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
849
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value insecure
= None
key_file
= None
Description
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
11.3. CONFIGURE THE RPC MESSAGING SYSTEM
OpenStack projects use an open standard for messaging middleware known as AMQP. This messaging middleware enables the OpenStack services that run on multiple servers to talk to each other. OpenStack Oslo RPC supports two implementations of AMQP: RabbitMQ and Qpid.
11.3.1. Configure RabbitMQ
OpenStack Oslo RPC uses RabbitMQ by default. Use these options to configure the RabbitMQ message system. The rpc_backend option is optional as long as RabbitMQ is the default messaging system. However, if it is included in the configuration, you must set it to
heat.openstack.common.rpc.impl_kombu.
rpc_backend = heat.openstack.common.rpc.impl_kombu
Use these options to configure the RabbitMQ messaging system. You can configure messaging communication for different installation scenarios, tune retries for RabbitMQ, and define the size of the RPC thread pool. To monitor notifications through RabbitMQ, you must set the
notification_driver option to heat.openstack.common.notifier.rpc_notifier in the
heat.conf file:
Table 11.29. Description of RabbitMQ configuration options
Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
amqp_durable_queues
= False
fake_rabbit
= False
heartbeat_rate
= 2
Description
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
850
Configuration option = Default value heartbeat_timeout_threshold
= 0
kombu_reconnect_delay kombu_ssl_ca_certs
=
kombu_ssl_certfile
=
kombu_ssl_keyfile
=
kombu_ssl_version
=
rabbit_ha_queues
= 1.0
= False
rabbit_host
= localhost
rabbit_hosts
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_password
= guest
rabbit_port
= 5672
rabbit_retry_backoff
= 2
rabbit_retry_interval
= 1
rabbit_use_ssl
= False
CHAPTER 11. ORCHESTRATION
Description
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
851
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
Description
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
11.3.2. Configure Qpid
Use these options to configure the Qpid messaging system for OpenStack Oslo RPC. Qpid is not the default messaging system, so you must enable it by setting the rpc_backend option in the
heat.conf file: rpc_backend=heat.openstack.common.rpc.impl_qpid
This critical option points the compute nodes to the Qpid broker (server). Set the qpid_hostname option to the host name where the broker runs in the heat.conf file.
Note
The qpid_hostname option accepts a host name or IP address value.
qpid_hostname = hostname.example.com
If the Qpid broker listens on a port other than the AMQP default of 5672, you must set the
qpid_port option to that value: qpid_port = 12345
If you configure the Qpid broker to require authentication, you must add a user name and password to the configuration: qpid_username = username qpid_password = password
By default, TCP is used as the transport. To enable SSL, set the qpid_protocol option: qpid_protocol = ssl
Use these additional options to configure the Qpid messaging driver for OpenStack Oslo RPC.
These options are used infrequently.
Table 11.30. Description of Qpid configuration options
852
CHAPTER 11. ORCHESTRATION
Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False
amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname
= localhost
qpid_hosts
= $qpid_hostname:$qpid_port
qpid_password
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity
= 1
qpid_sasl_mechanisms
=
qpid_tcp_nodelay
= True
qpid_topology_version
= 1
Description
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
qpid_username
=
rpc_conn_pool_size
= 30
11.3.3. Configure messaging
Use these common options to configure the RabbitMQ and Qpid messaging drivers:
Table 11.31. Description of AMQP configuration options
853
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] control_exchange
= openstack
default_notification_level default_publisher_id
= None
list_notifier_drivers notification_driver notification_topics transport_url
= None
= None
= []
= INFO
= notifications
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
(StrOpt) Default notification level for outgoing notifications.
(StrOpt) Default publisher_id for outgoing notifications.
(MultiStrOpt) List of drivers to send notifications
(DEPRECATED).
(MultiStrOpt) Driver or drivers to handle sending notifications.
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
Table 11.32. Description of RPC configuration options
Description Configuration option = Default value
[DEFAULT] engine_life_check_timeout
= 2
matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
rpc_cast_timeout
= 30
rpc_response_timeout
= 60
(IntOpt) RPC timeout for the engine liveness check that is used for stack locking.
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
854
Configuration option = Default value rpc_thread_pool_size
= 64
[oslo_messaging_amqp] allow_insecure_clients
= False
broadcast_prefix
= broadcast
container_name
= None
group_request_prefix
= unicast
idle_timeout
= 0
server_request_prefix
= exclusive
ssl_ca_file
=
ssl_cert_file
=
ssl_key_file
=
ssl_key_password
= None
trace
= False
CHAPTER 11. ORCHESTRATION
Description
(IntOpt) Size of RPC thread pool.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
Table 11.33. Description of notification configuration options
Description Configuration option = Default value
[DEFAULT] onready
= None (StrOpt) Deprecated.
11.4. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
ORCHESTRATION
855
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Table 11.34. New options
Option = default value
[DEFAULT] convergence_engine = False
(Type) Help string
(BoolOpt) Enables engine with convergence architecture. All stacks with this option will be created using convergence engine .
[DEFAULT] default_deployment_signal_transport =
CFN_SIGNAL
(StrOpt) Template default for how the server should signal to heat with the deployment output values.
CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL (requires enabled heat-apicfn). TEMP_URL_SIGNAL will create a Swift
TempURL to be signaled via HTTP PUT (requires object-store endpoint which supports TempURL).
HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials
[DEFAULT] default_software_config_transport =
POLL_SERVER_CFN
(StrOpt) Template default for how the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair (requires enabled heat-api-cfn). POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials (requires keystone v3 API, and configured stack_user_* config options). POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling (requires object-store endpoint which supports TempURL).
[DEFAULT] error_wait_time = 240
[DEFAULT] fatal_exception_format_errors = False
[DEFAULT] log-config-append = None
(IntOpt) Error wait time in seconds for stack action
(ie. create or update).
(BoolOpt) Make exception message format errors fatal
(StrOpt) 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.
[DEFAULT] log-date-format = %Y-%m-%d
%H:%M:%S
[DEFAULT] log-dir = None
[DEFAULT] log-file = None
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
(StrOpt) (Optional) The base directory used for relative --log-file paths.
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
856
(Type) Help string
CHAPTER 11. ORCHESTRATION
Option = default value
[DEFAULT] log-format = None
[DEFAULT] policy_dirs = ['policy.d']
[DEFAULT] stack_scheduler_hints = False
[DEFAULT] syslog-log-facility = LOG_USER
[DEFAULT] use-syslog = False
[DEFAULT] use-syslog-rfc-format = False
[clients_sahara] ca_file = None
[clients_sahara] cert_file = None
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.
(BoolOpt) When this feature is enabled, scheduler hints identifying the heat stack context of a server resource are passed to the configured schedulers in nova, for server creates done using heat resource types OS::Nova::Server and
AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of tuples,
(stackresourcename, stackname) with list[0] being
(None, rootstackname), and heat_resource_name will be set to the resource's name.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
857
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[clients_sahara] endpoint_type = None
[clients_sahara] insecure = None
[clients_sahara] key_file = None
[ec2authtoken] ca_file = None
[ec2authtoken] cert_file = None
[ec2authtoken] insecure = False
[ec2authtoken] key_file = None
[oslo_messaging_amqp] allow_insecure_clients =
False
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
[oslo_messaging_amqp] ssl_key_file =
(Type) Help string
(StrOpt) Type of endpoint in Identity service catalog to use for communication with the OpenStack service.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
(StrOpt) Optional CA cert file to use in SSL connections.
(StrOpt) Optional PEM-formatted certificate chain file.
(BoolOpt) If set, then the server's certificate will not be verified.
(StrOpt) Optional PEM-formatted file that contains the private key.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
858
CHAPTER 11. ORCHESTRATION
Option = default value
[oslo_messaging_amqp] ssl_key_password =
None
[oslo_messaging_amqp] trace = False
(Type) Help string
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] amqp_durable_queues =
False
[oslo_messaging_qpid] qpid_heartbeat = 60
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
(IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
[oslo_messaging_qpid] qpid_protocol = tcp (StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
[oslo_messaging_qpid] qpid_sasl_mechanisms = (StrOpt) Space separated list of SASL mechanisms to use for auth.
[oslo_messaging_qpid] qpid_tcp_nodelay = True
[oslo_messaging_qpid] qpid_topology_version = 1
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30
[oslo_messaging_rabbit] amqp_auto_delete =
False
[oslo_messaging_rabbit] amqp_durable_queues =
False
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
859
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] fake_rabbit = False
[oslo_messaging_rabbit] heartbeat_rate = 2
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(Type) Help string
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
[oslo_messaging_rabbit] rabbit_port = 5672
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
860
CHAPTER 11. ORCHESTRATION
Option = default value
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
[oslo_messaging_rabbit] rabbit_retry_interval = 1
(Type) Help string
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
[oslo_messaging_rabbit] rabbit_use_ssl = False
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
[oslo_messaging_rabbit] rpc_conn_pool_size = 30 (IntOpt) Size of RPC connection pool.
[oslo_middleware] max_request_body_size =
114688
[profiler] profiler_enabled = False
[profiler] trace_sqlalchemy = False
(IntOpt) The maximum body size for each request, in bytes.
(BoolOpt) If False fully disable profiling feature.
(BoolOpt) If False do not trace SQL requests.
Table 11.35. New default values
Option
[DEFAULT] auth_encryption_key
[DEFAULT] default_log_levels
[DEFAULT] deferred_auth_method
Previous default value notgood but just long enough i think
New default value notgood but just long enough i t amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.conne
ctionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retr
y=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN password trusts
861
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option
[DEFAULT] max_nested_stack_depth
[DEFAULT] num_engine_workers
[DEFAULT] plugin_dirs
Previous default value
3
1
[DEFAULT] rpc_zmq_matchmaker
[DEFAULT] trusts_delegated_roles
New default value
5
4
/usr/lib64/heat, /usr/lib/heat oslo.messaging._drivers.matchm
aker.MatchMakerLocalhost
local heat_stack_owner
/usr/lib64/heat, /usr/lib/heat,
/usr/local/lib/heat,
/usr/local/lib64/heat
Table 11.36. Deprecated options
Deprecated option
[DEFAULT] log-format
[DEFAULT] use-syslog
[DEFAULT] list_notifier_drivers
New Option
None
None
None
862
CHAPTER 12. TELEMETRY
CHAPTER 12. TELEMETRY
The Telemetry service collects measurements within OpenStack. Its various agents and services are configured in the /etc/ceilometer/ceilometer.conf file.
To install Telemetry, run the following command:
# yum install -y mongodb-server openstack-ceilometer-* pythonceilometer python-ceilometerclient
The following tables provide a comprehensive list of the Telemetry configuration options.
Table 12.1. Description of alarm configuration options
Configuration option = Default value
[alarm] evaluation_interval
= 60
Description evaluation_service
= default
notifier_rpc_topic
= alarm_notifier
partition_rpc_topic
=
alarm_partition_coordination
project_alarm_quota
= None
record_history
= True
rest_notifier_certificate_file
=
rest_notifier_certificate_key
=
rest_notifier_max_retries
= 0
(IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying metrics.
(StrOpt) Driver to use for alarm evaluation service.
DEPRECATED: "singleton" and "partitioned" alarm evaluator services will be removed in Kilo in favour of the default alarm evaluation service using tooz for partitioning.
(StrOpt) The topic that ceilometer uses for alarm notifier messages.
(StrOpt) The topic that ceilometer uses for alarm partition coordination messages. DEPRECATED:
RPC-based partitionedalarm evaluation service will be removed in Kilo in favour of the default alarm evaluation service using tooz for partitioning.
(IntOpt) Maximum number of alarms defined for a project.
(BoolOpt) Record alarm change events.
(StrOpt) SSL Client certificate for REST notifier.
(StrOpt) SSL Client private key for REST notifier.
(IntOpt) Number of retries for REST notifier
863
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rest_notifier_ssl_verify
= True
user_alarm_quota
= None
Description
(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.
(IntOpt) Maximum number of alarms defined for a user.
Table 12.2. Description of alarms configuration options
Description Configuration option = Default value
[alarms] gnocchi_url
= http://localhost:8041 (StrOpt) URL to Gnocchi.
Table 12.3. Description of AMQP configuration options
Description Configuration option = Default value
[DEFAULT] control_exchange
= openstack
notification_driver notification_topics transport_url
= None
= []
= notifications
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
(MultiStrOpt) Driver or drivers to handle sending notifications.
(ListOpt) AMQP topic used for OpenStack notifications.
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, fall back to the rpc_backend option and driver specific configuration.
Table 12.4. Description of API configuration options
Description Configuration option = Default value
[DEFAULT] api_paste_config
= api_paste.ini (StrOpt) Configuration file for WSGI definition of
API.
864
Configuration option = Default value api_workers
= 1
event_pipeline_cfg_file
=
event_pipeline.yaml
pipeline_cfg_file
= pipeline.yaml
reserved_metadata_keys
=
CHAPTER 12. TELEMETRY
Description
(IntOpt) Number of workers for Ceilometer API server.
(StrOpt) Configuration file for event pipeline definition.
(StrOpt) Configuration file for pipeline definition.
(ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.
(IntOpt) Limit on length of reserved metadata values.
(ListOpt) List of metadata prefixes reserved for metering use.
reserved_metadata_length
= 256
reserved_metadata_namespace
=
metering.
[api] host
= 0.0.0.0
pecan_debug
= False
port
= 8777
(StrOpt) The listen IP for the ceilometer API server.
(BoolOpt) Toggle Pecan Debug Middleware.
(IntOpt) The port for the ceilometer API server.
Table 12.5. Description of authorization configuration options
Description Configuration option = Default value
[service_credentials] insecure
= False
os_auth_url os_cacert
= http://localhost:5000/v2.0
= None
os_endpoint_type os_password
= publicURL
= admin
(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.
(StrOpt) Auth URL to use for OpenStack service access.
(StrOpt) Certificate chain for SSL validation.
(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.
(StrOpt) Password to use for OpenStack service access.
865
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value os_region_name
= None
os_tenant_id os_tenant_name os_username
=
= admin
= ceilometer
Description
(StrOpt) Region name to use for OpenStack service endpoints.
(StrOpt) Tenant ID to use for OpenStack service access.
(StrOpt) Tenant name to use for OpenStack service access.
(StrOpt) User name to use for OpenStack service access.
Table 12.6. Description of authorization token configuration options
Description Configuration option = Default value
[keystone_authtoken] admin_password
= None
admin_tenant_name
= admin
admin_token
= None
admin_user auth_admin_prefix auth_host
= None
= 127.0.0.1
auth_plugin auth_port
= None
= 35357
auth_protocol
=
= https
(StrOpt) Service user password.
(StrOpt) Service tenant name.
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and
`admin_password` instead.
(StrOpt) Service username.
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
(StrOpt) Name of the plugin to load
(IntOpt) Port of the admin Identity API endpoint.
Deprecated, use identity_uri.
(StrOpt) Protocol of the admin Identity API endpoint
(http or https). Deprecated, use identity_uri.
866
CHAPTER 12. TELEMETRY
Configuration option = Default value auth_section
= None
auth_uri cache cafile certfile
= None
auth_version
= None
= None
= None
= None
check_revocations_for_cached
= False
delay_auth_decision enforce_token_bind hash_algorithms
= False
= permissive
= md5
http_connect_timeout
= None
Description
(StrOpt) Config Section from which to load plugin specific options
(StrOpt) Complete public Identity API endpoint.
(StrOpt) API version of the admin Identity API endpoint.
(StrOpt) Env key for the swift cache.
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
(StrOpt) Required if identity server requires client certificate
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like
"permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple.
The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
(IntOpt) Request timeout value for communicating with Identity API server.
867
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value http_request_max_retries
= 3
identity_uri include_service_catalog insecure keyfile
= None
= False
= None
= True
memcache_pool_conn_get_timeout
= 10
memcache_pool_dead_retry memcache_pool_maxsize memcache_pool_socket_timeout memcache_pool_unused_timeout memcache_secret_key
= 10
= None
= 300
memcache_security_strategy
= 3
= 60
= None
Description
(IntOpt) How many times to try to reconnect when communicating with Identity API Server.
(StrOpt) Complete admin Identity API endpoint.
This should specify the unversioned root endpoint e.g. https://localhost:35357/
(BoolOpt) (Optional) Indicate whether to set the X-
Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
(BoolOpt) Verify HTTPS connections.
(StrOpt) Required if identity server requires client certificate
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.
(IntOpt) (Optional) Maximum total number of open connections to every memcached server.
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If
ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
868
Configuration option = Default value memcache_use_advanced_pool
= False
revocation_cache_time signing_dir
= None
token_cache_time
= 300
= 10
CHAPTER 12. TELEMETRY
Description
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
(StrOpt) Directory used to cache files related to PKI tokens.
(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration
(in seconds). Set to -1 to disable caching completely.
Table 12.7. Description of collector configuration options
Configuration option = Default value
[DEFAULT] collector_workers
= 1
Description
(IntOpt) Number of workers for collector service. A single collector is enabled by default.
[collector] requeue_event_on_dispatcher_error
= False
(BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it.
requeue_sample_on_dispatcher_error
= False
(BoolOpt) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher.
udp_address
= 0.0.0.0 (StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable.
(IntOpt) Port to which the UDP socket is bound.
udp_port
= 4952
[dispatcher_file] backup_count
= 0 (IntOpt) The max number of the files to keep.
869
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value file_path
= None
max_bytes
= 0
Description
(StrOpt) Name and the location of the file to record meters.
(IntOpt) The max size of the file.
Table 12.8. Description of common configuration options
Configuration option = Default value
[DEFAULT] host
= localhost
Description http_timeout
= 600
memcached_servers notification_workers polling_namespaces pollster_list
= []
= None
= 1
= ['compute', 'central']
rootwrap_config
=
/etc/ceilometer/rootwrap.conf
shuffle_time_before_polling_task
=
0
sql_expire_samples_only
= False
(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier.
(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.
(ListOpt) Memcached servers or None for in process cache.
(IntOpt) Number of workers for notification service.
A single notification agent is enabled by default.
(MultiChoicesOpt) Polling namespace(s) to be used while resource polling
(MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling
(StrOpt) Path to the rootwrap configuration file touse for running commands as root
(IntOpt) To reduce large requests at same time to
Nova or other components from different compute agents, shuffle start time of polling task.
(BoolOpt) Indicates if expirer expires only samples.
If set true, expired samples will be deleted, but residual resource and meter definition data will remain.
[compute] workload_partitioning
= False (BoolOpt) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously.
[coordination]
870
Configuration option = Default value backend_url
= None
CHAPTER 12. TELEMETRY
Description
(StrOpt) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent will not do workload partitioning and will only function correctly if a single instance of that service is running.
(FloatOpt) Number of seconds between checks to see if group membership has changed
(FloatOpt) Number of seconds between heartbeats for distributed coordination.
check_watchers
= 10.0
heartbeat
= 1.0
[keystone_authtoken] memcached_servers
= None (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
[polling] partitioning_group_prefix
= None (StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.
Table 12.9. Description of concurrency configuration options
Description Configuration option = Default value
[oslo_concurrency] disable_process_locking
= False
lock_path
= None
(BoolOpt) Enables or disables inter-process locks.
(StrOpt) 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 external locks are used, a lock path must be set.
Table 12.10. Description of database configuration options
871
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] database_connection
= None (StrOpt) DEPRECATED - Database connection string.
[database] alarm_connection
= None
backend
= sqlalchemy
connection
= None
connection_debug connection_trace
= 0
= False
db2nosql_resource_id_maxlen db_inc_retry_interval db_max_retries db_max_retry_interval db_retry_interval event_connection idle_timeout
= 20
= 3600
= 1
event_time_to_live
= -1
= True
= 10
= None
= 512
(StrOpt) The connection string used to connect to the alarm database. (if unset, connection is used)
(StrOpt) The back end to use for the database.
(StrOpt) The SQLAlchemy connection string to use to connect to the database.
(IntOpt) Verbosity of SQL debugging information:
0=None, 100=Everything.
(BoolOpt) Add Python stack traces to SQL as comment strings.
(IntOpt) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is <hostname>_<nodename>.
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to
-1 to specify an infinite retry count.
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
(IntOpt) Seconds between retries of a database transaction.
(StrOpt) The connection string used to connect to the event database. (if unset, connection is used)
(IntOpt) Number of seconds that events are kept in the database for (<= 0 means forever).
(IntOpt) Timeout before idle SQL connections are reaped.
872
Configuration option = Default value max_overflow
= None
max_pool_size
= None
max_retries
= 10
metering_connection metering_time_to_live min_pool_size
= 1
mongodb_replica_set
=
mysql_sql_mode pool_timeout
= TRADITIONAL
= None
retry_interval
= 10
slave_connection
= None
= -1
= None
sqlite_db
= oslo.sqlite
sqlite_synchronous
= True
use_db_reconnect
= False
CHAPTER 12. TELEMETRY
Description
(IntOpt) If set, use this value for max_overflow with
SQLAlchemy.
(IntOpt) Maximum number of SQL connections to keep open in a pool.
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
(StrOpt) The connection string used to connect to the metering database. (if unset, connection is used)
(IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever).
(IntOpt) Minimum number of SQL connections to keep open in a pool.
(StrOpt) The name of the replica set which is used to connect to MongoDB database. If it is set,
MongoReplicaSetClient will be used instead of
MongoClient.
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
(IntOpt) If set, use this value for pool_timeout with
SQLAlchemy.
(IntOpt) Interval between retries of opening a SQL connection.
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
(StrOpt) The file name to use with SQLite.
(BoolOpt) If True, SQLite uses synchronous mode.
(BoolOpt) Enable the experimental use of database reconnect on connection lost.
Table 12.11. Description of logging configuration options
873
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[DEFAULT] backdoor_port
= None
nova_http_log_debug
= False
(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number;
<port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
(BoolOpt) Allow novaclient's debug log output.
Table 12.12. Description of HTTP dispatcher configuration options
Description Configuration option = Default value
[dispatcher_http] cadf_only
= False
event_target target
=
timeout
= 5
= None
(BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted.
(StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target.
(StrOpt) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path
(IntOpt) The max time in seconds to wait for a request to timeout.
Table 12.13. Description of events configuration options
Description Configuration option = Default value
[event] definitions_cfg_file
=
event_definitions.yaml
(StrOpt) Configuration file for event definitions.
874
CHAPTER 12. TELEMETRY
Configuration option = Default value drop_unmatched_notifications
= False
store_raw
= []
Description
(BoolOpt) Drop notifications if no event definition matches. (Otherwise, they cannot be converted with only the default traits.)
(MultiStrOpt) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured.
[notification] ack_on_event_error
= True
store_events
= False
workload_partitioning
= False
(BoolOpt) Acknowledge message when event persistence fails.
(BoolOpt) Save event details.
(BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.
Table 12.14. Description of exchange configuration options
Configuration option = Default value
[DEFAULT] cinder_control_exchange
= cinder
glance_control_exchange
= glance
heat_control_exchange
= heat
http_control_exchanges
= ['nova',
'glance', 'neutron', 'cinder']
ironic_exchange
= ironic
keystone_control_exchange
= keystone
neutron_control_exchange
= neutron
nova_control_exchange
= nova
sahara_control_exchange
= sahara
sample_source
= openstack
Description
(StrOpt) Exchange name for Cinder notifications.
(StrOpt) Exchange name for Glance notifications.
(StrOpt) Exchange name for Heat notifications
(MultiStrOpt) Exchanges name to listen for notifications.
(StrOpt) Exchange name for Ironic notifications.
(StrOpt) Exchange name for Keystone notifications.
(StrOpt) Exchange name for Neutron notifications.
(StrOpt) Exchange name for Nova notifications.
(StrOpt) Exchange name for Data Processing notifications.
(StrOpt) Source for samples emitted on this instance.
875
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value swift_control_exchange
= swift
trove_control_exchange
= trove
Description
(StrOpt) Exchange name for Swift notifications.
(StrOpt) Exchange name for DBaaS notifications.
Table 12.15. Description of glance configuration options
Description Configuration option = Default value
[DEFAULT] glance_page_size
= 0 (IntOpt) Number of items to request in each paginated Glance API request (parameter used by glancecelient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used).
Table 12.16. Description of inspector configuration options
Description Configuration option = Default value
[DEFAULT] hypervisor_inspector
= libvirt
libvirt_type libvirt_uri
=
= kvm
(StrOpt) Inspector to use for inspecting the hypervisor layer.
(StrOpt) Libvirt domain type.
(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).
Table 12.17. Description of IPMI configuration options
Description Configuration option = Default value
[ipmi] node_manager_init_retry
= 3
polling_retry
= 3
(IntOpt) Number of retries upon Intel Node
Manager initialization failure
(IntOpt) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever.
876
CHAPTER 12. TELEMETRY
Table 12.18. Description of oslo_middleware configuration options
Description Configuration option = Default value
[oslo_middleware] max_request_body_size
= 114688 (IntOpt) The maximum body size for each request, in bytes.
Table 12.19. Description of logging configuration options
Configuration option = Default value
[DEFAULT] debug
= False
Description
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
default_log_levels
= 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, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN
(ListOpt) List of logger=LEVEL pairs.
fatal_deprecations
= False
instance_format
= "[instance: %(uuid)s] "
(BoolOpt) Enables or disables fatal status of deprecations.
(StrOpt) The format for an instance that is passed with the log message.
instance_uuid_format
= "[instance: %
(uuid)s] "
log_config_append
= None (StrOpt) 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.
log_date_format
= %Y-%m-%d %H:%M:%S (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir
= None
(StrOpt) The format for an instance UUID that is passed with the log message.
(StrOpt) (Optional) The base directory used for relative --log-file paths.
877
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value log_file
= None
log_format logging_context_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [%(request_id)s %
(user_identity)s] %(instance)s%(message)s
logging_debug_format_suffix
= %
(funcName)s %(pathname)s:%(lineno)d
logging_default_format_string
= %
(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%
(message)s
logging_exception_prefix
= %
(asctime)s.%(msecs)03d %(process)d TRACE %
(name)s %(instance)s
publish_errors
= False
syslog_log_facility use_stderr
= True
use_syslog
= False
= LOG_USER
use_syslog_rfc_format verbose
= None
= False
= False
Description
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Use logging_context_format_string and logging_default_format_string instead.
(StrOpt) Format string to use for log messages with context.
(StrOpt) Data to append to log format when level is
DEBUG.
(StrOpt) Format string to use for log messages without context.
(StrOpt) Prefix each line of exception output with this format.
(BoolOpt) Enables or disables publication of error events.
(StrOpt) Syslog facility to receive log lines.
(BoolOpt) Log output to standard error.
(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the
MSG part of the syslog message with APP-NAME
(RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.
(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
Table 12.20. Description of MagnetoDB configuration options
878
CHAPTER 12. TELEMETRY
Configuration option = Default value
[DEFAULT] magnetodb_control_exchange
=
magnetodb
Description
(StrOpt) Exchange name for Magnetodb notifications.
Table 12.21. Description of notification configuration options
Description Configuration option = Default value
[notification] disable_non_metric_meters
= False (BoolOpt) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation.
This option disables the collection of non-metric meters and will be the default behavior in Liberty.
Table 12.22. Description of policy configuration options
Description Configuration option = Default value
[oslo_policy] policy_default_rule
= default
policy_dirs
= ['policy.d']
policy_file
= policy.json
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
(StrOpt) The JSON file that defines policies.
Table 12.23. Description of Qpid configuration options
Description Configuration option = Default value
[oslo_messaging_qpid] amqp_auto_delete
= False (BoolOpt) Auto-delete queues in AMQP.
879
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value amqp_durable_queues
= False
qpid_heartbeat
= 60
qpid_hostname qpid_hosts qpid_password qpid_username
= localhost
= $qpid_hostname:$qpid_port
=
qpid_port
= 5672
qpid_protocol
= tcp
qpid_receiver_capacity qpid_sasl_mechanisms qpid_tcp_nodelay
=
= True
qpid_topology_version
=
rpc_conn_pool_size
= 1
= 1
= 30
Description
(BoolOpt) Use durable queues in AMQP.
(IntOpt) Seconds between connection keepalive heartbeats.
(StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
(IntOpt) The number of prefetched messages held by receiver.
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
(IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
(IntOpt) Size of RPC connection pool.
Table 12.24. Description of RabbitMQ configuration options
Description Configuration option = Default value
[oslo_messaging_rabbit] amqp_auto_delete
= False
amqp_durable_queues
= False
fake_rabbit
= False
(BoolOpt) Auto-delete queues in AMQP.
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
880
Configuration option = Default value heartbeat_rate
= 2
heartbeat_timeout_threshold
= 0
kombu_reconnect_delay
= 1.0
kombu_ssl_ca_certs
=
kombu_ssl_certfile
=
kombu_ssl_keyfile
=
kombu_ssl_version
=
rabbit_ha_queues
= False
rabbit_host
= localhost
rabbit_hosts
= $rabbit_host:$rabbit_port
rabbit_login_method
= AMQPLAIN
rabbit_max_retries
= 0
rabbit_password
= guest
rabbit_port
= 5672
rabbit_retry_backoff
= 2
rabbit_retry_interval
= 1
CHAPTER 12. TELEMETRY
Description
(IntOpt) How often times during the heartbeat_timeout_threshold to check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 are also available.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
(StrOpt) The RabbitMQ login method.
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
(IntOpt) How frequently to retry connecting with
RabbitMQ.
881
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value rabbit_use_ssl
= False
rabbit_userid
= guest
rabbit_virtual_host
= /
rpc_conn_pool_size
= 30
Description
(BoolOpt) Connect over SSL for RabbitMQ.
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
Table 12.25. Description of Redis configuration options
Description Configuration option = Default value
[matchmaker_redis] host
= 127.0.0.1
password
= None
port
= 6379
[matchmaker_ring] ringfile
= /etc/oslo/matchmaker_ring.json
(StrOpt) Host to locate redis.
(StrOpt) Password for Redis server (optional).
(IntOpt) Use this port to connect to redis host.
(StrOpt) Matchmaker ring file (JSON).
Table 12.26. Description of Rados gateway configuration options
Description Configuration option = Default value
[rgw_admin_credentials] access_key
= None
secret_key
= None
(StrOpt) Access key for Radosgw Admin.
(StrOpt) Secret key for Radosgw Admin.
Table 12.27. Description of RPC configuration options
Description Configuration option = Default value
[DEFAULT] dispatcher
= ['database'] (MultiStrOpt) Dispatcher to process data.
882
Configuration option = Default value matchmaker_heartbeat_freq
= 300
matchmaker_heartbeat_ttl
= 600
rpc_backend
= rabbit
rpc_cast_timeout
= 30
rpc_response_timeout
= 60
rpc_thread_pool_size
= 64
[notification] messaging_urls
= []
CHAPTER 12. TELEMETRY
Description
(IntOpt) Heartbeat frequency.
(IntOpt) Heartbeat time-to-live.
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
(IntOpt) Seconds to wait before a cast expires
(TTL). Only supported by impl_zmq.
(IntOpt) Seconds to wait for a response from a call.
(IntOpt) Size of RPC thread pool.
(MultiStrOpt) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virt ual_host (DEFAULT/transport_url is used if empty)
[oslo_messaging_amqp] allow_insecure_clients
= False
broadcast_prefix
= broadcast
container_name
= None
group_request_prefix
= unicast
idle_timeout
= 0
server_request_prefix
= exclusive
ssl_ca_file
=
ssl_cert_file
=
ssl_key_file
=
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
883
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Configuration option = Default value ssl_key_password
= None
Description
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
(BoolOpt) Debug: dump AMQP frames to stdout
trace
= False
[publisher] telemetry_secret
= change this for valid
signing
(StrOpt) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead.
[publisher_notifier] event_topic
= event
metering_topic
= metering
telemetry_driver
= messagingv2
(StrOpt) The topic that ceilometer uses for event notifications.
(StrOpt) The topic that ceilometer uses for metering notifications.
(StrOpt) The driver that ceilometer uses for metering notifications.
[publisher_rpc] metering_topic
= metering (StrOpt) The topic that ceilometer uses for metering messages.
Table 12.28. Description of service types configuration options
Description Configuration option = Default value
[service_types] glance
= image
kwapi
= energy
neutron
= network
nova
= compute
radosgw
= object-store
swift
= object-store
(StrOpt) Glance service type.
(StrOpt) Kwapi service type.
(StrOpt) Neutron service type.
(StrOpt) Nova service type.
(StrOpt) Radosgw service type.
(StrOpt) Swift service type.
884
Table 12.29. Description of swift configuration options
CHAPTER 12. TELEMETRY
Configuration option = Default value
[DEFAULT] reseller_prefix
= AUTH_
Description
(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.
Table 12.30. Description of TripleO configuration options
Description Configuration option = Default value
[hardware] readonly_user_name
= ro_snmp_user
readonly_user_password url_scheme
= snmp://
= password
(StrOpt) SNMPd user name of all nodes running in the cloud.
(StrOpt) SNMPd password of all the nodes running in the cloud.
(StrOpt) URL scheme to use for hardware nodes.
Table 12.31. Description of VMware configuration options
Description Configuration option = Default value
[vmware] api_retry_count
= 10
host_ip
=
host_password host_port
= 443
wsdl_location
=
host_username
=
task_poll_interval
= None
= 0.5
(IntOpt) Number of times a VMware Vsphere API may be retried.
(StrOpt) IP address of the VMware Vsphere host.
(StrOpt) Password of VMware Vsphere.
(IntOpt) Port of the VMware Vsphere host.
(StrOpt) Username of VMware Vsphere.
(FloatOpt) Sleep time in seconds for polling an ongoing async task.
(StrOpt) Optional vim service WSDL location e.g
http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.
Table 12.32. Description of XenAPI configuration options
885
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Description Configuration option = Default value
[xenapi] connection_password
= None
connection_url
= None
connection_username login_timeout
= 10
= root
(StrOpt) Password for connection to
XenServer/Xen Cloud Platform.
(StrOpt) URL for connection to XenServer/Xen
Cloud Platform.
(StrOpt) Username for connection to
XenServer/Xen Cloud Platform.
(IntOpt) Timeout in seconds for XenAPI login.
Table 12.33. Description of Zaqar configuration options
Description Configuration option = Default value
[DEFAULT] zaqar_control_exchange
= zaqar (StrOpt) Exchange name for Messaging service notifications.
886
12.1. TELEMETRY SAMPLE CONFIGURATION FILES
All the files in this section can be found in the /etc/ceilometer/ directory.
12.1.1. ceilometer.conf
The configuration for the Telemetry services and agents is found in the ceilometer.conf file.
This file must be modified after installation.
[DEFAULT]
#
# From ceilometer
#
# To reduce large requests at same time to Nova or other components
# from different compute agents, shuffle start time of polling task.
# (integer value)
#shuffle_time_before_polling_task = 0
# Configuration file for WSGI definition of API. (string value)
CHAPTER 12. TELEMETRY
#api_paste_config = api_paste.ini
# Number of workers for Ceilometer API server. (integer value)
#api_workers = 1
# Polling namespace(s) to be used while resource polling (unknown
# type)
#polling_namespaces = ['compute', 'central']
# List of pollsters (or wildcard templates) to be used while polling
# (unknown type)
#pollster_list = []
# Exchange name for Nova notifications. (string value)
#nova_control_exchange = nova
# List of metadata prefixes reserved for metering use. (list value)
#reserved_metadata_namespace = metering.
# Limit on length of reserved metadata values. (integer value)
#reserved_metadata_length = 256
# List of metadata keys reserved for metering use. And these keys are
# additional to the ones included in the namespace. (list value)
#reserved_metadata_keys =
# Inspector to use for inspecting the hypervisor layer. (string value)
#hypervisor_inspector = libvirt
# Libvirt domain type. (string value)
# Allowed values: kvm, lxc, qemu, uml, xen
#libvirt_type = kvm
# Override the default libvirt URI (which is dependent on
# libvirt_type). (string value)
#libvirt_uri =
# Exchange name for Data Processing notifications. (string value)
#sahara_control_exchange = sahara
# Dispatcher to process data. (multi valued)
# Deprecated group/name - [collector]/dispatcher
#dispatcher = database
# Exchange name for Keystone notifications. (string value)
#keystone_control_exchange = keystone
# Number of items to request in each paginated Glance API request
# (parameter used by glancecelient). If this is less than or equal to
# 0, page size is not specified (default value in glanceclient is
# used). (integer value)
#glance_page_size = 0
# Exchange name for Glance notifications. (string value)
#glance_control_exchange = glance
887
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Exchange name for Ironic notifications. (string value)
#ironic_exchange = ironic
# Exchanges name to listen for notifications. (multi valued)
#http_control_exchanges = nova
#http_control_exchanges = glance
#http_control_exchanges = neutron
#http_control_exchanges = cinder
# Exchange name for Neutron notifications. (string value)
# Deprecated group/name - [DEFAULT]/quantum_control_exchange
#neutron_control_exchange = neutron
# Allow novaclient's debug log output. (boolean value)
#nova_http_log_debug = false
# Swift reseller prefix. Must be on par with reseller_prefix in proxy-
# server.conf. (string value)
#reseller_prefix = AUTH_
# Enable eventlet backdoor. Acceptable values are 0, <port>, and
# <start>:<end>, where 0 results in listening on a random tcp port
# number; <port> results in listening on the specified port number
# (and not enabling backdoor if that port is in use); and
# <start>:<end> results in listening on the smallest unused port
# number within the specified range of port numbers. The chosen port
# is displayed in the service's log file. (string value)
#backdoor_port = <None>
# Print debugging output (set logging level to DEBUG instead of
# default WARNING level). (boolean value)
#debug = false
# Print more verbose output (set logging level to INFO instead of
# default WARNING level). (boolean value)
#verbose = false
# Log output to standard error. (boolean value)
#use_stderr = true
# 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.
# (string value)
# Deprecated group/name - [DEFAULT]/log_config
#log_config_append = <None>
# DEPRECATED. A logging.Formatter log message format string which may
# use any of the available logging.LogRecord attributes. This option
# is deprecated. Please use logging_context_format_string and
# logging_default_format_string instead. (string value)
#log_format = <None>
# Format string for %%(asctime)s in log records. Default: %(default)s
# . (string value)
#log_date_format = %Y-%m-%d %H:%M:%S
888
CHAPTER 12. TELEMETRY
# (Optional) Name of log file to output to. If no default is set,
# logging will go to stdout. (string value)
# Deprecated group/name - [DEFAULT]/logfile
#log_file = <None>
# (Optional) The base directory used for relative --log-file paths.
# (string value)
# Deprecated group/name - [DEFAULT]/logdir
#log_dir = <None>
# Use syslog for logging. Existing syslog format is DEPRECATED during
# I, and will change in J to honor RFC5424. (boolean value)
#use_syslog = false
# (Optional) Enables or disables syslog rfc5424 format for logging. If
# enabled, prefixes the MSG part of the syslog message with APP-NAME
# (RFC5424). The format without the APP-NAME is deprecated in I, and
# will be removed in J. (boolean value)
#use_syslog_rfc_format = false
# Syslog facility to receive log lines. (string value)
#syslog_log_facility = LOG_USER
# 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 without context. (string
# value)
#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %
(levelname)s %(name)s [-] %(instance)s%(message)s
# Data to append to log format when level 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 TRACE %
(name)s %(instance)s
# List of logger=LEVEL pairs. (list value)
#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo
.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WAR
N,urllib3.connectionpool=WARN,websocket=WARN,keystonemiddleware=WARN,rout es.middleware=WARN,stevedore=WARN
# Enables or disables publication of error events. (boolean value)
#publish_errors = false
# Enables or disables fatal status of deprecations. (boolean value)
#fatal_deprecations = false
# The format for an instance that is passed with the log message.
889
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# (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] "
# Exchange name for Heat notifications (string value)
#heat_control_exchange = heat
# Configuration file for pipeline definition. (string value)
#pipeline_cfg_file = pipeline.yaml
# Configuration file for event pipeline definition. (string value)
#event_pipeline_cfg_file = event_pipeline.yaml
# Exchange name for DBaaS notifications. (string value)
#trove_control_exchange = trove
# Exchange name for Messaging service notifications. (string value)
#zaqar_control_exchange = zaqar
# Source for samples emitted on this instance. (string value)
# Deprecated group/name - [DEFAULT]/counter_source
#sample_source = openstack
# Name of this node, which must be valid in an AMQP key. Can be an
# opaque identifier. For ZeroMQ only, must be a valid host name, FQDN,
# or IP address. (string value)
#host = shock
# Number of workers for collector service. A single collector is
# enabled by default. (integer value)
#collector_workers = 1
# Number of workers for notification service. A single notification
# agent is enabled by default. (integer value)
#notification_workers = 1
# Timeout seconds for HTTP requests. Set it to None to disable
# timeout. (integer value)
#http_timeout = 600
# DEPRECATED - Database connection string. (string value)
#database_connection = <None>
# Path to the rootwrap configuration file touse for running commands
# as root (string value)
#rootwrap_config = /etc/ceilometer/rootwrap.conf
# Exchange name for Cinder notifications. (string value)
#cinder_control_exchange = cinder
#
# From oslo.messaging
#
890
CHAPTER 12. TELEMETRY
# ZeroMQ bind address. Should be a wildcard (*), an ethernet
# interface, or IP. The "host" option should point or resolve to this
# address. (string value)
#rpc_zmq_bind_address = *
# MatchMaker driver. (string value)
#rpc_zmq_matchmaker = local
# ZeroMQ receiver listening port. (integer value)
#rpc_zmq_port = 9501
# Number of ZeroMQ contexts, defaults to 1. (integer value)
#rpc_zmq_contexts = 1
# Maximum number of ingress messages to locally buffer per topic.
# Default is unlimited. (integer value)
#rpc_zmq_topic_backlog = <None>
# Directory for holding IPC sockets. (string value)
#rpc_zmq_ipc_dir = /var/run/openstack
# Name of this node. Must be a valid hostname, FQDN, or IP address.
# Must match "host" option, if running Nova. (string value)
#rpc_zmq_host = localhost
# Seconds to wait before a cast expires (TTL). Only supported by
# impl_zmq. (integer value)
#rpc_cast_timeout = 30
# Heartbeat frequency. (integer value)
#matchmaker_heartbeat_freq = 300
# Heartbeat time-to-live. (integer value)
#matchmaker_heartbeat_ttl = 600
# Size of RPC thread pool. (integer value)
#rpc_thread_pool_size = 64
# Driver or drivers to handle sending notifications. (multi valued)
#notification_driver =
# AMQP topic used for OpenStack notifications. (list value)
# Deprecated group/name - [rpc_notifier2]/topics
#notification_topics = notifications
# Seconds to wait for a response from a call. (integer value)
#rpc_response_timeout = 60
# A URL representing the messaging driver to use and its full
# configuration. If not set, we fall back to the rpc_backend option
# and driver specific configuration. (string value)
#transport_url = <None>
# The messaging driver to use, defaults to rabbit. Other drivers
# include qpid and zmq. (string value)
891
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#rpc_backend = rabbit
# The default exchange under which topics are scoped. May be
# overridden by an exchange name specified in the transport_url
# option. (string value)
#control_exchange = openstack
[alarm]
#
# From ceilometer
#
# SSL Client certificate for REST notifier. (string value)
#rest_notifier_certificate_file =
# SSL Client private key for REST notifier. (string value)
#rest_notifier_certificate_key =
# Whether to verify the SSL Server certificate when calling alarm
# action. (boolean value)
#rest_notifier_ssl_verify = true
# Number of retries for REST notifier (integer value)
#rest_notifier_max_retries = 0
# Period of evaluation cycle, should be >= than configured pipeline
# interval for collection of underlying metrics. (integer value)
# Deprecated group/name - [alarm]/threshold_evaluation_interval
#evaluation_interval = 60
# The topic that ceilometer uses for alarm notifier messages. (string
# value)
#notifier_rpc_topic = alarm_notifier
# The topic that ceilometer uses for alarm partition coordination
# messages. DEPRECATED: RPC-based partitionedalarm evaluation service
# will be removed in Kilo in favour of the default alarm evaluation
# service using tooz for partitioning. (string value)
#partition_rpc_topic = alarm_partition_coordination
# URL to Gnocchi. (string value)
#gnocchi_url = http://localhost:8041
# Record alarm change events. (boolean value)
#record_history = true
# Maximum number of alarms defined for a user. (integer value)
#user_alarm_quota = <None>
# Maximum number of alarms defined for a project. (integer value)
#project_alarm_quota = <None>
# Driver to use for alarm evaluation service. DEPRECATED: "singleton"
# and "partitioned" alarm evaluator services will be removed in Kilo
892
CHAPTER 12. TELEMETRY
# in favour of the default alarm evaluation service using tooz for
# partitioning. (string value)
#evaluation_service = default
[api]
#
# From ceilometer
#
# The port for the ceilometer API server. (integer value)
# Deprecated group/name - [DEFAULT]/metering_api_port
#port = 8777
# The listen IP for the ceilometer API server. (string value)
#host = 0.0.0.0
# Toggle Pecan Debug Middleware. (boolean value)
#pecan_debug = false
[central]
#
# From ceilometer
#
# Work-load partitioning group prefix. Use only if you want to run
# multiple polling agents with different config files. For each sub-
# group of the agent pool with the same partitioning_group_prefix a
# disjoint subset of pollsters should be loaded. (string value)
# Deprecated group/name - [central]/partitioning_group_prefix
#partitioning_group_prefix = <None>
[collector]
#
# From ceilometer
#
# Address to which the UDP socket is bound. Set to an empty string to
# disable. (string value)
#udp_address = 0.0.0.0
# Port to which the UDP socket is bound. (integer value)
#udp_port = 4952
# Requeue the sample on the collector sample queue when the collector
# fails to dispatch it. This is only valid if the sample come from the
# notifier publisher. (boolean value)
#requeue_sample_on_dispatcher_error = false
# Requeue the event on the collector event queue when the collector
# fails to dispatch it. (boolean value)
893
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#requeue_event_on_dispatcher_error = false
[compute]
#
# From ceilometer
#
# Enable work-load partitioning, allowing multiple compute agents to
# be run simultaneously. (boolean value)
#workload_partitioning = false
[coordination]
#
# From ceilometer
#
# The backend URL to use for distributed coordination. If left empty,
# per-deployment central agent and per-host compute agent won't do
# workload partitioning and will only function correctly if a single
# instance of that service is running. (string value)
#backend_url = <None>
# Number of seconds between heartbeats for distributed coordination.
# (floating point value)
#heartbeat = 1.0
# Number of seconds between checks to see if group membership has
# changed (floating point value)
#check_watchers = 10.0
[database]
#
# From ceilometer
#
# Number of seconds that samples are kept in the database for (<= 0
# means forever). (integer value)
# Deprecated group/name - [database]/time_to_live
#metering_time_to_live = -1
# Number of seconds that events are kept in the database for (<= 0
# means forever). (integer value)
#event_time_to_live = -1
# The connection string used to connect to the metering database. (if
# unset, connection is used) (string value)
#metering_connection = <None>
# The connection string used to connect to the alarm database. (if
# unset, connection is used) (string value)
894
CHAPTER 12. TELEMETRY
#alarm_connection = <None>
# The connection string used to connect to the event database. (if
# unset, connection is used) (string value)
#event_connection = <None>
# The name of the replica set which is used to connect to MongoDB
# database. If it is set, MongoReplicaSetClient will be used instead
# of MongoClient. (string value)
#mongodb_replica_set =
# The max length of resources id in DB2 nosql, the value should be
# larger than len(hostname) * 2 as compute node's resource id is
# <hostname>_<nodename>. (integer value)
#db2nosql_resource_id_maxlen = 512
#
# From oslo.db
#
# The file name to use with SQLite. (string value)
# Deprecated group/name - [DEFAULT]/sqlite_db
#sqlite_db = oslo.sqlite
# If True, SQLite uses synchronous mode. (boolean value)
# Deprecated group/name - [DEFAULT]/sqlite_synchronous
#sqlite_synchronous = true
# The back end to use for the database. (string value)
# Deprecated group/name - [DEFAULT]/db_backend
#backend = sqlalchemy
# The SQLAlchemy connection string to use to connect to the database.
# (string value)
# Deprecated group/name - [DEFAULT]/sql_connection
# Deprecated group/name - [DATABASE]/sql_connection
# Deprecated group/name - [sql]/connection
#connection = <None>
# The SQLAlchemy connection string to use to connect to the slave
# database. (string value)
#slave_connection = <None>
# The SQL mode to be used for MySQL sessions. This option, including
# the default, overrides any server-set SQL mode. To use whatever SQL
# mode is set by the server configuration, set this to no value.
# Example: mysql_sql_mode= (string value)
#mysql_sql_mode = TRADITIONAL
# Timeout before idle SQL connections are reaped. (integer value)
# Deprecated group/name - [DEFAULT]/sql_idle_timeout
# Deprecated group/name - [DATABASE]/sql_idle_timeout
# Deprecated group/name - [sql]/idle_timeout
#idle_timeout = 3600
# Minimum number of SQL connections to keep open in a pool. (integer
895
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# value)
# Deprecated group/name - [DEFAULT]/sql_min_pool_size
# Deprecated group/name - [DATABASE]/sql_min_pool_size
#min_pool_size = 1
# Maximum number of SQL connections to keep open in a pool. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_max_pool_size
# Deprecated group/name - [DATABASE]/sql_max_pool_size
#max_pool_size = <None>
# Maximum number of database connection retries during startup. Set to
# -1 to specify an infinite retry count. (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_retries
# Deprecated group/name - [DATABASE]/sql_max_retries
#max_retries = 10
# Interval between retries of opening a SQL connection. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_retry_interval
# Deprecated group/name - [DATABASE]/reconnect_interval
#retry_interval = 10
# If set, use this value for max_overflow with SQLAlchemy. (integer
# value)
# Deprecated group/name - [DEFAULT]/sql_max_overflow
# Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
#max_overflow = <None>
# Verbosity of SQL debugging information: 0=None, 100=Everything.
# (integer value)
# Deprecated group/name - [DEFAULT]/sql_connection_debug
#connection_debug = 0
# Add Python stack traces to SQL as comment strings. (boolean value)
# Deprecated group/name - [DEFAULT]/sql_connection_trace
#connection_trace = false
# If set, use this value for pool_timeout with SQLAlchemy. (integer
# value)
# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
#pool_timeout = <None>
# Enable the experimental use of database reconnect on connection
# lost. (boolean value)
#use_db_reconnect = false
# Seconds between retries of a database transaction. (integer value)
#db_retry_interval = 1
# If True, increases the interval between retries of a database
# operation up to db_max_retry_interval. (boolean value)
#db_inc_retry_interval = true
# If db_inc_retry_interval is set, the maximum seconds between retries
# of a database operation. (integer value)
896
CHAPTER 12. TELEMETRY
#db_max_retry_interval = 10
# Maximum retries in case of connection error or deadlock error before
# error is raised. Set to -1 to specify an infinite retry count.
# (integer value)
#db_max_retries = 20
[dispatcher_file]
#
# From ceilometer
#
# Name and the location of the file to record meters. (string value)
#file_path = <None>
# The max size of the file. (integer value)
#max_bytes = 0
# The max number of the files to keep. (integer value)
#backup_count = 0
[event]
#
# From ceilometer
#
# Configuration file for event definitions. (string value)
#definitions_cfg_file = event_definitions.yaml
# Drop notifications if no event definition matches. (Otherwise, we
# convert them with just the default traits) (boolean value)
#drop_unmatched_notifications = false
# Store the raw notification for select priority levels (info and/or
# error). By default, raw details are not captured. (multi valued)
#store_raw =
[hardware]
#
# From ceilometer
#
# URL scheme to use for hardware nodes. (string value)
#url_scheme = snmp://
# SNMPd user name of all nodes running in the cloud. (string value)
#readonly_user_name = ro_snmp_user
# SNMPd password of all the nodes running in the cloud. (string value)
#readonly_user_password = password
897
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
898
[ipmi]
#
# From ceilometer
#
# Number of retries upon Intel Node Manager initialization failure
# (integer value)
#node_manager_init_retry = 3
# Tolerance of IPMI/NM polling failures before disable this pollster.
# Negative indicates retrying forever. (integer value)
#polling_retry = 3
[keystone_authtoken]
#
# From keystonemiddleware.auth_token
#
# Complete public Identity API endpoint. (string value)
#auth_uri = <None>
# API version of the admin Identity API endpoint. (string value)
#auth_version = <None>
# Do not handle authorization requests within the middleware, but
# delegate the authorization decision to downstream WSGI components.
# (boolean value)
#delay_auth_decision = false
# Request timeout value for communicating with Identity API server.
# (integer value)
#http_connect_timeout = <None>
# How many times are we trying to reconnect when communicating with
# Identity API Server. (integer value)
#http_request_max_retries = 3
# Env key for the swift cache. (string value)
#cache = <None>
# Required if identity server requires client certificate (string
# value)
#certfile = <None>
# Required if identity server requires client certificate (string
# value)
#keyfile = <None>
# A PEM encoded Certificate Authority to use when verifying HTTPs
# connections. Defaults to system CAs. (string value)
#cafile = <None>
CHAPTER 12. TELEMETRY
# Verify HTTPS connections. (boolean value)
#insecure = false
# Directory used to cache files related to PKI tokens. (string value)
#signing_dir = <None>
# Optionally specify a list of memcached server(s) to use for caching.
# If left undefined, tokens will instead be cached in-process. (list
# value)
# Deprecated group/name - [DEFAULT]/memcache_servers
#memcached_servers = <None>
# In order to prevent excessive effort spent validating tokens, the
# middleware caches previously-seen tokens for a configurable duration
# (in seconds). Set to -1 to disable caching completely. (integer
# value)
#token_cache_time = 300
# Determines the frequency at which the list of revoked tokens is
# retrieved from the Identity service (in seconds). A high number of
# revocation events combined with a low cache duration may
# significantly reduce performance. (integer value)
#revocation_cache_time = 10
# (Optional) If defined, indicate whether token data should be
# authenticated or authenticated and encrypted. Acceptable values are
# MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in
# the cache. If ENCRYPT, token data is encrypted and authenticated in
# the cache. If the value is not one of these options or empty,
# auth_token will raise an exception on initialization. (string value)
#memcache_security_strategy = <None>
# (Optional, mandatory if memcache_security_strategy is defined) This
# string is used for key derivation. (string value)
#memcache_secret_key = <None>
# (Optional) Number of seconds memcached server is considered dead
# before it is tried again. (integer value)
#memcache_pool_dead_retry = 300
# (Optional) Maximum total number of open connections to every
# memcached server. (integer value)
#memcache_pool_maxsize = 10
# (Optional) Socket timeout in seconds for communicating with a
# memcache server. (integer value)
#memcache_pool_socket_timeout = 3
# (Optional) Number of seconds a connection to memcached is held
# unused in the pool before it is closed. (integer value)
#memcache_pool_unused_timeout = 60
# (Optional) Number of seconds that an operation will wait to get a
# memcache client connection from the pool. (integer value)
#memcache_pool_conn_get_timeout = 10
899
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# (Optional) Use the advanced (eventlet safe) memcache client pool.
# The advanced pool will only work under python 2.x. (boolean value)
#memcache_use_advanced_pool = false
# (Optional) Indicate whether to set the X-Service-Catalog header. If
# False, middleware will not ask for service catalog on token
# validation and will not set the X-Service-Catalog header. (boolean
# value)
#include_service_catalog = true
# Used to control the use and type of token binding. Can be set to:
# "disabled" to not check token binding. "permissive" (default) to
# validate binding information if the bind type is of a form known to
# the server and ignore it if not. "strict" like "permissive" but if
# the bind type is unknown the token will be rejected. "required" any
# form of token binding is needed to be allowed. Finally the name of a
# binding method that must be present in tokens. (string value)
#enforce_token_bind = permissive
# If true, the revocation list will be checked for cached tokens. This
# requires that PKI tokens are configured on the identity server.
# (boolean value)
#check_revocations_for_cached = false
# Hash algorithms to use for hashing PKI tokens. This may be a single
# algorithm or multiple. The algorithms are those supported by Python
# standard hashlib.new(). The hashes will be tried in the order given,
# so put the preferred one first for performance. The result of the
# first hash will be stored in the cache. This will typically be set
# to multiple values only while migrating from a less secure algorithm
# to a more secure one. Once all the old tokens are expired this
# option should be set to a single value for better performance. (list
# value)
#hash_algorithms = md5
# Prefix to prepend at the beginning of the path. Deprecated, use
# identity_uri. (string value)
#auth_admin_prefix =
# Host providing the admin Identity API endpoint. Deprecated, use
# identity_uri. (string value)
#auth_host = 127.0.0.1
# Port of the admin Identity API endpoint. Deprecated, use
# identity_uri. (integer value)
#auth_port = 35357
# Protocol of the admin Identity API endpoint (http or https).
# Deprecated, use identity_uri. (string value)
#auth_protocol = https
# Complete admin Identity API endpoint. This should specify the
# unversioned root endpoint e.g. https://localhost:35357/ (string
# value)
#identity_uri = <None>
900
CHAPTER 12. TELEMETRY
# This option is deprecated and may be removed in a future release.
# Single shared secret with the Keystone configuration used for
# bootstrapping a Keystone installation, or otherwise bypassing the
# normal authentication process. This option should not be used, use
# `admin_user` and `admin_password` instead. (string value)
#admin_token = <None>
# Service username. (string value)
#admin_user = <None>
# Service user password. (string value)
#admin_password = <None>
# Service tenant name. (string value)
#admin_tenant_name = admin
[matchmaker_redis]
#
# From oslo.messaging
#
# Host to locate redis. (string value)
#host = 127.0.0.1
# Use this port to connect to redis host. (integer value)
#port = 6379
# Password for Redis server (optional). (string value)
#password = <None>
[matchmaker_ring]
#
# From oslo.messaging
#
# Matchmaker ring file (JSON). (string value)
# Deprecated group/name - [DEFAULT]/matchmaker_ringfile
#ringfile = /etc/oslo/matchmaker_ring.json
[notification]
#
# From ceilometer
#
# Acknowledge message when event persistence fails. (boolean value)
# Deprecated group/name - [collector]/ack_on_event_error
#ack_on_event_error = true
# Save event details. (boolean value)
901
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Deprecated group/name - [collector]/store_events
#store_events = false
# WARNING: Ceilometer historically offered the ability to store events
# as meters. This usage is NOT advised as it can flood the metering
# database and cause performance degradation. This option disables the
# collection of non-metric meters and will be the default behavior in
# Liberty. (boolean value)
#disable_non_metric_meters = false
# Enable workload partitioning, allowing multiple notification agents
# to be run simultaneously. (boolean value)
#workload_partitioning = false
# Messaging URLs to listen for notifications. Example:
# transport://user:pass@host1:port[,hostN:portN]/virtual_host
# (DEFAULT/transport_url is used if empty) (multi valued)
#messaging_urls =
[oslo_concurrency]
#
# From oslo.concurrency
#
# Enables or disables inter-process locks. (boolean value)
# Deprecated group/name - [DEFAULT]/disable_process_locking
#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 external locks are used, a lock path must be set. (string value)
# Deprecated group/name - [DEFAULT]/lock_path
#lock_path = <None>
[oslo_messaging_amqp]
#
# From oslo.messaging
#
# address prefix used when sending to a specific server (string value)
# Deprecated group/name - [amqp1]/server_request_prefix
#server_request_prefix = exclusive
# address prefix used when broadcasting to all servers (string value)
# Deprecated group/name - [amqp1]/broadcast_prefix
#broadcast_prefix = broadcast
# address prefix when sending to any server in group (string value)
# Deprecated group/name - [amqp1]/group_request_prefix
#group_request_prefix = unicast
902
CHAPTER 12. TELEMETRY
# Name for the AMQP container (string value)
# Deprecated group/name - [amqp1]/container_name
#container_name = <None>
# Timeout for inactive connections (in seconds) (integer value)
# Deprecated group/name - [amqp1]/idle_timeout
#idle_timeout = 0
# Debug: dump AMQP frames to stdout (boolean value)
# Deprecated group/name - [amqp1]/trace
#trace = false
# CA certificate PEM file for verifing server certificate (string
# value)
# Deprecated group/name - [amqp1]/ssl_ca_file
#ssl_ca_file =
# Identifying certificate PEM file to present to clients (string
# value)
# Deprecated group/name - [amqp1]/ssl_cert_file
#ssl_cert_file =
# Private key PEM file used to sign cert_file certificate (string
# value)
# Deprecated group/name - [amqp1]/ssl_key_file
#ssl_key_file =
# Password for decrypting ssl_key_file (if encrypted) (string value)
# Deprecated group/name - [amqp1]/ssl_key_password
#ssl_key_password = <None>
# Accept clients using either SSL or plain TCP (boolean value)
# Deprecated group/name - [amqp1]/allow_insecure_clients
#allow_insecure_clients = false
[oslo_messaging_qpid]
#
# From oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
#amqp_durable_queues = false
# Auto-delete queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/amqp_auto_delete
#amqp_auto_delete = false
# Size of RPC connection pool. (integer value)
# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size
#rpc_conn_pool_size = 30
# Qpid broker hostname. (string value)
# Deprecated group/name - [DEFAULT]/qpid_hostname
903
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
#qpid_hostname = localhost
# Qpid broker port. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_port
#qpid_port = 5672
# Qpid HA cluster host:port pairs. (list value)
# Deprecated group/name - [DEFAULT]/qpid_hosts
#qpid_hosts = $qpid_hostname:$qpid_port
# Username for Qpid connection. (string value)
# Deprecated group/name - [DEFAULT]/qpid_username
#qpid_username =
# Password for Qpid connection. (string value)
# Deprecated group/name - [DEFAULT]/qpid_password
#qpid_password =
# Space separated list of SASL mechanisms to use for auth. (string
# value)
# Deprecated group/name - [DEFAULT]/qpid_sasl_mechanisms
#qpid_sasl_mechanisms =
# Seconds between connection keepalive heartbeats. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_heartbeat
#qpid_heartbeat = 60
# Transport to use, either 'tcp' or 'ssl'. (string value)
# Deprecated group/name - [DEFAULT]/qpid_protocol
#qpid_protocol = tcp
# Whether to disable the Nagle algorithm. (boolean value)
# Deprecated group/name - [DEFAULT]/qpid_tcp_nodelay
#qpid_tcp_nodelay = true
# The number of prefetched messages held by receiver. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_receiver_capacity
#qpid_receiver_capacity = 1
# The qpid topology version to use. Version 1 is what was originally
# used by impl_qpid. Version 2 includes some backwards-incompatible
# changes that allow broker federation to work. Users should update
# to version 2 when they are able to take everything down, as it
# requires a clean break. (integer value)
# Deprecated group/name - [DEFAULT]/qpid_topology_version
#qpid_topology_version = 1
[oslo_messaging_rabbit]
#
# From oslo.messaging
#
# Use durable queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
904
CHAPTER 12. TELEMETRY
#amqp_durable_queues = false
# Auto-delete queues in AMQP. (boolean value)
# Deprecated group/name - [DEFAULT]/amqp_auto_delete
#amqp_auto_delete = false
# Size of RPC connection pool. (integer value)
# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size
#rpc_conn_pool_size = 30
# SSL version to use (valid only if SSL enabled). Valid values are
# TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be
# available on some distributions. (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_version
#kombu_ssl_version =
# SSL key file (valid only if SSL enabled). (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_keyfile
#kombu_ssl_keyfile =
# SSL cert file (valid only if SSL enabled). (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_certfile
#kombu_ssl_certfile =
# SSL certification authority file (valid only if SSL enabled).
# (string value)
# Deprecated group/name - [DEFAULT]/kombu_ssl_ca_certs
#kombu_ssl_ca_certs =
# How long to wait before reconnecting in response to an AMQP consumer
# cancel notification. (floating point value)
# Deprecated group/name - [DEFAULT]/kombu_reconnect_delay
#kombu_reconnect_delay = 1.0
# The RabbitMQ broker address where a single node is used. (string
# value)
# Deprecated group/name - [DEFAULT]/rabbit_host
#rabbit_host = localhost
# The RabbitMQ broker port where a single node is used. (integer
# value)
# Deprecated group/name - [DEFAULT]/rabbit_port
#rabbit_port = 5672
# RabbitMQ HA cluster host:port pairs. (list value)
# Deprecated group/name - [DEFAULT]/rabbit_hosts
#rabbit_hosts = $rabbit_host:$rabbit_port
# Connect over SSL for RabbitMQ. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_use_ssl
#rabbit_use_ssl = false
# The RabbitMQ userid. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_userid
#rabbit_userid = guest
905
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The RabbitMQ password. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_password
#rabbit_password = guest
# The RabbitMQ login method. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_login_method
#rabbit_login_method = AMQPLAIN
# The RabbitMQ virtual host. (string value)
# Deprecated group/name - [DEFAULT]/rabbit_virtual_host
#rabbit_virtual_host = /
# How frequently to retry connecting with RabbitMQ. (integer value)
#rabbit_retry_interval = 1
# How long to backoff for between retries when connecting to RabbitMQ.
# (integer value)
# Deprecated group/name - [DEFAULT]/rabbit_retry_backoff
#rabbit_retry_backoff = 2
# Maximum number of RabbitMQ connection retries. Default is 0
# (infinite retry count). (integer value)
# Deprecated group/name - [DEFAULT]/rabbit_max_retries
#rabbit_max_retries = 0
# Use HA queues in RabbitMQ (x-ha-policy: all). If you change this
# option, you must wipe the RabbitMQ database. (boolean value)
# Deprecated group/name - [DEFAULT]/rabbit_ha_queues
#rabbit_ha_queues = false
# Number of seconds after which the Rabbit broker is considered down
# if heartbeat's keep-alive fails (0 disables the heartbeat, >0
# enables it. Enabling heartbeats requires kombu>=3.0.7 and
# amqp>=1.4.0). EXPERIMENTAL (integer value)
#heartbeat_timeout_threshold = 0
# How often times during the heartbeat_timeout_threshold we check the
# heartbeat. (integer value)
#heartbeat_rate = 2
# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
# (boolean value)
# Deprecated group/name - [DEFAULT]/fake_rabbit
#fake_rabbit = false
[oslo_policy]
#
# From oslo.policy
#
# The JSON file that defines policies. (string value)
# Deprecated group/name - [DEFAULT]/policy_file
#policy_file = policy.json
906
CHAPTER 12. TELEMETRY
# Default rule. Enforced when a requested rule is not found. (string
# value)
# Deprecated group/name - [DEFAULT]/policy_default_rule
#policy_default_rule = default
# Directories where policy configuration files are stored. They can be
# relative to any directory in the search path defined by the
# config_dir option, or absolute paths. The file defined by
# policy_file must exist for these directories to be searched.
# Missing or empty directories are ignored. (multi valued)
# Deprecated group/name - [DEFAULT]/policy_dirs
#policy_dirs = policy.d
[polling]
#
# From ceilometer
#
# Work-load partitioning group prefix. Use only if you want to run
# multiple polling agents with different config files. For each sub-
# group of the agent pool with the same partitioning_group_prefix a
# disjoint subset of pollsters should be loaded. (string value)
# Deprecated group/name - [central]/partitioning_group_prefix
#partitioning_group_prefix = <None>
[publisher]
#
# From ceilometer
#
# Secret value for signing messages. Set value empty if signing is not
# required to avoid computational overhead. (string value)
# Deprecated group/name - [DEFAULT]/metering_secret
# Deprecated group/name - [publisher_rpc]/metering_secret
# Deprecated group/name - [publisher]/metering_secret
#telemetry_secret = change this for valid signing
[publisher_notifier]
#
# From ceilometer
#
# The topic that ceilometer uses for metering notifications. (string
# value)
#metering_topic = metering
# The topic that ceilometer uses for event notifications. (string
# value)
#event_topic = event
907
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# The driver that ceilometer uses for metering notifications. (string
# value)
# Deprecated group/name - [DEFAULT]/metering_driver
#telemetry_driver = messagingv2
[publisher_rpc]
#
# From ceilometer
#
# The topic that ceilometer uses for metering messages. (string value)
# Deprecated group/name - [DEFAULT]/metering_topic
#metering_topic = metering
[rgw_admin_credentials]
#
# From ceilometer
#
# Access key for Radosgw Admin. (string value)
#access_key = <None>
# Secret key for Radosgw Admin. (string value)
#secret_key = <None>
[service_credentials]
#
# From ceilometer
#
# User name to use for OpenStack service access. (string value)
# Deprecated group/name - [DEFAULT]/os_username
#os_username = ceilometer
# Password to use for OpenStack service access. (string value)
# Deprecated group/name - [DEFAULT]/os_password
#os_password = admin
# Tenant ID to use for OpenStack service access. (string value)
# Deprecated group/name - [DEFAULT]/os_tenant_id
#os_tenant_id =
# Tenant name to use for OpenStack service access. (string value)
# Deprecated group/name - [DEFAULT]/os_tenant_name
#os_tenant_name = admin
# Certificate chain for SSL validation. (string value)
#os_cacert = <None>
# Auth URL to use for OpenStack service access. (string value)
908
CHAPTER 12. TELEMETRY
# Deprecated group/name - [DEFAULT]/os_auth_url
#os_auth_url = http://localhost:5000/v2.0
# Region name to use for OpenStack service endpoints. (string value)
# Deprecated group/name - [DEFAULT]/os_region_name
#os_region_name = <None>
# Type of endpoint in Identity service catalog to use for
# communication with OpenStack services. (string value)
#os_endpoint_type = publicURL
# Disables X.509 certificate validation when an SSL connection to
# Identity Service is established. (boolean value)
#insecure = false
[service_types]
#
# From ceilometer
#
# Kwapi service type. (string value)
#kwapi = energy
# Glance service type. (string value)
#glance = image
# Neutron service type. (string value)
#neutron = network
# Nova service type. (string value)
#nova = compute
# Radosgw service type. (string value)
#radosgw = object-store
# Swift service type. (string value)
#swift = object-store
[vmware]
#
# From ceilometer
#
# IP address of the VMware Vsphere host. (string value)
#host_ip =
# Port of the VMware Vsphere host. (integer value)
#host_port = 443
# Username of VMware Vsphere. (string value)
#host_username =
909
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
# Password of VMware Vsphere. (string value)
#host_password =
# Number of times a VMware Vsphere API may be retried. (integer value)
#api_retry_count = 10
# Sleep time in seconds for polling an ongoing async task. (floating
# point value)
#task_poll_interval = 0.5
# Optional vim service WSDL location e.g
# http://<server>/vimService.wsdl. Optional over-ride to default
# location for bug work-arounds. (string value)
#wsdl_location = <None>
[xenapi]
#
# From ceilometer
#
# URL for connection to XenServer/Xen Cloud Platform. (string value)
#connection_url = <None>
# Username for connection to XenServer/Xen Cloud Platform. (string
# value)
#connection_username = root
# Password for connection to XenServer/Xen Cloud Platform. (string
# value)
#connection_password = <None>
# Timeout in seconds for XenAPI login. (integer value)
#login_timeout = 10
12.1.2. event_definitions.yaml
910
The event_definitions.yaml file defines how events received from other OpenStack components should be translated to Telemetry events.
This file provides a standard set of events and corresponding traits that may be of interest. This file can be modified to add and drop traits that operators may find useful.
---
- event_type: compute.instance.*
traits: &instance_traits
tenant_id:
fields: payload.tenant_id
user_id:
fields: payload.user_id
CHAPTER 12. TELEMETRY
instance_id:
fields: payload.instance_id
host:
fields: publisher_id
plugin:
name: split
parameters:
segment: 1
max_split: 1
service:
fields: publisher_id
plugin: split
memory_mb:
type: int
fields: payload.memory_mb
disk_gb:
type: int
fields: payload.disk_gb
root_gb:
type: int
fields: payload.root_gb
ephemeral_gb:
type: int
fields: payload.ephemeral_gb
vcpus:
type: int
fields: payload.vcpus
instance_type_id:
type: int
fields: payload.instance_type_id
instance_type:
fields: payload.instance_type
state:
fields: payload.state
os_architecture:
fields: payload.image_meta.'org.openstack__1__architecture'
os_version:
fields: payload.image_meta.'org.openstack__1__os_version'
os_distro:
fields: payload.image_meta.'org.openstack__1__os_distro'
launched_at:
type: datetime
fields: payload.launched_at
deleted_at:
type: datetime
fields: payload.deleted_at
- event_type: compute.instance.exists
traits:
<<: *instance_traits
audit_period_beginning:
type: datetime
fields: payload.audit_period_beginning
audit_period_ending:
type: datetime
fields: payload.audit_period_ending
- event_type: ['volume.exists', 'volume.create.*', 'volume.delete.*',
911
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
'volume.resize.*', 'volume.attach.*', 'volume.detach.*',
'volume.update.*', 'snapshot.exists', 'snapshot.create.*',
'snapshot.delete.*', 'snapshot.update.*']
traits: &cinder_traits
user_id:
fields: payload.user_id
project_id:
fields: payload.tenant_id
availability_zone:
fields: payload.availability_zone
display_name:
fields: payload.display_name
replication_status:
fields: payload.replication_status
status:
fields: payload.status
created_at:
fields: payload.created_at
- event_type: ['volume.exists', 'volume.create.*', 'volume.delete.*',
'volume.resize.*', 'volume.attach.*', 'volume.detach.*',
'volume.update.*']
traits:
<<: *cinder_traits
resource_id:
fields: payload.volume_id
host:
fields: payload.host
size:
fields: payload.size
type:
fields: payload.volume_type
replication_status:
fields: payload.replication_status
- event_type: ['snapshot.exists', 'snapshot.create.*',
'snapshot.delete.*', 'snapshot.update.*']
traits:
<<: *cinder_traits
resource_id:
fields: payload.snapshot_id
volume_id:
fields: payload.volume_id
- event_type: ['image.update', 'image.upload', 'image.delete']
traits: &glance_crud
project_id:
fields: payload.owner
resource_id:
fields: payload.id
name:
fields: payload.name
status:
fields: payload.status
created_at:
fields: payload.created_at
user_id:
fields: payload.owner
deleted_at:
912
CHAPTER 12. TELEMETRY
fields: payload.deleted_at
size:
fields: payload.size
- event_type: image.send
traits: &glance_send
receiver_project:
fields: payload.receiver_tenant_id
receiver_user:
fields: payload.receiver_user_id
user_id:
fields: payload.owner_id
image_id:
fields: payload.image_id
destination_ip:
fields: payload.destination_ip
bytes_sent:
fields: payload.bytes_sent
- event_type: orchestration.stack.*
traits: &orchestration_crud
project_id:
fields: payload.tenant_id
user_id:
fields: ['_context_trustor_user_id', '_context_user_id']
resource_id:
fields: payload.stack_identity
- event_type: sahara.cluster.*
traits: &sahara_crud
project_id:
fields: payload.project_id
user_id:
fields: _context_user_id
resource_id:
fields: payload.cluster_id
- event_type: ['identity.user.*', 'identity.project.*',
'identity.group.*', 'identity.role.*', 'identity.OS-TRUST:trust.*',
'identity.region.*', 'identity.service.*',
'identity.endpoint.*', 'identity.policy.*']
traits: &identity_crud
resource_id:
fields: payload.resource_info
initiator_id:
fields: payload.initiator.id
project_id:
fields: payload.initiator.project_id
domain_id:
fields: payload.initiator.domain_id
- event_type: identity.role_assignment.*
traits: &identity_role_assignment
role:
fields: payload.role
group:
fields: payload.group
domain:
fields: payload.domain
user:
fields: payload.user
913
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
project:
fields: payload.project
- event_type: identity.authenticate
traits: &identity_authenticate
typeURI:
fields: payload.typeURI
id:
fields: payload.id
action:
fields: payload.action
eventType:
fields: payload.eventType
eventTime:
fields: payload.eventTime
outcome:
fields: payload.outcome
initiator_typeURI:
fields: payload.initiator.typeURI
initiator_id:
fields: payload.initiator.id
initiator_name:
fields: payload.initiator.name
initiator_host_agent:
fields: payload.initiator.host.agent
initiator_host_addr:
fields: payload.initiator.host.address
target_typeURI:
fields: payload.target.typeURI
target_id:
fields: payload.target.id
observer_typeURI:
fields: payload.observer.typeURI
observer_id:
fields: payload.observer.id
- event_type: objectstore.http.request
traits: &objectstore_request
typeURI:
fields: payload.typeURI
id:
fields: payload.id
action:
fields: payload.action
eventType:
fields: payload.eventType
eventTime:
fields: payload.eventTime
outcome:
fields: payload.outcome
initiator_typeURI:
fields: payload.initiator.typeURI
initiator_id:
fields: payload.initiator.id
initiator_project_id:
fields: payload.initiator.project_id
target_typeURI:
fields: payload.target.typeURI
914
CHAPTER 12. TELEMETRY
target_id:
fields: payload.target.id
target_action:
fields: payload.target.action
target_metadata_path:
fields: payload.target.metadata.path
target_metadata_version:
fields: payload.target.metadata.version
target_metadata_container:
fields: payload.target.metadata.container
target_metadata_object:
fields: payload.target.metadata.object
observer_id:
fields: payload.observer.id
- event_type: magnetodb.table.*
traits: &kv_store
resource_id:
fields: payload.table_uuid
user_id:
fields: _context_user_id
project_id:
fields: _context_tenant
- event_type: ['network.*', 'subnet.*', 'port.*', 'router.*',
'floatingip.*', 'pool.*', 'vip.*', 'member.*', 'health_monitor.*',
'firewall.*', 'firewall_policy.*', 'firewall_rule.*', 'vpnservice.*',
'ipsecpolicy.*', 'ikepolicy.*', 'ipsec_site_connection.*']
traits: &network_traits
user_id:
fields: _context_user_id
project_id:
fields: _context_tenant_id
- event_type: network.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.network.id', 'payload.id']
- event_type: subnet.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.subnet.id', 'payload.id']
- event_type: port.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.port.id', 'payload.id']
- event_type: router.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.router.id', 'payload.id']
- event_type: floatingip.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.floatingip.id', 'payload.id']
915
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
- event_type: pool.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.pool.id', 'payload.id']
- event_type: vip.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.vip.id', 'payload.id']
- event_type: member.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.member.id', 'payload.id']
- event_type: health_monitor.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.health_monitor.id', 'payload.id']
- event_type: firewall.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.firewall.id', 'payload.id']
- event_type: firewall_policy.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.firewall_policy.id', 'payload.id']
- event_type: firewall_rule.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.firewall_rule.id', 'payload.id']
- event_type: vpnservice.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.vpnservice.id', 'payload.id']
- event_type: ipsecpolicy.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.ipsecpolicy.id', 'payload.id']
- event_type: ikepolicy.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.ikepolicy.id', 'payload.id']
- event_type: ipsec_site_connection.*
traits:
<<: *network_traits
resource_id:
fields: ['payload.ipsec_site_connection.id', 'payload.id']
- event_type: '*http.*'
916
CHAPTER 12. TELEMETRY
traits: &http_audit
typeURI:
fields: payload.typeURI
eventType:
fields: payload.eventType
action:
fields: payload.action
outcome:
fields: payload.outcome
id:
fields: payload.id
eventTime:
fields: payload.eventTime
requestPath:
fields: payload.requestPath
observer_id:
fields: payload.observer.id
target_id:
fields: payload.target.id
target_typeURI:
fields: payload.target.typeURI
target_name:
fields: payload.target.name
initiator_typeURI:
fields: payload.initiator.typeURI
initiator_id:
fields: payload.initiator.id
initiator_name:
fields: payload.initiator.name
initiator_host_address:
fields: payload.initiator.host.address
- event_type: '*http.response'
traits:
<<: *http_audit
reason_code:
fields: payload.reason.reasonCode
12.1.3. pipeline.yaml
Pipelines describe a coupling between sources of samples and the corresponding sinks for transformation and publication of the data. They are defined in the pipeline.yaml file.
This file can be modified to adjust polling intervals and the samples generated by the Telemetry module
--sources:
- name: meter_source
interval: 600
meters:
- "*"
sinks:
- meter_sink
- name: cpu_source
917
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
interval: 600
meters:
- "cpu"
sinks:
- cpu_sink
- name: disk_source
interval: 600
meters:
- "disk.read.bytes"
- "disk.read.requests"
- "disk.write.bytes"
- "disk.write.requests"
- "disk.device.read.bytes"
- "disk.device.read.requests"
- "disk.device.write.bytes"
- "disk.device.write.requests"
sinks:
- disk_sink
- name: network_source
interval: 600
meters:
- "network.incoming.bytes"
- "network.incoming.packets"
- "network.outgoing.bytes"
- "network.outgoing.packets"
sinks:
- network_sink sinks:
- name: meter_sink
transformers:
publishers:
- notifier://
- name: cpu_sink
transformers:
- name: "rate_of_change"
parameters:
target:
name: "cpu_util"
unit: "%"
type: "gauge"
scale: "100.0 / (10**9 *
(resource_metadata.cpu_number or 1))"
publishers:
- notifier://
- name: disk_sink
transformers:
- name: "rate_of_change"
parameters:
source:
map_from:
name: "(disk\\.device|disk)\\.(read|write)\\.
(bytes|requests)"
unit: "(B|request)"
target:
map_to:
name: "\\1.\\2.\\3.rate"
918
CHAPTER 12. TELEMETRY
unit: "\\1/s"
type: "gauge"
publishers:
- notifier://
- name: network_sink
transformers:
- name: "rate_of_change"
parameters:
source:
map_from:
name: "network\\.(incoming|outgoing)\\.
(bytes|packets)"
unit: "(B|packet)"
target:
map_to:
name: "network.\\1.\\2.rate"
unit: "\\1/s"
type: "gauge"
publishers:
- notifier://
12.1.4. event_pipeline.yaml
Event pipelines describe a coupling between notification event_types and the corresponding sinks for publication of the event data. They are defined in the event_pipeline.yaml file.
This file can be modified to adjust which notifications to capture and the and where to publish the events.
--sources:
- name: event_source
events:
- "*"
sinks:
- event_sink sinks:
- name: event_sink
transformers:
triggers:
publishers:
- direct://
12.1.5. policy.json
The policy.json file defines additional access controls that apply to the Telemetry service.
{
"context_is_admin": "role:admin",
"context_is_project": "project_id:%(target.project_id)s",
"context_is_owner": "user_id:%(target.user_id)s",
919
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
"segregation": "rule:context_is_admin",
"default": ""
}
12.2. NEW, UPDATED AND DEPRECATED OPTIONS IN KILO FOR
TELEMETRY
Table 12.34. New options
Option = default value
[DEFAULT] api_workers = 1
[DEFAULT] event_pipeline_cfg_file = event_pipeline.yaml
[DEFAULT] magnetodb_control_exchange = magnetodb
[DEFAULT] polling_namespaces = ['compute',
'central']
[DEFAULT] pollster_list = []
[DEFAULT] reserved_metadata_keys =
[DEFAULT] shuffle_time_before_polling_task = 0
[DEFAULT] sql_expire_samples_only = False
[DEFAULT] swift_control_exchange = swift
[DEFAULT] zaqar_control_exchange = zaqar
[alarms] gnocchi_url = http://localhost:8041
[collector] requeue_event_on_dispatcher_error =
False
(Type) Help string
(IntOpt) Number of workers for Ceilometer API server.
(StrOpt) Configuration file for event pipeline definition.
(StrOpt) Exchange name for Magnetodb notifications.
(MultiChoicesOpt) Polling namespace(s) to be used while resource polling
(MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling
(ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.
(IntOpt) To reduce large requests at same time to
Nova or other components from different compute agents, shuffle start time of polling task.
(BoolOpt) Indicates if expirer expires only samples.
If set true, expired samples will be deleted, but residual resource and meter definition data will remain.
(StrOpt) Exchange name for Swift notifications.
(StrOpt) Exchange name for Messaging service notifications.
(StrOpt) URL to Gnocchi.
(BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it.
920
CHAPTER 12. TELEMETRY
Option = default value
[coordination] check_watchers = 10.0
[database] db2nosql_resource_id_maxlen = 512
[database] event_connection = None
[database] event_time_to_live = -1
[database] metering_time_to_live = -1
[database] mongodb_replica_set =
[dispatcher_http] cadf_only = False
[dispatcher_http] event_target = None
[dispatcher_http] target =
[dispatcher_http] timeout = 5
[event] store_raw = []
[ipmi] polling_retry = 3
(Type) Help string
(FloatOpt) Number of seconds between checks to see if group membership has changed
(IntOpt) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is <hostname>_<nodename>.
(StrOpt) The connection string used to connect to the event database. (if unset, connection is used)
(IntOpt) Number of seconds that events are kept in the database for (<= 0 means forever).
(IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever).
(StrOpt) The name of the replica set which is used to connect to MongoDB database. If it is set,
MongoReplicaSetClient will be used instead of
MongoClient.
(BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted.
(StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target.
(StrOpt) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path
(IntOpt) The max time in seconds to wait for a request to timeout.
(MultiStrOpt) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured.
(IntOpt) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever.
921
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[notification] disable_non_metric_meters = False
[notification] workload_partitioning = False
(Type) Help string
(BoolOpt) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation.
This option disables the collection of non-metric meters and will be the default behavior in Liberty.
(BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.
(BoolOpt) Enables or disables inter-process locks.
[oslo_concurrency] disable_process_locking =
False
[oslo_concurrency] lock_path = None
[oslo_messaging_amqp] allow_insecure_clients =
False
[oslo_messaging_amqp] broadcast_prefix = broadcast
[oslo_messaging_amqp] container_name = None
[oslo_messaging_amqp] group_request_prefix = unicast
[oslo_messaging_amqp] idle_timeout = 0
[oslo_messaging_amqp] server_request_prefix = exclusive
[oslo_messaging_amqp] ssl_ca_file =
[oslo_messaging_amqp] ssl_cert_file =
[oslo_messaging_amqp] ssl_key_file =
[oslo_messaging_amqp] ssl_key_password =
None
(StrOpt) 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 external locks are used, a lock path must be set.
(BoolOpt) Accept clients using either SSL or plain
TCP
(StrOpt) address prefix used when broadcasting to all servers
(StrOpt) Name for the AMQP container
(StrOpt) address prefix when sending to any server in group
(IntOpt) Timeout for inactive connections (in seconds)
(StrOpt) address prefix used when sending to a specific server
(StrOpt) CA certificate PEM file for verifing server certificate
(StrOpt) Identifying certificate PEM file to present to clients
(StrOpt) Private key PEM file used to sign cert_file certificate
(StrOpt) Password for decrypting ssl_key_file (if encrypted)
922
CHAPTER 12. TELEMETRY
Option = default value
[oslo_messaging_amqp] trace = False
(Type) Help string
(BoolOpt) Debug: dump AMQP frames to stdout
[oslo_messaging_qpid] amqp_auto_delete = False (BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_qpid] amqp_durable_queues =
False
(BoolOpt) Use durable queues in AMQP.
[oslo_messaging_qpid] qpid_heartbeat = 60 (IntOpt) Seconds between connection keepalive heartbeats.
[oslo_messaging_qpid] qpid_hostname = localhost (StrOpt) Qpid broker hostname.
(ListOpt) Qpid HA cluster host:port pairs.
[oslo_messaging_qpid] qpid_hosts =
$qpid_hostname:$qpid_port
[oslo_messaging_qpid] qpid_password =
[oslo_messaging_qpid] qpid_port = 5672
[oslo_messaging_qpid] qpid_protocol = tcp
(StrOpt) Password for Qpid connection.
(IntOpt) Qpid broker port.
(StrOpt) Transport to use, either 'tcp' or 'ssl'.
[oslo_messaging_qpid] qpid_receiver_capacity = 1 (IntOpt) The number of prefetched messages held by receiver.
[oslo_messaging_qpid] qpid_sasl_mechanisms =
[oslo_messaging_qpid] qpid_tcp_nodelay = True
(StrOpt) Space separated list of SASL mechanisms to use for auth.
(BoolOpt) Whether to disable the Nagle algorithm.
[oslo_messaging_qpid] qpid_topology_version = 1 (IntOpt) The qpid topology version to use. Version
1 is what was originally used by impl_qpid. Version
2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
(StrOpt) Username for Qpid connection.
[oslo_messaging_qpid] qpid_username =
[oslo_messaging_qpid] rpc_conn_pool_size = 30 (IntOpt) Size of RPC connection pool.
(BoolOpt) Auto-delete queues in AMQP.
[oslo_messaging_rabbit] amqp_auto_delete =
False
[oslo_messaging_rabbit] amqp_durable_queues =
False
[oslo_messaging_rabbit] fake_rabbit = False
(BoolOpt) Use durable queues in AMQP.
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
923
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[oslo_messaging_rabbit] heartbeat_rate = 2
[oslo_messaging_rabbit] heartbeat_timeout_threshold = 0
[oslo_messaging_rabbit] kombu_reconnect_delay
= 1.0
[oslo_messaging_rabbit] kombu_ssl_ca_certs =
[oslo_messaging_rabbit] kombu_ssl_certfile =
[oslo_messaging_rabbit] kombu_ssl_keyfile =
[oslo_messaging_rabbit] kombu_ssl_version =
[oslo_messaging_rabbit] rabbit_ha_queues =
False
[oslo_messaging_rabbit] rabbit_host = localhost
(Type) Help string
(IntOpt) How often times during the heartbeat_timeout_threshold to check the heartbeat.
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, >0 enables it.
Enabling heartbeats requires kombu>=3.0.7 and amqp>=1.4.0). EXPERIMENTAL
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
(StrOpt) SSL certification authority file (valid only if
SSL enabled).
(StrOpt) SSL cert file (valid only if SSL enabled).
(StrOpt) SSL key file (valid only if SSL enabled).
(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23.
SSLv2, SSLv3, TLSv1_1, and TLSv1_2 are also available.
(BoolOpt) Use HA queues in RabbitMQ (x-hapolicy: all). If you change this option, you must wipe the RabbitMQ database.
(StrOpt) The RabbitMQ broker address where a single node is used.
(ListOpt) RabbitMQ HA cluster host:port pairs.
[oslo_messaging_rabbit] rabbit_hosts =
$rabbit_host:$rabbit_port
[oslo_messaging_rabbit] rabbit_login_method =
AMQPLAIN
[oslo_messaging_rabbit] rabbit_max_retries = 0
(StrOpt) The RabbitMQ login method.
[oslo_messaging_rabbit] rabbit_password = guest
[oslo_messaging_rabbit] rabbit_port = 5672
[oslo_messaging_rabbit] rabbit_retry_backoff = 2
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
(StrOpt) The RabbitMQ password.
(IntOpt) The RabbitMQ broker port where a single node is used.
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
924
CHAPTER 12. TELEMETRY
Option = default value
[oslo_messaging_rabbit] rabbit_retry_interval = 1
[oslo_policy] policy_dirs = ['policy.d']
(Type) Help string
(IntOpt) How frequently to retry connecting with
RabbitMQ.
(BoolOpt) Connect over SSL for RabbitMQ.
[oslo_messaging_rabbit] rabbit_use_ssl = False
[oslo_messaging_rabbit] rabbit_userid = guest
[oslo_messaging_rabbit] rabbit_virtual_host = /
[oslo_messaging_rabbit] rpc_conn_pool_size = 30
[oslo_middleware] max_request_body_size =
114688
[oslo_policy] policy_default_rule = default
(StrOpt) The RabbitMQ userid.
(StrOpt) The RabbitMQ virtual host.
(IntOpt) Size of RPC connection pool.
(IntOpt) The maximum body size for each request, in bytes.
(StrOpt) Default rule. Enforced when a requested rule is not found.
(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
[oslo_policy] policy_file = policy.json
[polling] partitioning_group_prefix = None
(StrOpt) The JSON file that defines policies.
(StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.
[publisher] telemetry_secret = change this for valid signing
(StrOpt) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead.
[publisher_notifier] event_topic = event
[publisher_notifier] telemetry_driver = messagingv2
[rgw_admin_credentials] access_key = None
(StrOpt) The topic that ceilometer uses for event notifications.
(StrOpt) The driver that ceilometer uses for metering notifications.
(StrOpt) Access key for Radosgw Admin.
[rgw_admin_credentials] secret_key = None
[service_types] radosgw = object-store
(StrOpt) Secret key for Radosgw Admin.
(StrOpt) Radosgw service type.
925
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
Option = default value
[vmware] host_port = 443
(Type) Help string
(IntOpt) Port of the VMware Vsphere host.
Table 12.35. New default values
Option
[DEFAULT] rpc_zmq_matchmaker
Previous default value New default value oslo.messaging._drivers.matchm
aker.MatchMakerLocalhost
local
Table 12.36. Deprecated options
Deprecated option
[alarm] evaluation_service
[DEFAULT] log_format
[database] time_to_live
[DEFAULT] database_connection
[publisher] metering_secret
[alarm] partition_rpc_topic
[DEFAULT] use_syslog
New Option
None
None
[database] metering_time_to_live
None
[publisher] telemetry_secret
None
None
926
APPENDIX A. THE POLICY.JSON FILE
APPENDIX A. THE POLICY.JSON FILE
Note
The following functionality is limited to Nova API v2.0, and currently does not apply to
Nova API v2.1.
Each OpenStack service, Identity, Compute, Networking and so on, has its own role-based access policies. They determine which user can access which objects in which way, and are defined in the service's policy.json file.
Whenever an API call to an OpenStack service is made, the service's policy engine uses the appropriate policy definitions to determine if the call can be accepted. Any changes to
policy.json are effective immediately, which allows new policies to be implemented while the service is running.
A policy.json file is a text file in JSON (Javascript Object Notation) format. Each policy is defined by a one-line statement in the form "<target>" : "<rule>".
The policy target, also named "action", represents an API call like "start an instance" or "attach a volume".
Action names are usually qualified. Example: OpenStack Compute features API calls to list instances, volumes and networks. In /etc/nova/policy.json, these APIs are represented by
compute:get_all, volume:get_all and network:get_all, respectively.
The mapping between API calls and actions is not generally documented.
The policy rule determines under which circumstances the API call is permitted. Usually this involves the user who makes the call (hereafter named the "API user") and often the object on which the API call operates. A typical rule checks if the API user is the object's owner.
Modifying the policy
While recipes for editing policy.json files are found on blogs, modifying the policy can have unexpected side effects and is not encouraged.
A.1. EXAMPLES
A simple rule might look like this:
"compute:get_all" : ""
The target is "compute:get_all", the "list all instances" API of the Compute service. The rule is an empty string meaning "always". This policy allows anybody to list instances.
927
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
You can also decline permission to use an API:
"compute:shelve": "!"
The exclamation mark stands for "never" or "nobody", which effectively disables the Compute API
"shelve an instance".
Many APIs can only be called by admin users. This can be expressed by the rule "role:admin".
The following policy ensures that only administrators can create new users in the Identity database:
"identity:create_user" : "role:admin"
You can limit APIs to any role. For example, the Orchestration service defines a role named
heat_stack_user. Whoever has this role isn't allowed to create stacks:
"stacks:create": "not role:heat_stack_user"
This rule makes use of the boolean operator not. More complex rules can be built using operators
and, or and parentheses.
You can define aliases for rules:
"deny_stack_user": "not role:heat_stack_user"
The policy engine understands that "deny_stack_user" is not an API and consequently interprets it as an alias. The stack creation policy above can then be written as:
"stacks:create": "rule:deny_stack_user"
This is taken verbatim from /etc/heat/policy.json.
Rules can compare API attributes to object attributes. For example:
"compute:start" : "user_id:%(user_id)s" states that only the owner of an instance can start it up. The user_id string before the colon is an
API attribute, namely the user ID of the API user. It is compared with the user ID of the object (in this case, an instance); more precisely, it is compared with the user_id field of that object in the database. If the two values are equal, permission is granted.
An admin user always has permission to call APIs. This is how /etc/keystone/policy.json makes this policy explicit:
"admin_required": "role:admin or is_admin:1",
"owner" : "user_id:%(user_id)s",
"admin_or_owner": "rule:admin_required or rule:owner",
"identity:change_password": "rule:admin_or_owner"
928
APPENDIX A. THE POLICY.JSON FILE
The first line defines an alias for "user is an admin user". The is_admin flag is only used when setting up the Identity service for the first time. It indicates that the user has admin privileges granted by the service token (--os-token parameter of the keystone command line client).
The second line creates an alias for "user owns the object" by comparing the API's user ID with the object's user ID.
Line 3 defines a third alias admin_or_owner, combining the two first aliases with the Boolean operator or.
Line 4 sets up the policy that a password can only be modified by its owner or an admin user.
As a final example, let's examine a more complex rule:
"identity:ec2_delete_credential": "rule:admin_required or
(rule:owner and user_id:%(target.credential.user_id)s)"
This rule determines who can use the Identity API "delete EC2 credential". Here, boolean operators and parentheses combine three simpler rules. admin_required and owner are the same aliases as in the previous example. user_id:%(target.credential.user_id)s compares the API user with the user ID of the credential object associated with the target.
A.2. SYNTAX
A policy.json file consists of policies and aliases of the form target:rule or
alias:definition, separated by commas and enclosed in curly braces:
{
"alias 1" : "definition 1",
"alias 2" : "definition 2",
...
"target 1" : "rule 1",
"target 2" : "rule 2",
....
}
Targets are APIs and are written "service:API" or simply "API". For example,
"compute:create" or "add_image".
Rules determine whether the API call is allowed.
Rules can be: always true. The action is always permitted. This can be written as "" (empty string), [], or
"@".
always false. The action is never permitted. Written as "!".
929
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
a special check a comparison of two values boolean expressions based on simpler rules
Special checks are
<role>:<role name>, a test whether the API credentials contain this role.
<rule>:<rule name>, the definition of an alias.
http:<target URL>, which delegates the check to a remote server. The API is authorized when the server returns True.
Developers can define additional special checks.
Two values are compared in the following way:
"value1 : value2"
Possible values are constants: Strings, numbers, true, false
API attributes target object attributes the flag is_admin
API attributes can be project_id, user_id or domain_id.
Target object attributes are fields from the object description in the database. For example in the case of the "compute:start" API, the object is the instance to be started. The policy for starting instances could use the %(project_id)sattribute, that is the project that owns the instance. The trailing s indicates this is a string.
is_admin indicates that administrative privileges are granted via the admin token mechanism (the
--os-token option of the keystone command). The admin token allows initialisation of the identity database before the admin role exists.
The alias construct exists for convenience. An alias is short name for a complex or hard to understand rule. It is defined in the same way as a policy:
930
APPENDIX A. THE POLICY.JSON FILE
alias name : alias definition
Once an alias is defined, use the rule keyword to use it in a policy rule.
A.3. OLDER SYNTAX
You may encounter older policy.json files that feature a different syntax, where JavaScript arrays are used instead of boolean operators. For example, the EC2 credentials rule above would have been written as follows:
"identity:ec2_delete_credential": [ [ "rule:admin_required ],
[ "rule:owner", "user_id:%(target.credential.user_id)s)" ] ]
The rule is an array of arrays. The innermost arrays are or'ed together, whereas elements inside the innermost arrays are and'ed.
While the old syntax is still supported, we recommend using the newer, more intuitive syntax.
931
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
APPENDIX B. FIREWALLS AND DEFAULT PORTS
On some deployments, such as ones where restrictive firewalls are in place, you might need to manually configure a firewall to permit OpenStack service traffic.
To manually configure a firewall, you must permit traffic through the ports that each OpenStack service uses. This table lists the default ports that each OpenStack service uses:
Table B.1. Default ports that OpenStack components use
OpenStack service
Data processing service (
sahara
) endpoint
Identity service (
keystone
) administrative endpoint
Identity service public endpoint
Default ports
Block Storage (
cinder
)
Compute (
nova
) endpoints
Compute API (
nova-api
)
Compute ports for access to virtual machine consoles
8776
8774
8773, 8775
5900-5999
Compute VNC proxy for browsers (
openstacknova-novncproxy
)
6080
6081 Compute VNC proxy for traditional VNC clients
(
openstack-nova-xvpvncproxy
)
Proxy port for HTML5 console used by Compute service
6082
8386
35357
Image service (
glance
) API
Image service registry
Networking (
neutron
)
Object Storage (
swift
)
Orchestration (
heat
) endpoint
Orchestration AWS CloudFormation-compatible
API (
openstack-heat-api-cfn
)
5000
9292
9191
9696
6000, 6001, 6002
8004
8000
Port type
publicurl and adminurl publicurl and adminurl publicurl and adminurl adminurl publicurl publicurl and adminurl publicurl and adminurl publicurl and adminurl
932
APPENDIX B. FIREWALLS AND DEFAULT PORTS
Port type OpenStack service
Orchestration AWS CloudWatch-compatible API
(
openstack-heat-api-cloudwatch
)
Telemetry (
ceilometer
)
Default ports
8003
8777 publicurl and adminurl
To function properly, some OpenStack components depend on other, non-OpenStack services. For example, the OpenStack dashboard uses HTTP for non-secure communication. In this case, you must configure the firewall to allow traffic to and from HTTP.
This table lists the ports that other OpenStack components use:
Table B.2. Default ports that secondary services related to OpenStack components use
Service
HTTP
HTTP alternate
HTTPS rsync iSCSI target
MySQL database service
Message Broker
(AMQP traffic)
Default port
80
8080
443
873
3260
3306
5672
Used by
OpenStack dashboard (
Horizon
) when it is not configured to use secure access.
OpenStack Object Storage (
swift
) service.
Any OpenStack service that is enabled for SSL, especially secure-access dashboard.
OpenStack Object Storage. Required.
OpenStack Block Storage. Required.
Most OpenStack components.
OpenStack Block Storage, Networking,
Orchestration, and Compute.
On some deployments, the default port used by a service may fall within the defined local port range of a host. To check a host's local port range:
$ sysctl -a | grep ip_local_port_range
If a service's default port falls within this range, run the following program to check if the port has already been assigned to another application:
$ lsof -i :PORT
Configure the service to use a different port if the default port is already being used by another application.
933
Red Hat Enterprise Linux OpenStack Platform 7 Configuration Reference
934
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement
Key features
Provides comprehensive configuration options
Covers all OpenStack services
Includes sample configuration files
Supports both bare metal and virtualized deployments
Provides detailed information on logging, authentication, and authorization
Offers guidance on deploying and managing cloud resources
Explains key features of OpenStack components
Covers new, updated, and deprecated options for each service
Frequently asked questions
This guide provides a comprehensive list of configuration options available for Red Hat Enterprise Linux OpenStack Platform 7, including sample configuration files.
The guide covers all of the core OpenStack services, including Compute, Networking, Storage, Identity, and Image.
You can access the configuration options through the respective configuration files for each OpenStack service.
