Skip to content

Commit

Permalink
document update to create-worker --countries argument
Browse files Browse the repository at this point in the history
  • Loading branch information
elfkuzco committed Jul 15, 2024
1 parent 4a9084d commit ede4da7
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ This docker-compose configuration to be used **only** for development purpose.
### backend

This container is a backend web server, linked to its database.
It provides a command `mirrors-qa-backend` to simplify tasks like updating of mirrors.
Run `mirrors-qa-backend --help` in the container to see the sub-commands and options.
It provides sub-commands to simplify tasks like updating of mirrors.
Run `mirrors-qa-backend --help` in the container to see the various sub-commands and options.

### postgresqldb

Expand Down Expand Up @@ -64,8 +64,9 @@ docker compose --profile worker up --build
The key name `id_rsa` is used as a bind mount in the compose file.

- Assuming the backend service is up (`docker compose up backend`), create a worker and assign them a list of countries to test for.
If an existing worker is responsible for those countries, they are assigned to the new worker. In this example, we create a worker
named `test`.
If no countries are provided, all available countries wiil be assigned to the worker.
In this example, we create a worker named `test` to test for mirrors in France, United States and Canada using the private key file
named `id_rsa`.
```sh
docker exec -i mirrors-qa-backend mirrors-qa-backend create-worker --countries=us,fr,ca test < ./id_rsa
```
Expand Down

0 comments on commit ede4da7

Please sign in to comment.