]> scripts.mit.edu Git - wizard.git/blobdiff - TODO
Add --continue support to upgrades.
[wizard.git] / TODO
diff --git a/TODO b/TODO
index b726963f7d5cb12946cb97ed405d284477cbe33f..a38c28ddcebfd8c6935390ebfe94a8a1297e7628 100644 (file)
--- a/TODO
+++ b/TODO
@@ -2,38 +2,53 @@ The Git Autoinstaller
 
 TODO NOW:
 
-- Consider adding user config to repository
-- Put php.ini links in repos (probably will need another
-  script in .scripts)
-- Version configuration
+- We have safe, non-braindead
+  version detection with `git describe --tags`.  Switch
+  everything to use it.  (I think the only thing left is
+  parallel-find.pl)
+- wizard.util is pretty braindead at this point.  Fix up
+  the wildly varying conventions in it.
+- Move migration code into Wizard, since we already deal
+  with installation there anyway.
 
-- Consider making usermode wizard operation a support mode
-  (mostly for letting users upgrade things themself)
+- Better error message if daemon/scripts-security-upd
+  is not on scripts-security-upd list
 
-- Add repository flag to migrate so that we can specify an
-  arbitrary repository to migrate to
+- Fix retarded logging mechanism
 
 - The great initial deploy:
     - Turn on mediawiki new autoinstaller
-    - Migrate all mediawik installs
-
-- Implement proper deploy log parsing; this basically means we
-  need to be able to introspect Git Log. Consider using git-python
-  for this.  There's also missing functionality, bad error handling
-  and hacks in the prototype implementation of upgrade
-
-- Wordpress needs to have .scripts dir in all -scripts versions
-  (remember --no-walk!) (also make .scripts/.htaccess)
-- Wordpress needs to have a .scripts/update script written for
-  its latest version (do this after its migration)
-- Wordpress needs to check for php.ini files (which it almost
-  certianly has) and commit messages
+    - Migrate all mediawiki installs
+
+Doing Wordpress:
+- Build automation for generating config files; this automation
+  will be shared with the migrate script and the installer script
+  (migrate script needs to be able to pull out values from config
+  file, so will we; installer script needs to be able to run
+  the installer to generate config files, so will this)
+- This should all be automated:
+    - Wordpress needs to have .scripts dir in all -scripts versions
+      (also make .scripts/.htaccess)
+    - Wordpress needs to have a .scripts/update script written for
+      its latest version (do this after its migration)
+    - Wordpress needs to check for php.ini files (which it almost
+      certianly has) and commit messages
+    - Wordpress needs user config and php.ini links made
 
 - Summary script should be more machine friendly, and should not
   output summary charts when I increase specificity
+- Summary script needs to be updated for new format
+
+Some other stuff to do in your copious free time:
 - Check how many autoinstalls are missing w bits for
   daemon.scripts (this would need pyafs)
-- Consider fixing Wizard's commit messages
+- Make scripts AFS patch advertise its existence so we can check for it.
+  (This might be otherwise possible using `fs sysname`
+- Implement proper deploy log parsing; this basically means we
+  need to be able to introspect Git Log. Consider using git-python
+  for this.
+- Make 'wizard summary' generate nice pretty graphs of installs by date
+  (more histograms, will need to check actual .scripts-version files.)
 
 PULLING OUT CONFIGURATION FILES IN AN AUTOMATED MANNER
 
@@ -95,14 +110,9 @@ Author: lockername locker <lockername@scripts.mit.edu>
 
 NOTES:
 
-- A perfectly formed autoinstall with upgrade paths for all of
-  the intervening versions is not really feasible to implement.
-  As such, we want to migrate everything to -scripts, and then
-  generate a -scripts2 with the correct .scripts directory.
-  We will then nop update some installs, but this will prevent
-  us from having to migrate and update concurrently.  Treat
-  a scripts2 upgrade from migration the same way you would treat
-  a botched scripts upgrade.
+- It is not expected or required for update scripts to exist for all
+  intervening versions that were present pre-migration; only for it
+  to work on the most recent migration.
 
 - Currently all repositories are initialized with --shared, which
   means they have basically ~no space footprint.  However, it
@@ -136,40 +146,33 @@ OVERALL PLAN:
   on documenting them.  Specifically, we will be keeping:
 
     - parallel-find.pl, and the resulting
-      /mitalso make .scripts/.htaccess/scripts/sec-tools/store/scriptslist
-      This script might need to be adapted if we decide to nuke
-      .scripts-version files.
-
-    - The current install scripts will be kept in place, sans changes
-      necessary to make them use Git install of copying the script over.
-      Porting these scripts to Python and making them modular would be
-      nice, but is priority.  For the long term, seeing this scripts
-      be packaged with rest of our code would be optimal.
+      /mit/scripts/.htaccess/scripts/sec-tools/store/scriptslist
 
 * The new procedure for generating an update is as follows:
   (check out the mass-migration instructions for something in this spirit,
-  although uglier in some ways)
+  although uglier in some ways; A indicates the step /should/ be automated.)
 
     0. ssh into not-backward, temporarily give the daemon.scripts-security-upd
        bits by blanching it on system:scripts-security-upd, and run parallel-find.pl
 
-    1. Have the Git repository and working copy for the project on hand.
+A   1. Have the Git repository and working copy for the project on hand.
 
-    2. Checkout the pristine branch
+A   2. Checkout the pristine branch
 
-    3. Remove all files from the working copy.  Use `wipe-working-dir`
+A   3. Remove all files from the working copy.  Use `wipe-working-dir`
 
-    4. Download the new tarball
+A   4. Download the new tarball
 
-    5. Extract the tarball over the working copy (`cp -R a/. b` works well,
-       remember that the working copy is empty)
+A   5. Extract the tarball over the working copy (`cp -R a/. b` works well,
+       remember that the working copy is empty; this needs some intelligent
+       input)
 
-    6. Check for empty directories and add stub files as necessary.
+A   6. Check for empty directories and add stub files as necessary.
        Use `preserve-empty-dir`
 
-    7. Git add it all, and then commit as a new pristine version (v1.2.3)
+A   7. Git add it all, and then commit as a new pristine version (v1.2.3)
 
-    8. Checkout the master branch
+A   8. Checkout the master branch
 
     9. [FOR EXISTING REPOSITORIES]
        Merge the pristine branch in. Resolve any conflicts that our
@@ -182,8 +185,8 @@ OVERALL PLAN:
        scripts.
 
     [FOR NEW REPOSITORIES]
-        mkdir .scripts
-        echo "Deny from all" > .scripts/.htaccess
+A       mkdir .scripts
+A       echo "Deny from all" > .scripts/.htaccess
         touch .scripts/update
         chmod a+x .scripts/update
 
@@ -196,6 +199,8 @@ OVERALL PLAN:
    11. Commit your changes, and tag as v1.2.3-scripts (or scripts2, if
        you are amending an install without an upstream changes)
 
+      NOTE: These steps should be run on a scripts server
+
    12. Test the new update procedure using
        `wizard upgrade --with=/path/to/repo /your/autoinstall` (this will
        read out master as your "latest" version).
@@ -204,7 +209,7 @@ OVERALL PLAN:
 
    13. You can also do a "mass" version of this using:
        `wizard -d testbed.txt massupgrade --with=/path/to/repo app`
-       You'll need perms for any testbed stuff you want.
+       You'll need perms for any testbed stuff you want. (not implemented)
 
       GET APPROVAL BEFORE PROCEEDING ANY FURTHER
 
@@ -217,12 +222,12 @@ OVERALL PLAN:
        which uses Git commands to check how many
        working copies apply the change cleanly, and writes out a logfile
        with the working copies that don't apply cleanly.  It also tells
-       us about "corrupt" working copies.
+       us about "corrupt" working copies, i.e. working copies that
+       have over a certain threshold of changes.
 
    15. Run `wizard massupgrade appname`, which applies the update to all working
        copies possible, and sends mail to users to whom the working copy
-       did not apply cleanly. It also frobs .scripts-version for successful
-       upgrades (maybe not, depending on our plans).
+       did not apply cleanly.
 
    16. Run parallel-find.pl to update our inventory
 
@@ -294,40 +299,14 @@ git tag v1.2.3-scripts
 
         * .scripts/update shell script (with the +x bit set appropriately),
           which performs the commands necessary to update a script.  This can
-          be in any language.
+          be in any language. (XXX: This is going to get removed soon)
 
         * .scripts/.htaccess to prevent this directory from being accessed
           from the web.
 
-        * .scripts/database (generated) contains the database the
-          user installed the script to, so scripts-remove can clean it
-
-            XXX: Could cause problems if a user copies the autoinstall,
-            fiddles with the DB credentials, and then scripts-remove's
-            the autoinstall.  Possible fix is to add the original
-            directory as a sanity check.  Additionally, we could have
-            the application read out of this file.
-
-        * .scripts/old-version (optional) the old value of .scripts-versoin
+        * .scripts/old-version (optional) the old value of .scripts-version,
+          basically used for reverting an install to pre-migrated state.
 
-        * .scripts/install (eventually) interactively installs the
-          applicatoin from command line.
+        * .scripts/lock (generated) which locks the autoinstall during an upgrade
 
-* The autoupgrade shall be the process of:
-
-    # Make the directory not accessible by the outside world (htaccess, but be careful!)
-    git add -u .
-    git commit -m 'automatically generated backup'
-    git pull origin master
-    if [ $? ne 0 ]; then git reset --hard; echo 'conflicts during upgrade'; fi
-    ./.scripts/update
-    # Make it accessible
-
-  (with some more robust error checking, a proper dry run mechanism to, and
-  lots of su'ing)
-
-* Make 'wizard summary' generate nice pretty graphs of installs by date
-  (more histograms, will need to check actual .scripts-version files.)
 
-* Update AFS patch to advertise its existence, so we can check for it
-  here.