diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 8c8521ac2580..bf303b7b6c54 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2529,16 +2529,21 @@ Topics: Topics: - Name: About installing OADP File: about-installing-oadp - - Name: Installing and configuring OADP with AWS + - Name: Installing the OADP Operator + File: oadp-installing-operator + - Name: Configuring OADP with AWS File: installing-oadp-aws - - Name: Installing and configuring OADP with Azure + - Name: Configuring OADP with Azure File: installing-oadp-azure - - Name: Installing and configuring OADP with GCP + - Name: Configuring OADP with GCP File: installing-oadp-gcp - - Name: Installing and configuring OADP with MCG + - Name: Configuring OADP with MCG File: installing-oadp-mcg - - Name: Installing and configuring OADP with ODF + - Name: Configuring OADP with ODF File: installing-oadp-ocs + - Name: Uninstalling OADP + Dir: installing + Topics: - Name: Uninstalling OADP File: uninstalling-oadp - Name: Backing up and restoring diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc index 64b8b58df482..171c7940540a 100644 --- a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc +++ b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="installing-oadp-aws"] -= Installing and configuring the OpenShift API for Data Protection with Amazon Web Services += Configuring the OpenShift API for Data Protection with Amazon Web Services include::_attributes/common-attributes.adoc[] :context: installing-oadp-aws :installing-oadp-aws: @@ -13,11 +13,11 @@ You install the OpenShift API for Data Protection (OADP) with Amazon Web Service include::snippets/oadp-mtc-operator.adoc[] -You configure AWS for Velero, create a default `Secret`, and then install the Data Protection Application. +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]. 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. -include::modules/oadp-installing-operator.adoc[leveloffset=+1] +//include::modules/oadp-installing-operator.adoc[leveloffset=+1] include::modules/migration-configuring-aws-s3.adoc[leveloffset=+1] include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1] include::modules/oadp-creating-default-secret.adoc[leveloffset=+2] diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc index 3077b98b3b71..53b3aec21a8a 100644 --- a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc +++ b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="installing-oadp-azure"] -= Installing and configuring the OpenShift API for Data Protection with Microsoft Azure += Configuring the OpenShift API for Data Protection with Microsoft Azure include::_attributes/common-attributes.adoc[] :context: installing-oadp-azure :installing-oadp-azure: @@ -13,11 +13,11 @@ You install the OpenShift API for Data Protection (OADP) with Microsoft Azure by include::snippets/oadp-mtc-operator.adoc[] -You configure Azure for Velero, create a default `Secret`, and then install the Data Protection Application. +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]. 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. -include::modules/oadp-installing-operator.adoc[leveloffset=+1] +// include::modules/oadp-installing-operator.adoc[leveloffset=+1] include::modules/migration-configuring-azure.adoc[leveloffset=+1] include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1] include::modules/oadp-creating-default-secret.adoc[leveloffset=+2] diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc index 6b688c72a17a..072b8ab031dd 100644 --- a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc +++ b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="installing-oadp-gcp"] -= Installing and configuring the OpenShift API for Data Protection with Google Cloud Platform += Configuring the OpenShift API for Data Protection with Google Cloud Platform include::_attributes/common-attributes.adoc[] :context: installing-oadp-gcp :installing-oadp-gcp: @@ -13,11 +13,11 @@ You install the OpenShift API for Data Protection (OADP) with Google Cloud Platf include::snippets/oadp-mtc-operator.adoc[] -You configure GCP for Velero, create a default `Secret`, and then install the Data Protection Application. +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]. 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. -include::modules/oadp-installing-operator.adoc[leveloffset=+1] +//include::modules/oadp-installing-operator.adoc[leveloffset=+1] include::modules/migration-configuring-gcp.adoc[leveloffset=+1] include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1] include::modules/oadp-creating-default-secret.adoc[leveloffset=+2] diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc index ff7180e2410e..07a3585eb872 100644 --- a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc +++ b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="installing-oadp-mcg"] -= Installing and configuring the OpenShift API for Data Protection with Multicloud Object Gateway += Configuring the OpenShift API for Data Protection with Multicloud Object Gateway include::_attributes/common-attributes.adoc[] :context: installing-oadp-mcg :installing-oadp-mcg: @@ -19,11 +19,11 @@ MCG is a component of {rh-storage}. You configure MCG as a backup location in th :FeatureName: The `CloudStorage` API, which automates the creation of a bucket for object storage, include::snippets/technology-preview.adoc[] -You create a `Secret` for the backup location and then you install the Data Protection Application. +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]. 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]. -include::modules/oadp-installing-operator.adoc[leveloffset=+1] +//include::modules/oadp-installing-operator.adoc[leveloffset=+1] include::modules/migration-configuring-mcg.adoc[leveloffset=+1] include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1] include::modules/oadp-creating-default-secret.adoc[leveloffset=+2] diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc index eaa479710d4f..13ab2aa25d39 100644 --- a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc +++ b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="installing-oadp-ocs"] -= Installing and configuring the OpenShift API for Data Protection with OpenShift Data Foundation += Configuring the OpenShift API for Data Protection with OpenShift Data Foundation include::_attributes/common-attributes.adoc[] :context: installing-oadp-ocs :credentials: cloud-credentials @@ -17,11 +17,11 @@ You can configure xref:../../../backup_and_restore/application_backup_and_restor :FeatureName: The `CloudStorage` API, which automates the creation of a bucket for object storage, include::snippets/technology-preview.adoc[] -You create a `Secret` for the backup location and then you install the Data Protection Application. +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]. 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]. -include::modules/oadp-installing-operator.adoc[leveloffset=+1] +//include::modules/oadp-installing-operator.adoc[leveloffset=+1] include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc b/backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc new file mode 100644 index 000000000000..8d957f92b0a8 --- /dev/null +++ b/backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc @@ -0,0 +1,25 @@ +:_content-type: PROCEDURE +[id="oadp-installing-operator-doc"] += Installing the OADP Operator +include::_attributes/common-attributes.adoc[] +:context: installing-oadp-operator + +toc::[] + +You can install the OpenShift API for Data Protection (OADP) Operator on {product-title} {product-version} by using Operator Lifecycle Manager (OLM). + +The OADP Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}]. + +.Prerequisites + +* You must be logged in as a user with `cluster-admin` privileges. + +.Procedure + +. In the {product-title} web console, click *Operators* -> *OperatorHub*. +. Use the *Filter by keyword* field to find the *OADP Operator*. +. Select the *OADP Operator* and click *Install*. +. Click *Install* to install the Operator in the `openshift-adp` project. +. Click *Operators* -> *Installed Operators* to verify the installation. + +include::modules/velero-oadp-version-relationship.adoc[leveloffset=+1] diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting.adoc index 39b605f38e9e..b9986c8e3646 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting.adoc @@ -21,6 +21,7 @@ You can obtain the Velero CLI tool by: * Accessing the Velero binary in the Velero deployment in the cluster include::modules/velero-obtaining-by-downloading.adoc[leveloffset=+1] +include::modules/velero-oadp-version-relationship.adoc[leveloffset=+2] include::modules/velero-obtaining-by-accessing-binary.adoc[leveloffset=+1] include::modules/oadp-debugging-oc-cli.adoc[leveloffset=+1] diff --git a/modules/velero-oadp-version-relationship.adoc b/modules/velero-oadp-version-relationship.adoc new file mode 100644 index 000000000000..2cdfe8b8ffdf --- /dev/null +++ b/modules/velero-oadp-version-relationship.adoc @@ -0,0 +1,18 @@ +:_content-type: CONCEPT +[id="velero-oadp-version-relationship_{context}"] += OADP-Velero-{product-title} version relationship + +[cols="3", options="header"] +|=== +|OADP version |Velero version |{product-title} version +| 1.1.0 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later +| 1.1.1 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later +| 1.1.2 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later +| 1.1.3 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later +| 1.1.4 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later +| 1.1.5 | link:https://{velero-domain}/docs/v1.9]/[1.9] | 4.9 and later +| 1.1.6 | link:https://{velero-domain}/docs/v1.9]/[1.9.] | 4.11 and later +| 1.2.0 | link:https://{velero-domain}/docs/v1.11/[1.11] | 4.11 and later +| 1.2.1 | link:https://{velero-domain}/docs/v1.11/[1.11] | 4.11 and later +| 1.2.2 | link:https://{velero-domain}/docs/v1.11/[1.11] | 4.11 and later +|=== diff --git a/modules/velero-obtaining-by-downloading.adoc b/modules/velero-obtaining-by-downloading.adoc index f14f8b74eef8..2a25eea36d7b 100644 --- a/modules/velero-obtaining-by-downloading.adoc +++ b/modules/velero-obtaining-by-downloading.adoc @@ -23,17 +23,4 @@ The page includes instructions for: . 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]. . Follow the appropriate procedure for macOS, GitHub, or Windows. -. Download the Velero version appropriate for your version of OADP and {product-title} according to the table that follows: -+ -.OADP-Velero-{product-title} version relationship -[cols="3", options="header"] -|=== -|OADP version |Velero version |{product-title} version -|1.0.0 |link:https://{velero-domain}/docs/v1.7/[1.7] |4.6 and later -|1.0.1 |link:https://{velero-domain}/docs/v1.7/[1.7] |4.6 and later -|1.0.2 |link:https://{velero-domain}/docs/v1.7/[1.7] |4.6 and later -|1.0.3 |link:https://{velero-domain}/docs/v1.7/[1.7] |4.6 and later -|1.1.0 |link:https://{velero-domain}/docs/v{velero-version}/[{velero-version}] |4.9 and later -|1.1.1 |link:https://{velero-domain}/docs/v{velero-version}/[{velero-version}] |4.9 and later -|1.1.2 |link:https://{velero-domain}/docs/v{velero-version}/[{velero-version}] |4.9 and later -|=== +. Download the Velero version appropriate for your version of OADP and {product-title}.