Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
349 lines (314 sloc) 13.5 KB
# Sample config which contains all the available options which the corresponding descriptions
# Note: This file is automatically generated using tools/config_gen.py - DO NOT UPDATE MANUALLY
[action_sensor]
# Whether to enable or disable the ability to post a trigger on action.
enable = True
# List of execution statuses for which a trigger will be emitted.
emit_when = succeeded,failed,timeout,canceled,abandoned # comma separated list allowed here.
[actionrunner]
# Internal pool size for dispatcher used by regular actions.
actions_pool_size = 60
# Default log level to use for Python runner actions. Can be overriden on invocation basis using "log_level" runner parameter.
python_runner_log_level = DEBUG
# Internal pool size for dispatcher used by workflow actions.
workflows_pool_size = 40
# Virtualenv binary which should be used to create pack virtualenvs.
virtualenv_binary = /usr/bin/virtualenv
# Python 3 binary which will be used by Python actions for packs which use Python 3 virtual environment
python3_binary = /usr/bin/python3
# location of the logging.conf file
logging = /etc/st2/logging.actionrunner.conf
# True to store and stream action output (stdout and stderr) in real-time.
stream_output = True
# List of virtualenv options to be passsed to "virtualenv" command that creates pack virtualenv.
virtualenv_opts = --system-site-packages # comma separated list allowed here.
# Python binary which will be used by Python actions.
python_binary = /usr/bin/python
[api]
# List of origins allowed for api, auth and stream
allow_origin = http://127.0.0.1:3000 # comma separated list allowed here.
# location of the logging.conf file
logging = /etc/st2/logging.api.conf
# Maximum limit (page size) argument which can be specified by the user in a query string.
max_page_size = 100
# True to mask secrets in the API responses
mask_secrets = True
# StackStorm API server host
host = 127.0.0.1
# None
debug = False
# StackStorm API server port
port = 9101
[auth]
# Common option - options below apply in both scenarios - when auth service is running as a WSGI
# service (e.g. under Apache or Nginx) and when it's running in the standalone mode.
# Enable authentication middleware.
enable = True
# Path to the logging config.
logging = /etc/st2/logging.auth.conf
# Base URL to the API endpoint excluding the version
api_url = None
# Service token ttl in seconds.
service_token_ttl = 86400
# Access token ttl in seconds.
token_ttl = 86400
# Authentication mode (proxy,standalone)
mode = standalone
# Specify to enable debug mode.
debug = False
# Standalone mode options - options below only apply when auth service is running in the standalone
# mode.
# Path to the SSL certificate file. Only used when "use_ssl" is specified.
cert = /etc/apache2/ssl/mycert.crt
# JSON serialized arguments which are passed to the authentication backend in a standalone mode.
backend_kwargs = None
# Host on which the service should listen on.
host = 127.0.0.1
# Path to the SSL private key file. Only used when "use_ssl" is specified.
key = /etc/apache2/ssl/mycert.key
# Specify to enable SSL / TLS mode
use_ssl = False
# Port on which the service should listen on.
port = 9100
# Authentication backend to use in a standalone mode. Available backends: flat_file.
backend = flat_file
[content]
# A URL pointing to the pack index. StackStorm Exchange is used by default. Use a comma-separated list for multiple indexes if you want to get other packs discovered with "st2 pack search".
index_url = https://index.stackstorm.org/v1/index.json # comma separated list allowed here.
# Path to the directory which contains system runners. NOTE: This option has been deprecated and it's unused since StackStorm v3.0.0
system_runners_base_path = /opt/stackstorm/runners
# Paths which will be searched for runners. NOTE: This option has been deprecated and it's unused since StackStorm v3.0.0
runners_base_paths = None
# User group that can write to packs directory.
pack_group = st2packs
# Path to the directory which contains system packs.
system_packs_base_path = /opt/stackstorm/packs
# Paths which will be searched for integration packs.
packs_base_paths = None
[coordination]
# Endpoint for the coordination server.
url = None
# TTL for the lock if backend suports it.
lock_timeout = 60
[database]
# username for db login
username = None
# Connection retry total time (minutes).
connection_retry_max_delay_m = 3
# ca_certs file contains a set of concatenated CA certificates, which are used to validate certificates passed from MongoDB.
ssl_ca_certs = None
# Certificate file used to identify the localconnection
ssl_certfile = None
# Connection retry backoff max (seconds).
connection_retry_backoff_max_s = 10
# Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided
ssl_cert_reqs = None
# Create the connection to mongodb using SSL
ssl = False
# host of db server
host = 127.0.0.1
# name of database
db_name = st2
# Backoff multiplier (seconds).
connection_retry_backoff_mul = 1
# Specifies database authentication mechanisms. By default, it use SCRAM-SHA-1 with MongoDB 3.0 and later, MONGODB-CR (MongoDB Challenge Response protocol) for older servers.
authentication_mechanism = None
# Private keyfile used to identify the local connection against MongoDB.
ssl_keyfile = None
# If True and `ssl_cert_reqs` is not None, enables hostname verification
ssl_match_hostname = True
# password for db login
password = None
# port of db server
port = 27017
[exporter]
# location of the logging.exporter.conf file
logging = /etc/st2/logging.exporter.conf
# Directory to dump data to.
dump_dir = /opt/stackstorm/exports/
[garbagecollector]
# Action executions and related objects (live actions, action output objects) older than this value (days) will be automatically deleted.
action_executions_ttl = None
# Trigger instances older than this value (days) will be automatically deleted.
trigger_instances_ttl = None
# Location of the logging configuration file.
logging = /etc/st2/logging.garbagecollector.conf
# How long to wait / sleep (in seconds) between collection of different object types.
sleep_delay = 2
# Set to True to perform garbage collection on Inquiries (based on the TTL value per Inquiry)
purge_inquiries = False
# Action execution output objects (ones generated by action output streaming) older than this value (days) will be automatically deleted.
action_executions_output_ttl = 7
# How often to check database for old data and perform garbage collection.
collection_interval = 600
[keyvalue]
# Location of the symmetric encryption key for encrypting values in kvstore. This key should be in JSON and should've been generated using st2-generate-symmetric-crypto-key tool.
encryption_key_path =
# Allow encryption of values in key value stored qualified as "secret".
enable_encryption = True
[log]
# Controls if stderr should be redirected to the logs.
redirect_stderr = False
# Exclusion list of loggers to omit.
excludes = # comma separated list allowed here.
# Blacklist of additional attribute names to mask in the log messages.
mask_secrets_blacklist = # comma separated list allowed here.
# True to mask secrets in the log files.
mask_secrets = True
[messaging]
# URL of the messaging server.
url = amqp://guest:guest@127.0.0.1:5672//
# How long should we wait between connection retries.
connection_retry_wait = 10000
# How many times should we retry connection before failing.
connection_retries = 10
# URL of all the nodes in a messaging service cluster.
cluster_urls = # comma separated list allowed here.
[metrics]
# Randomly sample and only send metrics for X% of metric operations to the backend. Default value of 1 means no sampling is done and all the metrics are sent to the backend. E.g. 0.1 would mean 10% of operations are sampled.
sample_rate = 1
# Destination server to connect to if driver requires connection.
host = 127.0.0.1
# Optional prefix which is prepended to all the metric names. Comes handy when you want to submit metrics from various environment to the same metric backend instance.
prefix = None
# Driver type for metrics collection.
driver = noop
# Destination port to connect to if driver requires connection.
port = 8125
[mistral]
# URL Mistral uses to talk back to the API.If not provided it defaults to public API URL. Note: This needs to be a base URL without API version (e.g. http://127.0.0.1:9101)
api_url = None
# Multiplier for the exponential backoff.
retry_exp_msec = 1000
# Jitter interval to smooth out HTTP requests to mistral tasks and executions API.
jitter_interval = 0.1
# Allow insecure communication with Mistral.
insecure = False
# Username for authentication.
keystone_username = None
# Enable results tracking and disable callbacks.
enable_polling = False
# OpenStack project scope.
keystone_project_name = None
# Password for authentication.
keystone_password = None
# Auth endpoint for Keystone.
keystone_auth_url = None
# Optional certificate to validate endpoint.
cacert = None
# v2 API root endpoint.
v2_base_url = http://127.0.0.1:8989/v2
# Max time to stop retrying.
retry_stop_max_msec = 600000
# Max time for each set of backoff.
retry_exp_max_msec = 300000
[notifier]
# Location of the logging configuration file.
logging = /etc/st2/logging.notifier.conf
[packs]
# Enable/Disable support for pack common libs. Setting this config to ``True`` would allow you to place common library code for sensors and actions in lib/ folder in packs and use them in python sensors and actions. See https://docs.stackstorm.com/reference/sharing_code_sensors_actions.html for details.
enable_common_libs = False
[resultstracker]
# Time interval between queries to external workflow system.
query_interval = 5
# Sleep delay in between queries when query queue is empty.
empty_q_sleep_time = 1
# Location of the logging configuration file.
logging = /etc/st2/logging.resultstracker.conf
# Sleep delay for query when there is no more worker in pool.
no_workers_sleep_time = 1
# Number of threads to use to query external workflow systems.
thread_pool_size = 10
[rulesengine]
# Location of the logging configuration file.
logging = /etc/st2/logging.rulesengine.conf
[scheduler]
# How long (in seconds) to sleep between each action scheduler main loop run interval.
sleep_interval = 0.1
# How often (in seconds) to look for zombie execution requests before rescheduling them.
gc_interval = 10
# Location of the logging configuration file.
logging = /etc/st2/logging.scheduler.conf
# The size of the pool used by the scheduler for scheduling executions.
pool_size = 10
[schema]
# Version of JSON schema to use.
version = 4
# URL to the JSON schema draft.
draft = http://json-schema.org/draft-04/schema#
[sensorcontainer]
# Provider of sensor node partition config.
partition_provider = {'name': 'default'}
# Run in a single sensor mode where parent process exits when a sensor crashes / dies. This is useful in environments where partitioning, sensor process life cycle and failover is handled by a 3rd party service such as kubernetes.
single_sensor_mode = False
# location of the logging.conf file
logging = /etc/st2/logging.sensorcontainer.conf
# name of the sensor node.
sensor_node_name = sensornode1
[ssh_runner]
# Max number of parallel remote SSH actions that should be run. Works only with Paramiko SSH runner.
max_parallel_actions = 50
# Location of the script on the remote filesystem.
remote_dir = /tmp
# Use the .ssh/config file. Useful to override ports etc.
use_ssh_config = False
# Path to the ssh config file.
ssh_config_file_path = ~/.ssh/config
# How partial success of actions run on multiple nodes should be treated.
allow_partial_failure = False
[stream]
# Specify to enable debug mode.
debug = False
# Send empty message every N seconds to keep connection open
heartbeat = 25
# StackStorm stream API server host
host = 127.0.0.1
# location of the logging.conf file
logging = /etc/st2/logging.stream.conf
# StackStorm API stream, server port
port = 9102
[syslog]
# Host for the syslog server.
host = 127.0.0.1
# Transport protocol to use (udp / tcp).
protocol = udp
# Port for the syslog server.
port = 514
# Syslog facility level.
facility = local7
[system]
# Enable debug mode.
debug = False
# True to validate parameters for non-system trigger types when creatinga rule. By default, only parameters for system triggers are validated.
validate_trigger_parameters = True
# True to validate action and runner output against schema.
validate_output_schema = False
# True to validate payload for non-system trigger types when dispatching a trigger inside the sensor. By default, only payload for system triggers is validated.
validate_trigger_payload = True
# Base path to all st2 artifacts.
base_path = /opt/stackstorm
[system_user]
# SSH private key for the system user.
ssh_key_file = /home/stanley/.ssh/stanley_rsa
# Default system user.
user = stanley
[timer]
# Specify to enable timer service. NOTE: Deprecated in favor of timersengine.enable
enable = None
# Timezone pertaining to the location where st2 is run. NOTE: Deprecated in favor of timersengine.local_timezone
local_timezone = None
# Location of the logging configuration file. NOTE: Deprecated in favor of timersengine.logging
logging = None
[timersengine]
# Specify to enable timer service.
enable = True
# Timezone pertaining to the location where st2 is run.
local_timezone = America/Los_Angeles
# Location of the logging configuration file.
logging = /etc/st2/logging.timersengine.conf
[webui]
# Base https URL to access st2 Web UI. This is used to construct history URLs that are sent out when chatops is used to kick off executions.
webui_base_url = https://localhost
[workflow_engine]
# Location of the logging configuration file.
logging = /etc/st2/logging.workflowengine.conf