Changes between Version 1 and Version 2 of hct


Ignore:
Timestamp:
Dec 28, 2012, 5:43:20 PM (13 years ago)
Author:
Jamie McClelland
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • hct

    v1 v2  
    2424`trouble` is a helper script that helps you edit a message based on existing templates, gpg sign the message, commit and push the message.
    2525
    26 Usage:
     26You can checkout a copy of trouble via git: git://git.mayfirst.org/mfpl/trouble
    2727
    28 The `message` subcommand helps you create a service-advisory.
     28For usage, run trouble with no arguments:
     29
    2930
    3031{{{
    31 trouble message [--template <template-name>] [--search <server-search-string>]
    32 trouble message --resume
     320 jamie@animal:~$ trouble
     33usage
     34 trouble <subcmd> <options>
     35 trouble message [--template <template-name>] [--search <server-search-string>]
     36 trouble message [--queue]
     37
     38Subcommands
     39 message - create a trouble message
     40 dns - manipulate DNS records to redirect DNS queries from servers that may be down
     41
     42Options
     43 --template - specify the name of a pre-existing dual language template
     44 --search - if freepupet helper is in your PATH, this string will be passed to freepuppet-helper
     45   ls:<server-search-string>, and the Servers Affected line in the service advisory will be
     46   pre-populated with the results
     47 --resume - resume message that has been saved in the queue (for approval or translation)
     48
     49Enviornment Variables
     50 TROUBLE_MESSAGES_PATH - the page to the service-advisories git repository. If undefined
     51 it is set to the current working directory.
     52Unknown or empty subcmd.
     530 jamie@animal:~$
    3354}}}
    3455
    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
    3856
    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