This is an automated email from the ASF dual-hosted git repository.
xxyu pushed a commit to branch doc5.0
in repository https://gitbox.apache.org/repos/asf/kylin.git
The following commit(s) were added to refs/heads/doc5.0 by this push:
new 53b5aeaf2d KYLIN-5233 Add doc for How to debug in IDE
53b5aeaf2d is described below
commit 53b5aeaf2d359cbdf60f0bbf3ee32ee6fce08ce8
Author: XiaoxiangYu <[email protected]>
AuthorDate: Wed Aug 24 11:20:50 2022 +0800
KYLIN-5233 Add doc for How to debug in IDE
---
.../docs/development/how_to_debug_kylin_in_ide.md | 57 ++++++++++++++++-----
.../development/images/docker-engine-resource.png | Bin 0 -> 84756 bytes
.../development/images/local-build-succeed.png | Bin 0 -> 526615 bytes
.../development/images/local-query-succeed.png | Bin 0 -> 355019 bytes
4 files changed, 43 insertions(+), 14 deletions(-)
diff --git a/website/docs/development/how_to_debug_kylin_in_ide.md
b/website/docs/development/how_to_debug_kylin_in_ide.md
index 1883bf37c7..3d2b3bdfc0 100644
--- a/website/docs/development/how_to_debug_kylin_in_ide.md
+++ b/website/docs/development/how_to_debug_kylin_in_ide.md
@@ -11,13 +11,33 @@ keywords:
- developer
- debug
draft: false
-last_update:
+last_update: 08/24/2022
date: 08/23/2022
---
# How to debug Kylin in IDEA using docker
-### Prepare IDEA and build source code
+## Background
+
+#### Why debug Kylin in IDEA using docker
+This article aims to introduce a simple and useful way to develop and debug
Kylin for developer, and provided similar deployment to user's real scenario.
+
+This guide assumes you use Laptop such as Macbook to do development work, and
have another remote linux server for testing and deployment purpose.
+Windows is not verified at the moment.
+
+You have to prepare:
+- Docker Desktop on Mac(and Docker Engine on Linux Server if needed)
+- IntelliJ IDEA and kylin's source code
+
+Tips:
+It is **recommended** to use remote server to deploy Hadoop Cluster, because
7-8 containers may consume a lot of hardware resources and cause your laptop
run slower than before.
+
+#### Deployment architecture
+Following is architecture of current deployment.
+
+
+
+## Prepare IDEA and build source code
#### Build source code
- Build back-end source code before your start debug.
```shell
@@ -41,7 +61,7 @@ npm install
-### Prepare the Hadoop Cluster
+## Prepare the Hadoop Cluster
#### Deploy Hadoop Cluster
- Install latest docker desktop in your laptop
@@ -53,6 +73,12 @@ npm install
export DOCKER_HOST=ssh://${USER}@${DOCKER_HOST}
```
+- Check available resource of your docker engine which you want to deploy
Hadoop Cluster, make sure you leave 6 CPUs and 12 GB memory at least .
+
+Following is the setting page of Docker Desktop of MacBook.
+
+
+
- Deploy hadoop cluster via docker compose on laptop(or on remote machine)
```shell
@@ -87,13 +113,7 @@ Following output content shows all hadoop component are in
health state.
-### Debug Kylin in IDEA
-
-#### Deployment architecture
-- Following is architecture of current deployment.
-
-
-
+## Debug Kylin in IDEA
#### Start backend in IDEA
@@ -118,14 +138,23 @@ cd kystudio
npm run devproxy
```
-
+
+
+
+#### Validate Kylin's core functions
+
+- Visit Kylin WEB UI in your laptop
+
+
+
+- Validate Cube Build and Query function
-- Visit Kylin WEB UI in your laptop.
+
-
+
-### Command manual
+## Command manual
1. Use `./dev-support/sandbox/sandbox.sh stop` to stop all containers
2. Use `./dev-support/sandbox/sandbox.sh start` to start all containers
3. Use `./dev-support/sandbox/sandbox.sh ps` to check status of all containers
diff --git a/website/docs/development/images/docker-engine-resource.png
b/website/docs/development/images/docker-engine-resource.png
new file mode 100644
index 0000000000..d4a64af8ba
Binary files /dev/null and
b/website/docs/development/images/docker-engine-resource.png differ
diff --git a/website/docs/development/images/local-build-succeed.png
b/website/docs/development/images/local-build-succeed.png
new file mode 100644
index 0000000000..84803c24d7
Binary files /dev/null and
b/website/docs/development/images/local-build-succeed.png differ
diff --git a/website/docs/development/images/local-query-succeed.png
b/website/docs/development/images/local-query-succeed.png
new file mode 100644
index 0000000000..0fdff564b3
Binary files /dev/null and
b/website/docs/development/images/local-query-succeed.png differ
