Skip to content

Commit 5144687

Browse files
author
Mahi0911
committed
Added link for pv creation in oci
1 parent 6d98051 commit 5144687

File tree

2 files changed

+86
-84
lines changed

2 files changed

+86
-84
lines changed

‎docs/sidb/README.md

Lines changed: 84 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -125,103 +125,103 @@ Oracle strongly recommends that you follow the [Prerequisites](./SIDB_PREREQUISI
125125
**NOTE:** Make sure you have created the required `.spec.adminPassword` [secret](https://kubernetes.io/docs/tasks/configmap-secret/managing-secret-using-kubectl/) and `.spec.persistence` [persistent volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
126126

127127

128-
* ### Creation Status
128+
* ### Creation Status
129+
130+
Creating a new database instance takes a while. When the 'status' status returns the response "Healthy", the Database is open for connections.
129131

130-
Creating a new database instance takes a while. When the 'status' status returns the response "Healthy", the Database is open for connections.
131-
132-
```sh
133-
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.status}"
134-
135-
Healthy
136-
```
132+
```sh
133+
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.status}"
134+
135+
Healthy
136+
```
137137

138138

139139

140-
* ### Connection Information
140+
* ### Connection Information
141141

142-
External and internal (running in Kubernetes pods) clients can connect to the database using .status.connectString and .status.clusterConnectString
143-
respectively in the following command
142+
External and internal (running in Kubernetes pods) clients can connect to the database using .status.connectString and .status.clusterConnectString
143+
respectively in the following command
144144

145-
```sh
146-
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.connectString}"
145+
```sh
146+
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.connectString}"
147147
148-
144.25.10.119:1521/ORCL
149-
```
148+
144.25.10.119:1521/ORCL
149+
```
150150

151-
The Oracle Database inside the container also has Oracle Enterprise Manager Express configured. To access OEM Express, start the browser and follow the URL:
151+
The Oracle Database inside the container also has Oracle Enterprise Manager Express configured. To access OEM Express, start the browser and follow the URL:
152152

153-
```sh
154-
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.oemExpressUrl}"
153+
```sh
154+
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.oemExpressUrl}"
155155
156-
https://144.25.10.119:5500/em
157-
```
156+
https://144.25.10.119:5500/em
157+
```
158158

159-
* ### Update Database Config
160-
161-
The following database parameters can be updated post database creation: flashBack, archiveLog, forceLog. Change their attribute values and apply using
162-
kubectl apply or edit/patch commands . Enable archiveLog before turning ON flashBack . Turn OFF flashBack before disabling the archiveLog
159+
* ### Update Database Config
160+
161+
The following database parameters can be updated post database creation: flashBack, archiveLog, forceLog. Change their attribute values and apply using
162+
kubectl apply or edit/patch commands . Enable archiveLog before turning ON flashBack . Turn OFF flashBack before disabling the archiveLog
163163

164-
```sh
165-
$ kubectl patch singleinstancedatabase sidb-sample --type merge -p '{"spec":{"forceLog": true}}'
164+
```sh
165+
$ kubectl patch singleinstancedatabase sidb-sample --type merge -p '{"spec":{"forceLog": true}}'
166166
167-
singleinstancedatabase.database.oracle.com/sidb-sample patched
168-
```
167+
singleinstancedatabase.database.oracle.com/sidb-sample patched
168+
```
169169

170-
* #### Database Config Status
170+
* #### Database Config Status
171171

172-
Check the Database Config Status using the following command
172+
Check the Database Config Status using the following command
173173

174-
```sh
175-
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath=[{.status.archiveLog}, {.status.flashBack}, {.status.forceLog}]"
174+
```sh
175+
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath=[{.status.archiveLog}, {.status.flashBack}, {.status.forceLog}]"
176176
177-
[true, true, true]
178-
```
177+
[true, true, true]
178+
```
179179

180-
* ### Update Initialization Parameters
180+
* ### Update Initialization Parameters
181181

182-
The following database initialization parameters can be updated post database creation: `sgaTarget, pgaAggregateTarget, cpuCount, processes`. Change their attribute values and apply using kubectl apply or edit/patch commands.
182+
The following database initialization parameters can be updated post database creation: `sgaTarget, pgaAggregateTarget, cpuCount, processes`. Change their attribute values and apply using kubectl apply or edit/patch commands.
183183

184-
**NOTE**
185-
* `sgaTarget` should be in range [sga_min_size, sga_max_size], else initialization parameter `sga_target` would not be updated to specified `sgaTarget`.
184+
**NOTE**
185+
* `sgaTarget` should be in range [sga_min_size, sga_max_size], else initialization parameter `sga_target` would not be updated to specified `sgaTarget`.
186186

187-
* ### Multiple Replicas
188-
189-
Multiple database pod replicas can be provisioned when the persistent volume access mode is ReadWriteMany. Database is open and mounted by one of the replicas. Other replicas will have instance started but not mounted and serve to provide quick cold fail-over in case the active pod dies. Update the replica attribute in the .yaml and apply using the kubectl apply command or edit/patch commands
187+
* ### Multiple Replicas
188+
189+
Multiple database pod replicas can be provisioned when the persistent volume access mode is ReadWriteMany. Database is open and mounted by one of the replicas. Other replicas will have instance started but not mounted and serve to provide quick cold fail-over in case the active pod dies. Update the replica attribute in the .yaml and apply using the kubectl apply command or edit/patch commands
190190

191-
Note: This functionality requires the [K8s extension](https://github.com/oracle/docker-images/tree/main/OracleDatabase/SingleInstance/extensions/k8s)
192-
Pre-built images from container-registry.oracle.com include the K8s extension
191+
Note: This functionality requires the [K8s extension](https://github.com/oracle/docker-images/tree/main/OracleDatabase/SingleInstance/extensions/k8s)
192+
Pre-built images from container-registry.oracle.com include the K8s extension
193193

194-
* ### Patch Attributes
194+
* ### Patch Attributes
195195

196-
The following attributes cannot be patched post SingleInstanceDatabase instance Creation : sid, edition, charset, pdbName, cloneFrom.
196+
The following attributes cannot be patched post SingleInstanceDatabase instance Creation : sid, edition, charset, pdbName, cloneFrom.
197197

198-
```sh
199-
$ kubectl --type=merge -p '{"spec":{"sid":"ORCL1"}}' patch singleinstancedatabase sidb-sample
198+
```sh
199+
$ kubectl --type=merge -p '{"spec":{"sid":"ORCL1"}}' patch singleinstancedatabase sidb-sample
200200
201-
The SingleInstanceDatabase "sidb-sample" is invalid: spec.sid: Forbidden: cannot be changed
202-
```
201+
The SingleInstanceDatabase "sidb-sample" is invalid: spec.sid: Forbidden: cannot be changed
202+
```
203203

204-
* #### Patch Persistence Volume Claim
204+
* #### Patch Persistence Volume Claim
205205

206-
Persistence Volume Claim (PVC) can be patched post SingleInstanceDatabase instance Creation . This will **delete all the database pods, PVC** and new database pods are created using the new PVC .
206+
Persistence Volume Claim (PVC) can be patched post SingleInstanceDatabase instance Creation . This will **delete all the database pods, PVC** and new database pods are created using the new PVC .
207207

208-
```sh
209-
$ kubectl --type=merge -p '{"spec":{"persistence":{"accessMode":"ReadWriteMany","size":"110Gi","storageClass":""}}}' patch singleinstancedatabase sidb-sample
208+
```sh
209+
$ kubectl --type=merge -p '{"spec":{"persistence":{"accessMode":"ReadWriteMany","size":"110Gi","storageClass":""}}}' patch singleinstancedatabase sidb-sample
210210
211-
singleinstancedatabase.database.oracle.com/sidb-sample patched
212-
```
211+
singleinstancedatabase.database.oracle.com/sidb-sample patched
212+
```
213213

214-
* #### Patch Service
214+
* #### Patch Service
215215

216-
Service can be patched post SingleInstanceDatabase instance Creation . This will **replace the Service with a new type** .
217-
* NodePort - '{"spec":{"loadBalancer": false}}'
218-
* LoadBalancer - '{"spec":{"loadBalancer": true }}'
216+
Service can be patched post SingleInstanceDatabase instance Creation . This will **replace the Service with a new type** .
217+
* NodePort - '{"spec":{"loadBalancer": false}}'
218+
* LoadBalancer - '{"spec":{"loadBalancer": true }}'
219219

220-
```sh
221-
$ kubectl --type=merge -p '{"spec":{"loadBalancer": false}}' patch singleinstancedatabase sidb-sample
220+
```sh
221+
$ kubectl --type=merge -p '{"spec":{"loadBalancer": false}}' patch singleinstancedatabase sidb-sample
222222
223-
singleinstancedatabase.database.oracle.com/sidb-sample patched
224-
```
223+
singleinstancedatabase.database.oracle.com/sidb-sample patched
224+
```
225225

226226
## Clone Existing Database
227227

@@ -249,33 +249,33 @@ $ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.status}"
249249

250250
Patched Oracle Docker images can be built using this [patching extension](https://github.com/oracle/docker-images/tree/main/OracleDatabase/SingleInstance/extensions/patching)
251251

252-
```sh
253-
kubectl --type=merge -p '{"spec":{"image":{"pullFrom":"patched-image:tag","pullSecrets":"pull-secret"}}}' patch singleinstancedatabase sidb-sample
252+
* ### Patch existing Database
254253

255-
singleinstancedatabase.database.oracle.com/sidb-sample patched
254+
Edit and apply the `singleinstancedatabase.yaml` file of the database resource/object by specifying a new release update for image attributes. The database pods will be restarted with the new release update image. For minimum downtime, ensure that you have mutiple replicas of the database pods running.
255+
256+
```sh
257+
kubectl --type=merge -p '{"spec":{"image":{"pullFrom":"patched-image:tag","pullSecrets":"pull-secret"}}}' patch singleinstancedatabase sidb-sample
256258
257-
```
259+
singleinstancedatabase.database.oracle.com/sidb-sample patched
258260
259-
* ### Patch existing Database
261+
```
260262

261-
Edit and apply the `singleinstancedatabase.yaml` file of the database resource/object by specifying a new release update for image attributes. The database pods will be restarted with the new release update image. For minimum downtime, ensure that you have mutiple replicas of the database pods running.
262-
263-
* ### Clone and Patch Database
264-
265-
Clone your source database using the method of [cloning existing database](README.md#clone-existing-database) and specify a new release image for the cloned database. Use this method to enusure there are no patching related issues impacting your database performance/functionality
266-
267-
* ### Datapatch status
263+
* ### Clone and Patch Database
264+
265+
Clone your source database using the method of [cloning existing database](README.md#clone-existing-database) and specify a new release image for the cloned database. Use this method to enusure there are no patching related issues impacting your database performance/functionality
266+
267+
* ### Datapatch status
268268

269-
Patching/Rollback operations are complete when the datapatch tool completes patching or rollback of the data files. Check the data files patching status
270-
and current release update version using the following commands
269+
Patching/Rollback operations are complete when the datapatch tool completes patching or rollback of the data files. Check the data files patching status
270+
and current release update version using the following commands
271271

272-
```sh
273-
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.datafilesPatched}"
272+
```sh
273+
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.datafilesPatched}"
274274
275-
true
276-
277-
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.releaseUpdate}"
275+
true
276+
277+
$ kubectl get singleinstancedatabase sidb-sample -o "jsonpath={.status.releaseUpdate}"
278278
279-
19.3.0.0.0 (29517242)
280-
```
279+
19.3.0.0.0 (29517242)
280+
```
281281

‎docs/sidb/SIDB_PREREQUISITES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ To deploy Oracle Database Operator for Kubernetes on Oracle Docker images, compl
1313
Set up an on-premises Kubernetes cluster, or subscribe to a managed Kubernetes service, such as Oracle Cloud Infrastructure Container Engine for Kubernetes, configured with persistent volumes. The persistent volumes are required for storage of the database files.
1414

1515
More info on creating persistent volumes available at [https://kubernetes.io/docs/concepts/storage/persistent-volumes/](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
16+
17+
More info on creating persistent volumes on oci is available at [https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengcreatingpersistentvolumeclaim.htm](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengcreatingpersistentvolumeclaim.htm)

0 commit comments

Comments
 (0)