kubean

README

🌱 Kubean

简体中文

Kubean is a production-ready cluster lifecycle management toolchain based on kubespray and other cluster LCM engine.

---

Kubean is a Cloud Native Computing Foundation sandbox project.

⚓ 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.

🏄♂ Quick start

Check Python compatibility before deployment: the two spray-job image variants have different requirements. See Python versions and image selection, especially for RHEL 8 and Kylin V10.

Killercoda tutorials

We created a scenario on killercoda, which is an online platform for interactive technique learning. You can try it in there.

Guided install with KubeStellar Console

KubeStellar Console offers a guided installation mission for Kubean with step-by-step instructions, pre-flight checks, validation, troubleshooting tips, and rollback support.

Local install

1. Ensure that you have a Kubernetes cluster running, on which Helm is installed

2. Deploy kubean-operator

   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:

   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, replacing <IP1>, <USERNAME>, and other strings with actual values.

   2. Start kubeanClusterOps to run the kubespray job.

      kubectl apply -f examples/install/1.minimal
      

   3. Check the kubespray job status.

      kubectl get job -n kubean-system
      

🌊 Kubernetes compatibility

Kubean Version	Kubernetes Version Range	Kubernetes Default Version	kubespray SHA
v0.34.2	v1.33 ~ v1.35	v1.34.7	a254f5e
v0.33.2	v1.33 ~ v1.35	v1.33.8	e3b5c41
v0.32.4	v1.32 ~ v1.34	v1.32.9	8dacb9c
v0.31.0	v1.32 ~ v1.34	v1.32.9	b9e1e85
v0.30.2	v1.32 ~ v1.34	v1.32.9	5dce75d
v0.29.1	v1.31 ~ v1.33	v1.32.9	fbf957a
v0.28.5	v1.31 ~ v1.33	v1.31.6	13c70d3
v0.27.3	v1.31 ~ v1.33	v1.31.6	502ba66
v0.26.4	v1.31 ~ v1.33	v1.31.6	739e5e1
v0.25.2	v1.30 ~ v1.32	v1.31.6	d0e9088
v0.24.2	v1.30 ~ v1.32	v1.31.6	4ad9f9b
v0.23.9	v1.30 ~ v1.32	v1.31.6	a4843ea
v0.22.5	v1.29 ~ v1.31	v1.30.5	d173f1d

To check the list of Kubernetes versions supported by Kubean, refer to the Kubernetes versions list.

📖 Roadmap

For detailed information about all the planned features, refer to the roadmap.

📖 Documents

Please visit our website: kubean-io.github.io/kubean/

✉ Join us

You can connect with us on the following channels:

• Slack: join the #Kubean channel on CNCF Slack by requesting an invitation from CNCF Slack. Once you have access to CNCF Slack, you can join the Kubean channel.
• Email: refer to the MAINTAINERS.md to find the email addresses of all maintainers. Feel free to contact them via email to report any issues or ask questions.

👍 Contributors

---

Copyright The Kubean Authors
We are a Cloud Native Computing Foundation sandbox project.
The Linux Foundation® (TLF) has registered trademarks and uses trademarks.
For a list of TLF trademarks, see Trademark Usage.

Kubean enriches the CNCF CLOUD NATIVE Landscape.