Skip to content

Commit 83954c8

Browse files
authored
Merge pull request #35109 from apinnick/bz1888035-noobaa-mtc
BZ1888035: Replace MCG module with link to OCS doc
2 parents fc6b6c8 + 08c42d0 commit 83954c8

File tree

6 files changed

+29
-191
lines changed

6 files changed

+29
-191
lines changed

migrating_from_ocp_3_to_4/installing-3-4.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ If you use a proxy server with an internally hosted replication repository, you
3333

3434
The following storage providers are supported:
3535

36-
* Multi-Cloud Object Gateway (MCG)
37-
* Amazon Web Services (AWS) S3
38-
* Google Cloud Platform (GCP)
39-
* Microsoft Azure Blob
36+
* xref:../migrating_from_ocp_3_to_4/installing-3-4.adoc#migration-configuring-mcg_installing-3-4[Multicloud Object Gateway]
37+
* xref:../migrating_from_ocp_3_to_4/installing-3-4.adoc#migration-configuring-aws-s3_installing-3-4[Amazon Web Services S3]
38+
* xref:../migrating_from_ocp_3_to_4/installing-3-4.adoc#migration-configuring-gcp_installing-3-4[Google Cloud Platform]
39+
* xref:../migrating_from_ocp_3_to_4/installing-3-4.adoc#migration-configuring-azure_installing-3-4[Microsoft Azure Blob]
4040
* Generic S3 object storage, for example, Minio or Ceph S3
4141

4242
[id="{context}_configuring-replication-repository-additional-resources"]
4343
[discrete]
44-
=== Additional resources
44+
=== Additional resources for configuring a replication repository
4545

4646
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-mtc-workflow_about-mtc-3-4[{mtc-short} workflow]
4747
* 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]

migrating_from_ocp_3_to_4/installing-restricted-3-4.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ include::modules/migration-installing-mtc-on-ocp-3.adoc[leveloffset=+1]
2525
[id="configuring-replication-repository_{context}"]
2626
== Configuring a replication repository
2727

28-
You must configure an object storage to use as a replication repository. The {mtc-full} ({mtc-short}) copies data from the source cluster to the replication repository, and then from the replication repository to the target cluster. Multi-Cloud Object Gateway (MCG) is the only supported option for a restricted network environment.
28+
The Multicloud Object Gateway is the only supported option for a restricted network environment.
2929

3030
{mtc-short} supports the xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-understanding-data-copy-methods_about-mtc-3-4[file system and snapshot data copy methods] for migrating data from the source cluster to the target cluster. You can select a method that is suited for your environment and is supported by your storage provider.
3131

@@ -35,12 +35,12 @@ If you use a proxy server with an internally hosted replication repository, you
3535

3636
[id="{context}_configuring-replication-repository-additional-resources"]
3737
[discrete]
38-
=== Additional resources
38+
=== Additional resources for configuring a replication repository
3939

40+
* 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.
4041
* xref:../migrating_from_ocp_3_to_4/about-mtc-3-4.adoc#migration-mtc-workflow_about-mtc-3-4[{mtc-short} workflow]
4142
* 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]
4243
* 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]
4344

4445
include::modules/migration-configuring-mcg.adoc[leveloffset=+2]
45-
4646
:installing-restricted-3-4!:

migration_toolkit_for_containers/installing-mtc-restricted.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,22 @@ include::modules/migration-installing-mtc-on-ocp-4.adoc[leveloffset=+1]
2424
[id="configuring-replication-repository_{context}"]
2525
== Configuring a replication repository
2626

27-
You must configure an object storage to use as a replication repository. The {mtc-full} ({mtc-short}) copies data from the source cluster to the replication repository, and then from the replication repository to the target cluster. Multi-Cloud Object Gateway (MCG) is the only supported option for a restricted network environment.
27+
The Multicloud Object Gateway is the only supported option for a restricted network environment.
2828

2929
{mtc-short} supports the xref:../migration_toolkit_for_containers/about-mtc.adoc#migration-understanding-data-copy-methods_about-mtc[file system and snapshot data copy methods] for migrating data from the source cluster to the target cluster. You can select a method that is suited for your environment and is supported by your storage provider.
3030

3131
All clusters must have uninterrupted network access to the replication repository.
3232

3333
If you use a proxy server with an internally hosted replication repository, you must ensure that the proxy allows access to the replication repository.
3434

35+
[id="{context}_configuring-replication-repository-additional-resources"]
36+
[discrete]
37+
=== Additional resources for configuring a replication repository
38+
39+
* 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.
40+
* xref:../migration_toolkit_for_containers/about-mtc.adoc#migration-mtc-workflow_about-mtc[{mtc-short} workflow]
41+
* xref:../migration_toolkit_for_containers/about-mtc.adoc#migration-understanding-data-copy-methods_about-mtc[About data copy methods]
42+
* 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]
43+
3544
include::modules/migration-configuring-mcg.adoc[leveloffset=+2]
3645
:installing-mtc-restricted!:

migration_toolkit_for_containers/installing-mtc.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ If you use a proxy server with an internally hosted replication repository, you
3232

3333
{mtc-short} supports the following storage providers:
3434

35-
* Multi-Cloud Object Gateway (MCG)
36-
* Amazon Web Services (AWS) S3
37-
* Google Cloud Platform (GCP)
38-
* Microsoft Azure Blob
35+
* xref:../migration_toolkit_for_containers/installing-mtc.adoc#migration-configuring-mcg_installing-mtc[Multicloud Object Gateway]
36+
* xref:../migration_toolkit_for_containers/installing-mtc.adoc#migration-configuring-aws-s3_installing-mtc[Amazon Web Services S3]
37+
* xref:../migration_toolkit_for_containers/installing-mtc.adoc#migration-configuring-gcp_installing-mtc[Google Cloud Platform]
38+
* xref:../migration_toolkit_for_containers/installing-mtc.adoc#migration-configuring-azure_installing-mtc[Microsoft Azure Blob]
3939
* Generic S3 object storage, for example, Minio or Ceph S3
4040

4141
[id="{context}_configuring-replication-repository-additional-resources"]
4242
[discrete]
43-
=== Additional resources
43+
=== Additional resources for configuring a replication repository
4444

4545
* xref:../migration_toolkit_for_containers/about-mtc.adoc#migration-mtc-workflow_about-mtc[{mtc-short} workflow]
4646
* xref:../migration_toolkit_for_containers/about-mtc.adoc#migration-understanding-data-copy-methods_about-mtc[About data copy methods]

modules/migration-configuring-mcg.adoc

Lines changed: 5 additions & 176 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,9 @@
66
// * migration_toolkit_for_containers/installing-mtc-restricted.adoc
77

88
[id="migration-configuring-mcg_{context}"]
9-
= Configuring Multi-Cloud Object Gateway
9+
= Configuring the Multicloud Object Gateway
1010

11-
You can install the OpenShift Container Storage Operator and configure a Multi-Cloud Object Gateway (MCG) storage bucket as a replication repository for the {mtc-full} ({mtc-short}).
12-
13-
[id="installing-the-ocs-operator_{context}"]
14-
== Installing the OpenShift Container Storage Operator
15-
16-
You can install the OpenShift Container Storage Operator from OperatorHub.
17-
18-
ifdef::installing-restricted-3-4[]
19-
See link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/planning_your_deployment/index#disconnected-environment_rhocs[Disconnected environment] in _Red Hat OpenShift Container Storage: Planning your deployment_ for more information.
20-
endif::[]
11+
You can configure the Multicloud Object Gateway (MCG) as a replication repository for the {mtc-full} ({mtc-short}). MCG is a component of OpenShift Container Storage.
2112

2213
ifdef::openshift-origin[]
2314
.Prerequisites
@@ -29,169 +20,7 @@ endif::[]
2920

3021
.Procedure
3122

32-
. In the {product-title} web console, click *Operators* -> *OperatorHub*.
33-
. Use *Filter by keyword* (in this case, *OCS*) to find the *OpenShift Container Storage Operator*.
34-
. Select the *OpenShift Container Storage Operator* and click *Install*.
35-
. Select an *Update Channel*, *Installation Mode*, and *Approval Strategy*.
36-
. Click *Install*.
37-
+
38-
On the *Installed Operators* page, the *OpenShift Container Storage Operator* appears in the *openshift-storage* project with the status *Succeeded*.
39-
40-
[id="configuring-mcg-storage-bucket_{context}"]
41-
== Creating the Multi-Cloud Object Gateway storage bucket
42-
43-
You can create the Multi-Cloud Object Gateway (MCG) storage bucket's custom resources (CRs).
44-
45-
.Procedure
46-
47-
. Log in to the {product-title} cluster:
48-
+
49-
[source,terminal]
50-
----
51-
$ oc login -u <username>
52-
----
53-
54-
. Create the `NooBaa` CR configuration file, `noobaa.yml`, with the following content:
55-
+
56-
[source,yaml]
57-
----
58-
apiVersion: noobaa.io/v1alpha1
59-
kind: NooBaa
60-
metadata:
61-
name: <noobaa>
62-
namespace: openshift-storage
63-
spec:
64-
dbResources:
65-
requests:
66-
cpu: 0.5 <1>
67-
memory: 1Gi
68-
coreResources:
69-
requests:
70-
cpu: 0.5 <1>
71-
memory: 1Gi
72-
----
73-
<1> For a very small cluster, you can change the value to `0.1`.
74-
75-
. Create the `NooBaa` object:
76-
+
77-
[source,terminal]
78-
----
79-
$ oc create -f noobaa.yml
80-
----
81-
82-
. Create the `BackingStore` CR configuration file, `bs.yml`, with the following content:
83-
+
84-
[source,yaml]
85-
----
86-
apiVersion: noobaa.io/v1alpha1
87-
kind: BackingStore
88-
metadata:
89-
finalizers:
90-
- noobaa.io/finalizer
91-
labels:
92-
app: noobaa
93-
name: <mcg_backing_store>
94-
namespace: openshift-storage
95-
spec:
96-
pvPool:
97-
numVolumes: 3 <1>
98-
resources:
99-
requests:
100-
storage: <volume_size> <2>
101-
storageClass: <storage_class> <3>
102-
type: pv-pool
103-
----
104-
<1> Specify the number of volumes in the persistent volume pool.
105-
<2> Specify the size of the volumes, for example, `50Gi`.
106-
<3> Specify the storage class, for example, `gp2`.
107-
108-
. Create the `BackingStore` object:
109-
+
110-
[source,terminal]
111-
----
112-
$ oc create -f bs.yml
113-
----
114-
115-
. Create the `BucketClass` CR configuration file, `bc.yml`, with the following content:
116-
+
117-
[source,yaml]
118-
----
119-
apiVersion: noobaa.io/v1alpha1
120-
kind: BucketClass
121-
metadata:
122-
labels:
123-
app: noobaa
124-
name: <mcg_bucket_class>
125-
namespace: openshift-storage
126-
spec:
127-
placementPolicy:
128-
tiers:
129-
- backingStores:
130-
- <mcg_backing_store>
131-
placement: Spread
132-
----
133-
134-
. Create the `BucketClass` object:
135-
+
136-
[source,terminal]
137-
----
138-
$ oc create -f bc.yml
139-
----
140-
141-
. Create the `ObjectBucketClaim` CR configuration file, `obc.yml`, with the following content:
142-
+
143-
[source,yaml]
144-
----
145-
apiVersion: objectbucket.io/v1alpha1
146-
kind: ObjectBucketClaim
147-
metadata:
148-
name: <bucket>
149-
namespace: openshift-storage
150-
spec:
151-
bucketName: <bucket> <1>
152-
storageClassName: <storage_class>
153-
additionalConfig:
154-
bucketclass: <mcg_bucket_class>
155-
----
156-
<1> Record the bucket name for adding the replication repository to the {mtc-short} web console.
157-
158-
. Create the `ObjectBucketClaim` object:
159-
+
160-
[source,terminal]
161-
----
162-
$ oc create -f obc.yml
163-
----
164-
165-
. Watch the resource creation process to verify that the `ObjectBucketClaim` status is `Bound`:
166-
+
167-
[source,terminal]
168-
----
169-
$ watch -n 30 'oc get -n openshift-storage objectbucketclaim migstorage -o yaml'
170-
----
171-
+
172-
This process can take five to ten minutes.
173-
174-
. Obtain and record the following values, which are required when you add the replication repository to the {mtc-short} web console:
175-
176-
* S3 endpoint:
177-
+
178-
[source,terminal]
179-
----
180-
$ oc get route -n openshift-storage s3
181-
----
182-
183-
* S3 provider access key:
184-
+
185-
[source,terminal]
186-
----
187-
$ oc get secret -n openshift-storage migstorage \
188-
-o go-template='{{ .data.AWS_ACCESS_KEY_ID }}' | base64 --decode
189-
----
190-
191-
* S3 provider secret access key:
23+
. Deploy OpenShift Container Storage by using the appropriate link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/[OpenShift Container Storage deployment guide].
24+
. Obtain the S3 endpoint, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY` by running the link:https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/4.7/html-single/managing_hybrid_and_multicloud_resources/index#accessing-the-Multicloud-object-gateway-from-the-terminal_rhocs[`describe` command] on the `NooBaa` custom resource.
19225
+
193-
[source,terminal]
194-
----
195-
$ oc get secret -n openshift-storage migstorage \
196-
-o go-template='{{ .data.AWS_SECRET_ACCESS_KEY }}' | base64 --decode
197-
----
26+
These values are required in order to add MCG as a replication repository to the {mtc-short} web console.

modules/migration-mtc-workflow.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can install the {mtc-full} Operator in a restricted environment with limited
3030

3131
. Configure the replication repository, an intermediate object storage that {mtc-short} uses to migrate data.
3232
+
33-
The source and target clusters must have network access to the replication repository during migration. In a restricted environment, you can use Multi-Cloud Object Gateway (MCG). If you are using a proxy server, you must configure it to allow network traffic between the replication repository and the clusters.
33+
The source and target clusters must have network access to the replication repository during migration. If you are using a proxy server, you must configure it to allow network traffic between the replication repository and the clusters.
3434

3535
. Add the source cluster to the {mtc-short} web console.
3636
. Add the replication repository to the {mtc-short} web console.

0 commit comments

Comments
 (0)