Bug 1880929 - [Doc RFE] Document how to create a namespace resource via the Multicloud Object Gateway UI
Summary: [Doc RFE] Document how to create a namespace resource via the Multicloud Obje...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenShift Container Storage
Classification: Red Hat Storage
Component: documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: OCS 4.6.0
Assignee: Laura Bailey
QA Contact: Filip Balák
URL:
Whiteboard:
Depends On:
Blocks: 1880905
TreeView+ depends on / blocked
 
Reported: 2020-09-21 07:36 UTC by Anjana Suparna Sriram
Modified: 2020-12-18 11:54 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-12-18 11:54:24 UTC
Embargoed:


Attachments (Terms of Use)
Namespace Buckets tab (82.36 KB, image/png)
2020-10-30 11:28 UTC, Filip Balák
no flags Details
Namespace Resources tab (76.54 KB, image/png)
2020-10-30 11:29 UTC, Filip Balák
no flags Details
Set caching policy (96.43 KB, image/png)
2020-11-02 12:11 UTC, Filip Balák
no flags Details

Comment 13 Filip Balák 2020-10-20 15:02:40 UTC
There is few suggestions:

# Chapter 4
- There is no explanation what is Namespace bucket at the beginning.
- "Namespace buckets provide a unified view of all object buckets in the namespace bucket." - I am not sure what this sentence means. Is it some tab in UI?
- "You can interact with objects in a namespace bucket using the S3 API. See S3 API endpoints for objects in namespace buckets for more information." - Wouldn't it be better to use "S3 compatible interface" instead of "S3 API"? Also in different parts of MCG documentation is used S3 endpoint instead of S3 API endpoint.

## Section 4.1
- "In the OpenShift Console, click Overview → Object Service and click the noobaa link." -> "In the OpenShift Console, navigate ti Home → Overview and click on Object Service tab. In Object Service tab click on link "Multicloud Object Gateway"." (the link "noobaa" was renamed to "Multicloud Object Gateway")
- "2. Click Accounts and select an account to add the connection to." -> "2. Click on Accounts in left panel and select an account to add the connection to." - there should be also step "Log into Multicloud Object dashboard." before this.
- "Click Add New Connection." -> "Click on Add Connection."
- "Your cloud provider’s default endpoint is shown in the Endpoint URL field by default. Enter an alternative endpoint if required." - Only Endpoint should be highlighted as the field is called only "Endpoint", not "Endpoint URL".

## Section 4.2
- "Add existing storage to NooBaa as namespace resources" -> "Add existing storage to Multicloud Object Gateway as namespace resources"
- "In the OpenShift Console, click Overview → Object Service and click the noobaa link." -> "In the OpenShift Console, navigate ti Home → Overview and click on Object Service tab. In Object Service tab click on link "Multicloud Object Gateway".", add step with MCG login after this.
- "2. Click Resources, and click on the Namespace Resources tab." -> "2. Click on Resources in left panel and select a Namespace Resources tab."
- "Set Target Bucket to the name of your bucket on that storage provider." -> "Select name of bucket on connected storage provider to be used as Target bucket."
- "Enter a Resource Name for your namespace." -> "Enter a Resource Name for your namespace resource."
- "and 0 buckets in the Namespace Buckets Using Resource column." -> "and 0 buckets in the Connected Namespace Buckets column."

## Section 4.3
- "In the OpenShift Console, click Overview → Object Service and click the noobaa link." -> "In the OpenShift Console, navigate ti Home → Overview and click on Object Service tab. In Object Service tab click on link "Multicloud Object Gateway".", add step with MCG login after this.
- "Click Buckets, and click on the Namespace Buckets tab." -> "Click on Buckets in left panel and select a Namespace Buckets tab."

Comment 17 Filip Balák 2020-10-30 11:28:29 UTC
Created attachment 1725265 [details]
Namespace Buckets tab

Comment 18 Filip Balák 2020-10-30 11:29:39 UTC
Created attachment 1725267 [details]
Namespace Resources tab

Comment 21 Filip Balák 2020-11-02 12:11:55 UTC
Created attachment 1725774 [details]
Set caching policy

The documentation looks good but there is a new step in Namespace bucket creation: Set caching policy (as seen in attached screenshot).

Please add this step with brief explanation of what this option means. I think it can be verified when this is done.

Comment 26 Filip Balák 2020-11-12 10:44:40 UTC
Looks good to me. --> VERIFIED

Comment 30 Rejy M Cyriac 2020-12-18 11:54:24 UTC
OCS 4.6.0 GA completed on 17 December 2020


Note You need to log in before you can comment on or make changes to this bug.