bash_completion: Move common code into function

[ganeti-local] / doc / admin.rst

diff --git a/doc/admin.rst b/doc/admin.rst
index 56a3972..3d0003d 100644 (file)
--- a/doc/admin.rst
+++ b/doc/admin.rst
@@ -1,7 +1,7 @@
 Ganeti administrator's guide
 ============================
 
-Documents Ganeti version 2.0
+Documents Ganeti version |version|
 
 .. contents::
 
@@ -173,8 +173,8 @@ Importing an instance is similar to creating a new one. The command is::
   gnt-backup import -n TARGET_NODE -t DISK_TEMPLATE \
     --src-node=NODE --src-dir=DIR INSTANCE_NAME
 
-Most of the options available for the command *gnt-instance add* are
-supported here too.
+Most of the options available for the command :command:`gnt-instance
+add` are supported here too.
 
 High availability features
 --------------------------
@@ -262,6 +262,7 @@ you can deactivate them with the deactivate-disks command, which works
 in the same way.
 
 Accessing an instance's console
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The command to access a running instance's console is::
 
@@ -281,8 +282,8 @@ command to ran to see a complete status for all your nodes is::
 Cluster-wide debugging
 ~~~~~~~~~~~~~~~~~~~~~~
 
-The *gnt-cluster* command offers several options to run tests or
-execute cluster-wide operations. For example::
+The :command:`gnt-cluster` command offers several options to run tests
+or execute cluster-wide operations. For example::
 
   gnt-cluster command
   gnt-cluster copyfile
@@ -291,4 +292,65 @@ execute cluster-wide operations. For example::
   gnt-cluster getmaster
   gnt-cluster version
 
-See the man page *gnt-cluster* to know more about their usage.
+See the man page :manpage:`gnt-cluster` to know more about their usage.
+
+Removing a cluster entirely
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The usual method to cleanup a cluster is to run ``gnt-cluster
+destroy`` however if the Ganeti installation is broken in any way then
+this will not run.
+
+It is possible in such a case to cleanup manually most if not all
+traces of a cluster installation by following these steps on all of
+the nodes:
+
+1. Shutdown all instances. This depends on the virtualisation
+   method used (Xen, KVM, etc.):
+
+  - Xen: run ``xm list`` and ``xm destroy`` on all the non-Domain-0
+    instances
+  - KVM: kill all the KVM processes
+  - chroot: kill all processes under the chroot mountpoints
+
+2. If using DRBD, shutdown all DRBD minors (which should by at this
+   time no-longer in use by instances); on each node, run ``drbdsetup
+   /dev/drbdN down`` for each active DRBD minor.
+
+3. If using LVM, cleanup the Ganeti volume group; if only Ganeti
+   created logical volumes (and you are not sharing the volume group
+   with the OS, for example), then simply running ``lvremove -f
+   xenvg`` (replace 'xenvg' with your volume group name) should do the
+   required cleanup.
+
+4. If using file-based storage, remove recursively all files and
+   directories under your file-storage directory: ``rm -rf
+   /srv/ganeti/file-storage/*`` replacing the path with the correct
+   path for your cluster.
+
+5. Stop the ganeti daemons (``/etc/init.d/ganeti stop``) and kill any
+   that remain alive (``pgrep ganeti`` and ``pkill ganeti``).
+
+6. Remove the ganeti state directory (``rm -rf /var/lib/ganeti/*``),
+   replacing the path with the correct path for your installation.
+
+On the master node, remove the cluster from the master-netdev (usually
+``xen-br0`` for bridged mode, otherwise ``eth0`` or similar), by
+running ``ip a del $clusterip/32 dev xen-br0`` (use the correct
+cluster ip and network device name).
+
+At this point, the machines are ready for a cluster creation; in case
+you want to remove Ganeti completely, you need to also undo some of
+the SSH changes and log directories:
+
+- ``rm -rf /var/log/ganeti /srv/ganeti`` (replace with the correct
+  paths)
+- remove from ``/root/.ssh`` the keys that Ganeti added (check
+  the ``authorized_keys`` and ``id_dsa`` files)
+- regenerate the host's SSH keys (check the OpenSSH startup scripts)
+- uninstall Ganeti
+
+Otherwise, if you plan to re-create the cluster, you can just go ahead
+and rerun ``gnt-cluster init``.
+
+.. vim: set textwidth=72 :