[Refactor] Improve developer experience of API server e2e-test by JiangJiaWei1103 · Pull Request #3466 · ray-project/kuberay

JiangJiaWei1103 · 2025-04-23T13:29:47Z

Changes

Remove run from the start-local-apiserver target
Simplify prerequisites for the local-e2e-test target by replacing multiple dependencies with a single start-local-apiserver target

Why are these changes needed?

There are currently two ways to run API server e2e tests:

Run make start-local-apiserver followed by make e2e-test
This approach is useful during test development, allowing quick iterations without rebuilding the operator image, restarting the kind cluster, and redeploying the API server within the cluster.
Run make local-e2e-test
This is a convenient all-in-one command for running the full e2e test workflow, including the cluster setup, running the e2e test, and tearing down the cluster.

However, the existing setup includes redundant dependencies that may confuse developers and make it harder to choose the best workflow. This PR streamlines the local e2e test process and improve the overall developer experience.

Related issue number

Closes #3384

Checks

I've made sure the tests are passing.
Testing Strategy
- Unit tests
- Manual tests
- This PR is not tested :(

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

JiangJiaWei1103 · 2025-04-23T14:10:52Z

@dentiny PTAL, thanks!

Follow-up

Once these changes are approved, I'll update the README.md and DEVELOPMENT.md to reflect the latest setup for running e2e tests in different scenarios.

Discussion

It appears that the load-ray-test-image target is not used during the e2e test process. Would it make sense to remove this from the local-e2e-test target to further improve the efficiency?

cc @machichima

machichima · 2025-04-23T14:53:15Z

apiserver/Makefile


 .PHONY: start-local-apiserver ## Build and start apiserver from scratch.
-start-local-apiserver: operator-image cluster load-operator-image deploy-operator install run
+start-local-apiserver: operator-image cluster load-operator-image deploy-operator install


Some note here, as install will build and deploy the apiserver to cluster., we think that running the apiserver locally is not needed, as it is already on the cluster

dentiny · 2025-04-24T00:19:55Z

Once these changes are approved, I'll update the README.md and DEVELOPMENT.md to reflect the latest setup for running e2e tests in different scenarios.

If it could be inconsistency for readme, can we do that in this PR?
The main reason is I don't want users to get confused under any circumstances, thank you!

JiangJiaWei1103 · 2025-04-25T12:57:26Z

Once these changes are approved, I'll update the README.md and DEVELOPMENT.md to reflect the latest setup for running e2e tests in different scenarios.

If it could be inconsistency for readme, can we do that in this PR? The main reason is I don't want users to get confused under any circumstances, thank you!

No problem, I'll fix the docs in this PR. thanks!

Signed-off-by: 江家瑋 <36886416+JiangJiaWei1103@users.noreply.github.com>

…-e2e-test-dx

…angJiaWei1103/kuberay into improve-apiserver-e2e-test-dx

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

JiangJiaWei1103 · 2025-04-28T14:19:36Z

Hi @dentiny and @machichima,

I've updated the documentations to reflect the latest API server setup. Please let me know if there's any problem. Thanks!

dentiny · 2025-04-28T17:02:11Z

apiserver/README.md

 ```

-### Install KubeRay Operator
+#### Install KubeRay Operator


curious, why do we make kuberay operator installation a subsection for helm installation?

machichima · 2025-04-28T14:37:04Z

apiserver/DEVELOPMENT.md

+    1. Install the KubeRay Operator into the cluster by running `make operator-image load-operator-image deploy-operator`
+    2. Install the KubeRay API server into the cluster by running `make install`
+    3. Verify the setup with a smoke test `curl localhost:31888`
+        * You should see a response like `{"code":5, "message":"Not Found"}`


The response with message "Not Found" is a bit confusing while it represent the connection is valid. Consider putting command like curl -I localhost:31888/healthz here, which provides a more informative response.

❯ curl -I localhost:31888/healthz HTTP/1.1 200 OK Date: Mon, 28 Apr 2025 14:36:35 GMT

machichima · 2025-04-28T14:48:35Z

apiserver/DEVELOPMENT.md

+    3. Verify the setup with a smoke test `curl localhost:31888`
+        * You should see a response like `{"code":5, "message":"Not Found"}`
+
+> Alternatively, you can simply run `make start-local-apiserver` to spin up the API server within the kind cluster in one single command.


Maybe we can add a small note here that if we modify the code for apiserver, the make install should be re-run?

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

machichima · 2025-04-29T15:24:50Z

@JiangJiaWei1103 LGTM, Thanks!

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

dentiny

Thanks!

…roject#3466) * refactor: Simplify the API server launch logic Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> * docs: Polish help msg of local-e2e-test Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> * docs: Structure apiserver installation with Helm Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> * docs: Update the API server setup Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> * docs: Run apiserver smoke test with a health check endpoint Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> * docs: Add notes for rebuilding and reploying API server Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> * docs: Teardown the existing API server deployment Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> * fix: Solve md lint Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> --------- Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com> Signed-off-by: 江家瑋 <36886416+JiangJiaWei1103@users.noreply.github.com>

JiangJiaWei1103 added 2 commits April 23, 2025 21:06

refactor: Simplify the API server launch logic

efb3dd9

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

docs: Polish help msg of local-e2e-test

ef870cd

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

JiangJiaWei1103 marked this pull request as ready for review April 23, 2025 14:13

machichima reviewed Apr 23, 2025

View reviewed changes

JiangJiaWei1103 and others added 5 commits April 25, 2025 20:59

Merge branch 'master' into improve-apiserver-e2e-test-dx

d8a5c7e

Signed-off-by: 江家瑋 <36886416+JiangJiaWei1103@users.noreply.github.com>

Merge remote-tracking branch 'upstream/master' into improve-apiserver…

07660d4

…-e2e-test-dx

Merge branch 'improve-apiserver-e2e-test-dx' of https://github.com/Ji…

e78bc54

…angJiaWei1103/kuberay into improve-apiserver-e2e-test-dx

docs: Structure apiserver installation with Helm

77cecdf

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

docs: Update the API server setup

aee7ddc

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

JiangJiaWei1103 requested a review from machichima April 28, 2025 14:18

dentiny reviewed Apr 28, 2025

View reviewed changes

machichima reviewed Apr 29, 2025

View reviewed changes

JiangJiaWei1103 added 2 commits April 29, 2025 20:39

docs: Run apiserver smoke test with a health check endpoint

2937eca

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

docs: Add notes for rebuilding and reploying API server

50f6fee

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

JiangJiaWei1103 requested review from dentiny and machichima April 29, 2025 12:51

docs: Teardown the existing API server deployment

a1c31a8

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

fix: Solve md lint

236752a

Signed-off-by: jiangjiawei1103 <waynechuang97@gmail.com>

machichima approved these changes Apr 29, 2025

View reviewed changes

dentiny approved these changes May 1, 2025

View reviewed changes

dentiny requested a review from kevin85421 May 1, 2025 10:00

kevin85421 approved these changes May 2, 2025

View reviewed changes

kevin85421 merged commit 4ff8316 into ray-project:master May 2, 2025
23 checks passed

JiangJiaWei1103 deleted the improve-apiserver-e2e-test-dx branch May 3, 2025 00:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Refactor] Improve developer experience of API server e2e-test#3466

[Refactor] Improve developer experience of API server e2e-test#3466
kevin85421 merged 11 commits intoray-project:masterfrom
JiangJiaWei1103:improve-apiserver-e2e-test-dx

JiangJiaWei1103 commented Apr 23, 2025

Uh oh!

JiangJiaWei1103 commented Apr 23, 2025

Uh oh!

machichima Apr 23, 2025 •

edited

Loading

Uh oh!

dentiny commented Apr 24, 2025

Uh oh!

JiangJiaWei1103 commented Apr 25, 2025

Uh oh!

JiangJiaWei1103 commented Apr 28, 2025

Uh oh!

dentiny Apr 28, 2025

Uh oh!

machichima Apr 28, 2025

Uh oh!

machichima Apr 28, 2025

Uh oh!

machichima commented Apr 29, 2025

Uh oh!

dentiny left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

JiangJiaWei1103 commented Apr 23, 2025

Changes

Why are these changes needed?

Related issue number

Checks

Uh oh!

JiangJiaWei1103 commented Apr 23, 2025

Follow-up

Discussion

Uh oh!

machichima Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dentiny commented Apr 24, 2025

Uh oh!

JiangJiaWei1103 commented Apr 25, 2025

Uh oh!

JiangJiaWei1103 commented Apr 28, 2025

Uh oh!

dentiny Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

machichima Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

machichima Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

machichima commented Apr 29, 2025

Uh oh!

dentiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

machichima Apr 23, 2025 •

edited

Loading