Bug 1795483

Summary: Noobaa : example given for name of backing store is wrong
Product: [Red Hat Storage] Red Hat OpenShift Container Storage Reporter: Jiffin <jthottan>
Component: documentationAssignee: Olive Lakra <olakra>
Status: CLOSED CURRENTRELEASE QA Contact: Ben Eli <belimele>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 4.2CC: asriram, ebenahar, nbecker, ocs-bugs, olakra, ratamir
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-04-16 14:36:27 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1797537    

Description Jiffin 2020-01-28 05:16:25 UTC 
Description of problem (please be detailed as possible and provide log
snippests):

In section 6.3.2 if u execute the following, you will get an error

./noobaa backingstore create s3-compatible rgw_resource --access-key=<access key> --secret-key=<secret key> --target-bucket=<buket name> --endpoint=<endpoint>

INFO[0000] ✅ Exists: NooBaa "noobaa"                    
PANI[0000] ☠️  Panic Attack: [Invalid] BackingStore.noobaa.io "rgw_resource" is invalid: metadata.name: Invalid value: "rgw_resource": a DNS-1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*') 
panic: (*logrus.Entry) (0x1944160,0xc000264540)

Version of all relevant components (if applicable):
4.2

Does this issue impact your ability to continue to work with the product
(please explain in detail what is the user impact)?


Is there any workaround available to the best of your knowledge?
No

Rate from 1 - 5 the complexity of the scenario you performed that caused this
bug (1 - very simple, 5 - very complex)?
1

Can this issue reproducible?
Yes

Can this issue reproduce from the UI?
No tried

If this is a regression, please provide more details to justify this:


Steps to Reproduce:
Follow steps the ocs admin guide 6.3.2


Actual results:
Backing store creation failed

Expected results:
Backing store creation should suceed 

Additional info:
Comment 2 Nimrod Becker 2020-01-28 07:02:26 UTC 
BackingStore naming takes the same convention as S3 Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) 
"Bucket names must not contain uppercase characters or underscores."

You also have a clear error message showing you exactly what is permitted:
a DNS-1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*') 

(The target bucket which would be created by the creation of a backing store would have the same name, so customers would be able to easily associate one with another, and as you know a bucket name has certain limitations due to the virtual host option).

Doc instruction should be changed to "rgw-resource" (as you can see, the output box in .iv refers to "rgw-resource")
Comment 3 Jiffin 2020-01-28 08:08:57 UTC 
(In reply to Nimrod Becker from comment #2)
> BackingStore naming takes the same convention as S3 Buckets
> (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) 
> "Bucket names must not contain uppercase characters or underscores."
> 
> You also have a clear error message showing you exactly what is permitted:
> a DNS-1123 subdomain must consist of lower case alphanumeric characters, '-'
> or '.', and must start and end with an alphanumeric character (e.g.
> 'example.com', regex used for validation is
> '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*') 
> 
> (The target bucket which would be created by the creation of a backing store
> would have the same name, so customers would be able to easily associate one
> with another, and as you know a bucket name has certain limitations due to
> the virtual host option).
> 
> Doc instruction should be changed to "rgw-resource" (as you can see, the
> output box in .iv refers to "rgw-resource")

Exactly. I meant the same, In section 6.3.2 step 1 uses rgw_resource instead of rgw-resource. I opened bug to change that.