Bug 1408293 - [DOCS] Gluster on OpenShift Examples Use Wrong Names
Summary: [DOCS] Gluster on OpenShift Examples Use Wrong Names
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.2.0
Hardware: Unspecified
OS: Unspecified
medium
low
Target Milestone: ---
: ---
Assignee: Ashley Hardin
QA Contact: Jianwei Hou
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-12-22 19:40 UTC by Steven Walter
Modified: 2020-02-14 18:22 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-02-06 16:56:23 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1414261 0 unspecified CLOSED [DOCS] Lost glusterfs endpoints after restart active master controllers host 2021-02-22 00:41:40 UTC

Internal Links: 1414261

Description Steven Walter 2016-12-22 19:40:49 UTC
Document URL: 
https://docs.openshift.com/enterprise/3.2/install_config/storage_examples/gluster_example.html

The above is for the 3.2 docs, but it affects 3.3 as well.

Section Number and Name: 
Creating the Gluster Endpoints and Gluster Service for Persistence

Describe the issue: 
The examples state, in the yaml:

-for the endpoints:

metadata:
  name: gluster-endpoints

-for the service:

metadata:
  name: gluster-service 


However, according to the general directions for Gluster storage on OpenShift (https://docs.openshift.com/enterprise/3.2/install_config/persistent_storage/persistent_storage_glusterfs.html), the name field in endpoints and in service need to be the *same*. Our examples should be consistent throughout so that they are more easily replicable; or, if this is not a requirement, the general directions should change as well (note there are side notes in the general directions stating "This name [endpoints] must match the service name"

Suggestions for improvement: 

Make the example docs use the same name

Comment 5 Jianwei Hou 2017-02-03 02:49:31 UTC
The endpoints name and service name are same now.

Comment 6 openshift-github-bot 2017-02-03 15:52:17 UTC
Commits pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/f9c8add293cab2e4891410a137748386a2b6fdd0
Bug 1408293, clarified that if using a service the endpoints name needs to match the service name

https://github.com/openshift/openshift-docs/commit/9fa748ecdcbc0edc0cdb9078ceb54ad605b66f4b
Merge pull request #3635 from ahardin-rh/gluster-examples

Bug 1408293, clarified that if using a service the endpoints name must match the service name


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