mirror of
https://github.com/cozystack/cozystack.git
synced 2026-11-22 20:53:52 +09:00
Both caps are facts about what each chart renders, and nothing outside the chart can derive them. Every Kubernetes worker pool is a separate KubernetesNodes release named kubernetes-nodes-<name>-<pool>, so a cluster name has to leave room for the default md0 pool inside the 53-character Helm release name limit: 32 characters. A Kafka KRaft controller pod is named kafka-<name>-c-<hash>-<id> with an 8-character hash, and that hostname has to fit the 63-character DNS-1123 label limit: 44 characters. Each chart now states its cap with a @name annotation, which cozyvalues-gen v1.7.0 publishes as x-cozystack-name in values.schema.json and hack/update-crd.sh carries into the ApplicationDefinition. The pre-commit job moves to that release, the first that understands the annotation. Assisted-by: LLM Signed-off-by: Timofei Larkin <lllamnyp@gmail.com>
302 lines
15 KiB
YAML
302 lines
15 KiB
YAML
## @name {string} - Cluster name. Every worker pool is a separate KubernetesNodes release named `kubernetes-nodes-<name>-<pool>`, so the name must leave room for the default `md0` pool inside the 53-character Helm release name limit.
|
|
## @maxLength 32
|
|
|
|
##
|
|
## @section Common Parameters
|
|
##
|
|
|
|
## @param {string} storageClass - Default StorageClass inside the tenant cluster. Remote-accessible LINSTOR classes are auto-propagated to the tenant under the same name.
|
|
## @immutable
|
|
## @x-cozystack-options {source: storageclass}
|
|
storageClass: replicated
|
|
|
|
##
|
|
## @section Application-specific Parameters
|
|
##
|
|
|
|
## @enum {string} ResourcesPreset - Default sizing preset.
|
|
## @value t1.nano
|
|
## @value t1.micro
|
|
## @value t1.small
|
|
## @value t1.medium
|
|
## @value t1.large
|
|
## @value t1.xlarge
|
|
## @value t1.2xlarge
|
|
## @value t1.4xlarge
|
|
## @value c1.nano
|
|
## @value c1.micro
|
|
## @value c1.small
|
|
## @value c1.medium
|
|
## @value c1.large
|
|
## @value c1.xlarge
|
|
## @value c1.2xlarge
|
|
## @value c1.4xlarge
|
|
## @value s1.nano
|
|
## @value s1.micro
|
|
## @value s1.small
|
|
## @value s1.medium
|
|
## @value s1.large
|
|
## @value s1.xlarge
|
|
## @value s1.2xlarge
|
|
## @value s1.4xlarge
|
|
## @value u1.nano
|
|
## @value u1.micro
|
|
## @value u1.small
|
|
## @value u1.medium
|
|
## @value u1.large
|
|
## @value u1.xlarge
|
|
## @value u1.2xlarge
|
|
## @value u1.4xlarge
|
|
## @value m1.nano
|
|
## @value m1.micro
|
|
## @value m1.small
|
|
## @value m1.medium
|
|
## @value m1.large
|
|
## @value m1.xlarge
|
|
## @value m1.2xlarge
|
|
## @value m1.4xlarge
|
|
## @value nano
|
|
## @value micro
|
|
## @value small
|
|
## @value medium
|
|
## @value large
|
|
## @value xlarge
|
|
## @value 2xlarge
|
|
|
|
## @typedef {struct} Resources - Explicit CPU and memory configuration for a node or component.
|
|
## @field {quantity} [cpu] - CPU available.
|
|
## @field {quantity} [memory] - Memory (RAM) available.
|
|
|
|
##
|
|
## @enum {string} Version
|
|
## @value v1.35
|
|
## @value v1.34
|
|
## @value v1.33
|
|
## @value v1.32
|
|
## @value v1.31
|
|
|
|
## @param {Version} version - Kubernetes major.minor version to deploy. On `v1.32` with `spec.oidc.mode` other than `None` the chart also renders `--feature-gates=RemoteRequestHeaderUID=true` next to `controlPlane.apiServer.extraArgs`, and an entry of your own there can change what it renders (see that field).
|
|
version: "v1.35"
|
|
|
|
|
|
## @param {string} host - External hostname for Kubernetes cluster. Defaults to `<cluster-name>.<tenant-host>` if empty.
|
|
host: ""
|
|
|
|
##
|
|
## @section Cluster Addons
|
|
##
|
|
|
|
## @typedef {struct} CertManagerAddon - cert-manager addon.
|
|
## @field {bool} enabled - Enable cert-manager.
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} CiliumAddon - Cilium CNI plugin.
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} GatewayAPIAddon - Gateway API addon.
|
|
## @field {bool} enabled - Enable Gateway API.
|
|
|
|
## @enum {string} IngressNginxExposeMethod - Method to expose the controller
|
|
## @value Proxied
|
|
## @value LoadBalancer
|
|
|
|
## @typedef {struct} IngressNginxAddon - Ingress-NGINX controller.
|
|
## @field {bool} enabled - Enable the controller (requires nodes labeled `ingress-nginx`).
|
|
## @field {IngressNginxExposeMethod} exposeMethod - Method to expose the controller. Allowed values: `Proxied`, `LoadBalancer`.
|
|
## @field {[]string} hosts - Domains routed to this tenant cluster when `exposeMethod` is `Proxied`.
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} GPUOperatorAddon - NVIDIA GPU Operator.
|
|
## @field {bool} enabled - Enable GPU Operator.
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} HAMiAddon - HAMi GPU virtualization middleware.
|
|
## @field {bool} enabled - Enable HAMi (requires GPU Operator).
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} MonitoringAgentsAddon - Monitoring agents (Fluent Bit, VMAgents).
|
|
## @field {bool} enabled - Enable monitoring agents.
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} VerticalPodAutoscalerAddon - Vertical Pod Autoscaler.
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} VeleroAddon - Velero backup and recovery addon.
|
|
## @field {bool} enabled - Enable Velero.
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} CoreDNSAddon - CoreDNS addon.
|
|
## @field {object} valuesOverride - Custom Helm values overrides.
|
|
|
|
## @typedef {struct} OuroborosAddon - Hairpin-NAT fix for ingress-nginx with PROXY-protocol. See cozystack/website docs/networking/hairpin-proxy-protocol for the operator guide.
|
|
## @field {bool} enabled - Enable ouroboros. Requires addons.ingressNginx.enabled (chart-render fail otherwise). Only useful when PROXY-protocol is wired on the tenant ingress-nginx via valuesOverride.
|
|
## @field {object} valuesOverride - Custom Helm values overrides. Operator-key wins over cozystack defaults.
|
|
|
|
## @typedef {struct} Addons - Cluster addons configuration.
|
|
## @field {CertManagerAddon} certManager - Cert-manager addon.
|
|
## @field {CiliumAddon} cilium - Cilium CNI plugin.
|
|
## @field {GatewayAPIAddon} gatewayAPI - Gateway API addon.
|
|
## @field {IngressNginxAddon} ingressNginx - Ingress-NGINX controller.
|
|
## @field {GPUOperatorAddon} gpuOperator - NVIDIA GPU Operator.
|
|
## @field {HAMiAddon} hami - HAMi GPU virtualization middleware.
|
|
## @field {MonitoringAgentsAddon} monitoringAgents - Monitoring agents.
|
|
## @field {VerticalPodAutoscalerAddon} verticalPodAutoscaler - Vertical Pod Autoscaler.
|
|
## @field {VeleroAddon} velero - Velero backup/restore addon.
|
|
## @field {CoreDNSAddon} coredns - CoreDNS addon.
|
|
## @field {OuroborosAddon} ouroboros - Hairpin-NAT fix for ingress-nginx with PROXY-protocol.
|
|
|
|
## @param {Addons} addons - Cluster addons configuration.
|
|
addons:
|
|
certManager:
|
|
enabled: false
|
|
valuesOverride: {}
|
|
cilium:
|
|
valuesOverride: {}
|
|
gatewayAPI:
|
|
enabled: false
|
|
ingressNginx:
|
|
enabled: false
|
|
exposeMethod: Proxied
|
|
hosts: []
|
|
valuesOverride: {}
|
|
gpuOperator:
|
|
enabled: false
|
|
valuesOverride: {}
|
|
hami:
|
|
enabled: false
|
|
valuesOverride: {}
|
|
monitoringAgents:
|
|
enabled: false
|
|
valuesOverride: {}
|
|
verticalPodAutoscaler:
|
|
valuesOverride: {}
|
|
velero:
|
|
enabled: false
|
|
valuesOverride: {}
|
|
coredns:
|
|
valuesOverride: {}
|
|
ouroboros:
|
|
enabled: false
|
|
valuesOverride: {}
|
|
|
|
##
|
|
## @section Kubernetes Control Plane Configuration
|
|
##
|
|
|
|
## @typedef {struct} APIServer - API Server configuration.
|
|
## @field {Resources} resources - CPU and memory resources for API Server.
|
|
## @field {ResourcesPreset} resourcesPreset="c1.medium" - Preset if `resources` omitted.
|
|
## @field {[]string} extraArgs - Extra command-line flags appended to the tenant kube-apiserver, passed through to KamajiControlPlane `spec.apiServer.extraArgs`. For OIDC use `spec.oidc.mode` — this passthrough is the escape hatch for unrelated apiserver flags. When `spec.oidc.mode` is not `None` the chart also renders `--requestheader-uid-headers=X-Remote-Uid` here from Kubernetes `v1.32`, plus `--feature-gates=RemoteRequestHeaderUID=true` on `v1.32` itself. It reads an entry of your own on either flag and adapts where it can, and fails the render on shapes the apiserver would refuse to start on; `docs/oidc-tenant.md` documents these shapes and what `--emulated-version` changes. Do NOT add legacy `--oidc-*` flags here when `spec.oidc.mode` is not `None`; the chart injects `--authentication-config` and the apiserver refuses to boot with both. Empty by default (no change to current behavior).
|
|
## @field {[]object} extraVolumes - Extra volumes added to the control-plane Deployment, passed through to KamajiControlPlane `spec.deployment.extraVolumes`. Use to mount a ConfigMap or Secret holding an AuthenticationConfiguration file referenced by `extraArgs`. Each item is a core/v1 Volume, but because the control-plane pod runs on the management cluster only `configMap` and `secret` sources are allowed (host-reaching sources like `hostPath`/`csi` and token-projection via `projected` are rejected); each volume must have a unique, non-empty name and exactly one source. The names `talos-ca` and `talos-tls-cert` are reserved by the chart. Empty by default.
|
|
## @field {[]object} extraVolumeMounts - Extra volume mounts added to the tenant kube-apiserver container, passed through to KamajiControlPlane `spec.apiServer.extraVolumeMounts`. Each `name` must reference a volume declared in `extraVolumes`; the chart-managed talos secret volumes cannot be mounted. Each item is a core/v1 VolumeMount. Empty by default.
|
|
|
|
## @typedef {struct} ControllerManager - Controller Manager configuration.
|
|
## @field {Resources} resources - CPU and memory resources for Controller Manager.
|
|
## @field {ResourcesPreset} resourcesPreset="t1.micro" - Preset if `resources` omitted.
|
|
|
|
## @typedef {struct} Scheduler - Scheduler configuration.
|
|
## @field {Resources} resources - CPU and memory resources for Scheduler.
|
|
## @field {ResourcesPreset} resourcesPreset="t1.micro" - Preset if `resources` omitted.
|
|
|
|
## @typedef {struct} KonnectivityServer - Konnectivity Server configuration.
|
|
## @field {Resources} resources - CPU and memory resources for Konnectivity.
|
|
## @field {ResourcesPreset} resourcesPreset="t1.micro" - Preset if `resources` omitted.
|
|
|
|
## @typedef {struct} Konnectivity - Konnectivity configuration.
|
|
## @field {KonnectivityServer} server - Konnectivity Server configuration.
|
|
|
|
## @typedef {struct} ControlPlane - Kubernetes control plane configuration.
|
|
## @field {int} replicas=2 - Number of control-plane replicas.
|
|
## @field {APIServer} apiServer - API Server configuration.
|
|
## @field {ControllerManager} controllerManager - Controller Manager configuration.
|
|
## @field {Scheduler} scheduler - Scheduler configuration.
|
|
## @field {Konnectivity} konnectivity - Konnectivity configuration.
|
|
|
|
## @param {ControlPlane} controlPlane - Kubernetes control-plane configuration.
|
|
controlPlane:
|
|
replicas: 2
|
|
apiServer:
|
|
resources: {}
|
|
resourcesPreset: "c1.medium"
|
|
extraArgs: []
|
|
extraVolumes: []
|
|
extraVolumeMounts: []
|
|
controllerManager:
|
|
resources: {}
|
|
resourcesPreset: "t1.micro"
|
|
scheduler:
|
|
resources: {}
|
|
resourcesPreset: "t1.micro"
|
|
konnectivity:
|
|
server:
|
|
resources: {}
|
|
resourcesPreset: "t1.micro"
|
|
|
|
## @typedef {struct} Images - Optional image overrides for chart-internal helpers.
|
|
## @field {string} [waitForKubeconfig] - Image used by the wait-for-kubeconfig init container. Empty falls back to images/busybox.tag.
|
|
## @field {string} [kubectl] - Image used by the bootstrap-token tenant Job (kubectl). Empty falls back to images/kubectl.tag.
|
|
## @field {string} [talosCsrSigner] - Image used by the talos-csr-signer sidecar in the Kamaji control plane. Empty falls back to images/talos-csr-signer.tag.
|
|
|
|
## @param {Images} images - Optional image overrides for air-gapped or rate-limited registries.
|
|
images:
|
|
waitForKubeconfig: ""
|
|
kubectl: ""
|
|
talosCsrSigner: ""
|
|
|
|
##
|
|
## @section Talos Worker Image
|
|
##
|
|
|
|
## @typedef {struct} Talos - Talos worker image configuration.
|
|
## @field {string} version - Talos release used for worker OS image and installer. Must satisfy the chart's Talos<->Kubernetes support matrix against the chosen `version`.
|
|
## @field {string} schematicID - Talos image-factory schematic ID. Defaults to the cozystack-tested vanilla schematic. Operators using custom schematics (system extensions, kernel args) override here.
|
|
## @field {string} imageFactoryURL - Base URL of the Talos Image Factory that serves the worker OS disk image (the `openstack-amd64.raw.xz` raw artifact streamed in by CDI over HTTP). Defaults to the public factory. Point at a self-hosted Image Factory, a caching mirror, or an internal HTTP file server for air-gapped, rate-limited, or flaky-egress environments. No trailing slash.
|
|
## @field {string} installerRepository - OCI repository prefix for the Talos installer image used by the in-guest `talos-reconcile` upgrade Job. Resolved as `<installerRepository>/<schematicID>:<version>`. Defaults to the public factory's installer path. Override for air-gapped or mirrored registries. No trailing slash.
|
|
## @field {object} registryMirrors - Talos `machine.registries.mirrors` passthrough for worker nodes: a map of upstream registry host to `{ endpoints: [ ... ] }`. Empty by default, so workers pull container images (the Talos `kubelet` image included) directly from the upstream registry. Point a host such as `ghcr.io` at an in-cluster pull-through mirror for air-gapped, rate-limited, or flaky-egress environments so a worker's boot does not depend on live public egress. Talos still falls back to the upstream registry unless a host also sets `skipFallback: true`, so a mirror alone does not enforce air-gap.
|
|
|
|
## @param {Talos} talos - Talos worker image configuration.
|
|
talos:
|
|
version: "v1.13.6"
|
|
schematicID: "ce4c980550dd2ab1b17bbf2b08801c7eb59418eafe8f279833297925d67c7515"
|
|
imageFactoryURL: "https://factory.talos.dev"
|
|
installerRepository: "factory.talos.dev/installer"
|
|
registryMirrors: {}
|
|
|
|
##
|
|
## @section OIDC
|
|
##
|
|
|
|
## @enum {string} OIDCMode - Identity mode for the tenant kube-apiserver.
|
|
## @value None
|
|
## @value System
|
|
## @value CustomConfig
|
|
|
|
## @enum {string} OIDCRole - RBAC role bound to a listed user inside the tenant cluster.
|
|
## @value admin
|
|
## @value view
|
|
|
|
## @typedef {struct} OIDCUser - One user entry; produces one ClusterRoleBinding inside the tenant cluster.
|
|
## @field {string} email - Email address matched against the `email` claim from the issuer. Used verbatim as the `User:` subject in the ClusterRoleBinding inside the tenant cluster. The `email` claim is a built-in OIDC scope requested explicitly by the chart-generated `kubectl oidc-login` kubeconfig; every conformant OIDC provider (cozy realm included) emits it.
|
|
## @field {OIDCRole} role - Role to bind: `admin` maps to `ClusterRole/cluster-admin`, `view` maps to `ClusterRole/view`.
|
|
|
|
## @typedef {struct} OIDCSecretRef - Reference to a Secret carrying an inline AuthenticationConfiguration.
|
|
## @field {string} [name] - Name of an existing Secret in the tenant (release) namespace whose `config.yaml` key holds an `apiserver.config.k8s.io/v1beta1` `AuthenticationConfiguration`. Mutually exclusive with `customConfig.config`.
|
|
|
|
## @typedef {struct} OIDCCustomConfig - Tenant-provided AuthenticationConfiguration; consumed only when `mode: CustomConfig`. Exactly one of `config` or `secretRef.name` must be set.
|
|
## @field {string} [config] - Inline AuthenticationConfiguration YAML (`apiserver.config.k8s.io/v1beta1`). The chart writes the value verbatim into a Secret mounted at `/etc/kubernetes/authentication-config/config.yaml` on the kube-apiserver. Mutually exclusive with `secretRef.name`.
|
|
## @field {OIDCSecretRef} [secretRef] - Reference to an existing Secret in the tenant namespace carrying the `AuthenticationConfiguration`.
|
|
|
|
## @typedef {struct} OIDC - OIDC selector for the tenant cluster (Phase 1 — per-cluster audience binding; no per-tenant Keycloak realm).
|
|
## @field {OIDCMode} mode - Identity mode. `None`: no OIDC, only the static admin kubeconfig works. `System`: trust the platform Keycloak realm (`cozy` by default) via a per-cluster public client with audience binding; zero-config default. `CustomConfig`: trust a tenant-supplied issuer directly (BYO); `cozy` is not in the path.
|
|
## @field {OIDCCustomConfig} [customConfig] - Tenant-supplied AuthenticationConfiguration; consumed only when `mode: CustomConfig`.
|
|
## @field {[]OIDCUser} [users] - Users granted access to the tenant cluster; each entry produces one ClusterRoleBinding inside the tenant cluster. Works for both `System` and `CustomConfig` modes.
|
|
|
|
## @param {OIDC} oidc - OIDC authentication and per-user RBAC for the tenant kube-apiserver. See docs/oidc-tenant.md for the operator guide.
|
|
oidc:
|
|
mode: "None"
|
|
customConfig:
|
|
config: ""
|
|
secretRef:
|
|
name: ""
|
|
users: []
|