Skip to content

Commit 1db6545

Browse files
author
navigaid
committed
README: Not Kubernetes
1 parent 3006900 commit 1db6545

File tree

1 file changed

+79
-6
lines changed

1 file changed

+79
-6
lines changed

.github/README.md

Lines changed: 79 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,105 @@
77
[![DockerHub](https://img.shields.io/docker/pulls/btwiuse/k0s.svg)](https://hub.docker.com/r/btwiuse/k0s)
88
[![@kubernot](https://img.shields.io/twitter/url/https/twitter.com/kubernot.svg?style=social&label=Follow%20%40kubernot)](https://twitter.com/kubernot)
99

10-
Kubernot is a modern SSH alternative with a Kubernetes-like interface, where
10+
Kubernot is an experimental SSH alternative with Kubernetes-like UX, where
1111

1212
- `scp` becomes `kubectl cp`
1313
- `ssh` becomes `kubectl exec`
1414
- `ssh -L` becomes `kubectl port-forward`
1515
- `~/.ssh/config` becomes `~/.kube/config`
1616

17-
Unlike SSH, Kubernot adopts the client-agent-server architecture from Kubernetes to allow accessing nodes behind a firewall.
17+
Unlike SSH, Kubernot adopts the client-agent-server model from Kubernetes that allows access to nodes behind a firewall.
1818

1919
||client|agent|server|
2020
|:--:|:--:|:--:|:--:|
2121
|SSH|`ssh`|-|`sshd`|
22-
|Kubernot|`kubectl`|`k0s pode`|`k0s apiserver`|
22+
|Kubernot|`kubectl`|`knot`|`kuber`|
2323
|Kubernetes|`kubectl`|`kubelet`|`kube-apiserver`|
2424

25-
Kubernot emulates a Kubernetes cluster by implementing a minimal subset of the [Kubernetes API](https://kubernetes.io/docs/concepts/overview/kubernetes-api/).
25+
Kubernot has two major components: __kuber__ and __knot__:
2626

27-
The apiserver is modelled after [kube-apiserver](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/), therefore compatible with the familiar `kubectl` CLI.
27+
- Kuber implements a minimal subset of [The Kubernetes API](https://kubernetes.io/docs/concepts/overview/kubernetes-api/), and is therefore compatible with kubectl.
2828

29-
Currently supported commands:
29+
It is directly modelled after [kube-apiserver](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).
30+
31+
- Knot is the equivalent of [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/) in Kubernetes.
32+
33+
It runs on targets like Windows / BSD / Android / Chrome (via WASI), since it only deals with processes, sockets and files - no container support is required.
34+
35+
## Not Kubernetes
36+
37+
Knowledge is power,
38+
39+
France is bacon,
40+
41+
but Kubernot is not Kubernetes:
42+
43+
44+
knot is not kubelet,
45+
46+
kuber is not kube-apiserver,
47+
48+
and k0s is not k8s.
49+
50+
Kubernot is not a distro of Kubernetes, but is designed to resemble it, and should therefore be shortened to __k0s__, mimicking the spelling of k8s.
51+
52+
When shortened to k0s, the pronunciation should be "chaos" not "kay-zero-es" in order to distinguish from [Mirantis' k0s](https://www.mirantis.com/software/k0s/).
53+
54+
## Features
55+
56+
Currently supported kubectl commands are:
3057

3158
- [ ] kubectl cp
3259
- [ ] kubectl exec
3360
- [ ] kubectl port-forward
3461
- [x] kubectl version
3562

63+
## Getting Started
64+
65+
`k0s` is the multicall binary of Kubernot. To install it, run:
66+
67+
```
68+
$ go install k0s.io/cmd/k0s@latest
69+
```
70+
71+
Alternatively, standalone commands can be installed like this:
72+
73+
```
74+
$ go install k0s.io/cmd/knot@latest
75+
```
76+
77+
```
78+
$ go install k0s.io/cmd/kuber@latest
79+
```
80+
81+
To start the server, run:
82+
83+
```
84+
$ k0s kuber
85+
```
86+
87+
or
88+
89+
```
90+
$ kuber
91+
```
92+
93+
then point kubectl to http://127.0.0.1:8000 and print the version:
94+
95+
```
96+
$ kubectl -s http://127.0.0.1:8000 version
97+
```
98+
99+
or use the embedded kubectl
100+
101+
```
102+
$ k0s kubectl -s http://127.0.0.1:8000 version
103+
```
104+
105+
if you don't have it readily installed.
106+
107+
## Credits
108+
36109
The name __Kubernot__ is inspired by many:
37110

38111
- [@alexellisuk](https://twitter.com/alexellisuk):

0 commit comments

Comments
 (0)