doc: Managing the glusterd2 service #1051

aravindavk · 2018-07-20T07:08:20Z

Content mostly from glusterfs documentation, changed to suit glusterd2.

Additionally added "gluster" group creation step and systemctl commands

Updates: #891
Signed-off-by: Aravinda VK [email protected]

Content mostly from glusterfs documentation, changed to suit glusterd2. Additionally added "gluster" group creation step and `systemctl` commands Updates: #891 Signed-off-by: Aravinda VK <[email protected]>

aravindavk · 2018-07-20T07:11:28Z

Glusterfs documentation page(glusterd1): https://docs.gluster.org/en/latest/Administrator%20Guide/Start%20Stop%20Daemon/

harigowtham · 2018-07-20T08:53:45Z

doc/managing-the-glusterd2-service.md

+# Managing the glusterd Service
+
+After installing GlusterFS and Glusterd2, you must start `glusterd2`
+service. The glusterd2 service serves as the Gluster elastic volume


From the second line, we are going to repeat stuff. As per the new doc, we are going to give them an insight about glusterd before reaching here. Its needed in the beginning for them to get a better understanding. If its in the beginning, this will be a repetition. will use the same snippet there.

Setup and install is out of scope for this page. This page is for post installation steps

Yes. i understand that setup & install is out of scope, @rishubhjain is working on that part. even before setup, we are thinking of explaining about glusterd.
if someone who is new to glusterd lands in github, we want him/her to understand what glusterd2 and then go ahead seeing the setup, installation, starting it and so on. So i felt explaining glusterd wasn't necessary here after the postinstall step.

@harigowtham I think we should give a brief introduction on what is glusterd2 in the user guide and then provide a link to an extended explanation, else the doc will be too long and might be not very user-friendly to someone who already knows what glusterd2 is.

yes. we have planned to give only a brief introduction. detailed introduction will be given as a link to the docs (https://docs.gluster.org/en/latest/) once the documetation for gd2 is available. The point i wanted to convey here is, adding the explanation about gd2 again and again will make this less user friendly because of repetition. so we can remove it here.

I'd suggest that we move away from the tone/approach that includes "you will ..." etc and into "needs to be..." For instance, the first line should read "After completing installation of GlusterFS and GlusterD2, glusterd2 needs to be restarted using "

harigowtham · 2018-07-20T08:53:49Z

doc/managing-the-glusterd2-service.md

+
+ # systemctl status glusterd2
+
+To check the Cluster status, run the following command from one of the


this section can go into a separate doc where we would have explained about peers and probing?

makes sense, I will remove this

harigowtham · 2018-07-20T08:56:02Z

doc/managing-the-glusterd2-service.md

+
+**Note**: Create "gluster" group before starting `glusterd2`
+
+## Starting and Stopping glusterd2 Manually


Do we have to talk about starting from binaries? Need more thoughts here.
Thought of documenting how to install from rpm as well as the binaries. Do we need to have this as well or is it better to put that section as a separate link?

I prefer not to mention about running binaries directly. It may lead to different non-standard configuration(No config file or different values in custom config file).

Also glusterd2 binary will not demonize by default, that may become issues.

We thought of explaining that as well but that will make the doc complicated. @rishubhjain we need to make sure of this.

It may make sense to adjust the title to read "Starting and Stopping glusterd2 Service Manually" and then there's less of a reason to mention binaries as systemd will be the most typical way to start and stop services on most of the systems where glusterd2 is installed (standalone).

Anyone running glusterd2 standalone with something that isn't systemd is kind of on their own IMO but they ought to be used to managing services with whatever they have anyway.

rishubhjain · 2018-07-20T13:03:05Z

doc/managing-the-glusterd2-service.md

+volume operations, such as adding and removing volumes across multiple
+storage servers non-disruptively.
+
+This section describes how to start the glusterd2 service in the


I think this statement needs a re-phrase, and I think this section does more than describing "how to start the service."

rishubhjain · 2018-07-20T13:09:54Z

doc/managing-the-glusterd2-service.md

+
+## Starting and Stopping glusterd2 Manually
+
+This section describes how to start and stop glusterd2 manually


Redundant, the title is self-explanatory.

phlogistonjohn · 2018-07-23T17:08:09Z

doc/managing-the-glusterd2-service.md

+
+## Gluster user group
+
+On each server nodes, create "gluster" user group if not exists


"On each server node" or "On all server nodes"

"if not not exists already" -> "if it does not already exist"

phlogistonjohn · 2018-07-23T17:08:45Z

doc/managing-the-glusterd2-service.md

+
+ # groupadd gluster
+
+Users from this group can run `glustercli` commands in GlusterFS


Nit: It seems more idomatic to me to say "on GlusterFS servers" rather than "in"

doc: Managing the glusterd2 service

ad5006e

Content mostly from glusterfs documentation, changed to suit glusterd2. Additionally added "gluster" group creation step and `systemctl` commands Updates: #891 Signed-off-by: Aravinda VK <[email protected]>

aravindavk requested review from prashanthpai, rishubhjain, harigowtham and Madhu-1 July 20, 2018 07:08

harigowtham reviewed Jul 20, 2018

View reviewed changes

rishubhjain reviewed Jul 20, 2018

View reviewed changes

phlogistonjohn reviewed Jul 23, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Managing the glusterd2 service #1051

doc: Managing the glusterd2 service #1051

aravindavk commented Jul 20, 2018

aravindavk commented Jul 20, 2018

harigowtham Jul 20, 2018

aravindavk Jul 20, 2018

harigowtham Jul 20, 2018

rishubhjain Jul 20, 2018

harigowtham Jul 23, 2018

sankarshanmukhopadhyay Jul 24, 2018

harigowtham Jul 20, 2018

aravindavk Jul 20, 2018

harigowtham Jul 20, 2018

aravindavk Jul 20, 2018

harigowtham Jul 20, 2018

phlogistonjohn Jul 23, 2018

rishubhjain Jul 20, 2018

rishubhjain Jul 20, 2018

phlogistonjohn Jul 23, 2018

phlogistonjohn Jul 23, 2018

sankarshanmukhopadhyay Jul 24, 2018


		# systemctl status glusterd2

		To check the Cluster status, run the following command from one of the


		Note: Create "gluster" group before starting `glusterd2`

		## Starting and Stopping glusterd2 Manually


		## Starting and Stopping glusterd2 Manually

		This section describes how to start and stop glusterd2 manually


		## Gluster user group

		On each server nodes, create "gluster" user group if not exists


		# groupadd gluster

		Users from this group can run `glustercli` commands in GlusterFS

doc: Managing the glusterd2 service #1051

Are you sure you want to change the base?

doc: Managing the glusterd2 service #1051

Conversation

aravindavk commented Jul 20, 2018

aravindavk commented Jul 20, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment