docs(examples): end-to-end homelab stack manifests (J1)#149
Merged
Conversation
Add examples/homelab/ — the full homelab vision as deploy-today manifests,
tying together everything shipped (GPU passthrough, node prep, Longhorn/NFS
storage, generic Platform, tunnel exposure):
- 01-cluster.cue k3s Cluster: control plane + general/GPU/storage pools;
GPU passthrough + nodePrep(open-iscsi). openctl-validated.
- 02-platform.yaml Platform: traefik, cloudflared (token via action $secret),
longhorn, nfsProvisioner, nvidiaDevicePlugin + a generic
kube-prometheus-stack (K4a).
- 03-tunnel.yaml Cloudflare Tunnel fronting every public app.
- 04-dns.yaml DNSRecord CNAMEs that $ref the Tunnel's cnameTarget.
- 05/06 *.yaml HelmReleases: Ollama+Open WebUI (GPU), Jellyfin (NFS),
MinIO, Authentik (SSO).
- README.md deploy path + the three wiring mechanisms ($ref outputs,
$secret credentials, nodePrep prerequisites).
The .cue cluster schema-checks offline (openctl validate); the plugin-kind
YAML is well-formed with accurate apiVersion/kind/spec shapes. Docs only,
no code change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
J1 — end-to-end example manifests
Adds
examples/homelab/— the full homelab vision as deploy-today manifests, tying together everything shipped this cycle (GPU passthrough, node prep, Longhorn/NFS storage, generic Platform, tunnel exposure). Nothing bespoke: the cluster is ak3s.Cluster, every app is a stock Helm chart in aHelmRelease, exposure is aTunnel+DNSRecord.01-cluster.cuek3s/ClusternodePrep: open-iscsi02-platform.yamlk8s/Platformkube-prometheus-stack(K4a)03-tunnel.yamlcloudflare/Tunnel04-dns.yamlcloudflare/DNSRecord$refthe Tunnel'scnameTarget05-ollama-openwebui.yamlk8s/HelmRelease06-media-and-services.yamlk8s/HelmReleaseThe README walks the deploy path and the three wiring mechanisms the whole stack leans on:
$refoutputs (kubeconfigPath, tunnel cnameTarget),$secretcredentials (tunnel token via action provider; Vault), andnodePrepprerequisites (open-iscsi for Longhorn).Verification
01-cluster.cueschema-checks offline:openctl validate -f examples/homelab/01-cluster.cue→Valid: 1 resource(s)(exercises the newnodePrep+gpufields against the compiled-in k3s schema).apiVersion/kind/metadata.name, matching each plugin's advertised schema.Docs/examples only — no Go changes.