Cluster Services Reference on Cozystack

Velero Backup Configuration

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

This guide is for cluster administrators who configure the backup infrastructure in Cozystack: S3 storage, Velero locations, backup strategies, and BackupClasses. Tenant users then use existing BackupClasses to create BackupJobs and Plans.

Prerequisites

Administrator access to the Cozystack (management) cluster.
S3-compatible storage: if you want to store backups in Cozy you need enable SeaweedFS and create a Bucket or can use another external S3 service.
Enable disabled by default component cozystack.velero in bundles.enabledPackages of the Platform Package. And for tenant clusters, set spec.addons.velero.enabled to true in the Kubernetes resource.

1. Set up storage credentials and configuration

Create the following resources in the management cluster in the cozy-velero namespace so that Velero can store backups and volume snapshots.

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`

Etcd Service Reference

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

Parameters

Common parameters

Name	Description	Type	Value
`size`	Persistent Volume size.	`quantity`	`4Gi`
`storageClass`	StorageClass used to store the data.	`string`	`""`
`replicas`	Number of etcd replicas.	`int`	`3`
`resources`	Resource configuration for etcd.	`object`	`{}`
`resources.cpu`	Number of CPU cores allocated.	`quantity`	`1000m`
`resources.memory`	Amount of memory allocated.	`quantity`	`512Mi`

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`
`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`	`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`	`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`	`small`
`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`	`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`	`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`	`small`