Skip to content

Commit

Permalink
Merge pull request #165 from rust-lang/docs-mention-crater-website
Browse files Browse the repository at this point in the history
docs: mention crater website
  • Loading branch information
MarcoIeni authored Oct 9, 2024
2 parents 470dd02 + 953454f commit 880eaa3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions service-catalog/crater/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The `crater` service is managed in the [terraform/crater] module, while the app
You can find the detailed `crater` docs
[here](https://github.com/rust-lang/crater/tree/master/docs).

[crater.rust-lang.org] shows the status of the running experiments and the agents.

## Architecture

The crater project contains the following components:
Expand Down Expand Up @@ -49,5 +51,6 @@ And the bot will reply to you.

[How to update Crater](./how-to-update-crater.md)

[crater.rust-lang.org]: https://crater.rust-lang.org
[rust-lang/crater]: https://github.com/rust-lang/crater
[terraform/crater]: https://github.com/rust-lang/simpleinfra/tree/master/terraform/crater
6 changes: 6 additions & 0 deletions service-catalog/crater/how-to-update-crater.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Crater is made of various components, here's how to update them.

> [!NOTE]
> Before updating crater check on [crater.rust-lang.org] if there are any running
> experiments.
> It's preferable to update crater when there are no running experiments.
## Agents

To update the ubuntu version of the agents, you need to update the [agent template].
Expand All @@ -27,6 +32,7 @@ The reason for updating the same VM instead of replacing it, is that crater has
SQLite database that would be lost if the VM was replaced.

[agent template]: https://github.com/rust-lang/simpleinfra/blob/74bbf479de315fb5c5d6e97832fc3dc9b12e4cab/terraform/crater/agent.tf#L139
[crater.rust-lang.org]: https://crater.rust-lang.org
[Dockerfile]: https://github.com/rust-lang/crater/blob/master/Dockerfile
[Cargo.lock]: https://github.com/rust-lang/crater/blob/master/Cargo.lock
[workflows]: https://github.com/rust-lang/crater/tree/master/.github/workflows

0 comments on commit 880eaa3

Please sign in to comment.