ctdb-web: Trim web documentation, point to wiki
authorMartin Schwenke <martin@meltin.net>
Wed, 4 May 2016 21:21:04 +0000 (07:21 +1000)
committerAmitay Isaacs <amitay@gmail.com>
Fri, 21 Oct 2016 07:01:00 +0000 (18:01 +1100)
Signed-off-by: Martin Schwenke <martin@meltin.net>
web/building.html [deleted file]
web/configuring.html [deleted file]
web/documentation.html
web/download.html [deleted file]
web/header.html
web/index.html
web/nfs.html [deleted file]
web/prerequisites.html [deleted file]

diff --git a/web/building.html b/web/building.html
deleted file mode 100644 (file)
index 7475078..0000000
+++ /dev/null
@@ -1,42 +0,0 @@
-<!--#set var="TITLE" value="Building CTDB" -->
-<!--#include virtual="header.html" -->
-
-<H2 align="center">Building CTDB and Samba</h2>
-
-<h2>CTDB</h2>
-To build a copy of CTDB code from a git tree you should do this:
-<pre>
-   cd ctdb
-   ./autogen.sh
-   ./configure
-   make
-   make install
-</pre>
-
-To build a copy of CTDB code from a tarball you should do this:
-<pre>
-   tar xf ctdb-x.y.tar.gz
-   cd ctdb-x.y
-   ./configure
-   make
-   make install
-</pre>
-You need to install ctdb on all nodes of your cluster.
-
-
-<h2>Samba3</h2>
-
-To build a copy of Samba3 with clustering and ctdb support you should do this:
-<pre>
-    cd samba_3_0_ctdb/source
-    ./autogen.sh
-    ./configure --with-ctdb=/usr/src/ctdb --with-cluster-support --enable-pie=no
-    make proto
-    make
-</pre>
-
-Once compiled, you should install Samba on all cluster nodes.<br><br>
-
-The /usr/src/ctdb path should be replaced with the path to the ctdb sources that you downloaded above.
-
-<!--#include virtual="footer.html" -->
diff --git a/web/configuring.html b/web/configuring.html
deleted file mode 100644 (file)
index b827290..0000000
+++ /dev/null
@@ -1,202 +0,0 @@
-<!--#set var="TITLE" value="Configuring CTDB" -->
-<!--#include virtual="header.html" -->
-
-<H2 align="center">Configuring CTDB</H2>
-
-<h2>Clustering Model</h2>
-
-The setup instructions on this page are modelled on setting up a cluster of N 
-nodes that function in nearly all respects as a single multi-homed node. 
-So the cluster will export N IP interfaces, each of which is equivalent 
-(same shares) and which offers coherent CIFS file access across all 
-nodes.<p>
-
-The clustering model utilizes IP takeover techniques to ensure that
-the full set of public IP addresses assigned to services on the
-cluster will always be available to the clients even when some nodes
-have failed and become unavailable.
-
-<h2>CTDB Cluster Configuration</h2>
-
-These are the primary configuration files for CTDB.<p>
-
-When CTDB is installed, it will install template versions of these
-files which you need to edit to suit your system.  
-
-<h3>/etc/sysconfig/ctdb</h3>
-
-This file contains the startup parameters for ctdb.<p>
-
-When you installed ctdb, a template config file should have been
-installed in /etc/sysconfig/ctdb.<p>
-
-Edit this file, following the instructions in the template.<p>
-
-The most important options are:
-<ul>
-<li>CTDB_NODES
-<li>CTDB_RECOVERY_LOCK
-<li>CTDB_PUBLIC_ADDRESSES
-</ul>
-
-Please verify these parameters carefully.
-
-<h4>CTDB_RECOVERY_LOCK</h4>
-
-This parameter specifies the lock file that the CTDB daemons use to arbitrate 
-which node is acting as a recovery master.<br>
-
-This file MUST be held on shared storage so that all CTDB daemons in the cluster will access/lock the same file.<br><br>
-
-You <strong>must</strong> specify this parameter.<br>
-There is no default for this parameter.
-
-<h3>CTDB_NODES</h3>
-
-This file needs to be created and should contain a list of the private
-IP addresses that the CTDB daemons will use in your cluster. One IP
-address for each node in the cluster.<p>
-
-This should be a private non-routable subnet which is only used for
-internal cluster traffic. This file must be the same on all nodes in
-the cluster.<p>
-
-Make sure that these IP addresses are automatically started when the
-cluster node boots and that each node can ping each other node.<p>
-
-Example 4 node cluster:
-<pre>
-  CTDB_NODES=/etc/ctdb/nodes
-</pre>
-Content of /etc/ctdb/nodes:
-<pre>
- 10.1.1.1
- 10.1.1.2
- 10.1.1.3
- 10.1.1.4
-</pre>
-
-The default for this file is /etc/ctdb/nodes.
-
-
-<h3>CTDB_PUBLIC_ADDRESSES</h3>
-
-Each node in a CTDB cluster contains a list of public addresses which that 
-particular node can host.<p>
-
-While running the CTDB cluster will assign each public address that exists in the entire cluster to one node that will host that public address.<p>
-
-These are the addresses that the SMBD daemons and other services will
-bind to and which clients will use to connect to the cluster.<p>
-
-<h3>Example 4 node cluster:</h3>
-<pre>
-  CTDB_PUBLIC_ADDRESSES=/etc/ctdb/public_addresses
-</pre>
-Content of /etc/ctdb/public_addresses:
-<pre>
- 192.168.1.1/24 eth0
- 192.168.1.2/24 eth0
- 192.168.2.1/24 eth1
- 192.168.2.2/24 eth1
-</pre>
-
-These are the IP addresses that you should configure in DNS for the
-name of the clustered samba server and are the addresses that CIFS
-clients will connect to.<p>
-
-Configure it as one DNS A record (==name) with multiple IP addresses
-and let round-robin DNS distribute the clients across the nodes of the
-cluster.<p>
-
-The CTDB cluster utilizes IP takeover techniques to ensure that as long as at least one node in the cluster is available, all the public IP addresses will always be available to clients.<p>
-
-This means that if one physical node fails, the public addresses that
-node was serving will be taken over by a different node in the cluster. This
-provides a guarantee that all ip addresses exposed to clients will
-always be reachable by clients as long as at least one node still remains available in the cluster with the capability to host that public address (i.e. the public address exists in that nodes public_addresses file).
-
-Do not assign these addresses to any of the interfaces on the
-host. CTDB will add and remove these addresses automatically at
-runtime.<p>
-
-This parameter is used when CTDB operated in takeover ip mode.<p>
-
-The usual location for this file is /etc/ctdb/public_addresses.<p><p>
-
-<h3>Example 2:</h3>
-By using different public_addresses files on different nodes it is possible to 
-partition the cluster into subsets of nodes.
-
-<pre>
-Node 0 : /etc/ctdb/public_addresses
-10.1.1.1/24 eth0
-10.1.2.1/24 eth1
-</pre>
-
-<pre>
-Node 1 : /etc/ctdb/public_addresses
-10.1.2.1/24 eth1
-10.1.3.1/24 eth2
-</pre>
-
-<pre>
-Node 2 : /etc/ctdb/public_addresses
-10.1.3.2/24 eth2
-</pre>
-
-In this example we have three nodes but a total of 4 public addresses.<p>
-
-10.1.2.1 can be hosted by either node 0 or node 1 and will be available to clients as long as at least one of these nodes are available. Only if both nodes 0 and 1 fails will this public address become unavailable to clients.<p>
-
-All other public addresses can only be served by one single node respectively and will therefore only be avialable if the respective node is also available.
-
-
-<h2>Event scripts</h2>
-
-CTDB comes with a number of application specific event scripts that
-are used to do service specific tasks when the cluster has been
-reconfigured. These scripts are stored in /etc/ctdb/events.d/<p>
-
-You do not need to modify these scripts if you just want to use
-clustered Samba or NFS but they serve as examples in case you want to
-add clustering support for other application servers we do not yet
-proivide event scripts for.<p>
-
-Please see the service scripts that installed by ctdb in
-/etc/ctdb/events.d for examples of how to configure other services to
-be aware of the HA features of CTDB.<p>
-
-Also see /etc/ctdb/events.d/README for additional documentation on how to
-create and manage event scripts.
-
-<h2>TCP port to use for CTDB</h2>
-
-CTDB defaults to use TCP port 4379 for its traffic.<p>
-
-Configuring a different port to use for CTDB traffic is done by adding
-a ctdb entry to the /etc/services file.<p>
-
-Example: for change CTDB to use port 9999 add the following line to /etc/services
-<pre>
- ctdb  9999/tcp
-</pre>
-
-Note: all nodes in the cluster MUST use the same port or else CTDB
-will not start correctly.
-
-<h2>Name resolution</h2>
-
-You need to setup some method for your Windows and NFS clients to find
-the nodes of the cluster, and automatically balance the load between
-the nodes.<p>
-
-We recommend that you use public ip addresses using
-CTDB_PUBLIC_INTERFACE/CTDB_PUBLIC_ADDRESSES and that you setup a
-round-robin DNS entry for your cluster, listing all the public IP
-addresses that CTDB will be managing as a single DNS A record.<p>
-
-You may also wish to setup a static WINS server entry listing all of
-your cluster nodes IP addresses.
-
-<!--#include virtual="footer.html" -->
index 0b80c10..75e016b 100644 (file)
@@ -5,23 +5,14 @@
 
 <h1>CTDB Documentation</h1>
 
-The following documentation should get you started with CTDB. 
+<p>
+  Most documentation about how to install and configure CTDB is
+  available in the
+  <a href="http://wiki.samba.org/index.php/CTDB_and_Clustered_Samba">CTDB
+  Wiki</a>.
+</p>
 
-<ul>
-<li><a href="/prerequisites.html">Prerequisites</a>
-<li><a href="/download.html">Downloading CTDB</a>
-<li><a href="/building.html">Building CTDB</a>
-<li><a href="/configuring.html">Configuring CTDB</a>
-<li><a href="/testing.html">Testing CTDB</a>
-<li><a href="/samba.html">Setting up Samba with CTDB</a>
-<li><a href="/ftp.html">Setting up FTP with CTDB</a>
-<li><a href="/nfs.html">Setting up NFS with CTDB</a>
-<li><a href="/iscsi.html">Setting up iSCSI with CTDB</a>
-<li><a href="/clamd.html">Setting up CLAMD with CTDB</a>
-<li><a href="http://wiki.samba.org/index.php/CTDB_Setup">CTDB Wiki</a>
-</ul>
-
-Man pages:
+<p>Man pages:</p>
 <ul>
 <li><a href="/manpages/ctdb.1.html">ctdb (1)</a>
 <li><a href="/manpages/ctdb_diagnostics.1.html">ctdb_diagnostics (1)</a>
@@ -36,6 +27,19 @@ Man pages:
 <li><a href="/manpages/ping_pong.1.html">ping_pong (1)</a>
 </ul>
 
+<p>
+  Additional documentation that might not yet be fully migrated to the
+  wiki:
+</p>
+
+<ul>
+<li><a href="testing.html">Testing CTDB</a>
+<li><a href="samba.html">Setting up Samba with CTDB</a>
+<li><a href="ftp.html">Setting up FTP with CTDB</a>
+<li><a href="iscsi.html">Setting up iSCSI with CTDB</a>
+<li><a href="clamd.html">Setting up CLAMD with CTDB</a>
+</ul>
+
 Articles:
 <ul>
 <li><a href="http://samba.org/~obnox/presentations/sambaXP-2009/">Michael
diff --git a/web/download.html b/web/download.html
deleted file mode 100644 (file)
index dce75fe..0000000
+++ /dev/null
@@ -1,50 +0,0 @@
-<!--#set var="TITLE" value="Downloading CTDB" -->
-<!--#include virtual="header.html" -->
-
-<H2 align="center">Getting the code</h2>
-
-You need two source trees, one is a copy of Samba3 and the other is the
-ctdb code itself.<p>
-
-Both source trees are stored in git repositories.<p>
-
-<h2>CTDB</h2>
-You can download ctdb source code via <a href="ftp://ftp.samba.org/pub/ctdb">ftp</a>
-and <a href="http://ftp.samba.org/pub/ctdb">http</a>. <br><br>
-
-You can also get the latest development version of ctdb using git:
-<pre>
-   git clone git://git.samba.org/ctdb.git ctdb
-</pre>
-
-To update this tree when improvements are made in the upstream code do this:
-<pre>
-    cd ctdb
-    git pull
-</pre>
-
-If you don't have git and can't easily install it, then you can
-instead use the following command to fetch ctdb or update it:
-<pre>
-    rsync -avz samba.org::ftp/unpacked/ctdb .
-</pre>
-
-
-<h2>Samba3 ctdb version</h2>
-<p>
-With Samba version 3.3 all cluster-relevant changes have been merged
-to the mainstream Samba code. Please refer to the <a
-href="http://www.samba.org/">Samba website</a> for the current release
-information.
-</p>
-
-<h2>Binary Packages</h2>
-
-Note that packages are so far only available for RHEL5. Other packages
-may come later. <p>
-
-See <a href="http://ftp.samba.org/pub/ctdb/packages/">packages</a> directory for package
-downloads.
-
-
-<!--#include virtual="footer.html" -->
index a356b08..dc370e8 100644 (file)
@@ -13,8 +13,6 @@
        <ul>
       <li><small><a href="/">home</a></small>
       <li><small><a href="/documentation.html">documentation</a></small>
-      <li><small><a href="/configuring.html">configuring</a></small>
-      <li><small><a href="/building.html">building</a></small>
        </ul>
     </td>
     <td align="center">
@@ -22,7 +20,6 @@
     </td>
     <td align="left">
       <ul>
-      <li><small><a href="/download.html">download</a></small>
       <li><small><a href="/testing.html">testing</a></small>
       <li><small><a href="http://wiki.samba.org/index.php/CTDB_Setup">wiki</a></small>
       <li><small><a href="http://bugzilla.samba.org/">bug-tracking</a></small>
index 91f87e8..0401094 100644 (file)
@@ -56,11 +56,17 @@ README file</a> for a description of how TDB is used.
 
 <h2>Documentation</h2>
 
-<a href="./documentation.html">CTDB documentation</a><br><br>
-
-Additional documentation on how to install and configure CTDB is available in the
-<a href="http://wiki.samba.org/index.php/CTDB_Setup">CTDB
-  Wiki</a>. Please read all of the documentation carefully.
+<p>
+  Most documentation about how to install and configure CTDB is
+  available in
+  the <a href="http://wiki.samba.org/index.php/CTDB_Setup">CTDB
+    Wiki</a>.
+</p>
+
+<p>
+  Additional documentation that is not yet included in the wiki is
+  <a href="./documentation.html">available</a>.
+</p>
 
 <h2>High Availability Features</h2>
 
diff --git a/web/nfs.html b/web/nfs.html
deleted file mode 100644 (file)
index a4a6fb5..0000000
+++ /dev/null
@@ -1,96 +0,0 @@
-<!--#set var="TITLE" value="CTDB and NFS" -->
-<!--#include virtual="header.html" -->
-
-<h1>Setting up clustered NFS</h1>
-
-NFS v2/v3 has been successfully tested with exporting the same
-data/network share from multiple nodes in a CTDB cluster with correct
-file locking behaviour and lock recovery.<br><br>
-
-Also see <a href="http://wiki.samba.org/index.php/CTDB_Setup#Setting_up_CTDB_for_clustered_NFS">Configuring
-NFS for CTDB clustering</a> at samba.org for additional information.
-
-<h2>Prereqs</h2>
-Configure CTDB as above and set it up to use public ipaddresses.<br>
-Verify that the CTDB cluster works.
-
-<h2>/etc/exports</h2>
-
-Export the same directory from all nodes.<br>
-Make sure to specify the fsid export option so that all nodes will present the same fsid to clients.<br>
-
-Clients can get "upset" if the fsid on a mount suddenly changes.<br>
-Example /etc/exports :
-<pre>
-  /gpfs0/data *(rw,fsid=1235)
-</pre>
-
-<h2>/etc/sysconfig/nfs</h2>
-
-This file must be edited to point statd to keep its state directory on 
-shared storage instead of in a local directory.<br><br>
-
-We must also make statd use a fixed port to listen on that is the same for 
-all nodes in the cluster.<br>
-
-If we don't specify a fixed port, the statd port will change during failover 
-which causes problems on some clients.<br>
-(some clients are very slow to realize when the port has changed)<br><br>
-
-This file should look something like :
-<pre>
-  NFS_HOSTNAME=ctdb
-  STATD_PORT=595
-  STATD_OUTGOING_PORT=596
-  MOUNTD_PORT=597
-  RQUOTAD_PORT=598
-  LOCKD_TCPPORT=599
-  LOCKD_UDPPORT=599
-  STATD_HOSTNAME="$NFS_HOSTNAME -H /etc/ctdb/statd-callout -p 97"
-  RPCNFSDARGS="-N 4"
-
-</pre>
-
-You need to make sure that the lock manager runs on the same port on all nodes in the cluster since some clients will have "issues" and take very long to recover if the port suddenly changes.<br>
-599 above is only an example. You can run the lock manager on any available port as long as you use the same port on all nodes.<br><br>
-
-NFS_HOSTNAME is the dns name for the ctdb cluster and which is used when clients map nfs shares. This name must be in DNS and resolve back into the public ip addresses of the cluster.<br>
-Always use the same name here as you use for the samba hostname.
-
-RPCNFSDARGS is used to disable support for NFSv4 which is not yet supported by CTDB.
-
-<h2>/etc/sysconfig/ctdb</h2>
-Add the following line to /etc/sysconfig/ctdb :
-
-<pre>
-  CTDB_MANAGES_NFS=yes
-</pre>
-The CTDB_MANAGES_NFS line tells the events scripts that CTDB is to manage startup and shutdown of the NFS and NFSLOCK services.<br>
-
-With this set to yes, CTDB will start/stop/restart these services as required.<br><br>
-
-
-<h2>chkconfig</h2>
-
-Since CTDB will manage and start/stop/restart the nfs and the nfslock services, you must disable them using chkconfig.
-<pre>
-  chkconfig nfs off
-  chkconfig nfslock off
-</pre>
-
-
-<h2>Event scripts</h2>
-
-CTDB clustering for NFS relies on two event scripts /etc/ctdb/events.d/60.nfs and /etc/ctdb/events.d/61.nfstickle.<br>
-
-These two scripts are provided by the RPM package and there should not be any need to change them.
-
-<h2><strong>IMPORTANT</strong></h2>
-
-Never ever mount the same nfs share on a client from two different nodes in the cluster at the same time!<br><br>
-
-The client side caching in NFS is very fragile and assumes/relies on that an object can only be accessed through one single path at a time.
-
-
-<!--#include virtual="footer.html" -->
-
diff --git a/web/prerequisites.html b/web/prerequisites.html
deleted file mode 100644 (file)
index 5a56300..0000000
+++ /dev/null
@@ -1,30 +0,0 @@
-<!--#set var="TITLE" value="CTDB prerequisites" -->
-<!--#include virtual="header.html" -->
-
-<h1>Prerequisites</h1>
-
-Before you can start using CTDB you must first install and configure a
-bunch of linux boxes.<br><br>
-
-After that you need to install and configure a cluster filesystem and
-mount that cluster filesystem on all the linux boxes that will form
-your cluster.<br><br>
-
-Also, ensure that the cluster filesystem supports correct
-posix locking semantics. A simple way to test this is to run <a
-href="https://wiki.samba.org/index.php/Ping_pong">ping_pong</a> utility
-bundled with CTDB.<br><br>
-
-<h1>Cluster filesystems</h1>
-We have primarily used the GPFS filesystem for our testing but any
-cluster filesystem should work as long as it provides correct file
-locking.<br><br>
-
-While we primarily test with GPFS, CTDB should work with almost any
-other cluster filesystem as well.<br><br>
-
-Please let us know your experiences in using other cluster filesystems.
-
-
-<!--#include virtual="footer.html" -->
-