br: add warmup param to restore CR

Signed-off-by: WangLe1321 <[email protected]>
pingcap · Jun 30, 2023 · e1394da · e1394da
1 parent f0b71e4
commit e1394da
Show file tree

Hide file tree

Showing 17 changed files with 264 additions and 64 deletions.
diff --git a/docs/api-references/docs.md b/docs/api-references/docs.md
@@ -1473,6 +1473,32 @@ For BR image, if it does not contain tag, Pod will use image &lsquo;ToolImage:${
 </tr>
 <tr>
 <td>
+<code>warmup</code></br>
+<em>
+<a href="#restorewarmupmode">
+RestoreWarmupMode
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Warmup represents whether to initialize TiKV volumes after volume snapshot restore</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>warmupImage</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>WarmupImage represents using what image to initialize TiKV volumes</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>podSecurityContext</code></br>
 <em>
 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#podsecuritycontext-v1-core">
@@ -13890,6 +13916,32 @@ For BR image, if it does not contain tag, Pod will use image &lsquo;ToolImage:${
 </tr>
 <tr>
 <td>
+<code>warmup</code></br>
+<em>
+<a href="#restorewarmupmode">
+RestoreWarmupMode
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Warmup represents whether to initialize TiKV volumes after volume snapshot restore</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>warmupImage</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>WarmupImage represents using what image to initialize TiKV volumes</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>podSecurityContext</code></br>
 <em>
 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#podsecuritycontext-v1-core">
@@ -14008,6 +14060,14 @@ RestoreConditionType
 </tr>
 </tbody>
 </table>
+<h3 id="restorewarmupmode">RestoreWarmupMode</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#restorespec">RestoreSpec</a>)
+</p>
+<p>
+<p>RestoreWarmupMode represents when to initialize TiKV volumes</p>
+</p>
 <h3 id="s3storageprovider">S3StorageProvider</h3>
 <p>
 (<em>Appears on:</em>

diff --git a/docs/api-references/federation-docs.md b/docs/api-references/federation-docs.md
@@ -1235,6 +1235,30 @@ string
 <p>PriorityClassName of Restore Job Pods</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>warmup</code></br>
+<em>
+github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.RestoreWarmupMode
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Warmup represents whether to initialize TiKV volumes after volume snapshot restore</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>warmupImage</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>WarmupImage represents using what image to initialize TiKV volumes</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="volumerestorespec">VolumeRestoreSpec</h3>

diff --git a/manifests/crd.yaml b/manifests/crd.yaml
@@ -14305,6 +14305,10 @@ spec:
                 type: boolean
               volumeAZ:
                 type: string
+              warmup:
+                type: string
+              warmupImage:
+                type: string
             type: object
           status:
             properties:

diff --git a/manifests/crd/federation/v1/federation.pingcap.com_volumerestores.yaml b/manifests/crd/federation/v1/federation.pingcap.com_volumerestores.yaml
@@ -945,6 +945,10 @@ spec:
                     type: array
                   toolImage:
                     type: string
+                  warmup:
+                    type: string
+                  warmupImage:
+                    type: string
                 type: object
             type: object
           status:

diff --git a/manifests/crd/federation/v1beta1/federation.pingcap.com_volumerestores.yaml b/manifests/crd/federation/v1beta1/federation.pingcap.com_volumerestores.yaml
@@ -945,6 +945,10 @@ spec:
                   type: array
                 toolImage:
                   type: string
+                warmup:
+                  type: string
+                warmupImage:
+                  type: string
               type: object
           type: object
         status:

diff --git a/manifests/crd/v1/pingcap.com_restores.yaml b/manifests/crd/v1/pingcap.com_restores.yaml
@@ -2083,6 +2083,10 @@ spec:
                 type: boolean
               volumeAZ:
                 type: string
+              warmup:
+                type: string
+              warmupImage:
+                type: string
             type: object
           status:
             properties:

diff --git a/manifests/crd/v1beta1/pingcap.com_restores.yaml b/manifests/crd/v1beta1/pingcap.com_restores.yaml
@@ -2082,6 +2082,10 @@ spec:
               type: boolean
             volumeAZ:
               type: string
+            warmup:
+              type: string
+            warmupImage:
+              type: string
           type: object
         status:
           properties:

diff --git a/manifests/crd_v1beta1.yaml b/manifests/crd_v1beta1.yaml
@@ -14285,6 +14285,10 @@ spec:
               type: boolean
             volumeAZ:
               type: string
+            warmup:
+              type: string
+            warmupImage:
+              type: string
           type: object
         status:
           properties:

diff --git a/manifests/federation-crd.yaml b/manifests/federation-crd.yaml
@@ -2019,6 +2019,10 @@ spec:
                     type: array
                   toolImage:
                     type: string
+                  warmup:
+                    type: string
+                  warmupImage:
+                    type: string
                 type: object
             type: object
           status:

diff --git a/manifests/federation-crd_v1beta1.yaml b/manifests/federation-crd_v1beta1.yaml
@@ -2023,6 +2023,10 @@ spec:
                   type: array
                 toolImage:
                   type: string
+                warmup:
+                  type: string
+                warmupImage:
+                  type: string
               type: object
           type: object
         status:

diff --git a/pkg/apis/federation/pingcap/v1alpha1/openapi_generated.go b/pkg/apis/federation/pingcap/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/federation/pingcap/v1alpha1/types.go b/pkg/apis/federation/pingcap/v1alpha1/types.go
@@ -327,6 +327,12 @@ type VolumeRestoreMemberSpec struct {
 	ServiceAccount string `json:"serviceAccount,omitempty"`
 	// PriorityClassName of Restore Job Pods
 	PriorityClassName string `json:"priorityClassName,omitempty"`
+	// Warmup represents whether to initialize TiKV volumes after volume snapshot restore
+	// +optional
+	Warmup pingcapv1alpha1.RestoreWarmupMode `json:"warmup,omitempty"`
+	// WarmupImage represents using what image to initialize TiKV volumes
+	// +optional
+	WarmupImage string `json:"warmupImage,omitempty"`
 }
 
 type VolumeRestoreMemberBackupInfo struct {

diff --git a/pkg/apis/pingcap/v1alpha1/openapi_generated.go b/pkg/apis/pingcap/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/pingcap/v1alpha1/types.go b/pkg/apis/pingcap/v1alpha1/types.go
@@ -2433,12 +2433,12 @@ type RestoreSpec struct {
 	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
 	// TableFilter means Table filter expression for 'db.table' matching. BR supports this from v4.0.3.
 	TableFilter []string `json:"tableFilter,omitempty"`
-	// ImagePullSecrets represents whether to initialize TiKV volumes after volume snapshot restore
+	// Warmup represents whether to initialize TiKV volumes after volume snapshot restore
 	// +optional
-	WarmUp bool `json:"warmUp,omitempty"`
-	// ImagePullSecrets represents using what image to initialize TiKV volumes
+	Warmup RestoreWarmupMode `json:"warmup,omitempty"`
+	// WarmupImage represents using what image to initialize TiKV volumes
 	// +optional
-	WarmUpImage string `json:"warmUpImage,omitempty"`
+	WarmupImage string `json:"warmupImage,omitempty"`
 
 	// PodSecurityContext of the component
 	// +optional
@@ -2460,6 +2460,16 @@ const (
 	FederalVolumeRestoreFinish FederalVolumeRestorePhase = "restore-finish"
 )
 
+// RestoreWarmupMode represents when to initialize TiKV volumes
+type RestoreWarmupMode string
+
+const (
+	// RestoreWarmupModeSync means initialize TiKV volumes before TiKV starts
+	RestoreWarmupModeSync RestoreWarmupMode = "sync"
+	// RestoreWarmupModeASync means initialize TiKV volumes after restore complete
+	RestoreWarmupModeASync RestoreWarmupMode = "async"
+)
+
 // RestoreStatus represents the current status of a tidb cluster restore.
 type RestoreStatus struct {
 	// TimeStarted is the time at which the restore was started.