README
¶
ResourceConsist
ResourceConsist aims to make a customized controller can be realized easily, and offering the ability of following PodOpsLifecycle for controllers.
The only thing users need to do to realize a customized controller is writing an adapter implementing ReconcileAdapter. For controllers following PodOpsLifecycle, WebhookAdapter is also necessary to be implemented.
🤠Employer is the entity responsible for managing and coordinating the utilization of another resource, similar to how a service selects and controls pods.
👩💻Employee is the resource managed by another resource, like pods selected by service.
👉 Please refer to key concepts to find out what 🤠Employer/👩💻Employee/... are.
💻 Get Started
🔧 Tutorial
ResourceConsist offers the frame for starting controller. Controllers started by adapters and resource consist frame can handle resources beyond or in cluster by themselves or cooperate with other controllers.
DemoControllerAdapter is an adapter handles resources by itself, while SlbControllerAdapter is an adapter handles resources cooperate with CCM controller.
With ResourceConsist, you can build a bridge between existing controllers and PodOpsLifecycle, just like what SlbControllerAdapter](https://github.com/KusionStack/resourceconsist/tree/main/pkg/adapters/alibabacloudslb/alibabacloudslb_controller.go#L35) did.
Please visit tutorial to start a controller.
☎️ Contact us
-
Twitter: KusionStack
-
Slack: Kusionstack
-
DingTalk (Chinese): 42753001
-
Wechat Group (Chinese)
🎖︎ Contribution guide
ResourceConsist is currently in its early stages. Our goal is to make a customized controller can be realized easily, especially for controllers following PodOpsLifecycle.
We will continue implementing more common used traffic controller into adapters
🚀 If you want to contribute to built-in adapters, you can start from contribute them into experimental/adapters. We will move it into adapters when the experimental adapters are ready to release.
We welcome everyone to participate in construction with us. Visit the contribution guide to understand how to participate in the contribution KusionStack project. If you have any questions, please submit the issue.
Directories