Bug 2209271

Summary: [GSS][DOC] rgw_sts_key explanation is missing in the RGW developer guide
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: Karun Josy <kjosy>
Component: DocumentationAssignee: Ranjini M N <rmandyam>
Documentation sub component: Default QA Contact: Hemanth Sai <hmaheswa>
Status: RELEASE_PENDING --- Docs Contact: Anjana Suparna Sriram <asriram>
Severity: medium    
Priority: unspecified CC: mkasturi, rmandyam, saraut
Version: 6.0   
Target Milestone: ---   
Target Release: 6.1z1   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 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:

Description Karun Josy 2023-05-23 09:56:42 UTC 
Describe the issue:

In the section "3.2.8.2. Configuring the Secure Token Service" we explain the usage of "rgw_sts_key" and has given an example

ceph config set RGW_CLIENT_NAME rgw_sts_key STS_KEY
ceph config set client.rgw rgw_sts_key 9a2142613c504c42a23ba2b82147dc28

But in upstream we explicitly ask the key to be 16 hex characters
===========
rgw_sts_key = {sts key for encrypting/ decrypting the session token, exactly 16 hex characters}
===========

https://docs.ceph.com/en/latest/radosgw/STSLite/


This information is missing from the document :

https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/6/html/developer_guide/ceph-object-gateway-and-the-s3-api#secure-token-service_dev


Chapter/Section Number and Title:

3.2.8.2. Configuring the Secure Token Service


Product Version:
RHCS 6

Any other versions of this document that also needs this update:

Yes, RHCS 5 
https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html/developer_guide/ceph-object-gateway-and-the-s3-api#configuring-the-secure-token-service_dev