This is an automated email from the ASF dual-hosted git repository.
xxyu pushed a commit to branch kylin4_on_cloud
in repository https://gitbox.apache.org/repos/asf/kylin.git
The following commit(s) were added to refs/heads/kylin4_on_cloud by this push:
new 0a14eeb # update README.md && fix some typo
0a14eeb is described below
commit 0a14eebcd50720e11121fe38f3be9a9fe0b4f9a4
Author: Mukvin <[email protected]>
AuthorDate: Tue Jan 25 16:03:04 2022 +0800
# update README.md && fix some typo
---
README.md | 12 ++++++------
images/kylinlogin.png | Bin 0 -> 176901 bytes
readme/advanced_configs.md | 16 +++++++---------
readme/prerequisites.md | 2 +-
4 files changed, 14 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index b384960..5a87e3e 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,8 @@
1. Deploy Kylin4 on Ec2 with Spark Standalone mode in `10` minutes.
2. Support to scale nodes (Kylin & Spark Worker) quickly and conveniently.
-4. Improve performance for query of Kylin4 in using `Local Cache + Soft
Affinity` feature (`Experimental Feature`), please check the
[details](https://kylin.apache.org/blog/2021/10/21/Local-Cache-and-Soft-Affinity-Scheduling/).
-5. Support to monitor status of cluster with `prometheus server` and
`granfana`.
+3. Improve performance for query of Kylin4 in using `Local Cache + Soft
Affinity` feature (`Experimental Feature`), please check the
[details](https://kylin.apache.org/blog/2021/10/21/Local-Cache-and-Soft-Affinity-Scheduling/).
+4. Support to monitor status of cluster with `prometheus server` and
`granfana`.
## Architecture
@@ -48,13 +48,13 @@ When cluster created, services and nodes will like below:
4. Init local env.
-```She
+```shell
$ bin/init.sh
```
> Note: Following the information into a python virtual env and get the help
> messages.
-5. Execute commands to deploy a `default` cluster.
+5. Execute commands to deploy a `default` cluster, please check
[details](./readme/prerequisites.md#cluster).
```shell
$ python deploy.py --type deploy
@@ -72,14 +72,14 @@ Then you can check the `public ip` of Kylin Node.
You can access `Kylin` web by `http://{kylin public ip}:7070/kylin`.
+
+
7. Destroy the `default` cluster.
```shell
$ python deploy.py --type destroy
```
-
-
## Notes
1. More details about `quick start for mutilple clusters`, see document [quick
start for mutilple clusters](./readme/quick_start_for_multiple_clusters.md)
diff --git a/images/kylinlogin.png b/images/kylinlogin.png
new file mode 100644
index 0000000..7dcd7d6
Binary files /dev/null and b/images/kylinlogin.png differ
diff --git a/readme/advanced_configs.md b/readme/advanced_configs.md
index 106c1ae..cd60193 100644
--- a/readme/advanced_configs.md
+++ b/readme/advanced_configs.md
@@ -1,6 +1,6 @@
## Advanced Configs
-### Advaced Params
+### Advanced Params
There are `9` modules params for tools. Introductions as below:
@@ -23,18 +23,18 @@ There are `9` modules params for tools. Introductions as
below:
> Note:
>
> 1. `KYLIN_SCALE_UP_NODES` is for the range of kylin nodes to scale up.
- > 1. `KYLIN_SCALE_DOWN_NODES` is for the range of kylin nodes to scale down.
- > 1. The range of `KYLIN_SCALE_UP_NODES` must be contain the range of
`KYLIN_SCALE_DOWN_NODES`.
- > 1. **They are effective to all clusters which is not only `default
cluster` but also other cluster which index is in `${CLUSTER_INDEXES}`.**
+ > 2. `KYLIN_SCALE_DOWN_NODES` is for the range of kylin nodes to scale down.
+ > 3. The range of `KYLIN_SCALE_UP_NODES` must be contain the range of
`KYLIN_SCALE_DOWN_NODES`.
+ > 4. **They are effective to all clusters which is not only `default
cluster` but also other cluster which index is in `${CLUSTER_INDEXES}`.**
- EC2_SPARK_SCALE_SLAVE_PARAMS: this params of module are for scaling **Spark
workers**, the range of **Spark Workers ** is related to
`SPARK_WORKER_SCALE_UP_NODES` and `SPARK_WORKER_SCALE_DOWN_NODES`.
> Note:
>
> 1. `SPARK_WORKER_SCALE_UP_NODES` is for the range for spark workers to
scale up. **It's effective to all clusters which is not only `default cluster`
but also other cluster which index is in `${CLUSTER_INDEXES}`.**
- > 1. `SPARK_WORKER_SCALE_DOWN_NODES` is for the range for spark workers to
scale down. **It's effective to all clusters which is not only `default
cluster` but also other cluster which index is in `${CLUSTER_INDEXES}`.**
- > 1. The range of `SPARK_WORKER_SCALE_UP_NODES` must be contain the range of
`SPARK_WORKER_SCALE_DOWN_NODES`.
- > 1. **They are effective to all clusters which is not only `default
cluster` but also other cluster which index is in `${CLUSTER_INDEXES}`.**
+ > 2. `SPARK_WORKER_SCALE_DOWN_NODES` is for the range for spark workers to
scale down. **It's effective to all clusters which is not only `default
cluster` but also other cluster which index is in `${CLUSTER_INDEXES}`.**
+ > 3. The range of `SPARK_WORKER_SCALE_UP_NODES` must be contain the range of
`SPARK_WORKER_SCALE_DOWN_NODES`.
+ > 4. **They are effective to all clusters which is not only `default
cluster` but also other cluster which index is in `${CLUSTER_INDEXES}`.**
### Customize Configs
@@ -46,8 +46,6 @@ User also can customize the params in `kylin_configs.yaml` to
create an expected
4. Now`Ec2Mode` **only effect** the related params are
`Ec2InstanceTypeFor*`,`Ec2VolumeSizeFor*` and `Ec2VolumnTypeFor`* in the
params modules.
5. If you don't change `ENABLE_LOCAL_CACHE_SOFT_AFFINITY` from `"false"` to
`"true"` then cluster will created normally without `Local Cache + Soft
Affinity` feature!
-
-
#### Example
As an example in `EC2_STATIC_SERVICES_PARAMS`:
diff --git a/readme/prerequisites.md b/readme/prerequisites.md
index 5bcdac7..541737d 100644
--- a/readme/prerequisites.md
+++ b/readme/prerequisites.md
@@ -213,4 +213,4 @@ $ bin/init.sh
-7. **(Important !!!)** If you want to re-fill the `kylin.properties` for a
`kylin` node in specify cluster, you need to remove the `.rendered` file and
re-copy the `kylin.propertie.template` . Redo steps from `3` to `6`.
\ No newline at end of file
+8. **(Important !!!)** If you want to re-fill the `kylin.properties` for a
`kylin` node in specify cluster, you need to remove the `.rendered` file and
re-copy the `kylin.propertie.template` . Redo steps from `3` to `6`.
\ No newline at end of file
