Add more details to ClusterBackupSpec api doc

Signed-off-by: Florent Poinsard <[email protected]>
planetscale · Sep 27, 2022 · 50ec58e · 50ec58e
1 parent beaeb3e
commit 50ec58e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/api/index.html b/docs/api/index.html
@@ -616,7 +616,9 @@ <h3 id="planetscale.com/v2.ClusterBackupSpec">ClusterBackupSpec
 <a href="#planetscale.com/v2.VitessClusterSpec">VitessClusterSpec</a>)
 </p>
 <p>
-<p>ClusterBackupSpec configures backups for a cluster.</p>
+<p>ClusterBackupSpec configures backups for a cluster.
+In addition to disaster recovery, Vitess currently depends on backups to support
+provisioning of a new tablet in a shard with existing data, as an implementation detail.</p>
 </p>
 <table class="table table-striped">
 <thead class="thead-dark">

diff --git a/pkg/apis/planetscale/v2/vitesscluster_types.go b/pkg/apis/planetscale/v2/vitesscluster_types.go
@@ -284,6 +284,8 @@ type VitessImagePullPolicies struct {
 }
 
 // ClusterBackupSpec configures backups for a cluster.
+// In addition to disaster recovery, Vitess currently depends on backups to support
+// provisioning of a new tablet in a shard with existing data, as an implementation detail.
 type ClusterBackupSpec struct {
 	// Locations is a list of places where Vitess backup data for the cluster
 	// can be stored. At least one storage location must be specified.