Juno - Juno - Juno - Juno - Juno - Juno - Juno - Juno -
Contents
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 Glance,
which is required by euca2ools.
To customize the Compute Service, use the configuration option settings documented in Table 2.30, “Description of glance configuration options” and Table 2.50, “Description of S3 configuration options”.
You can modify many options in the OpenStack Image Service. The following tables provide a comprehensive list.
| Configuration option = Default value | Description |
|---|---|
| [keystone_authtoken] | |
| admin_password = None | (StrOpt) Keystone account password |
| admin_tenant_name = admin | (StrOpt) Keystone service account tenant name to validate user tokens |
| admin_token = None | (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. |
| admin_user = None | (StrOpt) Keystone account username |
| auth_admin_prefix = | (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. |
| auth_host = 127.0.0.1 | (StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. |
| auth_port = 35357 | (IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. |
| auth_protocol = https | (StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. |
| auth_uri = None | (StrOpt) Complete public Identity API endpoint |
| auth_version = None | (StrOpt) API version of the admin Identity API endpoint |
| cache = None | (StrOpt) Env key for the swift cache |
| cafile = None | (StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| certfile = None | (StrOpt) Required if Keystone server requires client certificate |
| check_revocations_for_cached = False | (BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. |
| delay_auth_decision = False | (BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components |
| enforce_token_bind = permissive | (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. |
| hash_algorithms = md5 | (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. |
| http_connect_timeout = None | (BoolOpt) Request timeout value for communicating with Identity API server. |
| http_request_max_retries = 3 | (IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. |
| identity_uri = None | (StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ |
| include_service_catalog = True | (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. |
| insecure = False | (BoolOpt) Verify HTTPS connections. |
| keyfile = None | (StrOpt) Required if Keystone server requires client certificate |
| memcache_secret_key = None | (StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. |
| memcache_security_strategy = None | (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. |
| revocation_cache_time = 10 | (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. |
| signing_dir = None | (StrOpt) Directory used to cache files related to PKI tokens |
| token_cache_time = 300 | (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. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| allow_additional_image_properties = True | (BoolOpt) Whether to allow users to specify image properties beyond what the image schema provides |
| api_limit_max = 1000 | (IntOpt) Maximum permissible number of items that could be returned by a request |
| backlog = 4096 | (IntOpt) The backlog value that will be used when creating the TCP listener socket. |
| bind_host = 0.0.0.0 | (StrOpt) Address to bind the server. Useful when selecting a particular network interface. |
| bind_port = None | (IntOpt) The port on which the server will listen. |
| data_api = glance.db.sqlalchemy.api | (StrOpt) Python module path of data access API |
| image_location_quota = 10 | (IntOpt) Maximum number of locations allowed on an image. Negative values evaluate to unlimited. |
| image_member_quota = 128 | (IntOpt) Maximum number of image members per image. Negative values evaluate to unlimited. |
| image_property_quota = 128 | (IntOpt) Maximum number of properties allowed on an image. Negative values evaluate to unlimited. |
| image_tag_quota = 128 | (IntOpt) Maximum number of tags allowed on an image. Negative values evaluate to unlimited. |
| limit_param_default = 25 | (IntOpt) Default value for the number of items returned by a request if not specified explicitly in the request |
| lock_path = None | (StrOpt) Directory to use for lock files. |
| memcached_servers = None | (ListOpt) Memcached servers or None for in process cache. |
| metadata_encryption_key = None | (StrOpt) Key used for encrypting sensitive metadata while talking to the registry or database. |
| metadata_source_path = /etc/glance/metadefs/ | (StrOpt) Path to the directory where json metadata files are stored |
| property_protection_file = None | (StrOpt) The location of the property protection file. |
| property_protection_rule_format = roles | (StrOpt) This config value indicates whether "roles" or "policies" are used in the property protection file. |
| show_image_direct_url = False | (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! |
| user_storage_quota = 0 | (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 TeraBytesrespectively. 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. |
| workers = 4 | (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 | (StrOpt) Region name of this node |
| [image_format] | |
| container_formats = ami, ari, aki, bare, ovf, ova | (ListOpt) Supported values for the 'container_format' image attribute |
| disk_formats = ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso | (ListOpt) Supported values for the 'disk_format' image attribute |
| [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. |
| [task] | |
| eventlet_executor_pool_size = 1000 | (IntOpt) Specifies the maximum number of eventlet threads which can be spun up by the eventlet based task executor to perform execution of Glance tasks. |
| task_executor = eventlet | (StrOpt) Specifies which task executor to be used to run the task scripts. |
| task_time_to_live = 48 | (IntOpt) Time in hours for which a task lives after, either succeeding or failing |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| db_enforce_mysql_charset = True | (BoolOpt) DEPRECATED. TO BE REMOVED IN THE JUNO RELEASE. Whether or not to enforce that all DB tables have charset utf8. If your database tables do not have charset utf8 you will need to convert before this option is removed. This option is only relevant if your database engine is MySQL. |
| [database] | |
| backend = sqlalchemy | (StrOpt) The back end to use for the database. |
| connection = None | (StrOpt) The SQLAlchemy connection string to use to connect to the database. |
| connection_debug = 0 | (IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. |
| connection_trace = False | (BoolOpt) Add Python stack traces to SQL as comment strings. |
| db_inc_retry_interval = True | (BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval. |
| db_max_retries = 20 | (IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count. |
| db_max_retry_interval = 10 | (IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries. |
| db_retry_interval = 1 | (IntOpt) Seconds between database connection retries. |
| idle_timeout = 3600 | (IntOpt) Timeout before idle SQL connections are reaped. |
| max_overflow = None | (IntOpt) If set, use this value for max_overflow with SQLAlchemy. |
| max_pool_size = None | (IntOpt) Maximum number of SQL connections to keep open in a pool. |
| max_retries = 10 | (IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count. |
| min_pool_size = 1 | (IntOpt) Minimum number of SQL connections to keep open in a pool. |
| mysql_sql_mode = TRADITIONAL | (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= |
| pool_timeout = None | (IntOpt) If set, use this value for pool_timeout with SQLAlchemy. |
| retry_interval = 10 | (IntOpt) Interval between retries of opening a SQL connection. |
| slave_connection = None | (StrOpt) The SQLAlchemy connection string to use to connect to the slave database. |
| sqlite_db = oslo.sqlite | (StrOpt) The file name to use with SQLite. |
| sqlite_synchronous = True | (BoolOpt) If True, SQLite uses synchronous mode. |
| use_db_reconnect = False | (BoolOpt) Enable the experimental use of database reconnect on connection lost. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| cleanup_scrubber = False | (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. |
| cleanup_scrubber_time = 86400 | (IntOpt) Items must have a modified time that is older than this value in order to be candidates for cleanup. |
| delayed_delete = False | (BoolOpt) Turn on/off delayed delete. |
| image_cache_dir = None | (StrOpt) Base directory that the Image Cache uses. |
| image_cache_driver = sqlite | (StrOpt) The driver to use for image cache management. |
| image_cache_max_size = 10737418240 | (IntOpt) The maximum size in bytes that the cache can use. |
| image_cache_sqlite_db = cache.db | (StrOpt) The path to the sqlite file database that will be used for image cache management. |
| image_cache_stall_time = 86400 | (IntOpt) The amount of time to let an image remain in the cache without being accessed. |
| scrub_time = 0 | (IntOpt) The amount of time in seconds to delay before performing a delete. |
| scrubber_datadir = /var/lib/glance/scrubber | (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. |
| 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 | (ListOpt) List of logger=LEVEL pairs. |
| fatal_deprecations = False | (BoolOpt) Enables or disables fatal status of deprecations. |
| instance_format = "[instance: %(uuid)s] " | (StrOpt) The format for an instance that is passed with the log message. |
| instance_uuid_format = "[instance: %(uuid)s] " | (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. |
| 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. |
| 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) Format string to use for log messages with context. |
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | (StrOpt) Data to append to log format when level is DEBUG. |
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | (StrOpt) Format string to use for log messages without context. |
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | (StrOpt) Prefix each line of exception output with this format. |
| publish_errors = False | (BoolOpt) Enables or disables publication of error events. |
| syslog_log_facility = LOG_USER | (StrOpt) Syslog facility to receive log lines. |
| use_stderr = True | (BoolOpt) Log output to standard error. |
| use_syslog = False | (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. |
| use_syslog_rfc_format = False | (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. |
| verbose = False | (BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| policy_default_rule = default | (StrOpt) The default policy to use. |
| policy_file = policy.json | (StrOpt) The location of the policy file. |
| Configuration option = Default value | Description |
|---|---|
| [profiler] | |
| enabled = True | (BoolOpt) If False fully disable profiling feature. |
| trace_sqlalchemy = True | (BoolOpt) If False doesn't trace SQL requests. |
| Configuration option = Default value | Description |
|---|---|
| [matchmaker_redis] | |
| host = 127.0.0.1 | (StrOpt) Host to locate redis. |
| password = None | (StrOpt) Password for Redis server (optional). |
| port = 6379 | (IntOpt) Use this port to connect to redis host. |
| [matchmaker_ring] | |
| ringfile = /etc/oslo/matchmaker_ring.json | (StrOpt) Matchmaker ring file (JSON). |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| admin_password = None | (StrOpt) The administrators password. If "use_user_token" is not in effect, then admin credentials can be specified. |
| admin_tenant_name = None | (StrOpt) The tenant name of the administrative user. If "use_user_token" is not in effect, then admin tenant name can be specified. |
| admin_user = None | (StrOpt) The administrators user name. If "use_user_token" is not in effect, then admin credentials can be specified. |
| auth_region = None | (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. |
| auth_strategy = noauth | (StrOpt) The strategy to use for authentication. If "use_user_token" is not in effect, then auth strategy can be specified. |
| auth_url = None | (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. |
| registry_client_ca_file = None | (StrOpt) The path to the certifying authority cert file to use in SSL connections to the registry server. |
| registry_client_cert_file = None | (StrOpt) The path to the cert file to use in SSL connections to the registry server. |
| registry_client_insecure = False | (BoolOpt) When using SSL in connections to the registry server, do not require validation via a certifying authority. |
| registry_client_key_file = None | (StrOpt) The path to the key file to use in SSL connections to the registry server. |
| registry_client_protocol = http | (StrOpt) The protocol to use for communication with the registry server. Either http or https. |
| registry_client_timeout = 600 | (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. |
| registry_host = 0.0.0.0 | (StrOpt) Address to find the registry server. |
| registry_port = 9191 | (IntOpt) Port the registry server is listening on. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| fake_rabbit = False | (BoolOpt) If passed, use a fake RabbitMQ provider. |
| pydev_worker_debug_host = None | (StrOpt) The hostname/IP of the pydev process listening for debug connections |
| pydev_worker_debug_port = 5678 | (IntOpt) The port on which a pydev process is listening for connections. |
