Skip to content

Commit 756646a

Browse files
aditya059yunus-qureshigvenzl
authored
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>
1 parent 007e037 commit 756646a

File tree

3 files changed

+41
-41
lines changed

3 files changed

+41
-41
lines changed

OracleDatabase/SingleInstance/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ To run your Oracle Database image use the `docker run` command as follows:
149149
--ulimit: Resource limits. Update according to Oracle Database documentation.
150150
-e ORACLE_SID: The Oracle Database SID that should be used (default: ORCLCDB).
151151
-e ORACLE_PDB: The Oracle Database PDB name that should be used (default: ORCLPDB1).
152-
-e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDB_ADMIN password (default: auto generated).
152+
-e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDBADMIN password (default: auto generated).
153153
-e INIT_SGA_SIZE:
154154
The total memory in MB that should be used for all SGA components (optional).
155155
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
372372
--name: The name of the container (default: auto generated)
373373
-p: The port mapping of the host port to the container port.
374374
Only one port is exposed: 1521 (Oracle Listener)
375-
-e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDB_ADMIN password (default: auto generated)
375+
-e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDBADMIN password (default: auto generated)
376376
-e ORACLE_CHARACTERSET:
377377
The character set to use when creating the database (default: AL32UTF8)
378378
-e ENABLE_ARCHIVELOG:
@@ -418,7 +418,7 @@ To run your Oracle Database 21c, or 18c Express Edition container image use the
418418
--name: The name of the container (default: auto generated)
419419
-p: The port mapping of the host port to the container port.
420420
Two ports are exposed: 1521 (Oracle Listener), 5500 (EM Express)
421-
-e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDB_ADMIN password (default: auto generated)
421+
-e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDBADMIN password (default: auto generated)
422422
-e ORACLE_CHARACTERSET:
423423
The character set to use when creating the database (default: AL32UTF8)
424424
-v /opt/oracle/oradata
@@ -465,7 +465,7 @@ To run your Oracle Database Express Edition container image use the `docker run`
465465
--shm-size: Amount of Linux shared memory
466466
-p: The port mapping of the host port to the container port.
467467
Two ports are exposed: 1521 (Oracle Listener), 8080 (APEX)
468-
-e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDB_ADMIN password (default: auto generated)
468+
-e ORACLE_PWD: The Oracle Database SYS, SYSTEM and PDBADMIN password (default: auto generated)
469469

470470
-v /u01/app/oracle/oradata
471471
The data volume to use for the database.

OracleDatabase/SingleInstance/helm-charts/oracle-db/README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,44 @@ Database 19c is an industry leading relational database server.
55
## Getting started
66
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.
77
Clone the repo and execute the following command to generate oracle-db-1.0.0.tgz
8-
```
9-
$ helm package helm-charts/oracle-db
10-
```
8+
9+
helm package helm-charts/oracle-db
10+
1111

1212
## Introduction
1313

1414
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.
1515

16-
For more information on Oracle Database 19c refer to http://docs.oracle.com/en/database/
16+
For more information on Oracle Database 19c refer to [Oracle Database Online Documentation](https://docs.oracle.com/en/database/oracle/oracle-database/index.html).
1717

1818
## Prerequisites
1919

2020
- Kubernetes 1.12+
2121
- Helm 2.x or 3.x
22-
- NFS PV: https://kubernetes.io/docs/concepts/storage/volumes/#nfs
22+
- [NFS PV](https://kubernetes.io/docs/concepts/storage/volumes/#nfs)
2323
- Using Oracle Database Docker image requires you to accept terms of service
2424
- Create image pull secrets
25-
```
26-
$ kubectl create secret docker-registry regcred --docker-server=container-registry.oracle.com --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
27-
```
25+
26+
kubectl create secret docker-registry regcred --docker-server=container-registry.oracle.com --docker-username=<your-name> --docker-password=<your-pword> --docker-email=<your-email>
27+
2828

2929
## Using Oracle Database Docker image
3030
### Accepting the terms of service
31-
From the https://container-registry.oracle.com website accept `Terms of Service` for Oracle Database Enterprise Edition.
31+
From the [Oracle Container Registry](https://container-registry.oracle.com) website accept `Terms of Service` for Oracle Database Enterprise Edition.
3232

3333

3434
## Installing the Chart
3535

3636
To install the chart with the release name `db19c`:
3737

3838
Helm 3.x syntax
39-
```
40-
$ helm install db19c oracle-db-1.0.0.tgz
41-
```
39+
40+
helm install db19c oracle-db-1.0.0.tgz
41+
4242
Helm 2.x syntax
43-
```
44-
$ helm install --name db19c oracle-db-1.0.0.tgz
45-
```
43+
44+
helm install --name db19c oracle-db-1.0.0.tgz
45+
4646

4747
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.
4848

@@ -53,13 +53,13 @@ The command deploys Oracle Database on the Kubernetes cluster in the default con
5353
To uninstall/delete the `db19c` deployment:
5454

5555
Helm 3.x syntax
56-
```
57-
$ helm uninstall db19c
58-
```
56+
57+
helm uninstall db19c
58+
5959
Helm 2.x syntax
60-
```
61-
$ helm delete db19c
62-
```
60+
61+
helm delete db19c
62+
6363

6464
The command removes all the Kubernetes components associated with the chart and deletes the release.
6565

@@ -71,7 +71,7 @@ The following tables lists the configurable parameters of the Oracle Database c
7171
| ------------------------------- | ------------------------------- | ---------------------------------------------------------- |
7272
| oracle_sid | Database name (ORACLE_SID) | ORCLCDB |
7373
| oracle_pdb | PDB name | ORCLPDB1 |
74-
| oracle_pwd | SYS, SYSTEM and PDB_ADMIN password | Auto generated |
74+
| oracle_pwd | SYS, SYSTEM and PDBADMIN password | Auto generated |
7575
| oracle_characterset | The character set to use | AL32UTF8 |
7676
| oracle_edition | The database edition | enterprise |
7777
| persistence.size | Size of persistence storage | 100g |
@@ -86,34 +86,34 @@ The following tables lists the configurable parameters of the Oracle Database c
8686
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
8787

8888
Helm 3.x syntax
89-
```
90-
$ helm install db19c --set oracle_sid=ORCL,oracle_pdb=prod oracle-db-1.0.0.tgz
91-
```
89+
90+
helm install db19c --set oracle_sid=ORCL,oracle_pdb=prod oracle-db-1.0.0.tgz
91+
9292
Helm 2.x syntax
93-
```
94-
$ helm install --name db19c --set oracle_sid=ORCL,oracle_pdb=prod oracle-db-1.0.0.tgz
95-
```
93+
94+
helm install --name db19c --set oracle_sid=ORCL,oracle_pdb=prod oracle-db-1.0.0.tgz
95+
9696

9797
The above command sets the Oracle Database name to 'ORCL' and PDB name to 'prod'.
9898

9999
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
100100

101101
Helm 3.x syntax
102-
```
103-
$ helm install db19c -f values.yaml oracle-db-1.0.0.tgz
104-
```
102+
103+
helm install db19c -f values.yaml oracle-db-1.0.0.tgz
104+
105105
Helm 2.x syntax
106-
```
107-
$ helm install --name db19c -f values.yaml oracle-db-1.0.0.tgz
108-
```
106+
107+
helm install --name db19c -f values.yaml oracle-db-1.0.0.tgz
108+
109109

110110
> **Tip**: You can use the default [values.yaml](values.yaml)
111-
111+
112112

113113
## Persistence
114114

115115
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.
116116

117-
Persistent Volume Claims are used to keep the data across deployments.
117+
Persistent Volume Claims are used to keep the data across deployments.
118118
See the [Configuration](#configuration) section to configure the PVC or to disable persistence.
119119

OracleDatabase/SingleInstance/helm-charts/oracle-db/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ oracle_sid: ORCLCDB
1111
##This parameter modifies the name of the PDB. The default value is set to ORCLPDB1.
1212
oracle_pdb: ORCLPDB1
1313

14-
## The Oracle Database SYS, SYSTEM and PDB_ADMIN password. Defaults to a randomly generated password
14+
## The Oracle Database SYS, SYSTEM and PDBADMIN password. Defaults to a randomly generated password
1515
oracle_pwd:
1616

1717
## The character set to use when creating the database. Defaults to AL32UTF8

0 commit comments

Comments
 (0)