Bug 1480737 - [Docs] Section 5.1: Add more detail on creating custom gluster-endpoints.yaml
[Docs] Section 5.1: Add more detail on creating custom gluster-endpoints.yaml
Status: ASSIGNED
Product: Red Hat Gluster Storage
Classification: Red Hat
Component: doc-Container_Native_Storage_with_OpenShift (Show other bugs)
cns-3.5
Unspecified Unspecified
unspecified Severity medium
: ---
: ---
Assigned To: Bhavana
storage-qa-internal@redhat.com
:
Depends On:
Blocks: 1445455
  Show dependency treegraph
 
Reported: 2017-08-11 15:04 EDT by Thom Carlin
Modified: 2017-08-16 02:07 EDT (History)
3 users (show)

See Also:
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: ---


Attachments (Terms of Use)

  None (edit)
Description Thom Carlin 2017-08-11 15:04:24 EDT
Description of problem:

In https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.2/html-single/container-native_storage_for_openshift_container_platform/#chap-Documentation-Red_Hat_Gluster_Storage_Container_Native_with_OpenShift_Platform-OpenShift_Creating_Persistent_Volumes-Static_Prov, Section 5.1 STATIC PROVISIONING OF VOLUMES there should be additional steps to guide the end-user in creating the custom topology file.

Version-Release number of selected component (if applicable):

3.5

How reproducible:

100%

Steps to Reproduce:
1. Examine Section 5.1

Actual results:

Overall description with instructions in step 1 to "update the sample-gluster-endpoints.yaml file with the endpoints to be created based on the environment"

Expected results:

More detail with:
1) cp /usr/share/heketi/templates/sample-gluster-endpoints.yaml /path/to/gluster-endpoints.yaml
2) Edit /path/to/gluster-endpoints.yaml (with detail)
3) cp /usr/share/heketi/templates/sample-gluster-service.yaml /path/to/gluster-service.yaml
4) Edit /path/to/gluster-service.yaml (with detail)

Additional info:

If the sample is modified, this causes problems going forward:
a) there is no immediately available "known good" file.  If the customized file is somehow destroyed/altered so it doesn't work, customers may not be aware how to restore it easily
b) since the file is provided by an rpm, customizing causes issues whenever the rpm is updated...

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