- About this repository
- Add your Operator
- Test your Operator before submitting a PR
- Preview your Operator on OperatorHub.io
- Submitting your PR
- Update your Operator
- CI Tests your Operator
- Reporting Bugs
This repo is the canonical source for Kubernetes Operators that appear on OperatorHub.io, OpenShift Container Platform and OKD.
We would love to see your Operator being added to this collection. We currently use automated vetting via continuous integration plus manual review to curate a list of high-quality, well-documented Operators. If you are new to Kubernetes Operators start here.
If you have an existing Operator read our contribution guidelines on how to package and test it. Then test your Operator locally and submit a Pull Request.
You can leverage the Makefile at the top-level directory of this repository to test your Operator prior to submitting it. Assuming you followed the contribution guide, you can run the entire suite on a Linux or macOS system with Docker and KIND installed:
make operator.test OP_PATH=upstream-community-operators/my-operator
Tests not passing? Check here.
If you are submitting your Operator in the upstream-community-operators directory your Operator will appear on OperatorHub.io. You can preview how your Operator would be rendered there by using the preview tool.
Review this checklist upon creating a PR and after you acknowledged the contribution guidelines.
Similarly, to update your operator you need to submit a PR with any changes to your Operator resources. Refere to our contribution guide for more details.
Upon creating a pull request against this repo, a set of CI pipelines will run, see more details here. The pipeline will actually run the same Makefile commands you use to test locally.
You can help speed up the review of your PR by testing locally, either manually or using scripts
Tests not passing? Check here.
Use the issue tracker in this repository to report bugs.