senlin uses oslo.config to define and manage configuration options to allow the deployer to control many aspects of the service API and the service engine.
cloud_backend
¶Type: | string |
---|---|
Default: | openstack |
Valid Values: | openstack, openstack_test |
Default cloud backend to use.
host
¶Type: | host address |
---|---|
Default: | ubuntu-xenial-vexxhost-sjc1-0004962296 |
Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN or IP address.
periodic_interval
¶Type: | integer |
---|---|
Default: | 60 |
Seconds between running periodic tasks.
periodic_interval_max
¶Type: | integer |
---|---|
Default: | 120 |
Maximum seconds between periodic tasks to be called.
check_interval_max
¶Type: | integer |
---|---|
Default: | 3600 |
Maximum seconds between cluster check to be called.
periodic_fuzzy_delay
¶Type: | integer |
---|---|
Default: | 10 |
Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)
num_engine_workers
¶Type: | integer |
---|---|
Default: | 1 |
Number of senlin-engine processes to fork and run.
environment_dir
¶Type: | string |
---|---|
Default: | /etc/senlin/environments |
The directory to search for environment files.
max_nodes_per_cluster
¶Type: | integer |
---|---|
Default: | 1000 |
Maximum nodes allowed per top-level cluster.
max_clusters_per_project
¶Type: | integer |
---|---|
Default: | 100 |
Maximum number of clusters any one project may have active at one time.
default_action_timeout
¶Type: | integer |
---|---|
Default: | 3600 |
Timeout in seconds for actions.
max_actions_per_batch
¶Type: | integer |
---|---|
Default: | 0 |
Maximum number of node actions that each engine worker can schedule consecutively per batch. 0 means no limit.
batch_interval
¶Type: | integer |
---|---|
Default: | 3 |
Seconds to pause between scheduling two consecutive batches of node actions.
lock_retry_times
¶Type: | integer |
---|---|
Default: | 3 |
Number of times trying to grab a lock.
lock_retry_interval
¶Type: | integer |
---|---|
Default: | 10 |
Number of seconds between lock retries.
engine_life_check_timeout
¶Type: | integer |
---|---|
Default: | 2 |
RPC timeout for the engine liveness check that is used for cluster locking.
name_unique
¶Type: | boolean |
---|---|
Default: | false |
Flag to indicate whether to enforce unique names for Senlin objects belonging to the same project.
service_down_time
¶Type: | integer |
---|---|
Default: | 60 |
Maximum time since last check-in for a service to be considered up.
default_region_name
¶Type: | string |
---|---|
Default: | <None> |
Default region name used to get services endpoints.
max_response_size
¶Type: | integer |
---|---|
Default: | 524288 |
Maximum raw byte size of data from web response.
event_dispatchers
¶Type: | multi-valued |
---|---|
Default: | database |
Event dispatchers to enable.
auth_url
¶Type: | string |
---|---|
Default: | u'' |
Complete public identity V3 API endpoint.
service_username
¶Type: | string |
---|---|
Default: | senlin |
Senlin service user name.
service_password
¶Type: | string |
---|---|
Default: | u'' |
Password specified for the Senlin service user.
service_project_name
¶Type: | string |
---|---|
Default: | service |
Name of the service project.
service_user_domain
¶Type: | string |
---|---|
Default: | Default |
Name of the domain for the service user.
service_project_domain
¶Type: | string |
---|---|
Default: | Default |
Name of the domain for the service project.
priority
¶Type: | string |
---|---|
Default: | info |
Valid Values: | critical, error, warning, info, debug |
Lowest event priorities to be dispatched.
exclude_derived_actions
¶Type: | boolean |
---|---|
Default: | true |
Exclude derived actions from events dumping.
nova_control_exchange
¶Type: | string |
---|---|
Default: | nova |
Exchange name for nova notifications.
heat_control_exchange
¶Type: | string |
---|---|
Default: | heat |
Exchange name for heat notifications.
enabled_endpoints
¶Type: | multi-valued |
---|---|
Default: | nova |
Default: | heat |
Notification endpoints to enable.
enabled
¶Type: | boolean |
---|---|
Default: | false |
Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature).
Possible values:
operations. If the profiling is triggered by another project, this project part will be empty.
Group | Name |
---|---|
profiler | profiler_enabled |
trace_sqlalchemy
¶Type: | boolean |
---|---|
Default: | false |
Enables SQL requests profiling in services. Default value is False (SQL requests won’t be traced).
Possible values:
trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way.
hmac_keys
¶Type: | string |
---|---|
Default: | SECRET_KEY |
Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: <key1>[,<key2>,…<keyn>], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project.
Both “enabled” flag and “hmac_keys” config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources.
connection_string
¶Type: | string |
---|---|
Default: | messaging:// |
Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging.
Examples of possible values:
notifications.
es_doc_type
¶Type: | string |
---|---|
Default: | notification |
Document type for notification indexing in elasticsearch.
es_scroll_time
¶Type: | string |
---|---|
Default: | 2m |
This parameter is a time value parameter (for example: es_scroll_time=2m), indicating for how long the nodes that participate in the search will maintain relevant resources in order to continue and support it.
es_scroll_size
¶Type: | integer |
---|---|
Default: | 10000 |
Elasticsearch splits large requests in batches. This parameter defines maximum size of each batch (for example: es_scroll_size=10000).
socket_timeout
¶Type: | floating point |
---|---|
Default: | 0.1 |
Redissentinel provides a timeout option on the connections. This parameter defines that timeout (for example: socket_timeout=0.1).
sentinel_service_name
¶Type: | string |
---|---|
Default: | mymaster |
Redissentinel uses a service name to identify a master redis service. This parameter defines the name (for example: sentinal_service_name=mymaster).
host
¶Type: | string |
---|---|
Default: | <None> |
The address for notifying and triggering receivers. It is useful for case Senlin API service is running behind a proxy.
Group | Name |
---|---|
webhook | host |
port
¶Type: | port number |
---|---|
Default: | 8778 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
The port for notifying and triggering receivers. It is useful for case Senlin API service is running behind a proxy.
Group | Name |
---|---|
webhook | port |
max_message_size
¶Type: | integer |
---|---|
Default: | 65535 |
The max size(bytes) of message can be posted to receiver queue.
senlin_api_revision
¶Type: | string |
---|---|
Default: | 1.0 |
Senlin API revision.
senlin_engine_revision
¶Type: | string |
---|---|
Default: | 1.0 |
Senlin engine revision.
bind_host
¶Type: | ip address |
---|---|
Default: | 0.0.0.0 |
Address to bind the server. Useful when selecting a particular network interface.
bind_port
¶Type: | port number |
---|---|
Default: | 8778 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
The port on which the server will listen.
backlog
¶Type: | integer |
---|---|
Default: | 4096 |
Number of backlog requests to configure the socket with.
cert_file
¶Type: | string |
---|---|
Default: | <None> |
Location of the SSL certificate file to use for SSL mode.
key_file
¶Type: | string |
---|---|
Default: | <None> |
Location of the SSL key file to use for enabling SSL mode.
workers
¶Type: | integer |
---|---|
Default: | 0 |
Minimum Value: | 0 |
Number of workers for Senlin service.
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 by the Keystone v3 API with big service catalogs).
tcp_keepidle
¶Type: | integer |
---|---|
Default: | 600 |
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.
api_paste_config
¶Type: | string |
---|---|
Default: | api-paste.ini |
The API paste config file to use.
Group | Name |
---|---|
paste_deploy | api_paste_config |
wsgi_keep_alive
¶Type: | boolean |
---|---|
Default: | true |
If false, closes the client socket explicitly.
Group | Name |
---|---|
eventlet_opts | wsgi_keep_alive |
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’ indicates waiting forever.
Group | Name |
---|---|
eventlet_opts | client_socket_timeout |
max_json_body_size
¶Type: | integer |
---|---|
Default: | 1048576 |
Maximum raw byte size of JSON request body.
Group | Name |
---|---|
DEFAULT | max_json_body_size |
auth_type
¶Type: | unknown type |
---|---|
Default: | <None> |
Authentication type to load
Group | Name |
---|---|
zaqar | auth_plugin |
auth_section
¶Type: | unknown type |
---|---|
Default: | <None> |
Config Section from which to load plugin specific options
auth_url
¶Type: | unknown type |
---|---|
Default: | <None> |
Authentication URL
system_scope
¶Type: | unknown type |
---|---|
Default: | <None> |
Scope for system operations
domain_id
¶Type: | unknown type |
---|---|
Default: | <None> |
Domain ID to scope to
domain_name
¶Type: | unknown type |
---|---|
Default: | <None> |
Domain name to scope to
project_id
¶Type: | unknown type |
---|---|
Default: | <None> |
Project ID to scope to
Group | Name |
---|---|
zaqar | tenant-id |
zaqar | tenant_id |
project_name
¶Type: | unknown type |
---|---|
Default: | <None> |
Project name to scope to
Group | Name |
---|---|
zaqar | tenant-name |
zaqar | tenant_name |
project_domain_id
¶Type: | unknown type |
---|---|
Default: | <None> |
Domain ID containing project
project_domain_name
¶Type: | unknown type |
---|---|
Default: | <None> |
Domain name containing project
trust_id
¶Type: | unknown type |
---|---|
Default: | <None> |
Trust ID
default_domain_id
¶Type: | unknown type |
---|---|
Default: | <None> |
Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
default_domain_name
¶Type: | unknown type |
---|---|
Default: | <None> |
Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
user_id
¶Type: | unknown type |
---|---|
Default: | <None> |
User id
user_domain_id
¶Type: | unknown type |
---|---|
Default: | <None> |
User’s domain id
user_domain_name
¶Type: | unknown type |
---|---|
Default: | <None> |
User’s domain name
password
¶Type: | unknown type |
---|---|
Default: | <None> |
User’s password
senlin.common.config.
list_opts
()¶Return a list of oslo.config options available.
The purpose of this function is to allow tools like the Oslo sample config file generator to discover the options exposed to users by this service. The returned list includes all oslo.config options which may be registered at runtime by the service api/engine.
Each element of the list is a tuple. The first element is the name of the group under which the list of elements in the second element will be registered. A group name of None corresponds to the [DEFAULT] group in config files.
This function is also discoverable via the ‘senlin.config’ entry point under the ‘oslo.config.opts’ namespace.
Returns: | a list of (group_name, opts) tuples |
---|
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.