doc: Update INSTALL file

- Add LibQB and Knet links
- Remove old (pre udpu) config file example
- Change corosync.conf man page to contain useful information about
token timeout

Signed-off-by: Jan Friesse <jfriesse@redhat.com>
Reviewed-by: Fabio M. Di Nitto <fdinitto@redhat.com>
Reviewed-by: Christine Caulfield <ccaulfie@redhat.com>
This commit is contained in:
Jan Friesse 2019-01-16 14:39:42 +01:00
parent 03d9321bc8
commit ce29717491
2 changed files with 12 additions and 51 deletions

58
INSTALL
View File

@ -43,7 +43,8 @@ balance:~/corosync# make install
* A notice about dependencies *
-------------------------------
We have strived very hard to avoid dependencies as much as possible, but there
are two required libraries: LibQB and KNET.
are two required libraries: LibQB (https://github.com/ClusterLabs/libqb)
and KNET (https://kronosnet.org/).
Optional dependencies are support for DBUS, SNMP and libstatgrab.
@ -102,54 +103,11 @@ And you should get traps
------------------------
* Configuring Corosync *
------------------------
The corosync executive will automatically determine cluster membership by
communicating on a specified multicast address and port.
The directory conf contains the file corosync.conf.example
# Please read the corosync.conf.5 manual page
totem {
version: 2
secauth: off
threads: 0
interface {
ringnumber: 0
bindnetaddr: 192.168.1.1
mcastaddr: 226.94.1.1
mcastport: 5405
}
}
logging {
fileline: off
to_stderr: yes
to_file: yes
to_syslog: yes
logfile: /tmp/corosync.log
debug: off
timestamp: on
}
The totem section contains three values. All three values must be set
or the corosync executive wll exit with an error.
bindnetaddr specifies the address which the corosync Executive should bind to.
This address should always end in zero. If the local interface taffic
should routed over is 192.168.5.92, set bindnetaddr to 192.168.5.0.
mcastaddr is a multicast address. The default should work but you may have
a different network configuration. Avoid 224.x.x.x because this is a "config"
multicast address.
mcastport specifies the UDP port number. It is possible to use the same
multicast address on a network with the corosync services configured for
different UDP ports.
The timeout section contains seven values. This section is not normally used,
but rather used to override the program defaults for the purposes of fine
tuning for a given networking/processor combination or for debugging purposes.
Be careful to use the same timeout values on each of the nodes in the cluster
or unpredictable results may occur.
The configuration directory (usually /etc/corosync) contains an example
configuration file (corosync.conf.example). Please copy it as corosync.conf
and edit it as needed. At the very minimum, the nodelist section will have to be changed
to list all cluster nodes. For more information about the configuration file
please read the corosync.conf.5 manual page.
Generate a private key
----------------------
@ -161,7 +119,7 @@ First generate the key on one of the nodes:
balance# corosync-keygen
Corosync Authentication key generator.
Gathering 1024 bits for key from /dev/random.
Gathering 8192 bits for key from /dev/random.
Writing corosync key to /etc/corosync/authkey.
After this is complete, a private key will be in the file /etc/corosync/authkey.

View File

@ -32,7 +32,7 @@
.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" * THE POSSIBILITY OF SUCH DAMAGE.
.\" */
.TH COROSYNC_CONF 5 2019-01-10 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.TH COROSYNC_CONF 5 2019-01-16 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
corosync.conf - corosync executive configuration file
@ -347,6 +347,9 @@ For real token timeout used by totem it's possible to read cmap value of
.B runtime.config.totem.token
key.
Be careful to use the same timeout values on each of the nodes in the cluster
or unpredictable results may occur.
The default is 1000 milliseconds.
.TP