unkin-agent
9da206dc7c
PVCs and CloudNativePG Clusters need S3 buckets and backup schedules
provisioned consistently. This operator watches the
backups.unkin.net/{schedule,destination} annotations on those objects and
provisions everything needed to back them up, with no new CRDs.
- Add a PVC controller that provisions cephrgw ObjectStoreUser/Bucket/BucketAccess,
auto-generates a restic repo-password Secret and creates a k8up Schedule scoped
to the PVC via spec.backup.volumes[].persistentVolumeClaim.claimName.
- Add a CNPG Cluster controller that provisions the same bucket stack, idempotently
patches spec.backup.barmanObjectStore (leaving a user-set destinationPath alone
with a Warning event) and creates a ScheduledBackup.
- Resolve destinations through a ConfigMap lookup table; requeue until the
BucketAccess is Ready before creating schedule resources; own-reference created
resources and retain bucket data by default.
- Add schedule-mapping helpers (k8up 5-field/shortcut pass-through, CNPG 6-field
seconds-first) and deterministic, length-bounded name derivation.
- Add unit tests (schedule mapping, name derivation, destination resolution) and
envtest controller tests for both paths, wiring the external CRDs into envtest.
- Add kubebuilder-generated RBAC, a Dockerfile (distroless/nonroot), Woodpecker
lint/test/build pipelines and a tag-triggered image push to the artifactapi
docker-internal registry, plus a version-bump Makefile and deploy manifests.
61 lines
1.8 KiB
Go
61 lines
1.8 KiB
Go
package controller
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
func TestDerivedNames(t *testing.T) {
|
|
if got := bucketName("prod", "data"); got != "autobk-prod-data" {
|
|
t.Errorf("bucketName = %q", got)
|
|
}
|
|
if got := userName("data"); got != "autobk-data-owner" {
|
|
t.Errorf("userName = %q", got)
|
|
}
|
|
if got := accessName("data"); got != "autobk-data-rw" {
|
|
t.Errorf("accessName = %q", got)
|
|
}
|
|
if got := credSecretName("data"); got != "data-autobackup-rgw" {
|
|
t.Errorf("credSecretName = %q", got)
|
|
}
|
|
if got := resticSecretName("data"); got != "data-autobackup-restic" {
|
|
t.Errorf("resticSecretName = %q", got)
|
|
}
|
|
if got := scheduleName("data"); got != "data-autobackup" {
|
|
t.Errorf("scheduleName = %q", got)
|
|
}
|
|
}
|
|
|
|
func TestBucketNameSanitisesAndClamps(t *testing.T) {
|
|
// Upper-case and invalid characters are lowercased/replaced.
|
|
if got := bucketName("Prod_NS", "My.Data"); strings.ToLower(got) != got {
|
|
t.Errorf("bucketName not lowercased: %q", got)
|
|
}
|
|
|
|
longNS := strings.Repeat("a", 40)
|
|
longObj := strings.Repeat("b", 40)
|
|
got := bucketName(longNS, longObj)
|
|
if len(got) > maxBucketName {
|
|
t.Errorf("bucketName %q exceeds %d chars (%d)", got, maxBucketName, len(got))
|
|
}
|
|
// Deterministic: same inputs -> same hashed name.
|
|
if got2 := bucketName(longNS, longObj); got != got2 {
|
|
t.Errorf("bucketName not deterministic: %q vs %q", got, got2)
|
|
}
|
|
// Distinct long inputs -> distinct names (hash disambiguates).
|
|
if other := bucketName(longNS, strings.Repeat("c", 40)); other == got {
|
|
t.Errorf("bucketName collision for distinct inputs: %q", got)
|
|
}
|
|
}
|
|
|
|
func TestObjectNameClamps(t *testing.T) {
|
|
longObj := strings.Repeat("x", 300)
|
|
got := scheduleName(longObj)
|
|
if len(got) > maxObjectName {
|
|
t.Errorf("scheduleName %q exceeds %d chars (%d)", got, maxObjectName, len(got))
|
|
}
|
|
if got2 := scheduleName(longObj); got != got2 {
|
|
t.Errorf("scheduleName not deterministic")
|
|
}
|
|
}
|