Documentation
¶
Overview ¶
Package k8sbackup implements the Kubernetes backup agent: API resource dumps, PVC snapshots/clones, worker-pod supervision and the Secret-backed identity.
Index ¶
- Constants
- func BackupVolume(ctx context.Context, c *Clients, req VolumeBackupRequest) (*spec.VolumeResult, error)
- func IdentityPersist(core kubernetes.Interface, namespace, name string) func(cfg *config.AgentConfig) error
- func LoadIdentity(ctx context.Context, core kubernetes.Interface, namespace, name string) (*config.AgentConfig, error)
- func PlanVolumes(ctx context.Context, c *Clients, s *spec.Spec, clusterBackupID string) ([]spec.VolumePlan, []string, bool, error)
- func RunWorker(ctx context.Context) error
- func SaveIdentity(ctx context.Context, core kubernetes.Interface, namespace, name string, ...) error
- func Sweep(ctx context.Context, c *Clients, agentID string, ...)
- type Clients
- type DumpStats
- type VolumeBackupRequest
- type WorkerConfig
Constants ¶
const ( EnvWorkerServerURL = "FALLBCK_WORKER_SERVER_URL" EnvWorkerToken = "FALLBCK_WORKER_TOKEN" EnvWorkerTicket = "FALLBCK_WORKER_TICKET" EnvWorkerSession = "FALLBCK_WORKER_SESSION" // JSON temporal.BackupSessionInfo (identity fields) EnvWorkerPath = "FALLBCK_WORKER_PATH" // default /data EnvWorkerResult = "FALLBCK_WORKER_RESULT" // default /dev/termination-log EnvWorkerInsecure = "FALLBCK_WORKER_INSECURE_SKIP_VERIFY" EnvWorkerServerCA = "FALLBCK_WORKER_SERVER_CA" // inline PEM EnvWorkerPBSDirect = "FALLBCK_WORKER_PBS" // JSON backup.DirectOptions (direct mode) )
Environment of a worker pod (set by the agent when building the pod spec)
Variables ¶
This section is empty.
Functions ¶
func BackupVolume ¶
func BackupVolume(ctx context.Context, c *Clients, req VolumeBackupRequest) (*spec.VolumeResult, error)
BackupVolume executes one volume backup: snapshot → clone → worker pod (or a live read-only mount), returning the worker's result. All created objects are labeled and cleaned up on every path.
func IdentityPersist ¶
func IdentityPersist(core kubernetes.Interface, namespace, name string) func(cfg *config.AgentConfig) error
IdentityPersist adapts SaveIdentity for runtime.TokenStore.Persist (token rotations)
func LoadIdentity ¶
func LoadIdentity(ctx context.Context, core kubernetes.Interface, namespace, name string) (*config.AgentConfig, error)
LoadIdentity reads the enrolled agent configuration from the identity Secret; (nil, nil) when the Secret does not exist yet.
func PlanVolumes ¶
func PlanVolumes(ctx context.Context, c *Clients, s *spec.Spec, clusterBackupID string) ([]spec.VolumePlan, []string, bool, error)
PlanVolumes selects the PVCs a run backs up and decides snapshot vs live per volume
func RunWorker ¶
RunWorker is the worker-pod entrypoint: mount is at /data, credentials in the environment; the outcome is written to the termination-message file so the agent can read it from the pod status.
func SaveIdentity ¶
func SaveIdentity(ctx context.Context, core kubernetes.Interface, namespace, name string, cfg *config.AgentConfig) error
SaveIdentity writes the agent configuration into the identity Secret (create or update)
Types ¶
type Clients ¶
type Clients struct {
Discovery discovery.DiscoveryInterface
Dynamic dynamic.Interface
Core kubernetes.Interface
}
Clients bundles the API clients the agent needs; tests inject fakes.
func InClusterClients ¶
InClusterClients builds the clients from the pod's ServiceAccount
type DumpStats ¶
type DumpStats struct {
Counts map[string]int
Excluded []string
FailedGroups []string
Namespaces []string
Warnings []string
}
DumpStats summarises a resource dump for the manifest
func DumpResources ¶
func DumpResources(ctx context.Context, c *Clients, s *spec.Spec, spoolDir string, progress func(phase string)) (*DumpStats, error)
DumpResources writes every selected API resource as YAML under spoolDir: cluster/<group>/<version>/<plural>/<name>.yaml and namespaces/<ns>/<group>/<version>/<plural>/<name>.yaml. Memory stays flat: objects are fetched in pages of 500, written and dropped.
type VolumeBackupRequest ¶
type VolumeBackupRequest struct {
Plan spec.VolumePlan
RunID string
AgentID string
SnapshotTimeout time.Duration
VolumeTimeout time.Duration
AllowLiveFallback bool
Worker WorkerConfig
Progress func(phase string)
}
VolumeBackupRequest is one volume's backup order
type WorkerConfig ¶
type WorkerConfig struct {
Image string
// ImagePullPolicy for worker pods (default IfNotPresent; ":latest" would otherwise
// imply Always and break air-gapped/preloaded images)
ImagePullPolicy string
// Resources / SecurityContext are corev1 JSON blobs from the Helm chart (optional)
ResourcesJSON string
SecurityContextJSON string
// Env carries the worker credentials and session (built by the activity)
Env []corev1.EnvVar
}
WorkerConfig describes the worker pod the agent spawns per volume
Source Files