Fix issue 3

jpverma85 · rcitton-oracle · commit 223d2c49b4a7 · 2022-06-28T15:13:46.000Z
diff --git a/config/samples/onpremdb/pdb_create.yaml b/config/samples/onpremdb/pdb_create.yaml
diff --git a/config/samples/onpremdb/pdb_map.yaml b/config/samples/onpremdb/pdb_map.yaml
diff --git a/docs/onpremdb/README.md b/docs/onpremdb/README.md
@@ -12,7 +12,7 @@ NOTE: The target CDB (for which the PDB life cycle management is needed) **can a
 
 To deploy OraOperator, use this [Oracle Database Operator for Kubernetes](https://github.com/oracle/oracle-database-operator/blob/main/README.md) step-by-step procedure.
 
-After the Oracle Database Operator is deployed, you can see the DB Operator Pods running in the Kubernetes Cluster. As part of the OraOperator deployment, the On-Prem Database Controller is deployed as a CRD (Custom Resource Definition). The following output is an example of such a deployment:
+After the Oracle Database Operator is deployed, you can see the DB Operator Pods running in the Kubernetes Cluster. As part of the OraOperator deployment, the On-Prem Database Controller is deployed and we can see the CRDs (Custom Resource Definition) for CDB and PDB in the list of CRDs. The following output is an example of such a deployment:
 ```
 [root@test-server oracle-database-operator]# kubectl get ns
 NAME                              STATUS   AGE
@@ -48,7 +48,7 @@ autonomouscontainerdatabases.database.oracle.com   2022-06-22T01:21:36Z
 autonomousdatabasebackups.database.oracle.com      2022-06-22T01:21:36Z
 autonomousdatabaserestores.database.oracle.com     2022-06-22T01:21:37Z
 autonomousdatabases.database.oracle.com            2022-06-22T01:21:37Z
-cdbs.database.oracle.com                           2022-06-22T01:21:37Z <<<< CRD for CDB
+cdbs.database.oracle.com                           2022-06-22T01:21:37Z <<<<
 certificaterequests.cert-manager.io                2022-06-21T17:03:46Z
 certificates.cert-manager.io                       2022-06-21T17:03:47Z
 challenges.acme.cert-manager.io                    2022-06-21T17:03:47Z
@@ -57,7 +57,7 @@ dbcssystems.database.oracle.com                    2022-06-22T01:21:38Z
 issuers.cert-manager.io                            2022-06-21T17:03:49Z
 oraclerestdataservices.database.oracle.com         2022-06-22T01:21:38Z
 orders.acme.cert-manager.io                        2022-06-21T17:03:49Z 
-pdbs.database.oracle.com                           2022-06-22T01:21:39Z <<<< CRD for PDB
+pdbs.database.oracle.com                           2022-06-22T01:21:39Z <<<<
 shardingdatabases.database.oracle.com              2022-06-22T01:21:39Z
 singleinstancedatabases.database.oracle.com        2022-06-22T01:21:40Z
 ```
@@ -179,11 +179,11 @@ To create a CDB CRD, a sample .yaml file is available here: [config/samples/onpr
 
 The Oracle Database Operator On-Prem Controller creates the PDB kind as a custom resource that models a PDB as a native Kubernetes object. There is a one-to-one mapping between the actual PDB and the Kubernetes PDB Custom Resource. You cannot have more than one Kubernetes resource for a target PDB. This PDB resource can be used to perform PDB-LM operations by specifying the action attribute in the PDB Specs. Each PDB resource follows the PDB CRD as defined here: [config/crd/bases/database.oracle.com_pdbs.yaml](../../../config/crd/bases/database.oracle.com_pdbs.yaml)
 
-To create a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb.yaml](../../../config/samples/onpremdb/pdb.yaml)
+To create a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb_create.yaml](../../config/samples/onpremdb/pdb_create.yaml)
 
 # Use Cases for PDB Lifecycle Management Operations using Oracle DB Operator On-Prem Controller
 
-Using Oracle DB Operator On-Prem Controller, you can perform the following PDB-LM operations: CREATE, CLONE, MODIFY, DELETE, STATUS, PLUG, UNPLUG
+Using Oracle DB Operator On-Prem Controller, you can perform the following PDB-LM operations: CREATE, CLONE, MODIFY, DELETE, UNPLUG, PLUG.
 
 1. [Create PDB](./provisioning/create_pdb.md)
 2. [Clone PDB](./provisioning/clone_pdb.md)
diff --git a/docs/onpremdb/provisioning/clone_pdb.md b/docs/onpremdb/provisioning/clone_pdb.md
@@ -2,6 +2,8 @@
 
 In this use case, a PDB is cloned using Oracle DB Operator On-Prem controller.
 
+To clone a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb_clone.yaml](../../../config/samples/onpremdb/pdb_clone.yaml)
+
 **NOTE:** It is assumed that before this step, you have followed the [prerequisite](./../README.md#prerequsites-to-manage-pdb-life-cycle-using-oracle-db-operator-on-prem-database-controller) steps.
 
 This example uses `clone_pdb.yaml` to clone a PDB using Oracle DB Operator On-Prem Controller with:
diff --git a/docs/onpremdb/provisioning/create_pdb.log b/docs/onpremdb/provisioning/create_pdb.log
@@ -42,7 +42,7 @@ data:
 
 -- This is the .yaml file used to create a PDB CRD resource in this use case:
 
-% cat pdb.yaml
+% cat pdb_create.yaml
 #
 # 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.
@@ -79,7 +79,7 @@ spec:
 % kubectl apply -f pdb_secret.yaml
 secret/pdb1-secret created
 
-% kubectl apply -f pdb.yaml
+% kubectl apply -f pdb_create.yaml
 pdb.database.oracle.com/pdb1 created
 
 
diff --git a/docs/onpremdb/provisioning/create_pdb.md b/docs/onpremdb/provisioning/create_pdb.md
@@ -2,7 +2,7 @@
 
 The Oracle Database Operator On-Prem Controller creates the PDB kind as a custom resource that models a PDB as a native Kubernetes object. There is a one-to-one mapping between the actual PDB and the Kubernetes PDB Custom Resource. Each PDB resource follows the PDB CRD as defined here: [config/crd/bases/database.oracle.com_pdbs.yaml](../../../config/crd/bases/database.oracle.com_pdbs.yaml)
 
-To create a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb.yaml](../../../config/samples/onpremdb/pdb.yaml)
+To create a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb_create.yaml](../../../config/samples/onpremdb/pdb_create.yaml)
 
 **NOTE:** It is assumed that before this step, you have followed the [prerequisite](./../README.md#prerequsites-to-manage-pdb-life-cycle-using-oracle-db-operator-on-prem-database-controller) steps.
 
diff --git a/docs/onpremdb/provisioning/delete_pdb.md b/docs/onpremdb/provisioning/delete_pdb.md
@@ -2,6 +2,8 @@
 
 In this use case, a PDB is deleted using Oracle DB Operator On-Prem controller.
 
+To delete a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb_delete.yaml](../../../config/samples/onpremdb/pdb_delete.yaml)
+
 **NOTE:** It is assumed that before this step, you have followed the [prerequisite](./../README.md#prerequsites-to-manage-pdb-life-cycle-using-oracle-db-operator-on-prem-database-controller) steps.
 
 This example uses `delete_pdb.yaml` to delete a PDB using Oracle DB Operator On-Prem Controller with:
diff --git a/docs/onpremdb/provisioning/modify_pdb.md b/docs/onpremdb/provisioning/modify_pdb.md
@@ -2,6 +2,8 @@
 
 In this use case, the state of an existing PDB is modified using Oracle DB Operator On-Prem controller.
 
+To modify a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb_modify.yaml](../../../config/samples/onpremdb/pdb_modify.yaml)
+
 **NOTE:** It is assumed that before this step, you have followed the [prerequisite](./../README.md#prerequsites-to-manage-pdb-life-cycle-using-oracle-db-operator-on-prem-database-controller) steps.
 
 Subcase 1: This example uses `modify_pdb_close.yaml` to close a PDB using Oracle DB Operator On-Prem Controller with:
@@ -44,7 +46,7 @@ Subcase 2: This example uses `modify_pdb_open.yaml` to open a PDB using Oracle D
 - Option to close the state (i.e. modify) as `READ WRITE`
 
 
-**NOTE:** For the details of the parameters to be used in the .yaml file, please refer [config/crd/bases/database.oracle.com_pdbs.yaml](../../config/crd/bases/database.oracle.com_pdbs.yaml)
+**NOTE:** For the details of the parameters to be used in the .yaml file, please refer [config/crd/bases/database.oracle.com_pdbs.yaml](../../../config/crd/bases/database.oracle.com_pdbs.yaml)
 
 Use the file: [modify_pdb_open.yaml](./modify_pdb_open.yaml) for this use case as below:
 
diff --git a/docs/onpremdb/provisioning/plug_pdb.md b/docs/onpremdb/provisioning/plug_pdb.md
@@ -2,6 +2,8 @@
 
 In this use case, a PDB is plugged in using Oracle DB Operator On-Prem controller using an existing .xml file which was generated when the PDB was unplugged from this target CDB or another CDB.
 
+To plug in a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb_plug.yaml](../../../config/samples/onpremdb/pdb_plug.yaml)
+
 **NOTE:** It is assumed that before this step, you have followed the [prerequisite](./../README.md#prerequsites-to-manage-pdb-life-cycle-using-oracle-db-operator-on-prem-database-controller) steps.
 
 This example uses `plug_pdb.yaml` to plug in a PDB to a target CDB using Oracle DB Operator On-Prem Controller with:
diff --git a/docs/onpremdb/provisioning/unplug_pdb.md b/docs/onpremdb/provisioning/unplug_pdb.md
@@ -2,6 +2,8 @@
 
 In this use case, a PDB is unplugged using Oracle DB Operator On-Prem controller.
 
+To unplug a PDB CRD Resource, a sample .yaml file is available here: [config/samples/onpremdb/pdb_unplug.yaml](../../../config/samples/onpremdb/pdb_unplug.yaml)
+
 **NOTE:** It is assumed that before this step, you have followed the [prerequisite](./../README.md#prerequsites-to-manage-pdb-life-cycle-using-oracle-db-operator-on-prem-database-controller) steps.
 
 This example uses `unplug_pdb.yaml` to unplug a PDB from a target CDB using Oracle DB Operator On-Prem Controller with:
