a bot to help assist the crates.io, website, and other rust ops teams
This project is not used in production anymore, and is now archived.
This is a chat bot for Discord to manage the infrastructure of crates.io.
Most of the infrastructure for crates.io is hosted by Heroku. Currently if someone is to manage any part of the infrastructure for crates.io, they must have full credentials to Heroku.
The purpose of this bot is to allow basic infrastructure management tasks to be conducted through the Rust Language Discord server. It would be limited to specific members of the crates.io team, but it would allow more people to assist with basic infrastructure management without needing full credentials to Heroku.
(Still in progress)
Stage 1 of this bot will allow an authorized Discord member to:
- Update select environmental variables (not including things like API keys)
- Restart the application (which fixes most issues)
- Scale the application
- Change Dyno types
- Deploy the application
- Rollback a deployment
- Block/unblock ips
To be determined!
This Discord bot allows you to run commands in a Discord channel like this:
!command
By default, all commands are locked down and only can be run by users with permissions defined in the rust-org team repo like this user.
If you would like a command to be runnable by anyone (not just those authorized in the team repo), you need to add it to the NO_AUTH_COMMANDS constant.
lib.rs
// These commands do not require a user to be authorized
const NO_AUTH_COMMANDS: &[&str] = &["ping", "multiply", "myid"]For example, if you run the !ping command is a Discord channel, this bot will respond with "Pong!"
you: !ping
crates-io-bot: @you:Pong!
If you run the !multiply command with two numbers, this bot will respond with the product of the two numbers.
you: !multiply 2 2
crates-io-bot: 4
If you run the !myid command, this bot will respond with your Discord account ID.
you: !myid
crates-io-bot: @you: Here is your user id 1234567
You can access the list of commands and general help text with the !help command:
you: !help
crates-io-bot:
Hello! こんにちは！Hola! Bonjour! Ciao! 您好!
If you want more information about a specific command, just pass the command as argument.
Strikethrough commands are unavailable because they require permissions, require a specific role, require certain conditions, or are limited to direct messages.
General
ping
multiply
myid
get_app
get_apps
restart_app
scale_app
update_app_config
get_app_releases
rollback_app
block_ip
unblock_ip
deploy_app
To get help with a specific command, pass it as an argument to the help command. For example:
you: !help block_ip
crates-io-bot:
block_ip
Block an IP address
Sample usage
block_ip !block_ip app_name_or_id ip_address_to_block
block_ip !block_ip my_app 123.4.5.67
!get_app
If you run the !get_app command and pass it either the app name or the app id (and you have a Heroku token set in your environmental variables), this bot will respond with information about that app
you: !get_app your_app_name_or_id
crates-io-bot:
App ID: "123abc"
App Name: "My app 1"
Released At: 2020-02-12T00:35:44Z
Web URL: https://www.your_app.herokuapp.com
Formations for this app:
Name: web
Command: npm start
Quantity: 1
Size: Free
!get_apps
If you run the !get_apps command (and you have a Heroku token set in your environmental variables), this bot will respond with a list of apps associated with that Heroku account
you: !get_apps
crates-io-bot: @you: Here are your Heroku apps
App ID: "123abc"
App Name: "My app 1"
Released At: 2020-02-12T00:35:44Z
Web URL: https://www.your_app.herokuapp.com
App ID: "456def"
App Name: "My app 2"
Released At: 2020-02-12T00:35:44Z
Web URL: https://www.your_app.herokuapp.com
App ID: "789ghi"
App Name: "My app 3"
Released At: 2020-02-12T00:35:44Z
Web URL: https://www.your_app.herokuapp.com
!restart_app
If you run the !restart_app command and pass it either the app name or the app id (and you have a Heroku token set in your environmental variables), this bot will send a request to restart all dynos associated with the app
you: !restart_app your_app_name_or_id
crates-io-bot: @you: All dynos in your-app-name have been restarted.
!update_app_config
You can update authorized application configuration variables through the !update_app_config command.
Authorized configuration variables are defined here: heroku.rs
// Config variables that can be updated through Discord
const AUTHORIZED_CONFIG_VARS: &[&str] = &["FOO"];Let's say you have an app called "testing-nell-bot". That app has a config variable with the key "FOO" and you want to update the value of that key to "bar". You would run this command:
you: !update_app_config testing-nell-bot FOO bar
crates-io-bot: @you: Config Var has been updated {"FOO": "bar"}
!get_app_releases
You can get a list of releases for your app through the !get_app_releases command.
you: !get_app_releases testing-nell-bot
crates-io-bot: @you Here are your app releases
ID: abc-123
Version: 1
Status: succeeded
ID: def-456
Version: 2
Status: succeeded
ID: ghi-789
Version: 3
Status: succeeded
!deploy_app
If you would like to deploy your application, you can use this command (you can pass in the branch name, the commit id, or the full sha for the commit you want to deploy)
you: !deploy_app app_name branch_commit_id_or_sha
For example:
!deploy_app testing-nell-app master
crate-io-bot: @you Build in progress for testing-nell-app (this will take a few minutes)
Build ID is a30c6830-7e47-47ce-9f8d-1a883e4a9beb
Build a30c6830-7e47-47ce-9f8d-1a883e4a9beb is still pending...
Build a30c6830-7e47-47ce-9f8d-1a883e4a9beb is still pending...
Build a30c6830-7e47-47ce-9f8d-1a883e4a9beb is still pending...
Build a30c6830-7e47-47ce-9f8d-1a883e4a9beb is still pending...
Build a30c6830-7e47-47ce-9f8d-1a883e4a9beb is still pending...
@you: Build a30c6830-7e47-47ce-9f8d-1a883e4a9beb is complete for testing-nell-app, moving on to releasing the app
@you: App testing-nell-app version 0.2.1 has successfully been released!
This command will:
- Create a build of the code
- Periodically check the build for progress (this is configurable through the BUILD_CHECK_INTERVAL environmental variable)
- Periodically display messages in the Discord channel that the build is still pending (this is configurable through the BUILD_MESSAGE_DISPLAY_INTERVAL environmental variable)
- Release the application as the version you specified
!rollback_app
If you would like to rollback your app to the code associated with a previous release of your app, you can do so with the !rollback_app command.
you: !rollback_app testing-nell-bot version-to-rollback-to
you: !rollback_app testing-nell-bot v5
crates-io-bot: @you App testing-nell-bot was successfully rolled back to the code at v5
You can either specify the version with a "v" before the version number or with just the number. This command will also work.
you: !rollback_app testing-nell-bot 5
crates-io-bot: @you App testing-nell-bot was successfully rolled back to the code at 5
!scale_app
You can scale formations of dynos within your application through the !scale_app command.
For example: Let's say you have an application ("testing-nell-bot") that is running
- 1 formation - called "web"
- with 2 dynos in that formation
- each dyno is size "standard-1X"
If you want to update the formation to have a total of 3 dynos in it, you would run this command:
!scale_app testing-nell-bot web 3 standard-1X
crates-io-bot: : App testing-nell-bot's formation web has been updated
Name: web
Command: npm start
Quantity: 3
Size: standard-1X
If you want to scale down the formation to have a total of 2 dynos in it, you would run this command:
!scale_app testing-nell-bot web 2 standard-1X
crates-io-bot: : App testing-nell-bot's formation web has been updated
Name: web
Command: npm start
Quantity: 2
Size: standard-1X
If you want to change the size of all dynos in a formation (for example, upgrading all dynos from "standard-1X" to "standard-2X"), you would run this command:
!scale_app testing-nell-bot web 2 standard-2X
crates-io-bot: : App testing-nell-bot's formation web has been updated
Name: web
Command: npm start
Quantity: 2
Size: standard-2X
!block_ip
If you wish to block an IP address from accessing your application, you can do so with the !block_ip command.
you: !block_ip you_app_name ip_address_to_block
you: !block_ip testing-nell-bot 123.456.68
crates-io-bot: @you IP address 123.456.68
!unblock_ip
If you wish to unblock an IP address that was previously blocked for your application you can do so with the !unblock_ip command:
you: !unblock_ip you_app_name ip_address_to_unblock
you: !unblock_ip testing-nell-bot 123.456.68
crates-io-bot: @you IP address 123.456.789 has been unblocked
To setup this Discord bot, you need:
Go ahead and clone this repo and cd into the directory:
git clone https://github.com/rust-lang/crates-io-ops-bot.git
cd crates-io-ops-botTo use this bot, you will need to set up a Discord application through the Discord Developer Portal.
This blog post on Davao JS has a good guide on creating a Discord application and generating the token key. Skip to the "Generating Token Key" heading in the post and come back here when you create the token.
Make sure to store the token somewhere safe! You will need it!
To use the token in development and testing, you need to add it to your .env file. To set that file up:
cp .env.sample .envThen add the token to your .env file:
.env
DISCORD_TOKEN="<paste your token here>"
To use the token in production, make sure to set it wherever you define your environmental variables for your production environment.
In order to use commands that call out to Heroku, you must set the HEROKU_API_KEY environmental variable.
To use the Heroku API key in development at test environments, set this variable in your .env file
.env
HEROKU_API_KEY="123abc"
To use the Heroku API key in a CI/CD or production environment, make sure to set it wherever you define your environmental variables for that environment.
The !deploy_app command requires three GitHub related environmental variables to be set. This includes your GitHub org, the repo you want to deploy from, and a GitHub Personal Access Token.
To configure these variables for development and test environments, set these variables in your .env file.
.env
GITHUB_ORG="your-github-org"
GITHUB_REPO="your-github-repo"
GITHUB_TOKEN="your-github-personal-access-token"
To use these variables in a CI/CD or production environment, make sure to set them wherever you define your environmental variables for that environment.
The !deploy_app command kicks of a build of your application and periodically checks the build to see if it is still pending. Once it is no longer pending, it moves onto releasing the build. To configure the check interval for development and test environments, set this variable in your .env file
This will set the build check interval to 5 seconds
.env
BUILD_CHECK_INTERVAL="5"
To use the build check interval in a CI/CD or production environment, make sure to set it wherever you define your environmental variables for that environment.
The !deploy_app command kicks of a build of your application and periodically checks the build to see if it is still pending. This environmental variable allows you to configure how often messages are sent to the Discord channel indicating that the build is still pending.
This will set the build message display interval to 30 seconds
.env
BUILD_CHECK_INTERVAL="30"
To use the build message display interval in a CI/CD or production environment, make sure to set it wherever you define your environmental variables for that environment.
You can run this bot in your local environment with this command (make sure you are in the directory for your copy of this repo)
NOTE: You must be in the rust team repository with a discord id listed (like in this entry) to be able to run the bot.
cargo runOnce it is running, you will see the bot in the "online" list on your Discord Server. Try out the commands!
There is a Dockerfile within this repository to make it easy to build and run this bot within a Docker container (make sure you are in the directory for your copy of this repo)
Creating your docker_env.list file
You can pass all environmental variables to the Docker run command manually, but it's often much easier to keep them in a file. Unfortunately, we cannot just pass the .env file, as Docker requires that the env vars be in the format VAR1=value1, rather than VAR1="value2". One option is to copy your .env file.
cp .env docker_env.listAnd then open it up and remove the quotation marks around the environmental variables.
So
VAR1="value1"
becomes
VAR1=value1
Then you must build and run the container image:
docker build -t your_name/crates-io-ops-bot .
docker run --env-file docker_env.list -i -t your_name/crates-io-ops-bot