Version 2.3.0

  - New Feature #25: You can now specify a list of instance parameters which will get set
    when a database is getting created. See docs/CREATE_DB.md
  - Fixed #26: Autostart scripts dbstart and dbshut will now get deployed with the correctl
    permission
  - New Feature #27: Pythia will now configure SELinux according to the parameter set by
    selinux_desired_state (default permissive)
  - Fixed #32: The shell script that is getting executed when su to the oracle OS user
    now shows the correct version in any case

Author: thedatabaseme

.github/workflows/ansible_lint.yml

@@ -1,6 +1,10 @@
 name: Ansible Lint  # feel free to pick your own name
 
-on: [push, pull_request]
+on: 
+  push:
+    branches:
+      - develop
+  pull_request:
 
 jobs:
   build:

.gitignore

@@ -4,6 +4,7 @@
 /roles/pythia/vars/rdbms_dict.yml
 /roles/pythia/vars/rpm_dict.yml
 /roles/pythia/vars/sid_directories.yml
+/roles/pythia/vars/sid_parameters.yml
 /roles/pythia/templates/18EE_Database.rsp.j2
 /roles/pythia/templates/18SE2_Database.rsp.j2
 /roles/pythia/templates/19EE_Database.rsp.j2

Changelog.txt

@@ -1,7 +1,18 @@
 Changelog of Pythia:
 
+Version 2.3.0
+  - New Feature #25: You can now specify a list of instance parameters which will get set
+    when a database is getting created. See docs/CREATE_DB.md
+  - Fixed #26: Autostart scripts dbstart and dbshut will now get deployed with the correctl
+    permission
+  - New Feature #27: Pythia will now configure SELinux according to the parameter set by
+    selinux_desired_state (default permissive)
+  - Fixed #32: The shell script that is getting executed when su to the oracle OS user
+    now shows the correct version in any case
+
 Version 2.2.5
-  - New Feature #19: Automatic linting is now done using Github Actions. Fixed many (really many) linting errors and refactored lots of code
+  - New Feature #19: Automatic linting is now done using Github Actions. Fixed many (really many)
+    linting errors and refactored lots of code
   - New Feature #20: Added Molecule test scenarios in Pythia
   - New Feature #21: You can now specify additional runInstaller parameters by using the runinstaller_parameters variable
   - Fixed #23: Pythia now uses dynamic generated variable role_path when working with templates and files.

INSTALL.md

@@ -7,6 +7,11 @@ General
 You will need to provide several Files to ensure, that Pythia will work correctly. All Files you need to create are listed in this Instruction. These files can and should be changed by you, to fulfill your needs for installing and maintaining an Oracle Database. You may want to adapt all Variables or Templates to meet your or your companies requirements. Hence you want to change the Folder Structure to fulfill your needs.
 For every File that needs to exist, there is an *EXAMPLE* file in the respective directory. If you want to, you can copy the *EXAMPLE* file (and remove the EXAMPLE from the filename) and Pythia will work. This is not the recommended way however.
 
+Stage Directory
+===============
+
+Some tasks of Pythia relate on a so called "local stage directory". In this directory, Pythia searches for the software archives of the Oracle Database. The location of the stage directory is controlled by the variable `local_stage_directory` under `vars/main.yml`. You have to be aware, that Pythia searches for this directory on the Ansible Controlhost. By default, the location is `/mnt/oracle_stage`. You still can control the specific location of a software archive in the `rdbms_dict.yml` and `patch_dict.yml`. But the location can only be underneath the `local_stage_directory`.
+
 Variables
 ===============
 
@@ -82,6 +87,22 @@ All other Variables in here are referenced in the respective Responsefile for th
   - archive_dest: Specifies the Location of the Archived Redo Logs. This Variable is referenced in the DBCA Templates (*_Database.rsp.j2)
   - audit_dest: Specifies the Location of the Audit Files. This Variable is referenced in the DBCA Templates (*_Database.rsp.j2)
 
+sid_parameters.yml
+---------------
+There is no need to adapt the `dbca` template if you want to get an additional parameter included during DB creation. For this, you can use the `sid_parameters.yml` under the `vars` folder. There is an *sid_parameters_EXAMPLE.yml* file which shows you an example content. It is not mandatory, that this file exists, it will only get included, when it's existing and only when using the `db` TAG. In the `sid_parameters.yml` you can specify a dictionary of parameters you want to specify per SID. For instance, if you plan to adjust the parameters `filesystemio_options` and `fast_start_mttr_target` when a database `ORA21` is getting created, your `sid_parameters.yml` should look like this.
+
+```
+sid_parameters:
+  ORA21:
+    parameters:
+      FILESYSTEMIO_OPTIONS: setall
+      FAST_START_MTTR_TARGET: 150
+```
+
+You are able to specify parameters for multiple instances in one file.
+
+> :warning: Defining the same parameters multiple times with conflicting values will lead to unknown behavior during the DB creation. Please check the dbca templates under the templates directory to understand, which parameters are set there.
+
 Templates
 ===============
 

README.md

@@ -34,6 +34,12 @@ Requirements
 
 Pythia requires you to run Ansible 2.9 or higher. The Oracle Software you want to install / configure by Pythia has to be located on a "Staging Area" mounted on the Control Server. Keep in Mind, that you need to licence Oracle Software separately!
 
+The following collections / modules are needed (limited on some TAGs). Pythia will automatically download needed collections:
+
+| Collection / Module | TAGs                 |
+|---------------------|----------------------|
+| ansible.posix       | `db`, `rdbms`, `autostart` |
+
 Installation and Configuration
 ------------------------------
 
@@ -92,7 +98,7 @@ Example: Install additional Software named "DEMO" on the target system (defined
     - ansible-playbook /etc/ansible/pythia/pythia.yml -e "HOSTS=ansibletest" --tags "rpm" -e "install_rpm=DEMO" -k -K -u <username>
 
 Example: Install Oracle RDBMS with Version 19c and Enterprise Edition on Host "ansibletest", install the 19.5 RU (Patch ID: 30125133). Build a Database named "ORA19" on top, which will use Hugepages and a SGA Size of 16GB:
-Attention! Configuring Hugepages will most likely lead to a system reboot. Therefore the reboot_ack switch has to be set when calling the playbook.
+Attention! Configuring Hugepages will most likely lead to a system reboot. Therefore the `reboot_ack` switch has to be set when calling the playbook.
 
     - ansible-playbook /etc/ansible/pythia/pythia.yml -e "HOSTS=ansibletest" --tags "rdbms, db, patch, hugepage" -e "oracle_sid=ORA19 oracle_version=19EE install_patch=30125133 reboot_ack=true sga_max_size=16" -k -K -u <username>
 

docs/02_INSTALL_RDBMS.md

@@ -16,7 +16,7 @@ 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_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<br>(`rdbms_dict.yml` under vars folder)|`19EE`|
 
 Please also check the `vars/rdbms_dict.yml` and set the following Variables as you need. DON'T specify them in your Playbook Call.
 
@@ -36,7 +36,15 @@ Please also check the `vars/rdbms_dict.yml` and set the following Variables as y
 
 | Variable Name | Description              | Default Value |
 |---------------|--------------------------|---------------|
-|runinstaller_parameters|Additional runinstaller parameters during installation<br>of Oracle software. For example `-ignoreInternalDriverError`.|`NONE`|
+|runinstaller_parameters|Additional runinstaller parameters during installation of Oracle software. For example<br>`-ignoreInternalDriverError`.|`NONE`|
+|selinux_desired_state|There are some known problems with SELinux set to enforcing and Oracle Databases.<br>`selinux_desired_state` controls the state which SELinux should get set by Pythia.<br> Can be set to `permissive`, `enforcing` and `disabled`. Eventually a reboot is required<br>when altering the state. You may need to set the reboot_ack parameter when calling<br>the playbook.|`permissive`|
+
+<br>
+
+> :warning: SELinux can be tricky. We recommend to use the default setting (`permissive`). If your system is set to `enforcing`, a reboot will be required. Pythia will do the reboot for you, but you need to also acknowledge the reboot by the `reboot_ack=true` flag in the playbook call (see `hugepage` TAG in the [README.md](https://github.com/thedatabaseme/pythia/blob/master/README.md))
+
+<br>
+
 ## Examples
 
 Example: Install Oracle RDBMS with Version 18c as Standard Edition 2 on Host "ansibletest":

docs/03_CREATE_DB.md

@@ -8,7 +8,7 @@ We highly recommend, to also specify the `hugepage` TAG when creating a Database
 During the Prerequisite Check that Pythia does everytime you let her go, the according Prerequisites will be implemented. When specifying the `db` TAG, the following will be done during the prerequisite phase.
 
   - Check and set all needed Kernel Parameter (Shared Memory Configuration and also Hugepages if you specified the TAG `hugepage`)
-  - Restarts the System to disable Transparent Hugepages (when `hugepage` TAG is specified and you acknowledged the Reboot)
+  - Restarts the System to disable Transparent Hugepages (when `hugepage` TAG is specified and you acknowledged the Reboot (`reboot_ack=true`))
   - Set the Security Limits (`ulimit`) of the System
   - Setup an Environment Script for the Oracle OS User which will be executed when you `su` to the Oracle User
 
@@ -22,6 +22,22 @@ During the Prerequisite Check that Pythia does everytime you let her go, the acc
 |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`|
 
+### Optional SID parameters
+You can specify a list of database parameters that should get set during dbca DB creation by specifying them with the according SID name in a `sid_parameters.yml` (see *sid_parameters_EXAMPLE.yml*).
+For instance, if you plan to adjust the parameters `filesystemio_options` and `fast_start_mttr_target` when a database `ORA21` is getting created, your `sid_parameters.yml` should look like this.
+
+```
+sid_parameters:
+  ORA21:
+    parameters:
+      FILESYSTEMIO_OPTIONS: setall
+      FAST_START_MTTR_TARGET: 150
+```
+
+You are able to specify parameters for multiple instances in one file.
+
+> :warning: Defining the same parameters multiple times with conflicting values will lead to unknown behavior during the DB creation. Please check the dbca templates under the templates directory to understand, which parameters are set there.
+
 ### Optional Variables
 
 
@@ -40,6 +56,13 @@ During the Prerequisite Check that Pythia does everytime you let her go, the acc
 |listener_logging|Specifies if a created listener will be configured to log or not. Can be either `OFF` or `ON`.|`OFF`|
 |emexpress|Specifies if the EM Express should be installed / configured when creating a Database. <br>There are two valid values for this Variable: `DBEXPRESS` and `NONE`|`DBEXPRESS`|
 |autoextend|Specifies if the created Datafiles should be autoextensible or not|`FALSE`|
+|selinux_desired_state|There are some known problems with SELinux set to enforcing and Oracle Databases.<br>`selinux_desired_state` controls the state which SELinux should get set by Pythia.<br> Can be set to `permissive`, `enforcing` and `disabled`. Eventually a reboot is required<br>when altering the state. You may need to set the reboot_ack parameter when calling<br>the playbook.|`permissive`|
+
+<br>
+
+> :warning: SELinux can be tricky. We recommend to use the default setting (`permissive`). If your system is set to `enforcing`, a reboot will be required. Pythia will do the reboot for you, but you need to also acknowledge the reboot by the `reboot_ack=true` flag in the playbook call (see `hugepage` TAG in the [README.md](https://github.com/thedatabaseme/pythia/blob/master/README.md))
+
+<br>
 
 ## Examples
 

roles/pythia/README.md

@@ -33,6 +33,12 @@ Requirements
 
 Pythia requires you to run Ansible 2.9 or higher. The Oracle Software you want to install / configure by Pythia has to be located on a "Staging Area" mounted on the Control Server. Keep in Mind, that you need to licence Oracle Software separately!
 
+The following collections / modules are needed (limited on some TAGs). Pythia will automatically download needed collections:
+
+| Collection / Module | TAGs                 |
+|---------------------|----------------------|
+| ansible.posix       | `db`, `rdbms`, `autostart` |
+
 Role Variables
 --------------
 
@@ -50,6 +56,7 @@ main.yml Variables (can be set when calling the playbook, see Examples):
   - 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.
   - runinstaller_parameters (Default NULL): Additional runinstaller parameters during installation of Oracle software. For example "-ignoreInternalDriverError"
+  - selinux_desired_state (Default permissive): There are some known problems with SELinux set to enforcing and Oracle Databases. selinux_desired_state controls the state which SELinux should get set by Pythia. Can be set to permissive, enforcing and disabled. Most likely a reboot is required when altering the state. You may need to set the reboot_ack parameter when calling the playbook.
   - 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

roles/pythia/defaults/main.yml

@@ -13,6 +13,11 @@
 #    (client_dict.yml under vars folder)
 #  - runinstaller_parameters (Default NULL): Additional runinstaller parameters during installation
 #    of Oracle software. For example " -ignoreInternalDriverError".
+#  - selinux_desired_state (Default permissive): There are some known problems with SELinux set
+#    to enforcing and Oracle Databases. selinux_desired_state controls the state which SELinux
+#    should get set by Pythia. Can be set to permissive, enforcing and disabled. Most likely a
+#    reboot is required when altering the state. You may need to set the reboot_ack parameter
+#    when calling the playbook.
 #  - 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
@@ -143,6 +148,7 @@ sysctl_stable: true
 client_version: 19CLNT
 client_install_type: "Administrator"
 runinstaller_parameter: ""
+selinux_desired_state: "permissive"
 
 # Control Variables for Upgrade
 oracle_source_version: 18EE

roles/pythia/requirements.yml

@@ -0,0 +1,4 @@
+---
+
+collections:
+  - name: ansible.posix