Skip to content

Commit

Permalink
[KYUUBI #5762] [DOC] Introduce Kyuubi Web UI Engine Page
Browse files Browse the repository at this point in the history 
# 🔍 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

4a85af0 [hezhao2] compress picture
5aed43e [hezhao2] refactor
16d2d2f [hezhao2] reformat
ad9c30b [hezhao2] Introduce Kyuubi Web UI Engine Page

Authored-by: hezhao2 <[email protected]>
Signed-off-by: Kent Yao <[email protected]>
  • Loading branch information
@zhaohehuhu @yaooqinn
zhaohehuhu authored and yaooqinn committed Dec 1, 2023
1 parent f4a739e commit 3677f3a
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 1 deletion.
39 changes: 39 additions & 0 deletions docs/client/ui/engine_ui.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-->

# 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.

![workspace](../../imgs/ui/engine_ui.png)

| 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.<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 connected session closed. |

2 changes: 1 addition & 1 deletion docs/client/ui/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ Web UI
.. toctree::
:maxdepth: 2

hive_beeline
engine_ui

Binary file added docs/imgs/ui/engine_ui.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3677f3a

Please sign in to comment.