index.md

Documentation

snapscheduler enables taking snapshots of Kubernetes Persistent Volumes according to a defined schedule. Each schedule defines how often a new snapshot should be created as well as the retention policy for the snapshots (i.e., the maximum number to retain and/or for how long).

Requirements

The snapscheduler operator is designed to work with Kubernetes CSI-based storage drivers that are capable of taking volume snapshots.

Kubernetes version compatibility:

snapscheduler	Kubernetes	snapshot.storage.k8s.io
1.0	1.13 -- 1.16	v1alpha1
1.1	1.13 -- 1.21	v1alpha1, v1beta1
1.2	1.13 -- 1.21	v1alpha1, v1beta1
2.0	1.17 -- 1.23	v1beta1
2.1	1.17 -- 1.23	v1beta1
3.0	1.20 -- 1.24+	v1
3.1	1.20 -- 1.24+	v1
3.2	1.20 -- 1.25+	v1
3.3	1.20 -- 1.28+	v1
3.4	1.20 -- 1.29+	v1
master	1.20 -- 1.30+	v1

Contents

User documentation

• Installing snapscheduler
• Using the scheduler
  • Approaches to labeling PVCs

Developer documentation

• Building & running snapscheduler locally
• Editing the documentation
• Project tracking & roadmap