Skip to content

Commit

Permalink
README: fix /suite example's data body
Browse files Browse the repository at this point in the history
In example data json, use "main' ceph and suite branch.
Also, add copying .env step in Option 2 of Setup.

Signed-off-by: Vallari Agrawal <[email protected]>
  • Loading branch information
VallariAg committed Nov 7, 2023
1 parent f92d3f3 commit d1d5d6a
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth

## Setup

### Option 1: (teuthology docker setup)
### Option 1: Teuthology Docker Setup

1. Clone [teuthology](https://github.com/ceph/teuthology) and [teuthology-api](https://github.com/ceph/teuthology-api).
2. Rename `.env.dev` file to `.env`.
Expand Down Expand Up @@ -54,13 +54,17 @@ A REST API to execute [teuthology commands](https://docs.ceph.com/projects/teuth
1. Clone [teuthology-api](https://github.com/ceph/teuthology-api) and `cd` into it.
2. Create a virtualenv: `python3 -m venv venv`
2. Rename `.env.dev` file to `.env`.
3. Configure secrets as described in Option 1 above.
3. Activate the virtualenv: `source ./venv/bin/activate`
4. Create a virtualenv: `python3 -m venv venv`
4. Build the project: `pip install -e .`
5. Activate the virtualenv: `source ./venv/bin/activate`
5. Start the server: `gunicorn -c gunicorn_config.py teuthology_api.main:app`
6. Build the project: `pip install -e .`
7. Start the server: `gunicorn -c gunicorn_config.py teuthology_api.main:app`
## Documentation
Expand Down Expand Up @@ -88,20 +92,19 @@ Example
curl --location --request POST 'http://localhost:8082/suite?dry_run=false&logs=true' \
--header 'Content-Type: application/json' \
--data-raw '{
"--ceph": "wip-dis-testing-2",
"--ceph": "main",
"--ceph-repo": "https://github.com/ceph/ceph-ci.git",
"--kernel": "distro",
"--limit": "2",
"--newest": "0",
"--machine-type": "testnode",
"--num": "1",
"--priority": "70",
"--suite": "teuthology:no-ceph",
"--suite-branch": "wip-dis-testing-2",
"--suite-branch": "main",
"--suite-repo": "https://github.com/ceph/ceph-ci.git",
"--teuthology-branch": "main",
"--verbose": "1",
"--user": "vallariag"
"--user": "example"
}'
Note: "--user" in data body should be same as your github username (case sensitive). Otherwise, you wouldn't have permission to kill jobs/run.
xxx

0 comments on commit d1d5d6a

Please sign in to comment.