Defined Type: oradb::database

Defined in:
manifests/database.pp

Overview

database

add or destroys a (container) database

Examples:

creates a database


oradb::database{ 'testDb':
  oracle_base               => '/oracle',
  oracle_home               => '/oracle/product/11.2/db',
  version                   => '11.2',
  user                      => 'oracle',
  group                     => 'dba',
  download_dir              => '/var/tmp/install',
  action                    => 'create',
  db_name                   => 'test',
  db_domain                 => 'oracle.com',
  db_port                   => '1521',
  sys_password              => 'Welcome01',
  system_password           => 'Welcome01',
  data_file_destination     => "/oracle/oradata",
  recovery_area_destination => "/oracle/flash_recovery_area",
  character_set             => "AL32UTF8",
  nationalcharacter_set     => "UTF8",
  init_params               => {'open_cursors'        => '1000',
                                'processes'           => '600',
                                'job_queue_processes' => '4' },
  sample_schema             => 'TRUE',
  memory_percentage         => 40,
  memory_total              => 800,
  database_type             => "MULTIPURPOSE",
  em_configuration          => "NONE",
}

oradb::database{ 'oraDb':
  oracle_base               => '/oracle',
  oracle_home               => '/oracle/product/12.1/db',
  version                   => '12.1',
  user                      => 'oracle',
  group                     => 'dba'
  download_dir              => '/var/tmp/install',
  action                    => 'create',
  db_name                   => 'orcl',
  db_domain                 => 'example.com',
  sys_password              => 'Welcome01',
  system_password           => 'Welcome01',
  character_set             => 'AL32UTF8',
  nationalcharacter_set     => 'UTF8',
  sample_schema             => 'FALSE',
  memory_percentage         => 40,
  memory_total              => 800,
  database_type             => 'MULTIPURPOSE',
  em_configuration          => 'NONE',
  data_file_destination     => '/oracle/oradata',
  recovery_area_destination => '/oracle/flash_recovery_area',
  init_params               => {'open_cursors'        => '1000',
                                'processes'           => '600',
                                'job_queue_processes' => '4' },
  container_database        => true,
}

Parameters:

  • oracle_base (String) (defaults to: undef)

    full path to the Oracle Base directory

  • oracle_home (String) (defaults to: undef)

    full path to the Oracle Home directory inside Oracle Base

  • db_port (Integer) (defaults to: lookup('oradb::listener_port'))

    database listener port number

  • user (String) (defaults to: lookup('oradb::user'))

    operating system user

  • group (String) (defaults to: lookup('oradb::group'))

    the operating group name for using the oracle software

  • download_dir (String) (defaults to: lookup('oradb::download_dir'))

    location for installation files used by this module

  • puppet_download_mnt_point (String) (defaults to: lookup('oradb::module_mountpoint'))

    the location where the installation software is available

  • version (Enum['11.2', '12.1', '12.2']) (defaults to: lookup('oradb::version'))

    Oracle installation version

  • action (Enum['create','delete']) (defaults to: lookup('oradb::database::action'))

    create or delete the database

  • template (Optional[String]) (defaults to: undef)

    dbt template for your own full database configution

  • template_seeded (Optional[String]) (defaults to: undef)

    seeded template name

  • template_variables (String) (defaults to: 'dummy=/tmp')

    variables which you can use in your dbt template

  • db_name (String) (defaults to: lookup('oradb::database_name'))

    database name

  • db_domain (String) (defaults to: undef)

    database domain name

  • sys_password (String) (defaults to: lookup('oradb::default::password'))

    sys username password

  • system_password (String) (defaults to: lookup('oradb::default::password'))

    system username password

  • data_file_destination (Optional[String]) (defaults to: undef)

    full path to for the Datafiles location

  • recovery_area_destination (Optional[String]) (defaults to: undef)

    full path to for the recovery area destination location

  • character_set (String) (defaults to: lookup('oradb::database::character_set'))
  • nationalcharacter_set (String) (defaults to: lookup('oradb::database::nationalcharacter_set'))
  • init_params (Optional[Hash]) (defaults to: undef)

    database parameters

  • sample_schema (String) (defaults to: lookup('oradb::database::sample_schema'))

    add sample schemas

  • memory_percentage (Integer) (defaults to: lookup('oradb::database::memory_percentage'))
  • memory_total (Integer) (defaults to: lookup('oradb::database::memory_total'))
  • database_type (Enum['MULTIPURPOSE', 'DATA_WAREHOUSING', 'OLTP']) (defaults to: lookup('oradb::database::database_type'))
  • em_configuration (Enum['NONE', 'CENTRAL', 'LOCAL', 'ALL']) (defaults to: lookup('oradb::database::em_configuration'))
  • storage_type (Enum['FS', 'CFS', 'ASM']) (defaults to: lookup('oradb::database::storage_type'))
  • asm_snmp_password (String) (defaults to: lookup('oradb::default::password'))
  • db_snmp_password (String) (defaults to: lookup('oradb::default::password'))
  • asm_diskgroup (String) (defaults to: lookup('oradb::database::asm_diskgroup'))
  • recovery_diskgroup (Optional[String]) (defaults to: undef)
  • cluster_nodes (Optional[String]) (defaults to: undef)
  • container_database (Boolean) (defaults to: false)

    configure as a 12c container database which allows plugleable databases

  • automatic_memory_management (Boolean) (defaults to: true)


96
97
98
99
100
101
102
103
104
105
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# File 'manifests/database.pp', line 96

define oradb::database(
  String $oracle_base                                             = undef,
  String $oracle_home                                             = undef,
  Enum['11.2', '12.1', '12.2'] $version                           = lookup('oradb::version'),
  String $user                                                    = lookup('oradb::user'),
  String $group                                                   = lookup('oradb::group'),
  String $download_dir                                            = lookup('oradb::download_dir'),
  Enum['create','delete'] $action                                 = lookup('oradb::database::action'),
  Optional[String] $template                                      = undef,
  Optional[String] $template_seeded                               = undef,
  String $template_variables                                      = 'dummy=/tmp', # for dbt template
  String $db_name                                                 = lookup('oradb::database_name'),
  String $db_domain                                               = undef,
  Integer $db_port                                                = lookup('oradb::listener_port'),
  String $sys_password                                            = lookup('oradb::default::password'),
  String $system_password                                         = lookup('oradb::default::password'),
  Optional[String] $data_file_destination                         = undef,
  Optional[String] $recovery_area_destination                     = undef,
  String $character_set                                           = lookup('oradb::database::character_set'),
  String $nationalcharacter_set                                   = lookup('oradb::database::nationalcharacter_set'),
  Optional[Hash] $init_params                                     = undef,
  String $sample_schema                                           = lookup('oradb::database::sample_schema'),
  Integer $memory_percentage                                      = lookup('oradb::database::memory_percentage'),
  Integer $memory_total                                           = lookup('oradb::database::memory_total'),
  Enum['MULTIPURPOSE', 'DATA_WAREHOUSING', 'OLTP'] $database_type = lookup('oradb::database::database_type'),
  Enum['NONE', 'CENTRAL', 'LOCAL', 'ALL'] $em_configuration       = lookup('oradb::database::em_configuration'),
  Enum['FS', 'CFS', 'ASM'] $storage_type                          = lookup('oradb::database::storage_type'),
  String $asm_snmp_password                                       = lookup('oradb::default::password'),
  String $db_snmp_password                                        = lookup('oradb::default::password'),
  String $asm_diskgroup                                           = lookup('oradb::database::asm_diskgroup'),
  Optional[String] $recovery_diskgroup                            = undef,
  Optional[String] $cluster_nodes                                 = undef, # comma separated list with at first the local and at second the remode host e.g. "racnode1,racnode2"
  Boolean $container_database                                     = false, # 12.1 feature for pluggable database
  String $puppet_download_mnt_point                               = lookup('oradb::module_mountpoint'),
  Boolean $automatic_memory_management                            = true, # for 12.2 , choose false when more than 4gb memory
)
{

  $supported_db_kernels = join( lookup('oradb::kernels'), '|')
  if ( $::kernel in $supported_db_kernels == false){
    fail("Unrecognized operating system, please use it on a ${supported_db_kernels} host")
  }

  if $action == 'create' {
    $operation_type = 'createDatabase'
  } elsif $action == 'delete' {
    $operation_type = 'deleteDatabase'
  } else {
    fail('Unrecognized database action')
  }

  if ( $database_type in lookup('oradb::instance_types') == false ) {
    fail('Unrecognized database_type')
  }

  if ( $em_configuration in lookup('oradb::instance_em_configuration') == false) {
    fail('Unrecognized emConfiguration')
  }

  if ( $storage_type in lookup('oradb::instance_storage_type') == false ) {
    fail('Unrecognized storageType')
  }

  if ( $version == '11.2' and $container_database == true ){
    fail('container or pluggable database is not supported on version 11.2')
  }

  $exec_path = lookup('oradb::exec_path')
  $user_base = lookup('oradb::user_base_dir')
  $user_home = "${user_base}/${user}"

  if (is_hash($init_params) or is_string($init_params)) {
    if is_hash($init_params) {
      $init_params_array = sort(join_keys_to_values($init_params, '='))
      $sanitized_init_params = join($init_params_array,',')
    } else {
      $sanitized_init_params = $init_params
    }
  } else {
    fail 'init_params only supports a String or a Hash as value type'
  }

  $sanitized_title = regsubst($title, '[^a-zA-Z0-9.-]', '_', 'G')

  if $db_domain {
    $globaldb_name = "${db_name}.${db_domain}"
  } else {
    $globaldb_name = $db_name
  }

  if ! defined(File["${download_dir}/database_${sanitized_title}.rsp"]) {
    file { "${download_dir}/database_${sanitized_title}.rsp":
      ensure  => present,
      content => epp("oradb/dbca_${version}.rsp.epp",
                    { 'operationType'               => $operation_type,
                      'globaldb_name'               => $globaldb_name,
                      'db_name'                     => $db_name,
                      'cluster_nodes'               => $cluster_nodes,
                      'sys_password'                => $sys_password,
                      'system_password'             => $system_password,
                      'em_configuration'            => $em_configuration,
                      'db_snmp_password'            => $db_snmp_password,
                      'data_file_destination'       => $data_file_destination,
                      'recovery_area_destination'   => $recovery_area_destination,
                      'storage_type'                => $storage_type,
                      'asm_diskgroup'               => $asm_diskgroup,
                      'asm_snmp_password'           => $asm_snmp_password,
                      'recovery_diskgroup'          => $recovery_diskgroup,
                      'character_set'               => $character_set,
                      'nationalcharacter_set'       => $nationalcharacter_set,
                      'sanitizedInitParams'         => $sanitized_init_params,
                      'sample_schema'               => $sample_schema,
                      'memory_percentage'           => $memory_percentage,
                      'database_type'               => $database_type,
                      'memory_total'                => $memory_total,
                      'db_port'                     => $db_port,
                      'container_database'          => $container_database,
                      'automatic_memory_management' => $automatic_memory_management }),
      mode    => '0770',
      owner   => $user,
      group   => $group,
      before  => Exec["oracle database ${title}"],
    }
  }

  if ( $template_seeded ) {
    $templatename = "${oracle_home}/assistants/dbca/templates/${template_seeded}.dbc"
  } elsif ( $template ) {
    $templatename = "${download_dir}/${template}_${sanitized_title}.dbt"
    file { $templatename:
      ensure  => present,
      content => template("${puppet_download_mnt_point}/${template}.dbt.erb"),
      mode    => '0775',
      owner   => $user,
      group   => $group,
      before  => Exec["oracle database ${title}"],
    }
  } else {
    $templatename = undef
  }

  $elevation_prefix = "su - ${user} -c \"/bin/ksh -c \\\""
  $elevation_suffix = "\\\"\""

  if $action == 'create' {
    if ( $templatename ) {
      if ( $version == '11.2' or $container_database == false ) {
        if ( $cluster_nodes != undef) {
          $command = "${elevation_prefix}${oracle_home}/bin/dbca -silent -createDatabase -templateName ${templatename} -gdbname ${globaldb_name} -characterSet ${character_set} -responseFile NO_VALUE -sysPassword ${sys_password} -systemPassword ${system_password} -dbsnmpPassword ${db_snmp_password} -asmsnmpPassword ${asm_snmp_password} -storageType ${storage_type} -emConfiguration ${em_configuration} -nodelist ${cluster_nodes} -variables ${template_variables}${elevation_suffix}"
        } else {
          $command = "${elevation_prefix}${oracle_home}/bin/dbca -silent -createDatabase -templateName ${templatename} -gdbname ${globaldb_name} -characterSet ${character_set} -responseFile NO_VALUE -sysPassword ${sys_password} -systemPassword ${system_password} -dbsnmpPassword ${db_snmp_password} -asmsnmpPassword ${asm_snmp_password} -storageType ${storage_type} -emConfiguration ${em_configuration} -variables ${template_variables}${elevation_suffix}"
        }
      } else {
        if( $cluster_nodes != undef) {
          $command = "${elevation_prefix}${oracle_home}/bin/dbca -silent -createDatabase -templateName ${templatename} -gdbname ${globaldb_name} -characterSet ${character_set} -createAsContainerDatabase ${container_database} -responseFile NO_VALUE -sysPassword ${sys_password} -systemPassword ${system_password} -dbsnmpPassword ${db_snmp_password} -asmsnmpPassword ${asm_snmp_password} -storageType ${storage_type} -emConfiguration ${em_configuration} -nodelist ${cluster_nodes} -variables ${template_variables}${elevation_suffix}"
        } else {
          $command = "${elevation_prefix}${oracle_home}/bin/dbca -silent -createDatabase -templateName ${templatename} -gdbname ${globaldb_name} -characterSet ${character_set} -createAsContainerDatabase ${container_database} -responseFile NO_VALUE -sysPassword ${sys_password} -systemPassword ${system_password} -dbsnmpPassword ${db_snmp_password} -asmsnmpPassword ${asm_snmp_password} -storageType ${storage_type} -emConfiguration ${em_configuration} -variables ${template_variables}${elevation_suffix}"
        }
      }
    } else {
      if ( $version == '12.2' ) {
        $command = "${elevation_prefix}${oracle_home}/bin/dbca -silent -createDatabase -responseFile ${download_dir}/database_${sanitized_title}.rsp${elevation_suffix}"
      } else {
        $command = "${elevation_prefix}${oracle_home}/bin/dbca -silent -responseFile ${download_dir}/database_${sanitized_title}.rsp${elevation_suffix}"
      }
    }
    exec { "oracle database ${title}":
      command     => $command,
      creates     => "${oracle_base}/admin/${db_name}",
      timeout     => 0,
      path        => $exec_path,
      user        => 'root',
      group       => 'root',
      cwd         => $oracle_base,
      environment => ["USER=${user}",],
      logoutput   => true,
    }
  } elsif $action == 'delete' {
    if ( $version == '12.2' ) {
      $command = "${oracle_home}/bin/dbca -silent -deleteDatabase -sourceDB ${db_name} -sysDBAUserName sys -sysDBAPassword ${sys_password}"
    } else {
      $command = "${oracle_home}/bin/dbca -silent -responseFile ${download_dir}/database_${sanitized_title}.rsp"
    }
    exec { "oracle database ${title}":
      command     => $command,
      onlyif      => "ls ${oracle_base}/admin/${db_name}",
      timeout     => 0,
      path        => $exec_path,
      user        => $user,
      group       => $group,
      cwd         => $oracle_base,
      environment => ["USER=${user}",],
      logoutput   => true,
    }
  }
}