From 138e0aa8322cfff53ce6f84e0f34fd1e9c7a75ca Mon Sep 17 00:00:00 2001 From: Devin Buhl Date: Mon, 29 Jan 2024 10:12:30 -0500 Subject: [PATCH] chore: update readme Signed-off-by: Devin Buhl --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b5b35a09..f3d89ef3 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,24 @@ The goal of this project is to make it easier for people interested in using Kub ## ✨ Features -There are currently 3 different types of configurations available with this template. +The features included will depend on the type of configuration you want to use. There are currently **3 different types** of **configurations** available with this template. -"**Bare cluster**" - a distrubition of your choosing ([k0s](https://github.com/k0sproject/k0s), [k3s](https://github.com/k3s-io/k3s) or [Talos](https://github.com/siderolabs/talos)) that comes with only [kube-vip](https://github.com/kube-vip/kube-vip) _(k0s/k3s)_ and [Cilium](https://github.com/cilium/cilium) installed with the cluster. +1. "**Bare cluster**" - a distrubition of your choosing ([k0s](https://github.com/k0sproject/k0s), [k3s](https://github.com/k3s-io/k3s) or [Talos](https://github.com/siderolabs/talos)) that comes with only [kube-vip](https://github.com/kube-vip/kube-vip) _(k0s/k3s)_ and [Cilium](https://github.com/cilium/cilium) installed with the cluster. -- **Apps included:** None + - **Apps included:** None -"**Flux cluster**" - Add-on to the "**Bare cluster**" to deploy an opinionated implementation of [Flux](https://github.com/fluxcd/flux2) using [GitHub](https://github.com/) as GitOps provider and [sops](https://github.com/getsops/sops) to manage secrets. +2. "**Flux cluster**" - Add-on to the "**Bare cluster**" to deploy an opinionated implementation of [Flux](https://github.com/fluxcd/flux2) using [GitHub](https://github.com/) as GitOps provider and [sops](https://github.com/getsops/sops) to manage secrets. -- **Apps included:** [cert-manager](https://github.com/cert-manager/cert-manager), [spegel](https://github.com/XenitAB/spegel), [reloader](https://github.com/stakater/Reloader) and [openebs](https://github.com/openebs/openebs) in [Local PV / Hostpath](https://openebs.io/docs/concepts/localpv) mode. + - **Apps included:** [flux](https://github.com/fluxcd/flux2), [cert-manager](https://github.com/cert-manager/cert-manager), [spegel](https://github.com/XenitAB/spegel), [reloader](https://github.com/stakater/Reloader) and [openebs](https://github.com/openebs/openebs) in [Local PV / Hostpath](https://openebs.io/docs/concepts/localpv) mode. -"**Flux cluster with Cloudflare**" - Add-on to the "**Flux cluster**" that provides DNS and SSL with [Cloudflare](https://www.cloudflare.com/). [Cloudflare Tunnel](https://www.cloudflare.com/products/tunnel/) is also included to provide external access to certain applications deployed in your cluster. +3. "**Flux cluster with Cloudflare**" - Add-on to the "**Flux cluster**" that provides DNS and SSL with [Cloudflare](https://www.cloudflare.com/). [Cloudflare Tunnel](https://www.cloudflare.com/products/tunnel/) is also included to provide external access to certain applications deployed in your cluster. -- **Apps included:** [ingress-nginx](https://github.com/kubernetes/ingress-nginx/) and [external-dns](https://github.com/kubernetes-sigs/external-dns). + - **Apps included:** [ingress-nginx](https://github.com/kubernetes/ingress-nginx/), [external-dns](https://github.com/kubernetes-sigs/external-dns) and [cloudflared](https://github.com/cloudflare/cloudflared). - --- +Other features include: + +- [Renovate](https://github.com/renovatebot/renovate) can be activated on any of the configurations you choose to help manage dependencies via pull requests. See the 🤖 [**Renovate**](#-renovate) section below for more details. -[Renovate](https://github.com/renovatebot/renovate) can be activated on any of the configurations you choose. This will help you manage dependencies via pull requests. ## 💻 Machine Preparation