https://github.com/kubean-io/kubean
:seedling: Product ready cluster lifecycle management toolchains based on kubespray and other cluster LCM engine.
https://github.com/kubean-io/kubean
cloud-native k8s kubernetes kubespray operator
Last synced: 3 months ago
JSON representation
:seedling: Product ready cluster lifecycle management toolchains based on kubespray and other cluster LCM engine.
- Host: GitHub
- URL: https://github.com/kubean-io/kubean
- Owner: kubean-io
- License: apache-2.0
- Created: 2022-07-05T07:46:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-07T10:06:49.000Z (3 months ago)
- Last Synced: 2026-03-07T14:23:54.444Z (3 months ago)
- Topics: cloud-native, k8s, kubernetes, kubespray, operator
- Language: Go
- Homepage: https://kubean-io.github.io/kubean
- Size: 76.2 MB
- Stars: 525
- Watchers: 7
- Forks: 45
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
- Governance: GOVERNANCE.md
- Maintainers: MAINTAINERS.md
Awesome Lists containing this project
- awesome-cloud-native - kubean - Kubernetes lifecycle management operator based on kubespray. (Cluster Provisioning & Lifecycle)
README
# :seedling: Kubean
> [简体中文](./README_zh.md)
[
](https://github.com/cncf/k8s-conformance/pull/2240)
[
](https://kubean-io.github.io/website/)
Kubean is a production-ready cluster lifecycle management toolchain based on [kubespray](https://github.com/kubernetes-sigs/kubespray) and other cluster LCM engine.
[](https://github.com/kubean-io/kubean/actions/workflows/auto-main-ci.yaml)
[](https://codecov.io/gh/kubean-io/kubean)
[](https://bestpractices.coreinfrastructure.org/projects/6263)
[](https://github.com/kubean-io/kubean/blob/main/docs/overrides/test/kubean_testcase.md)
[](https://github.com/kubean-io/kubean/blob/main/docs/overrides/test/kubean_testcase.md)
[](https://github.com/kubean-io/kubean/blob/main/LICENSE)
[](https://goreportcard.com/report/github.com/kubean-io/kubean)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean?ref=badge_shield)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean?ref=badge_large)
---
**Kubean is a [Cloud Native Computing Foundation sandbox project](https://cncf.io/).**
## :anchor: Awesome features
- **Simplicity:** Deploying of Kubean and powerful lifecycle management of kubernetes cluster implementing by declarative API.
- **Offline Supported**: Offline packages(os-pkgs, images, binarys) are released with the release. You won't have to worry about how to gather all the resources you need.
- **Compatibility**: Multi-arch delivery Supporting. Such as AMD, ARM with common Linux distributions. Also include Kunpeng with Kylin.
- **Expandability**: Allowing custom actions be added to cluster without any changes for Kubespray.
## :surfing_man: Quick start
### Killercoda tutorials
We created a [scenario](https://killercoda.com/kubean) on [killercoda](https://killercoda.com), which is an online platform for interactive technique learning. You can try it in there.
### Local install
1. Ensure that you have a Kubernetes cluster running, on which Helm is installed
2. Deploy kubean-operator
```shell
helm repo add kubean-io https://kubean-io.github.io/kubean-helm-chart/
helm install kubean kubean-io/kubean --create-namespace -n kubean-system
```
Then check kubean-operator status by running:
```shell
kubectl get pods -n kubean-system
```
3. Online deploy an all-in-one cluster with minimal configuration
1. A simple way is to use [AllInOne.yml](./examples/install/1.minimal/),
replacing ``, ``, and other strings with actual values.
2. Start `kubeanClusterOps` to run the kubespray job.
```shell
kubectl apply -f examples/install/1.minimal
```
3. Check the kubespray job status.
```shell
kubectl get job -n kubean-system
```
[](https://asciinema.org/a/jFTUi2IdU5yydv88kHkPYMni0)
## :ocean: Kubernetes compatibility
| | Kubernetes 1.27 | Kubernetes 1.26 | Kubernetes 1.25 | Kubernetes 1.24 | Kubernetes 1.23 | Kubernetes 1.22 | Kubernetes 1.21 | Kubernetes 1.20 |
|---------------|:---------------:|:---------------:|:---------------:|:---------------:|:---------------:|:---------------:|:---------------:|:---------------:|
| Kubean v0.7.4 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Kubean v0.6.6 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Kubean v0.5.4 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Kubean v0.4.5 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Kubean v0.4.4 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
To check the list of Kubernetes versions supported by Kubean, refer to the [Kubernetes versions list](./docs/zh/usage/support_k8s_version.md).
## :book: Roadmap
For detailed information about all the planned features, refer to the [roadmap](docs/en/develop/roadmap.md).
## :book: Documents
Please visit our website: [kubean-io.github.io/kubean/](https://kubean-io.github.io/kubean/)
## :envelope: Join us
You can connect with us on the following channels:
- Slack: join the [#Kubean](https://cloud-native.slack.com/messages/kubean) channel on CNCF Slack by requesting an [invitation](https://slack.cncf.io/) from CNCF Slack. Once you have access to CNCF Slack, you can join the Kubean channel.
- Email: refer to the [MAINTAINERS.md](./MAINTAINERS.md) to find the email addresses of all maintainers. Feel free to contact them via email to report any issues or ask questions.
## :thumbsup: Contributors
## :mag_right: Others
Copyright The Kubean Authors
We are a [Cloud Native Computing Foundation sandbox project](https://www.cncf.io/).
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage).
---
