-
Story
-
Resolution: Done
-
Normal
-
None
-
None
-
False
-
False
-
Passed
-
Undefined
-
Reference slack thread: https://coreos.slack.com/archives/CFN0XJEPR/p1624868823435300
Customer request came in for more information how to configure a generic S3 bucket as their replication repository (which was Netapp), referencing this section of the product documentation:
MCG is going to be the same as a generic S3 bucket as far as MTC is concerned, but the documentation doesn't do a great job describing how exactly you configure it within the MTC web console.
For generic S3 (effectively anything that is non-AWS S3), we expect the following:
Bucket Endpoint: probably in the form of "https://<my_bucket_endpoint", note the protocol (https://,http://, is important)
Access key, secret access key, both of which should be fairly obvious
Region: This is the tricky one, some backends require this, and some backends do not. We cannot tell the user what value to provide because we don't know the specific backend they're going to be using. The first recommendation should be to confirm with your s3 product documentation as to what the expected client value should be. Then we can mention that some/most s3 providers will accept an empty region. For example, Netapp accepts region as you'd expect, but if you leave it empty it will default to us-east-1.
- links to
[MIG-753] Improve MCG/Generic S3 replication repository configuration docs
apinnick@redhat.com I see what you mean; the section I'm referencing is helping guide the user set up the bucket itself. I think it would be good to add a "breadcrumb" at the end of this section that points the user in the right direction after they have their bucket. Something like "okay now that you have your S3 bucket and credentials here is how you can configure it in the web console". WDYT?
Ready for QE. PR: https://github.com/openshift/openshift-docs/pull/34146
ernelson@redhat.com
I think you are referencing the wrong part of the documentation. The procedure for adding a replication repository to the UI (Section 1.6.2.3) has these steps.
I can add a note to the "region" explanation but I do not think this bug will require anything more.
ernelson@redhat.com
The PR has not yet been merged because of the docs freeze, so I updated it to include an "Additional resources" section in the section about configuring the repository. The Additional resources list has links to MTV workflow, "About data copy methods", and "Adding replication repository to web console'. I think that should provide sufficient context.