Skip to content
This repository has been archived by the owner on Mar 26, 2020. It is now read-only.

doc: Managing the glusterd2 service #1051

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc: Managing the glusterd2 service #1051

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions doc/managing-the-glusterd2-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Managing the glusterd Service

After installing GlusterFS and Glusterd2, you must start `glusterd2`
service. The glusterd2 service serves as the Gluster elastic volume
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 "

manager, overseeing glusterfs processes, and co-ordinating dynamic
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

following ways:

**Note**: You must start glusterd2 on all GlusterFS servers.

## Gluster user group

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

already using the following command.

# groupadd gluster

Users from this group can run `glustercli` commands in GlusterFS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree.

servers.

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

## Starting and Stopping glusterd2 Manually
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


This section describes how to start and stop glusterd2 manually
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Redundant, the title is self-explanatory.


To start glusterd2 manually, enter the following command:

# systemctl start glusterd2

To stop glusterd2 manually, enter the following command:

# systemctl stop glusterd2

## Starting glusterd Automatically

This section describes how to configure the system to automatically
start the glusterd2 service every time the system boots.

# systemctl enable glusterd2

## Status

Check the status of `glusterd2` using,

# systemctl status glusterd2

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense, I will remove this

GlusterFS server.

# glustercli peer status