Kruise

English | 简体中文

Introduction

OpenKruise (official site: https://openkruise.io) is a CNCF(Cloud Native Computing Foundation) incubating project. It consists of several controllers which extend and complement the Kubernetes core controllers for workload and application management.

Key Features

• Advance Workloads

  Advance Workloads can help you manage applications of stateless, stateful, daemon and job.

  They all support not only the basic features which are similar to the original Workloads in Kubernetes, but also more advanced abilities like in-place update, configurable scale/upgrade strategies, parallel operations.

  • CloneSet for stateless applications
  • Advanced StatefulSet for stateful applications
  • Advanced DaemonSet for daemon applications
  • BroadcastJob for deploying jobs over specific nodes
  • AdvancedCronJob for creating Job or BroadcastJob periodically

• Sidecar container Management

  Kruise simplify sidecar injection and enable sidecar in-place update. Kruise also enhance the sidecar startup and termination control.

  • SidecarSet for defining and upgrading your own sidecars
  • Container Launch Priority to control the container startup orders
  • Sidecar Job Terminator terminates sidecar containers for such job-type Pods when its main containers completed.

• Multi-domain Management

  This can help you manage applications over nodes with multiple domains, such as different node pools, available zones, architectures(x86 & arm) or node types(kubelet & virtual kubelet).

  Here we provide two different ways:

  • WorkloadSpread for bypass distributing pods in workloads
  • UnitedDeployment, a new workload to manage multiple sub-workloads

• Enhanced Operations

  • ContainerRecreateRequest provides a way to let users restart/recreate containers in a running pod
  • ImagePullJob pre-download images on specific nodes
  • ResourceDistribution support Secret & ConfigMap resource distribution across namespaces
  • PersistentPodState is able to persistent states of the Pod, such as “IP Retention”
  • PodProbeMarker provides the ability to customize the Probe and return the result to the Pod

• Application Protection

  • Protect Kubernetes resources and applications’ availability from the cascading deletion
  • PodUnavailableBudget for achieving the effect of preventing application disruption or SLA degradation

Quick Start

You can view the full documentation from the OpenKruise website.

• Install or upgrade Kruise with the stable version.
• Install or upgrade Kruise with the latest version including alpha/beta/rc.

Users

Registration: Who is using Kruise

• Alibaba Group, Ant Group, DouyuTV, Sto, Boss直聘
• hangyinxiaofei, vanyitech, Dmall, Bringg, 佐疆科技
• Lyft, Ctrip, 享住智慧, VIPKID, zhangmen
• xiaohongshu, bixin, 永辉科技中心, 跟谁学, 哈啰出行
• Spectro Cloud, ihomefnt, Arkane Systems, Deepexi, 火花思维
• OPPO, Suning.cn, joyy, Mobvista, 深圳凤凰木网络有限公司
• xiaomi, Netease, MeiTuan Finance, Shopee, Esign
• LinkedIn, 雪球, 兴盛优选, Wholee, LilithGames, Baidu
• Bilibili, 冠赢互娱, MeiTuan, 同城

Contributing

You are warmly welcome to hack on Kruise. We have prepared a detailed guide CONTRIBUTING.md.

Community

Active communication channels:

• Slack: OpenKruise channel (English)
• DingTalk：Search GroupID 23330762 (Chinese)
• WeChat: Search User openkruise and 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

License

Kruise is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.