doc/index.rst

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