Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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 days ago
JSON representation

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

Awesome Lists containing this project

README

        

# :seedling: Kubean


trackgit-views

> [简体中文](./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.

[![main workflow](https://github.com/kubean-io/kubean/actions/workflows/auto-main-ci.yaml/badge.svg)](https://github.com/kubean-io/kubean/actions/workflows/auto-main-ci.yaml)
[![codecov](https://codecov.io/gh/kubean-io/kubean/branch/main/graph/badge.svg?token=8FX807D3QQ)](https://codecov.io/gh/kubean-io/kubean)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6263/badge)](https://bestpractices.coreinfrastructure.org/projects/6263)
[![kubean coverage](https://raw.githubusercontent.com/dasu23/e2ecoverage/master/badges/kubean/kubeanCoverage.svg)](https://github.com/kubean-io/kubean/blob/main/docs/overrides/test/kubean_testcase.md)
[![kubean coverage](https://raw.githubusercontent.com/dasu23/e2ecoverage/master/badges/kubean/kubeanCoverage2.svg)](https://github.com/kubean-io/kubean/blob/main/docs/overrides/test/kubean_testcase.md)
[![license](https://img.shields.io/badge/license-AL%202.0-blue)](https://github.com/kubean-io/kubean/blob/main/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubean-io/kubean)](https://goreportcard.com/report/github.com/kubean-io/kubean)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean?ref=badge_shield)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubean-io%2Fkubean.svg?type=small)](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
```

[![quick_start_image](docs/overrides/assets/images/quick_start.gif)](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).

---







Kubean enriches the CNCF CLOUD NATIVE Landscape.