Skip to content

Update README.md to include installation and uninstallation instructions for OperatorHub.io #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md to include installation and uninstallation instructions for OperatorHub.io #179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 42 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ In this v1.2.0 production release, `OraOperator` supports the following database
* Oracle Base Database Service: support for Oracle Database 23ai Cloning, using KMS Vaults, PDB creation.

## New Product Features
*The Operator itself, as a product, brings the following new features:
* The Operator itself, as a product, brings the following new features:
* Published on `operatorhub.io`
* Operator Lifecycle Manager (OLM) support (install from `operatorhub.io`)
* Validated on Google Kubernetes Engine
Expand Down Expand Up @@ -140,26 +140,20 @@ Oracle strongly recommends that you ensure your system meets the following [Prer
```sh
kubectl apply -f rbac/node-rbac.yaml
```
## Installation
### Install Oracle DB Operator

After you have completed the preceding prerequisite changes, you can install the operator. To install the operator in the cluster quickly, you can apply the modified `oracle-database-operator.yaml` file from the preceding step.

Run the following command
## Install Oracle DB Operator

```sh
kubectl apply -f oracle-database-operator.yaml
```
After you have completed the preceding prerequisite changes, you can install the operator using one of the following methods:

## Install Oracle DB Operator
### Option 1: Install Using `oracle-database-operator.yaml`

After you have completed the preceding prerequisite changes, you can install the operator. To install the operator in the cluster quickly, you can apply the modified `oracle-database-operator.yaml` file from the preceding step.
To install the operator in the cluster quickly, you can apply the modified `oracle-database-operator.yaml` file from the preceding step.

Run the following command
Run the following command

```sh
kubectl apply -f oracle-database-operator.yaml
```
```sh
kubectl apply -f oracle-database-operator.yaml
```

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.

Expand All @@ -173,12 +167,20 @@ Oracle strongly recommends that you ensure your system meets the following [Prer

```

* Check the resources
### Option 2: Install via OperatorHub.io

You can also install the Oracle DB Operator from [OperatorHub.io](https://operatorhub.io/operator/oracle-database-operator).

1. Visit the [Oracle Database Operator](https://operatorhub.io/operator/oracle-database-operator) page on OperatorHub.io.

2. Click the **Install** button to view and follow the step-by-step installation instructions for your Kubernetes environment.

### Check the resources

You should see that the operator is up and running, along with the shipped controllers.

For more details, see [Oracle Database Operator Installation Instructions](./docs/installation/OPERATOR_INSTALLATION_README.md).
## Documentation

## Getting Started with the Operator (Quickstart)

The following quickstarts are designed for specific database configurations:
Expand Down Expand Up @@ -229,6 +231,10 @@ YAML file templates are available under [`/config/samples`](./config/samples/).

* ### Delete the Deployment

#### Option1: Delete `oracle-database-operator.yaml`

Use this option if you install the operator using `oracle-database-operator.yaml`

After all CRD instances are deleted, it is safe to remove the CRDs, APIServices and operator deployment. To remove these files, use the following command:

```sh
Expand All @@ -237,6 +243,25 @@ YAML file templates are available under [`/config/samples`](./config/samples/).

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.

#### Option2: Delete the Operator’s ClusterServiceVersion (CSV)

Use this option if you install the operation from OperatorHub.io.

First, identify the name of the installed operator’s ClusterServiceVersion (CSV) using the following command:

```sh
kubectl clusterserviceversion -n operators
```

Look for a CSV name similar to oracle-database-operator.vx.x.x.

Once identified, delete the ClusterServiceVersion with the following command (replace the placeholder with the actual CSV name):

```sh
kubectl delete clusterserviceversion oracle-database-operator.vx.x.x -n operators
```


## Documentation for the supported Oracle Database configurations

* [Oracle Autonomous Database](https://docs.oracle.com/en-us/iaas/Content/Database/Concepts/adboverview.htm)
Expand Down