Configuration Options

oslo.service uses oslo.config to define and manage configuration options to allow the deployer to control how an application uses this library.

periodic_task

These options apply to services using the periodic task features of oslo.service.

DEFAULT

run_external_periodic_tasks

Type

boolean

Default

True

Some periodic tasks can be run in a separate process. Should we run them here?

service

These options apply to services using the basic service framework.

DEFAULT

backdoor_port

Type

string

Default

<None>

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.

backdoor_socket

Type

string

Default

<None>

Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process.

log_options

Type

boolean

Default

True

Enables or disables logging values of all registered options when starting a service (at DEBUG level).

graceful_shutdown_timeout

Type

integer

Default

60

Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.

sslutils

These options apply to services using the SSL utilities module.

ssl

ca_file

Type

string

Default

<None>

CA certificate file to use to verify connecting clients.

Deprecated Variations

Group	Name
DEFAULT	ssl_ca_file

cert_file

Type

string

Default

<None>

Certificate file to use when starting the server securely.

Deprecated Variations

Group	Name
DEFAULT	ssl_cert_file

key_file

Type

string

Default

<None>

Private key file to use when starting the server securely.

Deprecated Variations

Group	Name
DEFAULT	ssl_key_file

version

Type

string

Default

<None>

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.

ciphers

Type

string

Default

<None>

Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.

wsgi

These options apply to services using the WSGI (Web Service Gateway Interface) module.

DEFAULT

api_paste_config

Type

string

Default

api-paste.ini

File name for the paste.deploy config for api service

wsgi_log_format

Type

string

Default

%(client_ip)s "%(request_line)s" status: %(status_code)s  len: %(body_length)s time: %(wall_seconds).7f

A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.

tcp_keepidle

Type

integer

Default

600

Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

wsgi_default_pool_size

Type

integer

Default

100

Size of the pool of greenthreads used by wsgi

max_header_line

Type

integer

Default

16384

Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).

wsgi_keep_alive

Type

boolean

Default

True

If False, closes the client socket connection explicitly.

client_socket_timeout

Type

integer

Default

900

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.

wsgi_server_debug

Type

boolean

Default

False

True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.