-
Notifications
You must be signed in to change notification settings - Fork 364
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Synchronize the repo's and docs README
They diverged a bit over time. Use the mkdocs include-markdown plugin to import the common parts from the repo's README into the docs README. Signed-off-by: Tom Wieczorek <[email protected]>
- Loading branch information
Showing
4 changed files
with
74 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,60 @@ | ||
| # k0s - The Zero Friction Kubernetes | ||
|
|
||
|  | ||
| <!-- When changing this file, consider to change ../README.md, too! --> | ||
|
|
||
| k0s is an open source, all-inclusive Kubernetes distribution, which is configured with all of the features needed to build a Kubernetes cluster. Due to its simple design, flexible deployment options and modest system requirements, k0s is well suited for | ||
|  | ||
|  | ||
|
|
||
| - Any cloud | ||
| - Bare metal | ||
| - Edge and IoT | ||
| {% | ||
| include-markdown "../README.md" | ||
| start="<!-- Start Overview -->" | ||
| end="<!-- End Overview -->" | ||
| %} | ||
|
|
||
| k0s drastically reduces the complexity of installing and running a CNCF certified Kubernetes distribution. With k0s new clusters can be bootstrapped in minutes and developer friction is reduced to zero. This allows anyone with no special skills or expertise in Kubernetes to easily get started. | ||
| ## What happened to GitHub stargazers? | ||
|
|
||
| k0s is distributed as a single binary with zero host OS dependencies besides the host OS kernel. It works with any Linux without additional software packages or configuration. Any security vulnerabilities or performance issues can be fixed directly in the k0s distribution that makes it extremely straightforward to keep the clusters up-to-date and secure. | ||
|
|
||
| ## What happened to Github stargazers? | ||
|
|
||
| In September 2022 we made a human error while creating some build automation scripts&tools for the Github repository. Our automation accidentally changed the repo to a private one for few minutes. That itself is not a big deal and everything was restored quickly. But the nasty side effect is that it also removed all the stargazers at that point. :( | ||
| In September 2022 we made a human error while creating some build automation scripts&tools for the GitHub repository. Our automation accidentally changed the repo to a private one for few minutes. That itself is not a big deal and everything was restored quickly. But the nasty side effect is that it also removed all the stargazers at that point. :( | ||
|
|
||
| Before that mishap we had 4776 stargazers, making k0s one of the most popular Kubernetes distro out there. | ||
|
|
||
| **So if you are reading this, and have not yet starred [k0s repo](https://github.com/k0sproject/k0s/) we would highly appreciate the :star: to get our numbers closer to what they used to be.** | ||
|
|
||
| ## Key Features | ||
| **So if you are reading this, and have not yet starred the [k0s repository](https://github.com/k0sproject/k0s/) we would highly appreciate the :star: to get our numbers closer to what they used to be.** | ||
|
|
||
| - Certified and 100% upstream Kubernetes | ||
| - Multiple installation methods: [single-node](install.md), [multi-node](k0sctl-install.md), [airgap](airgap-install.md) and [Docker](k0s-in-docker.md) | ||
| - Automatic lifecycle management with k0sctl: [upgrade](upgrade.md), [backup and restore](backup.md) | ||
| - Modest [system requirements](system-requirements.md) (1 vCPU, 1 GB RAM) | ||
| - Available as a single binary with no [external runtime dependencies](external-runtime-deps.md) besides the kernel | ||
| - Flexible deployment options with [control plane isolation](networking.md#controller-worker-communication) as default | ||
| - Scalable from a single node to large, [high-available](high-availability.md) clusters | ||
| - Supports custom [Container Network Interface (CNI)](networking.md) plugins (Kube-Router is the default, Calico is offered as a preconfigured alternative) | ||
| - Supports custom [Container Runtime Interface (CRI)](runtime.md) plugins (containerd is the default) | ||
| - Supports all Kubernetes storage options with [Container Storage Interface (CSI)](storage.md), includes [OpenEBS host-local storage provider](examples/openebs.md) | ||
| - Supports a variety of [datastore backends](configuration.md#specstorage): etcd (default for multi-node clusters), SQLite (default for single node clusters), MySQL, and PostgreSQL | ||
| - Supports x86-64, ARM64 and ARMv7 | ||
| - Includes [Konnectivity service](networking.md#controller-worker-communication), CoreDNS and Metrics Server | ||
| {% | ||
| include-markdown "../README.md" | ||
| start="<!-- Start Key Features -->" | ||
| end="<!-- End Key Features -->" | ||
| %} | ||
|
|
||
| ## Getting Started | ||
|
|
||
| [Quick Start Guide](install.md) for creating a full Kubernetes cluster with a single node. | ||
| - [Quick Start Guide](install.md) for creating a full Kubernetes cluster with a single node. | ||
| - [Install using k0sctl](k0sctl-install.md) - Deploy and upgrade multi-node clusters with one command. | ||
| - [Run k0s in Docker](k0s-in-docker.md) - Run k0s controllers and workers in containers. | ||
|
|
||
| ## Demo | ||
|
|
||
|  | ||
|
|
||
| ## Community Support | ||
|
|
||
| - [Lens Forums] - Request for support and help from the Lens and k0s community. | ||
| - [GitHub Issues] - Submit your issues and feature requests via GitHub. | ||
|
|
||
| We welcome your help in building k0s! If you are interested, we invite you to | ||
| check out the [Contributing Guide] and the [Code of Conduct]. | ||
|
|
||
| [Lens Forums]: https://forums.k8slens.dev/ | ||
| [GitHub Issues]: https://github.com/k0sproject/k0s/issues | ||
| [Contributing Guide]: https://docs.k0sproject.io/stable/contributors/overview/ | ||
| [Code of Conduct]:https://docs.k0sproject.io/stable/contributors/CODE_OF_CONDUCT/ | ||
|
|
||
| ## Community hours | ||
|
|
||
| We will be holding regular community hours. Everyone in the community is welcome to drop by and ask questions, talk about projects, and chat. | ||
|
|
||
| We currently have a monthly office hours call on the last Tuesday of the month. | ||
|
|
||
| To see the call details in your local timezone, check out [https://dateful.com/eventlink/2735919704](https://dateful.com/eventlink/2735919704). | ||
| {% | ||
| include-markdown "../README.md" | ||
| start="<!-- Start Join the Community -->" | ||
| end="<!-- End Join the Community -->" | ||
| %} | ||
|
|
||
| ## Commercial Support | ||
|
|
||
| [Mirantis](https://www.mirantis.com/software/k0s/) offers technical support, professional services and training for k0s. The support subscriptions include, for example, prioritized support (Phone, Web, Email) and access to verified extensions on top of your k0s cluster. | ||
|
|
||
| For any k0s inquiries, please contact us via email [[email protected]](mailto:[email protected]). | ||
|
|
||
| {% | ||
| include-markdown "../README.md" | ||
| start="<!-- Start Motivation -->" | ||
| end="<!-- End Motivation -->" | ||
| %} | ||
|
|
||
| {% | ||
| include-markdown "../README.md" | ||
| start="<!-- Start Scope -->" | ||
| end="<!-- End Scope -->" | ||
| %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters