Added job scheduling page by Med16-11 · Pull Request #23 · ceph/pulpito-ng

Med16-11 · 2023-06-25T18:49:51Z

screen-capture.mp4

Merge this first ceph/teuthology#1924, followed by ceph/teuthology-api#51 before merging this PR!

This PR is dependent on the following PRs:

ceph/teuthology-api#51
ceph/teuthology#1924

Testing this PR

please checkout -b the PRs above for teuthology and teuthology-api.

And in teuthology-api do

diff --git a/setup.cfg b/setup.cfg
index babeb07..26154f1 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -56,7 +56,7 @@ install_requires =
     itsdangerous
     pydantic-settings
     python-dotenv
-    teuthology @ git+https://github.com/ceph/teuthology#egg=teuthology[test]
+    teuthology @ git+https://github.com/ceph/teuthology@wip-ksirivad-teuth-suite-exception

kamoltat · 2023-06-27T04:01:16Z

@Med16-11 always rebase against latest main branch before filing a PR, or else there will likely be merge conflicts like what you see right now.

kamoltat · 2023-06-27T04:04:25Z

src/pages/Schedule/index.js

+          </button>
+        </div>
+      </div>
+      {/* <div>


Please check for things like commented code before committing :)

Sure, I actually thought that we can use the commented code later to ensure that buttons are working properly and can write the logic in functions later.

kamoltat · 2023-06-29T16:49:38Z

Okay so a few things we can improve:

The key and value column should be a dynamic table where when you input data into the last row, it will automatically generate a new row.
key and value should be an input form ( currently it is static)
When hover on to a row, you should be able to delete it, similar to POSTMAN where a little trash icon will appear and you can just delete the row.
The top box which displays the teutholgoy-suite command should automatically generate the command based on the kv that is given in table.
run and dry-run button should have red and blue colors.

Med16-11 · 2023-06-30T08:50:06Z

Okay so a few things we can improve:

The key and value column should be a dynamic table where when you input data into the last row, it will automatically generate a new row.

key and value should be an input form ( currently it is static)

When hover on to a row, you should be able to delete it, similar to POSTMAN where a little trash icon will appear and you can just delete the row.

The top box which displays the teutholgoy-suite command should automatically generate the command based on the kv that is given in table.

run and dry-run button should have red and blue colors.

Got it.

Med16-11 · 2023-06-30T08:57:12Z

It seems like I have closed the PR accidentally. Could you please open it @kamoltat

kamoltat · 2023-07-10T14:10:38Z

Thanks you for filling the change,

here are some of the things I think can be improved:

The button, you should use import Button from "@mui/material/Button"; the color for run button can be used as color="error" for now. For dry-run button try to find a blue color that matches the color="error".
The command box only gets updated once you press the run button, what we should do is to have the command box update every-time we check/uncheck the box for each key. This also applies when we delete a row that is checked.
Instead of generating a new column for the delete row button, we can have a small trash/bin icon inside the value column for each row, similar to how POSTMAN did it.

Med16-11 · 2023-07-17T13:07:28Z

It looks like this now.

kamoltat

@Med16-11
Thanks for the change, I think with the table color being black it is hard to see in dark mode, might be worth also changing the border to white or light grey when in dark mode.

kamoltat · 2023-07-18T13:49:23Z

I realized that you have a merge commit, we can avoid that by doing:

git fetch upstream

git rebase upstream/main

Also, to keep the commits clean in your PR, you should try to squash your commits in to 1 commit whenever the change between the two commits serve the same purpose.

You can do this by:

commit your new change:
git add <file>
write some random commit message
git commit -s
Now lets say you have N new commits on top of main you do:
git rebase -HEAD~N

In the interactive shell put an s

pick 02efde5 resolved conflits
pick 1b725ad resolved other conflits
pick 9374fad added the suggested changes
pick dfd9165 pages/Job/index.js: fix job started time
pick 15386e1 Implement kill-run button using mock API endpoint
s 7a3edd9 new changes added

Then it will redirect you to commit message , just edit the commit by deleting the random commit message you wrote and keep/edit the original commit message that you a squashing to.

kamoltat · 2023-07-25T15:43:24Z

Pending merge conflict to be resolved

Med16-11 · 2023-07-25T18:17:54Z

Pending merge conflict to be resolved

On it.

Med16-11 · 2023-07-26T15:15:04Z

That's how table looks now in dark mode.

Med16-11 · 2023-07-26T15:17:28Z

I'll be squashing all the commits after receiving your reviews.

kamoltat · 2023-07-26T15:54:23Z

@Med16-11 Thanks for the table change the border looks good now for dark mode.

kamoltat · 2023-07-26T15:57:29Z

@Med16-11 I've noticed that:

The input box for the key column cannot be edited?
If we tick the checkbox for a bunch keys/values and delete it, the command box up top still retains the value of the deleted row.

Med16-11 · 2023-07-26T16:01:12Z

@Med16-11 I've noticed that:

The input box for the key column cannot be edited?

If we tick the checkbox for a bunch keys/values and delete it, the command box up top still retains the value of the deleted row.

Okay, I'll look into it.

kamoltat · 2023-08-02T16:00:01Z

@Med16-11 thanks for your new change,
you're very close,

so I think the key column is still unable to be inputed.
Trash Icon in dark mode cannot be seen since it is white and when the cursor is on the row, it becomes white as well

VallariAg · 2023-08-07T12:18:52Z

@kamoltat @zmc
The schema for /suite endpoint on teuthology-api is defined and restrictive. Since the API does not allow the freedom to add any other args to the teuthology-suite command, the KEY column's can be plain text (listing all possible args) instead of input fields. This would let the user know about the restrictions of key names. Otherwise we would need to check the key names before requesting teuthology-api and throw an error if its not supported.
What do you think?

@Med16-11
Good work! I know it's WIP, just letting you some of the issues:

If I edit a row after clicking the "check", the command on top does not edit.
Command input at top and the form below are out of sync if something is directly added to the command input. They need to be synced as it would cause confusion for the user about which args would be considered for the run.

zmc · 2023-08-07T20:45:36Z

@VallariAg If I understand you correctly, you're suggesting we not allow/require the user to input the flag names in the "Key" column, and instead list all the available options and allow the user to fill in the ones they need. I think I agree with that. We could populate a Select and allow adding items to the table from that list.

This reminds me: at some point we'll want to be populating default values; perhaps we should add an endpoint to teuthology-api that provides these.

VallariAg · 2023-08-08T03:42:11Z

@zmc that sounds perfect. I'll open an issue for adding an endpoint for default values on teuthology-api and using it on pulpito-ng.

In teuthology meeting, we also discussed to disable editing on the command input above the table. We can focus on scheduling runs with the form table for now. I'll open a new issue for later enabling that feature.

kamoltat · 2023-08-09T15:43:35Z

@zmc @VallariAg
Okay so I think I'm fine with having all the suite keys as an out of the box experience. But from a Teuthology user perspective I only use around 10 - 13 out of 50+ arguments. If I were to use pulpito-ng to schedule jobs I would probably like to have only 10-13 keys in my key column with like at least 2-3 keys being selected by default. Therefore, I think we should keep the key delete functionality and key add button.

kamoltat · 2024-02-01T23:11:36Z

NOTE: I always forget to drop the eb58790
since the PR that has this commit hasn't been merged yet. So reviewer please help watch out for this hot reload commit.

Nevermind, the PR for that commit is merged so it is no longer cherry-picked to my dev local branch

kamoltat · 2024-02-14T15:08:26Z

In order, to test this PR properly, we need to modify the dry_run args in teuthology_api

diff --git a/src/teuthology_api/services/suite.py b/src/teuthology_api/services/suite.py
index 8f1d0f7..af29aaa 100644
--- a/src/teuthology_api/services/suite.py
+++ b/src/teuthology_api/services/suite.py
@@ -22,8 +22,8 @@ def run(args, dry_run: bool, send_logs: bool, access_token: str):
         )
     try:
         args["--timestamp"] = datetime.now().strftime("%Y-%m-%d_%H:%M:%S")
-        if dry_run:
-            args["--dry-run"] = True
+        if args["--dry-run"] == True:
+            log.info("This run is a dry run")
             logs = logs_run(teuthology.suite.main, args)
             return {"run": {}, "logs": logs}

(Edit: ceph/teuthology-api#48 resolved this)

kamoltat · 2024-03-13T18:37:18Z

screen-capture.mp4

src/lib/teuthologyAPI.ts

kamoltat · 2024-05-10T20:38:29Z

ran into this error:

Run npm run lint

> pulpito-ng@0.1.0 lint
> eslint src

/home/runner/work/pulpito-ng/pulpito-ng/src/lib/teuthologyAPI.ts
  30:22  error  React Hook "useUserData" is called in function "doSchedule" that is neither a React function component nor a custom React Hook function. React component names must start with an uppercase letter. React Hook names must start with the word "use"  react-hooks/rules-of-hooks

Error: Process completed with exit code 1.

Therefore, I decided to change the name doSchedule to useSchedule

VallariAg · 2024-06-10T11:24:35Z

Hey @kamoltat,
I was testing this PR and I keep running into the following issue when I send a dry-run schedule request:

docker-compose-teuthology_api-1  | INFO:     192.168.96.1:47482 - "POST /suite?logs=true HTTP/1.1" 307 Temporary Redirect
docker-compose-teuthology_api-1  | INFO:     192.168.96.1:47468 - "OPTIONS /suite/?logs=true HTTP/1.1" 200 OK
docker-compose-teuthology_api-1  | 2024-06-10 11:08:12,547.547 INFO:root:teuthology version: 1.1.1.dev689+g3f548c60
docker-compose-teuthology_api-1  | 2024-06-10 11:08:12,548.548 INFO:teuthology.suite:Using random seed=3261
docker-compose-teuthology_api-1  | 2024-06-10 11:08:12,548.548 INFO:teuthology.suite.run:kernel sha1: distro
docker-compose-teuthology_api-1  | Process Process-1:1:
docker-compose-teuthology_api-1  | Traceback (most recent call last):
docker-compose-teuthology_api-1  |   File "/usr/local/lib/python3.8/dist-packages/teuthology/suite/run.py", line 200, in choose_ceph_hash
docker-compose-teuthology_api-1  |     ceph_hash = util.git_ls_remote(
docker-compose-teuthology_api-1  |   File "/usr/local/lib/python3.8/dist-packages/teuthology/suite/util.py", line 163, in git_ls_remote
docker-compose-teuthology_api-1  |     return repo_utils.ls_remote(url, branch)
docker-compose-teuthology_api-1  |   File "/usr/local/lib/python3.8/dist-packages/teuthology/repo_utils.py", line 76, in ls_remote
docker-compose-teuthology_api-1  |     raise GitError(e.output) from None
docker-compose-teuthology_api-1  | teuthology.exceptions.GitError: b"fatal: could not read Username for 'https://github.com': No such device or address\n"
docker-compose-teuthology_api-1  | 
docker-compose-teuthology_api-1  | During handling of the above exception, another exception occurred:
docker-compose-teuthology_api-1  | 
docker-compose-teuthology_api-1  | Traceback (most recent call last):
docker-compose-teuthology_api-1  |   File "/usr/lib/python3.8/multiprocessing/process.py", line 315, in _bootstrap
docker-compose-teuthology_api-1  |     self.run()
docker-compose-teuthology_api-1  |   File "/usr/lib/python3.8/multiprocessing/process.py", line 108, in run
docker-compose-teuthology_api-1  |     self._target(*self._args, **self._kwargs)
docker-compose-teuthology_api-1  |   File "/teuthology_api/src/teuthology_api/services/helpers.py", line 62, in _execute_with_logs
docker-compose-teuthology_api-1  |     job_count = func(args)
docker-compose-teuthology_api-1  |   File "/usr/local/lib/python3.8/dist-packages/teuthology/suite/__init__.py", line 153, in main
docker-compose-teuthology_api-1  |     run = Run(conf)
docker-compose-teuthology_api-1  |   File "/usr/local/lib/python3.8/dist-packages/teuthology/suite/run.py", line 57, in __init__
docker-compose-teuthology_api-1  |     self.base_config = self.create_initial_config()
docker-compose-teuthology_api-1  |   File "/usr/local/lib/python3.8/dist-packages/teuthology/suite/run.py", line 92, in create_initial_config
docker-compose-teuthology_api-1  |     ceph_hash = self.choose_ceph_hash()
docker-compose-teuthology_api-1  |   File "/usr/local/lib/python3.8/dist-packages/teuthology/suite/run.py", line 203, in choose_ceph_hash
docker-compose-teuthology_api-1  |     raise util.schedule_fail(message=str(e), name=self.name, dry_run=self.args.dry_run) from None
docker-compose-teuthology_api-1  |   File "/usr/local/lib/python3.8/dist-packages/teuthology/suite/util.py", line 77, in schedule_fail
docker-compose-teuthology_api-1  |     raise ScheduleFailError(message, name)
docker-compose-teuthology_api-1  | teuthology.exceptions.ScheduleFailError: Scheduling VallariAg-2024-06-10_11:08:11-teuthology:no-ceph-main-distro-default-smithi failed: b"fatal: could not read Username for 'https://github.com': No such device or address\n"
docker-compose-teuthology_api-1  | 2024-06-10 11:08:14,164.164 ERROR:teuthology_api.services.helpers:Scheduling VallariAg-2024-06-10_11:08:11-teuthology:no-ceph-main-distro-default-smithi failed: b"fatal: could not read Username for 'https://github.com': No such device or address\n"
docker-compose-teuthology_api-1  | INFO:     192.168.96.1:47482 - "POST /suite/?logs=true HTTP/1.1" 400 Bad Request

Please let me know if you see the problem on your end too.

kamoltat · 2024-06-12T15:30:50Z

@VallariAg Yes I was able to recreate the issue, fixing ...

kamoltat · 2024-06-12T15:45:03Z

@VallariAg ceph-repo should be https://github.com/ceph/ceph-ci.git

VallariAg · 2024-06-12T15:48:41Z

@kamoltat ohhhh my bad! I'll test this again today.

VallariAg · 2024-06-13T07:33:54Z

src/pages/Schedule/index.jsx

+          {clickDryRun.isLoading | clickRun.isLoading | clickForcePriority.isLoading ? <CircularProgress /> : <Editor
+            value={logText}
+            readOnly={true}
+            highlight={(logText) => highlight(logText, languages.yaml)}
+            style={{
+              fontFamily: [
+                "ui-monospace",
+                "SFMono-Regular",
+                '"SF Mono"',
+                "Menlo",
+                "Consolas",
+                "Liberation Mono",
+                '"Lucida Console"',
+                "Courier",
+                "monospace",
+              ].join(","),
+              textAlign: "initial",
+            }}
+          />}


We can probably reuse the new CodeBlock component now because that PR got merged.

Yep Code block seems like a good idea

src/pages/Schedule/index.jsx

VallariAg · 2024-06-13T08:03:44Z

src/pages/Schedule/index.jsx

+      "--newest",
+      "--num",
+      "--limit",
+      "--priority",


When I schedule runs, they are all end with "dead" status because for docker setup the "<config_yaml>": ["/teuthology/containerized_node.yaml"] config is needed. I hard-coded that in request and it resulted with "pass" status!
Right now, t-api input of <config_yaml> is a path (like the above example) but there's a PR open which will take in actual config text: ceph/teuthology-api#50. Nevertheless, I guess the react coded would probably be the same for both.

So we probably need to add support for config_yaml to get green runs in docker. It's a list type though which sounds complex so maybe we can implement this in next PR.

I never got to that part where I was looking for a passed run, so thank you for reaching that.

VallariAg · 2024-06-13T08:12:16Z

Really exhaustive error handling, this is awesome!
I was able to schedule runs from the /schedule page and tested features with different teuthology-suite config, works great for me!

Signed-off-by: Med16-11 <singhmedhavi923@gmail.com> resolved conflits

Signed-off-by: Med16-11 <singhmedhavi923@gmail.com>

Signed-off-by: Zack Cerza <zack@redhat.com>

1. Rewrote the components with Material UI 2. Improved OnListener logics 3. Improved how we store data in useLocalStorage. Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>

…ling suites Use axios post request to for run, dry-run and force-priority Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>

schedule feature uses useMutation to deal with cases like onSuccess, onError and isLoading. CircularProgress is added when button is clicked and mutation is in the state of isLoading. Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>

1. After a run is scheduled, user will be able to see the results including the logs from teuthology-suite. Only success runs will show all logs from teuthology-suite, failed runs will only return the exception with descriptive failure reasons. 2. Added Warning Alerts for 0 jobs scheduled in a run 3. Added more arguments that can be use to schedule run Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>

kamoltat self-requested a review June 26, 2023 14:37

kamoltat assigned Med16-11 Jun 27, 2023

kamoltat added the feature New feature or request label Jun 27, 2023

kamoltat requested changes Jun 27, 2023

View reviewed changes

kamoltat linked an issue Jun 29, 2023 that may be closed by this pull request

Teuthology-suite #4

Open

4 tasks

Med16-11 closed this Jun 30, 2023

kamoltat reopened this Jun 30, 2023

kamoltat self-requested a review July 18, 2023 13:12

kamoltat requested changes Jul 18, 2023

View reviewed changes

This was referenced Aug 8, 2023

scheduling page: populate default values using new teuthology-api endpoint #41

Open

scheduling page: disable edit for teuthology-suite command input #42

Open

kamoltat force-pushed the medhavi branch from 3957229 to 1b77720 Compare December 13, 2023 22:08

kamoltat force-pushed the medhavi branch from f30b55a to 9e02a60 Compare January 30, 2024 20:18

kamoltat force-pushed the medhavi branch 2 times, most recently from 5cefc09 to aff5afd Compare February 14, 2024 15:06

kamoltat force-pushed the medhavi branch from aff5afd to 8a521a9 Compare February 14, 2024 17:04

kamoltat force-pushed the medhavi branch from 8a521a9 to d947c73 Compare March 13, 2024 20:51

This was referenced Mar 13, 2024

teuthology/suite/run.py: Improve ScheduleFail exception ceph/teuthology#1924

Open

[suite]: Modify how we handle Error and Success runs ceph/teuthology-api#51

Open

VallariAg reviewed Apr 25, 2024

View reviewed changes

src/lib/teuthologyAPI.ts Show resolved Hide resolved

kamoltat force-pushed the medhavi branch from d947c73 to 8a858fb Compare May 8, 2024 15:39

kamoltat force-pushed the medhavi branch from 8a858fb to d876adc Compare May 10, 2024 20:46

kamoltat self-assigned this Jun 12, 2024

VallariAg approved these changes Jun 13, 2024

View reviewed changes

Med16-11 and others added 7 commits October 15, 2025 09:43

Added job scheduling page

1e42d93

Signed-off-by: Med16-11 <singhmedhavi923@gmail.com> resolved conflits

lock & unlock widget added

0623fb3

Signed-off-by: Med16-11 <singhmedhavi923@gmail.com>

App: Add route for Schedule

716262b

Signed-off-by: Zack Cerza <zack@redhat.com>

src/pages/Schedule/index: UI facelift + improve logic

7fbad61

1. Rewrote the components with Material UI 2. Improved OnListener logics 3. Improved how we store data in useLocalStorage. Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>

src/pages/Schedule: Connect pulpito-ng with teuthology-api for schedu…

bec8a97

…ling suites Use axios post request to for run, dry-run and force-priority Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>

kamoltat force-pushed the medhavi branch from d876adc to 13e234f Compare October 15, 2025 13:52

Comments

Conversation

Med16-11 commented Jun 25, 2023 • edited by kamoltat Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge this first ceph/teuthology#1924, followed by ceph/teuthology-api#51 before merging this PR!

Testing this PR

Uh oh!

kamoltat commented Jun 27, 2023

Uh oh!

kamoltat Jun 27, 2023

Choose a reason for hiding this comment

Uh oh!

Med16-11 Jun 28, 2023

Choose a reason for hiding this comment

Uh oh!

kamoltat commented Jun 29, 2023

Uh oh!

Med16-11 commented Jun 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Med16-11 commented Jun 30, 2023

Uh oh!

kamoltat commented Jul 10, 2023

Uh oh!

Med16-11 commented Jul 17, 2023

Uh oh!

kamoltat left a comment

Choose a reason for hiding this comment

Uh oh!

kamoltat commented Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kamoltat commented Jul 25, 2023

Uh oh!

Med16-11 commented Jul 25, 2023

Uh oh!

Med16-11 commented Jul 26, 2023

Uh oh!

Med16-11 commented Jul 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kamoltat commented Jul 26, 2023

Uh oh!

kamoltat commented Jul 26, 2023

Uh oh!

Med16-11 commented Jul 26, 2023

Uh oh!

kamoltat commented Aug 2, 2023

Uh oh!

VallariAg commented Aug 7, 2023

Uh oh!

zmc commented Aug 7, 2023

Uh oh!

VallariAg commented Aug 8, 2023

Uh oh!

kamoltat commented Aug 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kamoltat commented Feb 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kamoltat commented Feb 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kamoltat commented Mar 13, 2024

Uh oh!

Uh oh!

kamoltat commented May 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

VallariAg commented Jun 10, 2024

Uh oh!

kamoltat commented Jun 12, 2024

Uh oh!

kamoltat commented Jun 12, 2024

Uh oh!

VallariAg commented Jun 12, 2024

Uh oh!

VallariAg Jun 13, 2024

Choose a reason for hiding this comment

Med16-11 commented Jun 25, 2023 •

edited by kamoltat

Loading

Med16-11 commented Jun 30, 2023 •

edited

Loading

kamoltat commented Jul 18, 2023 •

edited

Loading

Med16-11 commented Jul 26, 2023 •

edited

Loading

kamoltat commented Aug 9, 2023 •

edited

Loading

kamoltat commented Feb 1, 2024 •

edited

Loading

kamoltat commented Feb 14, 2024 •

edited

Loading

kamoltat commented May 10, 2024 •

edited

Loading