Puppet Class: st2::params

Inherited by:

st2
st2::profile::selinux

Defined in:

manifests/params.pp

Summary

Main parameters to manage the st2 module

Overview

Examples:

Best Practice

class { 'st2::params':
  admin_username => 'myuser',
  admin_password => 'SuperSecret!',
}
include st2::profile::fullinstall

Parameters:

• packs_group_name (Any) (defaults to: 'st2packs') —

  The name of the group created to hold the st2 admin user

• hostname (Any) (defaults to: '127.0.0.1') —

  Hostname of the StackStorm box. This is used as the default to drive a lot of other parameters in the st2 class such as auth URL, MongoDB host, RabbitMQ host, etc.

• admin_username (Any) (defaults to: 'st2admin') —

  Username of the StackStorm admin user. Best practice is to change this to a unique username.

• admin_password (Any) (defaults to: 'Ch@ngeMe') —

  Password of the StackStorm admin user. Best practice is to change this to a unique password.

# File 'manifests/params.pp', line 20

class st2::params(
  $packs_group_name = 'st2packs',
  $hostname         = '127.0.0.1',
  ## StackStorm default credentials (change these!)
  $admin_username   = 'st2admin',
  $admin_password   = 'Ch@ngeMe',
) {

  # SSL settings
  $use_ssl  = false
  $ssl_dir  = '/etc/ssl/st2'
  $ssl_cert = '/etc/ssl/st2/st2.crt'
  $ssl_key  = '/etc/ssl/st2/st2.key'

  # Auth settings
  $auth_mode = standalone
  $auth_backend = flat_file
  $auth_htpasswd_file = '/etc/st2/htpasswd'
  $auth_backend_config = {
    htpasswd_file => $auth_htpasswd_file,
  }
  $auth_port = 9100

  # API settings
  $api_port = 9101

  # stream settings
  $stream_port = 9102

  # nginx basic status port
  $basicstatus_port = 9103
  $basicstatus_enabled = false

  # Non-user configurable parameters
  $repository = 'stable'
  $conf_dir = '/etc/st2'
  $datstore_keys_dir = "${conf_dir}/keys"

  $st2_server_packages = [
    'st2',
  ]
  $st2_chatops_packages = [
    'st2chatops',
  ]
  $st2_web_packages = [
    'st2web',
  ]
  case $facts['os']['family'] {
    'Debian': {
      $st2_client_packages = [
        'python-st2client',
      ]
      $package_type = 'deb'
    }
    'RedHat': {
      $st2_client_packages = [
        'st2client',
      ]
      $package_type = 'rpm'
    }
    default: {
      $st2_client_packages = [
        'python-st2client',
      ]
      $package_type = 'deb'
    }
  }

  ## StackStorm core services
  $st2_services = [
    'st2actionrunner',
    'st2api',
    'st2auth',
    'st2garbagecollector',
    'st2sensorcontainer',
    'st2stream',
  ]

  ## StackStorm Workflow Engine (Orchestra)
  $rulesengine_services = [
    'st2rulesengine',
  ]

  ## StackStorm Workflow Engine (Orchestra)
  $notifier_services = [
    'st2notifier',
  ]

  ## StackStorm ChatOps services
  $st2_chatops_services = [
    'st2chatops',
  ]

  ## StackStorm Workflow Engine (Orchestra)
  $workflowengine_services = [
    'st2workflowengine',
  ]

  ## StackStorm Timers Engine
  $timersengine_services = [
    'st2timersengine',
  ]
  $timersengine_enabled = true
  $timersengine_timezone = 'America/Los_Angeles'

  ## StackStorm Scheduler
  $scheduler_services = [
    'st2scheduler',
  ]
  $scheduler_sleep_interval = 0.1
  $scheduler_gc_interval = 10
  $scheduler_pool_size = 10

  ## nginx
  $nginx_ssl_port = 443
  $nginx_ssl_protocols = [
    'TLSv1.2',
    'TLSv1.3',
  ]
  $nginx_ssl_ciphers = [
    # TLSv1.3
    'TLS_AES_128_GCM_SHA256',
    'TLS_AES_256_GCM_SHA384',
    'TLS_CHACHA20_POLY1305_SHA256',
    # TLSv1.2
    'ECDHE-ECDSA-AES128-GCM-SHA256',
    'ECDHE-ECDSA-AES128-SHA256',
    'ECDHE-ECDSA-AES256-GCM-SHA384',
    'ECDHE-ECDSA-AES256-SHA384',
    'ECDHE-ECDSA-CHACHA20-POLY1305',
    'ECDHE-RSA-AES128-GCM-SHA256',
    'ECDHE-RSA-AES128-SHA256',
    'ECDHE-RSA-AES256-GCM-SHA384',
    'ECDHE-RSA-AES256-SHA384',
    'ECDHE-RSA-CHACHA20-POLY1305',
  ]
  # no max on the body size for large workflow support
  $nginx_client_max_body_size = '0'

  # Number of workflow engines to run
  $workflowengine_num = 1

  # Number of schedulers to run
  $scheduler_num = 1

  # Number of rules engines to run
  $rulesengine_num = 1

  # Number of notifiers to run
  $notifier_num = 1

  # Should the output schema of actions and workflows be validated
  $validate_output_schema = false

  # st2web
  $web_root = '/opt/stackstorm/static/webui/'

  ## MongoDB Data
  $mongodb_admin_username = 'admin'

  $mongodb_port = 27017
  $mongodb_bind_ips = ['127.0.0.1']

  $mongodb_st2_db = 'st2'
  $mongodb_st2_username = 'stackstorm'
  $mongodb_st2_roles = ['readWrite']

  ## RabbitMQ
  $rabbitmq_username = $admin_username
  $rabbitmq_password = $admin_password
  $rabbitmq_hostname = '127.0.0.1'
  $rabbitmq_port = 5672
  $rabbitmq_bind_ip = '127.0.0.1'
  $rabbitmq_vhost = '/'
  $osname = downcase($facts['os']['name'])
  $rabbitmq_signing_key = 'https://github.com/rabbitmq/signing-keys/releases/download/2.0/rabbitmq-release-signing-key.asc'
  $rabbitmq_key = 'https://packagecloud.io/rabbitmq/rabbitmq-server/gpgkey'
  $erlang_url = $facts['os']['family'] ? {
    'Debian' => "http://ppa.launchpad.net/rabbitmq/rabbitmq-erlang/${osname}",
    'RedHat' => "https://packagecloud.io/rabbitmq/erlang/el/${facts['os'][release][major]}/\$basearch",
  }
  $erlang_key = 'https://packagecloud.io/rabbitmq/erlang/gpgkey'
  $erlang_key_id = 'B279943D2A549531E144B875F77F1EDA57EBB1CC'
  $erlang_key_source = 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xf77f1eda57ebb1cc'
  $erlang_rhel_sslcacert_location = '/etc/pki/tls/certs/ca-bundle.crt'
  $erlang_rhel_sslverify = 1
  $erlang_rhel_gpgcheck = 0
  $erlang_rhel_repo_gpgcheck = 1
  $erlang_packages = [
    'erlang',
  ]

  ## Redis
  $redis_bind_ip = '127.0.0.1'
  $redis_hostname = '127.0.0.1'
  $redis_port = 6379
  $redis_password = ''


  ## actionrunner config
  $actionrunner_workers = 10
  $actionrunner_global_env_file = $facts['os']['family'] ? {
    'Debian' => '/etc/default/st2actionrunner',
    'RedHat' => '/etc/sysconfig/st2actionrunner',
  }

  ## chatops default config
  $st2_chatops_dir  = '/opt/stackstorm/chatops'
  $st2_chatops_global_env_file = $facts['os']['family'] ? {
    'Debian' => '/etc/default/st2chatops',
    'RedHat' => '/etc/sysconfig/st2chatops',
  }

  $hubot_log_level = 'debug'
  $hubot_express_port = '8081'
  $tls_cert_reject_unauthorized = '0'
  $hubot_name = '"hubot"'
  $hubot_alias = "'!'"
  $chatops_adapter = {}
  $chatops_adapter_conf = {
    'HUBOT_ADAPTER' => 'slack',
  }

  $metrics_include = false
  $metric_driver = 'statsd'
  $metric_host = '127.0.0.1'
  $metric_port = '8125'
}