Puppet Class: nova::db

Defined in:
manifests/db.pp

Overview

Copyright © 2014 eNovance SAS <licensing@enovance.com>

Author: Emilien Macchi <emilien.macchi@enovance.com>

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Class: nova::db

Configures the Nova database.

Parameters

database_connection

(optional) Connection url to connect to nova database. Defaults to $::os_service_default

slave_connection

(optional) Connection url to connect to nova slave database (read-only). Defaults to $::os_service_default

database_connection_recycle_time

Timeout when db connections should be reaped. (Optional) Defaults to $::os_service_default

database_max_pool_size

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

database_max_retries

Maximum db connection retries during startup. Setting -1 implies an infinite retry count. (Optional) Defaults to $::os_service_default

database_retry_interval

Interval between retries of opening a sql connection. (Optional) Defaults to $::os_service_default

database_max_overflow

If set, use this value for max_overflow with sqlalchemy. (Optional) Defaults to $::os_service_default

database_pool_timeout

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

database_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 $::os_service_default

mysql_enable_ndb

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

api_database_connection

(optional) Connection url to connect to nova api database. Defaults to $::os_service_default

api_slave_connection

(optional) Connection url to connect to nova api slave database (read-only). Defaults to $::os_service_default

api_database_connection_recycle_time

Timeout when nova api db connections should be reaped. (Optional) Defaults to $::os_service_default

api_database_max_pool_size

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

api_database_max_retries

Maximum db connection retries during startup. Setting -1 implies an infinite retry count. (Optional) Defaults to $::os_service_default

api_database_retry_interval

Interval between retries of opening a sql connection. (Optional) Defaults to $::os_service_default

api_database_max_overflow

If set, use this value for max_overflow with sqlalchemy. (Optional) Defaults to $::os_service_default

api_database_pool_timeout

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

DEPRECATED PARAMETERS

database_min_pool_size

Minimum number of SQL connections to keep open in a pool. (Optional) Defaults to undef

Parameters:

  • database_connection (Any) (defaults to: $::os_service_default)
  • slave_connection (Any) (defaults to: $::os_service_default)
  • database_connection_recycle_time (Any) (defaults to: $::os_service_default)
  • database_max_pool_size (Any) (defaults to: $::os_service_default)
  • database_max_retries (Any) (defaults to: $::os_service_default)
  • database_retry_interval (Any) (defaults to: $::os_service_default)
  • database_max_overflow (Any) (defaults to: $::os_service_default)
  • database_pool_timeout (Any) (defaults to: $::os_service_default)
  • database_db_max_retries (Any) (defaults to: $::os_service_default)
  • mysql_enable_ndb (Any) (defaults to: $::os_service_default)
  • api_database_connection (Any) (defaults to: $::os_service_default)
  • api_slave_connection (Any) (defaults to: $::os_service_default)
  • api_database_connection_recycle_time (Any) (defaults to: $::os_service_default)
  • api_database_max_pool_size (Any) (defaults to: $::os_service_default)
  • api_database_max_retries (Any) (defaults to: $::os_service_default)
  • api_database_retry_interval (Any) (defaults to: $::os_service_default)
  • api_database_max_overflow (Any) (defaults to: $::os_service_default)
  • api_database_pool_timeout (Any) (defaults to: $::os_service_default)
  • database_min_pool_size (Any) (defaults to: undef)


106
107
108
109
110
111
112
113
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
# File 'manifests/db.pp', line 106

class nova::db (
  $database_connection                  = $::os_service_default,
  $slave_connection                     = $::os_service_default,
  $database_connection_recycle_time     = $::os_service_default,
  $database_max_pool_size               = $::os_service_default,
  $database_max_retries                 = $::os_service_default,
  $database_retry_interval              = $::os_service_default,
  $database_max_overflow                = $::os_service_default,
  $database_pool_timeout                = $::os_service_default,
  $database_db_max_retries              = $::os_service_default,
  $mysql_enable_ndb                     = $::os_service_default,
  $api_database_connection              = $::os_service_default,
  $api_slave_connection                 = $::os_service_default,
  $api_database_connection_recycle_time = $::os_service_default,
  $api_database_max_pool_size           = $::os_service_default,
  $api_database_max_retries             = $::os_service_default,
  $api_database_retry_interval          = $::os_service_default,
  $api_database_max_overflow            = $::os_service_default,
  $api_database_pool_timeout            = $::os_service_default,
  # DEPRECATED PARAMETERS
  $database_min_pool_size               = undef,
) {

  include nova::deps

  if $::nova::database_min_pool_size or $database_min_pool_size {
    warning('The database_min_pool_size parameter is deprecated, and will be removed in a future release.')
  }

  # NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
  # to use nova::<myparam> first the nova::db::<myparam>
  $database_connection_real = pick($::nova::database_connection, $database_connection)
  $slave_connection_real = pick($::nova::slave_connection, $slave_connection)
  $api_database_connection_real = pick($::nova::api_database_connection, $api_database_connection)
  $api_slave_connection_real = pick($::nova::api_slave_connection, $api_slave_connection)
  $database_connection_recycle_time_real = pick($::nova::database_idle_timeout, $database_connection_recycle_time)
  $database_max_pool_size_real = pick($::nova::database_max_pool_size, $database_max_pool_size)
  $database_max_retries_real = pick($::nova::database_max_retries, $database_max_retries)
  $database_retry_interval_real = pick($::nova::database_retry_interval, $database_retry_interval)
  $database_max_overflow_real = pick($::nova::database_max_overflow, $database_max_overflow)

  if !is_service_default($database_connection_real) {
    oslo::db { 'nova_config':
      db_max_retries          => $database_db_max_retries,
      connection              => $database_connection_real,
      connection_recycle_time => $database_connection_recycle_time_real,
      max_pool_size           => $database_max_pool_size_real,
      max_retries             => $database_max_retries_real,
      retry_interval          => $database_retry_interval_real,
      max_overflow            => $database_max_overflow_real,
      pool_timeout            => $database_pool_timeout,
      mysql_enable_ndb        => $mysql_enable_ndb,
      slave_connection        => $slave_connection_real,
    }
  }

  if !is_service_default($api_database_connection_real) {
    oslo::db { 'api_database':
      config                  => 'nova_config',
      config_group            => 'api_database',
      connection              => $api_database_connection_real,
      slave_connection        => $api_slave_connection_real,
      connection_recycle_time => $api_database_connection_recycle_time,
      max_pool_size           => $api_database_max_pool_size,
      max_retries             => $api_database_max_retries,
      retry_interval          => $api_database_retry_interval,
      max_overflow            => $api_database_max_overflow,
      pool_timeout            => $api_database_pool_timeout,
      # Package management should be disabled here to avoid conflict.
      manage_backend_package  => false
    }
  }

}