kyuubi/docs/quick_start/quick_start_with_hue.md
Cheng Pan 4deb20600a [KYUUBI #425] [DOCS] Getting Started with Kyuubi and Cloudera Hue
![pan3793](https://badgen.net/badge/Hello/pan3793/green) [![Closes #425](https://badgen.net/badge/Preview/Closes%20%23425/blue)](https://github.com/yaooqinn/kyuubi/pull/425) ![110](https://badgen.net/badge/%2B/110/red) ![4](https://badgen.net/badge/-/4/green) ![2](https://badgen.net/badge/commits/2/yellow) ![Target Issue](https://badgen.net/badge/Missing/Target%20Issue/ff0000) ![Doc](https://badgen.net/badge/Label/Doc/) [&#10088;?&#10089;](https://pullrequestbadge.com/?utm_medium=github&utm_source=yaooqinn&utm_campaign=badge_info)<!-- PR-BADGE: PLEASE DO NOT REMOVE THIS COMMENT -->

<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/yaooqinn/kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate

![image](https://user-images.githubusercontent.com/26535726/110803250-f66f9300-82b9-11eb-93e3-c533c8089cc9.png)

- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request

Closes #425 from pan3793/hue.

67a451e [Cheng Pan] fix
adcfd6a [Cheng Pan] [DOCS] Getting Started with Kyuubi and Cloudera Hue

Authored-by: Cheng Pan <379377944@qq.com>
Signed-off-by: ulysses-you <ulyssesyou18@gmail.com>
2021-03-12 09:11:01 +08:00

119 lines
2.9 KiB
Markdown

<div align=center>
![](../imgs/kyuubi_logo_simple.png)
</div>
# Getting Started with Kyuubi and Cloudera Hue
## What is Hue
[Hue](https://gethue.com/) is an open source SQL Assistant for Databases & Data Warehouses.
## Preparation
### Get Kyuubi Started
[Get the server Started](quick_start.md) first before your try Hue with Kyuubi.
```bash
Welcome to
__ __ __
/\ \/\ \ /\ \ __
\ \ \/'/' __ __ __ __ __ __\ \ \____/\_\
\ \ , < /\ \/\ \/\ \/\ \/\ \/\ \\ \ '__`\/\ \
\ \ \\`\\ \ \_\ \ \ \_\ \ \ \_\ \\ \ \L\ \ \ \
\ \_\ \_\/`____ \ \____/\ \____/ \ \_,__/\ \_\
\/_/\/_/`/___/> \/___/ \/___/ \/___/ \/_/
/\___/
\/__/
```
## Run Hue in Docker
Here we demo running Kyuubi on macOS and Hue on [Docker for Mac](https://docs.docker.com/docker-for-mac/),
there are several known limitations of network, and you can find
[workarounds from here](https://docs.docker.com/docker-for-mac/networking/#known-limitations-use-cases-and-workarounds).
### Configuration
1. Copy a configuration template from Hue Docker image.
```
docker run --rm gethue/hue:latest cat /usr/share/hue/desktop/conf/hue.ini > hue.ini
```
2. Modify the `hue.ini`
```ini
[beeswax]
# Kyuubi 1.1.x support thrift version from 1 to 10
thrift_version=7
# change to your username to avoid permissions issue for local test
auth_username=chengpan
[notebook]
[[interpreters]]
[[[sql]]]
name=SparkSQL
interface=hiveserver2
[spark]
# Host of the Spark Thrift Server
# For macOS users, use docker.for.mac.host.internal to access host network
sql_server_host=docker.for.mac.host.internal
# Port of the Spark Thrift Server
sql_server_port=10009
# other configurations
...
```
### Start Hue in Docker
```
docker run -p 8888:8888 -v $PWD/hue.ini:/usr/share/hue/desktop/conf/hue.ini gethue/hue:latest
```
Go http://localhost:8888/ and follow the guide to create an account.
![](../imgs/hue/start.png)
Having fun with Hue and Kyuubi!
![](../imgs/hue/spark_sql_docker.png)
### For CDH 6.x Users
If you are using CDH 6.x, there is a trick that CDH 6.x blocks Spark in default, you need to modify the configuration to
overwrite the `desktop.app_blacklist` to remove this restriction.
Config Hue in Cloudera Manager.
![](../imgs/hue/cloudera_manager.png)
Refer following configuration and tune it to fit your environment.
```
[desktop]
app_blacklist=zookeeper,hbase,impala,search,sqoop,security
use_new_editor=true
[[interpreters]]
[[[sparksql]]]
name=Spark SQL
interface=hiveserver2
# other interpreters
...
[spark]
sql_server_host=kyuubi-server-host
sql_server_port=10009
```
You need to restart the Hue Service to activate the configuration changes, and then Spark SQL will available in editor list.
![](../imgs/hue/editor.png)
Having fun with Hue and Kyuubi!
![](../imgs/hue/spark_sql_cdh6.png)