Skip to content

Commit d28bfbf

Browse files
apurvabhide17apurvabhide17
committed
OADP-6290: Created seperate modules from the OADP API assembly
1 parent ff7d000 commit d28bfbf

12 files changed

+377
-237
lines changed

‎backup_and_restore/application_backup_and_restore/oadp-api.adoc

Lines changed: 27 additions & 229 deletions
Original file line numberDiff line numberDiff line change
@@ -9,246 +9,44 @@ include::_attributes/common-attributes.adoc[]
99

1010
toc::[]
1111

12-
The document provides information about the following APIs that you can use with OADP:
12+
You can use the following APIs with {oadp-short}:
1313

14-
* Velero API
15-
* OADP API
14+
Velero API::
15+
Velero API documentation is maintained by Velero, and not by Red{nbsp}Hat. For more information, see link:https://velero.io/docs/main/api-types/[Velero API types].
1616

17-
[id="velero-api"]
18-
== Velero API
17+
OADP API::
1918

20-
Velero API documentation is maintained by Velero, not by Red Hat. It can be found at link:https://velero.io/docs/main/api-types/[Velero API types].
19+
The following are the {oadp-short} APIs:
2120

22-
[id="oadp-api-tables"]
23-
== OADP API
21+
* `DataProtectionApplicationSpec`
22+
* `BackupLocation`
23+
* `SnapshotLocation`
24+
* `ApplicationConfig`
25+
* `VeleroConfig`
26+
* `CustomPlugin`
27+
* `ResticConfig`
28+
* `PodConfig`
29+
* `Features`
30+
* `DataMover`
31+
+
32+
For more information, see in link:https://pkg.go.dev/github.com/openshift/oadp-operator[OADP Operator].
2433
25-
The following tables provide the structure of the OADP API:
34+
include::modules/dataprotectionapplicationspec-type.adoc[leveloffset=+1]
2635

27-
.DataProtectionApplicationSpec
28-
[options="header"]
29-
|===
30-
|Property|Type|Description
36+
include::modules/backuplocation-type.adoc[leveloffset=+1]
3137

32-
|`backupLocations`
33-
|[] link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#BackupLocation[`BackupLocation`]
34-
|Defines the list of configurations to use for `BackupStorageLocations`.
38+
include::modules/snapshotlocation-type.adoc[leveloffset=+1]
3539

36-
|`snapshotLocations`
37-
|[] link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#SnapshotLocation[`SnapshotLocation`]
38-
|Defines the list of configurations to use for `VolumeSnapshotLocations`.
40+
include::modules/applicationconfig-type.adoc[leveloffset=+1]
3941

40-
|`unsupportedOverrides`
41-
|map [ link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#UnsupportedImageKey[UnsupportedImageKey] ] link:https://pkg.go.dev/builtin#string[string]
42-
|Can be used to override the deployed dependent images for development. Options are `veleroImageFqin`, `awsPluginImageFqin`, `openshiftPluginImageFqin`, `azurePluginImageFqin`, `gcpPluginImageFqin`, `csiPluginImageFqin`, `dataMoverImageFqin`, `resticRestoreImageFqin`, `kubevirtPluginImageFqin`, and `operator-type`.
42+
include::modules/customplugin-type.adoc[leveloffset=+1]
4343

44-
|`podAnnotations`
45-
|map [ link:https://pkg.go.dev/builtin#string[string] ] link:https://pkg.go.dev/builtin#string[string]
46-
|Used to add annotations to pods deployed by Operators.
44+
include::modules/resticconfig-type.adoc[leveloffset=+1]
4745

48-
|`podDnsPolicy`
49-
|link:https://pkg.go.dev/k8s.io/api/core/v1#DNSPolicy[`DNSPolicy`]
50-
|Defines the configuration of the DNS of a pod.
46+
include::modules/podconfig-type.adoc[leveloffset=+1]
5147

52-
|`podDnsConfig`
53-
|link:https://pkg.go.dev/k8s.io/api/core/v1#PodDNSConfig[`PodDNSConfig`]
54-
|Defines the DNS parameters of a pod in addition to those generated from `DNSPolicy`.
48+
include::modules/oadp-configuring-node-agents.adoc[leveloffset=+1]
5549

56-
|`backupImages`
57-
|*link:https://pkg.go.dev/builtin#bool[bool]
58-
|Used to specify whether or not you want to deploy a registry for enabling backup and restore of images.
59-
60-
|`configuration`
61-
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ApplicationConfig[`ApplicationConfig`]
62-
|Used to define the data protection application's server configuration.
63-
64-
|`features`
65-
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#Features[`Features`]
66-
|Defines the configuration for the DPA to enable the Technology Preview features.
67-
|===
68-
69-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#DataProtectionApplicationSpec[Complete schema definitions for the OADP API].
70-
71-
.BackupLocation
72-
[options="header"]
73-
|===
74-
|Property|Type|Description
75-
76-
|`velero`
77-
|*link:https://pkg.go.dev/github.com/vmware-tanzu/velero/pkg/apis/velero/v1#BackupStorageLocationSpec[velero.BackupStorageLocationSpec]
78-
|Location to store volume snapshots, as described in link:https://pkg.go.dev/github.com/vmware-tanzu/velero/pkg/apis/velero/v1#BackupStorageLocation[Backup Storage Location].
79-
80-
|`bucket`
81-
| *link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#CloudStorageLocation[CloudStorageLocation]
82-
| [Technology Preview] Automates creation of a bucket at some cloud storage providers for use as a backup storage location.
83-
|===
84-
85-
:FeatureName: The `bucket` parameter
86-
include::snippets/technology-preview.adoc[leveloffset=+1]
87-
88-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#BackupLocation[Complete schema definitions for the type `BackupLocation`].
89-
90-
.SnapshotLocation
91-
[options="header"]
92-
|===
93-
|Property|Type|Description
94-
95-
|`velero`
96-
|*link:https://pkg.go.dev/github.com/vmware-tanzu/velero/pkg/apis/velero/v1#VolumeSnapshotLocationSpec[VolumeSnapshotLocationSpec]
97-
|Location to store volume snapshots, as described in link:https://pkg.go.dev/github.com/vmware-tanzu/velero/pkg/apis/velero/v1#VolumeSnapshotLocation[Volume Snapshot Location].
98-
|===
99-
100-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#SnapshotLocation[Complete schema definitions for the type `SnapshotLocation`].
101-
102-
.ApplicationConfig
103-
[options="header"]
104-
|===
105-
|Property|Type|Description
106-
107-
|`velero`
108-
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#VeleroConfig[VeleroConfig]
109-
|Defines the configuration for the Velero server.
110-
111-
|`restic`
112-
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ResticConfig[ResticConfig]
113-
|Defines the configuration for the Restic server.
114-
|===
115-
116-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ApplicationConfig[Complete schema definitions for the type `ApplicationConfig`].
117-
118-
.VeleroConfig
119-
[options="header"]
120-
|===
121-
|Property|Type|Description
122-
123-
|`featureFlags`
124-
|[] link:https://pkg.go.dev/builtin#string[string]
125-
|Defines the list of features to enable for the Velero instance.
126-
127-
|`defaultPlugins`
128-
|[] link:https://pkg.go.dev/builtin#string[string]
129-
|The following types of default Velero plugins can be installed: `aws`,`azure`, `csi`, `gcp`, `kubevirt`, and `openshift`.
130-
131-
|`customPlugins`
132-
|[]link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#CustomPlugin[CustomPlugin]
133-
|Used for installation of custom Velero plugins.
134-
135-
Default and custom plugins are described in xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins#oadp-features-plugins[OADP plugins]
136-
137-
|`restoreResourcesVersionPriority`
138-
|link:https://pkg.go.dev/builtin#string[string]
139-
|Represents a config map that is created if defined for use in conjunction with the `EnableAPIGroupVersions` feature flag. Defining this field automatically adds `EnableAPIGroupVersions` to the Velero server feature flag.
140-
141-
|`noDefaultBackupLocation`
142-
|link:https://pkg.go.dev/builtin#bool[bool]
143-
|To install Velero without a default backup storage location, you must set the `noDefaultBackupLocation` flag in order to confirm installation.
144-
145-
|`podConfig`
146-
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#PodConfig[`PodConfig`]
147-
|Defines the configuration of the `Velero` pod.
148-
149-
|`logLevel`
150-
|link:https://pkg.go.dev/builtin#string[string]
151-
|Velero server’s log level (use `debug` for the most granular logging, leave unset for Velero default). Valid options are `trace`, `debug`, `info`, `warning`, `error`, `fatal`, and `panic`.
152-
|===
153-
154-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#VeleroConfig[Complete schema definitions for the type `VeleroConfig`].
155-
156-
.CustomPlugin
157-
[options="header"]
158-
|===
159-
|Property|Type|Description
160-
161-
|`name`
162-
|link:https://pkg.go.dev/builtin#string[string]
163-
|Name of custom plugin.
164-
165-
|`image`
166-
|link:https://pkg.go.dev/builtin#string[string]
167-
|Image of custom plugin.
168-
|===
169-
170-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#CustomPlugin[Complete schema definitions for the type `CustomPlugin`].
171-
172-
.ResticConfig
173-
[options="header"]
174-
|===
175-
|Property|Type|Description
176-
177-
|`enable`
178-
|*link:https://pkg.go.dev/builtin#bool[bool]
179-
|If set to `true`, enables backup and restore using Restic. If set to `false`, snapshots are needed.
180-
181-
|`supplementalGroups`
182-
|[]link:https://pkg.go.dev/builtin#int64[int64]
183-
|Defines the Linux groups to be applied to the `Restic` pod.
184-
185-
|`timeout`
186-
|link:https://pkg.go.dev/builtin#string[string]
187-
|A user-supplied duration string that defines the Restic timeout. Default value is `1hr` (1 hour). A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, -1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, and `h`.
188-
189-
|`podConfig`
190-
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#PodConfig[`PodConfig`]
191-
|Defines the configuration of the `Restic` pod.
192-
|===
193-
194-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ResticConfig[Complete schema definitions for the type `ResticConfig`].
195-
196-
.PodConfig
197-
[options="header"]
198-
|===
199-
|Property|Type|Description
200-
201-
|`nodeSelector`
202-
|map [ link:https://pkg.go.dev/builtin#string[string] ] link:https://pkg.go.dev/builtin#string[string]
203-
|Defines the `nodeSelector` to be supplied to a `Velero` `podSpec` or a `Restic` `podSpec`.
204-
For more details, see xref:../../backup_and_restore/application_backup_and_restore/oadp-api.adoc#oadp-configuring-node-agents_oadp-api[Configuring node agents and node labels].
205-
206-
|`tolerations`
207-
|[]link:https://pkg.go.dev/k8s.io/api/core/v1#Toleration[Toleration]
208-
|Defines the list of tolerations to be applied to a Velero deployment or a Restic `daemonset`.
209-
210-
|`resourceAllocations`
211-
|link:https://pkg.go.dev/k8s.io/api/core/v1#ResourceRequirements[ResourceRequirements]
212-
|Set specific resource `limits` and `requests` for a `Velero` pod or a `Restic` pod as described in xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#oadp-setting-resource-limits-and-requests_installing-oadp-aws[Setting Velero CPU and memory resource allocations].
213-
214-
|`labels`
215-
|map [ link:https://pkg.go.dev/builtin#string[string] ] link:https://pkg.go.dev/builtin#string[string]
216-
|Labels to add to pods.
217-
|===
218-
219-
include::modules/oadp-configuring-node-agents.adoc[leveloffset=+2]
220-
221-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#PodConfig[Complete schema definitions for the type `PodConfig`].
222-
223-
.Features
224-
[options="header"]
225-
|===
226-
|Property|Type|Description
227-
228-
|`dataMover`
229-
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#DataMover[`DataMover`]
230-
|Defines the configuration of the Data Mover.
231-
|===
232-
233-
link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#Features[Complete schema definitions for the type `Features`].
234-
235-
.DataMover
236-
[options="header"]
237-
|===
238-
|Property|Type|Description
239-
240-
|`enable`
241-
|link:https://pkg.go.dev/builtin#bool[bool]
242-
|If set to `true`, deploys the volume snapshot mover controller and a modified CSI Data Mover plugin. If set to `false`, these are not deployed.
243-
244-
|`credentialName`
245-
|link:https://pkg.go.dev/builtin#string[string]
246-
|User-supplied Restic `Secret` name for Data Mover.
247-
248-
|`timeout`
249-
|link:https://pkg.go.dev/builtin#string[string]
250-
|A user-supplied duration string for `VolumeSnapshotBackup` and `VolumeSnapshotRestore` to complete. Default is `10m` (10 minutes). A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, -1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, and `h`.
251-
|===
252-
253-
The OADP API is more fully detailed in link:https://pkg.go.dev/github.com/openshift/oadp-operator[OADP Operator].
50+
include::modules/features-type.adoc[leveloffset=+1]
25451

52+
include::modules/datamover-type.adoc[leveloffset=+1]

‎modules/applicationconfig-type.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Module included in the following assemblies:
2+
//
3+
// backup_and_restore/application_backup_and_restore/oadp-api.adoc
4+
:_mod-docs-content-type: REFERENCE
5+
6+
[id="applicationconfig-type_{context}"]
7+
= ApplicationConfig type
8+
9+
The following are `ApplicationConfig` {oadp-short} APIs:
10+
11+
.ApplicationConfig
12+
[options="header"]
13+
|===
14+
|Property|Type|Description
15+
16+
|`velero`
17+
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#VeleroConfig[VeleroConfig]
18+
|Defines the configuration for the Velero server.
19+
20+
|`restic`
21+
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ResticConfig[ResticConfig]
22+
|Defines the configuration for the Restic server.
23+
|===
24+
25+
26+
[role="_additional-resources"]
27+
.Additional resources
28+
* link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ApplicationConfig[Complete schema definitions for the type `ApplicationConfig`]

‎modules/backuplocation-type.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// backup_and_restore/application_backup_and_restore/oadp-api.adoc
4+
:_mod-docs-content-type: REFERENCE
5+
6+
[id="backuplocation-type_{context}"]
7+
= BackupLocation type
8+
9+
The following are `BackupLocation` {oadp-short} APIs:
10+
11+
.BackupLocation
12+
[options="header"]
13+
|===
14+
|Property|Type|Description
15+
16+
|`velero`
17+
|*link:https://pkg.go.dev/github.com/vmware-tanzu/velero/pkg/apis/velero/v1#BackupStorageLocationSpec[velero.BackupStorageLocationSpec]
18+
|Location to store volume snapshots, as described in link:https://pkg.go.dev/github.com/vmware-tanzu/velero/pkg/apis/velero/v1#BackupStorageLocation[Backup Storage Location].
19+
20+
|`bucket`
21+
| *link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#CloudStorageLocation[CloudStorageLocation]
22+
| [Technology Preview] Automates creation of a bucket at some cloud storage providers for use as a backup storage location.
23+
|===
24+
25+
:FeatureName: The `bucket` parameter
26+
include::snippets/technology-preview.adoc[leveloffset=+1]
27+
28+
29+
[role="_additional-resources"]
30+
.Additional resources
31+
* link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#BackupLocation[Complete schema definitions for the type `BackupLocation`]

‎modules/customplugin-type.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// backup_and_restore/application_backup_and_restore/oadp-api.adoc
4+
:_mod-docs-content-type: REFERENCE
5+
6+
[id="customplugin-type_{context}"]
7+
= CustomPlugin type
8+
9+
The following are `CustomPlugin` {oadp-short} APIs:
10+
11+
.CustomPlugin
12+
[options="header"]
13+
|===
14+
|Property|Type|Description
15+
16+
|`name`
17+
|link:https://pkg.go.dev/builtin#string[string]
18+
|Name of custom plugin.
19+
20+
|`image`
21+
|link:https://pkg.go.dev/builtin#string[string]
22+
|Image of custom plugin.
23+
|===
24+
25+
[role="_additional-resources"]
26+
.Additional resources
27+
* link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#CustomPlugin[Complete schema definitions for the type `CustomPlugin`]

‎modules/datamover-type.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// backup_and_restore/application_backup_and_restore/oadp-api.adoc
4+
:_mod-docs-content-type: REFERENCE
5+
6+
[id="datamover-type_{context}"]
7+
= DataMover type
8+
9+
The following are `DataMover` {oadp-short} APIs:
10+
11+
.DataMover
12+
[options="header"]
13+
|===
14+
|Property|Type|Description
15+
16+
|`enable`
17+
|link:https://pkg.go.dev/builtin#bool[bool]
18+
|If set to `true`, deploys the volume snapshot mover controller and a modified CSI Data Mover plugin. If set to `false`, these are not deployed.
19+
20+
|`credentialName`
21+
|link:https://pkg.go.dev/builtin#string[string]
22+
|User-supplied Restic `Secret` name for Data Mover.
23+
24+
|`timeout`
25+
|link:https://pkg.go.dev/builtin#string[string]
26+
|A user-supplied duration string for `VolumeSnapshotBackup` and `VolumeSnapshotRestore` to complete. Default is `10m` (10 minutes). A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, -1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, and `h`.
27+
|===

0 commit comments

Comments
 (0)