Cluster Services Reference on Cozystack

Backup Classes

Mon, 01 Jan 0001 00:00:00 +0000

Cozystack ships a single platform-managed BackupClass named cozy-default. It is provisioned automatically when the backupstrategy-controller package is installed and references the system-managed bucket provisioned through the apps.cozystack.io/Bucket CR cozy-backups in the tenant-root namespace (the real S3 bucket name is the COSI-assigned one from BucketClaim.status.bucketName).

Tenants reference cozy-default from BackupJob, Plan, and RestoreJob resources — they do not supply S3 credentials, endpoints, or paths. The platform projects the system-managed credentials Secret into the tenant namespace per BackupJob (or, for long-lived references like Velero’s BackupStorageLocation, into a fixed list of system namespaces on a periodic tick), and the default strategy templates encode <namespace>/<application> into every S3 path so two tenants with the same application name never collide.

BootBox Service Reference

Mon, 01 Jan 0001 00:00:00 +0000

Parameters

Common parameters

Name	Description	Type	Value
`whitelistHTTP`	Secure HTTP by enabling client networks whitelisting.	`bool`	`true`
`whitelist`	List of client networks.	`[]string`	`[]`
`machines`	Configuration of physical machine instances.	`[]object`	`[]`
`machines[i].hostname`	Hostname.	`string`	`""`
`machines[i].arch`	Architecture.	`string`	`""`
`machines[i].ip`	IP address configuration.	`object`	`{}`
`machines[i].ip.address`	IP address.	`string`	`""`
`machines[i].ip.gateway`	IP gateway.	`string`	`""`
`machines[i].ip.netmask`	Netmask.	`string`	`""`
`machines[i].leaseTime`	Lease time.	`int`	`0`
`machines[i].mac`	MAC addresses.	`[]string`	`[]`
`machines[i].nameServers`	Name servers.	`[]string`	`[]`
`machines[i].timeServers`	Time servers.	`[]string`	`[]`
`machines[i].uefi`	UEFI.	`bool`	`false`

ComputePlane Service Reference

Mon, 01 Jan 0001 00:00:00 +0000

A managed, isolated environment for running code-executing (untrusted-code) catalog applications — notebooks, workflow “code” nodes, plugin systems.

This tenant module provisions a single-tenant, Cozystack-managed cluster by deploying the ordinary apps/kubernetes chart (Kamaji control plane + KubeVirt-VM worker nodes) with operator-fixed values, sourced from this package’s own source-only ExternalArtifact (cozystack-computeplane-application-kubevirt-kubernetes). The tenant gets the same substrate as any managed kind: Kubernetes cluster, but holds no admin kubeconfig for it. The security posture (Cozystack-enablement addons, withheld credentials) is baked into the chart and cannot be overridden; the one tenant-facing knob is nodeGroups — the module forwards only the documented per-pool fields to the pool chart, so any other NodeGroup field (e.g. talos, version, images) is silently dropped: accepted but inert.

Etcd Service Reference

Mon, 01 Jan 0001 00:00:00 +0000

This chart renders an EtcdCluster (etcd-operator.cozystack.io/v1alpha2) managed by the cozystack etcd-operator, plus the cert-manager CA chain and a Kamaji DataStore. TLS uses secretRef mode: this chart’s own cert-manager Certificate resources issue the server, operator-client and peer certs from the etcd-issuer / etcd-peer-issuer CA Issuers, and the EtcdCluster only references the resulting Secrets via serverSecretRef / operatorClientSecretRef / peer.secretRef (the operator itself mints nothing). This is deliberate: spec.tls is immutable in v1alpha2 and etcd-migrate adopts legacy clusters into exactly this secretRef shape, so the chart must match it or every post-adoption reconcile is rejected. etcd runs cert-only (--client-cert-auth, no password auth); consumers authenticate by presenting a commonName=root client cert (etcd-client-tls) signed by the same CA.

Tenant Gateway Reference

Mon, 01 Jan 0001 00:00:00 +0000

Per-tenant Gateway API Gateway backed by Cilium. Installed automatically when tenant.spec.gateway=true on the publishing tenant. Other tenants under that tenant inherit through the publishing Gateway without opting in.

The chart renders one gateway.cozystack.io/v1alpha1 TenantGateway CR per tenant. The cozystack-controller reconciles the actual Gateway, per-tenant Issuer, and per-listener Certificate resources from there. Helm does not render Gateway or Certificate directly — that prevents the Helm-vs-controller race on Gateway.spec.listeners that ad-hoc HTTPRoute additions would cause.

Ingress-NGINX Controller Reference

Mon, 01 Jan 0001 00:00:00 +0000

Parameters

Common parameters

Name	Description	Type	Value
`replicas`	Number of ingress-nginx replicas.	`int`	`2`
`whitelist`	List of client networks.	`[]string`	`[]`
`cloudflareProxy`	Restoring original visitor IPs when Cloudflare proxied is enabled.	`bool`	`false`
`proxyProtocol`	Enable PROXY-protocol (use-proxy-protocol) on a tenant Ingress application. The upstream L4 load balancer in front of ingress-nginx MUST already inject PROXY-protocol v1 headers, otherwise all traffic to this ingress breaks — including in-cluster and direct-Service (hairpin) access to its public hostnames. Mutually exclusive with cloudflareProxy. For the host (external-facing) ingress use the platform-level publishing.proxyProtocol switch instead; the per-app value is rejected there because it would bypass the ouroboros hairpin handling and the disable-hazard guard.	`bool`	`false`
`resources`	Explicit CPU and memory configuration for each ingress-nginx replica. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`resources.cpu`	CPU available to each replica.	`quantity`	`""`
`resources.memory`	Memory (RAM) available to each replica.	`quantity`	`""`
`resourcesPreset`	Default sizing preset used when `resources` is omitted.	`string`	`t1.micro`

SeaweedFS Service Reference

Mon, 01 Jan 0001 00:00:00 +0000

Parameters

Common parameters

Name	Description	Type	Value
`host`	The hostname used to access SeaweedFS externally (defaults to ‘s3’ subdomain for the tenant host).	`string`	`""`
`topology`	The topology of the SeaweedFS cluster.	`string`	`Simple`
`replicationFactor`	Replication factor: number of replicas for each volume in the SeaweedFS cluster.	`int`	`2`

SeaweedFS Components Configuration

Name	Description	Type	Value
`db`	Database configuration.	`object`	`{}`
`db.replicas`	Number of database replicas.	`int`	`2`
`db.size`	Persistent Volume size.	`quantity`	`10Gi`
`db.storageClass`	StorageClass used to store the data.	`string`	`""`
`db.resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`db.resources.cpu`	Number of CPU cores allocated.	`quantity`	`""`
`db.resources.memory`	Amount of memory allocated.	`quantity`	`""`
`db.resourcesPreset`	Default sizing preset used when `resources` is omitted.	`string`	`t1.small`
`master`	Master service configuration.	`object`	`{}`
`master.replicas`	Number of master replicas.	`int`	`3`
`master.resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`master.resources.cpu`	Number of CPU cores allocated.	`quantity`	`""`
`master.resources.memory`	Amount of memory allocated.	`quantity`	`""`
`master.resourcesPreset`	Default sizing preset used when `resources` is omitted.	`string`	`t1.small`
`master.volumeSizeLimitMB`	Size in MB at which a volume stops taking writes, and the divisor that sets how many buckets a volume server can serve. Lower it to fit more buckets on the same disk, at the cost of more volume files for the same stored data; on a large volume it is worth raising instead. Changing it on an instance that already holds data costs something either way: lowering it stops writes to every bucket whose volumes all reach the new value until that bucket can grow, and raising it takes the room new buckets grow into, so run the check in docs/operations/seaweedfs-lowering-the-volume-size-limit.md first. Must be between 1 and 30000. A value close to or above `volume.size` leaves each volume server a single slot rather than failing, since the server floors its slot count at one.	`int`	`400`
`filer`	Filer service configuration.	`object`	`{}`
`filer.replicas`	Number of filer replicas.	`int`	`2`
`filer.resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`filer.resources.cpu`	Number of CPU cores allocated.	`quantity`	`""`
`filer.resources.memory`	Amount of memory allocated.	`quantity`	`""`
`filer.resourcesPreset`	Default sizing preset used when `resources` is omitted.	`string`	`t1.small`
`filer.grpcHost`	The hostname used to expose or access the filer service externally.	`string`	`""`
`filer.grpcPort`	The port used to access the filer service externally.	`int`	`443`
`filer.whitelist`	A list of IP addresses or CIDR ranges that are allowed to access the filer service.	`[]string`	`[]`
`volume`	Volume service configuration.	`object`	`{}`
`volume.replicas`	Number of volume replicas.	`int`	`2`
`volume.size`	Persistent Volume size.	`quantity`	`10Gi`
`volume.storageClass`	StorageClass used to store the data.	`string`	`""`
`volume.diskType`	SeaweedFS disk type tag for the default volume servers (e.g., “hdd”, “ssd”).	`string`	`""`
`volume.resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`volume.resources.cpu`	Number of CPU cores allocated.	`quantity`	`""`
`volume.resources.memory`	Amount of memory allocated.	`quantity`	`""`
`volume.resourcesPreset`	Default sizing preset used when `resources` is omitted.	`string`	`t1.small`
`volume.zones`	A map of zones for MultiZone topology. Each zone can have its own number of replicas and size.	`map[string]object`	`{}`
`volume.zones[name].replicas`	Number of replicas in the zone.	`int`	`0`
`volume.zones[name].size`	Zone storage size.	`quantity`	`""`
`volume.zones[name].dataCenter`	SeaweedFS data center name for this zone. Defaults to the zone name.	`string`	`""`
`volume.zones[name].nodeSelector`	YAML nodeSelector for this zone (default: topology.kubernetes.io/zone: ).	`string`	`""`
`volume.zones[name].storageClass`	StorageClass used to store zone data. Defaults to volume.storageClass.	`string`	`""`
`volume.zones[name].pools`	A map of storage pools for this zone. Each pool creates a separate Volume StatefulSet per zone.	`map[string]object`	`{}`
`volume.zones[name].pools[name].diskType`	SeaweedFS disk type tag (e.g., “ssd”, “hdd”, “nvme”).	`string`	`""`
`volume.zones[name].pools[name].replicas`	Number of volume replicas. Defaults to volume.replicas (Simple) or zone.replicas/volume.replicas (MultiZone).	`int`	`0`
`volume.zones[name].pools[name].size`	Persistent Volume size. Defaults to volume.size (Simple) or zone.size/volume.size (MultiZone).	`quantity`	`""`
`volume.zones[name].pools[name].storageClass`	Kubernetes StorageClass for the pool. Defaults to volume.storageClass.	`string`	`""`
`volume.zones[name].pools[name].resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`volume.zones[name].pools[name].resources.cpu`	Number of CPU cores allocated.	`quantity`	`""`
`volume.zones[name].pools[name].resources.memory`	Amount of memory allocated.	`quantity`	`""`
`volume.zones[name].pools[name].resourcesPreset`	Default sizing preset used when `resources` is omitted. Defaults to volume.resourcesPreset.	`string`	`{}`
`volume.pools`	A map of storage pools. Each pool creates a separate Volume StatefulSet with its own disk type.	`map[string]object`	`{}`
`volume.pools[name].diskType`	SeaweedFS disk type tag (e.g., “ssd”, “hdd”, “nvme”).	`string`	`""`
`volume.pools[name].replicas`	Number of volume replicas. Defaults to volume.replicas (Simple) or zone.replicas/volume.replicas (MultiZone).	`int`	`0`
`volume.pools[name].size`	Persistent Volume size. Defaults to volume.size (Simple) or zone.size/volume.size (MultiZone).	`quantity`	`""`
`volume.pools[name].storageClass`	Kubernetes StorageClass for the pool. Defaults to volume.storageClass.	`string`	`""`
`volume.pools[name].resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`volume.pools[name].resources.cpu`	Number of CPU cores allocated.	`quantity`	`""`
`volume.pools[name].resources.memory`	Amount of memory allocated.	`quantity`	`""`
`volume.pools[name].resourcesPreset`	Default sizing preset used when `resources` is omitted. Defaults to volume.resourcesPreset.	`string`	`{}`
`s3`	S3 service configuration.	`object`	`{}`
`s3.replicas`	Number of S3 replicas.	`int`	`2`
`s3.resources`	Explicit CPU and memory configuration. When omitted, the preset defined in `resourcesPreset` is applied.	`object`	`{}`
`s3.resources.cpu`	Number of CPU cores allocated.	`quantity`	`""`
`s3.resources.memory`	Amount of memory allocated.	`quantity`	`""`
`s3.resourcesPreset`	Default sizing preset used when `resources` is omitted.	`string`	`t1.small`