You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by kl...@apache.org on 2022/07/26 11:18:12 UTC
[incubator-devlake-website] branch kw-lake-2609-k8s-rds created (now b42bfa30)
This is an automated email from the ASF dual-hosted git repository.
klesh pushed a change to branch kw-lake-2609-k8s-rds
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
at b42bfa30 docs: updated k8s deployment / added RDS doc
This branch includes the following new commits:
new b42bfa30 docs: updated k8s deployment / added RDS doc
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[incubator-devlake-website] 01/01: docs: updated k8s deployment / added RDS doc
Posted by kl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
klesh pushed a commit to branch kw-lake-2609-k8s-rds
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit b42bfa3084461d0303b1f695f58e089e1bc53c69
Author: Klesh Wong <zh...@merico.dev>
AuthorDate: Tue Jul 26 19:17:25 2022 +0800
docs: updated k8s deployment / added RDS doc
---
docs/QuickStart/KubernetesSetup.md | 43 ++++++++++++++++++++++++--------------
1 file changed, 27 insertions(+), 16 deletions(-)
diff --git a/docs/QuickStart/KubernetesSetup.md b/docs/QuickStart/KubernetesSetup.md
index 692639fc..42f40cc9 100644
--- a/docs/QuickStart/KubernetesSetup.md
+++ b/docs/QuickStart/KubernetesSetup.md
@@ -5,29 +5,40 @@ description: >
sidebar_position: 2
---
+We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) for users interested in deploying Apache DevLake to a k8s cluster.
-We provide a sample [k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) for users interested in deploying Apache DevLake on a k8s cluster.
-
-[k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) will create a namespace `devlake` on your k8s cluster, and use `nodePort 30004` for `config-ui`, `nodePort 30002` for `grafana` dashboards. If you would like to use certain version of Apache DevLake, please update the image tag of `grafana`, `devlake` and `config-ui` services to specify versions like `v0.10.1`.
+[k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) will create a namespace `devlake` on your k8s cluster, and use `nodePort 30004` for `config-ui`, `nodePort 30002` for `grafana` dashboards. If you would like to use a specific version of Apache DevLake, please update the image tag of `grafana`, `devlake` and `config-ui` deployments.
## Step-by-step guide
1. Download [k8s-deploy.yaml](https://github.com/apache/incubator-devlake/blob/main/k8s-deploy.yaml) to local machine
-2. Some key points:
- - `config-ui` deployment:
- * `GRAFANA_ENDPOINT`: FQDN of grafana service which can be reached from user's browser
+2. Customize the settings (`devlake-config` config map):
+ - Settings shared between `grafana` and `mysql`
+ * `MYSQL_ROOT_PASSWORD`: set root password for `mysql`
+ * `MYSQL_USER`: shared between `mysql` and `grafana`
+ * `MYSQL_PASSWORD`: shared between `mysql` and `grafana`
+ * `MYSQL_DATABASE`: shared between `mysql` and `grafana`
+ * `MYSQL_URL`: set MySQL URL for `grafana` in `$HOST:$PORT` format
+ - Settings used by `config-ui`:
+ * `GRAFANA_ENDPOINT`: FQDN of grafana service which can be reached within k8s cluster, normally you don't need to change it unless namespace was changed
* `DEVLAKE_ENDPOINT`: FQDN of devlake service which can be reached within k8s cluster, normally you don't need to change it unless namespace was changed
* `ADMIN_USER`/`ADMIN_PASS`: Not required, but highly recommended
- - `devlake-config` config map:
- * `MYSQL_USER`: shared between `mysql` and `grafana` service
- * `MYSQL_PASSWORD`: shared between `mysql` and `grafana` service
- * `MYSQL_DATABASE`: shared between `mysql` and `grafana` service
- * `MYSQL_ROOT_PASSWORD`: set root password for `mysql` service
- - `devlake` deployment:
+ - Settings used by `devlake`:
* `DB_URL`: update this value if `MYSQL_USER`, `MYSQL_PASSWORD` or `MYSQL_DATABASE` were changed
3. The `devlake` deployment store its configuration in `/app/.env`. In our sample yaml, we use `hostPath` volume, so please make sure directory `/var/lib/devlake` exists on your k8s workers, or employ other techniques to persist `/app/.env` file. Please do NOT mount the entire `/app` directory, because plugins are located in `/app/bin` folder.
4. Finally, execute the following command, Apache DevLake should be up and running:
- ```sh
- kubectl apply -f k8s-deploy.yaml
- ```
-<br/><br/><br/>
+ ```sh
+ kubectl apply -f k8s-deploy.yaml
+ ```
+
+
+## FAQ
+
+- What if I want to replace MySQL with RDS?
+ First, remove the `mysql` deployment section, and then update the `devlake-config` configmap accordingly:
+ * `MYSQL_ROOT_PASSWORD`: remove this line
+ * `MYSQL_USER`: set RDS username for grafana
+ * `MYSQL_PASSWORD`: set RDS password for grafana
+ * `MYSQL_DATABASE`: set RDS database for grafana
+ * `MYSQL_URL`: set RDS URL for `grafana` in `$HOST:$PORT` format
+ * `DB_URL`: set RDS URL for `devlake`