-
Notifications
You must be signed in to change notification settings - Fork 361
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed 92ae77c to head with MkDocs 1.6.1 and mike 2.1.3
- Loading branch information
1 parent
f02e589
commit 882d404
Showing
4 changed files
with
258 additions
and
131 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -325,10 +325,19 @@ | |
| </label> | ||
| <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#overview" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Overview | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#what-happened-to-github-stargazers" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| What happened to Github stargazers? | ||
| What happened to GitHub stargazers? | ||
| </span> | ||
| </a> | ||
|
|
||
|
|
@@ -362,21 +371,36 @@ | |
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#community-support" class="md-nav__link"> | ||
| <a href="#join-the-community" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Community Support | ||
| Join the Community | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <nav class="md-nav" aria-label="Join the Community"> | ||
| <ul class="md-nav__list"> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#community-hours" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Community hours | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#adopters" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Adopters | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| </ul> | ||
| </nav> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
|
|
@@ -386,6 +410,24 @@ | |
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#motivation" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Motivation | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#scope" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Scope | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| </ul> | ||
|
|
@@ -2079,10 +2121,19 @@ | |
| </label> | ||
| <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#overview" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Overview | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#what-happened-to-github-stargazers" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| What happened to Github stargazers? | ||
| What happened to GitHub stargazers? | ||
| </span> | ||
| </a> | ||
|
|
||
|
|
@@ -2116,21 +2167,36 @@ | |
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#community-support" class="md-nav__link"> | ||
| <a href="#join-the-community" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Community Support | ||
| Join the Community | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <nav class="md-nav" aria-label="Join the Community"> | ||
| <ul class="md-nav__list"> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#community-hours" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Community hours | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#adopters" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Adopters | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| </ul> | ||
| </nav> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
|
|
@@ -2140,6 +2206,24 @@ | |
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#motivation" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Motivation | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| <li class="md-nav__item"> | ||
| <a href="#scope" class="md-nav__link"> | ||
| <span class="md-ellipsis"> | ||
| Scope | ||
| </span> | ||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| </ul> | ||
|
|
@@ -2158,19 +2242,29 @@ | |
|
|
||
|
|
||
| <h1 id="k0s-the-zero-friction-kubernetes">k0s - The Zero Friction Kubernetes<a class="headerlink" href="#k0s-the-zero-friction-kubernetes" title="Permanent link">#</a></h1> | ||
| <p><img alt="k0s logo" src="img/k0s-logo-full-color-light.svg" /></p> | ||
| <p>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</p> | ||
| <!-- When changing this file, consider to change ../README.md, too! --> | ||
|
|
||
| <p><img alt="k0s-logo-dark" src="img/k0s-logo-full-color-dark.svg#only-dark" /> | ||
| <img alt="k0s-logo-light" src="img/k0s-logo-full-color-light.svg#only-light" /></p> | ||
| <!-- BEGIN INCLUDE ../README.md '<!-- Start Overview -->' '<!-- End Overview -->' --> | ||
|
|
||
| <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">#</a></h2> | ||
| <p>k0s is an open source, all-inclusive Kubernetes distribution, which is configured with all of the features needed to build a Kubernetes cluster and packaged as a single binary for ease of use. Due to its simple design, flexible deployment options and modest system requirements, k0s is well suited for</p> | ||
| <ul> | ||
| <li>Any cloud</li> | ||
| <li>Bare metal</li> | ||
| <li>Edge and IoT</li> | ||
| </ul> | ||
| <p>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.</p> | ||
| <p>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.</p> | ||
| <h2 id="what-happened-to-github-stargazers">What happened to Github stargazers?<a class="headerlink" href="#what-happened-to-github-stargazers" title="Permanent link">#</a></h2> | ||
| <p>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. :(</p> | ||
| <!-- END INCLUDE --> | ||
|
|
||
| <h2 id="what-happened-to-github-stargazers">What happened to GitHub stargazers?<a class="headerlink" href="#what-happened-to-github-stargazers" title="Permanent link">#</a></h2> | ||
| <p>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. :(</p> | ||
| <p>Before that mishap we had 4776 stargazers, making k0s one of the most popular Kubernetes distro out there.</p> | ||
| <p><strong>So if you are reading this, and have not yet starred <a href="https://github.com/k0sproject/k0s/">k0s repo</a> we would highly appreciate the :star: to get our numbers closer to what they used to be.</strong></p> | ||
| <p><strong>So if you are reading this, and have not yet starred the <a href="https://github.com/k0sproject/k0s/">k0s repository</a> we would highly appreciate the :star: to get our numbers closer to what they used to be.</strong></p> | ||
| <!-- BEGIN INCLUDE ../README.md '<!-- Start Key Features -->' '<!-- End Key Features -->' --> | ||
|
|
||
| <h2 id="key-features">Key Features<a class="headerlink" href="#key-features" title="Permanent link">#</a></h2> | ||
| <ul> | ||
| <li>Certified and 100% upstream Kubernetes</li> | ||
|
|
@@ -2182,29 +2276,62 @@ <h2 id="key-features">Key Features<a class="headerlink" href="#key-features" tit | |
| <li>Scalable from a single node to large, <a href="high-availability/">high-available</a> clusters</li> | ||
| <li>Supports custom <a href="networking/">Container Network Interface (CNI)</a> plugins (Kube-Router is the default, Calico is offered as a preconfigured alternative)</li> | ||
| <li>Supports custom <a href="runtime/">Container Runtime Interface (CRI)</a> plugins (containerd is the default)</li> | ||
| <li>Supports all Kubernetes storage options with <a href="storage/">Container Storage Interface (CSI)</a>, includes <a href="examples/openebs/">OpenEBS host-local storage provider</a></li> | ||
| <li>Supports all Kubernetes storage options with <a href="storage/">Container Storage Interface (CSI)</a></li> | ||
| <li>Supports a variety of <a href="configuration/#specstorage">datastore backends</a>: etcd (default for multi-node clusters), SQLite (default for single node clusters), MySQL, and PostgreSQL</li> | ||
| <li>Supports x86-64, ARM64 and ARMv7</li> | ||
| <li>Includes <a href="networking/#controller-worker-communication">Konnectivity service</a>, CoreDNS and Metrics Server</li> | ||
| </ul> | ||
| <!-- END INCLUDE --> | ||
|
|
||
| <h2 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">#</a></h2> | ||
| <p><a href="install/">Quick Start Guide</a> for creating a full Kubernetes cluster with a single node.</p> | ||
| <ul> | ||
| <li><a href="install/">Quick Start Guide</a> for creating a full Kubernetes cluster with a single node.</li> | ||
| <li><a href="k0sctl-install/">Install using k0sctl</a> - Deploy and upgrade multi-node clusters with one command.</li> | ||
| <li><a href="k0s-in-docker/">Run k0s in Docker</a> - Run k0s controllers and workers in containers.</li> | ||
| </ul> | ||
| <h2 id="demo">Demo<a class="headerlink" href="#demo" title="Permanent link">#</a></h2> | ||
| <p><img alt="k0s demo" src="img/k0s_demo.gif" /></p> | ||
| <h2 id="community-support">Community Support<a class="headerlink" href="#community-support" title="Permanent link">#</a></h2> | ||
| <!-- BEGIN INCLUDE ../README.md '<!-- Start Join the Community -->' '<!-- End Join the Community -->' --> | ||
|
|
||
| <h2 id="join-the-community">Join the Community<a class="headerlink" href="#join-the-community" title="Permanent link">#</a></h2> | ||
| <ul> | ||
| <li><a href="https://forums.k8slens.dev/">Lens Forums</a> - Request for support and help from the Lens and k0s community.</li> | ||
| <li><a href="https://github.com/k0sproject/k0s/issues">GitHub Issues</a> - Submit your issues and feature requests via GitHub.</li> | ||
| </ul> | ||
| <p>We welcome your help in building k0s! If you are interested, we invite you to | ||
| check out the <a href="https://docs.k0sproject.io/stable/contributors/overview/">Contributing Guide</a> and the <a href="https://docs.k0sproject.io/stable/contributors/CODE_OF_CONDUCT/">Code of Conduct</a>.</p> | ||
| <h2 id="community-hours">Community hours<a class="headerlink" href="#community-hours" title="Permanent link">#</a></h2> | ||
| <h3 id="community-hours">Community hours<a class="headerlink" href="#community-hours" title="Permanent link">#</a></h3> | ||
| <p>We will be holding regular community hours. Everyone in the community is welcome to drop by and ask questions, talk about projects, and chat.</p> | ||
| <p>We currently have a monthly office hours call on the last Tuesday of the month.</p> | ||
| <p>To see the call details in your local timezone, check out <a href="https://dateful.com/eventlink/2735919704">https://dateful.com/eventlink/2735919704</a>.</p> | ||
| <h3 id="adopters">Adopters<a class="headerlink" href="#adopters" title="Permanent link">#</a></h3> | ||
| <p>k0s is used in numerous cases and environments. The range we've seen it being adopted ranges from very small far edge deployments to big data center deployments. Please add your use case to <a href="adopters/">adopters</a> list.</p> | ||
| <!-- END INCLUDE --> | ||
|
|
||
| <h2 id="commercial-support">Commercial Support<a class="headerlink" href="#commercial-support" title="Permanent link">#</a></h2> | ||
| <p><a href="https://www.mirantis.com/software/k0s/">Mirantis</a> 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.</p> | ||
| <p>For any k0s inquiries, please contact us via email <a href="mailto:[email protected]">[email protected]</a>.</p> | ||
| <!-- BEGIN INCLUDE ../README.md '<!-- Start Motivation -->' '<!-- End Motivation -->' --> | ||
|
|
||
| <h2 id="motivation">Motivation<a class="headerlink" href="#motivation" title="Permanent link">#</a></h2> | ||
| <p><em>We have seen a gap between the host OS and Kubernetes that runs on top of it: How to ensure they work together as they are upgraded independent from each other? Who is responsible for vulnerabilities or performance issues originating from the host OS that affect the K8S on top?</em></p> | ||
| <p><strong>→</strong> k0s is fully self contained. It’s distributed as a single binary with no host OS deps besides the kernel. Any vulnerability or perf issues may be fixed in k0s Kubernetes.</p> | ||
| <p><em>We have seen K8S with partial FIPS security compliance: How to ensure security compliance for critical applications if only part of the system is FIPS compliant?</em></p> | ||
| <p><strong>→</strong> k0s core + all included host OS dependencies + components on top may be compiled and packaged as a 100% FIPS compliant distribution using a proper toolchain.</p> | ||
| <p><em>We have seen Kubernetes with cumbersome lifecycle management, high minimum system requirements, weird host OS and infra restrictions, and/or need to use different distros to meet different use cases.</em></p> | ||
| <p><strong>→</strong> k0s is designed to be lightweight at its core. It comes with a tool to automate cluster lifecycle management. It works on any host OS and infrastructure, and may be extended to work with any use cases such as edge, IoT, telco, public clouds, private data centers, and hybrid & hyper converged cloud applications without sacrificing the pure Kubernetes compliance or amazing developer experience.</p> | ||
| <!-- END INCLUDE --> | ||
|
|
||
| <!-- BEGIN INCLUDE ../README.md '<!-- Start Scope -->' '<!-- End Scope -->' --> | ||
|
|
||
| <h2 id="scope">Scope<a class="headerlink" href="#scope" title="Permanent link">#</a></h2> | ||
| <p>While some Kubernetes distros package everything and the kitchen sink, k0s tries to minimize the amount of "add-ons" to bundle in. Instead, we aim to provide a robust and versatile "base" for running Kubernetes in various setups. Of course we will provide some ways to easily control and setup various "add-ons", but we will not bundle many of those into k0s itself. There are a couple of reasons why we think this is the correct way:</p> | ||
| <ul> | ||
| <li>Many of the addons such as ingresses, service meshes, storage etc. are VERY opinionated. We try to build this base with fewer opinions. :D</li> | ||
| <li>Keeping up with the upstream releases with many external addons is very maintenance heavy. Shipping with old versions does not make much sense either.</li> | ||
| </ul> | ||
| <p>With strong enough arguments we might take in new addons, but in general those should be something that are essential for the "core" of k0s.</p> | ||
| <!-- END INCLUDE --> | ||
|
|
||
|
|
||
|
|
||
|
|
||
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.