diff --git a/doc/development.adoc b/doc/development.adoc index ac54264f3..6961fd2b6 100644 --- a/doc/development.adoc +++ b/doc/development.adoc @@ -13,7 +13,7 @@ A Pull-Request is only accepted, when `github-Actions` are valid. === Prepare a development environment -IMPORTANT: This chapter shows, how the development envionment could look like. + +IMPORTANT: This chapter shows, how the development environment could look like. + You need an Ansible-Controller with an Editor or IDE of your own choice. @@ -72,7 +72,7 @@ ansible-navigator 3.3.0 === Using ansible-doctor -IMPORTANT: `ansible-doctor` has module dpendencies with conflicts between `ansible-lint`. +IMPORTANT: `ansible-doctor` has module dependencies with conflicts between `ansible-lint`. We have to use a dedicated venv for `ansible-doctor' .configure venv for ansible-oracle @@ -190,7 +190,7 @@ cd packer_templates/oraclelinux/ === Upload new Version -IMPORTANT: Change the boxname to an account with write priviledges. +IMPORTANT: Change the boxname to an account with write privileges. .Upload new version after build: ---- @@ -206,9 +206,9 @@ vagrant cloud publish --release ${boxname} "$vagrantversion" virtualbox == ansible molecule WARNING: The timeout for pulling docker Container in `molecule` is 15s at the moment. + -There is no parameter to increase the timeout. Pull container manually before starting the szenario. The image url is defined in `molecule.yml`. +There is no parameter to increase the timeout. Pull container manually before starting the scenario. The image url is defined in `molecule.yml`. -The following szenarios are existing in the `ansible-oracle profect. +The following scenarios are existing in the `ansible-oracle profect. [options="header" cols="1,4" valign="top"] |======================= @@ -222,12 +222,12 @@ The following szenarios are existing in the `ansible-oracle profect. === Test OS roles -IMPORTANT: This szenario is used, when changes at OS roles should be tested against different OS Distribuitions. + -Most of the tests are included in the `dbfs` szenario! +IMPORTANT: This scenario is used, when changes at OS roles should be tested against different OS Distribuitions. + +Most of the tests are included in the `dbfs` scenario! The execution time is ~10m for a full test. -The `default` szenario requires no parameter `-s`! +The `default` scenario requires no parameter `-s`! .Start download ---- @@ -251,12 +251,12 @@ cd extensions molecule test -s download ---- -`molecule test` does the full test of the szenario. +`molecule test` does the full test of the scenario. -=== Test Single Instance in Filesystem with szenario `dbfs` +=== Test Single Instance in Filesystem with scenario `dbfs` IMPORTANT: Make sure that the installation media and patches are placed in `/vagrant` before starting `molecule`. + -Use the szenario `download` for downloading the Patches from support.oracle.com. +Use the scenario `download` for downloading the Patches from support.oracle.com. The execution time is ~2h for a full test. diff --git a/doc/featurelist.adoc b/doc/featurelist.adoc index e54412dcf..29e1b0c87 100644 --- a/doc/featurelist.adoc +++ b/doc/featurelist.adoc @@ -1,11 +1,11 @@ ## Supported features in ansible-oracle -WARNING: Please check the official Compatibilty List from Oracle for RDBMS and Restart/Grid-Infrastructure. + +WARNING: Please check the official Compatibility List from Oracle for RDBMS and Restart/Grid-Infrastructure. + `ansible-oracle` only supports combinations from Oracle with exceptions from the following table. IMPORTANT: All Editions from Oracle are supported. -See documentation from Oracle for differences between Enterprise and Standard Edtion (SE, SE One and SE2) +See documentation from Oracle for differences between Enterprise and Standard Edition (SE, SE One and SE2) :supportedfrom112: 11.2.0.3 <> \ diff --git a/doc/guides/advanced.adoc b/doc/guides/advanced.adoc index 784565ad5..fb4b8b01a 100644 --- a/doc/guides/advanced.adoc +++ b/doc/guides/advanced.adoc @@ -52,7 +52,7 @@ Do not change this until you really know what you are doing. All installation media are searched in `oracle_stage_remote` on the database server. -WARNING: It is assumend that `oracle_stage_remote` is set to `/sw` +WARNING: It is assumed that `oracle_stage_remote` is set to `/sw` ===== Installation media diff --git a/doc/missing_documentation.md b/doc/missing_documentation.md index c5b4cf9ef..9e288463b 100644 --- a/doc/missing_documentation.md +++ b/doc/missing_documentation.md @@ -16,7 +16,7 @@ -- operations with ansible-oracle - explain concepts around ansible collection - meaning of files and directories -- venv, differnt versions of python / ansible +- venv, different versions of python / ansible - ansible controller - why rendanic Linux, why not standard OL? (security concerns) @@ -54,7 +54,7 @@ ansible-oracle currently works for OL7/8, RHEL7/8 ## logging -- first beginner installation, runing from ansible-container to OL VM took 7 hours +- first beginner installation, running from ansible-container to OL VM took 7 hours - no timing in log on-screen - where can I find the log files? @@ -146,7 +146,7 @@ create a new directory under inventory (e.g. copy the existing "dbfs" directory 1. software_src.yml choose e.g. source directory, local or nfs, unzip (Y/N), etc. 1. dev_sec.yml choose hardening options in directory "has", you can see other possibilities -1. database.yml, exact sizing of Tablepsaces, memory, etc. +1. database.yml, exact sizing of Tablespaces, memory, etc. 1. asm.yml (setup ASM disks) diff --git a/doc/roles.adoc b/doc/roles.adoc index d0ef7066a..80503cb6a 100644 --- a/doc/roles.adoc +++ b/doc/roles.adoc @@ -26,7 +26,7 @@ filesystem (ext4, xfs, btrfs) etc). + If you want to create your database on a filesystem (instead of ASM) this is where you define the layout. * Install required OS packages -* Change kernel paramemeters +* Change kernel parameters * Set up pam.d/limits config * Configures Hugepages (as a percentage of total RAM) * Disables transparent hugepages diff --git a/doc/vagrant.adoc b/doc/vagrant.adoc index 79f69d6cc..2540cf0cb 100644 --- a/doc/vagrant.adoc +++ b/doc/vagrant.adoc @@ -20,7 +20,7 @@ no support for Mac with M1 ** 16 GB RAM ** 150 GB free Disk space + The free space is needed in your home directory in Windows. -** Admin priviledges on Host machine +** Admin privileges on Host machine ** Hyper-V disabled ** no WSL/WSL2 for installation + While you may try it, the documentation states that Hyper-V should be completely disabled and that no WSL/WSL2 is used.