Skip to content

Commit a6d6986

Browse files
author
Bob Furu
authored
Merge pull request #41858 from Erin-Donnelly/ODF-doc-updates
2 parents 23adb69 + fb21064 commit a6d6986

26 files changed

+129
-115
lines changed

_attributes/common-attributes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ endif::[]
2727
:cluster-manager: OpenShift Cluster Manager
2828
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
2929
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager]
30-
:rh-storage-first: Red Hat OpenShift Container Storage
31-
:rh-storage: OpenShift Container Storage
30+
:rh-storage-first: Red Hat OpenShift Data Foundation
31+
:rh-storage: OpenShift Data Foundation
3232
:rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM)
3333
:rh-rhacm: RHACM
3434
:sandboxed-containers-first: OpenShift sandboxed containers

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1255,7 +1255,7 @@ Topics:
12551255
File: persistent-storage-local
12561256
- Name: Persistent storage using NFS
12571257
File: persistent-storage-nfs
1258-
- Name: Persistent storage using Red Hat OpenShift Container Storage
1258+
- Name: Persistent storage using Red Hat OpenShift Data Foundation
12591259
File: persistent-storage-ocs
12601260
- Name: Persistent storage using VMware vSphere
12611261
File: persistent-storage-vsphere

backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc::[]
99

1010
You back up applications by creating a xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-creating-backup-cr_backing-up-applications[`Backup`] custom resource (CR).
1111

12-
The `Backup` CR creates backup files for Kubernetes resources and internal images, on S3 object storage, and snapshots for persistent volumes (PVs), if the cloud provider uses a native snapshot API or the xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-pvs-csi_backing-up-applications[Container Storage Interface (CSI)] to create snapshots, such as OpenShift Container Storage 4. For more information, see xref:../../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots[CSI volume snapshots].
12+
The `Backup` CR creates backup files for Kubernetes resources and internal images, on S3 object storage, and snapshots for persistent volumes (PVs), if the cloud provider uses a native snapshot API or the xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-pvs-csi_backing-up-applications[Container Storage Interface (CSI)] to create snapshots, such as {rh-storage} 4. For more information, see xref:../../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots[CSI volume snapshots].
1313

1414
:FeatureName: The `CloudStorage` API for S3 storage
1515
include::snippets/technology-preview.adoc[]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To back up PVs with snapshots, you must have a cloud provider that supports eith
2727
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#installing-oadp-aws[Amazon Web Services]
2828
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc#installing-oadp-azure[Microsoft Azure]
2929
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc#installing-oadp-gcp[Google Cloud Platform]
30-
* CSI snapshot-enabled cloud provider, such as xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc#installing-oadp-ocs[OpenShift Container Storage]
30+
* CSI snapshot-enabled cloud provider, such as xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc#installing-oadp-ocs[OpenShift Data Foundation]
3131
3232
If your cloud provider does not support snapshots or if your storage is NFS, you can back up applications with xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-applications-restic_backing-up-applications[Restic backups] on object storage.
3333

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ toc::[]
1313
You install the Openshift API for Data Protection (OADP) with Multicloud Object Gateway (MCG) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
1414

1515
You configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway] as a backup location.
16+
MCG is a component of {rh-storage}. You configure MCG as a backup location in the `DataProtectionApplication` custom resource (CR).
1617

1718
:FeatureName: The `CloudStorage` API for S3 storage
1819
include::snippets/technology-preview.adoc[]

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,7 +1,7 @@
11
:_content-type: ASSEMBLY
22
[id="installing-oadp-ocs"]
3-
= Installing and configuring the OpenShift API for Data Protection with OpenShift Container Storage
4-
include::_attributes/common-attributes.adoc[]
3+
= Installing and configuring the Openshift API for Data Protection with OpenShift Data Foundation
4+
include::modules/common-attributes.adoc[]
55
:context: installing-oadp-ocs
66
:installing-oadp-ocs:
77
:credentials: cloud-credentials
@@ -10,7 +10,7 @@ include::_attributes/common-attributes.adoc[]
1010

1111
toc::[]
1212

13-
You install the Openshift API for Data Protection (OADP) with OpenShift Container Storage (OCS) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
13+
You install the Openshift API for Data Protection (OADP) with {rh-storage} by installing the OADP Operator and configuring a backup location and a snapshot location. Then, you install the Data Protection Application.
1414

1515
You can configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway] or any S3-compatible object storage as a backup location.
1616

migrating_from_ocp_3_to_4/installing-restricted-3-4.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ include::modules/migration-configuring-mcg.adoc[leveloffset=+2]
4747
[id="{context}_configuring-replication-repository-additional-resources"]
4848
=== Additional resources
4949

50-
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.8/html-single/planning_your_deployment/index#disconnected-environment_rhocs[Disconnected environment] in the Red Hat OpenShift Container Storage documentation.
50+
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/planning_your_deployment/disconnected-environment_rhodf[Disconnected environment] in the {rh-storage-first} documentation.
5151
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-mtc-workflow_about-mtc-3-4[{mtc-short} workflow]
5252
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-understanding-data-copy-methods_about-mtc-3-4[About data copy methods]
5353
* xref:../migrating_from_ocp_3_to_4/migrating-applications-3-4.adoc#migration-adding-replication-repository-to-cam_migrating-applications-3-4[Adding a replication repository to the {mtc-short} web console]

migrating_from_ocp_3_to_4/planning-migration-3-4.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,13 @@ Persistent storage using the Container Storage Interface (CSI) was link:https://
101101
For more information, see xref:../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-using-csi[Persistent storage using the Container Storage Interface (CSI)].
102102

103103
[discrete]
104-
==== Red Hat OpenShift Container Storage
104+
==== Red Hat OpenShift Data Foundation
105105

106-
Red Hat OpenShift Container Storage 3, which is available for use with {product-title} 3.11, uses Red Hat Gluster Storage as the backing storage.
106+
OpenShift Container Storage 3, which is available for use with {product-title} 3.11, uses Red Hat Gluster Storage as the backing storage.
107107

108-
Red Hat OpenShift Container Storage 4, which is available for use with {product-title} 4, uses Red Hat Ceph Storage as the backing storage.
108+
{rh-storage-first} 4, which is available for use with {product-title} 4, uses Red Hat Ceph Storage as the backing storage.
109109

110-
For more information, see xref:../storage/persistent_storage/persistent-storage-ocs.adoc#red-hat-openshift-container-storage[Persistent storage using Red Hat OpenShift Container Storage] and the link:https://access.redhat.com/articles/4731161[interoperability matrix] article.
110+
For more information, see xref:../storage/persistent_storage/persistent-storage-ocs.adoc#red-hat-openshift-data-foundation[Persistent storage using Red Hat OpenShift Data Foundation] and the link:https://access.redhat.com/articles/4731161[interoperability matrix] article.
111111

112112
[discrete]
113113
==== Unsupported persistent storage options

migration_toolkit_for_containers/installing-mtc-restricted.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ include::modules/migration-configuring-mcg.adoc[leveloffset=+2]
5555
[id="{context}_configuring-replication-repository-additional-resources"]
5656
=== Additional resources
5757

58-
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.8/html-single/planning_your_deployment/index#disconnected-environment_rhocs[Disconnected environment] in the Red Hat OpenShift Container Storage documentation.
58+
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/planning_your_deployment/disconnected-environment_rhodf[Disconnected environment] in the {rh-storage-first} documentation.
5959
* xref:../migration_toolkit_for_containers/about-mtc.adoc#migration-mtc-workflow_about-mtc[{mtc-short} workflow]
6060
* xref:../migration_toolkit_for_containers/about-mtc.adoc#migration-understanding-data-copy-methods_about-mtc[About data copy methods]
6161
* xref:../migration_toolkit_for_containers/migrating-applications-with-mtc.adoc#migration-adding-replication-repository-to-cam_migrating-applications-with-mtc[Adding a replication repository to the {mtc-short} web console]

modules/deploy-red-hat-openshift-container-storage.adoc

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,61 @@
55
[options="header",cols="1,1"]
66
|===
77

8-
|If you are looking for Red Hat OpenShift Container Storage information about...
9-
|See the following Red Hat OpenShift Container Storage documentation:
8+
|If you are looking for {rh-storage-first} information about...
9+
|See the following {rh-storage-first} documentation:
1010

1111
|What's new, known issues, notable bug fixes, and Technology Previews
12-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html/4.7_release_notes/index[OpenShift Container Storage 4.7 Release Notes]
12+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/4.9_release_notes[OpenShift Data Foundation 4.9 Release Notes]
1313

1414
|Supported workloads, layouts, hardware and software requirements, sizing and scaling recommendations
15-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/planning_your_deployment/index[Planning your OpenShift Container Storage 4.5 deployment]
15+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/planning_your_deployment[Planning your OpenShift Data Foundation 4.9 deployment]
1616

17-
|Instructions on preparing to deploy when your environment is not directly connected to the internet
18-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/preparing_to_deploy_in_a_disconnected_environment/index[Preparing to deploy OpenShift Container Storage 4.5 in a disconnected environment]
17+
|Instructions on deploying {rh-storage} to use an external Red Hat Ceph Storage cluster
18+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/deploying_openshift_data_foundation_in_external_mode[Deploying OpenShift Data Foundation 4.9 in external mode]
1919

20-
|Instructions on deploying OpenShift Container Storage to use an external Red Hat Ceph Storage cluster
21-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/deploying_openshift_container_storage_in_external_mode/index[Deploying OpenShift Container Storage 4.5 in external mode]
20+
|Instructions on deploying {rh-storage} to local storage on bare metal infrastructure
21+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/deploying_openshift_data_foundation_using_bare_metal_infrastructure[Deploying OpenShift Data Foundation 4.9 using bare metal infrastructure]
2222

23-
|Instructions on deploying OpenShift Container Storage to local storage on bare metal infrastructure
24-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/deploying_openshift_container_storage_using_bare_metal_infrastructure/index[Deploying OpenShift Container Storage 4.5 using bare metal infrastructure]
23+
|Instructions on deploying {rh-storage} on Red Hat {product-title} VMWare vSphere clusters
24+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/deploying_openshift_data_foundation_on_vmware_vsphere[Deploying OpenShift Data Foundation 4.9 on VMWare vSphere]
2525

26-
|Instructions on deploying OpenShift Container Storage on Red Hat {product-title} VMWare vSphere clusters
27-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/deploying_openshift_container_storage_on_vmware_vsphere/index[Deploying OpenShift Container Storage 4.5 on VMWare vSphere]
26+
|Instructions on deploying {rh-storage} using Amazon Web Services for local or cloud storage
27+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/deploying_openshift_data_foundation_using_amazon_web_services[Deploying OpenShift Data Foundation 4.9 using Amazon Web Services]
2828

29-
|Instructions on deploying OpenShift Container Storage using Amazon Web Services for local or cloud storage
30-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/deploying_openshift_container_storage_using_amazon_web_services/index[Deploying OpenShift Container Storage 4.5 using Amazon Web Services]
29+
|Instructions on deploying and managing {rh-storage} on existing Red Hat {product-title} Google Cloud clusters
30+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/deploying_and_managing_openshift_data_foundation_using_google_cloud[Deploying and managing OpenShift Data Foundation 4.9 using Google Cloud]
3131

32-
|Instructions on deploying and managing OpenShift Container Storage on existing Red Hat {product-title} Google Cloud clusters
33-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/deploying_and_managing_openshift_container_storage_using_google_cloud/index[Deploying and managing OpenShift Container Storage 4.5 using Google Cloud]
32+
|Instructions on deploying and managing {rh-storage} on existing Red Hat {product-title} Azure clusters
33+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/deploying_openshift_data_foundation_using_microsoft_azure_and_azure_red_hat_openshift[Deploying and managing OpenShift Data Foundation 4.9 using Microsoft Azure]
3434

35-
|Instructions on deploying and managing OpenShift Container Storage on existing Red Hat {product-title} Azure clusters
36-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/deploying_and_managing_openshift_container_storage_using_microsoft_azure/index[Deploying and managing OpenShift Container Storage 4.5 using Microsoft Azure]
35+
|Instructions on deploying {rh-storage} to use local storage on IBM Power infrastructure
36+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html-single/deploying_openshift_data_foundation_using_ibm_power_systems/index[Deploying OpenShift Data Foundation on IBM Power]
3737

38-
|Managing a Red Hat OpenShift Container Storage 4.5 cluster
39-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/managing_openshift_container_storage/index[Managing OpenShift Container Storage 4.5]
38+
|Instructions on deploying {rh-storage} to use local storage on IBM Z infrastructure
39+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/deploying_openshift_data_foundation_using_ibm_z_infrastructure/index[Deploying OpenShift Data Foundation on IBM Z infrastructure]
4040

41-
|Monitoring a Red Hat OpenShift Container Storage 4.5 cluster
42-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/monitoring_openshift_container_storage/index[Monitoring Red Hat OpenShift Container Storage 4.5]
41+
|Allocating storage to core services and hosted applications in {rh-storage-first}, including snapshot and clone
42+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/managing_and_allocating_storage_resources[Managing and allocating resources]
43+
44+
|Managing storage resources across a hybrid cloud or multicloud environment using the Multicloud Object Gateway (NooBaa)
45+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/managing_hybrid_and_multicloud_resources[Managing hybrid and multicloud resources]
46+
47+
|Safely replacing storage devices for {rh-storage-first}
48+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/replacing_devices[Replacing devices]
49+
50+
|Safely replacing a node in a {rh-storage-first} cluster
51+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/replacing_nodes[Replacing nodes]
52+
53+
|Scaling operations in {rh-storage-first}
54+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/scaling_storage[Scaling storage]
55+
56+
|Monitoring a {rh-storage-first} 4.9 cluster
57+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/monitoring_openshift_data_foundation[Monitoring Red Hat OpenShift Data Foundation 4.9]
4358

4459
|Resolve issues encountered during operations
45-
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.5/html/troubleshooting_openshift_container_storage/index[Troubleshooting OpenShift Container Storage 4.5]
60+
|link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.9/html/troubleshooting_openshift_data_foundation[Troubleshooting OpenShift Data Foundation 4.9]
4661

4762
|Migrating your {product-title} cluster from version 3 to version 4
48-
|link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.7/html/migrating_from_version_3_to_4/index[Migration]
63+
|link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.9/html/migrating_from_version_3_to_4/index[Migration]
4964

5065
|===

0 commit comments

Comments
 (0)