README
¶
K2s (Kubernetes) Setup
K2s solution is a Kubernetes (K8s) distribution which packages different components into one small and easy to use solution. It has its focus on running mixed Windows & Linux workloads in Kubernetes and it's available on Windows hosts.
Why K2s distribution ?
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 on 100% open source technology, requiring no additional licenses.
The name K2s comes from the fact that we start with the default setting of 2 K8s nodes (Windows & Linux) and it relates to K8s with the intention to solve the problems mentioned above.
See Features for a full list of features.
Quickstart
Extract the downloaded K2s.zip file to a folder of your choice (use C: drive if possible), open a command prompt as Administrator and navigate to the installation folder.
Install K2s with (ensure to verify the Prerequisites first):
<installation folder>\k2s.exe install
After installation, you can utilize one of the shortcuts to interact with your newly created cluster:
k - shows the commands available for interacting with the K8s cluster
ks - get the state of the cluster
kgn - show the nodes of the cluster
kgp - show all the pods running in the cluster
...
Beside the raw K8s cluster we are also providing a rich set of addons, which are bringing additional specific functionality to your cluster. Enabling such an addon is a straightforward process:
k2s addons ls - lists all the available addons
k2s addons enable ingress-nginx - enables the ingress nginx ingress controller
...
Disabling the same addon:
k2s addons disable ingress-nginx - disables the ingress nginx ingress controller
...
Uninstalling the cluster removes not only the cluster itself but also all the workloads within the cluster:
<installation folder>\k2s uninstall
Supported OS Versions
| Windows | Version | Build |
|---|---|---|
| Windows 10, Server 2019 | 1809 | 10.0.17763.xxxx |
| Windows 10 | 2004 | 10.0.19041.xxxx |
| Windows 10 | 20H2 | 10.0.19042.xxxx |
| Windows 10 | 21H2 | 10.0.19044.xxxx |
| Windows 10 | 22H2 | 10.0.19045.xxxx |
| Windows Server 2022 | 21H2 | 10.0.20348.xxxx |
| Windows 11 | 21H2 | 10.0.22000.xxxx |
| Windows 11 | 22H2 | 10.0.22621.xxxx |
| Windows 11 | 23H2 | 10.0.22631.xxxx |
See also Windows-based Images.
Hosting variants:
-
Host Variant: On the Windows host, a single virtual machine is exclusively utilized as the Linux master node, while the Windows host itself functions as the worker node. This variant is also the default, it offers very low memory consumption and efficiency. Memory usage starts at 4GB.
-
Multi VM Variant: For each node, a virtual machine is created, with a minimum configuration of one Windows node and one Linux node. The memory usage for each node starts at 10GB.
-
Development Only Variant: In this variant, the focus is on setting up an environment solely for building and testing Windows and Linux containers without creating a K8s cluster.
In addition to offering a K8s cluster setup, the K2s solution also provides tools for building and testing Windows and Linux container (checkout the k2s image command options).
For development only cases where no K8s is needed and the focus is only on building and testing containers (Windows & Linux), K2s offers a way to do that.
Further Usage
- Get K2s
- Install K2s
- Start K2s (optional, K8s cluster starts automatically after installation)
- Inspect Cluster Status
- Stop K2s
- Uninstall K2s
- Add a registry
- Build a container image
- Shortcuts for interacting with cluster
- Upgrading your cluster
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.
Troubleshoot
Contribute
Training for Kubernetes
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
util/pause
package main connects to the given host and port and redirects its stdin to the connection and the connection's output to stdout.
|
package main connects to the given host and port and redirects its stdin to the connection and the connection's output to stdout. |