diff --git a/backup_and_restore/application_backup_and_restore/oadp-api.adoc b/backup_and_restore/application_backup_and_restore/oadp-api.adoc index ecb5bbfca993..7836f91e6e18 100644 --- a/backup_and_restore/application_backup_and_restore/oadp-api.adoc +++ b/backup_and_restore/application_backup_and_restore/oadp-api.adoc @@ -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:: @@ -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] diff --git a/modules/applicationconfig-type.adoc b/modules/applicationconfig-type.adoc index 6b4777bd0375..c90bde67d67f 100644 --- a/modules/applicationconfig-type.adoc +++ b/modules/applicationconfig-type.adoc @@ -6,6 +6,7 @@ [id="applicationconfig-type_{context}"] = ApplicationConfig type +[role="_abstract"] The following are `ApplicationConfig` {oadp-short} APIs: .ApplicationConfig diff --git a/modules/backuplocation-type.adoc b/modules/backuplocation-type.adoc index a0b6ecf30a9d..edf0f67bf098 100644 --- a/modules/backuplocation-type.adoc +++ b/modules/backuplocation-type.adoc @@ -6,6 +6,7 @@ [id="backuplocation-type_{context}"] = BackupLocation type +[role="_abstract"] The following are `BackupLocation` {oadp-short} APIs: .BackupLocation diff --git a/modules/customplugin-type.adoc b/modules/customplugin-type.adoc index 46bfe42f7b7c..f279e010a0f9 100644 --- a/modules/customplugin-type.adoc +++ b/modules/customplugin-type.adoc @@ -6,6 +6,7 @@ [id="customplugin-type_{context}"] = CustomPlugin type +[role="_abstract"] The following are `CustomPlugin` {oadp-short} APIs: .CustomPlugin diff --git a/modules/datamover-type.adoc b/modules/datamover-type.adoc index 77bade9f70bf..71228eacf9e2 100644 --- a/modules/datamover-type.adoc +++ b/modules/datamover-type.adoc @@ -6,6 +6,7 @@ [id="datamover-type_{context}"] = DataMover type +[role="_abstract"] The following are `DataMover` {oadp-short} APIs: .DataMover diff --git a/modules/dataprotectionapplicationspec-type.adoc b/modules/dataprotectionapplicationspec-type.adoc index bce2c7b301e8..e639d67026b0 100644 --- a/modules/dataprotectionapplicationspec-type.adoc +++ b/modules/dataprotectionapplicationspec-type.adoc @@ -6,6 +6,7 @@ [id="dataprotectionapplicationspec-type_{context}"] = DataProtectionApplicationSpec type +[role="_abstract"] The following are `DataProtectionApplicationSpec` {oadp-short} APIs: .DataProtectionApplicationSpec diff --git a/modules/features-type.adoc b/modules/features-type.adoc index 8bccd5806d03..b0999be33712 100644 --- a/modules/features-type.adoc +++ b/modules/features-type.adoc @@ -6,6 +6,7 @@ [id="features-type_{context}"] = Features type +[role="_abstract"] The following are `Features` {oadp-short} APIs: .Features diff --git a/modules/podconfig-type.adoc b/modules/podconfig-type.adoc index a9ea6bd75390..9e99f6c94c93 100644 --- a/modules/podconfig-type.adoc +++ b/modules/podconfig-type.adoc @@ -6,6 +6,7 @@ [id="podconfig-type_{context}"] = PodConfig type +[role="_abstract"] The following are `PodConfig` {oadp-short} APIs: .PodConfig diff --git a/modules/resticconfig-type.adoc b/modules/resticconfig-type.adoc index 9e12fcb92fb3..d58677490bf2 100644 --- a/modules/resticconfig-type.adoc +++ b/modules/resticconfig-type.adoc @@ -6,6 +6,7 @@ [id="resticconfig-type_{context}"] = ResticConfig type +[role="_abstract"] The following are `ResticConfig` {oadp-short} APIs: .ResticConfig diff --git a/modules/snapshotlocation-type.adoc b/modules/snapshotlocation-type.adoc index 9560abf75702..2ecce67f8a48 100644 --- a/modules/snapshotlocation-type.adoc +++ b/modules/snapshotlocation-type.adoc @@ -6,6 +6,7 @@ [id="snapshotlocation-type_{context}"] = SnapshotLocation type +[role="_abstract"] The following are `SnapshotLocation` {oadp-short} APIs: .SnapshotLocation diff --git a/modules/veleroconfig-type.adoc b/modules/veleroconfig-type.adoc index 0792a40a093e..5fff0677f07f 100644 --- a/modules/veleroconfig-type.adoc +++ b/modules/veleroconfig-type.adoc @@ -6,6 +6,7 @@ [id="veleroconfig-type_{context}"] = VeleroConfig type +[role="_abstract"] The following are `VeleroConfig` {oadp-short} APIs: .VeleroConfig @@ -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.