Kyligence Insight For Superset 使用手册

关于 Kyligence Insight for Superset 
为了服务Kyligence /Kylin 的用户，Kyligence开发了定制版的Superset：Kyligence Insight for Superset ，它丰富了Kylin生态圈，使得Kyligence/ Kylin的用户多了一种选择。

本文介绍如何使用Docker部署Kyligence Insight for Superset，你可以在这个GitHub的 项目上了解更多安装方式及提出反馈意见。

先决条件

该引导给您介绍如何快速启动Kyligence Insight for Superset. 其假设您已经安装了Docker服务. 如果还没有安装可以去参考

• Install Docker for Windows
• Install Docker for Mac
• Install Docker for CentOS

需要注册一下 Kyligence Account 账户, 以便您免费激活Kyligence Insight for Superset.

如果您想使用MapBox交互式地图服务, 还需要准备一个 Mapbox Token (可选项)

快速上手

特别注意 , 如果您用 快速上手 章节启动的Kyligence Insight for Superset, 您是无法升级的. 因为您的元数据没有做外部存储.

1. 到insight.default.yaml所在目录执行如下命令, 启动Kyligence Insight for Superset! : $ docker run -it -p <本地端口>:8099 --name <容器名称> kyligence/superset-kylin:latest 例如: $ docker run -it -p 8099:8099 --name superset-kylin kyligence/superset-kylin:latest

启动成功后请连续使用组合键ctrl+p, ctrl+q, 以便docker做为后台进程运行.

1. 我们还需要创建一个superset默认的admin账户 : $ docker exec -it superset-kylin bin/create-admin.sh
2. 现在打开浏览器访问https://127.0.0.1:8099 , 使用admin/admin即可登录Kyligence Insight for Superset.

使用MySQL作为元数据启动Kyligence Insight for Superset

在前面的快速上手部分, 我们没有使用外部数据库作为Kyligence Insight for Superset的元数据库, 如果您为了版本升级或运维方便, 请您使用外部数据库作为Kyligence Insight for Superset的元数据库, 现在以MySQL为例示范如何使用MySQL作为Kyligence Insight for Superset的元数据库.

1. 新建一个 insight.default.yaml 文件，拷贝以下内容到新文件, 以便配置Superset各种启动参数 : superset: sqlalchemy_database_uri: <SQLAlchemy DSN, 如果留空会用文件数据库作为元数据库> sqllab_timeout: <SQLLab超时时间> mapbox_api_key: <mapbox token>
2. (可选项)如果您没有MySQL服务, 可以使用docker启动一个MySQL服务, 如果您已经有了MySQL服务那么这步可以跳过 : $ docker pull mysql:5.7 $ docker run -itd -p <local port>:3306 -e MYSQL_ROOT_PASSWORD=<database password> -e MYSQL_DATABASE=<database name> --name <container name> mysql:5.7 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci 例如: $ docker pull mysql:5.7 $ docker run -itd -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=superset --name superset-db mysql:5.7 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
3. 获取Kyligence Insight for Superset镜像最新版 : $ docker pull kyligence/superset-kylin:latest
4. 准备一个MySQL的连接字符串, 以便Kyligence Insight for Superset使用MySQL元数据, 并且把这个字符串填入default.yaml中 : mysql://<db username>:<db password>@<db container name>:<db port>/<database> ### 如果您是使用先前Docker启动的MySQL, 那么这个字符串就为 mysql://root:root@superset-db:3306/superset
5. 到default.yaml所在目录执行如下命令, 启动Kyligence Insight for Superset! : $ docker run -it -p <本机端口>:8099 \ --link <db container name>:<db container name> \ -v /<绝对路径>/insight.default.yaml:/usr/local/superset/conf/insight.default.yaml \ --name <容器名称> \ kyligence/superset-kylin:latest ### 如果您是使用先前Docker启动的MySQL, 那么启动容器命令为: $ docker run -it -p 8099:8099 \ --link superset-db:superset-db \ -v `pwd`/insight.default.yaml:/usr/local/superset/conf/insight.default.yaml \ --name superset-kylin \ kyligence/superset-kylin:latest
6. 按照提示输入您的Kyligence Account账户和密码, 以便免费使用Kyligence Insight for Superset : Welcome to Kyligence Insight for Superset! In order to activate your evaluation, you need to login with your Kyligence Account. If you do not have a Kyligence Account, please register at: https://account.kyligence.io/#/extra-signup?lang=en&source=superset To learn more about the activation, please refer to following URL: https://cn.kyligence.io/2018/07/11/kyligence-insight-for-superset-big-data-visualization/ Please enter account: 输入KyAccount账户 Please enter password: 输入KyAccount密码
7. 现在本地8099端口已经开启了一个Kyligence Insight for Superset服务了, 可以通过docker ps -a 来验证Kyligence Insight for Superset容器是否正常启动 : $ docker ps -a ONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 3b059d2723cb kyligence/superset-kylin:latest "bootstrap.sh" 2 days ago Up 3 seconds (health: starting) 0.0.0.0:8099->8099/tcp superset-kylin

启动成功后请连续使用组合键ctrl+p, ctrl+q, 以便docker做为后台进程运行.

1. 我们还需要创建一个superset默认的admin账户 : $ docker exec -it superset-kylin bin/create-admin.sh

insight.default.yaml 配置

升级方式

如果您使用Docker部署的Kyligence Insight for Superset, 升级操作很简单, 只需要停止原容器, 再开启新容器即可 :

docker rm -f superset-kylin
docker pull kyligence/superset-kylin

然后再按照 使用MySQL作为元数据启动Kyligence Insight for Superset 中第4步, 开启Docker服务即可.

特别注意: 如果您用 快速上手 章节启动的Kyligence Insight for Superset, 您是无法升级的. 因为您的元数据没有做外部存储.

用如果您在使用时遇到任何问题，可在如下链接 创建一个issue 将问题反馈给我们：https://github.com/Kyligence/Insight-for-Superset/issues