Configuration Options

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.

DEFAULT

host
Type:host address
Default:lcy01-amd64-018

Name of the engine node. This can be an opaque identifier. It is not necessarily a hostname, FQDN or IP address.

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.

notification_topics
Type:list
Default:versioned_notifications

Default notification topic.

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.

health_check_interval_min
Type:integer
Default:60

Minimum seconds between health 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)

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.

default_nova_timeout
Type:integer
Default:600

Timeout in seconds for nova API calls.

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.

database_retry_limit
Type:integer
Default:10

Number of times retrying a failed operation on the database.

database_retry_interval
Type:integer
Default:0.3

Initial number of seconds between database retries.

database_max_retry_interval
Type:integer
Default:2

Maximum number of seconds between database 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.

trust_roles
Type:list
Default:''

The roles which are delegated to the trustee by the trustor when a cluster is created.

cloud_backend
Type:string
Default:openstack
Valid Values:openstack, openstack_test

Default cloud backend to use.

event_dispatchers
Type:multi-valued
Default:database

Event dispatchers to enable.

authentication

auth_url
Type:string
Default:''

Complete public identity V3 API endpoint.

service_username
Type:string
Default:senlin

Senlin service user name.

service_password
Type:string
Default:''

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.

conductor

workers
Type:integer
Default:1

Number of senlin-conductor processes.

threads
Type:integer
Default:1000

Number of senlin-conductor threads.

dispatchers

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.

engine

workers
Type:integer
Default:1

Number of senlin-engine processes.

Deprecated Variations
Group Name
DEFAULT num_engine_workers
threads
Type:integer
Default:1000

Number of senlin-engine threads.

Deprecated Variations
Group Name
DEFAULT scheduler_thread_pool_size

health_manager

nova_control_exchange
Type:string
Default:nova

Exchange name for nova notifications.

nova_notification_topic
Type:string
Default:versioned_notifications

Topic name for nova notifications.

heat_control_exchange
Type:string
Default:heat

Exchange name for heat notifications.

heat_notification_topic
Type:string
Default:notifications

Topic name for heat notifications.

enabled_endpoints
Type:multi-valued
Default:nova
Default:heat

Notification endpoints to enable.

workers
Type:integer
Default:1

Number of senlin-health-manager processes.

threads
Type:integer
Default:1000

Number of senlin-health-manager threads.

Deprecated Variations
Group Name
DEFAULT health_manager_thread_pool_size

notification

max_message_size
Type:integer
Default:65535

The max size(bytes) of message can be posted to notification queue.

ttl
Type:integer
Default:300

The ttl in seconds of a message posted to notification queue.

receiver

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.

Deprecated Variations
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.

Deprecated Variations
Group Name
webhook port
max_message_size
Type:integer
Default:65535

The max size(bytes) of message can be posted to receiver queue.

revision

senlin_api_revision
Type:string
Default:1.0

Senlin API revision.

senlin_engine_revision
Type:string
Default:1.0

Senlin engine revision.

senlin_api

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.

Deprecated Variations
Group Name
paste_deploy api_paste_config
wsgi_keep_alive
Type:boolean
Default:true

If false, closes the client socket explicitly.

Deprecated Variations
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.

Deprecated Variations
Group Name
eventlet_opts client_socket_timeout
max_json_body_size
Type:integer
Default:1048576

Maximum raw byte size of JSON request body.

Deprecated Variations
Group Name
DEFAULT max_json_body_size

zaqar

auth_type
Type:unknown type
Default:<None>

Authentication type to load

Deprecated Variations
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

Deprecated Variations
Group Name
zaqar tenant-id
zaqar tenant_id
project_name
Type:unknown type
Default:<None>

Project name to scope to

Deprecated Variations
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

username
Type:unknown type
Default:<None>

Username

Deprecated Variations
Group Name
zaqar user-name
zaqar user_name
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

Options

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.

Returns:a list of (group_name, opts) tuples