Tool:jouncebot

From Wikitech
Jump to: navigation, search


Tool Labs tools
Crystal Clear app package utilities.png jouncebot
Description IRC bot for Deployments
Keywords irc, python
Author(s) Matt Walker
Maintainer(s) (View all)
Source code gerrit
License GNU General Public License 2.0 or later
Issues Open tasks · Report a bug

jouncebot is a Python reminder bot for Wikimedia Deployments. It reads the deployments calendar and pokes people on IRC when their window opens.

It listens in these channels on irc.freenode.net:

  • #wikimedia-operations

Setup

It runs from Wikimedia Tool Labs under the "jouncebot" account. Bots are started and stopped using normal tool labs conventions.

Source code lives in gerrit.

README

Login

$ ssh tools-login.wmflabs.org
$ become jouncebot

Running the bot

# Start the bot
$ ./jouncebot.sh start

# Stop the bot
$ ./jouncebot.sh stop

# Restart the bot
$ ./jouncebot.sh restart

# Check job status
$ ./jouncebot.sh status

# Tail log files
$ ./jouncebot.sh tail

# Rotate log files
$ ./jouncebot.sh stop &&
  ./jouncebot.sh logrotate &&
  ./jouncebot.sh start

# Update bot to latest version
$ ./jouncebot.sh update
$ ./jouncebot.sh restart

Configuration

jouncebot is configured using a YAML file located in the home directory: jouncebot.yaml. See also the default config in jouncebot/DefaultConfig.yaml

See also