Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 6 additions & 5 deletions backup_and_restore/application_backup_and_restore/oadp-api.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
:_mod-docs-content-type: ASSEMBLY
[id="oadp-api"]
= APIs used with OADP
:toc:

include::_attributes/common-attributes.adoc[]
:context: oadp-api
:namespace: openshift-adp
:local-product: OADP
:velero-domain: velero.io

toc::[]


[role="_abstract"]
You can use the following APIs with {oadp-short}:

Velero API::
Expand Down Expand Up @@ -49,11 +52,9 @@ include::modules/podconfig-type.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../../backup_and_restore/application_backup_and_restore/oadp-api.adoc#oadp-configuring-node-agents_oadp-api[Configuring node agents and node labels]
* 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]
* link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#PodConfig[Complete schema definitions for the type `PodConfig`](Go documentation)

include::modules/oadp-configuring-node-agents.adoc[leveloffset=+1]
* xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins#oadp-features-plugins[OADP plugins]
* link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#PodConfig[Complete schema definitions for the type `PodConfig`](Go documentation)

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

Expand Down
1 change: 1 addition & 0 deletions modules/applicationconfig-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="applicationconfig-type_{context}"]
= ApplicationConfig type

[role="_abstract"]
The following are `ApplicationConfig` {oadp-short} APIs:

.ApplicationConfig
Expand Down
1 change: 1 addition & 0 deletions modules/backuplocation-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="backuplocation-type_{context}"]
= BackupLocation type

[role="_abstract"]
The following are `BackupLocation` {oadp-short} APIs:

.BackupLocation
Expand Down
1 change: 1 addition & 0 deletions modules/customplugin-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="customplugin-type_{context}"]
= CustomPlugin type

[role="_abstract"]
The following are `CustomPlugin` {oadp-short} APIs:

.CustomPlugin
Expand Down
1 change: 1 addition & 0 deletions modules/datamover-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="datamover-type_{context}"]
= DataMover type

[role="_abstract"]
The following are `DataMover` {oadp-short} APIs:

.DataMover
Expand Down
1 change: 1 addition & 0 deletions modules/dataprotectionapplicationspec-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="dataprotectionapplicationspec-type_{context}"]
= DataProtectionApplicationSpec type

[role="_abstract"]
The following are `DataProtectionApplicationSpec` {oadp-short} APIs:

.DataProtectionApplicationSpec
Expand Down
1 change: 1 addition & 0 deletions modules/features-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="features-type_{context}"]
= Features type

[role="_abstract"]
The following are `Features` {oadp-short} APIs:

.Features
Expand Down
1 change: 1 addition & 0 deletions modules/podconfig-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="podconfig-type_{context}"]
= PodConfig type

[role="_abstract"]
The following are `PodConfig` {oadp-short} APIs:

.PodConfig
Expand Down
1 change: 1 addition & 0 deletions modules/resticconfig-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="resticconfig-type_{context}"]
= ResticConfig type

[role="_abstract"]
The following are `ResticConfig` {oadp-short} APIs:

.ResticConfig
Expand Down
1 change: 1 addition & 0 deletions modules/snapshotlocation-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="snapshotlocation-type_{context}"]
= SnapshotLocation type

[role="_abstract"]
The following are `SnapshotLocation` {oadp-short} APIs:

.SnapshotLocation
Expand Down
3 changes: 1 addition & 2 deletions modules/veleroconfig-type.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="veleroconfig-type_{context}"]
= VeleroConfig type

[role="_abstract"]
The following are `VeleroConfig` {oadp-short} APIs:

.VeleroConfig
Expand All @@ -25,8 +26,6 @@ The following are `VeleroConfig` {oadp-short} APIs:
|[]link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#CustomPlugin[CustomPlugin]
|Used for installation of custom Velero plugins.

Default and custom plugins are described in xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins#oadp-features-plugins[OADP plugins]

|`restoreResourcesVersionPriority`
|link:https://pkg.go.dev/builtin#string[string]
|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.
Expand Down