database
Overview
This defined type allows you to create or delete a database.
Under the hood the calls the dbca utility to do the work. When you need more control over the individual settings when creating the database, you must use the ora_database custom type of the ora_config module
Here is an example on how to use this defined type to create a database:
ora_install::database{ 'testDb_Create':
action => 'create',
oracle_base => '/oracle',
oracle_home => '/oracle/product/11.2/db',
version => '11.2',
user => 'oracle',
group => 'dba',
download_dir => '/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",
require => Ora_install::Listener['start listener'],
}
Experience the Power of Puppet for Oracle
If you want to play and experiment with Puppet and Oracle, please take a look at our playgrounds. At our playgrounds, we provide you with a pre-installed environment, where you experiment fast and easy.
Attributes
| Attribute Name | Short Description |
|---|---|
| action | The action that must be taken. |
| asm_diskgroup | The ASM diskgroup to use for the database. |
| asm_snmp_password | The password to use for the ASMSNMP user. |
| character_set | The character set to use for running the database. |
| cluster_nodes | A comma seperated list of the nodes running in the RAC cluster. |
| container_database | Database is a container for pluggable databases. |
| data_file_destination | The location of the data file’s. |
| database_type | The kind of database you want to create. |
| db_conf_type | The type of database that needs to be installed. |
| db_domain | The domain of the database. |
| db_name | The name of the database. |
| db_port | The IP port to use for the database. |
| db_snmp_password | Password to use for the dbsnmp user. |
| download_dir | The directory where the Puppet software puts all downloaded files. |
| em_configuration | The type of Enterprise Manager configuration. |
| group | The os group to use for these Oracle puppet definitions. |
| init_params | The init parameters to use for the database. |
| logoutput | log the outputs of Puppet exec or not. |
| memory_mgmt_type | The type of memory management to use for the database. |
| memory_percentage | The percentage of physical memory for Oracle. |
| memory_total | The total memory in MB to allocate to Oracle. |
| nationalcharacter_set | Use this NLS Character set. |
| oracle_base | A directory to use as Oracle base directory. |
| oracle_home | A directory to be used as Oracle home directory for this software. |
| puppet_download_mnt_point | The base path of all remote files for the defined type or class. |
| recovery_area_destination | Location of the recovary files. |
| recovery_diskgroup | Diskgroup to use for recovery files. |
| sample_schema | Load the sample schema or not. |
| storage_type | The storage type to use. |
| sys_password | The password to use for the SYS user. |
| system_password | The password to use for the SYSTEM user. |
| template | Use the specified template to create the database. |
| template_type | The template type DBCA uses. |
| user | The user used for the specified installation. |
| version | The version that is installed in the used Oracle home. |
action
The action that must be taken. create or delete.
Valid values are:
createdelete
The default value is: create
Type: Enum['create','delete']
Default:'create'
asm_diskgroup
The ASM diskgroup to use for the database.
The default value is: DATA
Type: String[1]
Default:'DATA'
asm_snmp_password
The password to use for the ASMSNMP user.
Type: Optional[Easy_type::Password]
Default:undef
character_set
The character set to use for running the database.
The default value is: AL32UTF8
Type: String[1]
Default:'AL32UTF8'
cluster_nodes
A comma seperated list of the nodes running in the RAC cluster.
Example: node1,node2
Type: Optional[String[1]]
Default:undef
container_database
Database is a container for pluggable databases. When you want to add pluggable database to this database, specify a value of true.
The default value is: false
Type: Boolean
Default:false
data_file_destination
The location of the data file’s.
Type: Optional[String[1]]
Default:undef
database_type
The kind of database you want to create.
Valid values are:
MULTIPURPOSEDATA_WAREHOUSINGOLTP
The default value is: MULTIPURPOSE
Type: Enum['MULTIPURPOSE','DATA_WAREHOUSING','OLTP']
Default:'MULTIPURPOSE'
db_conf_type
The type of database that needs to be installed.
Valid values are:
SINGLERACRACONE
Type: Enum['SINGLE','RAC','RACONE']
Default:'SINGLE'
db_domain
The domain of the database.
Type: Optional[String[1]]
Default:undef
db_name
The name of the database.
Type: String[1]
Default:'orcl'
db_port
The IP port to use for the database.
The default value is: 1521
Type: Integer
Default:1521
db_snmp_password
Password to use for the dbsnmp user.
Type: Optional[Easy_type::Password]
Default:undef
download_dir
The directory where the Puppet software puts all downloaded files.
Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in.
The default value is: /install
Type: Stdlib::Absolutepath
Default:'/install'
em_configuration
The type of Enterprise Manager configuration.
Valid values are:
CENTRAL(all versions)LOCAL(version < 12.2)ALL(version < 12.2)NONE(all versions)DBEXPRESS(version >= 12.2)BOTH(version >= 12.2)
The default value is: NONE
Type: Enum['CENTRAL','LOCAL','ALL','NONE','DBEXPRESS','BOTH']
Default:'NONE'
group
The os group to use for these Oracle puppet definitions.
The default value is: dba
Type: String[1]
Default:'dba'
init_params
The init parameters to use for the database.
You can use either a comma separated string for init_params or a Hash.
Using comma separated string
Here is an example using a comma separated string:
ora_install::database{'my_database'
...
init_params => "open_cursors=1000,processes=600,job_queue_processes=4",
...
}
Using a Hash
Here is an example using a Hash:
ora_install::database{'my_database'
...
init_params => {'open_cursors' => '1000',
'processes' => '600',
'job_queue_processes' => '4' },
}
...
}
Type: Optional[Variant[String[1],Hash]]
Default:undef
logoutput
log the outputs of Puppet exec or not.
When you specify true Puppet will log all output of exec types.
Valid values are:
truefalseon_failure
Type: Variant[Boolean,Enum['on_failure']]
Default:lookup( { name => 'logoutput', default_value => 'on_failure' })
memory_percentage
The percentage of physical memory for Oracle.
The default value is: 40
Type: Integer
Default:40
memory_total
The total memory in MB to allocate to Oracle.
The default value is: 800
Type: Integer
Default:1000
nationalcharacter_set
Use this NLS Character set.
The default value is: UTF8
Type: String[1]
Default:'AL16UTF16'
oracle_base
A directory to use as Oracle base directory.
Type: String[1]
Default:undef
oracle_home
A directory to be used as Oracle home directory for this software.
Type: String[1]
Default:undef
puppet_download_mnt_point
The base path of all remote files for the defined type or class.
The default value is: puppet:///modules/ora_install
Type: Optional[String[1]]
Default:undef
recovery_area_destination
Location of the recovary files.
Type: Optional[String[1]]
Default:undef
recovery_diskgroup
Diskgroup to use for recovery files.
Type: Optional[String[1]]
Default:undef
sample_schema
Load the sample schema or not. Attention This is a string and not a boolean value.
The default value is: TRUE
Type: Enum['TRUE','FALSE']
Default:'TRUE'
storage_type
The storage type to use.
Valid values are:
FSCFSASM
FS
Type: Enum['FS','CFS','ASM']
Default:'FS'
sys_password
The password to use for the SYS user.
Type: Easy_type::Password
system_password
The password to use for the SYSTEM user.
Type: Easy_type::Password
template
Use the specified template to create the database.
You can choose between a set of pre-delivered templates, but also specify your own templates.
Using a pre-delivered template
ora_install delivers a few predefined templates.
- dbtemplate_11GR2
- dbtemplate_12.1
- dbtemplate_12.1_asm
Here is an example on how to use this:
ora_install::database{ 'testDb_Create':
...
template => 'dbtemplate_12.1',
...
}
Using your own template
When you specify a template name not pre-delivered by ora_install, the defined type will look in the directory specified by puppet_download_mnt_point for your own template.
Here is an example:
template => 'my_dbtemplate_11gR2_asm',
puppet_download_mnt_point => '/vagrant', # 'ora_install' etc
The template must be have the following extension dbt.erb like dbtemplate_12.1.dbt.erb
- Click here for an 12.1 db instance template example
- Click here for an 11.2 db asm instance template example
Type: Optional[String[1]]
Default:undef
template_type
The template type DBCA uses. There are two types of templates:
non-seedseed
The default value is: non-seed
Type: Enum['non-seed','seed']
Default:'non-seed'
user
The user used for the specified installation. The install class will not create the user for you. You must do that yourself.
The default value is: oracle
Type: String[1]
Default:'oracle'
memory_mgmt_type
The type of memory management to use for the database. The options are:
AUTOAUTO_SGACUSTOM_SGA
The default is AUTO_SGA
Type: Enum['AUTO','AUTO_SGA','CUSTOM_SGA']
Default:'AUTO_SGA'
version
The version that is installed in the used Oracle home.
Puppet uses this value to decide on version specific actions.
Type: Ora_install::ShortVersion
Default:'12.2'
