| | 1 | = Here Comes Trouble = |
| | 2 | |
| | 3 | `Here Comes Trouble` (htc) is a package for helping the support team with communications during an outage. It facilitates communicating service advisory messages to MF/PL members. |
| | 4 | |
| | 5 | htc consists of the following components: |
| | 6 | |
| | 7 | * messages git repo - this is a git repository with three subdirectories: |
| | 8 | * templates - pre-written and translated templates for common service advisories |
| | 9 | * queue - messages queued for translation or approval |
| | 10 | * published - messages published, a directory for each year with a directory for each message in the corresponding year |
| | 11 | * trouble - a bash script that simplified the creation of new messages. trouble prompts you through the process of selecting a template, creating a new message with next available number, gpg signing the message, commiting and publishing |
| | 12 | * post-commit hooks |
| | 13 | * rss-publish - generates a new RSS feed based on the most recent 25 messages |
| | 14 | * html-publish - generates browseable html files for the complete set of messages |
| | 15 | * email-publish - based on the RSS feed, emails new messages to service-advisories email list |
| | 16 | * status-publish - based on the RSS feed, publishes new messages on various configured status-supported systems |
| | 17 | |
| | 18 | htc is designed to require only a workstation with the appropriate (and reasonably up-to-date) software installed and Internet access between the workstation and jojobe.mayfirst.org (our server hosted in the UK). |
| | 19 | |
| | 20 | == trouble == |
| | 21 | |
| | 22 | The primary client component is a command line program called `trouble`. |
| | 23 | |
| | 24 | `trouble` is a helper script that helps you edit a message based on existing templates, gpg sign the message, commit and push the message. |
| | 25 | |
| | 26 | Usage: |
| | 27 | |
| | 28 | The `message` subcommand helps you create a service-advisory. |
| | 29 | |
| | 30 | {{{ |
| | 31 | trouble message [--template <template-name>] [--search <server-search-string>] |
| | 32 | trouble message --resume |
| | 33 | }}} |
| | 34 | |
| | 35 | * --template - specify the name of a pre-existing dual language templates |
| | 36 | * --search - if freepupet helper is in your $PATH, this string will be passed to freepuppet-helper ls:<server-search-string>, and the Servers Affected line in the service advisory will be pre-populated with the results |
| | 37 | * --resume - resume an queued message |
| | 38 | |
| | 39 | The `dns` subcommand helps you manipulate DNS records commonly needed during an outage. It can either manipulate them via the red API (if Telehouse is available) or manipulate them directly on jobjoe (our secondary DNS server) if the red API is not available. |
| | 40 | |
| | 41 | trouble dns [--disable-mail-relay <gil|paulo>] [--redirect-mayfirst-website] |
| | 42 | |
| | 43 | * --disable-mail-relay - disable the DNS record for the specified mail relay server |
| | 44 | * --redirect-mayfirst-website - replace the DNS record for {www.,}mayfirst.org to point to jojobe, where it redirects to support.mayfirst.org |
| | 45 | |
| | 46 | |
