Updating quick user guide #1076

rishubhjain · 2018-07-27T04:00:09Z

Closes : #1058

prashanthpai · 2018-07-27T04:10:52Z

doc/quick-start-user-guide.md

+```sh
+# yum install rpcbind
+```
+For other distors please install rpcbind and then follow the steps given below.


rpcbind is no longer needed for glusterd2

@prashanthpai I had a discussion with @kshlm regarding same, as he suggested I needed to check with others before removing it. Will remove it. and update the PR

prashanthpai · 2018-07-27T04:12:21Z

doc/quick-start-user-guide.md

-binaries of the latest release. Like all Go programs, glusterd2 is a single
-binary (statically linked) without external dependencies. You can download the
-[latest release](https://github.com/gluster/glusterd2/releases) from Github.
+For other distros, you can download binaries of the [latest release](https://github.com/gluster/glusterd2/releases) from Github. 


I really do not see how this change fixes or improves anything

Fedora does not come under "non-rpm distros", but to install glusterd2 in Fedora we need to use binaries, so it is better to mention just distros to make it more generalized.

prashanthpai · 2018-07-27T04:13:17Z

doc/quick-start-user-guide.md

@@ -71,9 +77,41 @@ etcdcurls = "http://192.168.56.101:2379"
 etcdpurls = "http://192.168.56.101:2380"
 ```

+**Authentication:** In glusterd2 REST API authentication is enabled by default. To disable rest authentication add `restauth=false` in Glusterd2 config file(Default path is


Except when you have links, documentation in markdown shouldn't exceed 80 character limit.

prashanthpai · 2018-07-27T04:13:59Z

doc/quick-start-user-guide.md

@@ -71,9 +77,41 @@ etcdcurls = "http://192.168.56.101:2379"
 etcdpurls = "http://192.168.56.101:2380"
 ```

+**Authentication:** In glusterd2 REST API authentication is enabled by default. To disable rest authentication add `restauth=false` in Glusterd2 config file(Default path is


The default path of config file should be a separate subsection that comes before Authentication section

prashanthpai · 2018-07-27T04:15:07Z

doc/quick-start-user-guide.md

-**Start glusterd2 process:** Glusterd2 is not a daemon and currently can run only in the foreground.
+### Running glusterd2 for RPM installation
+
+**Enable glusterd2 service:** To enable glusterd2 service run:


Enabling can mean anything. Please mention that this command is to ensure glusterd2 service starts automatically when the system starts

prashanthpai · 2018-07-27T04:15:38Z

doc/quick-start-user-guide.md

+```
+Please ensure that glusterd2 service status is "active (runnning)" before proceeding.
+
+**Authentication:** In glusterd2, REST API authentication is enabled by default. To disable rest authentication add `restauth=false` in Glusterd2 config file(`/var/lib/glusterd2/glusterd2.toml`)


This is present twice.

made the changes.

…er_guide

rishubhjain · 2018-08-02T19:04:01Z

@prashanthpai @aravindavk @Madhu-1 Please review

harigowtham

I had a few questions. have raised them as a comment. If they arent valid, do let me know.

And from line 97 in the existing code, can we have that line above the commands like add peer and stuff. It has instructions about rest and cli which to all commands. This will make it clearer.

harigowtham · 2018-08-08T10:58:08Z

doc/quick-start-user-guide.md

+etcdendpoints = "http://[ip_address]:[port]"
+noembed = true
+```
+Provide ip-address and port of node where etcd is running.


Can we point them to the link where they can find how to set up external etcd?

Right now do we have any documentation related to external etcd?

harigowtham · 2018-08-08T11:00:35Z

doc/quick-start-user-guide.md

+
+```sh
+# systemctl restart glusterd2
+```


do we have to mention it for binaries as well?

yes, will do that. For binaries I think we will have to stop the glusterd2 if already running, and then start it with same command.

harigowtham · 2018-08-08T11:04:54Z

doc/development-guide.md

@@ -71,7 +71,7 @@ Once your PR has has been submitted for review the following critieria will need
 * Each PR needs reviews accepting the change from at least two developers for merging
  * It is common to request reviews from those reviewers automatically suggested by github
 * Each PR needs to have been open for at least 24 working hours to allow for community feedback
-  * The 24 working hours counts hours occuring Mon-Fri in the local timezone of the submitter
+  * The 24 working hours counts hours occurring Mon-Fri in the local timezone of the submitter
 * Each PR must be fully updated to master and tests must have passed

 When the criteria are met a project maintainer can merge your changes into the project's master branch.


nit: When the criteria are met, a project maintainer ...

harigowtham · 2018-08-08T11:14:54Z

doc/quick-start-user-guide.md

+```
+
+### Output
+
 You will see an output similar to the following:


I think we dont get an output like this if we use RPMs or if we mention the log file. Can you verify that and change this accordingly?

ok, I will check.

harigowtham · 2018-08-08T11:16:41Z

doc/quick-start-user-guide.md


 ```sh
 # ./glusterd2 --config conf.toml
 ```

+### Authentication
+


Is there any step to be performed while using the default authentication? I remember having messed up something here so that i had to turn it off. If yes, can you mention that?

for using the default authentication they will have to go through the authentication document #1021, IMO in quick user guide we should help users in using GD2 with minimal setup efforts.

sankarshanmukhopadhyay

small set of changes requested.

sankarshanmukhopadhyay · 2018-08-08T11:26:20Z

doc/development-guide.md

@@ -71,7 +71,7 @@ Once your PR has has been submitted for review the following critieria will need
 * Each PR needs reviews accepting the change from at least two developers for merging
  * It is common to request reviews from those reviewers automatically suggested by github


GitHub (in place of github)

sankarshanmukhopadhyay · 2018-08-08T11:27:26Z

doc/quick-start-user-guide.md


-### Running glusterd2
+### Custom configuration for glusterd2 [Optional Step].

 **Create a working directory:** This is where glusterd2 will store all data which includes logs, pid files, etcd information etc. For this example, we will be using a temporary path. If a working directory is not specified, it defaults to current directory.


For the purposes of this example,

sankarshanmukhopadhyay · 2018-08-08T11:28:45Z

doc/quick-start-user-guide.md


 ```sh
 # ./glusterd2 --config conf.toml
 ```

+### Authentication
+
+In glusterd2, REST API authentication is enabled by default. To disable rest authentication add `restauth=false` in Glusterd2 config file(`/etc/glusterd2/glusterd2.toml`) or the custom config file provided by you (conf.toml as per above example)


Is this something that is recommended? If not, perhaps it is prudent to add a disclaimer like "the developers would recommend that the ReST API authentication is not disabled"

IMO sure will add the disclaimer, but IMO for the pupose of speeding up the setup, its better to let user disable the authentication for trying out GD2.

…er_guide Conflicts: doc/quick-start-user-guide.md

prashanthpai · 2018-08-20T06:04:21Z

doc/quick-start-user-guide.md

-**Create a working directory:** This is where glusterd2 will store all data which includes logs, pid files, etcd information etc. For this example, we will be using a temporary path. If a working directory is not specified, it defaults to current directory.
+### Custom configuration for glusterd2 [Optional].
+
+**Create a working directory:** This is where glusterd2 will store all data which includes logs, pid files, etcd information etc. For the purposes of this example, we will be using a temporary path. If a working directory is not specified, it defaults to current directory.


There's no such thing as working directory anymore. The location of logs and pid files can be different.

prashanthpai · 2018-08-20T06:05:21Z

doc/development-guide.md

@@ -69,12 +69,12 @@ If you are planning on making a large set of changes or a major architectural ch
 **Review Process:**
 Once your PR has has been submitted for review the following critieria will need to be met before it will be merged:
 * Each PR needs reviews accepting the change from at least two developers for merging
-  * It is common to request reviews from those reviewers automatically suggested by github
+  * It is common to request reviews from those reviewers automatically suggested by GitHub


The title of PR needs to be more accurate and concise. Titles such as Updating quick user guide don't give a any useful information to reviewers. This applies to commit messages as well.

prashanthpai · 2018-08-20T06:09:15Z

doc/quick-start-user-guide.md

-**Start glusterd2 process:** Glusterd2 is not a daemon and currently can run only in the foreground.
+### Using external etcd instead of embedded etcd.
+
+By default glusterd2 uses embedded etcd, but glusterd2 also supports usage of external etcd.


The tone of this section must reflect that external etcd is the default and is the recommended way and supported way. It currently says otherwise.

prashanthpai · 2018-08-20T06:10:02Z

doc/quick-start-user-guide.md

+
+By default glusterd2 uses embedded etcd, but glusterd2 also supports usage of external etcd.
+
+To provide external etcd details. Edit glusterd2 config file by adding `noembed` option and specifying


A sentence cannot begin with To provide external etcd details and just end there ;)

prashanthpai · 2018-08-20T06:11:15Z

doc/quick-start-user-guide.md

+To provide external etcd details. Edit glusterd2 config file by adding `noembed` option and specifying
+the etcd endpoint:
+
+```toml


It's also useful to tell what file this is.

prashanthpai · 2018-08-20T06:11:50Z

doc/quick-start-user-guide.md

+etcdendpoints = "http://[ip_address]:[port]"
+noembed = true
+```
+Provide ip-address and port of node where etcd is running.


This is vague. What needs to be provided here is the etcd client URL.

prashanthpai · 2018-08-20T06:12:05Z

doc/quick-start-user-guide.md

+```
+
+Check the status of glusterd2 service:
+


prashanthpai · 2018-08-20T06:12:12Z

doc/quick-start-user-guide.md

+```
+
+**Start glusterd2 service:** To start glusterd2 process run:
+


prashanthpai · 2018-08-20T06:13:42Z

doc/quick-start-user-guide.md

+
+### Running glusterd2 for RPM installation
+
+**Enable glusterd2 service:** Enable glusterd2 service to ensure that glusterd2 service starts automatically when system starts.


There's no meaning to enable glusterd2 service, it's just that systemctl operation is named so.

To ensure..., run:

…er_guide

prashanthpai suggested changes Jul 27, 2018

View reviewed changes

rishubhjain force-pushed the user_guide branch from 09e1139 to 6a15d19 Compare July 27, 2018 04:29

rishubhjain added 2 commits August 2, 2018 14:58

Updating quick user guide

0138559

Merge branch 'master' of https://github.com/gluster/glusterd2 into us…

be5b31c

…er_guide

rishubhjain force-pushed the user_guide branch from b9ba3ef to be5b31c Compare August 2, 2018 18:58

rishubhjain changed the title ~~[WIP] Updating quick user guide~~ Updating quick user guide Aug 2, 2018

harigowtham reviewed Aug 8, 2018

View reviewed changes

sankarshanmukhopadhyay suggested changes Aug 8, 2018

View reviewed changes

Merge branch 'master' of https://github.com/gluster/glusterd2 into us…

c1a178b

…er_guide Conflicts: doc/quick-start-user-guide.md

rishubhjain force-pushed the user_guide branch from 5212264 to b5392ce Compare August 14, 2018 05:33

prashanthpai suggested changes Aug 20, 2018

View reviewed changes

rishubhjain added 2 commits August 20, 2018 03:25

Merge branch 'master' of https://github.com/gluster/glusterd2 into us…

97ccebb

…er_guide

Merge branch 'master' of https://github.com/gluster/glusterd2 into us…

095df04

…er_guide

rishubhjain force-pushed the user_guide branch from b5392ce to 095df04 Compare August 20, 2018 07:25

atinmu mentioned this pull request Oct 7, 2018

Not able to run glusterd2 with the documentation steps (2 Node cluster) #1058

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating quick user guide #1076

Updating quick user guide #1076

rishubhjain commented Jul 27, 2018

prashanthpai Jul 27, 2018

rishubhjain Jul 27, 2018

prashanthpai Jul 27, 2018

rishubhjain Aug 2, 2018

prashanthpai Jul 27, 2018

prashanthpai Jul 27, 2018

prashanthpai Jul 27, 2018

prashanthpai Jul 27, 2018

rishubhjain Aug 2, 2018

rishubhjain commented Aug 2, 2018

harigowtham left a comment

harigowtham Aug 8, 2018

rishubhjain Aug 10, 2018

harigowtham Aug 8, 2018

rishubhjain Aug 10, 2018

harigowtham Aug 8, 2018

harigowtham Aug 8, 2018

rishubhjain Aug 10, 2018

harigowtham Aug 8, 2018

rishubhjain Aug 10, 2018 •

edited

Loading

sankarshanmukhopadhyay left a comment

sankarshanmukhopadhyay Aug 8, 2018

sankarshanmukhopadhyay Aug 8, 2018

sankarshanmukhopadhyay Aug 8, 2018

rishubhjain Aug 23, 2018

prashanthpai Aug 20, 2018

prashanthpai Aug 20, 2018

prashanthpai Aug 20, 2018

prashanthpai Aug 20, 2018

prashanthpai Aug 20, 2018

prashanthpai Aug 20, 2018

prashanthpai Aug 20, 2018

prashanthpai Aug 20, 2018

prashanthpai Aug 20, 2018

		@@ -71,7 +71,7 @@ Once your PR has has been submitted for review the following critieria will need
		* Each PR needs reviews accepting the change from at least two developers for merging
		* It is common to request reviews from those reviewers automatically suggested by github


		By default glusterd2 uses embedded etcd, but glusterd2 also supports usage of external etcd.

		To provide external etcd details. Edit glusterd2 config file by adding `noembed` option and specifying

		```

		Start glusterd2 service: To start glusterd2 process run:


		### Running glusterd2 for RPM installation

		Enable glusterd2 service: Enable glusterd2 service to ensure that glusterd2 service starts automatically when system starts.

Updating quick user guide #1076

Are you sure you want to change the base?

Updating quick user guide #1076

Conversation

rishubhjain commented Jul 27, 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

rishubhjain commented Aug 2, 2018

harigowtham left a 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

rishubhjain Aug 10, 2018 • edited Loading

Choose a reason for hiding this comment

sankarshanmukhopadhyay left a 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

rishubhjain Aug 10, 2018 •

edited

Loading