Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history 
Signed-off-by: Xieql <xieqianglong@huawei.com>
  • Loading branch information
@Xieql
Xieql committed Aug 30, 2023
1 parent 9798539 commit 26ac2fc
Show file tree
Hide file tree
Showing 5 changed files with 155 additions and 328 deletions.
241 changes: 55 additions & 186 deletions docs/content/en/references/backups_v1alpha1_types.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,6 @@ <h3 id="backup.kurator.dev/v1alpha1.Backup">Backup
<table>
<tr>
<td>
<code>storage</code><br>
<em>
<a href="#backup.kurator.dev/v1alpha1.BackupStorage">
BackupStorage
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Storage details where the backup data should be stored.
If not set, the backup will use the default Storage that is created during Velero installation.</p>
</td>
</tr>
<tr>
<td>
<code>schedule</code><br>
<em>
string
Expand All @@ -91,7 +76,16 @@ <h3 id="backup.kurator.dev/v1alpha1.Backup">Backup
<em>(Optional)</em>
<p>Schedule defines when to run the Backup using a Cron expression.
A cron expression is a format used to specify the execution time of recurring tasks, consisting of multiple fields representing different time units.
For example, &ldquo;30 * * * <em>&rdquo; represents execution at the 30th minute of every hour, &ldquo;</em>/15 * * * *&rdquo; represents execution every 15 minutes, and &ldquo;10 10,14 * * *&rdquo; represents execution at 10:10 AM and 2:10 PM every day.
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌───────────── month (1 - 12)
│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday;
│ │ │ │ │ 7 is also Sunday on some systems)
│ │ │ │ │
│ │ │ │ │</p>
<hr />
<p>For example, &ldquo;30 * * * *&rdquo; represents execution at the 30th minute of every hour, and &ldquo;10 10,14 * * *&rdquo; represents execution at 10:10 AM and 2:10 PM every day.
If not set, the backup will be executed only once.</p>
</td>
</tr>
Expand Down Expand Up @@ -271,7 +265,13 @@ <h3 id="backup.kurator.dev/v1alpha1.BackupPolicy">BackupPolicy
<em>(Optional)</em>
<p>OrderedResources specifies the backup order of resources of specific Kind.
The map key is the resource name and value is a list of object names separated by commas.
Each resource name has format &ldquo;namespace/objectname&rdquo;. For cluster resources, simply use &ldquo;objectname&rdquo;.</p>
Each resource name has format &ldquo;namespace/objectname&rdquo;. For cluster resources, simply use &ldquo;objectname&rdquo;.
For example, if you have a specific order for pods, such as &ldquo;pod1, pod2, pod3&rdquo; with all belonging to the &ldquo;ns1&rdquo; namespace,
and a specific order for persistentvolumes, such as &ldquo;pv4, pv8&rdquo;, you can use the orderedResources field in YAML format as shown below:</p>
<pre><code class="language-yaml">orderedResources:
pods: &quot;ns1/pod1, ns1/pod2, ns1/pod3&quot;
persistentvolumes: &quot;pv4, pv8&quot;
</code></pre>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -311,21 +311,6 @@ <h3 id="backup.kurator.dev/v1alpha1.BackupSpec">BackupSpec
<tbody>
<tr>
<td>
<code>storage</code><br>
<em>
<a href="#backup.kurator.dev/v1alpha1.BackupStorage">
BackupStorage
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Storage details where the backup data should be stored.
If not set, the backup will use the default Storage that is created during Velero installation.</p>
</td>
</tr>
<tr>
<td>
<code>schedule</code><br>
<em>
string
Expand All @@ -335,7 +320,16 @@ <h3 id="backup.kurator.dev/v1alpha1.BackupSpec">BackupSpec
<em>(Optional)</em>
<p>Schedule defines when to run the Backup using a Cron expression.
A cron expression is a format used to specify the execution time of recurring tasks, consisting of multiple fields representing different time units.
For example, &ldquo;30 * * * <em>&rdquo; represents execution at the 30th minute of every hour, &ldquo;</em>/15 * * * *&rdquo; represents execution every 15 minutes, and &ldquo;10 10,14 * * *&rdquo; represents execution at 10:10 AM and 2:10 PM every day.
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌───────────── month (1 - 12)
│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday;
│ │ │ │ │ 7 is also Sunday on some systems)
│ │ │ │ │
│ │ │ │ │</p>
<hr />
<p>For example, &ldquo;30 * * * *&rdquo; represents execution at the 30th minute of every hour, and &ldquo;10 10,14 * * *&rdquo; represents execution at 10:10 AM and 2:10 PM every day.
If not set, the backup will be executed only once.</p>
</td>
</tr>
Expand Down Expand Up @@ -431,115 +425,6 @@ <h3 id="backup.kurator.dev/v1alpha1.BackupStatus">BackupStatus
</table>
</div>
</div>
<h3 id="backup.kurator.dev/v1alpha1.BackupStorage">BackupStorage
</h3>
<p>
(<em>Appears on:</em>
<a href="#backup.kurator.dev/v1alpha1.BackupSpec">BackupSpec</a>,
<a href="#backup.kurator.dev/v1alpha1.MigrateSpec">MigrateSpec</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>location</code><br>
<em>
<a href="#backup.kurator.dev/v1alpha1.BackupStorageLocation">
BackupStorageLocation
</a>
</em>
</td>
<td>
<p>Location specifies the location where the backup data will be stored.</p>
</td>
</tr>
<tr>
<td>
<code>credentials</code><br>
<em>
string
</em>
</td>
<td>
<p>Credentials to access the backup storage location.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="backup.kurator.dev/v1alpha1.BackupStorageLocation">BackupStorageLocation
</h3>
<p>
(<em>Appears on:</em>
<a href="#backup.kurator.dev/v1alpha1.BackupStorage">BackupStorage</a>)
</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table td-content">
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>bucket</code><br>
<em>
string
</em>
</td>
<td>
<p>Bucket specifies the storage bucket name.</p>
</td>
</tr>
<tr>
<td>
<code>provider</code><br>
<em>
string
</em>
</td>
<td>
<p>Provider specifies the storage provider type (e.g., aws).</p>
</td>
</tr>
<tr>
<td>
<code>s3Url</code><br>
<em>
string
</em>
</td>
<td>
<p>S3Url provides the endpoint URL for S3-compatible storage.</p>
</td>
</tr>
<tr>
<td>
<code>region</code><br>
<em>
string
</em>
</td>
<td>
<p>Region specifies the region of the storage.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="backup.kurator.dev/v1alpha1.ClusterSelector">ClusterSelector
</h3>
<p>
Expand Down Expand Up @@ -681,19 +566,6 @@ <h3 id="backup.kurator.dev/v1alpha1.Migrate">Migrate
<table>
<tr>
<td>
<code>storage</code><br>
<em>
<a href="#backup.kurator.dev/v1alpha1.BackupStorage">
BackupStorage
</a>
</em>
</td>
<td>
<p>Storage details where the data should be stored.</p>
</td>
</tr>
<tr>
<td>
<code>sourceCluster</code><br>
<em>
<a href="#backup.kurator.dev/v1alpha1.Destination">
Expand Down Expand Up @@ -873,19 +745,6 @@ <h3 id="backup.kurator.dev/v1alpha1.MigrateSpec">MigrateSpec
<tbody>
<tr>
<td>
<code>storage</code><br>
<em>
<a href="#backup.kurator.dev/v1alpha1.BackupStorage">
BackupStorage
</a>
</em>
</td>
<td>
<p>Storage details where the data should be stored.</p>
</td>
</tr>
<tr>
<td>
<code>sourceCluster</code><br>
<em>
<a href="#backup.kurator.dev/v1alpha1.Destination">
Expand Down Expand Up @@ -1054,7 +913,9 @@ <h3 id="backup.kurator.dev/v1alpha1.ResourceFilter">ResourceFilter
<td>
<em>(Optional)</em>
<p>IncludedResources is a slice of resource names to include in the backup.
If empty, all resources are included.</p>
For example, we can populate this string array with &ldquo;deployments&rdquo; and &ldquo;configmaps&rdquo;, then we will select all resources of type deployments and configmaps,
If empty, all resources are included.
Cannot work with IncludedClusterScopedResources, ExcludedClusterScopedResources, IncludedNamespaceScopedResources and ExcludedNamespaceScopedResources.</p>
</td>
</tr>
<tr>
Expand All @@ -1066,7 +927,21 @@ <h3 id="backup.kurator.dev/v1alpha1.ResourceFilter">ResourceFilter
</td>
<td>
<em>(Optional)</em>
<p>ExcludedResources is a slice of resource names that are not included in the backup.</p>
<p>ExcludedResources is a slice of resource names that are not included in the backup.
Cannot work with IncludedClusterScopedResources, ExcludedClusterScopedResources, IncludedNamespaceScopedResources and ExcludedNamespaceScopedResources.</p>
</td>
</tr>
<tr>
<td>
<code>includeClusterResources</code><br>
<em>
bool
</em>
</td>
<td>
<em>(Optional)</em>
<p>IncludeClusterResources specifies whether cluster-scoped resources should be included for consideration in the backup.
Cannot work with IncludedClusterScopedResources, ExcludedClusterScopedResources, IncludedNamespaceScopedResources and ExcludedNamespaceScopedResources.</p>
</td>
</tr>
<tr>
Expand All @@ -1079,8 +954,10 @@ <h3 id="backup.kurator.dev/v1alpha1.ResourceFilter">ResourceFilter
<td>
<em>(Optional)</em>
<p>IncludedClusterScopedResources is a slice of cluster-scoped resource type names to include in the backup.
For example, we can populate this string array with &ldquo;storageclasses&rdquo; and &ldquo;clusterroles&rdquo;, then we will select all resources of type storageclasses and clusterroles,
If set to &ldquo;*&rdquo;, all cluster-scoped resource types are included.
The default value is empty, which means only related cluster-scoped resources are included.</p>
The default value is empty, which means only related cluster-scoped resources are included.
Cannot work with IncludedResources, ExcludedResources and IncludeClusterResources.</p>
</td>
</tr>
<tr>
Expand All @@ -1093,7 +970,8 @@ <h3 id="backup.kurator.dev/v1alpha1.ResourceFilter">ResourceFilter
<td>
<em>(Optional)</em>
<p>ExcludedClusterScopedResources is a slice of cluster-scoped resource type names to exclude from the backup.
If set to &ldquo;*&rdquo;, all cluster-scoped resource types are excluded. The default value is empty.</p>
If set to &ldquo;*&rdquo;, all cluster-scoped resource types are excluded. The default value is empty.
Cannot work with IncludedResources, ExcludedResources and IncludeClusterResources.</p>
</td>
</tr>
<tr>
Expand All @@ -1106,7 +984,9 @@ <h3 id="backup.kurator.dev/v1alpha1.ResourceFilter">ResourceFilter
<td>
<em>(Optional)</em>
<p>IncludedNamespaceScopedResources is a slice of namespace-scoped resource type names to include in the backup.
The default value is &ldquo;*&rdquo;.</p>
For example, we can populate this string array with &ldquo;deployments&rdquo; and &ldquo;configmaps&rdquo;, then we will select all resources of type deployments and configmaps,
The default value is &ldquo;*&rdquo;.
Cannot work with IncludedResources, ExcludedResources and IncludeClusterResources.</p>
</td>
</tr>
<tr>
Expand All @@ -1119,7 +999,8 @@ <h3 id="backup.kurator.dev/v1alpha1.ResourceFilter">ResourceFilter
<td>
<em>(Optional)</em>
<p>ExcludedNamespaceScopedResources is a slice of namespace-scoped resource type names to exclude from the backup.
If set to &ldquo;*&rdquo;, all namespace-scoped resource types are excluded. The default value is empty.</p>
If set to &ldquo;*&rdquo;, all namespace-scoped resource types are excluded. The default value is empty.
Cannot work with IncludedResources, ExcludedResources and IncludeClusterResources.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1153,18 +1034,6 @@ <h3 id="backup.kurator.dev/v1alpha1.ResourceFilter">ResourceFilter
LabelSelector as well as OrLabelSelectors cannot co-exist in backup request, only one of them can be used.</p>
</td>
</tr>
<tr>
<td>
<code>includeClusterResources</code><br>
<em>
bool
</em>
</td>
<td>
<em>(Optional)</em>
<p>IncludeClusterResources specifies whether cluster-scoped resources should be included for consideration in the backup.</p>
</td>
</tr>
</tbody>
</table>
</div>
Expand Down

0 comments on commit 26ac2fc

Please sign in to comment.