br: make schdule support compact (#6033)

Author: RidRisR

docs/api-references/docs.md

@@ -189,7 +189,9 @@ StorageProvider
 <p>
 (Members of <code>StorageProvider</code> are embedded into this type.)
 </p>
-<p>StorageProvider configures where and how backups should be stored.</p>
+<p>StorageProvider configures where and how backups should be stored.
+*** Note: This field should generally not be left empty, unless you are certain the storage provider
+*** can be obtained from another source, such as a schedule CR.</p>
 </td>
 </tr>
 <tr>
@@ -226,7 +228,9 @@ BRConfig
 </em>
 </td>
 <td>
-<p>BRConfig is the configs for BR</p>
+<p>BRConfig is the configs for BR
+*** Note: This field should generally not be left empty, unless you are certain the BR config
+*** can be obtained from another source, such as a schedule CR.</p>
 </td>
 </tr>
 <tr>
@@ -647,6 +651,17 @@ string
 </tr>
 <tr>
 <td>
+<code>compactSpan</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>CompactSpan is to specify how long backups we want to compact.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>backupTemplate</code></br>
 <em>
 <a href="#backupspec">
@@ -674,6 +689,20 @@ BackupSpec
 </tr>
 <tr>
 <td>
+<code>compactBackupTemplate</code></br>
+<em>
+<a href="#compactspec">
+CompactSpec
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>CompactBackupTemplate is the specification of the compact backup structure to get scheduled.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>storageClassName</code></br>
 <em>
 string
@@ -710,6 +739,37 @@ string
 <p>ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>br</code></br>
+<em>
+<a href="#brconfig">
+BRConfig
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>BRConfig is the configs for BR</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>StorageProvider</code></br>
+<em>
+<a href="#storageprovider">
+StorageProvider
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>StorageProvider</code> are embedded into this type.)
+</p>
+<em>(Optional)</em>
+<p>StorageProvider configures where and how backups should be stored.</p>
+</td>
+</tr>
 </table>
 </td>
 </tr>
@@ -3446,6 +3506,7 @@ string
 <h3 id="brconfig">BRConfig</h3>
 <p>
 (<em>Appears on:</em>
+<a href="#backupschedulespec">BackupScheduleSpec</a>, 
 <a href="#backupspec">BackupSpec</a>, 
 <a href="#compactspec">CompactSpec</a>, 
 <a href="#restorespec">RestoreSpec</a>)
@@ -3938,6 +3999,17 @@ string
 </tr>
 <tr>
 <td>
+<code>compactSpan</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>CompactSpan is to specify how long backups we want to compact.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>backupTemplate</code></br>
 <em>
 <a href="#backupspec">
@@ -3965,6 +4037,20 @@ BackupSpec
 </tr>
 <tr>
 <td>
+<code>compactBackupTemplate</code></br>
+<em>
+<a href="#compactspec">
+CompactSpec
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>CompactBackupTemplate is the specification of the compact backup structure to get scheduled.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>storageClassName</code></br>
 <em>
 string
@@ -4001,6 +4087,37 @@ string
 <p>ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>br</code></br>
+<em>
+<a href="#brconfig">
+BRConfig
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>BRConfig is the configs for BR</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>StorageProvider</code></br>
+<em>
+<a href="#storageprovider">
+StorageProvider
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>StorageProvider</code> are embedded into this type.)
+</p>
+<em>(Optional)</em>
+<p>StorageProvider configures where and how backups should be stored.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="backupschedulestatus">BackupScheduleStatus</h3>
@@ -4032,6 +4149,17 @@ string
 </tr>
 <tr>
 <td>
+<code>lastCompact</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>LastCompact represents the last compact</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>logBackup</code></br>
 <em>
 string
@@ -4043,6 +4171,19 @@ string
 </tr>
 <tr>
 <td>
+<code>logBackupStartTs</code></br>
+<em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta">
+Kubernetes meta/v1.Time
+</a>
+</em>
+</td>
+<td>
+<p>LogBackupStartTs represents the start time of log backup</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>lastBackupTime</code></br>
 <em>
 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta">
@@ -4056,6 +4197,32 @@ Kubernetes meta/v1.Time
 </tr>
 <tr>
 <td>
+<code>lastCompactTs</code></br>
+<em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta">
+Kubernetes meta/v1.Time
+</a>
+</em>
+</td>
+<td>
+<p>LastCompactTs represents the endTs of the last compact</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>nextCompactEndTs</code></br>
+<em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta">
+Kubernetes meta/v1.Time
+</a>
+</em>
+</td>
+<td>
+<p>NextCompactEndTs represents the scheduled endTs of next compact</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>allBackupCleanTime</code></br>
 <em>
 <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta">
@@ -4193,7 +4360,9 @@ StorageProvider
 <p>
 (Members of <code>StorageProvider</code> are embedded into this type.)
 </p>
-<p>StorageProvider configures where and how backups should be stored.</p>
+<p>StorageProvider configures where and how backups should be stored.
+*** Note: This field should generally not be left empty, unless you are certain the storage provider
+*** can be obtained from another source, such as a schedule CR.</p>
 </td>
 </tr>
 <tr>
@@ -4230,7 +4399,9 @@ BRConfig
 </em>
 </td>
 <td>
-<p>BRConfig is the configs for BR</p>
+<p>BRConfig is the configs for BR
+*** Note: This field should generally not be left empty, unless you are certain the BR config
+*** can be obtained from another source, such as a schedule CR.</p>
 </td>
 </tr>
 <tr>
@@ -5429,7 +5600,9 @@ StorageProvider
 <p>
 (Members of <code>StorageProvider</code> are embedded into this type.)
 </p>
-<p>StorageProvider configures where and how backups should be stored.</p>
+<p>StorageProvider configures where and how backups should be stored.
+*** Note: This field should generally not be left empty, unless you are certain the storage provider
+*** can be obtained from another source, such as a schedule CR.</p>
 </td>
 </tr>
 <tr>
@@ -5507,7 +5680,9 @@ BRConfig
 </em>
 </td>
 <td>
-<p>BRConfig is the configs for BR</p>
+<p>BRConfig is the configs for BR
+*** Note: This field should generally not be left empty, unless you are certain the BR config
+*** can be obtained from another source, such as a schedule CR.</p>
 </td>
 </tr>
 <tr>
@@ -5697,6 +5872,7 @@ string
 <h3 id="compactspec">CompactSpec</h3>
 <p>
 (<em>Appears on:</em>
+<a href="#backupschedulespec">BackupScheduleSpec</a>, 
 <a href="#compactbackup">CompactBackup</a>)
 </p>
 <p>
@@ -5765,7 +5941,9 @@ StorageProvider
 <p>
 (Members of <code>StorageProvider</code> are embedded into this type.)
 </p>
-<p>StorageProvider configures where and how backups should be stored.</p>
+<p>StorageProvider configures where and how backups should be stored.
+*** Note: This field should generally not be left empty, unless you are certain the storage provider
+*** can be obtained from another source, such as a schedule CR.</p>
 </td>
 </tr>
 <tr>
@@ -5843,7 +6021,9 @@ BRConfig
 </em>
 </td>
 <td>
-<p>BRConfig is the configs for BR</p>
+<p>BRConfig is the configs for BR
+*** Note: This field should generally not be left empty, unless you are certain the BR config
+*** can be obtained from another source, such as a schedule CR.</p>
 </td>
 </tr>
 <tr>
@@ -16571,6 +16751,7 @@ More info: <a href="https://kubernetes.io/docs/concepts/storage/persistent-volum
 <h3 id="storageprovider">StorageProvider</h3>
 <p>
 (<em>Appears on:</em>
+<a href="#backupschedulespec">BackupScheduleSpec</a>, 
 <a href="#backupspec">BackupSpec</a>, 
 <a href="#compactspec">CompactSpec</a>, 
 <a href="#restorespec">RestoreSpec</a>)