kubean

README

🌱 Kubean

简体中文

Kubean is a product ready cluster lifecycle management toolchains 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

Killercoda

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

Local install

1. Ensure that a Kubernetes Cluster exists and Helm 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 mode deployment of minimal all-in-one clusters

You can use the example in folder examples/install/1.minimal which uses online resources to install k8s cluster.

1. Modify the examples/install/1.minimal/AllInOne.yml file by simply replacing <IP1>, <USERNAME>, and any other placeholders with their actual values.
2. Start kubeanClusterOps which will start the kubespray job.

   $ kubectl apply -f examples/install/1.minimal
   

3. Check the kubespray job status.

   $ kubectl get job -n kubean-system
   

🌊 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, please refer to the Kubernetes versions list.

📖 Roadmap

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

📖 Documents

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

✉ Communication

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

🔎 Others

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.

License