Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gotsysdba/oracle-ords-operator
Oracle ORDS Operator for Kubernetes
https://github.com/gotsysdba/oracle-ords-operator
kubernetes operator oracle ords
Last synced: 12 days ago
JSON representation
Oracle ORDS Operator for Kubernetes
- Host: GitHub
- URL: https://github.com/gotsysdba/oracle-ords-operator
- Owner: gotsysdba
- License: upl-1.0
- Created: 2024-04-08T10:24:20.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-30T08:07:51.000Z (6 months ago)
- Last Synced: 2024-05-30T09:35:40.868Z (6 months ago)
- Topics: kubernetes, operator, oracle, ords
- Language: Go
- Homepage:
- Size: 529 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Oracle Rest Data Services (ORDS) Operator for Kubernetes
This is a **Proof-of-Concept** [Oracle Rest Data Services](https://www.oracle.com/uk/database/technologies/appdev/rest.html) Operator (ORDS Operator) and is *currently* **not supported** by Oracle.
Your evaluation and [Feedback](../../issues/new?labels=feedback&title=New+Feedback) is appreciated.
## Description
The ORDS Operator extends the Kubernetes API with a Custom Resource (CR) and Controller for automating Oracle Rest Data
Services (ORDS) lifecycle management. Using the ORDS Operator, you can easily migrate existing, or create new, ORDS implementations
into an existing Kubernetes cluster.
This Operator allows you to run what would otherwise be an On-Premises ORDS middle-tier, configured as you require, inside Kubernetes with the additional ability of the controller to perform automatic ORDS/APEX install/upgrades inside the database.
## Features Summary
The custom RestDataServices resource supports the following configurations as a Deployment, StatefulSet, or DaemonSet:
* Single RestDataServices resource with one database pool
* Single RestDataServices resource with multiple database pools*
* Multiple RestDataServices resources, each with one database pool
* Multiple RestDataServices resources, each with multiple database pools*
*See [Limitations](#limitations)
It supports the majority of ORDS configuration settings as per the [API Documentation](docs/api.md).
The ORDS and APEX schemas can be [automatically installed/upgraded](docs/autoupgrade.md) into the Oracle Database by the ORDS Operator.
ORDS Version support:
* v22.1+
Oracle Database Version:
* 19c
* 23ai (incl. 23ai Free)
### Quick Installation
To install the ORDS Operator, run:
```bash
kubectl apply -f https://github.com/gotsysdba/oracle-ords-operator/releases/latest/download/oracle-ords-operator.yaml
```
This will create a new namespace, `oracle-ords-operator-system`, in which the Controller will run.
### Common Configurations
A few common configuration examples can be used to quickly familiarise yourself with the ORDS Custom Resource Definition.
The "Conclusion" section of each example highlights specific settings to enable functionality that maybe of interest.
* [Containerised Single Instance Database using the OraOperator](docs/examples/sidb_container.md)
* [Multipool, Multidatabase using a TNS Names file](docs/examples/multi_pool.md)
* [Autonomous Database using the OraOperator](docs/examples/adb_oraoper.md) - (Customer Managed ORDS) *See [Limitations](#limitations)
* [Autonomous Database without the OraOperator](docs/examples/adb.md) - (Customer Managed ORDS)
* [Oracle API for MongoDB Support](docs/examples/mongo_api.md)
Running through all examples in the same Kubernetes cluster illustrates the ability to run multiple ORDS instances with a variety of different configurations.
If you have a specific use-case that is not covered and would like it to be, please open an [Enhancement Request](../../issues/new?labels=enhancement) or feel free to contribute it via a Pull Request.
### Limitations
When connecting to a mTLS enabled ADB and using the OraOperator to retreive the Wallet, it is currently not supported to have multiple, different databases supported by the single RestDataServices resource. This is due to a requirement to set the `TNS_ADMIN` parameter at the Pod level ([#97](https://github.com/oracle/oracle-database-operator/issues/97)).
## Contributing
See [Contributing to this Repository](./CONTRIBUTING.md)
## Reporting a Security Issue
See [Reporting security vulnerabilities](./SECURITY.md)
## License
Copyright (c) 2024 Oracle and/or its affiliates.
Released under the Universal Permissive License v1.0 as shown at [https://oss.oracle.com/licenses/upl/](https://oss.oracle.com/licenses/upl/)