doc/index.rst

   1 Wizard
   2 ======
   3
   4 Wizard is the next-generation autoinstall management service for
   5 scripts.mit.edu.  It's current focus is on automating the upgrading
   6 process using a Git backend, and in the future will administrate all
   7 aspects of autoinstalls (installation and upgrades).
   8
   9 Usage
  10 -----
  11
  12 .. highlight:: sh
  13
  14 Components of Wizard depend on packages and special configuration found
  15 on scripts servers.  As such, the best way to test Wizard is to SSH
  16 into a scripts server and add Wizard to your path::
  17
  18     ssh scripts.mit.edu
  19     export PATH="/mit/scripts/wizard/bin:$PATH"
  20     wizard help
  21
  22 Individual tools that are not scripts-specific, such as ``wizard upgrade``
  23 or ``wizard install``, can be run locally with Python 2.6 and a reasonably
  24 new version of Git.  You will, however, have to explicitly specify configuration
  25 appropriate for your local machine.
  26
  27 .. highlight:: python
  28
  29 Development
  30 -----------
  31
  32 The canonical source of the Wizard source code is the directory
  33 :file:`/mit/scripts/git/wizard.git` on AFS.
  34
  35 The live version of the source code lives at :file:`/mit/scripts/wizard`
  36 and should be periodically updated as necessary (you will
  37 need scripts-root bits to do so).  Documentation lives in
  38 :file:`/mit/scripts/web_scripts/home/wizard`; the post-merge
  39 hook on this Git repository should perform the appropriate rebuild.
  40
  41 Certain commands must be run as root on ``not-backward.mit.edu``
  42 due to our restrictive security policies.  This machine maintains
  43 its own copy of Wizard at :file:`/wizard`.  If you make local changes
  44 to this copy and would like to push them back to the core repository,
  45 you should push to a ``system:scripts-security-upd`` writable
  46 directory in your home directory, and then on a trusted machine
  47 perform the push to the canonical repository.
  48
  49 Table of Contents
  50 -----------------
  51
  52 .. toctree::
  53
  54     testing
  55     repository-conversion
  56     glossary
  57
  58 Modules
  59 -------
  60
  61 .. toctree::
  62     :maxdepth: 1
  63
  64     module/wizard
  65     module/wizard.deploy
  66     module/wizard.install
  67     module/wizard.shell
  68     module/wizard.util
  69
  70 Indices and tables
  71 ------------------
  72
  73 * :ref:`genindex`
  74 * :ref:`modindex`
  75 * :ref:`search`
  76