diff --git a/website/src/content/docs/guides/index.md b/website/src/content/docs/guides/index.md index 3ee36e694c2..080012afa08 100644 --- a/website/src/content/docs/guides/index.md +++ b/website/src/content/docs/guides/index.md @@ -10,60 +10,28 @@ Clusters created using Clustertool come pre-packed with most of these charts pre ::: -## Minimal Getting Started Setup +## Prerequisites -Install the following charts with **default** values.yaml if not already installed: +- Running Kubernetes Cluster +- Container Storage Interface (CSI) +- LoadBalancer like Metallb -- Install `cloudnative-pg` -> [Cloudnative-PG Installation](#prometheus-and-cnpg-system-app-installations) -- Install `prometheus-operator` -> [Prometheus-Operator Installation](#prometheus-and-cnpg-system-app-installations) -- Install `cert-manager` -> [Certificate Management with Cert-Manager](#cert-manager-operator-and-clusterissuer-installation-for-certificate-management) -- Install `volsync` which is used to configure Backups-> [PVC Backup Guide](/guides/volsync-backup-restore) -- `metallb` or another loadBalancer is required if you do not have a loadBalancer yet +## Required Charts for most Truecharts Charts -To configure MetalLB, you will need to also add `metallb-config` and adapt it to your own needs. +Install the following charts if not already installed: -## Getting started using Charts with your own Domain - -- Steps Above -> [Minimal Getting Started](#minimal-getting-started-setup) -- Install the `traefik-crds` chart -- Install `traefik` chart -- Use CloudFlare for DNS and create an API token -> [Guide](/charts/premium/clusterissuer/how-to#configure-acme-issuer) -- Install `Clusterissuer` and configure it for your needs -> [Clusterissuer How-to](/charts/premium/clusterissuer/how-to) -- Add `Blocky` and configure it with k8s-gateway enabled -> [Blocky Setup Guide](/charts/premium/blocky/setup-guide) -- Setup ingress on each Chart you want to expose -> [Configure Ingress using Clusterissuer certs](/charts/premium/clusterissuer/how-to/#configure-ingress-using-clusterissuer) +- [Cert-Manager](https://cert-manager.io/) +- [Cloudnative-PG](https://cloudnative-pg.io/) +- [Prometheus-Operator](https://truecharts.org/charts/system/prometheus-operator/) --- -## Important Charts +## Recommended Charts -### MetalLB installation - -![MetalLB](./img/icons/metallb.png) - -This step is mandatory if you don't intend to use another LoadBalancer. We have a full guide explaining the setup on the [MetalLB-Config Setup Guide](/charts/premium/metallb-config/setup-guide) page on how to setup MetalLB. Please refer to that page for more info before continuing. - -### Prometheus and CNPG system app installations - -![Prometheus](./img/icons/prometheus-operator.png) ![CNPG](./img/icons/cnpg.png) - -Many of the popular TrueCharts charts rely on `Prometheus Operator` and `Cloudnative-PG Operator` to be installed **PRIOR** to installing another chart that may rely on functionality these operators provide. If you're unsure if you're using any TrueCharts charts that require Prometheus or CNPG functionality, we advise you install these charts first anyway before attempting to then install any other charts. - -[Here](/general/faq#how-do-i-know-if-an-app-uses-cnpg) is a list of charts that rely on CNPG functionality. If you intend to deploy any of these charts, you **must** install the `Cloudnative-PG Operator` chart first as above. - -### Traefik installation for Ingress / Reverse-Proxy support with TrueCharts Charts - -![Traefik](./img/icons/traefik.png) - -`Traefik` is our "ingress" or "reverse-proxy" solution of choice and is integrated into all our charts in order to make it as easy as possible to secure your charts. To support this, we supply a separate Traefik "ingress" app, which has been pre-configured to provide secure and fast connections. - -### Cert-Manager (operator) and Clusterissuer installation for certificate management - -![Cert-Manager](./img/icons/cert-manager.png) - -TrueCharts only supports the usage of `Cert-Manager` (both the operator portion and the main `clusterissuer`) for certificate management inside charts. We highly recommend setting up `clusterissuer` using our [clusterissuer setup-guide](/charts/premium/clusterissuer/how-to) before adding `Ingress` to your applications. - -### Blocky DNS provider for split-DNS installation and guide - -![Blocky](./img/icons/blocky.png) - -Blocky is the optional, but preferred DNS solution for TrueCharts. It's a DNS proxy, DNS enhancer and ad-blocker which supports "split-DNS" through `K8S-Gateway` and is highly-available. The [Blocky Setup-Guide](/charts/premium/blocky/setup-guide) will cover basic setup options which will get you up and running and is not all inclusive. +- [Blocky](https://truecharts.org/charts/premium/blocky/): Local DNS Resolving with k8s-gateway +- [Clusterissuer](https://truecharts.org/charts/premium/clusterissuer/): Configuring Cert-Manager +- [Kubernetes-Reflector](https://truecharts.org/charts/system/kubernetes-reflector/): Reflect Resources across Namespaces +- [Metallb](https://metallb.io/) with [Metallb-Config](https://truecharts.org/charts/premium/metallb-config/) as LoadBalancer +- [Snapshot-Controller](https://truecharts.org/charts/system/snapshot-controller/): Required for Volsync +- [Volsync](https://truecharts.org/charts/system/volsync/): For Backup and Restore of PVCs +- [Traefik-CRDS](https://truecharts.org/charts/system/traefik-crds/) & [Traefik](https://traefik.io/traefik/): For Ingress and Reverse Proxying