Merge pull request #18 from thedatabaseme/develop

Merge 2.2.0 to Master

Author: thedatabaseme

.gitignore

@@ -8,4 +8,6 @@
 /roles/pythia/templates/18SE2_Database.rsp.j2
 /roles/pythia/templates/19EE_Database.rsp.j2
 /roles/pythia/templates/19SE2_Database.rsp.j2
+/roles/pythia/templates/21EE_Database.rsp.j2
+/roles/pythia/templates/21SE2_Database.rsp.j2
 .idea

Changelog.txt

@@ -1,5 +1,26 @@
 Changelog of Pythia:
 
+Version 2.2.0
+  - New Feature #17: Pythia now supports Oracle Database 21c as well as Multitenant / Container Databases
+    
+    Especially the support for Multitenant Databases has brought some Changes.
+    It's now necessary to provide the information if the Databases running on a
+    specific RDBMS is a CDB or not. It's not a real good implementation to control
+    this in the rdbms_dict.yml cause the fact if it is a CDB or not, is defined per
+    database and not per RDBMS. But since 21c no longer supports any NON-CDB setups,
+    we implemented it there. The fact if is a CDB or not is controlled by setting
+    the variable container_database within rdbms_dict.yml.
+    Second major adjustment can be found during the patching of a container database.
+    You can control if you want to get all PDBs within a CDB started up after the
+    patch has been applied to the RDBMS by using the variable patch_all_pdbs within
+    the patch_dict.yml. Keep in mind, this variable is optional within the dictionary,
+    so you can specify it but you don't have to. When the variable patch_all_pdbs is
+    set to false, only PDBs that are started up during CDB startup (by using a trigger) are
+    opened and therefore patched.
+    When you missed the point for patching all PDBs while patching a CDB with Pythia,
+    you have to patch the PDBs (by using datapatch) manually on your own. Pythia will
+    not know if there are PDBs not patched.
+
 Version 2.1.0
   - New Feature #1: Added documentation / instructions under docs/*.md for the most common tasks you can do with Pythia
   - New Feature #13: Implemented Export / Import mechanism over Datapump Network_link

docs/02_INSTALL_RDBMS.md

@@ -27,6 +27,7 @@ Please also check the `vars/rdbms_dict.yml` and set the following Variables as y
 |oracle_base|Oracle Base Directory for the specified RDBMS|
 |oracle_home|Oracle Home Directory for the specified RDBMS|
 |oracle_inventory|Path to the Oracle Inventory Location|
+|container_database|Controls, if a database created for the specified<br> release, should be a CDB or not. NON-CDB<br> are desupported starting with 21c
 |additional_dir|You may specify an additional directory that should be<br> created / permission set when install RDBMS|
 |space_needed_gb|Space approximately in GB for installing the RDBMS. Respects,<br> that there is probably a Patch installed on top|
 |desc|Description of the RDBMS|

docs/03_CREATE_DB.md

@@ -20,13 +20,14 @@ During the Prerequisite Check that Pythia does everytime you let her go, the acc
 | Variable Name | Description              | Default Value |
 |---------------|--------------------------|---------------|
 |oracle_version |The Version of the RDBMS and Database you want to deploy or change.<br>The Version String has to be existant within the RDBMS Dictionary (`rdbms_dict.yml` under vars folder)|`19EE`|
-|oracle_sid|The SID of the Oracle Database you want to install. Only needed when starting <br>the playbook with the `db` tag, for creating a Database|none|
+|oracle_sid|The SID of the Oracle Database you want to install. Only needed when starting <br>the playbook with the `db` tag, for creating a Database|`NONE`|
 
 ### Optional Variables
 
 
 | Variable Name | Description              | Default Value |
 |---------------|--------------------------|---------------|
+|oracle_pdb_name|Name of the Plugable Database you want to get created<br> during Database creation. Needs to be set in order to get it created.|`NONE`|
 |sga_max_size |Size of the SGA in GB of the Oracle Database to be created. Both Parameters <br>sga_max_size and sga_target will be set to this value for your Instance Configuration|`2`|
 |pga_aggregate_target|Size of the PGA in GB of the Oracle Database to be created. Will be set as <br>Oracle Parameter pga_aggregate_target|`1`|
 |use_large_pages|Can be `TRUE` or `ONLY`. Will automatically be set to `ONLY` when the hugepage tag <br>is specified|`TRUE`|

docs/04_INSTALL_PATCH.md

@@ -19,6 +19,7 @@ Please also check the vars/patch_dict.yml and set the following Variables as you
 |patch_id |Unique Patch ID|
 |patch_dir |Path where the patch is located, relative to the `local_stage_directory` variable. <br>Must reside under `local_stage_directory`|
 |patch_file|Filename of the Patch Archive|
+|patch_all_pdbs|Can be `true` or `false`. When defined and the according RDBMS is enabled<br> as `container_database` (see `rdbms_dict.yml`), all PDBs will get opened<br> and patched during patching.
 |opatch_dir|Path where the needed OPATCH for patch installation is located. Relative to the `local_stage_directory` variable. <br>Must reside under `local_stage_directory`|
 |oracle_inventory|Path to the Oracle Inventory Location|
 |opatch_file|Filename of the needed OPATCH archive|

roles/pythia/README.md

@@ -49,6 +49,7 @@ main.yml Variables (can be set when calling the playbook, see Examples):
   - oracle_version (Default 19EE): The Version of the RDBMS and Database you want to deploy or change. The Version String has to be existant within the RDBMS Dictionary (rdbms_dict.yml under vars folder)
   - client_version (Default 19CLNT): The Version of the Oracle Client you want to deploy. The Version String has to be existant within the Client Dictionary (client_dict.yml under vars folder)
   - oracle_sid (Default NULL): The SID of the Oracle Database you want to install. Only needed when starting the playbook with the "db" tag, for creating a Database.
+  - oracle_pdb_name (Default NULL): Name of the Plugable Database you want to get created during Database creation. Needs to be set in order to get it created.
   - space_needed_gb: Space approximately in GB for installing the RDBMS. Respects, that there is probably a Patch installed on top. OVERLOADS rdbms_dict.yml space_needed_gb. SHOULD NOT BE SPECIFIED WITHIN HERE. SHOULD BE SPECIFIED AS EXTRA VARIABLE IN PLAYBOOK CALL.
   - nls_length_semantics (Default BYTE): Oracle Parameter NLS_LENGTH_SEMANTICS, can be BYTE or CHAR. When set, it will be placed in the Database creation Response Files
   - character_set (Default AL32UTF8): Character Set of the Database when creating.
@@ -106,6 +107,7 @@ patch_dict.yml (a Dictionary File for Patches that can be installed by Pythia):
   - patch_id: Unique Patch ID of the Patch
   - patch_dir: Path where the Patch is located on the Stage Directory, relative to the local_stage_directory Variable
   - patch_file: Filename of the Patch Archive
+  - patch_all_pdbs: Can be true or false. When defined and the according RDBMS is enabled as container_database (see rdbms_dict.yml), all PDBs will get opened and patched during patching.
   - opatch_dir: Path where the needed OPatch Version is located on the Stage Directory, relative to the local_stage_directory Variable
   - opatch_file: Filename of the OPatch Archive
   - desc: Description of the Patch
@@ -116,6 +118,7 @@ rdbms_dict.yml (a Dictionary File for RDBMS that can be installed by Pythia):
   - oracle_base: Oracle Base Directory for the specified RDBMS
   - oracle_home: Oracle Home Directory for the specified RDBMS
   - oracle_inventory: Path to the Oracle Inventory Location
+  - container_database: Controls, if a database created for the specified release, should be a CDB or not. NON-CDB are desupported starting with 21c
   - space_needed_gb: Space approximately needed in GB for installing the RDBMS. This value is checked in precheck_fsfree.yml before installing a RDBMS. The value should respect, that you are planning to install a Patchset on Top of the RDBMS. Good initial Value are 12GB of Free Space. 
   - desc: Description of the RDBMS
 

roles/pythia/defaults/main.yml

@@ -8,6 +8,7 @@
 #  - oracle_version (Default 19EE): The Version of the RDBMS and Database you want to deploy or change. The Version String has to be existant within the RDBMS Dictionary (rdbms_dict.yml under vars folder)
 #  - client_version (Default 19CLNT): The Version of the Oracle Client you want to deploy. The Version String has to be existant within the Client Dictionary (client_dict.yml under vars folder)
 #  - oracle_sid (Default NULL): The SID of the Oracle Database you want to install. Only needed when starting the playbook with the "db" tag, for creating a Database.
+#  - oracle_pdb_name (Default NULL): Name of the Plugable Database you want to get created during Database creation. Needs to be set in order to get it created.
 #  - nls_length_semantics (Default BYTE): Oracle Parameter NLS_LENGTH_SEMANTICS, can be BYTE or CHAR. When set, it will be placed in the Database creation Response Files
 #  - character_set (Default AL32UTF8): Character Set of the Database when creating.
 #  - national_character_set (Default AL16UTF16): National Character Set of the Database when creating
@@ -77,6 +78,7 @@ sqlscriptoutput: false
 # Control Variables for Installation
 oracle_version: 19EE
 oracle_sid: ""
+oracle_pdb_name: ""
 install_patch: ""
 install_rpm: ""
 reboot_required: false

roles/pythia/tasks/install_db.yml

@@ -78,7 +78,7 @@
 - name: Create Database {{ oracle_sid }} with dbca
   become: yes
   become_user: "{{ oracle_user }}"
-  shell: "{{ rdbms[oracle_version|string].oracle_home }}/bin/dbca -silent -createDatabase -templateName {{ rdbms[oracle_version|string].oracle_home }}/assistants/dbca/templates/{{ oracle_version }}_Database.rsp -sid {{ oracle_sid }} -gdbName {{ oracle_sid }} -createAsContainerDatabase false -sysPassword {{ sys_user_password }} -systemPassword {{ system_user_password }} -emConfiguration {{ emexpress }} -ignorePreReqs -honorControlFileInitParam"
+  shell: "{{ rdbms[oracle_version|string].oracle_home }}/bin/dbca -silent -createDatabase -templateName {{ rdbms[oracle_version|string].oracle_home }}/assistants/dbca/templates/{{ oracle_version }}_Database.rsp -sid {{ oracle_sid }} -gdbName {{ oracle_sid }} -createAsContainerDatabase {{ rdbms[oracle_version|string].container_database }} -sysPassword {{ sys_user_password }} -systemPassword {{ system_user_password }} -emConfiguration {{ emexpress }} -ignorePreReqs -honorControlFileInitParam"
   register: result
   failed_when: ("ERROR" in result.stdout) or ("FATAL" in result.stdout)
   environment:
@@ -88,6 +88,20 @@
   tags:
     - db
 
+- name: Create plugable Database {{ oracle_pdb_name }} with dbca
+  become: yes
+  become_user: "{{ oracle_user }}"
+  shell: "{{ rdbms[oracle_version|string].oracle_home }}/bin/dbca -silent -createPluggableDatabase -pdbName {{ oracle_pdb_name }} -sourceDB {{ oracle_sid }} -configureTDE false -createPDBFrom DEFAULT -pdbAdminUserName pdmadm_{{ oracle_pdb_name }} -pdbAdminPassword {{ sys_user_password }} -pdbDatafileDestination {{ data_dest }}/{{ oracle_pdb_name }}"
+  register: result
+  failed_when: ("ERROR" in result.stdout) or ("FATAL" in result.stdout)
+  when: (rdbms[oracle_version|string].container_database|bool) and (oracle_pdb_name|length > 0)
+  environment:
+    ORACLE_HOME: "{{ rdbms[oracle_version|string].oracle_home }}"
+    ORACLE_BASE: "{{ rdbms[oracle_version|string].oracle_base }}"
+    ORACLE_SID: "{{ oracle_sid }}"
+  tags:
+    - db
+
 ###################################################################################
 # Reset Database Users Passwords and Print them out to the User
 # Tag: db

roles/pythia/tasks/install_patch.yml

@@ -196,6 +196,8 @@
   become: yes
   become_user: "{{ oracle_user }}"
   shell: "{{ rdbms[oracle_version|string].oracle_home }}/OPatch/opatch apply -silent -oh {{ rdbms[oracle_version|string].oracle_home }}"
+  environment:
+    ORACLE_BASE: "{{ rdbms[oracle_version|string].oracle_base }}"
   args:
     chdir: "{{ remote_stage_directory }}/{{ patch[install_patch|int].patch_id }}"
   register: result
@@ -242,6 +244,19 @@
     - patch
     - patchonly
 
+- name: Start all PDBs for patching
+  become: yes
+  become_user: "{{ oracle_user }}"
+  shell: "echo -e \"alter pluggable database all open;\" | {{ rdbms[oracle_version|string].oracle_home }}/bin/sqlplus -s / as sysdba"
+  environment:
+    ORACLE_HOME: "{{ rdbms[oracle_version|string].oracle_home }}"
+    ORACLE_SID: "{{ item }}"
+  when: (sid_list.stdout_lines|length > 0) and (patch[install_patch|int].patch_all_pdbs is defined) and (patch[install_patch|int].patch_all_pdbs|bool) and (rdbms[oracle_version|string].container_database|bool)
+  with_items: "{{ sid_list.stdout_lines }}"
+  tags:
+    - patch
+    - patchonly
+
 ###################################################################################
 # The Database itself is not patched with datapatch.
 # Tag: patch, patchonly
@@ -254,6 +269,7 @@
   environment:
     ORACLE_HOME: "{{ rdbms[oracle_version|string].oracle_home }}"
     ORACLE_SID: "{{ item }}"
+    ORACLE_BASE: "{{ rdbms[oracle_version|string].oracle_base }}"
   when: (sid_list.stdout_lines|length > 0)
   with_items: "{{ sid_list.stdout_lines }}"
   tags:

roles/pythia/tasks/main.yml

@@ -1,7 +1,7 @@
 ---
 ##################################################################################
 # Main Task File for Pythia
-# Version 2.1.0
+# Version 2.2.0
 # Author: Philip Haberkern
 # For more Details view README.md
 ##################################################################################