Hide Forgot
Additional information: Develop a comprehensive guide for Red Hat Gluster Storage for Containers that assists customers with understanding about containerized Gluster.
As discussed in the meeting, we agreed to document as just "3.2" http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#idm139999885817440 Made the change accordingly.
On a quick check, I still see some major mismatches in the guide. See below for the corrections required in the guide: ##### # subscription-manager repos --enable=rh-gluster-3-for-rhel-7-server-rpm ---> # subscription-manager repos --enable=rh-gluster-3-for-rhel-7-server-rpms # yum install heketi-client heketi-template ---> # yum install heketi-client heketi-templates # yum install atomic-openshift-clientyum install atomic-openshift ---> # yum install atomic-openshift-clients A cluster-admin user must be created. ---> No link to openshift guide for creating a cluster admin user ##### Can you quickly re-check the same from your end and update it correctly?
Anjana, can you check and do the needful?
Yes, I agree. I think the instruction in Appendix C of the dev guide are easier to follow. IN addition, it's helpful to understand how the router works with the rest of the deployment (ie heketi api server values) as per my suggstions in this guide https://docs.google.com/document/d/1b4U1QoKTgLDLKtonirpALi_B2iATay-I7bSFEQXQ8Ow/edit?ts=57912865#
I think we also need to emphasize that on the router the user SHOULD NOT EDIT the /etc/dnsmasq.conf UNTIL the router has successfully started. Any changes to this file while it's trying to deploy (even if it's been assigned out to a server) will cause an unrecoverable error
In Appendix A. Client Configuration using Port Forwarding oc port-forward heketi pod name 8080:8080 For clarity it should be: oc port-forward <heketi pod name> 8080:8080 I believe this is the convention we are following in complete doc.
3.2.1.2. Setting up the Red Hat Enterprise Linux 7 Client for Installing Red Hat Gluster Storage Container Converged with OpenShift Subscribe to the OpenShift Enterprise 3.2 repo change # subscription-manager repos --enable=rhel-7-server-ose-3.2-rpms/x86_64 to # subscription-manager repos --enable=rhel-7-server-ose-3.2-rpms
(In reply to Prasanth from comment #9) > On a quick check, I still see some major mismatches in the guide. See below > for the corrections required in the guide: > > ##### > # subscription-manager repos --enable=rh-gluster-3-for-rhel-7-server-rpm > ---> # subscription-manager repos > --enable=rh-gluster-3-for-rhel-7-server-rpms > # yum install heketi-client heketi-template ---> # yum install heketi-client > heketi-templates > # yum install atomic-openshift-clientyum install atomic-openshift ---> # yum > install atomic-openshift-clients > A cluster-admin user must be created. ---> No link to openshift guide for > creating a cluster admin user > ##### > > Can you quickly re-check the same from your end and update it correctly? Hi Prasanth, The commands and the link to the cluster admin guide is updated. let me know if this looks ok. http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#chap-Documentation-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage-Support_Requirements_2
(In reply to Neha from comment #15) > 3.2.1.2. Setting up the Red Hat Enterprise Linux 7 Client for Installing Red > Hat Gluster Storage Container Converged with OpenShift > > Subscribe to the OpenShift Enterprise 3.2 repo > > change > > # subscription-manager repos --enable=rhel-7-server-ose-3.2-rpms/x86_64 > > to > > # subscription-manager repos --enable=rhel-7-server-ose-3.2-rpms Hi Neha, The command is now updated: http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#idm139722086961568
(In reply to Neha from comment #14) > In Appendix A. Client Configuration using Port Forwarding > > oc port-forward heketi pod name 8080:8080 > > For clarity it should be: > > oc port-forward <heketi pod name> 8080:8080 > > I believe this is the convention we are following in complete doc. Hi Neha, The pod name is now witten within "< >": http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#idm139722086961568
A.2. Setting up the DNS After the router is setup, the clients have to be setup to access the services in the OpenShift cluster. Execute the following steps to setup the DNS. ***I would recommend saying "After the router is running" You cannot change the DNS before the router is completely up, or it won't ever come up completely.
Should we enhance this: path: The Gluster volume that will be accessed from the Trusted Storage Pool. Tell the user how to find it oc rch <glusterpod> gluster volume info i.e. oc rsh glusterfs-dc-aplo19.rh72-1-8h7dc sh-4.2# gluster volume status Status of volume: heketidbstorage <--- path
(In reply to Erin Boyd from comment #24) > A.2. Setting up the DNS > After the router is setup, the clients have to be setup to access the > services in the OpenShift cluster. Execute the following steps to setup the > DNS. > > ***I would recommend saying > > "After the router is running" > > You cannot change the DNS before the router is completely up, or it won't > ever come up completely. Updated the phrase accordingly. http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#idm139999887218976
(In reply to Erin Boyd from comment #25) > Should we enhance this: > path: The Gluster volume that will be accessed from the Trusted Storage > Pool. > > Tell the user how to find it > > oc rch <glusterpod> > gluster volume info > > i.e. > oc rsh glusterfs-dc-aplo19.rh72-1-8h7dc > > sh-4.2# gluster volume status > Status of volume: heketidbstorage <--- path It was recommended I add a new chapter, where the gluster pod operations are described. I think that will cover this suggestion: http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#chap-Documentation-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage-Gluster_Pod_Operations
The team gave approval to the docs but the last 2 changes we need ASAP are the following: CHANGE #1 In Section "4.1. Preparing the Red Hat OpenShift Enterprise Cluster" Move all of Step 1: On each of the OpenShift nodes that will host the Red Hat Gluster Storage container, add the following rules to /etc/sysconfig/iptables in order to open the required ports: -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 24007 -j ACCEPT -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 24008 -j ACCEPT -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 2222 -j ACCEPT -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m multiport --dports 49152:49664 -j ACCEPT Execute the following command to reload the iptables: # systemctl reload iptables from "4.1. Preparing the Red Hat OpenShift Enterprise Cluster" to "3.2.3. Red Hat OpenShift Enterprise Requirements" as its own separate bullet after "The OpenShift cluster must be up and running." bullet but before the "The OpenShift router must be created and the DNS must be setup. For more information see, Appendix A, OpenShift Router Setup" bullet. CHANGE #2 Update the title and subtitle to the following text: Title: Deployment Guide for Containerized Red Hat Gluster Storage in OpenShift Enterprise Subtitle: Deploying Containerized Red Hat Gluster Storage in OpenShift Enterprise
(In reply to khartsoe from comment #31) > The team gave approval to the docs but the last 2 changes we need ASAP are > the following: > > CHANGE #1 > > In Section "4.1. Preparing the Red Hat OpenShift Enterprise Cluster" > > Move all of Step 1: > > On each of the OpenShift nodes that will host the Red Hat Gluster Storage > container, add the following rules to /etc/sysconfig/iptables in order to > open the required ports: > > -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 24007 -j > ACCEPT > -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 24008 -j > ACCEPT > -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 2222 -j > ACCEPT > -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m multiport --dports > 49152:49664 -j ACCEPT > > Execute the following command to reload the iptables: > > # systemctl reload iptables > > > from "4.1. Preparing the Red Hat OpenShift Enterprise Cluster" to "3.2.3. > Red Hat OpenShift Enterprise Requirements" as its own separate bullet after > "The OpenShift cluster must be up and running." bullet but before the "The > OpenShift router must be created and the DNS must be setup. For more > information see, Appendix A, OpenShift Router Setup" bullet. > > > > CHANGE #2 > > Update the title and subtitle to the following text: > > Title: Deployment Guide for Containerized Red Hat Gluster Storage in > OpenShift Enterprise > Subtitle: Deploying Containerized Red Hat Gluster Storage in OpenShift > Enterprise Hi Ken, Comment 1 is addressed. Comment 2 of changing the title is still under progress. Following is the updated bug: http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#chap-Documentation-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage-Setting_the_environment-Preparing_RHOE
Hello Jeff, Following is the updated link to the "Deployment Guide for Containerized Red Hat Gluster Storage" guide: http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html Apart from the change of title suggestion in comment 31 (which will be addressed in a while), all the other comments are addressed in the documentation. You can use this document for your reference and let me know if you have any questions. Thanks, Bhavana
(In reply to khartsoe from comment #31) > The team gave approval to the docs but the last 2 changes we need ASAP are > the following: > > CHANGE #1 > > In Section "4.1. Preparing the Red Hat OpenShift Enterprise Cluster" > > Move all of Step 1: > > On each of the OpenShift nodes that will host the Red Hat Gluster Storage > container, add the following rules to /etc/sysconfig/iptables in order to > open the required ports: > > -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 24007 -j > ACCEPT > -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 24008 -j > ACCEPT > -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m tcp --dport 2222 -j > ACCEPT > -A OS_FIREWALL_ALLOW -p tcp -m state --state NEW -m multiport --dports > 49152:49664 -j ACCEPT > > Execute the following command to reload the iptables: > > # systemctl reload iptables > > > from "4.1. Preparing the Red Hat OpenShift Enterprise Cluster" to "3.2.3. > Red Hat OpenShift Enterprise Requirements" as its own separate bullet after > "The OpenShift cluster must be up and running." bullet but before the "The > OpenShift router must be created and the DNS must be setup. For more > information see, Appendix A, OpenShift Router Setup" bullet. > > > > CHANGE #2 > > Update the title and subtitle to the following text: > > Title: Deployment Guide for Containerized Red Hat Gluster Storage in > OpenShift Enterprise > Subtitle: Deploying Containerized Red Hat Gluster Storage in OpenShift > Enterprise Change #2 has been incorporated and here's the updated doc: http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html
The latest updates are included in the following link: http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#chap-Documentation-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage-Introduction_Containerized_RHGS
(In reply to Bhavana from comment #33) > Hello Jeff, > > Following is the updated link to the "Deployment Guide for Containerized Red > Hat Gluster Storage" guide: > > http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage- > 3.1-Deployment_Guide_for_Containerized_Red_Hat_Gluster_Storage%20%28html- > single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html > > Apart from the change of title suggestion in comment 31 (which will be > addressed in a while), all the other comments are addressed in the > documentation. You can use this document for your reference and let me know > if you have any questions. > > Thanks, > Bhavana Hello Bhavana, The doc looks pretty good now. I have a couple of comments: 1) Section 3.2.3: second bullet are the itables rules which are not needed at this point in the doc since they are only needed once the reader is getting ready to run gluster. However, if you leave the iptables rules where they are then the last bullet in that section is wrong: "Ensure the nodes have the valid ports opened for communicating with Red Hat Gluster Storage. See the iptables configuration task in Step 1 of Section 4.1, “Preparing the Red Hat OpenShift Enterprise Cluster” for more information. " The links takes you to "4.1. Preparing the Red Hat OpenShift Enterprise Cluster" which contains nothing about the gluster ports. I do not think you need this last bullet in section 3.2.3 since you have just mentioned the iptables rules a few bullets earlier in the same section. 2) section 4.1.3.b: "# oadm router storage-project-router --replicas=1". Is the router's name "storage-project-router" based on the project name? If yes then you might want do show this as you have in many other examples with the generic command first followed by a specific example: Eg. # oadm router <router-name> --replicas=1 For example: # oadm router storage-project-router --replicas=1 3) section 4.1.3.b: can you add a sentence on the purpose of the subdomain? Can the user make up any name they want? Is it related at all to LDAP setups? 4) section 4.4: formatting of beginning of sample json file is off: { "clusters": [ { "nodes": [ { #<---- indented too far to the right "node": { ... That is as far as I got in my testing... Jeff
There are some changes suggested in the comment #40. Based on that moving it back.
Jeff, It will be good if you can change the state of the bug to "VERIFIED" once all the changes you want are incorporated in to the doc.
(In reply to Anoop from comment #42) > Jeff, > > It will be good if you can change the state of the bug to "VERIFIED" once > all the changes you want are incorporated in to the doc. I will do that after reviewing the next iteration of the doc, thanks for the reminder.
(In reply to Jeff Vance from comment #44) > (In reply to Anoop from comment #42) > > Jeff, > > > > It will be good if you can change the state of the bug to "VERIFIED" once > > all the changes you want are incorporated in to the doc. > > I will do that after reviewing the next iteration of the doc, thanks for the > reminder. Just for the record, I do not consider any of my comments regarding the doc to be blockers.
Verified based on the discussions in the program meeting. All new changes will be taken up in the next release.