Skip to content

Commit 5aaafdf

Browse files
yunus-qureshiyunus-qureshi
committed
Merge remote-tracking branch 'github/main'
2 parents 1356892 + 86f22f5 commit 5aaafdf

9 files changed

+105
-80
lines changed

‎Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,3 +192,4 @@ catalog-build: opm ## Build a catalog image.
192192
.PHONY: catalog-push
193193
catalog-push: ## Push a catalog image.
194194
$(MAKE) docker-push IMG=$(CATALOG_IMG)
195+

‎config/samples/sidb/oraclerestdataservice_apex.yaml

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,6 @@
33
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
44
#
55

6-
apiVersion: v1
7-
kind: Secret
8-
metadata:
9-
name: ords-secret
10-
namespace: default
11-
type: Opaque
12-
stringData:
13-
## Specify your ORDS password here
14-
oracle_pwd:
15-
16-
---
17-
18-
apiVersion: v1
19-
kind: Secret
20-
metadata:
21-
name: apex-secret
22-
namespace: default
23-
type: Opaque
24-
stringData:
25-
## Specify your APEX password here
26-
## This password should complete the following requirements:
27-
## 1. Contain at least 6 characters.
28-
## 2. Contain at least one numeric character (0123456789).
29-
## 3. Contain at least one punctuation character (!"#$%&()``*+,-/:;?_).
30-
## 4. Contain at least one uppercase alphabetic character.
31-
oracle_pwd:
32-
33-
---
34-
356
apiVersion: database.oracle.com/v1alpha1
367
kind: OracleRestDataService
378
metadata:

‎config/samples/sidb/oraclerestdataservice_create.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
33
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
44
#
55

6-
apiVersion: v1
7-
kind: Secret
8-
metadata:
9-
name: ords-secret
10-
namespace: default
11-
type: Opaque
12-
stringData:
13-
## Specify your ORDS password here
14-
oracle_pwd:
15-
16-
---
17-
186
apiVersion: database.oracle.com/v1alpha1
197
kind: OracleRestDataService
208
metadata:

‎config/samples/sidb/oraclerestdataservice_secrets.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#
2+
# Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
3+
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
4+
#
5+
6+
## ORDS password secret
7+
apiVersion: v1
8+
kind: Secret
9+
metadata:
10+
name: ords-secret
11+
namespace: default
12+
type: Opaque
13+
stringData:
14+
## Specify your ORDS password here
15+
oracle_pwd:
16+
17+
---
18+
19+
## APEX password secret
20+
apiVersion: v1
21+
kind: Secret
22+
metadata:
23+
name: apex-secret
24+
namespace: default
25+
type: Opaque
26+
stringData:
27+
## Specify your APEX password here
28+
## This password should complete the following requirements:
29+
## 1. Contain at least 6 characters.
30+
## 2. Contain at least one numeric character (0123456789).
31+
## 3. Contain at least one punctuation character (!"#$%&()``*+,-/:;?_).
32+
## 4. Contain at least one uppercase alphabetic character.
33+
oracle_pwd:

‎config/samples/sidb/singleinstancedatabase_create.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
33
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
44
#
55

6-
apiVersion: v1
7-
kind: Secret
8-
metadata:
9-
name: db-admin-secret
10-
namespace: default
11-
type: Opaque
12-
stringData:
13-
# Specify your DB password here
14-
oracle_pwd:
15-
16-
---
17-
186
apiVersion: database.oracle.com/v1alpha1
197
kind: SingleInstanceDatabase
208
metadata:

‎config/samples/sidb/singleinstancedatabase_express.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
33
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
44
#
55

6-
apiVersion: v1
7-
kind: Secret
8-
metadata:
9-
name: xedb-admin-secret
10-
namespace: default
11-
type: Opaque
12-
stringData:
13-
## Specify your DB password here
14-
oracle_pwd:
15-
16-
---
17-
186
apiVersion: database.oracle.com/v1alpha1
197
kind: SingleInstanceDatabase
208
metadata:

‎config/samples/sidb/singleinstancedatabase_prebuiltdb.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
33
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
44
#
55

6-
apiVersion: v1
7-
kind: Secret
8-
metadata:
9-
name: prebuiltdb-admin-secret
10-
namespace: default
11-
type: Opaque
12-
stringData:
13-
## Specify your DB password here
14-
oracle_pwd:
15-
16-
---
17-
186
apiVersion: database.oracle.com/v1alpha1
197
kind: SingleInstanceDatabase
208
metadata:

‎config/samples/sidb/singleinstancedatabase_secrets.yaml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
#
2+
# Copyright (c) 2022, Oracle and/or its affiliates.
3+
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
4+
#
5+
6+
## Database Admin Password Secret
7+
apiVersion: v1
8+
kind: Secret
9+
metadata:
10+
name: db-admin-secret
11+
namespace: default
12+
type: Opaque
13+
stringData:
14+
## Specify your DB password here
15+
oracle_pwd:
16+
17+
---
18+
19+
## Oracle Database XE Admin password secret
20+
apiVersion: v1
21+
kind: Secret
22+
metadata:
23+
name: prebuiltdb-admin-secret
24+
namespace: default
25+
type: Opaque
26+
stringData:
27+
## Specify your DB password here
28+
oracle_pwd:
29+
30+
---
31+
32+
## Prebuilt-Database Admin password secret
33+
apiVersion: v1
34+
kind: Secret
35+
metadata:
36+
name: xedb-admin-secret
37+
namespace: default
38+
type: Opaque
39+
stringData:
40+
## Specify your DB password here
41+
oracle_pwd:

‎docs/sidb/README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ The `adminPassword` field in the above `singleinstancedatabase.yaml` file refers
137137

138138
Create this secret using the following command as an example:
139139

140-
kubectl create secret generic admin-secret --from-literal=oracle_pwd=<specify password here>
140+
kubectl create secret generic db-admin-secret --from-literal=oracle_pwd=<specify password here>
141141

142-
This command creates a secret named `admin-secret`, with the key `oracle_pwd` mapped to the actual password specified in the command.
142+
This command creates a secret named `db-admin-secret`, with the key `oracle_pwd` mapped to the actual password specified in the command.
143143

144144
### Create a Database
145145

@@ -201,6 +201,13 @@ This command pulls the XE image uploaded on the [Oracle Container Registry](http
201201
- For XE database, only single replica mode (i.e. `replicas: 1`) is supported.
202202
- For XE database, you **cannot change** the init parameters i.e. `cpuCount, processes, sgaTarget or pgaAggregateTarget`.
203203
204+
#### Additional Information
205+
You are required to specify the database admin password secret in the corresponding YAML file. The default values mentioned in the `adminPassword.secretName` fields of [singleinstancedatabase_create.yaml](../../config/samples/sidb/singleinstancedatabase_create.yaml), [singleinstancedatabase_prebuiltdb.yaml](../../config/samples/sidb/singleinstancedatabase_prebuiltdb.yaml) and [singleinstancedatabase_express.yaml](../../config/samples/sidb/singleinstancedatabase_express.yaml) files are `db-admin-secret`, `prebuiltdb-admin-secret`, and `xedb-admin-secret` respectively. You can create these secrets manually by using the sample command mentioned in the [Template YAML](#template-yaml) section. Alternatively, you can create these secrets by filling the passwords in the **[singleinstancedatabase_secrets.yaml](../../config/samples/sidb/singleinstancedatabase_secrets.yaml)** file and applying it using the command below:
206+
207+
```bash
208+
kubectl apply -f singleinstancedatabase_secrets.yaml
209+
```
210+
204211
### Connecting to Database
205212
206213
Creating a new database instance takes a while. When the `status` column returns the response `Healthy`, the Database is open for connections.
@@ -653,6 +660,20 @@ $ kubectl apply -f oraclerestdataservice_create.yaml
653660
```
654661
After this command completes, ORDS is installed in the container database (CDB) of the Single Instance Database.
655662
663+
##### NOTE:
664+
You are required to specify the ORDS secret in the [oraclerestdataservice_create.yaml](../../config/samples/sidb/oraclerestdataservice_create.yaml) file. The default value mentioned in the `adminPassword.secretName` field is `ords-secret`. You can create this secret manually by using the following command:
665+
666+
```bash
667+
kubectl create secret generic ords-secret --from-literal=oracle_pwd=<specify password here>
668+
```
669+
670+
Alternatively, you can create this secret and the APEX secret by filling the passwords in the **[oraclerestdataservice_secrets.yaml](../../config/samples/sidb/oraclerestdataservice_secrets.yaml)** file and applying it using the command below:
671+
672+
```bash
673+
kubectl apply -f singleinstancedatabase_secrets.yaml
674+
```
675+
The APEX secret created above, will be used while [installing APEX](#apex-installation).
676+
656677
#### Creation Status
657678
658679
Creating a new ORDS instance takes a while. To check the status of the ORDS instance, use the following command:
@@ -809,7 +830,13 @@ The `OraOperator` facilitates installation of APEX in the database and also conf
809830

810831
kubectl apply -f oraclerestdataservice_apex.yaml
811832

812-
* The APEX Password is used as a common password for `APEX_PUBLIC_USER, APEX_REST_PUBLIC_USER, APEX_LISTENER` and Apex administrator (username: `ADMIN`) mapped to secretKey.
833+
* The APEX Password is used as a common password for `APEX_PUBLIC_USER, APEX_REST_PUBLIC_USER, APEX_LISTENER` and Apex administrator (username: `ADMIN`) mapped to secretKey. You can create APEX secret using the following command:
834+
835+
```bash
836+
kubectl create secret generic apex-secret --from-literal=oracle_pwd=<specify password here>
837+
```
838+
Please refer [this](#note) section for APEX secret creation using the **[oraclerestdataservice_secrets.yaml](../../config/samples/sidb/oraclerestdataservice_secrets.yaml)** file.
839+
813840
* The status of ORDS turns to `Updating` during APEX configuration, and changes to `Healthy` after successful configuration. You can also check status by using the following command:
814841

815842

0 commit comments

Comments
 (0)