[Debian-ha-commits] [ocfs2-tools] 01/01: Update Debian documentation

[Valentin Vidic]

This is an automated email from the git hooks/post-receive script.

vvidic-guest pushed a commit to branch master
in repository ocfs2-tools.

commit 14f71e8f4b353d3364db532391fc78f1a53d1bdc
Author: Valentin Vidic <Valentin.Vidic at CARNet.hr>
Date:   Tue Jul 12 22:36:40 2016 +0200

    Update Debian documentation
---
 debian/NEWS.Debian   | 13 +++++++++
 debian/README.Debian | 79 +++++++++++++++++++++++++++++++++-------------------
 debian/changelog     |  4 ++-
 3 files changed, 66 insertions(+), 30 deletions(-)

diff --git a/debian/NEWS.Debian b/debian/NEWS.Debian
new file mode 100644
index 0000000..ea6e202
--- /dev/null
+++ b/debian/NEWS.Debian
@@ -0,0 +1,13 @@
+ocfs2-tools (1.8.4-2) unstable; urgency=medium
+
+  Nodes using systemd now require additional fstab options for
+  the filesystem to mount automatically on boot:
+
+    /dev/sdc1 /srv ocfs2 _netdev,x-systemd.requires=o2cb.service 0 0
+
+  Option _netdev is required to mount the filesystem by the
+  remote-fs.target, while the x-systemd.requires option starts
+  the cluster service before the filesystem (this option is
+  available since systemd v220).
+
+ -- Valentin Vidic <Valentin.Vidic at CARNet.hr>  Tue, 12 Jul 2016 22:26:31 +0200
diff --git a/debian/README.Debian b/debian/README.Debian
index 06243f3..3f52d01 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -1,41 +1,62 @@
 Instructions for OCFS2 filesystems in Debian
 ============================================
 
-1. Setup instructions
----------------------
+1. Cluster setup
+----------------
+
+You need to create a configuration file /etc/ocfs2/cluster.conf
+describing your cluster.  The most basic example includes two nodes
+in a cluster named ocfs2:
+
+cluster:
+        node_count = 2
+        name = ocfs2
+
+node:
+        number = 1
+        cluster = ocfs2
+        ip_port = 7777
+        ip_address = 192.168.1.1
+        name = node1
+
+node:
+        number = 2
+        cluster = ocfs2
+        ip_port = 7777
+        ip_address = 192.168.1.2
+        name = node2
+
+This cluster uses the TCP port 7777 for cluster communication and
+a local heartbeat mode (one disk heartbeat per OCFS2 filesystem).
+Make sure the node names listed in the configuration match the
+hostnames configured on the nodes.
+
+Next, reconfigure ocfs2-tools to enable the cluster service:
 
-You will need to create a configuration file describing your cluster
-called /etc/ocfs2/cluster.conf. An example is provided in:
+  dpkg-reconfigure ocfs2-tools
 
-  /usr/share/doc/ocfs2-tools/examples/cluster.conf
+Finally, restarting the o2cb service will load the required
+kernel modules and start the cluster service:
 
-Next, reconfigure ocfs2-tools to start the cluster at boot time by
-running:
-  
-  dpkg-reconfigure ocfs2-tools
+  service o2cb restart
+
+2. Filesystem setup
+-------------------
 
-2. Kernel modules
------------------
+When the cluster is running, OCFS2 filesystem can be created on a
+shared disk device:
 
-The init script for Debian expects to have most of the kernel code
-it uses available in modular form.
+  mkfs.ocfs2 --cluster-stack=o2cb --cluster-name=ocfs2 /dev/sdc1
 
-In previous releases sctp module was necessary to work around a
-kernel starvation that led to crashes.  With 1.2.1 this seems to be
-no longer necessary.
+Now, you should be able to mount the filesystem on both cluster
+nodes. Note that nodes using systemd require additional fstab
+options for the filesystem to mount automatically on boot:
 
-Here follows the name and location of the modules:
+  /dev/sdc1 /srv ocfs2 _netdev,x-systemd.requires=o2cb.service 0 0
 
-Module name             Location
---------------------------------
-configfs                File systems
-                         -> Pseudo filesystems
-                          -> Userspace-driven configuration filesystem
-ocfs2_nodemanager       File systems
-                         -> OCFS2 file system support
-ocfs2_dlm               File systems
-                         -> OCFS2 file system support
-ocfs2_dlmfs             File systems
-                         -> OCFS2 file system support
+Option _netdev is required to mount the filesystem by the
+remote-fs.target, while the x-systemd.requires option starts
+the cluster service before the filesystem (this option is
+available since systemd v220).
 
- -- Jeremy Lainé <jeremy.laine at m4x.org>  Fri, 21 Nov 2008 08:08:08 +0100
+ -- Valentin Vidic <Valentin.Vidic at CARNet.hr>  Tue, 12 Jul 2016 22:26:31 +0200
diff --git a/debian/changelog b/debian/changelog
index 0389dd4..c2030a4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -7,8 +7,10 @@ ocfs2-tools (1.8.4-2) unstable; urgency=medium
   * Move init scripts out of rcS (Closes: #796638)
   * Start storage services before ocfs2 (Closes: #723093)
   * debian/tests: o2cb service startup
+  * Add global heartbeat support for virtio devices
+  * Update Debian documentation
 
- -- Valentin Vidic <Valentin.Vidic at CARNet.hr>  Fri, 08 Jul 2016 11:57:12 +0200
+ -- Valentin Vidic <Valentin.Vidic at CARNet.hr>  Tue, 12 Jul 2016 22:26:31 +0200
 
 ocfs2-tools (1.8.4-1) unstable; urgency=medium
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-ha/ocfs2-tools.git