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

[DOC] Introduce Kyuubi Web UI Engine Page #5762

Closed
wants to merge 4 commits into from

Conversation

zhaohehuhu
Copy link
Contributor

@zhaohehuhu zhaohehuhu commented Nov 24, 2023

🔍 Description

Issue References 🔗

This pull request fixes #5572

Describe Your Solution 🔧

Introduce Kyuubi Web UI Engine Page as the screenshot shown.

Types of changes 🔖

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Test Plan 🧪

Behavior Without This Pull Request ⚰️

Behavior With This Pull Request 🎉

Screenshot 2023-11-27 at 10 39 55

Related Unit Tests


Checklists

📝 Author Self Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • This patch was not authored or co-authored using Generative Tooling

📝 Committer Pre-Merge Checklist

  • Pull request title is okay.
  • No license issues.
  • Milestone correctly set?
  • Test coverage is ok
  • Assignees are selected.
  • Minimum number of approvals
  • No changes are requested

Be nice. Be informative.

@github-actions github-actions bot added the kind:documentation Documentation is a feature! label Nov 24, 2023
@zhaohehuhu
Copy link
Contributor Author

@zwangsheng plz help review it. Thanks.

@zhaohehuhu zhaohehuhu changed the title Introduce Kyuubi Web UI Engine Page [DOC] Introduce Kyuubi Web UI Engine Page Nov 24, 2023
| Version | The version of the Kyuubi server associated with this engine |
| Operation | Extra operations that users can do further.<br/> 1. View native engine UI<br/>find and select the engine you wish to view its native UI. <br/>clink on the view button, you should be redirected to the native engine UI powered by Kyuubi proxy. <br/>2. Delete the specified engine gracefully <br/>select the specific engine you would like to delete from the Engine Management page. <br/>click on delete button and confirm your choice, then the engine will be remove from service discovery like Zookeeper, ETCD and etc. <br/>The engine will eventually be shut down once all the jobs running on it inside are finished. |

![workspace](../../imgs/ui/spark_ui.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, we don't need this Spark UI Image.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it.

| Share Level | The share level of engine, such as user, connection, group and server |
| User | The user created the engine |
| Version | The version of the Kyuubi server associated with this engine |
| Operation | Extra operations that users can do further.<br/> 1. View native engine UI<br/>find and select the engine you wish to view its native UI. <br/>clink on the view button, you should be redirected to the native engine UI powered by Kyuubi proxy. <br/>2. Delete the specified engine gracefully <br/>select the specific engine you would like to delete from the Engine Management page. <br/>click on delete button and confirm your choice, then the engine will be remove from service discovery like Zookeeper, ETCD and etc. <br/>The engine will eventually be shut down once all the jobs running on it inside are finished. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The engine will eventually be shut down once all the jobs running on it inside are finished.

The engine will eventually be shut down once all connected session closed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it.


This engine UI is able to help you understand status of the engine behind Kyuubi servers.

## Engine Management details
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Engine Management details => Engine Management Details

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Thanks!

done. @zwangsheng

@codecov-commenter
Copy link

codecov-commenter commented Nov 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fdcb456) 61.40% compared to head (5aed43e) 61.37%.
Report is 30 commits behind head on master.

❗ Current head 5aed43e differs from pull request most recent head 4a85af0. Consider uploading reports for the commit 4a85af0 to get more accurate results

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #5762      +/-   ##
============================================
- Coverage     61.40%   61.37%   -0.03%     
  Complexity       23       23              
============================================
  Files           607      607              
  Lines         35897    35940      +43     
  Branches       4923     4932       +9     
============================================
+ Hits          22042    22059      +17     
- Misses        11474    11494      +20     
- Partials       2381     2387       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@zwangsheng zwangsheng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, would you re-upload latest screenshoot in PR desc, it's failed for now.

PTAL @pan3793

@zhaohehuhu
Copy link
Contributor Author

LGTM, would you re-upload latest screenshoot in PR desc, it's failed for now.

PTAL @pan3793

Thanks.

@yaooqinn yaooqinn added this to the v1.9.0 milestone Dec 1, 2023
@yaooqinn
Copy link
Member

yaooqinn commented Dec 1, 2023

Hi @zhaohehuhu, is it possible to reduce the size of docs/imgs/ui/engine_ui.png?

@zhaohehuhu
Copy link
Contributor Author

zhaohehuhu commented Dec 1, 2023

Hi @zhaohehuhu, is it possible to reduce the size of docs/imgs/ui/engine_ui.png?

Yup. It compressed to 27 KB

@yaooqinn yaooqinn closed this in 3677f3a Dec 1, 2023
@yaooqinn
Copy link
Member

yaooqinn commented Dec 1, 2023

Thank you all, merged to master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation Documentation is a feature!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TASK][EASY] Introduce Kyuubi Web UI Engine Page
4 participants