From 7adb74fcdb25c17b18ee284b364c7aa384d8a9cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alfred=20G=C3=B6ppel?= <43101280+alfi0812@users.noreply.github.com> Date: Mon, 14 Apr 2025 18:26:22 +0200 Subject: [PATCH] fix(docs): update intel guide and quick start guide (#34367) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ Fixes # **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code - [x] 📜 Documentation Changes **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [x] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made changes to the documentation - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning - [x] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com> --- .../src/content/docs/general/systemrequirements.md | 6 ++++-- website/src/content/docs/guides/gpu/intel.md | 7 ++++--- website/src/content/docs/guides/gpu/nvidia.md | 14 ++++++++------ website/src/content/docs/guides/index.md | 9 +++++---- 4 files changed, 21 insertions(+), 15 deletions(-) diff --git a/website/src/content/docs/general/systemrequirements.md b/website/src/content/docs/general/systemrequirements.md index e5b85d41399..151d62152ef 100644 --- a/website/src/content/docs/general/systemrequirements.md +++ b/website/src/content/docs/general/systemrequirements.md @@ -25,7 +25,7 @@ Systems complying with these minimum specifications will be able to run **some** **CPU:** 6 *Physical* Cores of AMD Ryzen or Intel 8th Gen Core or better families -* for VMs: dedicated 2 Cores remaining for the host system, e.g. SCALE or Proxmox +* for VMs: dedicated 1 Core (2 Threads) remaining for the host system, e.g. SCALE or Proxmox **RAM:** 16GB or more @@ -50,7 +50,9 @@ Systems complying with these minimum specifications will be able to run **some** Systems complying with these recommended specifications will likely be able to run any Chart we offer, and likely many at the same time, depending on system load and the specific Charts in deployment. -**CPU:** 8+ *Physical* Cores of AMD Ryzen or Intel 8th Gen Core or better families +**CPU:** 7+ *Physical* Cores of AMD Ryzen or Intel 8th Gen Core or better families + +* for VMs: dedicated 1 Core (2 Threads) remaining for the host system, e.g. SCALE or Proxmox **RAM:** 48GB or more diff --git a/website/src/content/docs/guides/gpu/intel.md b/website/src/content/docs/guides/gpu/intel.md index a542c7f9d51..8b7b4f861b8 100644 --- a/website/src/content/docs/guides/gpu/intel.md +++ b/website/src/content/docs/guides/gpu/intel.md @@ -13,6 +13,7 @@ Feel free to open a thread in the appropiate Channel in our Discord server. - Having your GPU isolated when using a VM - Passed the GPU to your Talos Machine when using a VM +- Node Feature Discovery added to your cluster ## Extensions for Talhelper/Clustertool @@ -22,7 +23,6 @@ This Section assumes you are using Clustertool or Talhelper for your talos clust ::: - Its important to add the following Extensions to your `talconfig.yaml` for bootstrap: ```yaml @@ -53,11 +53,12 @@ Add the following repo to your cluster if using fluxcd: apiVersion: source.toolkit.fluxcd.io/v1 kind: HelmRepository metadata: - name: intel + name: home-ops-mirror namespace: flux-system spec: + type: oci interval: 2h - url: https://intel.github.io/helm-charts + url: oci://ghcr.io/home-operations/charts-mirror ``` diff --git a/website/src/content/docs/guides/gpu/nvidia.md b/website/src/content/docs/guides/gpu/nvidia.md index 63107690032..e68f8d555b3 100644 --- a/website/src/content/docs/guides/gpu/nvidia.md +++ b/website/src/content/docs/guides/gpu/nvidia.md @@ -172,10 +172,10 @@ spec: spec: # renovate: registryUrl=https://charts.truechartsoci.org chart: nvidia-device-plugin - version: 0.17.0 + version: 0.17.1 sourceRef: kind: HelmRepository - name: nvdp + name: home-ops-mirror namespace: flux-system interval: 5m install: @@ -213,15 +213,17 @@ Don't forget to add the required repository `nvdp.yaml` into the `repositories/h ```yaml --- +# yaml-language-server: $schema=https://kubernetes-schemas.pages.dev/source.toolkit.fluxcd.io/helmrepository_v1.json apiVersion: source.toolkit.fluxcd.io/v1 kind: HelmRepository metadata: - name: nvdp + name: home-ops-mirror namespace: flux-system spec: - interval: 1h - url: https://nvidia.github.io/k8s-device-plugin - timeout: 3m + type: oci + interval: 2h + url: oci://ghcr.io/home-operations/charts-mirror + ``` ## Example of GPU Assignment diff --git a/website/src/content/docs/guides/index.md b/website/src/content/docs/guides/index.md index 65a636e5865..853812a33c2 100644 --- a/website/src/content/docs/guides/index.md +++ b/website/src/content/docs/guides/index.md @@ -20,9 +20,9 @@ Clusters created using Clustertool come pre-packed with most of these charts pre Install the following charts if not already installed: - - [Cert-Manager](#cert-manager) - - [Cloudnative-PG](#cloudnative-pg) - - [Prometheus](#prometheus) +- [Cert-Manager](#cert-manager) +- [Cloudnative-PG](#cloudnative-pg) +- [Prometheus](#prometheus) --- @@ -32,9 +32,10 @@ Install the following charts if not already installed: - [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 +- [Node Feature Discovery](https://github.com/kubernetes-sigs/node-feature-discovery): For Node Discovery +- [Nginx-Ingress](https://kubernetes.github.io/ingress-nginx/): For Ingress and Reverse Proxying - [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 ## Upstream Operators