Merge pull request #34 from abhisbyk/AbhiK_sidb_yaml_fixes

yunus-qureshi · web-flow · commit 86f22f5f1837 · 2022-09-13T12:22:48.000+05:30
Sample SIDB YAML file changes
diff --git a/config/samples/sidb/oraclerestdataservice_apex.yaml b/config/samples/sidb/oraclerestdataservice_apex.yaml
@@ -3,35 +3,6 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 #
 
-apiVersion: v1
-kind: Secret
-metadata:
-  name: ords-secret
-  namespace: default
-type: Opaque
-stringData:
-  ## Specify your ORDS password here
-  oracle_pwd: 
-
----
-
-apiVersion: v1
-kind: Secret
-metadata:
-  name: apex-secret
-  namespace: default
-type: Opaque
-stringData:
-  ## Specify your APEX password here
-  ## This password should complete the following requirements:
-  ## 1. Contain at least 6 characters.
-  ## 2. Contain at least one numeric character (0123456789).
-  ## 3. Contain at least one punctuation character (!"#$%&()``*+,-/:;?_).
-  ## 4. Contain at least one uppercase alphabetic character.
-  oracle_pwd: 
-
----
-
 apiVersion: database.oracle.com/v1alpha1
 kind: OracleRestDataService
 metadata:
diff --git a/config/samples/sidb/oraclerestdataservice_create.yaml b/config/samples/sidb/oraclerestdataservice_create.yaml
@@ -3,18 +3,6 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 #
 
-apiVersion: v1
-kind: Secret
-metadata:
-  name: ords-secret
-  namespace: default
-type: Opaque
-stringData:
-  ## Specify your ORDS password here
-  oracle_pwd: 
-
----
-
 apiVersion: database.oracle.com/v1alpha1
 kind: OracleRestDataService
 metadata:
diff --git a/config/samples/sidb/oraclerestdataservice_secrets.yaml b/config/samples/sidb/oraclerestdataservice_secrets.yaml
@@ -0,0 +1,33 @@
+#
+# Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+#
+
+## ORDS password secret
+apiVersion: v1
+kind: Secret
+metadata:
+  name: ords-secret
+  namespace: default
+type: Opaque
+stringData:
+  ## Specify your ORDS password here
+  oracle_pwd: 
+
+---
+
+## APEX password secret
+apiVersion: v1
+kind: Secret
+metadata:
+  name: apex-secret
+  namespace: default
+type: Opaque
+stringData:
+  ## Specify your APEX password here
+  ## This password should complete the following requirements:
+  ## 1. Contain at least 6 characters.
+  ## 2. Contain at least one numeric character (0123456789).
+  ## 3. Contain at least one punctuation character (!"#$%&()``*+,-/:;?_).
+  ## 4. Contain at least one uppercase alphabetic character.
+  oracle_pwd:
diff --git a/config/samples/sidb/singleinstancedatabase_create.yaml b/config/samples/sidb/singleinstancedatabase_create.yaml
@@ -3,18 +3,6 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 #
 
-apiVersion: v1
-kind: Secret
-metadata:
-  name: db-admin-secret
-  namespace: default
-type: Opaque
-stringData:
-  # Specify your DB password here
-  oracle_pwd: 
-
----
-
 apiVersion: database.oracle.com/v1alpha1
 kind: SingleInstanceDatabase
 metadata:
diff --git a/config/samples/sidb/singleinstancedatabase_express.yaml b/config/samples/sidb/singleinstancedatabase_express.yaml
@@ -3,18 +3,6 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 #
 
-apiVersion: v1
-kind: Secret
-metadata:
-  name: xedb-admin-secret
-  namespace: default
-type: Opaque
-stringData:
-  ## Specify your DB password here
-  oracle_pwd: 
-
----
-
 apiVersion: database.oracle.com/v1alpha1
 kind: SingleInstanceDatabase
 metadata:
diff --git a/config/samples/sidb/singleinstancedatabase_prebuiltdb.yaml b/config/samples/sidb/singleinstancedatabase_prebuiltdb.yaml
@@ -3,18 +3,6 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 #
 
-apiVersion: v1
-kind: Secret
-metadata:
-  name: prebuiltdb-admin-secret
-  namespace: default
-type: Opaque
-stringData:
-  ## Specify your DB password here
-  oracle_pwd: 
-
----
-
 apiVersion: database.oracle.com/v1alpha1
 kind: SingleInstanceDatabase
 metadata:
diff --git a/config/samples/sidb/singleinstancedatabase_secrets.yaml b/config/samples/sidb/singleinstancedatabase_secrets.yaml
@@ -0,0 +1,41 @@
+#
+# Copyright (c) 2022, Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
+#
+
+## Database Admin Password Secret
+apiVersion: v1
+kind: Secret
+metadata:
+  name: db-admin-secret
+  namespace: default
+type: Opaque
+stringData:
+  ## Specify your DB password here
+  oracle_pwd:
+
+---
+
+## Oracle Database XE Admin password secret
+apiVersion: v1
+kind: Secret
+metadata:
+  name: prebuiltdb-admin-secret
+  namespace: default
+type: Opaque
+stringData:
+  ## Specify your DB password here
+  oracle_pwd:
+
+---
+
+## Prebuilt-Database Admin password secret
+apiVersion: v1
+kind: Secret
+metadata:
+  name: xedb-admin-secret
+  namespace: default
+type: Opaque
+stringData:
+  ## Specify your DB password here
+  oracle_pwd:
diff --git a/docs/sidb/README.md b/docs/sidb/README.md
@@ -135,9 +135,9 @@ The `adminPassword` field in the above `singleinstancedatabase.yaml` file refers
 
 Create this secret using the following command as an example:
 
-    kubectl create secret generic admin-secret --from-literal=oracle_pwd=<specify password here>
+    kubectl create secret generic db-admin-secret --from-literal=oracle_pwd=<specify password here>
 
-This command creates a secret named `admin-secret`, with the key `oracle_pwd` mapped to the actual password specified in the command.
+This command creates a secret named `db-admin-secret`, with the key `oracle_pwd` mapped to the actual password specified in the command.
 
 ### Create a Database
 
@@ -199,6 +199,13 @@ This command pulls the XE image uploaded on the [Oracle Container Registry](http
 - For XE database, only single replica mode (i.e. `replicas: 1`) is supported.
 - For XE database, you **cannot change** the init parameters i.e. `cpuCount, processes, sgaTarget or pgaAggregateTarget`.
 
+#### Additional Information
+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:
+
+```bash
+kubectl apply -f singleinstancedatabase_secrets.yaml
+```
+
 ### Connecting to Database
 
 Creating a new database instance takes a while. When the `status` column returns the response `Healthy`, the Database is open for connections.
@@ -588,6 +595,20 @@ $ kubectl apply -f oraclerestdataservice_create.yaml
 ```
 After this command completes, ORDS is installed in the container database (CDB) of the Single Instance Database.
 
+##### NOTE:
+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:
+
+```bash
+kubectl create secret generic ords-secret --from-literal=oracle_pwd=<specify password here>
+```
+
+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:
+
+```bash
+kubectl apply -f singleinstancedatabase_secrets.yaml
+```
+The APEX secret created above, will be used while [installing APEX](#apex-installation).
+
 #### Creation Status
   
 Creating a new ORDS instance takes a while. To check the status of the ORDS instance, use the following command:
@@ -744,7 +765,13 @@ The `OraOperator` facilitates installation of APEX in the database and also conf
 
       kubectl apply -f oraclerestdataservice_apex.yaml
 
-* 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.
+* 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:
+
+  ```bash
+  kubectl create secret generic apex-secret --from-literal=oracle_pwd=<specify password here>
+  ``` 
+  Please refer [this](#note) section for APEX secret creation using the **[oraclerestdataservice_secrets.yaml](../../config/samples/sidb/oraclerestdataservice_secrets.yaml)** file.
+
 * 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:
 
 
