Skip to content

Commit 994ab51

Browse files
RendanicRendanic
committed
ansible-oracle Documentation
1 parent 9d43068 commit 994ab51

File tree

5 files changed

+218
-36
lines changed

5 files changed

+218
-36
lines changed

‎README.adoc‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121

2222
### Next Steps
2323

24-
1. Read the full documentation <https://github.com/oravirt/ansible-oracle/tree/master/doc>
25-
1. How to develop in ansible-oracle <https://github.com/oravirt/ansible-oracle/blob/master/doc/development.adoc>
26-
1. List of roles in ansible-oracle <https://github.com/oravirt/ansible-oracle/blob/master/doc/roles.adoc>
24+
1. [APEX and ORDS in `ansible-oracle`](doc/guides/apex_ords.adoc)
25+
2. [How to develop in ansible-oracle](doc/development.adoc)
26+
3. [List of roles in ansible-oracle](doc/roles.adoc)
2727

2828

2929
## Pre-requisites

‎changelogs/fragments/doc1.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
major_changes:
3+
- "ansible-oracle Documentation fixes (oravirt#473)"

‎doc/featurelist.adoc‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Redhat Enterprise Linux
3535
|6 <<table1footnote,^[1]^>> +
3636
7 <<table1footnote,^[1]^>> +
3737
8 +
38-
9 (experimental!) <<table1footnote,^[5]^>>
38+
9
3939

4040
|SuSE Linux Enterprise Server<<table1footnote,^[3]^>>
4141
|15, 15.3
@@ -138,6 +138,10 @@ a|OneOff Patches<<table1footnote,^[11]^>>
138138
|automatic datapatch execution<<table1footnote,^[11]^>>
139139
|Patch Download from Oracle
140140
141+
|Oracle APEX (experimental!)
142+
a|Installation of APEX in PDB. Not supported for CDB or nonCDB.
143+
|{supportedfrom19}
144+
141145
|Environment script
142146
a|dynamic shell environment link:https://github.com/opitzconsulting/oracle-scripts[`ocenv`] for Oracle
143147
|{supportedfrom12}
@@ -154,6 +158,8 @@ a|dynamic shell environment link:https://github.com/opitzconsulting/oracle-scrip
154158
Please do not use this feature in production environments.
155159
[[table1footnote]]^3^::
156160
Limited support. Not tested for Oracle Restart & Grid-Infrastructure
161+
[[table1footnote]]^4^::
162+
Only tested with PDB on 19c+. May be work in nonCDB as well but noch in CDB.
157163
[[table1footnote]]^5^::
158164
in development and not implemented at the moment.
159165
[[table1footnote]]^6^::

‎doc/guides/apex_ords.adoc‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
:toc:
2+
:toc-placement!:
3+
:toclevels: 4
4+
toc::[]
5+
6+
:sectnums:
7+
:sectnumlevels: 4
8+
9+
== Setup APEX and ORDS
10+
11+
IMPORTANT: The installation of APEX and ORDS with `ansible-oracle` is currently _experimental_.
12+
13+
=== Requirements
14+
15+
==== APEX
16+
17+
- RDBMS 19c or newer
18+
- APEX 20.x or newer is mandatory for RDBMS 19c
19+
- Tested with APEX 23.2, 24.1 - may work with older versions as well
20+
- Installation is tested with PDB only.
21+
- CDB and nonCDB is not supported at the moment.
22+
- Download ZIP from Oracle with Playbook `patch_download.yml` supported for Version 22.1 or newer
23+
- APEX only with ORDS - no old APEX Listener
24+
25+
Important Notes:
26+
27+
- Primary Note for Oracle APEX Upgrades (Doc ID 1088970.1)
28+
29+
Known Issues:
30+
31+
- ADMIN password of INTERNAL Workspace is wrong after APEX upgrade
32+
Silent script to reset ADMIN password depends on APEX Relöease. +
33+
There was no reliable solution found for the moment...
34+
35+
==== ORDS
36+
37+
- OracleLinux 8 or 9 only
38+
- Installation with ords.rpm from `public-yum.oracle.com`
39+
- Limited database configuration - see documentation
40+
41+
=== APEX Configuration
42+
43+
IMPORTANT: Install APEX before ORDS - otherwise, the ORDS will not detect and configure APEX. +
44+
ORDS is only tested with existing APEX installation.
45+
46+
==== Mandatory variables
47+
48+
The following global variables are needed for an APEX installation.
49+
50+
.Mandatory variables
51+
[options="header,footer"]
52+
|=======================
53+
|Value |Description
54+
|`oraapex_default_admin_password` | The parameter is mandatory, because it is the only way to configure a password for the admin user at the moment.
55+
|=======================
56+
57+
.Optional variables
58+
[options="header,footer"]
59+
|=======================
60+
|Value |Description
61+
|`oraapex_base`
62+
| Default: `{{ oracle_base }}/product` +
63+
The unzip is done into `{{ oraapex_base }}/apex_<APEX Version>`
64+
|`oraapex_default_tablespace`
65+
| Default: `SYSAUX` +
66+
Could be set in each PDB.
67+
|`oraapex_default_files_tablespace`
68+
| Default: `SYSAUX` +
69+
Could be set in each PDB.
70+
|`oraapex_default_temp_tablespace`
71+
| Default: `TEMP` +
72+
Could be set in each PDB.
73+
|=======================
74+
75+
==== APEX in PDB
76+
77+
APEX can be installed in each PDB.
78+
79+
.mandatory Variables in `oracle_pdbs`
80+
[options="header,footer"]
81+
|=======================
82+
|Value |Description
83+
| `apex_state`
84+
| State for APEX installation. +
85+
Only `present` supported at the moment.
86+
| `apex_version`
87+
| Version of APEX. +
88+
Is used to download the Archive from Oracle.
89+
|=======================
90+
91+
.optional Variables in `oracle_pdbs`
92+
[options="header,footer"]
93+
|=======================
94+
|Value |Description
95+
| `oraapex_tablespace`
96+
| Custom APEX Tablespace.
97+
| `oraapex_files_tablespace`
98+
| Custom APEX Tablespace for files.
99+
| `oraapex_temp_tablespace`
100+
| Custom APEX temporary Tablespace.
101+
| `apex_patchid`
102+
| Patchid for _PSE BUNDLE FOR APEX_
103+
|=======================
104+
105+
IMPORTANT: The example shows the minimum attributes for an APEX installation. +
106+
That's not the minimum needed to create a PDB.
107+
108+
.Example `oracle_pdbs`
109+
----
110+
oracle_pdbs:
111+
- cdb: CDB1
112+
pdb_name: PDB1
113+
state: present
114+
apex_state: present
115+
apex_version: 24.1
116+
apex_patchid: 36695709
117+
----
118+
119+
IMPORTANT: `oraapex` does not use the default passwords from `ansible-oracle`. +
120+
You have to define them in `dbpasswords`.
121+
122+
The user `APEX_PUBLIC_ROUTER` is new in APEX 24.1. +
123+
`oraapex` checks for an existing password regardless of the version of APEX.
124+
125+
.Example `dbpasswords` for APEX in a PDB with mandatory values for `oraapex`
126+
----
127+
dbpasswords:
128+
CDB1:
129+
PDB1:
130+
apex_public_router: ords123
131+
apex_public_user: ords123
132+
apex_rest_public_user: ords123
133+
ords_public_user: ords123
134+
----
135+
136+
IMPORTANT: Do not forget to download the APEX Patch when `apex_patchid` is set in `oracle_pdbs`. +
137+
`opatch_install` is very important, because these Patches are not applied with OPatch.
138+
139+
.Example `oracle_sw_patches`
140+
----
141+
oracle_sw_patches:
142+
- filename: p36695709_2410_Generic.zip
143+
patchid: 36695709
144+
version: 24.1
145+
description: PSE BUNDLE FOR APEX 24.1
146+
opatch_needed: false
147+
----
148+
149+
==== Playbook execution
150+
151+
The installation of APEX is part of `playbooks/manage_db.yml`. +
152+
This allows the creation of custom Tablespaces, Profiles etc. for APEX, without the need to use a dedicated Playbook.
153+
154+
155+
=== ORDS Configuration
156+
157+
IMPORTANT: The configuration of ORDS is limited to the following variables at the moment.
158+
159+
.Mandatory variables in `oraords_db_pools`
160+
[options="header,footer"]
161+
|=======================
162+
|Value |Description
163+
| db_pool | Database Pool
164+
| pdb_name | PDB-Name of Target
165+
| service | Database Service Name
166+
| port | Listener Port
167+
| host | Database Hostname
168+
|=======================
169+
170+
.Optional variables in `oraords_db_pools`
171+
[options="header,footer"]
172+
|=======================
173+
|Value |Description
174+
| feature_db_api | true / false (Default)
175+
| feature_rest_enabled_sql | true / false (Default)
176+
| feature_sdw | true / false (Default)
177+
|=======================
178+
179+
----
180+
oraords_db_pools:
181+
- db_pool: default
182+
pdb_name: PDB1
183+
admin_user: sys
184+
service: pdb1
185+
port: 1521
186+
host: "{{ inventory_hostname }}"
187+
feature_db_api: true
188+
feature_rest_enabled_sql: true
189+
feature_sdw: true
190+
----
191+
192+
The passwords for Admin- and ORDS-User are defined in `oraords_db_pools_password`. +
193+
They are set in a dedicated variable to prevent `no_log=true` in loops over `oraords_db_pools`. +
194+
Referencing `dbpasswords` helps to reduce redundancy for passwords.
195+
196+
----
197+
oraords_db_pools_password:
198+
default:
199+
admin_password: "{{ dbpasswords['DB1']['sys'] }}"
200+
ords_password: "{{ dbpasswords['DB1']['PDB1']['ords_public_user'] }}"
201+
----
202+
203+
==== Playbook execution
204+
205+
The Playbook `playbooks/manage_ords.yml` is used to install ORDS.

0 commit comments

Comments
 (0)