Skip to content

Commit

Permalink
README: add testing instructions & change volume mounted
Browse files Browse the repository at this point in the history
Add a note to use /docs for testing. And change
volume mount instructions in docker-compose dev setup
to only mount src dir instead of root dir of this repo.

Signed-off-by: Vallari Agrawal <[email protected]>
  • Loading branch information
VallariAg committed Jun 24, 2024
1 parent 84b6f61 commit 3798208
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth
environment:
DEPLOYMENT: development
volumes:
- ../../../teuthology-api:/teuthology_api/:rw
- ../../../teuthology-api/src:/teuthology_api/src:rw
```
`DEPLOYMENT: development` would run the server in `--reload` mode (server would restart when changes are made in `/src` dir) and `volumes` would mount host directory to docker's directory (local changes would reflect in docker container).
Expand All @@ -71,7 +71,9 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth
The documentation can be accessed at http://localhost:8082/docs after running the application.
Note: To run commands, authenticate by visiting `http://localhost:8082/login` through browser and follow the github authentication steps (this stores the auth token in browser cookies).
Once you have teuthology-api running, authenticate by visiting `http://localhost:8082/login` through browser and follow the github authentication steps (this stores the auth token in browser cookies).
> Note: To test below endpoints locally, recommended flow is to login through browser (as mentioned above) and then send requests (and receive response) through interactive docs at `/docs`.
### Route `/`
Expand Down

0 comments on commit 3798208

Please sign in to comment.