Skip to content

Commit 2b44772

Browse files
Merge pull request #30 from abhisbyk/AbhiK_doc_fixes
Doc changes
2 parents 189e92b + 4028846 commit 2b44772

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Make Oracle Database Kubernetes Native - Take 2
44

5-
As part of Oracle's resolution to make Oracle Database Kubernetes-native (that is, observable and operable by Kubernetes), Oracle released _Oracle Database Operator for Kubernetes_ (`OraOperator`). OraOperator extends the Kubernetes API with custom resources and controllers for automating Oracle Database lifecycle management.
5+
As part of Oracle's resolution to make Oracle Database Kubernetes-native (that is, observable and operable by Kubernetes), Oracle released _Oracle Database Operator for Kubernetes_ (`OraOperator` or the operator). OraOperator extends the Kubernetes API with custom resources and controllers for automating Oracle Database lifecycle management.
66

77
In this v0.2.0 release, `OraOperator` supports the following database configurations and infrastructure:
88

@@ -32,7 +32,7 @@ The upcoming releases will support new configurations, operations and capabiliti
3232

3333
## Release Status
3434

35-
**CAUTION:** The current release of `OraOperator` (v0.2.0) is for development and test only. DO NOT USE IN PRODUCTION.
35+
**CAUTION:** The current release of `OraOperator` (v0.2.0) is for development and testing only. DO NOT USE IN PRODUCTION.
3636

3737
This release has been installed and tested on the following Kubernetes platforms:
3838

@@ -67,8 +67,13 @@ Oracle strongly recommends that you ensure your system meets the following [Prer
6767
```sh
6868
kubectl apply -f https://raw.githubusercontent.com/oracle/oracle-database-operator/main/oracle-database-operator.yaml
6969
```
70+
---
71+
**NOTE:**
72+
The above command will also upgrade the existing v0.1.0 `OraOperator` installation to the latest version i.e. v0.2.0.
7073

71-
Ensure that operator pods are up and running. Operator pod replicas are set to a default of 3 for High Availability, which can be scaled up and down.
74+
---
75+
76+
Ensure that the operator pods are up and running. For high availability, Operator pod replicas are set to a default of 3. You can scale this setting up or down.
7277

7378
```sh
7479
$ kubectl get pods -n oracle-database-operator-system
@@ -101,7 +106,7 @@ YAML file templates are available under [`/config/samples`](./config/samples/).
101106

102107
## Uninstall the Operator
103108

104-
To uninstall the operator, the final step consists of deciding whether or not you want to delete the CRDs and APIServices that were introduced to the cluster by the operator. Choose one of the following options:
109+
To uninstall the operator, the final step consists of deciding whether you want to delete the custom resource definitions (CRDs) and Kubernetes APIServices introduced into the cluster by the operator. Choose one of the following options:
105110

106111
* ### Deleting the CRDs and APIServices
107112

@@ -120,13 +125,13 @@ YAML file templates are available under [`/config/samples`](./config/samples/).
120125
kubectl delete pdb.database.oracle.com --all -n <namespace>
121126
```
122127

123-
After all CRD instances are deleted, it is safe to remove the CRDs, APISerivces and operator deployment.
128+
After all CRD instances are deleted, it is safe to remove the CRDs, APISerivces and operator deployment. Use the following command:
124129

125130
```sh
126131
kubectl delete -f oracle-database-operator.yaml --ignore-not-found=true
127132
```
128133

129-
Note: If the CRD instances are not deleted, and the operator is deleted by using the preceding command, then operator deployment and instance objects (pods,services, PVCs, and so on) are deleted. However, the CRD deletion stops responding, because the CRD instances have properties that prevent its deletion and that can only be removed by the operator pod, which is deleted when the APIServices are deleted.
134+
Note: If the CRD instances are not deleted, and the operator is deleted by using the preceding command, then operator deployment and instance objects (pods, services, PVCs, and so on) are deleted. However, if that happens, then the CRD deletion stops responding. This is because the CRD instances have properties that prevent their deletion, and that can only be removed by the operator pod, which is deleted when the APIServices are deleted.
130135

131136

132137
## Docs of the supported Oracle Database configurations

docs/sidb/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Oracle Database Operator for Kubernetes (`OraOperator`) includes the Single Inst
3232
* [APEX Installation](#apex-installation)
3333
* [Delete ORDS](#delete-ords)
3434
* [Maintenance Operations](#maintenance-operations)
35+
* [Additional Information](#additional-information)
3536

3637
## Prerequisites
3738

@@ -793,3 +794,9 @@ If you need to perform some maintenance operations (Database/ORDS) manually, the
793794
3. Log In to `sqlplus` to perform manual operations by using the following command:
794795
795796
sqlplus / as sysdba
797+
798+
## Additional information
799+
Detailed instructions for setting up Single Instance Database by OraOperator using OCI free trial account is available now in the LiveLab format. Please use the following link:
800+
[https://oracle.github.io/cloudtestdrive/AppDev/database-operator/workshops/freetier/?lab=introduction](https://oracle.github.io/cloudtestdrive/AppDev/database-operator/workshops/freetier/?lab=introduction)
801+
802+
Thanks, [Jan Leemans](https://github.com/janleemans), for this effort!!

0 commit comments

Comments
 (0)