doc/index.rst

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