Skip to content

Commit b5a4cf1

Browse files
committed
OADP-2380: updating velero table and some tidying up
1 parent a725b8e commit b5a4cf1

10 files changed

+70
-34
lines changed

_topic_maps/_topic_map.yml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2740,16 +2740,21 @@ Topics:
27402740
Topics:
27412741
- Name: About installing OADP
27422742
File: about-installing-oadp
2743-
- Name: Installing and configuring OADP with AWS
2743+
- Name: Installing the OADP Operator
2744+
File: oadp-installing-operator
2745+
- Name: Configuring OADP with AWS
27442746
File: installing-oadp-aws
2745-
- Name: Installing and configuring OADP with Azure
2747+
- Name: Configuring OADP with Azure
27462748
File: installing-oadp-azure
2747-
- Name: Installing and configuring OADP with GCP
2749+
- Name: Configuring OADP with GCP
27482750
File: installing-oadp-gcp
2749-
- Name: Installing and configuring OADP with MCG
2751+
- Name: Configuring OADP with MCG
27502752
File: installing-oadp-mcg
2751-
- Name: Installing and configuring OADP with ODF
2753+
- Name: Configuring OADP with ODF
27522754
File: installing-oadp-ocs
2755+
- Name: Uninstalling OADP
2756+
Dir: installing
2757+
Topics:
27532758
- Name: Uninstalling OADP
27542759
File: uninstalling-oadp
27552760
- Name: OADP backing up

backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="installing-oadp-aws"]
3-
= Installing and configuring the OpenShift API for Data Protection with Amazon Web Services
3+
= Configuring the OpenShift API for Data Protection with Amazon Web Services
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-oadp-aws
66
:installing-oadp-aws:
@@ -13,11 +13,11 @@ You install the OpenShift API for Data Protection (OADP) with Amazon Web Service
1313

1414
include::snippets/oadp-mtc-operator.adoc[]
1515

16-
You configure AWS for Velero, create a default `Secret`, and then install the Data Protection Application.
16+
You configure AWS for Velero, create a default `Secret`, and then install the Data Protection Application. For more details, see xref:../../..//backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the OADP Operator].
1717

1818
To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
1919

20-
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
20+
//include::modules/oadp-installing-operator.adoc[leveloffset=+1]
2121
include::modules/migration-configuring-aws-s3.adoc[leveloffset=+1]
2222
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
2323
include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]

backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="installing-oadp-azure"]
3-
= Installing and configuring the OpenShift API for Data Protection with Microsoft Azure
3+
= Configuring the OpenShift API for Data Protection with Microsoft Azure
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-oadp-azure
66
:installing-oadp-azure:
@@ -13,11 +13,11 @@ You install the OpenShift API for Data Protection (OADP) with Microsoft Azure by
1313

1414
include::snippets/oadp-mtc-operator.adoc[]
1515

16-
You configure Azure for Velero, create a default `Secret`, and then install the Data Protection Application.
16+
You configure Azure for Velero, create a default `Secret`, and then install the Data Protection Application. For more details, see xref:../../..//backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the OADP Operator].
1717

1818
To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
1919

20-
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
20+
// include::modules/oadp-installing-operator.adoc[leveloffset=+1]
2121
include::modules/migration-configuring-azure.adoc[leveloffset=+1]
2222
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
2323
include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]

backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="installing-oadp-gcp"]
3-
= Installing and configuring the OpenShift API for Data Protection with Google Cloud Platform
3+
= Configuring the OpenShift API for Data Protection with Google Cloud Platform
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-oadp-gcp
66
:installing-oadp-gcp:
@@ -13,11 +13,11 @@ You install the OpenShift API for Data Protection (OADP) with Google Cloud Platf
1313

1414
include::snippets/oadp-mtc-operator.adoc[]
1515

16-
You configure GCP for Velero, create a default `Secret`, and then install the Data Protection Application.
16+
You configure GCP for Velero, create a default `Secret`, and then install the Data Protection Application. For more details, see xref:../../..//backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the OADP Operator].
1717

1818
To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
1919

20-
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
20+
//include::modules/oadp-installing-operator.adoc[leveloffset=+1]
2121
include::modules/migration-configuring-gcp.adoc[leveloffset=+1]
2222
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
2323
include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]

backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="installing-oadp-mcg"]
3-
= Installing and configuring the OpenShift API for Data Protection with Multicloud Object Gateway
3+
= Configuring the OpenShift API for Data Protection with Multicloud Object Gateway
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-oadp-mcg
66
:installing-oadp-mcg:
@@ -19,11 +19,11 @@ MCG is a component of {rh-storage}. You configure MCG as a backup location in th
1919
:FeatureName: The `CloudStorage` API, which automates the creation of a bucket for object storage,
2020
include::snippets/technology-preview.adoc[]
2121

22-
You create a `Secret` for the backup location and then you install the Data Protection Application.
22+
You create a `Secret` for the backup location and then you install the Data Protection Application. For more details, see xref:../../..//backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the OADP Operator].
2323

2424
To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. For details, see xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
2525

26-
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
26+
//include::modules/oadp-installing-operator.adoc[leveloffset=+1]
2727
include::modules/migration-configuring-mcg.adoc[leveloffset=+1]
2828
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
2929
include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]

backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="installing-oadp-ocs"]
3-
= Installing and configuring the OpenShift API for Data Protection with OpenShift Data Foundation
3+
= Configuring the OpenShift API for Data Protection with OpenShift Data Foundation
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-oadp-ocs
66
:credentials: cloud-credentials
@@ -17,11 +17,11 @@ You can configure xref:../../../backup_and_restore/application_backup_and_restor
1717
:FeatureName: The `CloudStorage` API, which automates the creation of a bucket for object storage,
1818
include::snippets/technology-preview.adoc[]
1919

20-
You create a `Secret` for the backup location and then you install the Data Protection Application.
20+
You create a `Secret` for the backup location and then you install the Data Protection Application. For more details, see xref:../../..//backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the OADP Operator].
2121

2222
To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. For details, see xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
2323

24-
include::modules/oadp-installing-operator.adoc[leveloffset=+1]
24+
//include::modules/oadp-installing-operator.adoc[leveloffset=+1]
2525
include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
2626

2727
[role="_additional-resources"]
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_content-type: PROCEDURE
2+
[id="oadp-installing-operator-doc"]
3+
= Installing the OADP Operator
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installing-oadp-operator
6+
7+
toc::[]
8+
9+
You can install the OpenShift API for Data Protection (OADP) Operator on {product-title} {product-version} by using Operator Lifecycle Manager (OLM).
10+
11+
The OADP Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
12+
13+
.Prerequisites
14+
15+
* You must be logged in as a user with `cluster-admin` privileges.
16+
17+
.Procedure
18+
19+
. In the {product-title} web console, click *Operators* -> *OperatorHub*.
20+
. Use the *Filter by keyword* field to find the *OADP Operator*.
21+
. Select the *OADP Operator* and click *Install*.
22+
. Click *Install* to install the Operator in the `openshift-adp` project.
23+
. Click *Operators* -> *Installed Operators* to verify the installation.
24+
25+
include::modules/velero-oadp-version-relationship.adoc[leveloffset=+1]

backup_and_restore/application_backup_and_restore/troubleshooting.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ You can obtain the Velero CLI tool by:
2222
* Accessing the Velero binary in the Velero deployment in the cluster
2323
2424
include::modules/velero-obtaining-by-downloading.adoc[leveloffset=+1]
25+
include::modules/velero-oadp-version-relationship.adoc[leveloffset=+2]
2526
include::modules/velero-obtaining-by-accessing-binary.adoc[leveloffset=+1]
2627

2728
include::modules/oadp-debugging-oc-cli.adoc[leveloffset=+1]
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_content-type: CONCEPT
2+
[id="velero-oadp-version-relationship_{context}"]
3+
= OADP-Velero-{product-title} version relationship
4+
5+
[cols="3", options="header"]
6+
|===
7+
|OADP version |Velero version |{product-title} version
8+
| 1.1.0 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later
9+
| 1.1.1 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later
10+
| 1.1.2 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later
11+
| 1.1.3 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later
12+
| 1.1.4 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later
13+
| 1.1.5 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later
14+
| 1.1.6 | link:https://{velero-domain}/docs/v1.9]/[1.9.] | 4.11 and later
15+
| 1.2.0 | link:https://{velero-domain}/docs/v1.11/[1.11] | 4.11 and later
16+
| 1.2.1 | link:https://{velero-domain}/docs/v1.11/[1.11] | 4.11 and later
17+
| 1.2.2 | link:https://{velero-domain}/docs/v1.11/[1.11] | 4.11 and later
18+
|===

modules/velero-obtaining-by-downloading.adoc

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,4 @@ The page includes instructions for:
2323

2424
. Open a browser and navigate to link:https://{velero-domain}/docs/v{velero-version}/basic-install/#install-the-cli["Install the CLI" on the Velero website].
2525
. Follow the appropriate procedure for macOS, GitHub, or Windows.
26-
. Download the Velero version appropriate for your version of OADP and {product-title} according to the table that follows:
27-
+
28-
.OADP-Velero-{product-title} version relationship
29-
[cols="3", options="header"]
30-
|===
31-
|OADP version |Velero version |{product-title} version
32-
|1.0.0 |link:https://{velero-domain}/docs/v1.7/[1.7] |4.6 and later
33-
|1.0.1 |link:https://{velero-domain}/docs/v1.7/[1.7] |4.6 and later
34-
|1.0.2 |link:https://{velero-domain}/docs/v1.7/[1.7] |4.6 and later
35-
|1.0.3 |link:https://{velero-domain}/docs/v1.7/[1.7] |4.6 and later
36-
|1.1.0 |link:https://{velero-domain}/docs/v{velero-version}/[{velero-version}] |4.9 and later
37-
|1.1.1 |link:https://{velero-domain}/docs/v{velero-version}/[{velero-version}] |4.9 and later
38-
|1.1.2 |link:https://{velero-domain}/docs/v{velero-version}/[{velero-version}] |4.9 and later
39-
|===
26+
. Download the Velero version appropriate for your version of OADP and {product-title}.

0 commit comments

Comments
 (0)