diff --git a/docs/imgs/hue/cloudera_manager.png b/docs/imgs/hue/cloudera_manager.png new file mode 100644 index 000000000..32e90eeb2 Binary files /dev/null and b/docs/imgs/hue/cloudera_manager.png differ diff --git a/docs/imgs/hue/editor.png b/docs/imgs/hue/editor.png new file mode 100644 index 000000000..b0e53f561 Binary files /dev/null and b/docs/imgs/hue/editor.png differ diff --git a/docs/imgs/hue/spark_sql_cdh6.png b/docs/imgs/hue/spark_sql_cdh6.png new file mode 100644 index 000000000..bf54414f4 Binary files /dev/null and b/docs/imgs/hue/spark_sql_cdh6.png differ diff --git a/docs/imgs/hue/spark_sql_docker.png b/docs/imgs/hue/spark_sql_docker.png new file mode 100644 index 000000000..cbcd2c8ce Binary files /dev/null and b/docs/imgs/hue/spark_sql_docker.png differ diff --git a/docs/imgs/hue/start.png b/docs/imgs/hue/start.png new file mode 100644 index 000000000..d8c644e20 Binary files /dev/null and b/docs/imgs/hue/start.png differ diff --git a/docs/imgs/hue_login.png b/docs/imgs/hue_login.png deleted file mode 100644 index 022682071..000000000 Binary files a/docs/imgs/hue_login.png and /dev/null differ diff --git a/docs/quick_start/index.rst b/docs/quick_start/index.rst index 9dba83990..8b0b00795 100644 --- a/docs/quick_start/index.rst +++ b/docs/quick_start/index.rst @@ -15,3 +15,5 @@ In this section, you will learn how to setup and interact with kyuubi quickly. quick_start_with_beeline quick_start_with_jdbc quick_start_with_datagrip + quick_start_with_hue + diff --git a/docs/quick_start/quick_start_with_hue.md b/docs/quick_start/quick_start_with_hue.md index 0e82ebe89..b75f5f7be 100644 --- a/docs/quick_start/quick_start_with_hue.md +++ b/docs/quick_start/quick_start_with_hue.md @@ -4,11 +4,115 @@ -# Getting Started With Cloudera Hue +# Getting Started with Kyuubi and Cloudera Hue +## What is Hue -docker run -it -p 8888:8888 gethue/hue:latest +[Hue](https://gethue.com/) is an open source SQL Assistant for Databases & Data Warehouses. -http://localhost:8888/ +## Preparation -![](../imgs/hue_login.png) \ No newline at end of file +### 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)