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

README: Correct the stuff in teuthology-api docker step #21

Merged
merged 1 commit into from
Sep 12, 2023
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
21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth
links:
- teuthology
- paddles
healthcheck:
test: [ "CMD", "curl", "-f", "http://0.0.0.0:8082" ]
```
5. Follow teuthology development setup instructions from [here](https://github.com/ceph/teuthology/tree/main/docs/docker-compose).

Expand Down Expand Up @@ -74,22 +76,3 @@ curl --location --request POST 'http://localhost:8082/suite?dry_run=false&logs=t
"--user": "vallariag"
}'
```

## GSOC/OUTREACHY 2023

This section is for GSOC/OUTREACHY 2023 applicants.

### Task 1: Run Teuthology & Teuthology-API
Install Teutholology-API by following the instructions above. Make sure to get all the containers running with healthy status and take a screen shot of all the running containers. TIP: In https://github.com/ceph/teuthology/tree/main/docs/docker-compose#readme run TEUTHOLOGY_WAIT=1 ./start.sh so you have time to take screen shots. Submit the screenshots to all your mentors through email.

### Task 2: Add unit-test to suite & kill route
Add unit-tests for 2 functions of your choice, 1 in `src/services/suite.py` and 1 in `src/services/kill.py.` You should be using `TestClient` library from fast-api, following this [doc](https://fastapi.tiangolo.com/tutorial/testing/#extended-fastapi-app-file).

File a PR tagging the `gsoc-outreachy` label, please use `git commit -s` to sign your commits.

### Task 3: Create a low fidelity UX/UI mockup
The purpose of this project is to enable Teuthology to schedule/kill jobs
through [Pulpito](https://pulpito.ceph.com/), therefore, we need to also add a new
widget, e.g., action bar -> form that allows you to schedule jobs, delete button on each runs/jobs. Please submit the mockup by filing a PR to this repo. This task is open-ende so feel free to use any tools (you can even hand draw it).

Again, please use the `gsoc-outreachy` label and `git commit -s` to sign your commits.
Loading