|
7 | 7 | [](https://hub.docker.com/r/btwiuse/k0s)
|
8 | 8 | [](https://twitter.com/kubernot)
|
9 | 9 |
|
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 |
11 | 11 |
|
12 | 12 | - `scp` becomes `kubectl cp`
|
13 | 13 | - `ssh` becomes `kubectl exec`
|
14 | 14 | - `ssh -L` becomes `kubectl port-forward`
|
15 | 15 | - `~/.ssh/config` becomes `~/.kube/config`
|
16 | 16 |
|
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. |
18 | 18 |
|
19 | 19 | ||client|agent|server|
|
20 | 20 | |:--:|:--:|:--:|:--:|
|
21 | 21 | |SSH|`ssh`|-|`sshd`|
|
22 |
| -|Kubernot|`kubectl`|`k0s pode`|`k0s apiserver`| |
| 22 | +|Kubernot|`kubectl`|`knot`|`kuber`| |
23 | 23 | |Kubernetes|`kubectl`|`kubelet`|`kube-apiserver`|
|
24 | 24 |
|
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__: |
26 | 26 |
|
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. |
28 | 28 |
|
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: |
30 | 57 |
|
31 | 58 | - [ ] kubectl cp
|
32 | 59 | - [ ] kubectl exec
|
33 | 60 | - [ ] kubectl port-forward
|
34 | 61 | - [x] kubectl version
|
35 | 62 |
|
| 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 | + |
36 | 109 | The name __Kubernot__ is inspired by many:
|
37 | 110 |
|
38 | 111 | - [@alexellisuk](https://twitter.com/alexellisuk):
|
|
0 commit comments