Caution
This project is in early development and not yet ready for production use.
The OCM Kubernetes Controller Toolkit
- supports the deployment of an OCM component and its resources, like Helm charts or other manifests, into a Kubernetes cluster with the help of kro and a deployer, e.g. FluxCD.
- provides a controller to transfer OCM components.
You should be familiar with the following concepts:
- Open Component Model
- Kubernetes ecosystem
- kro
- Kubernetes resource deployer such as FluxCD.
- Task
Note
The following section provides a high-level overview of the OCM Kubernetes Controller Toolkit and its components regarding the deployment of an OCM resource in a very basic scenario.
The primary purpose of OCM Kubernetes Controller Toolkit is simple: Deploy an OCM resource from an OCM component version into a Kubernetes cluster.
The diagram below provides an overview of the architecture of the OCM Kubernetes Controller Toolkit.
Take a look at our installation guide to get started.
Important
While the OCM Kubernetes Controller Toolkit technically can be used standalone, it requires kro and a deployer, e.g. FluxCD, to deploy an OCM resource into a Kubernetes cluster. The OCM Kubernetes Controller Toolkit deployment, however, does not contain kro or any deployer. Please refer to the respective installation guides for these tools:
- Setup your (test) environment with kind, kro, and FluxCD
- Deploying a Helm chart using a
ResourceGraphDefinitionwith FluxCD - Deploying a Helm chart using a
ResourceGraphDefinitioninside the OCM component version (bootstrap) with FluxCD - Configuring credentials for OCM Kubernetes Controller Toolkit resources to access private OCM repositories
Code contributions, feature requests, bug reports, and help requests are very welcome. Please refer to our Contributing Guide for more information on how to contribute to OCM.
OCM Kubernetes Controller Toolkit follows the Linux Foundation EU Code of Conduct