Drastically improve written log output.

[wizard.git] / TODO

diff --git a/TODO b/TODO
index c467861431b8da12aa8eb139fe1f0f32b17f0bc6..0e3301f47ca3d81ab8202dc58b8c77354df95890 100644 (file)
--- a/TODO
+++ b/TODO
@@ -2,11 +2,12 @@ The Git Autoinstaller
 
 TODO NOW:
 
 
 TODO NOW:
 

-- For the long running programs, I definitely want to use logging.
-- Whiteboard the flow for performing an upgrade on a single
-  install. How assisted does it need to be?
-- Conduct migration tool testing
-- Create mass-migration tool (should be able to limit on mediawiki)
+- Not quite sure what I'm going to do to deal with the fact that
+  there will be lower priviledged jobs trying to write to the logs.
+  Perhaps the best way to do this is stick it in tmp and chmod
+  it liberally.
+- Check how many autoinstalls are missing w bits for
+  daemon.scripts (this would need pyafs)

 - Run parallel-find.pl
 - Migrate all mediawikis
 - Wordpress needs to have a .scripts/update script written for
 - Run parallel-find.pl
 - Migrate all mediawikis
 - Wordpress needs to have a .scripts/update script written for


@@ -19,12 +20,39 @@ NOTES:
   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
   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.
+  us from having to migrate and update concurrently.  Treat
+  a scripts2 upgrade from migration the same way you would treat
+  a botched scripts upgrade.

 
 - summary and info are still not using loggers. Maybe they should,
 
 - summary and info are still not using loggers. Maybe they should,

-  maybe they shouldn't
-
-- We need another patched AFS server to deploy updates off of.
+  maybe they shouldn't.  Using loggers means we lose interactivity
+  with the Git output
+
+- Currently all repositories are initialized with --shared, which
+  means they have basically ~no space footprint.  However, it
+  also means that /mit/scripts/wizard/srv MUST NOT lose revs.
+
+- Full fledged logging options. Namely:
+  x all loggers (delay implementing this until we actually have debug stmts)
+    - default is WARNING
+    - debug     => loglevel = DEBUG
+  x stdout logger
+    - default is WARNING (see below for exception)
+    - verbose   => loglevel = INFO
+  x file logger (only allowed for serial processing)
+    - default is OFF
+    - log-file   => loglevel = INFO
+  x database logger (necessary for parallel processing, not implemented)
+    - default is OFF
+    - log-db    => loglevel = INFO
+
+- More on the database logger: it will be very simple with one
+  table named `logs` in SQLite, with columns: `job`, `level`,
+  `message`.  Job identifies the subprocess/thread that emitted
+  the log, so things can be correlated together.  We will then
+  have `wizard dump` which takes a database like this and dumps
+  it into a file logger type file.  The database may also store
+  a queue like structure which can be used to coordinate jobs.

 
 OVERALL PLAN:
 
 
 OVERALL PLAN:
 


@@ -32,7 +60,9 @@ OVERALL PLAN:
   on documenting them.  Specifically, we will be keeping:
 
     - parallel-find.pl, and the resulting
   on documenting them.  Specifically, we will be keeping:
 
     - parallel-find.pl, and the resulting

-/mit/scripts/sec-tools/store/scriptslist
+      /mit/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.
 
     - The current install scripts will be kept in place, sans changes
       necessary to make them use Git install of copying the script over.


@@ -40,23 +70,26 @@ OVERALL PLAN:
       nice, but is priority.  For the long term, seeing this scripts
       be packaged with rest of our code would be optimal.
 
       nice, but is priority.  For the long term, seeing this scripts
       be packaged with rest of our code would be optimal.
 

-* The new procedure for generating an update is as follows (this is
-  also similar to procedure for creating these repositories):
+* 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)
+
+    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.
 
     2. Checkout the pristine branch
 
 
     1. Have the Git repository and working copy for the project on hand.
 
     2. Checkout the pristine branch
 

-    3. Remove all files from the working copy (rm -Rf *, and then delete
-       any dot stragglers.  A script to do this would be handy)
+    3. Remove all files from the working copy.  Use `wipe-working-dir`

 
     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)
 
 
     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)
 

-    6. Check for empty directories and add stub files as necessary
-       (use preserve-empty-dir)
+    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)
 
 
     7. Git add it all, and then commit as a new pristine version (v1.2.3)
 


@@ -68,43 +101,57 @@ OVERALL PLAN:
        with --no-commit (otherwise, you want to git commit --amend
        to keep our history clean
 
        with --no-commit (otherwise, you want to git commit --amend
        to keep our history clean
 

-       [FOR THE FIRST TIME]
-       Apply the scripts patch that was used for that version here
-       (usually patch -p1 < patch)
+       [FOR NEW REPOSITORIES]
+       See if any patches are needed to make this run smoothly on
+       scripts.

 
 

-   10. Check if there are any special update procedures, and update the
+    [FOR NEW REPOSITORIES]
+        mkdir .scripts
+        echo "Deny from all" > .scripts/.htaccess
+        touch .scripts/update
+        chmod a+x .scripts/update
+
+   10. Check if there are any special update procedures, and update/create the

        .scripts/update shell script as necessary (this means that any
        application specific update logic will be kept with the actual
        source code.  The language of this update script will vary
        depending on context.)
 
        .scripts/update shell script as necessary (this means that any
        application specific update logic will be kept with the actual
        source code.  The language of this update script will vary
        depending on context.)
 

-   11. Commit your changes, and tag as v1.2.3-scripts
+   11. Commit your changes, and tag as v1.2.3-scripts (or scripts2, if
+       you are amending an install without an upstream changes)

 
 

-   If you're setting up a repository from scratch, stop here, and
-   repeat as necessary
+   12. Test the new update procedure using
+       `wizard upgrade --with=/path/to/repo /your/autoinstall` (this will
+       read out master as your "latest" version).
+       Use git commit --amend to fix any bugs (alternatively, squash them
+       together later).

 
 

-       XXX: Should we force people to push to the real repository at
-       this point, or just make the repository that the script pulls
-       stuff out of configurable? (Twiddling origin can get you a
-       devel setup with no code changes)
+   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.

 
 

-   12. Run the "dry-run script", 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.
+      GET APPROVAL BEFORE PROCEEDING ANY FURTHER

 
 

-   13. Run the "limited run" script, which applies the update to our
-       test-bed, and lets us check the basic functionality of the update.
-       This can include a script that lets us update a single directory
-       with verbose output.
+      NOTE: The following commands are to be run on not-backward.mit.edu.
+      You'll need to add daemon.scripts-security-upd to
+      scripts-security-upd to get bits to do this.  Make sure you remove
+      these bits when you're done.

 
 

-   14. Run the "deploy" script, which applies the update to all working
+   14. Run `wizard research appname`
+       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.
+
+   15. Run `wizard massupgrade appname`, which applies the update to all working

        copies possible, and sends mail to users to whom the working copy
        copies possible, and sends mail to users to whom the working copy

-       did not apply cleanly. It also frobs .scripts/version for successful
-       upgrades.
+       did not apply cleanly. It also frobs .scripts-version for successful
+       upgrades (maybe not, depending on our plans).

 
 

-   15. Run parallel-find.pl
+   16. Run parallel-find.pl to update our inventory

 
 * For mass importing into the repository, the steps are:
 
 * For mass importing into the repository, the steps are:

+  (this probably won't ever be automated, becuase there are fiddly bits)

 
 [TO SET IT UP]
 # let app-1.2.3 be the scripts folder originally in deploydev
 
 [TO SET IT UP]
 # let app-1.2.3 be the scripts folder originally in deploydev


@@ -114,7 +161,7 @@ OVERALL PLAN:
     cd app
     git init
     cd ..
     cd app
     git init
     cd ..

-unfurl app-1.2.3 app
+unfurl app-1.2.3 app  # [FIDDLY BIT]

 # NOTE: contents of application are now in app directory
 cd app
 git add .
 # NOTE: contents of application are now in app directory
 cd app
 git add .


@@ -123,7 +170,7 @@ git tag v1.2.3
 git branch pristine
 # NOTE: you're still on master branch
 # WARNING: the following operation might require -p1
 git branch pristine
 # NOTE: you're still on master branch
 # WARNING: the following operation might require -p1

-patch -p0 < ../app-1.2.3/app-1.2.3.patch
+patch -p0 < ../app-1.2.3/app-1.2.3.patch  # [FIDDLY BIT]

 # NOTE: please sanity check the patch!
 git add .
 # NOTE: -a flag is to handle if the patch deleted something
 # NOTE: please sanity check the patch!
 git add .
 # NOTE: -a flag is to handle if the patch deleted something


@@ -136,13 +183,14 @@ git checkout pristine
 # NOTE: this preserves your .git folder, but removes everything
 wipe-working-dir .
 cd ..
 # NOTE: this preserves your .git folder, but removes everything
 wipe-working-dir .
 cd ..

-unfurl app-1.2.3 app
+unfurl app-1.2.3 app  # [FIDDLY BIT]

 cd app
 # NOTE: please sanity check app directory
 git add .
 # NOTE: -a is to take care of deletions
 git commit -as -m "App 1.2.3"
 git tag v1.2.3
 cd app
 # NOTE: please sanity check app directory
 git add .
 # NOTE: -a is to take care of deletions
 git commit -as -m "App 1.2.3"
 git tag v1.2.3

+[FIDDLE AROUND. FIDDLE AROUND]

 [IF THE PATCH HAS CHANGED]
     # You are on the pristine branch
     # NOTE: Now, the tricky part (this is different from a real update)
 [IF THE PATCH HAS CHANGED]
     # You are on the pristine branch
     # NOTE: Now, the tricky part (this is different from a real update)


@@ -169,13 +217,6 @@ git tag v1.2.3-scripts
 
     - A .scripts directory, which contains the following information:
 
 
     - A .scripts directory, which contains the following information:
 

-        [IF THIS IS THE FIRST UPDATE]
-            mkdir .scripts
-            echo "Deny from all" > .scripts/.htaccess
-            touch .scripts/update
-            chmod a+x .scripts/update
-            # OPERATION: create the update script
-

         * .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.
         * .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.


@@ -198,7 +239,8 @@ git tag v1.2.3-scripts
           now; probably want to keep that for now)
 
             XXX: It's unclear if we want to move to this wholesale, or
           now; probably want to keep that for now)
 
             XXX: It's unclear if we want to move to this wholesale, or

-            delay this indefinitely.
+            delay this indefinitely.  quentin thinks that the Git
+            repository itself is a sufficient record.

 
 * The migration process has been implemented, see 'wizard migrate'.
 
 
 * The migration process has been implemented, see 'wizard migrate'.
 


@@ -216,7 +258,15 @@ git tag v1.2.3-scripts
     ./.scripts/update
     # Make it accessible
 
     ./.scripts/update
     # Make it accessible
 

-  (with some more robust error checking)
+  (with some more robust error checking, a proper dry run mechanism to, and
+  lots of su'ing)
+
+* All code that operates on an untrusted Git repository, or runs
+  executable code, should be done on NOT-BACKWARD.mit.edu.  Pending
+  accounts confirmation, it will also get a principal
+  daemon.scripts-security-upd, which is what we'll actually put
+  in the scripts-security-upd group.  parallel-find.pl should also
+  be run on not-backward, by virtue of its fat pipe to the AFS servers.

 
 * Make 'wizard summary' generate nice pretty graphs of installs by date
   (more histograms, will need to check actual .scripts-version files.)
 
 * Make 'wizard summary' generate nice pretty graphs of installs by date
   (more histograms, will need to check actual .scripts-version files.)