Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fleet: init backup plugin api #378

Merged
merged 7 commits into from
Sep 7, 2023
Merged

fleet: init backup plugin api #378

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8b6a06d
fleet: init backup plugin api
Xieql Aug 31, 2023
112e907
fleet: update velero plugin api
Xieql Sep 4, 2023
ceeb5a7
fleet: update with review
Xieql Sep 4, 2023
3d51dbe
update
Xieql Sep 5, 2023
ad7db96
update
Xieql Sep 5, 2023
baaa9d8
update
Xieql Sep 6, 2023
d11c6a7
update
Xieql Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
262 changes: 262 additions & 0 deletions docs/content/en/references/fleet_v1alpha1_types.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,259 @@ <h3 id="fleet.kurator.dev/v1alpha1.Fleet">Fleet
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.BackupConfig">BackupConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.PluginConfig">PluginConfig</a>)
</p>
<p>BackupConfig defines the configuration for the Velero backup engine.</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>chart</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.ChartConfig">
ChartConfig
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>Chart defines the helm chart config of the velero.
default values is</p>
<p>chart:
repository: <a href="https://vmware-tanzu.github.io/helm-charts">https://vmware-tanzu.github.io/helm-charts</a>
name: velero
version: 5.0.2</p>
</td>
</tr>
<tr>
<td>
<code>storage</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.BackupStorage">
BackupStorage
</a>
</em>
</td>
<td>
<p>Storage details where the backup data should be stored.</p>
</td>
</tr>
<tr>
<td>
<code>veleroImage</code><br>
<em>
<a href="https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1?tab=doc#JSON">
Kubernetes /apiextensions/v1.JSON
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>VeleroImage Details of the container image to use in the Velero deployment &amp; daemonset
default values is</p>
<p>repository: velero/velero
tag: v1.11.1
pullPolicy: IfNotPresent</p>
</td>
</tr>
<tr>
<td>
<code>initContainers</code><br>
<em>
<a href="https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1?tab=doc#JSON">
Kubernetes /apiextensions/v1.JSON
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>InitContainers to add to the Velero deployment&rsquo;s pod spec.
default values is</p>
<ul>
<li>name: velero-plugin-for-aws
image: velero/velero-plugin-for-aws:v1.7.1
imagePullPolicy: IfNotPresent
volumeMounts:
<ul>
<li>mountPath: /target
name: plugins</li>
</ul></li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.BackupCredentials">BackupCredentials
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.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>accessKeyID</code><br>
<em>
string
</em>
</td>
<td>
<p>AccessKeyID is the identifier for the access key.</p>
</td>
</tr>
<tr>
<td>
<code>secretAccessKey</code><br>
<em>
string
</em>
</td>
<td>
<p>SecretAccessKey is the secret access key associated with AccessKeyID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.BackupStorage">BackupStorage
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.BackupConfig">BackupConfig</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="#fleet.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>
<a href="#fleet.kurator.dev/v1alpha1.BackupCredentials">
BackupCredentials
</a>
</em>
</td>
<td>
<p>Credentials to access the backup storage location.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="fleet.kurator.dev/v1alpha1.BackupStorageLocation">BackupStorageLocation
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.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="fleet.kurator.dev/v1alpha1.ChartConfig">ChartConfig
</h3>
<p>
(<em>Appears on:</em>
<a href="#fleet.kurator.dev/v1alpha1.BackupConfig">BackupConfig</a>,
<a href="#fleet.kurator.dev/v1alpha1.GrafanaConfig">GrafanaConfig</a>,
<a href="#fleet.kurator.dev/v1alpha1.KyvernoConfig">KyvernoConfig</a>,
<a href="#fleet.kurator.dev/v1alpha1.PrometheusConfig">PrometheusConfig</a>,
Expand Down Expand Up @@ -594,6 +843,19 @@ <h3 id="fleet.kurator.dev/v1alpha1.PluginConfig">PluginConfig
<p>Policy defines the configuration for the ploicy management.</p>
</td>
</tr>
<tr>
<td>
<code>backup</code><br>
<em>
<a href="#fleet.kurator.dev/v1alpha1.BackupConfig">
BackupConfig
</a>
</em>
</td>
<td>
<p>Backup defines the configuration for the backup engine(Velero).</p>
</td>
</tr>
</tbody>
</table>
</div>
Expand Down
84 changes: 84 additions & 0 deletions manifests/charts/fleet-manager/crds/fleet.kurator.dev_fleet.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,90 @@ spec:
description: Plugin defines the plugins that would be installed in
the fleet.
properties:
backup:
description: Backup defines the configuration for the backup engine(Velero).
properties:
chart:
description: "Chart defines the helm chart config of the velero.
default values is \n chart: repository: https://vmware-tanzu.github.io/helm-charts
name: velero version: 5.0.2"
properties:
name:
description: Name defines the name of the chart. Default
value depends on the kind of the component.
type: string
repository:
description: Repository defines the repository of chart.
Default value depends on the kind of the component.
type: string
version:
description: Version defines the version of the chart.
Default value depends on the kind of the component.
type: string
type: object
initContainers:
description: "InitContainers to add to the Velero deployment's
pod spec. default values is \n - name: velero-plugin-for-aws
image: velero/velero-plugin-for-aws:v1.7.1 imagePullPolicy:
IfNotPresent volumeMounts: - mountPath: /target name: plugins"
x-kubernetes-preserve-unknown-fields: true
storage:
description: Storage details where the backup data should
be stored.
properties:
credentials:
description: Credentials to access the backup storage
location.
properties:
accessKeyID:
description: AccessKeyID is the identifier for the
access key.
type: string
secretAccessKey:
description: SecretAccessKey is the secret access
key associated with AccessKeyID
type: string
required:
- accessKeyID
- secretAccessKey
type: object
location:
description: Location specifies the location where the
backup data will be stored.
properties:
bucket:
description: Bucket specifies the storage bucket name.
type: string
provider:
description: Provider specifies the storage provider
type (e.g., aws).
type: string
region:
description: Region specifies the region of the storage.
type: string
s3Url:
description: S3Url provides the endpoint URL for S3-compatible
storage.
type: string
required:
- bucket
- provider
- region
- s3Url
type: object
required:
- credentials
- location
type: object
veleroImage:
description: "VeleroImage Details of the container image to
use in the Velero deployment & daemonset default values
is \n repository: velero/velero tag: v1.11.1 pullPolicy:
IfNotPresent"
x-kubernetes-preserve-unknown-fields: true
required:
- storage
type: object
grafana:
description: Grafana defines the configuration for the grafana
installation and observation.
Expand Down
Loading
Loading