Orchestrator Operator

Go based operator for deploying the Orchestrator. For more comprehensive information about Orchestrator, please refer to the Orchestrator Official Documentation.

Installing the operator

Please visit the README.md page and follow the guide to install the operator in your cluster.

Releasing the operator

Please visit the README.md page and follow the guide to release the operator.

Updating the Orchestrator Plugins

Please visit the section in this Guide and follow the instructions.

Contributing to the operator

This project is generated using the operator-sdk. For general knowledge on how to use build the go based operator using the operator-sdk tool, please visit: go-based-operator.

Fork the Project

To fork the project into a local repository, follow this guide After making code changes, create a pull request and add reviewers from the maintainer list.

Code change rules

1. Ensure to run make generate manifests after modifying the orchestrator_types.go file.
2. Ensure to run make manifests if any changes to the kubebuilder makers in the reconciler for rbac changes to be propagated in the config/rbac directory.
3. Ensure to run make bundle for changes in the config directory to be reflected in the bundle directory.
4. Ensure to add unit tests for any new feature or update. Reference the kube package.

Installation

For local installation, login to an OCP cluster. Currently, the operator has been tested only on OCP clusters.
Run make docker-build docker-push to build and push to your local docker repository.
Run make deploy to install the operator on the OCP cluster.
Apply a Custom Resource - find sample CR here.

Uninstallation

Remove the custom resource and run make undeploy to remove the operator resources.

NOTE: Run make help for more information on all potential make targets

Prerequisites for dev tools

• go version v1.22.0+
• operator-sdk v1.38.0+
• docker version 27.03+.
• kubectl version v1.20.0+.
• Access to a OCP cluster v4.14+.

Upgrading the operator

The mechanism for upgrading the operator currently involves removing the existing operator and its operand resources and installing the new version. Follow this section in the guide to clean up resources and follow this section in the guide to install the latest version.

License

See the LICENSE file for details.