You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by zk...@apache.org on 2023/03/08 08:46:24 UTC
[incubator-devlake-website] branch main updated: update dockercompose setup (#458)
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-website.git
The following commit(s) were added to refs/heads/main by this push:
new 6a511e998a update dockercompose setup (#458)
6a511e998a is described below
commit 6a511e998ac86b1f30f45f7d615a61def95ac204
Author: Warren Chen <yi...@merico.dev>
AuthorDate: Wed Mar 8 16:46:19 2023 +0800
update dockercompose setup (#458)
---
docs/GettingStarted/Authentication.md | 2 +-
docs/GettingStarted/DockerComposeSetup.md | 88 +++++++++++++++++++
docs/GettingStarted/HelmSetup.md | 99 ++++++++++------------
.../GettingStarted/DockerComposeSetup.md | 87 +++++++++++++++++++
.../version-v0.15/GettingStarted/HelmSetup.md | 97 ++++++++++-----------
5 files changed, 263 insertions(+), 110 deletions(-)
diff --git a/docs/GettingStarted/Authentication.md b/docs/GettingStarted/Authentication.md
index f8f27df55d..92184ba05d 100644
--- a/docs/GettingStarted/Authentication.md
+++ b/docs/GettingStarted/Authentication.md
@@ -8,7 +8,7 @@ The document explains how you can set up Apache DevLake securely.
First of all, there are 4 services included in the deployment:
-- database: `postgress` and `mysql` are supported, you may choose one of them or any other compatible DBS like cloud-based systems. You should follow the document from the database to make it secure.
+- database: `mysql` is supported, you may use it or any other compatible DBS like cloud-based systems. You should follow the document from the database to make it secure.
- grafana: You are likely to use it most of the time, browsing built-in dashboards, and creating your own customized metric. grafana supports [User Management](https://grafana.com/docs/grafana/latest/administration/user-management/), please follow the official document to set it up based on your need.
- devlake: This is the core service for Data Collection and Metric Calculation, all collected/calculated data would be stored to the database, and accessed by the `grafana` service. `devlake` itself doesn't support User Management of any kind, so we don't recommend that you expose its port to the outside world.
- config-ui: A web interface to set up `devlake` to do the work. You may set up an automated `blueprint` to collect data. `config-ui` supports `Basic Authentication`, by simply set up the Environment Variable `ADMIN_USER` and `ADMIN_PASS` for the container. There are commented lines in `config-ui.environment` section in our `docker-compose.yml` file for your convenience.
diff --git a/docs/GettingStarted/DockerComposeSetup.md b/docs/GettingStarted/DockerComposeSetup.md
index b1c7004189..0b18b2a868 100644
--- a/docs/GettingStarted/DockerComposeSetup.md
+++ b/docs/GettingStarted/DockerComposeSetup.md
@@ -33,6 +33,94 @@ 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?
+
+ 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:
+
+1. Comment out mysql part:
+```yaml
+ mysql:
+ image: mysql:8
+ volumes:
+ - mysql-storage:/var/lib/mysql
+ restart: always
+ ports:
+ - "127.0.0.1:3306:3306"
+ environment:
+ MYSQL_ROOT_PASSWORD: admin
+ MYSQL_DATABASE: lake
+ MYSQL_USER: merico
+ MYSQL_PASSWORD: merico
+ command:
+ --character-set-server=utf8mb4
+ --collation-server=utf8mb4_bin
+```
+
+2. Comment out the 'mysql' volume:
+
+```yaml
+volumes:
+ mysql-storage:
+```
+
+3. Comment out the 'depends_on mysql' part:
+
+```yaml
+ depends_on:
+ - mysql
+```
+
+4. 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"
+# Don't forget to create db named `lake` in your own db, and set character-set-server=utf8mb4, collation-server=utf8mb4_bin as below
+# character-set-server=utf8mb4
+# collation-server=utf8mb4_bin
+```
+
+
+5. 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:
+
+1. Comment out the 'grafana' part:
+
+```yaml
+ grafana:
+ image: mericodev/devlake-dashboard:latest
+ build:
+ context: grafana/
+ ports:
+ - "3002:3000"
+ volumes:
+ - grafana-storage:/var/lib/grafana
+ environment:
+ GF_SERVER_ROOT_URL: "http://localhost:4000/grafana"
+ GF_USERS_DEFAULT_THEME: "light"
+ MYSQL_URL: mysql:3306
+ MYSQL_DATABASE: lake
+ MYSQL_USER: merico
+ MYSQL_PASSWORD: merico
+ restart: always
+ depends_on:
+ - mysql
+```
+
+2. Comment out grafana volume:
+
+```yaml
+volumes:
+ 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`
+
## Troubleshooting
If you run into any problem, please check the [Troubleshooting](/Troubleshooting/Installation.md) or [create an issue](https://github.com/apache/incubator-devlake/issues)
diff --git a/docs/GettingStarted/HelmSetup.md b/docs/GettingStarted/HelmSetup.md
index 0d272794d7..07c61fa2b3 100644
--- a/docs/GettingStarted/HelmSetup.md
+++ b/docs/GettingStarted/HelmSetup.md
@@ -112,66 +112,55 @@ After the deployment, visit devlake at: https://devlake-0.example.com:8443, and
Some useful parameters for the chart, you could also check them in values.yaml
-| Parameter | Description | Default |
-| ----------------------------- | ---------------------------------------------------------- | -------------------------- |
-| replicaCount | Replica Count for devlake, currently not used | 1 |
-| imageTag | The version tag for all images | see Values.yaml |
-| mysql.useExternal | If use external mysql server, set true | false |
-| mysql.externalServer | External mysql server address | 127.0.0.1 |
-| mysql.externalPort | External mysql server port | 3306 |
-| mysql.username | username for mysql | merico |
-| mysql.password | password for mysql | merico |
-| mysql.database | database for mysql | lake |
-| mysql.rootPassword | root password for mysql | admin |
-| mysql.storage.class | storage class for mysql's volume | "" |
-| mysql.storage.size | volume size for mysql's data | 5Gi |
-| mysql.image.repository | repository for mysql's image | mysql |
-| mysql.image.tag | image tag for mysql's image | 8 |
-| mysql.image.pullPolicy | pullPolicy for mysql's image | IfNotPresent |
-| pgsql.useExternal | If use external pgsql server, set true | false |
-| pgsql.externalServer | External pgsql server address | 127.0.0.1 |
-| pgsql.externalPort | External pgsql server port | 3306 |
-| pgsql.username | username for pgsql | merico |
-| pgsql.password | password for pgsql | merico |
-| pgsql.database | database for pgsql | lake |
-| pgsql.storage.class | storage class for pgsql's volume | "" |
-| pgsql.storage.size | volume size for pgsql's data | 5Gi |
-| pgsql.image.repository | repository for pgsql's image | postgres |
-| pgsql.image.tag | image tag for pgsql's image | 14.5 |
-| pgsql.image.pullPolicy | pullPolicy for pgsql's image | IfNotPresent |
-| grafana.image.repository | repository for grafana's image | apache/devlake-dashboard |
-| grafana.image.pullPolicy | pullPolicy for grafana's image | Always |
-| lake.storage.class | storage class for lake's volume | "" |
-| lake.storage.size | volume size for lake's data | 100Mi |
-| lake.image.repository | repository for lake's image | apache/devlake |
-| lake.image.pullPolicy | pullPolicy for lake's image | Always |
-| lake.loggingDir | log dir for the lake server | /app/logs |
-| lake.loggingLevel | log level for the lake server | info |
-| lake.dotenv | initial configurations for injecting to lake's .env | see Values.yaml |
-| ui.image.repository | repository for ui's image | apache/devlake-config-ui |
-| ui.image.pullPolicy | pullPolicy for ui's image | Always |
-| ui.basicAuth.enabled | If the basic auth in ui is enabled | false |
-| ui.basicAuth.user | The user name for the basic auth | "admin" |
-| ui.basicAuth.password | The password for the basic auth | "admin" |
-| service.type | Service type for exposed service | NodePort |
-| service.uiPort | Node port for config ui | 32001 |
-| service.ingress.enabled | If ingress is enabled | false |
-| service.ingress.enableHttps | If https is enabled | false |
+| Parameter | Description | Default |
+| ----------------------------- | -------------------------------------------------------- | -------------------------- |
+| replicaCount | Replica Count for devlake, currently not used | 1 |
+| imageTag | The version tag for all images | see Values.yaml |
+| mysql.useExternal | If use external mysql server, set true | false |
+| mysql.externalServer | External mysql server address | 127.0.0.1 |
+| mysql.externalPort | External mysql server port | 3306 |
+| mysql.username | username for mysql | merico |
+| mysql.password | password for mysql | merico |
+| mysql.database | database for mysql | lake |
+| mysql.rootPassword | root password for mysql | admin |
+| mysql.storage.class | storage class for mysql's volume | "" |
+| mysql.storage.size | volume size for mysql's data | 5Gi |
+| mysql.image.repository | repository for mysql's image | mysql |
+| mysql.image.tag | image tag for mysql's image | 8 |
+| mysql.image.pullPolicy | pullPolicy for mysql's image | IfNotPresent |
+| grafana.image.repository | repository for grafana's image | apache/devlake-dashboard |
+| grafana.image.pullPolicy | pullPolicy for grafana's image | Always |
+| lake.storage.class | storage class for lake's volume | "" |
+| lake.storage.size | volume size for lake's data | 100Mi |
+| lake.image.repository | repository for lake's image | apache/devlake |
+| lake.image.pullPolicy | pullPolicy for lake's image | Always |
+| lake.loggingDir | log dir for the lake server | /app/logs |
+| lake.loggingLevel | log level for the lake server | info |
+| lake.dotenv | initial configurations for injecting to lake's .env | see Values.yaml |
+| ui.image.repository | repository for ui's image | apache/devlake-config-ui |
+| ui.image.pullPolicy | pullPolicy for ui's image | Always |
+| ui.basicAuth.enabled | If the basic auth in ui is enabled | false |
+| ui.basicAuth.user | The user name for the basic auth | "admin" |
+| ui.basicAuth.password | The password for the basic auth | "admin" |
+| service.type | Service type for exposed service | NodePort |
+| service.uiPort | Node port for config ui | 32001 |
+| service.ingress.enabled | If ingress is enabled | false |
+| service.ingress.enableHttps | If https is enabled | false |
| service.ingress.className | Class name for ingressClass. leave empty for using default | "" |
-| service.ingress.hostname | The hostname/domainname for ingress | localhost |
-| service.ingress.prefix | The prefix for endpoints, currently not used | / |
-| service.ingress.tlsSecretName | The secret name for tls's certificate for https | "" |
-| service.ingress.httpPort | The http port for ingress | 80 |
-| service.ingress.httpsPort | The https port for ingress | 443 |
-| option.localtime | The hostpath for mount as /etc/localtime | /etc/localtime |
-| option.database | The database type, valids: mysql, pgsql | mysql |
+| service.ingress.hostname | The hostname/domainname for ingress | localhost |
+| service.ingress.prefix | The prefix for endpoints, currently not used | / |
+| service.ingress.tlsSecretName | The secret name for tls's certificate for https | "" |
+| service.ingress.httpPort | The http port for ingress | 80 |
+| service.ingress.httpsPort | The https port for ingress | 443 |
+| option.localtime | The hostpath for mount as /etc/localtime | /etc/localtime |
+| 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.
- 2. Proviede the folllowing values while install from helm:
+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.
+2. Provide the following 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.
diff --git a/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md b/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
index 7c592a85f2..7607b77673 100644
--- a/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
+++ b/versioned_docs/version-v0.15/GettingStarted/DockerComposeSetup.md
@@ -35,6 +35,93 @@ 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?
+
+ 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:
+
+1. Comment out mysql part:
+```yaml
+ mysql:
+ image: mysql:8
+ volumes:
+ - mysql-storage:/var/lib/mysql
+ restart: always
+ ports:
+ - "127.0.0.1:3306:3306"
+ environment:
+ MYSQL_ROOT_PASSWORD: admin
+ MYSQL_DATABASE: lake
+ MYSQL_USER: merico
+ MYSQL_PASSWORD: merico
+ command:
+ --character-set-server=utf8mb4
+ --collation-server=utf8mb4_bin
+```
+
+2. Comment out the 'mysql' volume:
+
+```yaml
+volumes:
+ mysql-storage:
+```
+
+3. Comment out the 'depends_on mysql' part:
+
+```yaml
+ depends_on:
+ - mysql
+```
+
+4. 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"
+# Don't forget to create db named `lake` in your own db, and set character-set-server=utf8mb4, collation-server=utf8mb4_bin as below
+# character-set-server=utf8mb4
+# collation-server=utf8mb4_bin
+```
+
+
+5. 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:
+
+1. Comment out the 'grafana' part:
+
+```yaml
+ grafana:
+ image: mericodev/devlake-dashboard:latest
+ build:
+ context: grafana/
+ ports:
+ - "3002:3000"
+ volumes:
+ - grafana-storage:/var/lib/grafana
+ environment:
+ GF_SERVER_ROOT_URL: "http://localhost:4000/grafana"
+ GF_USERS_DEFAULT_THEME: "light"
+ MYSQL_URL: mysql:3306
+ MYSQL_DATABASE: lake
+ MYSQL_USER: merico
+ MYSQL_PASSWORD: merico
+ restart: always
+ depends_on:
+ - mysql
+```
+
+2. Comment out grafana volume:
+
+```yaml
+volumes:
+ 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`
## Troubleshooting
diff --git a/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md b/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
index ea118bd0e5..64d7e3c6b6 100644
--- a/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
+++ b/versioned_docs/version-v0.15/GettingStarted/HelmSetup.md
@@ -22,7 +22,7 @@ To install the chart with release name `devlake`:
```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
-helm install devlake devlake/devlake --version=0.15.1-beta5
+helm install devlake devlake/devlake --version=0.15.1-beta6
```
And visit your devlake from the node port (32001 by default).
@@ -47,7 +47,7 @@ Grafana URL `http://YOUR-NODE-IP:30091`
```shell
helm repo update
-helm upgrade --install devlake devlake/devlake --version=0.15.1-beta5
+helm upgrade --install devlake devlake/devlake --version=0.15.1-beta6
```
### Uninstall
@@ -112,59 +112,48 @@ After the deployment, visit devlake at: https://devlake-0.example.com:8443, and
Some useful parameters for the chart, you could also check them in values.yaml
-| Parameter | Description | Default |
-| ----------------------------- | ---------------------------------------------------------- | -------------------------- |
-| replicaCount | Replica Count for devlake, currently not used | 1 |
-| imageTag | The version tag for all images | see Values.yaml |
-| mysql.useExternal | If use external mysql server, set true | false |
-| mysql.externalServer | External mysql server address | 127.0.0.1 |
-| mysql.externalPort | External mysql server port | 3306 |
-| mysql.username | username for mysql | merico |
-| mysql.password | password for mysql | merico |
-| mysql.database | database for mysql | lake |
-| mysql.rootPassword | root password for mysql | admin |
-| mysql.storage.class | storage class for mysql's volume | "" |
-| mysql.storage.size | volume size for mysql's data | 5Gi |
-| mysql.image.repository | repository for mysql's image | mysql |
-| mysql.image.tag | image tag for mysql's image | 8 |
-| mysql.image.pullPolicy | pullPolicy for mysql's image | IfNotPresent |
-| pgsql.useExternal | If use external pgsql server, set true | false |
-| pgsql.externalServer | External pgsql server address | 127.0.0.1 |
-| pgsql.externalPort | External pgsql server port | 3306 |
-| pgsql.username | username for pgsql | merico |
-| pgsql.password | password for pgsql | merico |
-| pgsql.database | database for pgsql | lake |
-| pgsql.storage.class | storage class for pgsql's volume | "" |
-| pgsql.storage.size | volume size for pgsql's data | 5Gi |
-| pgsql.image.repository | repository for pgsql's image | postgres |
-| pgsql.image.tag | image tag for pgsql's image | 14.5 |
-| pgsql.image.pullPolicy | pullPolicy for pgsql's image | IfNotPresent |
-| grafana.image.repository | repository for grafana's image | apache/devlake-dashboard |
-| grafana.image.pullPolicy | pullPolicy for grafana's image | Always |
-| lake.storage.class | storage class for lake's volume | "" |
-| lake.storage.size | volume size for lake's data | 100Mi |
-| lake.image.repository | repository for lake's image | apache/devlake |
-| lake.image.pullPolicy | pullPolicy for lake's image | Always |
-| lake.loggingDir | log dir for the lake server | /app/logs |
-| lake.loggingLevel | log level for the lake server | info |
-| lake.dotenv | initial configurations for injecting to lake's .env | see Values.yaml |
-| ui.image.repository | repository for ui's image | apache/devlake-config-ui |
-| ui.image.pullPolicy | pullPolicy for ui's image | Always |
-| ui.basicAuth.enabled | If the basic auth in ui is enabled | false |
-| ui.basicAuth.user | The user name for the basic auth | "admin" |
-| ui.basicAuth.password | The password for the basic auth | "admin" |
-| service.type | Service type for exposed service | NodePort |
-| service.uiPort | Node port for config ui | 32001 |
-| service.ingress.enabled | If ingress is enabled | false |
-| service.ingress.enableHttps | If https is enabled | false |
+| Parameter | Description | Default |
+| ----------------------------- | -------------------------------------------------------- | -------------------------- |
+| replicaCount | Replica Count for devlake, currently not used | 1 |
+| imageTag | The version tag for all images | see Values.yaml |
+| mysql.useExternal | If use external mysql server, set true | false |
+| mysql.externalServer | External mysql server address | 127.0.0.1 |
+| mysql.externalPort | External mysql server port | 3306 |
+| mysql.username | username for mysql | merico |
+| mysql.password | password for mysql | merico |
+| mysql.database | database for mysql | lake |
+| mysql.rootPassword | root password for mysql | admin |
+| mysql.storage.class | storage class for mysql's volume | "" |
+| mysql.storage.size | volume size for mysql's data | 5Gi |
+| mysql.image.repository | repository for mysql's image | mysql |
+| mysql.image.tag | image tag for mysql's image | 8 |
+| mysql.image.pullPolicy | pullPolicy for mysql's image | IfNotPresent |
+| grafana.image.repository | repository for grafana's image | apache/devlake-dashboard |
+| grafana.image.pullPolicy | pullPolicy for grafana's image | Always |
+| lake.storage.class | storage class for lake's volume | "" |
+| lake.storage.size | volume size for lake's data | 100Mi |
+| lake.image.repository | repository for lake's image | apache/devlake |
+| lake.image.pullPolicy | pullPolicy for lake's image | Always |
+| lake.loggingDir | log dir for the lake server | /app/logs |
+| lake.loggingLevel | log level for the lake server | info |
+| lake.dotenv | initial configurations for injecting to lake's .env | see Values.yaml |
+| ui.image.repository | repository for ui's image | apache/devlake-config-ui |
+| ui.image.pullPolicy | pullPolicy for ui's image | Always |
+| ui.basicAuth.enabled | If the basic auth in ui is enabled | false |
+| ui.basicAuth.user | The user name for the basic auth | "admin" |
+| ui.basicAuth.password | The password for the basic auth | "admin" |
+| service.type | Service type for exposed service | NodePort |
+| service.uiPort | Node port for config ui | 32001 |
+| service.ingress.enabled | If ingress is enabled | false |
+| service.ingress.enableHttps | If https is enabled | false |
| service.ingress.className | Class name for ingressClass. leave empty for using default | "" |
-| service.ingress.hostname | The hostname/domainname for ingress | localhost |
-| service.ingress.prefix | The prefix for endpoints, currently not used | / |
-| service.ingress.tlsSecretName | The secret name for tls's certificate for https | "" |
-| service.ingress.httpPort | The http port for ingress | 80 |
-| service.ingress.httpsPort | The https port for ingress | 443 |
-| option.localtime | The hostpath for mount as /etc/localtime | /etc/localtime |
-| option.database | The database type, valids: mysql, pgsql | mysql |
+| service.ingress.hostname | The hostname/domainname for ingress | localhost |
+| service.ingress.prefix | The prefix for endpoints, currently not used | / |
+| service.ingress.tlsSecretName | The secret name for tls's certificate for https | "" |
+| service.ingress.httpPort | The http port for ingress | 80 |
+| service.ingress.httpsPort | The https port for ingress | 443 |
+| option.localtime | The hostpath for mount as /etc/localtime | /etc/localtime |
+| option.database | The database type, valids: mysql | mysql |
## FAQ
1. Can I use a managed Cloud database service instead of running database in Docker?