From 6165efb9125a8da97f18c34f22fa4576467c8af5 Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Sat, 13 Nov 2010 20:02:53 +0100
Subject: [PATCH] Add RST version of gnt-os man page
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: RenΓ© Nussbaumer <rn@google.com>
---
 man/gnt-os.rst | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 man/gnt-os.rst

diff --git a/man/gnt-os.rst b/man/gnt-os.rst
new file mode 100644
index 000000000..401ea91b8
--- /dev/null
+++ b/man/gnt-os.rst
@@ -0,0 +1,67 @@
+gnt-os(8) Ganeti | Version @GANETI_VERSION@
+===========================================
+
+Name
+----
+
+gnt-os - Instance operating system administration
+
+Synopsis
+--------
+
+**gnt-os** {command} [arguments...]
+
+DESCRIPTION
+-----------
+
+The **gnt-os** is used for managing the list of available operating
+system flavours for the instances in the Ganeti cluster.
+
+COMMANDS
+--------
+
+**list**
+
+Gives the list of available/supported OS to use in the instances.
+When creating the instance you can give the OS-name as an option.
+
+Note that hidden or blacklisted OSes are not displayed by this
+command, use **diagnose** for showing those.
+
+**diagnose**
+
+This command will help you see why an installed OS is not available
+in the cluster. The **list** command shows only the OS-es that the
+cluster sees available on all nodes. It could be that some OS is
+missing from a node, or is only partially installed, and this
+command will show the details of all the OSes and the reasons they
+are or are not valid.
+
+**info**
+
+This command will list detailed information about each OS available
+in the cluster, including its validity status, the supported API
+versions, the supported parameters (if any) and their
+documentations, etc.
+
+| **modify** [-H *HYPERVISOR*:option=*value*[,...]]
+| [--hidden=*yes|no*] [--blacklisted=*yes|no*]
+| {*OS*}
+
+This command will allow you to modify OS parameters.
+
+To modify the per-OS hypervisor parameters (which override the
+global hypervisor parameters), you can run modify ``-H`` with the
+same syntax as in **gnt-cluster init** to override default
+hypervisor parameters of the cluster for specified *OS* argument.
+
+To modify the hidden and blacklisted states of an OS, pass the options
+``--hidden ``*yes|no*, or respectively ``--blacklisted ...``. The
+'hidden' state means that an OS won't be listed by default in the OS
+list, but is available for installation. The 'blacklisted' state means
+that the OS is not listed and is also not allowed for new instance
+creations (but can be used for reinstalling old instances).
+
+Note: The given operating system doesn't have to exists. This allows
+preseeding the settings for operating systems not yet known to
+**gnt-os**.
-- 
GitLab