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.
host
¶host address
bullseye-zed.debian.net
Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN or IP address.
default_region_name
¶string
<None>
Default region name used to get services endpoints.
max_response_size
¶integer
524288
Maximum raw byte size of data from web response.
notification_topics
¶list
['versioned_notifications']
Default notification topic.
periodic_interval
¶integer
60
Seconds between running periodic tasks.
check_interval_max
¶integer
3600
Maximum seconds between cluster check to be called.
health_check_interval_min
¶integer
60
Minimum seconds between health check to be called.
environment_dir
¶string
/etc/senlin/environments
The directory to search for environment files.
max_nodes_per_cluster
¶integer
1000
Maximum nodes allowed per top-level cluster.
max_clusters_per_project
¶integer
100
Maximum number of clusters any one project may have active at one time.
default_action_timeout
¶integer
3600
Timeout in seconds for actions.
default_nova_timeout
¶integer
600
Timeout in seconds for nova API calls.
max_actions_per_batch
¶integer
0
Maximum number of node actions that each engine worker can schedule consecutively per batch. 0 means no limit.
batch_interval
¶integer
3
Seconds to pause between scheduling two consecutive batches of node actions.
lock_retry_times
¶integer
3
Number of times trying to grab a lock.
lock_retry_interval
¶integer
10
Number of seconds between lock retries.
database_retry_limit
¶integer
10
Number of times retrying a failed operation on the database.
database_retry_interval
¶integer
0.3
Initial number of seconds between database retries.
database_max_retry_interval
¶integer
2
Maximum number of seconds between database retries.
engine_life_check_timeout
¶integer
2
RPC timeout for the engine liveness check that is used for cluster locking.
name_unique
¶boolean
False
Flag to indicate whether to enforce unique names for Senlin objects belonging to the same project.
service_down_time
¶integer
60
Maximum time since last check-in for a service to be considered up.
trust_roles
¶list
[]
The roles which are delegated to the trustee by the trustor when a cluster is created.
cloud_backend
¶string
openstack
openstack, openstack_test
Default cloud backend to use.
event_dispatchers
¶multi-valued
database
Event dispatchers to enable.
auth_url
¶string
''
Complete identity V3 API endpoint.
service_username
¶string
senlin
Senlin service user name.
service_password
¶string
''
Password specified for the Senlin service user.
service_project_name
¶string
service
Name of the service project.
service_user_domain
¶string
Default
Name of the domain for the service user.
service_project_domain
¶string
Default
Name of the domain for the service project.
verify_ssl
¶boolean
True
Verify HTTPS connections.
interface
¶string
public
Interface to use for the API endpoints.
workers
¶integer
1
Number of senlin-conductor processes.
threads
¶integer
1000
Number of senlin-conductor threads.
priority
¶string
info
critical, error, warning, info, debug
Lowest event priorities to be dispatched.
exclude_derived_actions
¶boolean
True
Exclude derived actions from events dumping.
workers
¶integer
1
Number of senlin-engine processes.
Group |
Name |
---|---|
DEFAULT |
num_engine_workers |
threads
¶integer
1000
Number of senlin-engine threads.
Group |
Name |
---|---|
DEFAULT |
scheduler_thread_pool_size |
nova_control_exchange
¶string
nova
Exchange name for nova notifications.
nova_notification_topic
¶string
versioned_notifications
Topic name for nova notifications.
heat_control_exchange
¶string
heat
Exchange name for heat notifications.
heat_notification_topic
¶string
notifications
Topic name for heat notifications.
enabled_endpoints
¶multi-valued
nova
heat
Notification endpoints to enable.
workers
¶integer
1
Number of senlin-health-manager processes.
threads
¶integer
1000
Number of senlin-health-manager threads.
Group |
Name |
---|---|
DEFAULT |
health_manager_thread_pool_size |
max_message_size
¶integer
65535
The max size(bytes) of message can be posted to notification queue.
ttl
¶integer
300
The ttl in seconds of a message posted to notification queue.
host
¶string
<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
¶port number
8777
0
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
¶integer
65535
The max size(bytes) of message can be posted to receiver queue.
senlin_api_revision
¶string
1.0
Senlin API revision.
senlin_engine_revision
¶string
1.0
Senlin engine revision.
bind_host
¶ip address
0.0.0.0
Address to bind the server. Useful when selecting a particular network interface.
bind_port
¶port number
8777
0
65535
The port on which the server will listen.
backlog
¶integer
4096
Number of backlog requests to configure the socket with.
cert_file
¶string
<None>
Location of the SSL certificate file to use for SSL mode.
key_file
¶string
<None>
Location of the SSL key file to use for enabling SSL mode.
workers
¶integer
0
0
Number of workers for Senlin service.
max_header_line
¶integer
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
¶integer
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
¶string
api-paste.ini
The API paste config file to use.
Group |
Name |
---|---|
paste_deploy |
api_paste_config |
wsgi_keep_alive
¶boolean
True
If false, closes the client socket explicitly.
Group |
Name |
---|---|
eventlet_opts |
wsgi_keep_alive |
client_socket_timeout
¶integer
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
¶integer
1048576
Maximum raw byte size of JSON request body.
Group |
Name |
---|---|
DEFAULT |
max_json_body_size |
auth_type
¶unknown type
<None>
Authentication type to load
Group |
Name |
---|---|
zaqar |
auth_plugin |
auth_section
¶unknown type
<None>
Config Section from which to load plugin specific options
auth_url
¶unknown type
<None>
Authentication URL
system_scope
¶unknown type
<None>
Scope for system operations
domain_id
¶unknown type
<None>
Domain ID to scope to
domain_name
¶unknown type
<None>
Domain name to scope to
project_id
¶unknown type
<None>
Project ID to scope to
Group |
Name |
---|---|
zaqar |
tenant-id |
zaqar |
tenant_id |
project_name
¶unknown type
<None>
Project name to scope to
Group |
Name |
---|---|
zaqar |
tenant-name |
zaqar |
tenant_name |
project_domain_id
¶unknown type
<None>
Domain ID containing project
project_domain_name
¶unknown type
<None>
Domain name containing project
trust_id
¶unknown type
<None>
ID of the trust to use as a trustee use
default_domain_id
¶unknown type
<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
¶unknown type
<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
¶unknown type
<None>
User id
username
¶unknown type
<None>
Username
Group |
Name |
---|---|
zaqar |
user-name |
zaqar |
user_name |
user_domain_id
¶unknown type
<None>
User’s domain id
user_domain_name
¶unknown type
<None>
User’s domain name
password
¶unknown type
<None>
User’s password
senlin.conf.opts.
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.
This function is also discoverable via the ‘senlin.conf’ entry point under the ‘oslo.config.opts’ namespace.
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.