gobackup / gobackup/gobackup-operator
Validate storage connection on Storage create and surface errors in status (describe)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
Summary
When a Storage resource is created/applied, validate that the operator can actually connect to the configured storage backend. If the connection check fails, record the error in the resource's status so it is visible via kubectl describe storage <name>.
Motivation
Today a Storage can be applied with invalid or unreachable configuration (wrong credentials, bad endpoint/host, missing bucket, network failure) and nothing surfaces the problem until a backup job tries to use it and fails. Users have no immediate feedback on whether a storage definition is usable.
Current state
StorageStatusis empty — no observed state is recorded (api/v1/storage_types.go:181).- There is no
Storagecontroller/reconciler; onlyBackupReconcilerreferences storages (get;list;watch) and validates thatStorageRefsare non-empty (internal/controller/backup_controller.go).
Proposed behavior
- On Storage create/update, perform a lightweight connectivity/auth check against the backend (per
spec.type), e.g. verify endpoint reachability and credentials/bucket access without writing real backup data. - Write the outcome to
StorageStatus:- A
Readycondition (status: True/False, reason, message), and/or a phase + human-readable message. - On failure, include the error message so it shows up in
kubectl describe storage <name>events/conditions.
- A
- Re-validate when the spec changes (track
observedGeneration).
Acceptance criteria
-
StorageStatusgains fields/conditions to represent connection state and error message. - A reconciler (or the existing flow) runs the connection check and updates status.
- A misconfigured Storage shows the failure reason in
kubectl describe. - A valid Storage shows a Ready/healthy state.
- CRD manifests regenerated (note:
charts/CRDs are not auto-synced bymake manifestsand must be hand-synced).
Open questions
- Which backends get a real connectivity check vs. config-only validation in the first pass?
- Should the check run periodically (requeue) or only on spec change?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with StorageStatus in api/v1/storage_types.go and the storage references and validation flow in internal/controller/backup_controller.go; determine how the proposed reconciler fits the current operator structure. Review the backend-specific scope in the issue and run make manifests when schema changes are defined. Done means a misconfigured Storage exposes a failure through describe, a valid one reports healthy, and charts/ CRDs are hand-synced.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- backend, devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100