README
¶
Rollouts
Introduction
Kruise Rollouts is a Bypass component that offers Advanced Progressive Delivery Features. Its support for canary, multi-batch, and A/B testing delivery modes can be helpful in achieving smooth and controlled rollouts of changes to your application, while its compatibility with Gateway API and various Ingress implementations makes it easier to integrate with your existing infrastructure. Overall, Kruise Rollouts is a valuable tool for Kubernetes users looking to optimize their deployment processes!
Why Kruise Rollouts?
-
Functionality：
- Supports canary and multi-batch delivery for various workloads, such as Deployment, CloneSet, and StatefulSet.
- Supports Fine-grained traffic orchestration of application with Kubernetes Ingress and Gateway API.
-
Flexibility:
- Handles both incremental and existing workloads with ease.
- Be compatible with workload-referencing components like HPA, allowing for easy deployment and management of workloads.
- Supports plug-and-play and hot-swapping, with immediate effect upon application, and the flexibility to be easily deleted at any stage, including during the rollout process.
-
Extensibility:
- Extend to other workloads and traffic types easily with pluggable lua scripts.
Quick Start
- See Getting Started documents in OpenKruise official website.
Contributing
You are warmly welcome to hack on Kruise Rollout. We have prepared a detailed guide CONTRIBUTING.md.
Community
Active communication channels:
- Slack: OpenKruise channel (English)
- DingTalk：Search GroupID
23330762(Chinese) - WeChat: Search User
openkruiseand let the robot invite you (Chinese) - Bi-weekly Community Meeting (APAC, Chinese):
- Thursday 19:00 GMT+8 (Asia/Shanghai), Calendar
- Meeting Link(zoom)
- Notes and agenda
- Bi-weekly Community Meeting (English): TODO
Acknowledge
- The global idea is from both OpenKruise and KubeVela communities, and the basic code of rollout is inherited from the KubeVela Rollout.
- This project is maintained by both contributors from OpenKruise and KubeVela.
License
Kruise Rollout is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +kubebuilder:object:generate=true +groupName=rollouts.kruise.io
|
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +kubebuilder:object:generate=true +groupName=rollouts.kruise.io |
|
v1beta1
Package v1beta1 contains API Schema definitions for the apps v1beta1 API group +kubebuilder:object:generate=true +groupName=rollouts.kruise.io
|
Package v1beta1 contains API Schema definitions for the apps v1beta1 API group +kubebuilder:object:generate=true +groupName=rollouts.kruise.io |
|
pkg
|
|
|
controller/deployment
Package deployment contains all the logic for handling Kubernetes Deployments.
|
Package deployment contains all the logic for handling Kubernetes Deployments. |
|
test
|
|