docs/source/index.rst

   1 .. Ganeti Web Manager documentation master file, created by
   2    sphinx-quickstart on Fri Oct 26 11:40:24 2012.
   3
   4 Ganeti Web Manager
   5 ==================
   6
   7 |gwm| is a Django_ based web frontend for managing Ganeti_ virtualization
   8 clusters. Since Ganeti only provides a command-line interface, |gwm|'s
   9 goal is to provide a user friendly interface to Ganeti by being feature
  10 complete with Ganeti's :ref:`RAPI <rapi>`. On top of Ganeti it
  11 provides a permission system for managing access to clusters and virtual
  12 machines and an in browser VNC console.
  13
  14 If you don't already have a Ganeti cluster setup, these directions_ can
  15 help you get started. If you are looking for support, please contact us
  16 through these :ref:`channels <contact>`. If you are looking to deploy
  17 |gwm| for the first time, check out our :ref:`installation` guide. If
  18 you already have a |gwm| instance running it might be time to
  19 :ref:`upgrade <upgrading>`.
  20
  21
  22 |gwm| is licensed under the :ref:`GPLv2 <license>`. It is currently
  23 developed and maintained by the Oregon State University Open Source Lab
  24 and a handful of volunteers. If you would like to get involved in
  25 development see our :ref:`development <development>` guide.
  26
  27
  28 .. _directions: http://docs.ganeti.org/ganeti/current/html/install.html
  29 .. _Ganeti: http://code.google.com/p/ganeti/
  30 .. _Django: http://djangoproject.com
  31
  32
  33 Getting Started
  34 ---------------
  35 .. toctree::
  36     :maxdepth: 1
  37
  38     installing
  39     deploying
  40     importing
  41
  42
  43 Features
  44 --------
  45 .. toctree::
  46     :maxdepth: 1
  47
  48     features/permissions
  49     features/objectlog
  50     features/vnc
  51     features/sshkeys
  52     features/ldap
  53     features/templates
  54
  55     features/clusters
  56     features/cluster-read-only
  57     features/registration
  58     features/caching
  59     caching
  60
  61 Usage
  62 -----
  63 .. toctree::
  64     :maxdepth: 1
  65
  66     usage/configuring
  67     usage/upgrading
  68     usage/clusters
  69     usage/virtualmachines
  70     usage/nodes
  71     usage/templates
  72
  73 Project Information
  74 -------------------
  75 .. toctree::
  76     :maxdepth: 1
  77
  78     ref/dependencies
  79     info/changelog
  80     info/history
  81     info/design
  82     info/contact
  83     info/screenshots
  84     info/license
  85     info/faq
  86
  87 Development
  88 -----------
  89 .. toctree::
  90     :maxdepth: 1
  91
  92     dev/schedule
  93     dev/process
  94     info/issues
  95     dev/tools
  96     dev/documentation
  97     dev/contributers
  98
  99     dev/developers
 100     dev/tests
 101     dev/search
 102     dev/selenium
 103
 104 References
 105 ~~~~~~~~~~
 106 .. toctree::
 107     :maxdepth: 1
 108
 109     ref/rapi-help
 110     ref/rest-api
 111     ref/git
 112     ref/logo
 113     ref/versions
 114
 115 Indices and tables
 116 ==================
 117
 118 * :ref:`genindex`
 119 * :ref:`modindex`
 120 * :ref:`search`
 121