You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by he...@apache.org on 2023/03/22 22:40:31 UTC
[incubator-devlake-website] branch main updated: docs: update docker compose setup according to review (#463)
This is an automated email from the ASF dual-hosted git repository.
hez pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new fbae22cc70 docs: update docker compose setup according to review (#463)
fbae22cc70 is described below
commit fbae22cc70902a9e397e65581ae4de85c05e20fc
Author: Warren Chen <yi...@merico.dev>
AuthorDate: Thu Mar 23 06:40:25 2023 +0800
docs: update docker compose setup according to review (#463)
* docs: update docker compose setup according to review
* update for review
* update for review 2
---
docs/GettingStarted/DockerComposeSetup.md | 42 ++++++++++++++++------
docs/GettingStarted/HelmSetup.md | 2 +-
.../version-v0.12/QuickStart/KubernetesSetup.md | 2 +-
.../GettingStarted/KubernetesSetup.md | 2 +-
.../GettingStarted/KubernetesSetup.md | 2 +-
.../GettingStarted/DockerComposeSetup.md | 42 ++++++++++++++++------
.../version-v0.15/GettingStarted/HelmSetup.md | 2 +-
7 files changed, 67 insertions(+), 27 deletions(-)
diff --git a/docs/GettingStarted/DockerComposeSetup.md b/docs/GettingStarted/DockerComposeSetup.md
index 0b18b2a868..63d4b1ba86 100644
--- a/docs/GettingStarted/DockerComposeSetup.md
+++ b/docs/GettingStarted/DockerComposeSetup.md
@@ -34,11 +34,11 @@ Support for database schema migration was introduced to DevLake in v0.10.0. From
<br/>
## FAQ
-### Can I use an external Database service instead of running Database in Docker?
+### Can I use a managed cloud database service instead of running database in Docker?
- Yes, you can simply comment out the 'mysql' part in 'docker-compose.yml' and update some configurations in '.env' before you run docker compose up -d, here are the steps:
+Yes, please follow the steps below:
-1. Comment out mysql part:
+1. Comment out the 'mysql' part in `docker-compose.yml`:
```yaml
mysql:
image: mysql:8
@@ -57,21 +57,36 @@ Support for database schema migration was introduced to DevLake in v0.10.0. From
--collation-server=utf8mb4_bin
```
-2. Comment out the 'mysql' volume:
+2. Comment out the 'mysql' volume in `docker-compose.yml`:
```yaml
volumes:
mysql-storage:
```
-3. Comment out the 'depends_on mysql' part:
+3. Comment out the 'depends_on mysql' part in `docker-compose.yml`:
```yaml
depends_on:
- mysql
```
-4. Set DB_URL to your own DB_URL in .env
+4. Provide your managed cloud database connection info in the 'grafana' section in `docker-compose.yml`:
+
+* MYSQL_URL: This parameter specifies the URL of your database instance. For example, if your database is hosted on a server with IP address 123.45.67.89 and port number 3306, the URL would be "123.45.67.89:3306".
+* MYSQL_DATABASE: This parameter specifies the name of your database. For example, if your database is named "mydatabase", you would set this parameter to "mydatabase".
+* MYSQL_USER: This parameter specifies the username that you will use to connect to your database. For example, if your username is "myuser", you would set this parameter to "myuser".
+* MYSQL_PASSWORD: This parameter specifies the password that you will use to connect to your database. For example, if your password is "mypassword", you would set this parameter to "mypassword".
+
+
+```yaml
+ MYSQL_URL: 123.45.67.89:3306
+ MYSQL_DATABASE: mydatabase
+ MYSQL_USER: myuser
+ MYSQL_PASSWORD: mypassword
+```
+
+5. Set DB_URL to your own DB_URL in `.env`:
```bash
DB_URL="mysql://YOUR_USER:YOUR_PASSWORD@YOUR_IP:YOUR_PORT/lake?charset=utf8mb4&parseTime=True"
@@ -80,12 +95,11 @@ DB_URL="mysql://YOUR_USER:YOUR_PASSWORD@YOUR_IP:YOUR_PORT/lake?charset=utf8mb4&p
# collation-server=utf8mb4_bin
```
-
-5. Final step: `docker compose up -d`
+6. Final step: `docker compose up -d`
### Can I use an external Grafana instead of running Grafana in Docker?
- Yes, you can simply comment out grafana part in docker-compose.yml and update some configurations in .env before you run `docker compose up -d`, here are the steps:
+Yes, please follow the steps below:
1. Comment out the 'grafana' part:
@@ -114,12 +128,18 @@ DB_URL="mysql://YOUR_USER:YOUR_PASSWORD@YOUR_IP:YOUR_PORT/lake?charset=utf8mb4&p
```yaml
volumes:
- grafana-storage:
+ grafana-storage:
```
3. Set config-ui.environment.GRAFANA_ENDPOINT to your own grafana url in docker-compose.yml
-4. Final step: `docker compose up -d`
+4. Please connect your Grafana to DevLake's database by following https://grafana.com/docs/grafana/latest/administration/data-source-management/
+
+5. If you want to import dashboards, please check https://grafana.com/docs/grafana/latest/dashboards/export-import/.
+
+* You can find DevLake's self-built Grafana dashboards here (https://github.com/apache/incubator-devlake/tree/main/grafana/dashboards).
+
+6. Final step: `docker compose up -d`
## Troubleshooting
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index 07c61fa2b3..ba3de37972 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -156,7 +156,7 @@ Some useful parameters for the chart, you could also check them in values.yaml
| option.database | The database type, valids: mysql | mysql |
## FAQ
-### 1. Can I use a managed Cloud database service instead of running database in Docker?
+### 1. Can I use a managed cloud database service instead of running database in Docker?
Yes, you can just set useExternal value to true while deploying devlake with helm chart. Below we will use MySQL on AWS RDS as an example.
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 would like to use an existing instance.
diff --git a/versioned_docs/version-v0.12/QuickStart/KubernetesSetup.md b/versioned_docs/version-v0.12/QuickStart/KubernetesSetup.md
index 4c1989dce7..6ef65705af 100644
--- a/versioned_docs/version-v0.12/QuickStart/KubernetesSetup.md
+++ b/versioned_docs/version-v0.12/QuickStart/KubernetesSetup.md
@@ -42,7 +42,7 @@ We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlak
## FAQ
-1. Can I use a managed Cloud database service instead of running database in docker?
+1. Can I use a managed Cloud database service instead of running database in k8s?
Yes, it only takes a few changes in the sample yaml file to make it happen. Below we'll use MySQL on AWS RDS as an example.
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. Remove the `mysql` deployment and service sections from `k8s-deploy.yaml`
diff --git a/versioned_docs/version-v0.13/GettingStarted/KubernetesSetup.md b/versioned_docs/version-v0.13/GettingStarted/KubernetesSetup.md
index 29bdc4e8d7..29ce1d951c 100644
--- a/versioned_docs/version-v0.13/GettingStarted/KubernetesSetup.md
+++ b/versioned_docs/version-v0.13/GettingStarted/KubernetesSetup.md
@@ -43,7 +43,7 @@ We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlak
## FAQ
-1. Can I use a managed Cloud database service instead of running database in docker?
+1. Can I use a managed Cloud database service instead of running database in k8s?
Yes, it only takes a few changes in the sample yaml file. Below we'll use MySQL on AWS RDS as an example.
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
diff --git a/versioned_docs/version-v0.14/GettingStarted/KubernetesSetup.md b/versioned_docs/version-v0.14/GettingStarted/KubernetesSetup.md
index d17bc9ad44..6c605240c6 100644
--- a/versioned_docs/version-v0.14/GettingStarted/KubernetesSetup.md
+++ b/versioned_docs/version-v0.14/GettingStarted/KubernetesSetup.md
@@ -43,7 +43,7 @@ We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlak
## FAQ
-1. Can I use a managed Cloud database service instead of running database in docker?
+1. Can I use a managed Cloud database service instead of running database in k8s?
Yes, it only takes a few changes in the sample yaml file. Below we'll use MySQL on AWS RDS as an example.
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
diff --git a/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md b/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
index 7607b77673..03df49e0fe 100644
--- a/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
+++ b/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
@@ -36,11 +36,11 @@ Support for database schema migration was introduced to DevLake in v0.10.0. From
<br/>
## FAQ
-### Can I use an external Database service instead of running Database in Docker?
+### Can I use a managed cloud database service instead of running database in Docker?
- Yes, you can simply comment out the 'mysql' part in 'docker-compose.yml' and update some configurations in '.env' before you run docker compose up -d, here are the steps:
+Yes, please follow the steps below:
-1. Comment out mysql part:
+1. Comment out the 'mysql' part in `docker-compose.yml`:
```yaml
mysql:
image: mysql:8
@@ -59,21 +59,36 @@ Support for database schema migration was introduced to DevLake in v0.10.0. From
--collation-server=utf8mb4_bin
```
-2. Comment out the 'mysql' volume:
+2. Comment out the 'mysql' volume in `docker-compose.yml`:
```yaml
volumes:
mysql-storage:
```
-3. Comment out the 'depends_on mysql' part:
+3. Comment out the 'depends_on mysql' part in `docker-compose.yml`:
```yaml
depends_on:
- mysql
```
-4. Set DB_URL to your own DB_URL in .env
+4. Provide your managed cloud database connection info in the 'grafana' section in `docker-compose.yml`:
+
+* MYSQL_URL: This parameter specifies the URL of your database instance. For example, if your database is hosted on a server with IP address 123.45.67.89 and port number 3306, the URL would be "123.45.67.89:3306".
+* MYSQL_DATABASE: This parameter specifies the name of your database. For example, if your database is named "mydatabase", you would set this parameter to "mydatabase".
+* MYSQL_USER: This parameter specifies the username that you will use to connect to your database. For example, if your username is "myuser", you would set this parameter to "myuser".
+* MYSQL_PASSWORD: This parameter specifies the password that you will use to connect to your database. For example, if your password is "mypassword", you would set this parameter to "mypassword".
+
+
+```yaml
+ MYSQL_URL: 123.45.67.89:3306
+ MYSQL_DATABASE: mydatabase
+ MYSQL_USER: myuser
+ MYSQL_PASSWORD: mypassword
+```
+
+5. Set DB_URL to your own DB_URL in `.env`:
```bash
DB_URL="mysql://YOUR_USER:YOUR_PASSWORD@YOUR_IP:YOUR_PORT/lake?charset=utf8mb4&parseTime=True"
@@ -82,12 +97,11 @@ DB_URL="mysql://YOUR_USER:YOUR_PASSWORD@YOUR_IP:YOUR_PORT/lake?charset=utf8mb4&p
# collation-server=utf8mb4_bin
```
-
-5. Final step: `docker compose up -d`
+6. Final step: `docker compose up -d`
### Can I use an external Grafana instead of running Grafana in Docker?
- Yes, you can simply comment out grafana part in docker-compose.yml and update some configurations in .env before you run `docker compose up -d`, here are the steps:
+Yes, please follow the steps below:
1. Comment out the 'grafana' part:
@@ -116,12 +130,18 @@ DB_URL="mysql://YOUR_USER:YOUR_PASSWORD@YOUR_IP:YOUR_PORT/lake?charset=utf8mb4&p
```yaml
volumes:
- grafana-storage:
+ grafana-storage:
```
3. Set config-ui.environment.GRAFANA_ENDPOINT to your own grafana url in docker-compose.yml
-4. Final step: `docker compose up -d`
+4. Please connect your Grafana to DevLake's database by following https://grafana.com/docs/grafana/latest/administration/data-source-management/
+
+5. If you want to import dashboards, please check https://grafana.com/docs/grafana/latest/dashboards/export-import/.
+
+* You can find DevLake's self-built Grafana dashboards here (https://github.com/apache/incubator-devlake/tree/main/grafana/dashboards).
+
+6. Final step: `docker compose up -d`
## Troubleshooting
diff --git a/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md b/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
index 64d7e3c6b6..da52a9ee7e 100644
--- a/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
+++ b/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
@@ -156,7 +156,7 @@ Some useful parameters for the chart, you could also check them in values.yaml
| option.database | The database type, valids: mysql | mysql |
## FAQ
-1. Can I use a managed Cloud database service instead of running database in Docker?
+1. Can I use a managed cloud database service instead of running database in Docker?
Yes, you can just set useExternal value to true while deploying devlake with helm chart. Below we will use MySQL on AWS RDS as an example.
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 would like to use an existing instance.