clean up and docs
This commit is contained in:
1 parent
0bb935b076
commit
22ef880654
8 files changed
+312
-262
No files matched your search
@@ -1 +1,85 @@
|
||||
# My Helm Charts
|
||||
# My Helm Charts
|
||||
|
||||
A collection of Helm charts for deploying self-hosted applications to a personal
|
||||
homelab Kubernetes cluster (based on k3s). The charts assume a homelab infrastructure
|
||||
that includes:
|
||||
|
||||
- **Traefik** as the ingress controller
|
||||
- **cert-manager** for per-host certificate issuance
|
||||
- **external-secrets** (with a `ClusterSecretStore`) for fetching TLS certificates
|
||||
- **Tailscale** ingress (`ingressClassName: tailscale`) for VPN-only access
|
||||
- **gethomepage** annotations so the [Homepage](https://gethomepage.dev) dashboard
|
||||
auto-discovers services from the ingresses
|
||||
|
||||
> The `x.cat` domain names, DNS configuration, and certificate stores are samples from
|
||||
> the author's own homelab. Adjust the `global.dns` block in your own values to match
|
||||
> your environment.
|
||||
|
||||
---
|
||||
|
||||
## Contents
|
||||
|
||||
| Chart | Description |
|
||||
| --- | --- |
|
||||
| [`compose-app`](charts/compose-app) | A generic "compose-like" chart that turns a simple YAML service declaration into Deployments, Services, and Ingresses. Also manages volumes and secrets. |
|
||||
| [`homepage`](charts/homepage) | Deploys [Homepage](https://gethomepage.dev), a self-hosted start page / dashboard, with a ServiceAccount + RBAC that lets it read cluster state. |
|
||||
|
||||
---
|
||||
|
||||
## Repository structure
|
||||
|
||||
```
|
||||
charts/
|
||||
├── charts/
|
||||
│ ├── compose-app/ # Generic app-deploy chart (Deploy + Service + Ingress + volumes + secrets)
|
||||
│ └── homepage/ # Homepage dashboard chart (Deploy + ConfigMap + RBAC)
|
||||
└── Readme.md # This file
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Using these charts
|
||||
|
||||
Each chart is a standalone Helm chart (Helm v3 / `apiVersion: v2`). Install one with:
|
||||
|
||||
```sh
|
||||
helm install <release-name> ./charts/<chart-name> -f my-values.yaml
|
||||
```
|
||||
|
||||
There is no central umbrella chart and no chart repository index in this repo; each
|
||||
chart is referenced by (relative) path.
|
||||
|
||||
---
|
||||
|
||||
## Global DNS configuration
|
||||
|
||||
`compose-app` carries a shared `global.dns` values block describing the DNS layout,
|
||||
TLS, and certificate management used to build ingress hosts:
|
||||
|
||||
| Key | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `global.dns.internalPrefix` | `k3s.internal` | Host suffix used for internal ingresses (e.g. `<prefix>.k3s.internal`). |
|
||||
| `global.dns.primary.domain` | `bob.cat` | Primary public domain. |
|
||||
| `global.dns.primary.root` | `""` | Subdomain root under the primary domain (empty root → the domain itself). |
|
||||
| `global.dns.secondary.domain` | `tod.cat` | Secondary (backup) public domain. |
|
||||
| `global.dns.secondary.root` | `gr` | Subdomain root under the secondary domain. |
|
||||
| `global.dns.tls.enabled` | `true` | Whether to provision TLS for ingress hosts. |
|
||||
| `global.dns.tls.issuer` | `issue` | `ClusterIssuer` name used by cert-manager when not using wildcards. |
|
||||
| `global.dns.tls.acmeServer` | `http://acme` | ACME server endpoint (informational). |
|
||||
| `global.dns.tls.skipTLSVerify` | `true` | Skip TLS verification for the ACME client. |
|
||||
| `global.dns.tls.useWildCard` | `true` | If true, reuse a wildcard cert via external-secrets; otherwise request per-host certificates. |
|
||||
|
||||
---
|
||||
|
||||
## TLS provisioning
|
||||
|
||||
TLS secrets are produced one of two ways, controlled by `useWildCard`:
|
||||
|
||||
- **Wildcard (default):** an `ExternalSecret` fetches `tls.crt` / `tls.key` from a
|
||||
`ClusterSecretStore` named `k8s-ns-certs`, referenced as `cloudflare-wildcard<domain>`.
|
||||
This is how the sample values provision certificates.
|
||||
- **Per-host:** a cert-manager `Certificate` is created for the host, using the
|
||||
`ClusterIssuer` named by `global.dns.tls.issuer`.
|
||||
|
||||
The generated secret is always named `tls-<prefix><domain>` and referenced by the TLS
|
||||
ingress rule.
|
||||
Reference in new issue
Block a user