/kubean

:seedling: Product ready cluster lifecycle management toolchains based on kubespray and other cluster LCM engine.

Primary LanguageGoApache License 2.0Apache-2.0

๐ŸŒฑ Kubean

trackgit-views

็ฎ€ไฝ“ไธญๆ–‡

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

main workflow codecov CII Best Practices kubean coverage kubean coverage license Go Report Card FOSSA Status FOSSA Status

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 tutorials

We created a scenario on killercoda, 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

    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

quick_start_image

๐ŸŒŠ 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.

๐Ÿ“– 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

๐Ÿ”Ž 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.