Fixing readme to resolve issue 2760 (#2767)

* Replaced PDB_ADMIN with PDBADMIN * Replaced PDB_ADMIN with PDBADMIN * Fixing lint errors * Fixing lint errors * Fixing lint errors --------- Co-authored-by: Yunus Qureshi <write2yunus@gmail.com> Co-authored-by: Gerald Venzl <gerald.venzl@oracle.com>
oracle · May 15, 2024 · 756646a · 756646a
1 parent 007e037
commit 756646a
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 41 deletions.
diff --git a/OracleDatabase/SingleInstance/README.md b/OracleDatabase/SingleInstance/README.md
@@ -149,7 +149,7 @@ To run your Oracle Database image use the `docker run` command as follows:
        --ulimit:      Resource limits. Update according to Oracle Database documentation.
        -e ORACLE_SID: The Oracle Database SID that should be used (default: ORCLCDB).
        -e ORACLE_PDB: The Oracle Database PDB name that should be used (default: ORCLPDB1).
-       -e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDB_ADMIN password (default: auto generated).
+       -e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDBADMIN password (default: auto generated).
        -e INIT_SGA_SIZE:
                       The total memory in MB that should be used for all SGA components (optional).
                       Supported by Oracle Database 19.3 onwards.
@@ -372,7 +372,7 @@ To run your Oracle Database 23ai Free container image use the `podman run` comma
        --name:        The name of the container (default: auto generated)
        -p:            The port mapping of the host port to the container port.
                       Only one port is exposed: 1521 (Oracle Listener)
-       -e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDB_ADMIN password (default: auto generated)
+       -e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDBADMIN password (default: auto generated)
        -e ORACLE_CHARACTERSET:
                       The character set to use when creating the database (default: AL32UTF8)
        -e ENABLE_ARCHIVELOG: 
@@ -418,7 +418,7 @@ To run your Oracle Database 21c, or 18c Express Edition container image use the
        --name:        The name of the container (default: auto generated)
        -p:            The port mapping of the host port to the container port.
                       Two ports are exposed: 1521 (Oracle Listener), 5500 (EM Express)
-       -e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDB_ADMIN password (default: auto generated)
+       -e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDBADMIN password (default: auto generated)
        -e ORACLE_CHARACTERSET:
                       The character set to use when creating the database (default: AL32UTF8)
        -v /opt/oracle/oradata
@@ -465,7 +465,7 @@ To run your Oracle Database Express Edition container image use the `docker run`
        --shm-size:    Amount of Linux shared memory
        -p:            The port mapping of the host port to the container port.
                       Two ports are exposed: 1521 (Oracle Listener), 8080 (APEX)
-       -e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDB_ADMIN password (default: auto generated)
+       -e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDBADMIN password (default: auto generated)
 
        -v /u01/app/oracle/oradata
                       The data volume to use for the database.

diff --git a/OracleDatabase/SingleInstance/helm-charts/oracle-db/README.md b/OracleDatabase/SingleInstance/helm-charts/oracle-db/README.md
@@ -5,44 +5,44 @@ Database 19c is an industry leading relational database server.
 ## Getting started
 A Helm chart is used for packaging the deployment yamls to simplify install in Kubernetes. The chart is available at [helm-charts/oracle-db](./) directory.
 Clone the repo and execute the following command to generate oracle-db-1.0.0.tgz
-```
-$ helm package helm-charts/oracle-db
-```
+
+    helm package helm-charts/oracle-db
+
 
 ## Introduction
 
 The Oracle Database Chart contains the Oracle Database 19c running on Oracle Linux 7. This image contains a default database in a multitenant configuration with one pdb.
 
-For more information on Oracle Database 19c refer to http://docs.oracle.com/en/database/
+For more information on Oracle Database 19c refer to [Oracle Database Online Documentation](https://docs.oracle.com/en/database/oracle/oracle-database/index.html).
 
 ## Prerequisites
 
 - Kubernetes 1.12+
 - Helm 2.x or 3.x
-- NFS PV: https://kubernetes.io/docs/concepts/storage/volumes/#nfs
+- [NFS PV](https://kubernetes.io/docs/concepts/storage/volumes/#nfs)
 - Using Oracle Database Docker image requires you to accept terms of service
 - Create image pull secrets
-    ``` 
-    $ kubectl create secret docker-registry regcred --docker-server=container-registry.oracle.com --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
-    ```
+
+    kubectl create secret docker-registry regcred --docker-server=container-registry.oracle.com --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
+
 
 ## Using Oracle  Database Docker image
 ### Accepting the terms of service
-From the https://container-registry.oracle.com website accept `Terms of Service` for Oracle Database Enterprise Edition.
+From the [Oracle Container Registry](https://container-registry.oracle.com) website accept `Terms of Service` for Oracle Database Enterprise Edition.
 
 
 ## Installing the Chart
 
 To install the chart with the release name `db19c`:
 
 Helm 3.x syntax
-```
-$ helm install db19c oracle-db-1.0.0.tgz
-```
+
+    helm install db19c oracle-db-1.0.0.tgz
+
 Helm 2.x syntax
-```
-$ helm install --name db19c oracle-db-1.0.0.tgz
-```
+
+    helm install --name db19c oracle-db-1.0.0.tgz
+
 
 The command deploys Oracle Database on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
 
@@ -53,13 +53,13 @@ The command deploys Oracle Database on the Kubernetes cluster in the default con
 To uninstall/delete the `db19c` deployment:
 
 Helm 3.x syntax
-```
-$ helm uninstall db19c 
-```
+
+    helm uninstall db19c 
+
 Helm 2.x syntax
-```
-$ helm delete db19c
-```
+
+    helm delete db19c
+
 
 The command removes all the Kubernetes components associated with the chart and deletes the release.
 
@@ -71,7 +71,7 @@ The following tables lists the configurable parameters of the Oracle  Database c
 | -------------------------------      | -------------------------------            | ---------------------------------------------------------- |
 | oracle_sid                           | Database name (ORACLE_SID)                 | ORCLCDB                                                    |
 | oracle_pdb                           | PDB name                                   | ORCLPDB1                                                   |
-| oracle_pwd                           | SYS, SYSTEM and PDB_ADMIN password         | Auto generated                                             |
+| oracle_pwd                           | SYS, SYSTEM and PDBADMIN password          | Auto generated                                             |
 | oracle_characterset                  | The character set to use                   | AL32UTF8                                                   |
 | oracle_edition                       | The database edition                       | enterprise                                                 |
 | persistence.size                     | Size of persistence storage                | 100g                                                       |
@@ -86,34 +86,34 @@ The following tables lists the configurable parameters of the Oracle  Database c
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
 
 Helm 3.x syntax
-```
-$ helm install db19c --set oracle_sid=ORCL,oracle_pdb=prod oracle-db-1.0.0.tgz
-```
+
+    helm install db19c --set oracle_sid=ORCL,oracle_pdb=prod oracle-db-1.0.0.tgz
+
 Helm 2.x syntax
-```
-$ helm install --name db19c --set oracle_sid=ORCL,oracle_pdb=prod oracle-db-1.0.0.tgz
-```
+
+    helm install --name db19c --set oracle_sid=ORCL,oracle_pdb=prod oracle-db-1.0.0.tgz
+
 
 The above command sets  the Oracle Database name to 'ORCL' and PDB name to 'prod'.
 
 Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
 
 Helm 3.x syntax
-```
-$ helm install db19c -f values.yaml oracle-db-1.0.0.tgz
-```
+
+    helm install db19c -f values.yaml oracle-db-1.0.0.tgz
+
 Helm 2.x syntax
-```
-$ helm install --name db19c -f values.yaml oracle-db-1.0.0.tgz
-```
+
+    helm install --name db19c -f values.yaml oracle-db-1.0.0.tgz
+
 
 > **Tip**: You can use the default [values.yaml](values.yaml)
- 
+
 
 ## Persistence
 
 The [Oracle Database](https://www.oracle.com) image stores the Oracle Database data files  and configurations at the `/opt/oracle/oradata` path of the container.
 
-Persistent Volume Claims are used to keep the data across deployments. 
+Persistent Volume Claims are used to keep the data across deployments.
 See the [Configuration](#configuration) section to configure the PVC or to disable persistence.
 
diff --git a/OracleDatabase/SingleInstance/helm-charts/oracle-db/values.yaml b/OracleDatabase/SingleInstance/helm-charts/oracle-db/values.yaml
@@ -11,7 +11,7 @@ oracle_sid: ORCLCDB
 ##This parameter modifies the name of the PDB. The default value is set to ORCLPDB1.
 oracle_pdb: ORCLPDB1
 
-## The Oracle Database SYS, SYSTEM and PDB_ADMIN password. Defaults to a randomly generated password
+## The Oracle Database SYS, SYSTEM and PDBADMIN password. Defaults to a randomly generated password
 oracle_pwd:
 
 ## The character set to use when creating the database. Defaults to AL32UTF8