github.com/kubernetes-sigs/kro @v0.9.2 sqlite
README
kro | Kube Resource Orchestrator
Kube Resource Orchestrator (kro) is a subproject of Kubernetes SIG Cloud Provider. This project aims to simplify the creation and management of complex custom resources for Kubernetes.
Kro helps you to define complex multi-resource constructs as reusable components in your applications and systems. It does this by providing a Kubernetes-native, vendor agnostic way to define groupings of Kubernetes resources.
Kro's fundamental custom resource is the ResourceGraphDefinition. A ResourceGraphDefinition defines collections of underlying Kubernetes resources. It can define any Kubernetes resources, either native or custom, and can specify the dependencies between them. This lets you define complex custom resources, and include default configurations for their use.
The kro controller will determine the dependencies between resources, establish the correct order of operations to create and configure them, and then dynamically create and manage all of the underlying resources for you.
Kro is Kubernetes native and integrates seamlessly with existing tools to preserve familiar processes and interfaces.
Documentation
| Title | Description |
|---|---|
| Introduction | An introduction to kro |
| Installation | Install kro in your cluster |
| Getting started | Deploy your first ResourceGraphDefinition |
| Concepts | Learn more about kro concepts |
| Examples | Example resources |
| Contributions | How to get involved |
FAQ
-
What is kro?
Kube Resource Orchestrator (kro) is a new operator for Kubernetes that simplifies the creation of complex Kubernetes resource configurations. kro lets you create and manage custom groups of Kubernetes resources by defining them as a ResourceGraphDefinition, the project's fundamental custom resource. ResourceGraphDefinition specifications define a set of resources and how they relate to each other functionally. Once defined, ResourceGraphDefinitions can be applied to a Kubernetes cluster where the kro controller is running. Once validated by kro, you can create instances of your ResourceGraphDefinition. kro translates your ResourceGraphDefinition instance and its parameters into specific Kubernetes resources and configurations which it then manages for you.
-
How does kro work?
kro is designed to use core Kubernetes primitives to make resource grouping, customization, and dependency management simpler. When a ResourceGraphDefinition is applied to the cluster, the kro controller verifies its specification, then dynamically creates a new CRD and registers it with the API server. kro then deploys a dedicated controller to respond to instance events on the CRD. This microcontroller is responsible for managing the lifecycle of resources defined in the ResourceGraphDefinition for each instance that is created.
-
How do I use kro?
To create your custom resource groupings, you create ResourceGraphDefinition specifications. These specify one or more Kubernetes resources, and can include specific configurations for each resource.
For example, you can define a WebApp ResourceGraphDefinition that defines a WebAppCRD CRD that is composed of a Deployment, pre-configured to deploy your web server backend, and a Service configured to run on a specific port. You can just as easily create a more complex WebAppWithDB ResourceGraphDefinition by combining the existing WebApp ResourceGraphDefinition with a Table custom resource to provision a cloud managed database instance for your web app to use.
Once you have defined a ResourceGraphDefinition, you can apply it to a Kubernetes cluster where the kro controller is running. kro will take care of the heavy lifting of creating CRDs and deploying dedicated controllers in order to manage instances of your new custom resource group.
To create an instance of your custom resource groupings, you create an instance of the CRD that your ResourceGraphDefinition specifies. In the WebApp ResourceGraphDefinition example, this would be an instance of the WebAppCRD CRD. kro will respond by dynamically creating, configuring, and managing the underlying Kubernetes resources for you.
-
Why did you build this project?
We want to help streamline and simplify building with Kubernetes. Building with Kubernetes means dealing with resources that need to operate and work together, and orchestrating this can get complex and difficult at scale. With this project, we're taking a step in reducing the complexity of resource dependency management and customization, paving the way for a simple and scalable way to create complex custom resources for Kubernetes.
-
What should I know about API changes?
kro's API is currently at v1alpha1. As kro evolves, we may introduce breaking changes to improve the API. We are committed to providing clear migration paths, deprecation notices, and comprehensive support to help users adapt to any breaking changes. Our goal is to ensure smooth transitions as the project continues to improve.
Community Participation
Development and discussion is coordinated in the Kubernetes Slack (invite link) channel #kro channel.
Please join our community meeting. * Every other Wednesday at 9AM PT (Pacific Time). Convert to local timezone * Add to Google Calendar * Agenda: Public doc * Join us: Zoom meeting * Community meeting recordings: YouTube channel
Code of conduct
Participation in the project community is governed by the Kubernetes Code of Conduct.
Security
See CONTRIBUTING and SECURITY for information.