Defined Type: oslo::db

Defined in:
manifests/db.pp

Overview

Define: oslo::db

Configure oslo_db options

This resource configures Oslo database configs for an OpenStack service. It will manage the [database] section in the given config resource.

Parameters:

config

(Optional) The resource type used to apply configuration parameters. Defaults to $name

config_group

(Optional) The configuration group to set the database configuration in. Some OpenStack services might implement the oslo database options in another configuration group, this makes it available to set which one to use. Defaults to ‘database’

sqlite_synchronous

(Optional) If True, SQLite uses synchronous mode (boolean value). Defaults to $facts

backend

(Optional) The back end to use for the database. Defaults to $facts

manage_backend_package

(Optional) Whether to install the backend package. Defaults to true.

backend_package_ensure

(Optional) Desired ensure state of the backend database package, accepts latest or specific versions. Defaults to present.

connection

(Optional) The SQLAlchemy connection string to use to connect to the database. Defaults to $facts

slave_connection

(Optional) The SQLAlchemy connection string to use to connect to the slave database. Defaults to $facts

mysql_sql_mode

(Optional) The SQL mode to be used for MySQL sessions. Defaults to $facts

connection_recycle_time

(Optional) Timeout before idle SQL connections are reaped. Defaults to $facts

max_pool_size

(Optional) Maximum number of SQL connections to keep open in a pool. Defaults to $facts

max_retries

(Optional) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. Defaults to $facts

retry_interval

(Optional) Interval between retries of opening a SQL connection. Defaults to $facts

max_overflow

(Optional) If set, use this value for max_overflow with SQLALchemy. Defaults to $facts

connection_debug

(Optional) Verbosity of SQL debugging information: 0=None, 100=Everything. Defaults to $facts

connection_trace

(Optional) Add Python stack traces to SQL as comment strings (boolean value). Defaults to $facts

pool_timeout

(Optional) If set, use this value for pool_timeout with SQLAlchemy. Defaults to $facts

use_db_reconnect

(Optional) Enable the experimental use of database reconnect on connection lost (boolean value) Defaults to $facts

db_retry_interval

(Optional) Seconds between retries of a database transaction. Defaults to $facts

db_inc_retry_interval

(Optional) If True, increases the interval between retries of a database operation up to db_max_retry_interval. Defaults to $facts

db_max_retry_interval

(Optional) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. Defaults to $facts

db_max_retries

(Optional) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. Defaults to $facts

mysql_enable_ndb

(Optional) If True, transparently enables support for handling MySQL Cluster (NDB). Defaults to $facts

manage_config

(Optional) Whether to manage the configuration parameters. Defaults to true.

Parameters:

  • config (Any) (defaults to: $name)
  • config_group (String[1]) (defaults to: 'database')
  • sqlite_synchronous (Any) (defaults to: $facts['os_service_default'])
  • backend (Any) (defaults to: $facts['os_service_default'])
  • manage_backend_package (Boolean) (defaults to: true)
  • backend_package_ensure (Any) (defaults to: present)
  • connection (Oslo::Dbconn) (defaults to: $facts['os_service_default'])
  • slave_connection (Oslo::Dbconn) (defaults to: $facts['os_service_default'])
  • mysql_sql_mode (Any) (defaults to: $facts['os_service_default'])
  • connection_recycle_time (Any) (defaults to: $facts['os_service_default'])
  • max_pool_size (Any) (defaults to: $facts['os_service_default'])
  • max_retries (Any) (defaults to: $facts['os_service_default'])
  • retry_interval (Any) (defaults to: $facts['os_service_default'])
  • max_overflow (Any) (defaults to: $facts['os_service_default'])
  • connection_debug (Any) (defaults to: $facts['os_service_default'])
  • connection_trace (Any) (defaults to: $facts['os_service_default'])
  • pool_timeout (Any) (defaults to: $facts['os_service_default'])
  • use_db_reconnect (Any) (defaults to: $facts['os_service_default'])
  • db_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • db_inc_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • db_max_retry_interval (Any) (defaults to: $facts['os_service_default'])
  • db_max_retries (Any) (defaults to: $facts['os_service_default'])
  • mysql_enable_ndb (Any) (defaults to: $facts['os_service_default'])
  • manage_config (Boolean) (defaults to: true) 


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'manifests/db.pp', line 114

define oslo::db(
  $config                         = $name,
  String[1] $config_group         = 'database',
  $sqlite_synchronous             = $facts['os_service_default'],
  $backend                        = $facts['os_service_default'],
  Boolean $manage_backend_package = true,
  $backend_package_ensure         = present,
  Oslo::Dbconn $connection        = $facts['os_service_default'],
  Oslo::Dbconn $slave_connection  = $facts['os_service_default'],
  $mysql_sql_mode                 = $facts['os_service_default'],
  $connection_recycle_time        = $facts['os_service_default'],
  $max_pool_size                  = $facts['os_service_default'],
  $max_retries                    = $facts['os_service_default'],
  $retry_interval                 = $facts['os_service_default'],
  $max_overflow                   = $facts['os_service_default'],
  $connection_debug               = $facts['os_service_default'],
  $connection_trace               = $facts['os_service_default'],
  $pool_timeout                   = $facts['os_service_default'],
  $use_db_reconnect               = $facts['os_service_default'],
  $db_retry_interval              = $facts['os_service_default'],
  $db_inc_retry_interval          = $facts['os_service_default'],
  $db_max_retry_interval          = $facts['os_service_default'],
  $db_max_retries                 = $facts['os_service_default'],
  $mysql_enable_ndb               = $facts['os_service_default'],
  Boolean $manage_config          = true,
) {

  include oslo::params

  if $manage_backend_package {
    case $connection {
      Oslo::Dbconn::Mysql: {
        require 'mysql::bindings'
        require 'mysql::bindings::python'
        if $connection =~ /^mysql\+pymysql/ {
          $backend_package = $::oslo::params::pymysql_package_name
        } else {
          $backend_package = undef
        }
      }
      Oslo::Dbconn::Postgres: {
        $backend_package = undef
        require 'postgresql::lib::python'
      }
      Oslo::Dbconn::Sqlite: {
        $backend_package = undef
      }
      default: {
        $backend_package = undef
      }
    }

    if $backend_package {
      ensure_packages($backend_package, {
        ensure => $backend_package_ensure,
        name   => $backend_package,
        tag    => 'openstack',
      })
    }
  }

  if $manage_config {
    $database_options = {
      "${config_group}/sqlite_synchronous"      => { value => $sqlite_synchronous },
      "${config_group}/backend"                 => { value => $backend },
      "${config_group}/connection"              => { value => $connection, secret => true },
      "${config_group}/slave_connection"        => { value => $slave_connection, secret => true },
      "${config_group}/mysql_sql_mode"          => { value => $mysql_sql_mode },
      "${config_group}/connection_recycle_time" => { value => $connection_recycle_time },
      "${config_group}/max_pool_size"           => { value => $max_pool_size },
      "${config_group}/max_retries"             => { value => $max_retries },
      "${config_group}/retry_interval"          => { value => $retry_interval },
      "${config_group}/max_overflow"            => { value => $max_overflow },
      "${config_group}/connection_debug"        => { value => $connection_debug },
      "${config_group}/connection_trace"        => { value => $connection_trace },
      "${config_group}/pool_timeout"            => { value => $pool_timeout },
      "${config_group}/use_db_reconnect"        => { value => $use_db_reconnect },
      "${config_group}/db_retry_interval"       => { value => $db_retry_interval },
      "${config_group}/db_inc_retry_interval"   => { value => $db_inc_retry_interval },
      "${config_group}/db_max_retry_interval"   => { value => $db_max_retry_interval },
      "${config_group}/db_max_retries"          => { value => $db_max_retries },
      "${config_group}/mysql_enable_ndb"        => { value => $mysql_enable_ndb },
    }

    create_resources($config, $database_options)
  }
}