You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/onpremdb/README.md
+35-13Lines changed: 35 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@
3
3
The On-Premise Database Controller enables provisioning of Oracle Databases (PDBs) both on a Kubernetes cluster or outside of a Kubernetes cluster. The following sections explain the setup and functionality of this controller:
4
4
5
5
*[Prerequisites for On-Premise Database Controller](ORACLE_ONPREMDB_CONTROLLER_README.md#prerequisites-and-setup)
*[Validation and Errors](ORACLE_ONPREMDB_CONTROLLER_README.md#validation-and-errors)
@@ -14,7 +14,7 @@ The On-Premise Database Controller enables provisioning of Oracle Databases (PDB
14
14
+### Prepare CDB for PDB Lifecycme Management (PDB-LM)
15
15
16
16
Pluggable Database management is performed in the Container Database (CDB) and includes create, clone, plug, unplug, delete, modify and map operations.
17
-
You cannot have an ORDS enabled schema in the container database. To perform the PDB lifecycle management operations, the default CDB administrator credentials must be defined.
17
+
You cannot have an ORDS enabled schema in the container database. To perform the PDB lifecycle management operations, the default CDB administrator credentials must be defined.
18
18
19
19
To define the default CDB administrator credentials, perform the following steps on the target CDB(s) where PDB-LM operations are to be performed:
20
20
@@ -26,34 +26,56 @@ The On-Premise Database Controller enables provisioning of Oracle Databases (PDB
26
26
```
27
27
+### Building the Oracle REST Data Service (ORDS) Image
28
28
29
-
Oracle On-Premise Database controller enhances the Oracle REST Data Services (ORDS) image to enable it for PDB Lifecycle Management. You can build this image by following the instructions below:
30
-
* After cloning the repository, go to the "ords" folder, and run:
29
+
Oracle On-Premise Database controller enhances the Oracle REST Data Services (ORDS) image to enable it for PDB Lifecycle Management. You can build this image by following the instructions below:
30
+
* After cloning the repository, go to the "ords" folder, and run:
31
31
```sh
32
32
docker build -t oracle/ords-dboper:latest .
33
33
```
34
-
* Once the image is ready, you need to push it to your Docker Images Repository to pull it during CDB Resource creation.
34
+
35
+
> **_NOTE1:_** Required file to build this image is Oracle Rest Data Services 'ords-< version >.zip',
36
+
you can download such file from http://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html
37
+
38
+
> **_NOTE2:_** to build the ords image you need to Accept the Oracle Standard Terms and Restrictions for Java/jdk repository on Oracle Container Registry at https://container-registry.oracle.com
39
+
40
+
> **_NOTE3:_** docker needs access to container-registry.oracle.com for which following command may be required:
41
+
```sh
42
+
docker login container-registry.oracle.com
43
+
```
44
+
>**_NOTE4:_**if you are going to deploy inside minikube, you need to switch the env to it, issuing:
45
+
```sh
46
+
eval$(minikube docker-env)
47
+
```
48
+
* Once the image is ready, you may need to push it to your Docker Images Repository to pull it during CDB controller resource creation.
35
49
36
50
+ ### Install cert-manager
37
51
38
52
Validating webhook is an endpoint Kubernetes can invoke prior to persisting resources in ETCD. This endpoint returns a structured response indicating whether the resource should be rejected or accepted and persisted to the datastore.
39
53
40
54
Webhook requires a TLS certificate that the apiserver is configured to trust . Install the cert-manager with the following command:
The Oracle Database Operator creates the CDB kind as a custom resource that models a target CDB as a native Kubernetes object. This is only used to create Pods to connect to the target CDB to perform PDB-LM operations. These CDB resources can be scaled up and down based on the expected load using replicas. Each CDB resource follows the CDB CRD as defined here: [config/crd/bases/database.oracle.com_cdbs.yaml](../../config/crd/bases/database.oracle.com_cdbs.yaml)
@@ -77,7 +99,7 @@ The On-Premise Database Controller enables provisioning of Oracle Databases (PDB
77
99
78
100
A sample .yaml file is available here: [config/samples/onpremdb/cdb.yaml](../../config/samples/onpremdb/cdb.yaml)
79
101
80
-
**Note:** The password and username fields in the above `cdb.yaml` yaml are Kubernetes Secrets. Please see the section [Kubernetes Secrets](ORACLE_ONPREMDB_CONTROLLER_README.md#kubernetes-secrets) for more information.
102
+
**Note:** The password and username fields in the above `cdb.yaml` yaml are Kubernetes Secrets. Please see the section [Kubernetes Secrets](ORACLE_ONPREMDB_CONTROLLER_README.md#kubernetes-secrets) for more information.
81
103
82
104
+ ### Check the status of the all CDBs
83
105
```sh
@@ -153,7 +175,7 @@ The On-Premise Database Controller enables provisioning of Oracle Databases (PDB
153
175
+ ### Map PDB
154
176
155
177
This is used to map an existing PDB in the CDB as a Kubernetes Custom Resource.
156
-
A sample .yaml file is available here: [config/samples/onpremdb/pdb_map.yaml](../../config/samples/onpremdb/pdb_map.yaml)
178
+
A sample .yaml file is available here: [config/samples/onpremdb/pdb_map.yaml](../../config/samples/onpremdb/pdb_map.yaml)
157
179
158
180
## Validation and Errors
159
181
@@ -210,4 +232,4 @@ $ kubectl get pdbs -A
210
232
NAMESPACE NAME CONNECT STRING CDB NAME PDB NAME PDB SIZE STATUS MESSAGE
211
233
oracle-database-operator-system pdb1 democdb demotest1 Failed Secret not found:pdb12-secret
212
234
oracle-database-operator-system pdb2 democdb demotest2 Failed ORA-65016: FILE_NAME_CONVERT must be specified...
0 commit comments