K2s - Kubernetes distribution for Windows & Linux workloads

Read the K2s Online Documentation.

K2s is a Kubernetes distribution which packages different open-source components into one small and easy to use solution focusing on running mixed Windows-based & Linux-based workloads in Kubernetes.

This solution is installable on Windows hosts.

The name K2s comes from the fact that we start with the default setting of 2 Kubernetes nodes (Windows & Linux) and it relates to K8s as synonym for Kubernetes.

Why K2s?

The problems that K2s solves are the following:

• It provides the option to construct a K8s cluster by reusing the Windows host as a node. This eliminates the need for an extra Windows license in the case of a mixed Windows & Linux cluster.
• Offline support is available for all use cases, eliminating the requirement for an internet connection.
• It offers an easy path for migrating bare metal Windows applications to K8s workloads.
• It maintains a low footprint by utilizing a single virtual machine for Linux workloads (Hyper-V or WSL).
• It is built 100% on open-source technology, requiring no additional licenses.

See also the Features List.

Quick Start

1. Get K2s
2. Verify that the Prerequisites are fulfilled
3. Run as administrator in the installation/repository folder:

   k2s.exe install

4. Check K2s cluster health:

   k2s.exe status

5. Deploy your workloads :rocket:

See k2s CLI and CLI Shortcuts for more means to interact with the K2s cluster.

Optionally, install one or more K2s Addons for additional functionality.

To create an offline installer first, check out Creating Offline Package.

Supported OS Versions

See also Windows-based Images.

Hosting Variants

Further Usage

• Getting K2s
• Installing K2s
• Starting K2s
• Checking K2s Status
• Stopping K2s
• Uninstalling K2s
• Adding a Container Registry
• Building a Container Image
• CLI Shortcuts
• Upgrading K2s
• Creating Offline Package

Addons

K2s provides a rich set of addons which are containing specific functionality, checkout the k2s addons command for all options. These addons can be used for testing and rapid prototyping purposes, as well in selected product scenarios.

Contributing

Training

Troubleshooting