diff --git a/website/src/content/docs/clustertool/getting-started.md b/website/src/content/docs/clustertool/getting-started.md index 60cfce03e74..8259ac602a5 100644 --- a/website/src/content/docs/clustertool/getting-started.md +++ b/website/src/content/docs/clustertool/getting-started.md @@ -252,4 +252,5 @@ Otherwise it will reset your talos-vm during next restart. ::: Your talos-cluster should now be bootstrapped and you should be able to add your first charts. -Have fun! + +Have fun with your cluster! diff --git a/website/src/content/docs/guides/cheatsheet.md b/website/src/content/docs/guides/cheatsheet.md index 267585a5651..fd778b38f68 100644 --- a/website/src/content/docs/guides/cheatsheet.md +++ b/website/src/content/docs/guides/cheatsheet.md @@ -24,6 +24,12 @@ Show all Helm-Releases: flux get hr -A ``` +Reconcile your cluster: + +```bash +flux reconcile source git cluster +``` + Show all Flux objects which are not ready: ```bash diff --git a/website/src/content/docs/guides/fluxcd/deploychart.md b/website/src/content/docs/guides/fluxcd/deploychart.md new file mode 100644 index 00000000000..39f61dc7f40 --- /dev/null +++ b/website/src/content/docs/guides/fluxcd/deploychart.md @@ -0,0 +1,89 @@ +--- +sidebar: + order: 3 +title: Deploy a chart with Flux on your Clustertool Cluster +--- + +This guide will explain briefly how to deploy a chart on your brand new Clustertool Cluster using Flux. + +## Create the files + +- Your charts can be placed in the folder `clusters/main/kubernetes/apps/`. +- There will make a folder for your `chart` and inside that folder an `app` folder. +- In this guide we will use as example `librespeed` +- So it will be like: `clusters/main/kubernetes/apps/librespeed/app/` +- In this folder we will create two files, `helm-release.yaml` and `namespace.yaml`. + +:::note[Folder Structure] + +You are not limited to only use the `clusters/main/kubernetes/apps` folder. You can make any folder with subfolders in `clusters/main/kubernetes/` to organize your charts. + +::: + +```yaml +// namespace.yaml + +apiVersion: v1 +kind: Namespace +metadata: + name: librespeed +## Add this part when you need a privileged namespace +# labels: +# pod-security.kubernetes.io/enforce: privileged + +``` +:::warning[Privileged Namespace] + +Add the label for pod-security only when it is really needed. After deploying the chart and this part will be needed you will see this in your event logs. + +::: + +```yaml +// helm-release.yaml +--- +apiVersion: helm.toolkit.fluxcd.io/v2 +kind: HelmRelease +metadata: + name: librespeed + namespace: librespeed +spec: + interval: 15m + chart: + spec: + chart: librespeed + version: 15.6.1 + sourceRef: + kind: HelmRepository + name: truecharts + namespace: flux-system + interval: 15m + timeout: 20m + maxHistory: 3 + driftDetection: + mode: warn + install: + createNamespace: true + remediation: + retries: 3 + upgrade: + cleanupOnFail: true + remediation: + retries: 3 + uninstall: + keepHistory: false + values: + # Add here your chart specific values +``` + +## Generate and deploy + +:::note[Kustomizations] + +When not using clustertool, you need to add the kustomizations yourself. + +::: + +- Run `clustertool genconfig`. This will creates `kustomization.yaml` and `ks.yaml` files. +- Also this will update the `kustomization.yaml` in the folder above. +- Push to git +- Wait for flux to get it deployed. This can be taken up to 30 minutes. Another option you can do is run [flux reconcile](/guides/cheatsheet) or configure a flux [webhook](/guides/fluxcd/webhook). diff --git a/website/src/content/docs/guides/fluxcd/index.md b/website/src/content/docs/guides/fluxcd/index.md index 82788beb9b2..b74507e1b22 100644 --- a/website/src/content/docs/guides/fluxcd/index.md +++ b/website/src/content/docs/guides/fluxcd/index.md @@ -1,4 +1,6 @@ --- +sidebar: + order: 1 title: FluxCD Basics --- diff --git a/website/src/content/docs/guides/fluxcd/webhook.md b/website/src/content/docs/guides/fluxcd/webhook.md index 285c02633b3..5e080b546b9 100644 --- a/website/src/content/docs/guides/fluxcd/webhook.md +++ b/website/src/content/docs/guides/fluxcd/webhook.md @@ -1,4 +1,6 @@ --- +sidebar: + order: 2 title: FluxCD Webhook ---