[incubator-devlake-helm-chart] branch main updated: Refine HelmSetup.md (#132)

[zk...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-helm-chart.git


The following commit(s) were added to refs/heads/main by this push:
     new 91ba5bd  Refine HelmSetup.md (#132)
91ba5bd is described below

commit 91ba5bdfba71f3676c26df20cd1b7c9ae9c1232b
Author: Ji Bin <ma...@live.com>
AuthorDate: Mon May 22 17:02:28 2023 +0800

    Refine HelmSetup.md (#132)
    
    Signed-off-by: Ji Bin <ma...@live.com>
---
 HelmSetup.md | 75 ++++++++++++++++++++++++++++++++++++------------------------
 1 file changed, 45 insertions(+), 30 deletions(-)

diff --git a/HelmSetup.md b/HelmSetup.md
index 6cc45ef..0473f20 100644
--- a/HelmSetup.md
+++ b/HelmSetup.md
@@ -191,43 +191,58 @@ Some useful parameters for the chart, you could also check them in values.yaml
 
 1. Can I use a managed Cloud database service instead of running database in docker?
 
-Yes, it just set useExternal value to true while you deploy devlake with helm chart. Below we'll use MySQL on AWS RDS as an example.
+  Yes, it just set useExternal value to true while you deploy devlake with helm chart. Below we'll use MySQL on AWS RDS as an example.
+
+  a. (Optional) Create a MySQL instance on AWS RDS following this [doc](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html), skip this step if you'd like to use an existing instance
+  b. Proviede below values while install from helm:
+
+    - `mysql.useExternal`: this should be `true`
+    - `mysql.externalServer`: use your RDS instance's IP address or domain name.
+    - `mysql.externalPort`: use your RDS instance's database port.
+    - `mysql.username`: use your `username` for access RDS instance's DB
+    - `mysql.password`: use your `password` for access RDS instance's DB
+    - `mysql.database`: use your RDS instance's DB name, you may need to create a database first with `CREATE DATABASE <DB name>;`
+
+  Here is the example:
+
+  ```
+  helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
+  helm repo update
+  helm install devlake devlake/devlake \
+    --set mysql.useExternal=true \
+    --set mysql.externalServer=db.example.com \
+    --set mysql.externalPort=3306 \
+    --set mysql.username=admin \
+    --set mysql.password=password_4_admin \
+    --set mysql.database=devlake
+  ```
 
-1. (Optional) Create a MySQL instance on AWS RDS following this [doc](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.MySQL.html), skip this step if you'd like to use an existing instance
-2. Proviede below values while install from helm:
-
-   - `mysql.useExternal`: this should be `true`
-   - `mysql.externalServer`: use your RDS instance's IP address or domain name.
-   - `mysql.externalPort`: use your RDS instance's database port.
-   - `mysql.username`: use your `username` for access RDS instance's DB
-   - `mysql.password`: use your `password` for access RDS instance's DB
-   - `mysql.database`: use your RDS instance's DB name, you may need to create a database first with `CREATE DATABASE <DB name>;`
+2. Can I use a secret to store the database connection details?
 
-Here is the example:
+  Yes, to do so, you need to have a secret in your Kubernetes Cluster that contains the following values:
 
-```
-helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
-helm repo update
-helm install devlake devlake/devlake \
-  --set mysql.useExternal=true \
-  --set mysql.externalServer=db.example.com \
-  --set mysql.externalPort=3306 \
-  --set mysql.username=admin \
-  --set mysql.password=password_4_admin \
-  --set mysql.database=devlake
-```
+  - `MYSQL_USER`: The user to connect to your DB.
+  - `MYSQL_PASSWORD`: The password to connect to your DB.
+  - `MYSQL_DATABASE`: The database to connect to your DB.
+  - `MYSQL_ROOT_PASSWORD`: The root password to connect to your DB.
+  - `DB_URL`: mysql://`username`:`password`@`dbserver`:`port`/`database`?charset=utf8mb4&parseTime=True
 
-2. Can I use a secret to store the database connection details?
+  The secret name needs to be the same as the value `option.connectionSecretName`
 
-Yes, to do so, you need to have a secret in your Kubernetes Cluster that contains the following values:
+3. Can I use an external Grafana instead of running built-in Grafana?
 
-- `MYSQL_USER`: The user to connect to your DB.
-- `MYSQL_PASSWORD`: The password to connect to your DB.
-- `MYSQL_DATABASE`: The database to connect to your DB.
-- `MYSQL_ROOT_PASSWORD`: The root password to connect to your DB.
-- `DB_URL`: mysql://`username`:`password`@`dbserver`:`port`/`database`?charset=utf8mb4&parseTime=True
+  Yes, the devlake helm chart supports using an external Grafana. You can set the following values while installing from helm:
+  - `grafana.useExternal`: this should be `true`
+  - `grafana.externalUrl`: use your Grafana's URL, e.g. `https://grafana.example.com`
 
-The secret name needs to be the same as the value `option.connectionSecretName`
+  Here is the example:
+  ```
+  helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
+  helm repo update
+  helm install devlake devlake/devlake \
+    --set grafana.useExternal=true \
+    --set grafana.externalUrl=https://grafana.example.com
+  ```
 
 ## Troubleshooting