Add notes on how to update the Google sheets credentials

I had to reverse engineer this a little bit prior to the 2023 Mystery
Hunt, (by trying to use the "New Hunt" button in Turbot and finding an
error of "invalid_grant: Bad Request" coming from
gsheets_creds.refresh(Request()) in the CloudWatch logs for the turbot
lambda).

The new instructions here tell the admin how to update the Gsheets
credentials (by running ./gsheets-authenticate.py) and how to take the
value that results (in the .gsheets-pickle.base64 file) and put it
into the SSM parameter named GSHEETS_PICKLE_BASE64 in ASM Systems
Manager in the AWS interface.

diff --git a/README b/README
index e84d560afbf26b3db1c2a01fd980eb22b0309998..a83c9d53fe75cdb89e99ae7d195d7c2d9a3de598 100644 (file)
--- a/README
+++ b/README
@@ -22,7 +22,9 @@ There are a few places where pieces are deployed or configured:
 
   * The AWS account is associated with a root login of
     crwth@puzzlers.org. If you need access to this account, just ask
-    Carl at that email and he'll help you out.
+    Carl at that email and he'll help you out. The Turbot lambda is
+    named "turbot" and can be deployed with "make deploy" from this
+    repository.
 
   * The Google docs for the spreadsheet template and for every
     puzzle-specific spreadsheet are stored in a Google account for the
@@ -31,6 +33,16 @@ There are a few places where pieces are deployed or configured:
     Google drive directory containing all the sheets for a specific
     hunt to everyone in the hunt).
 
+  * The Turbot lambda needs access to pickled credentials for the
+    Google account for creating and updating Google sheets. To update
+    these a human must run ./gsheets-authenticate.py and then login to
+    the turbot@cworth.org Google account in the web browser that pops
+    up. This will result in a file named
+    .gsheets-pickle.base64. Finally, the user must go to the Systems
+    Manager pane in the AWS console, click on Parameter Store in the
+    left menu and then edit the GSHEETS_PICKLE_BASE64 parameter to
+    have a value of the contents of the .gsheets-pickle.base64 file.
+
   * The Turbot Slack app is maintained at the following URL:
     https://api.slack.com/apps/A01B6C96E21 This is where the AWS
     Lambda URLs are configured for specific slash commands, etc.