diff --git a/docs/index.md b/docs/index.md index 2ae31b97d..9ca09ceb9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,15 +2,17 @@ ๐Ÿงธ Smol K8s Lab -`smol-k8s-lab` leverages Argo CD and slim k8s distributions like K3s to create production-like environments via a declarative workflow. Batteries and ๐Ÿฆ‘ included. +Leverage Argo CD and slim Kubernetes distributions, like K3s, to create production-like environments via a declarative workflow. Batteries and ๐Ÿฆ‘ included. ## About -`smol-k8s-lab`'s declarative workflow, CLI, and TUI enable rapid iteration in production-like environments with minimal costs for failure. This makes it ideal for proof-of-concepts, prototyping, and benchmarking Kubernetes applications and distributions! ๐Ÿ’™ +`smol-k8s-lab`'s declarative workflow, CLI, and TUI enable rapid iteration in production-like environments with minimal costs for failure. This makes it ideal for proof-of-concepts, prototyping, and benchmarking Kubernetes applications and distributions. It's also great for home labs, with some common FOSS apps such as Home Assistant, Nextcloud, Matrix, and more! -By default, `smol-k8s-lab` deploys [Argo CD] + [Argo CD Appset Secret Plugin] which enables Argo CD to securely manage your lab via files in open-source Git repos. We can optionally make heavy use of Bitwarden. Additionally, a customized dark-theme is provided for Argo CD's incredibly useful web-interface. +By default, it deploys [Argo CD] + [Argo CD Appset Secret Plugin] which enables Argo CD to securely manage your lab via files in open source Git repos. Additionally, a customized dark-theme is provided for Argo CD's incredibly useful web-interface. -Consider viewing my very long walk through if you like video walk-throughs: +`smol-k8s-lab` can also optionally make heavy use of Bitwarden to store any passwords, tokens, and secrets so you can use them immediately. + +Consider viewing our very long walk through if you like video walk-throughs:

@@ -23,8 +25,8 @@ Here's the [same video with captions](https://youtu.be/2E9DVJpv440?feature=share Please see our [Getting Started guide](https://small-hack.github.io/smol-k8s-lab/installation). # Under the hood -Note: this project is not officially affiliated with any of the below tooling or applications. +Note: this project is not officially affiliated with any of the below tooling or applications. We just love open source projects ๐Ÿ’™ ## Supported k8s distributions We always install the latest version of Kubernetes that is available from the distro's startup script. @@ -32,10 +34,10 @@ We always install the latest version of Kubernetes that is available from the di | Distro | Description | |:------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------| | [][k3s]
[k3s] | The certified Kubernetes distribution built for IoT & Edge computing | -| [][k3d]
[k3d] | K3d is k3s in Docker ๐Ÿณ.
โš ๏ธ testing | +| [][k3d]
[k3d] | K3d is k3s in Docker ๐Ÿณ.
In beta! | | [][KinD]
[KinD] | kind is a tool for running local Kubernetes clusters using Docker container โ€œnodesโ€. kind was primarily designed for testing Kubernetes itself. | -We tend to test first on k3s first, then the other distros. k3d support coming soon. +We tend to test first on k3s first, then the other distros. ## Default Installed Applications Version is the helm chart version, or manifest version. See the [Default Applications](/k8s_apps/argocd) tab for more info on each application. @@ -69,7 +71,7 @@ Minor Notes: | [kepler logo][kepler]
[kepler] | Kepler (Kubernetes Efficient Power Level Exporter) uses eBPF to probe energy-related system stats and exports them as Prometheus metrics. | โœ… | | [k8up logo, a minimalist logo of a small blue hill with line starting the right going into the hill][k8up]
[k8up] | Backups operator using [restic] to backup to s3 endpoints | โœ… | | [k8tz logo, the k8s logo but with a watch in the center instead of the ship wheel][k8tz]
[k8tz] | Timezone environment variable injector for pods and cronjobs | โœ… | -| [netmaker logo, a purple letter N][Netmaker]
[Netmaker] | Netmaker is a self hosted vpn management tool | โœ… | +| [netmaker logo, a purple letter N][Netmaker]
[Netmaker] | Netmaker is a self hosted vpn management tool that uses Wiregaurdยฎ | โœ… | | [nextcloud logo, 3 white circles touching eachother on a blue background][Nextcloud]
[Nextcloud] | Nextcloud is a self hosted file server | โœ… | | [Mastodon logo, a white M in a purple chat bubble][Mastodon]
[Mastodon] | Mastodon is a self hosted federated social media network | โœ… | | [Matrix logo][matrix]
[matrix] | Matrix is a self hosted chat platform | โœ… | @@ -79,14 +81,14 @@ Minor Notes: # Status - +`smol-k8s-lab` is actively maintained, and in a semi-stable state. We still may introduce features that, upon major version releases, can introduce breaking changes, but we'll always include how to update your config files in the merged pull request description, and that will be linked in the release notes. ## Development -smol-k8s-lab is written in Python and built and published using [Poetry]. You can check out the [`pyproject.toml`](https://github.com/small-hack/smol-k8s-lab/blob/main/pyproject.toml) for the versions of each library we install below. +`smol-k8s-lab` is written in Python 3.12 and built and published using [Poetry]. You can check out the [`pyproject.toml`](https://github.com/small-hack/smol-k8s-lab/blob/main/pyproject.toml) for the versions of each library we install below. ### Core libraries -These are installed anytime you install smol-k8s-lab as an end user: +These are installed anytime you install `smol-k8s-lab` as an end user: | Default Library | Description | |-----------------|----------------------------------------------------------------------------------|