You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
30 - update documentation website, README, and --help text (#33)
* forgot all the links 🤦
* adding kind config to be bundled properly with the pip package
* fixing issue where kind wouldn't have the file it needed from pypi
* fix help text to have XDG note on README. + fix -h --help display
* test image table formatting
* fixing distros table, and testing apps table
* trying a different html break
* fixing docs and testing if same fix works in readme
* finish fixing readme to match docs
* fix nav order and add table of contents so quickstart still appears
* uncrowd quickstart and fix pathing
* attempt to fix collapsibles again
* remove link for image
* try another bullet format and remove - from summary name
* update krew section
* more data about kubectl krew
* be more verbose
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k0s-logo.svg"width="32">][k0s]</br>[k0s]| Simple, Solid & Certified Kubernetes Distribution |
39
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k3s_icon.ico"width="26">][k3s]</br>[k3s]| The certified Kubernetes distribution built for IoT & Edge computing |
40
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/kind_icon.png"width="32">][KinD]</br>[KinD]| kind is a tool for running local Kubernetes clusters using Docker container “nodes”. kind was primarily designed for testing Kubernetes itself, but may be used for local development or CI. |
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k3s_icon.ico"width="26">][k3s] <br /> [k3s]| The certified Kubernetes distribution built for IoT & Edge computing |
40
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/kind_icon.png"width="32">][KinD] <br /> [KinD]| kind is a tool for running local Kubernetes clusters using Docker container “nodes”. kind was primarily designed for testing Kubernetes itself, but may be used for local development or CI. |
41
41
42
42
We tend to test first on k3s first, then the other distros.
43
43
@@ -47,20 +47,20 @@ Version is the helm chart version, or manifest version.
| 🐄</br>[Local Path Provisioner]| k3s latest | Default simple local file storage for persistent data |
51
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/metallb_icon.png"width="32px"alt="metallb logo, blue arrow pointing up, with small line on one leg of arrow to show balance">][metallb]</br> [metallb]| 0.13.7 | loadbalancer for metal, since we're mostly selfhosting |
52
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/nginx.ico"width="32px"alt="nginx logo, white letter N with green background">][nginx-ingress]</br>[nginx-ingress]| 4.4.0 | The ingress controller allows access to the cluster remotely, needed for web traffic |
53
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/cert-manager_icon.png"width="32px"alt="cert manager logo">][cert-manager]</br>[cert-manager]| 1.10.1 | For SSL/TLS certificates |
50
+
| 🐄 <br /> [Local Path Provisioner]| k3s latest | Default simple local file storage for persistent data |
51
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/metallb_icon.png"width="32px"alt="metallb logo, blue arrow pointing up, with small line on one leg of arrow to show balance">][metallb] <br /> [metallb]| 0.13.7 | loadbalancer for metal, since we're mostly selfhosting |
52
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/nginx.ico"width="32px"alt="nginx logo, white letter N with green background">][nginx-ingress] <br /> [nginx-ingress]| 4.4.0 | The ingress controller allows access to the cluster remotely, needed for web traffic |
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k9s_icon.png"alt="k9s logo, outline of dog with ship wheels for eyes"width="32px">][k9s]</br>[k9s]| latest | Terminal based dashboard for kubernetes |
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/eso_icon.png"width="32"alt="ESO logo, outline of robot with astricks in a screen in it's belly">][ESO]</br>[ESO]| 0.6.1 | external-secrets-operator integrates external secret management systems like GitLab|
62
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/argo_icon.png"width="32"alt="argo CD logo, an organer squid wearing a fishbowl helmet">][Argo CD]</br>[Argo CD]| 5.16.2 | Gitops - Continuous Deployment |
63
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/kyverno_icon.png"width="32"alt="kyvero logo">][Kyverno]</br>[Kyverno]| latest | Kubernetes native policy management to enforce policies on k8s resources |
61
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/eso_icon.png"width="32"alt="ESO logo, outline of robot with astricks in a screen in it's belly">][ESO] <br /> [ESO]| 0.6.1 | external-secrets-operator integrates external secret management systems like GitLab|
62
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/argo_icon.png"width="32"alt="argo CD logo, an organer squid wearing a fishbowl helmet">][Argo CD] <br /> [Argo CD]| 5.16.2 | Gitops - Continuous Deployment |
63
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/kyverno_icon.png"width="32"alt="kyvero logo">][Kyverno] <br /> [Kyverno]| latest | Kubernetes native policy management to enforce policies on k8s resources |
Copy file name to clipboardExpand all lines: docs/index.md
+41-21Lines changed: 41 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,53 +2,47 @@
2
2
layout: default
3
3
title: Intro
4
4
description: "Smol K8s Lab Overview"
5
+
has_children: true
5
6
nav_order: 1
6
7
permalink: /
7
8
---
8
9
9
10
## ☁️ *smol k8s lab* 🧸
10
11
[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/screenshots/help_text.svg"alt="Output of smol-k8s-lab --help after cloning the directory and installing the prerequisites.">](https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/screenshots/help_text.svg)
11
12
12
-
This is aimed at getting up and running quickly with mostly smaller k8s distros in one small command line script.
13
-
14
-
## QuickStart
15
-
Get started with `smol-k8s-lab` today with our tutorial [here](https://jessebot.github.io/smol-k8s-lab/quickstart).
16
-
17
-
There's also full tutorials to manually set up different distros in the [docs we maintain](https://jessebot.github.io/smol-k8s-lab/distros) as well as BASH scripts for basic automation of each k8s distro in:
18
-
19
-
`./distro/[NAME OF K8S DISTRO]/bash_full_quickstart.sh`
13
+
A project aimed at getting up and running quickly with mostly smaller k8s distros in one small command line script.
20
14
21
15
### Supported k8s distributions
22
16
We always install the latest version of kubernetes that is available from the distro's startup script.
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k0s-logo.svg"width="32">][k0s]</br>[k0s]| Simple, Solid & Certified Kubernetes Distribution |
27
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k3s_icon.ico"width="26">][k3s]</br>[k3s]| The certified Kubernetes distribution built for IoT & Edge computing |
28
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/kind_icon.png"width="32">][KinD]</br>[KinD]| kind is a tool for running local Kubernetes clusters using Docker container “nodes”. kind was primarily designed for testing Kubernetes itself, but may be used for local development or CI. |
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k3s_icon.ico"width="26">][k3s] <br /> [k3s]| The certified Kubernetes distribution built for IoT & Edge computing |
22
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/kind_icon.png"width="32">][KinD] <br /> [KinD]| kind is a tool for running local Kubernetes clusters using Docker container “nodes”. kind was primarily designed for testing Kubernetes itself, but may be used for local development or CI. |
29
23
30
-
We tend to test first on k3s first, then the other distros.
24
+
We tend to test first on kind and k3s first, then k0s.
31
25
32
26
33
27
### Stack We Install on K8s
34
28
Version is the helm chart version, or manifest version.
| 🐄</br>[Local Path Provisioner]| k3s latest | Default simple local file storage for persistent data |
39
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/metallb_icon.png"width="32px"alt="metallb logo, blue arrow pointing up, with small line on one leg of arrow to show balance">][metallb]</br> [metallb]| 0.13.7 | loadbalancer for metal, since we're mostly selfhosting |
40
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/nginx.ico"width="32px"alt="nginx logo, white letter N with green background">][nginx-ingress]</br>[nginx-ingress]| 4.4.0 | The ingress controller allows access to the cluster remotely, needed for web traffic |
41
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/cert-manager_icon.png"width="32px"alt="cert manager logo">][cert-manager]</br>[cert-manager]| 1.10.1 | For SSL/TLS certificates |
42
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k9s_icon.png"alt="k9s logo, outline of dog with ship wheels for eyes"width="32px">][k9s]</br>[k9s]| latest | Terminal based dashboard for kubernetes |
32
+
| 🐄[Local Path Provisioner]| k3s latest | Default simple local file storage for persistent data |
33
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/metallb_icon.png"width="32px"alt="metallb logo, blue arrow pointing up, with small line on one leg of arrow to show balance">][metallb] <br /> [metallb]| 0.13.7 | loadbalancer for metal, since we're mostly selfhosting |
34
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/nginx.ico"width="32px"alt="nginx logo, white letter N with green background">][nginx-ingress] <br /> [nginx-ingress]| 4.4.0 | The ingress controller allows access to the cluster remotely, needed for web traffic |
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/k9s_icon.png"alt="k9s logo, outline of dog with ship wheels for eyes"width="32px">][k9s] <br /> [k9s]| latest | Terminal based dashboard for kubernetes |
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/eso_icon.png"width="32"alt="ESO logo, outline of robot with astricks in a screen in it's belly">][ESO]</br>[ESO]| 0.6.1 | external-secrets-operator integrates external secret management systems like GitLab|
50
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/argo_icon.png"width="32"alt="argo CD logo, an organer squid wearing a fishbowl helmet">][Argo CD]</br>[Argo CD]| 5.16.2 | Gitops - Continuous Deployment |
51
-
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/kyverno_icon.png"width="32"alt="kyvero logo">][Kyverno]</br>[Kyverno]| latest | Kubernetes native policy management to enforce policies on k8s resources |
43
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/eso_icon.png"width="32"alt="ESO logo, outline of robot with astricks in a screen in it's belly">][ESO] <br /> [ESO]| 0.6.1 | external-secrets-operator integrates external secret management systems like GitLab|
44
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/argo_icon.png"width="32"alt="argo CD logo, an organer squid wearing a fishbowl helmet">][Argo CD] <br /> [Argo CD]| 5.16.2 | Gitops - Continuous Deployment |
45
+
|[<imgsrc="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/icons/kyverno_icon.png"width="32"alt="kyvero logo">][Kyverno] <br /> [Kyverno]| latest | Kubernetes native policy management to enforce policies on k8s resources |
52
46
53
47
54
48
### Tooling Used for the CLI itself and interface
@@ -61,12 +55,38 @@ smol-k8s-lab is written in Python and built and published using [Poetry]. You ca
61
55
62
56
We also utilize the [Bitwarden cli], for a password manager so you never have to see/know your argocd password.
63
57
58
+
## Things we don't handle
59
+
64
60
### Port Forwarding
65
61
If you want to access an app outside of port forwarding to test, you'll need to make sure your app's ingress is setup correctly and then you'll need to setup your router to port forward 80->80 and 443->443 for your WAN. then setup DNS for your domain if you want the wider internet to access this remotely.
66
62
67
63
### SSL/TLS
68
-
69
64
After SSL is working (if it's not, follow the steps in the [cert-manager common error troubleshooting guide](https://cert-manager.io/docs/faq/acme/#common-errors)), you can also change the `letsencrypt-staging` value to `letsencrypt-prod` for any domains you own and can configure to point to your cluster via DNS.
70
65
71
66
### Troubleshooting
72
67
If you're stuck, checkout the [Notes section](https://jessebot.github.io/smol-k8s-lab/notes) to see if we also got stuck on the same thing at some point :)
0 commit comments