[KYUUBI #5762 ] [DOC] Introduce Kyuubi Web UI Engine Page

# 🔍 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)
- [x] 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 🎉

<img width="835" alt="Screenshot 2023-11-27 at 10 39 55" src="https://github.com/apache/kyuubi/assets/32693629/363426e8-9808-4fd7-a711-2f0f80164147">

#### Related Unit Tests

---

# Checklists
## 📝 Author Self Checklist

- [x] My code follows the [style guidelines](https://kyuubi.readthedocs.io/en/master/contributing/code/style.html) of this project
- [x] I have performed a self-review
- [x] 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](https://www.apache.org/legal/generative-tooling.html)

## 📝 Committer Pre-Merge Checklist

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

**Be nice. Be informative.**

Closes #5762 from zhaohehuhu/dev-1123.

Closes #5762

4a85af03e [hezhao2] compress picture
5aed43e63 [hezhao2] refactor
16d2d2f83 [hezhao2] reformat
ad9c30bf1 [hezhao2] Introduce Kyuubi Web UI Engine Page

Authored-by: hezhao2 <hezhao2@cisco.com>
Signed-off-by: Kent Yao <yao@apache.org>

2023-12-01 18:00:13 +08:00

6.8 KiB

Raw Blame History

Engine UI

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

Engine Management Details

The Engine UI offers an Engine Management feature on the left side of UI page. This allows users to access detailed information about the engines. However, not all available engines are displayed by default. Thus, users have to add correct filter conditions to get engines they prefer. After setting the right conditions, please click on 'search' button. The engines that meet your specified requirements should be listed on the page as the below picture shown.

Name	Description
Engine address	The engine IP address
Engine ID	The unique identifier of engine
Engine Type	The engine types(only SPARK-SQL engine can be shown in this page now)
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. 1. View native engine UI find and select the engine you wish to view its native UI. clink on the view button, you should be redirected to the native engine UI powered by Kyuubi proxy. 2. Delete the specified engine gracefully select the specific engine you would like to delete from the Engine Management page. click on delete button and confirm your choice, then the engine will be remove from service discovery like Zookeeper, ETCD and etc. The engine will eventually be shut down once all connected session closed.

6.8 KiB Raw Blame History

Engine UI

Engine Management Details

6.8 KiB

Raw Blame History