Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document bors #123

Merged
merged 1 commit into from
Aug 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions service-catalog/bors/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Bors

The bors [module](https://github.com/rust-lang/simpleinfra/tree/master/terragrunt/modules/bors)
contains the infrastructure of [bors](https://github.com/rust-lang/bors), the Rust rewrite of
[homu](https://github.com/rust-lang/homu).

`Homu` is deployed in the legacy account, while `bors` is deployed in the
`bors-staging` and `bors-prod` account, depending on the environment.

Bors is deployed as a [Fargate](https://aws.amazon.com/fargate/) service
([ECS](https://aws.amazon.com/ecs/)) in the `us-east-2` region.
Bors uses an RDS PostgreSQL database.

To deploy a new version, the
[deployment](https://github.com/rust-lang/bors/blob/main/.github/workflows/deploy.yml)
pipeline:

1. Pushes the Docker image to the [ECR](https://aws.amazon.com/ecr/) repository.
2. Updates the ECS service, forcing a new deployment.

## Versions

These are the versions we need to keep up-to-date:

- Operating system: Ubuntu. Version specified in the
[Dockerfile]
- Rust toolchain: specified in the [Dockerfile]
- Rust dependencies: specified in the
[Cargo.toml](https://github.com/rust-lang/bors/blob/main/Cargo.toml)
- PostgreSQL: version specified in
[Terraform](https://github.com/rust-lang/simpleinfra/blob/master/terragrunt/modules/bors/main.tf)

No automation is in place as of August 2024.

[Dockerfile]: https://github.com/rust-lang/bors/blob/main/Dockerfile