Add all-in-one Docker Compose and Grafana configuration

build/docker/README.md

@@ -20,3 +20,5 @@ The docker-compose files we use are as follows:
  runs MongoDB.
 - `docker-compose-full.yml`: This file launches all the applications needed to
  develop Yorkie. It also runs monitoring tools such as Prometheus and Grafana.
+- `docker-compose-deploy.yml`: This file is used to deploy Yorkie by one command.
+ It runs Yorkie, MongoDB, and monitoring tools.

build/docker/docker-compose-deploy.yml

@@ -0,0 +1,49 @@
+version: '3.3'
+
+services:
+  prometheus:
+    image: prom/prometheus:latest
+    container_name: prometheus
+    ports:
+      - '9090:9090'
+    command:
+      - --config.file=/etc/prometheus/prometheus.yml
+    volumes:
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml:ro
+  grafana:
+    image: grafana/grafana:latest
+    container_name: grafana
+    ports:
+      - '3000:3000'
+    command:
+      - --config=/etc/grafana/grafana.ini
+    volumes:
+      - ./grafana/dashboard.yml:/etc/grafana/provisioning/dashboards/dashboard.yml:ro
+      - ./grafana/grafana.ini:/etc/grafana/grafana.ini:ro
+      - ./grafana/datasources.yml:/etc/grafana/provisioning/datasources/datasources.yml:ro
+    depends_on:
+      - prometheus
+  mongo:
+    image: mongo:latest
+    container_name: mongo
+    restart: always
+    ports:
+      - '27017:27017'
+  yorkie:
+    build:
+      context: ../../
+      dockerfile: Dockerfile
+    container_name: 'yorkie'
+    command:
+      [
+        'server',
+        '--mongo-connection-uri',
+        'mongodb://mongo:27017',
+        '--enable-pprof',
+      ]
+    restart: always
+    ports:
+      - '8080:8080'
+      - '8081:8081'
+    depends_on:
+      - mongo

build/docker/grafana/README.md

@@ -0,0 +1,28 @@
+# Grafana Setup Guide
+
+## Importing Dashboards
+
+To import dashboards into Grafana, follow these steps:
+
+1. Open Grafana in your browser (http://localhost:3000).
+2. Log in with the default credentials (admin/admin).
+3. Click "Dashboards" in the left sidebar.
+4. Click "New" and then "Import".
+5. Use the Yorkie dashboard ID `18560` to import the dashboard.
+6. Click "Load" and "Import" and the dashboard will be made.
+
+## Setting a Default Dashboard
+
+If you want to set a default dashboard, follow these steps:
+
+1. Open the [Yorkie dashboard](https://grafana.com/grafana/dashboards/18560).
+2. Download the dashboard JSON file.
+3. Paste the contents into `build/docker/grafana/yorkie_dashboard.json`.
+4. Mount the docker volume to the Grafana container by adding the following line to your `docker-compose.yml` file:
+
+   ```yaml
+   volumes:
+     - ./grafana/your_dashboard_name.json:/var/lib/grafana/your_dashboard_name.json:ro
+   ```
+
+You can import other dashboards by following the same steps.

build/docker/grafana/dashboard.yml

@@ -0,0 +1,14 @@
+apiVersion: 1
+
+providers:
+  - name: 'dashboards'
+    orgId: 1
+    folder: ''
+    folderUid: ''
+    type: file
+    disableDeletion: true
+    updateIntervalSeconds: 10
+    allowUiUpdates: true
+    options:
+      path: /var/lib/grafana
+      foldersFromFilesStructure: true

build/docker/grafana/datasources.yml

@@ -0,0 +1,8 @@
+apiVersion: 1
+
+datasources:
+  - name: Prometheus
+    type: prometheus
+    access: proxy
+    url: http://prometheus:9090
+    isDefault: true

build/docker/grafana/grafana.ini

@@ -0,0 +1,21 @@
+[paths]
+provisioning = /etc/grafana/provisioning
+
+[server]
+http_port = 3000
+
+[security]
+admin_user = admin
+admin_password = admin
+
+[users]
+allow_sign_up = true
+
+[auth.anonymous]
+enabled = false
+
+[dashboards]
+versions_to_keep = 20
+
+[unified_alerting]
+enabled = true

build/docker/prometheus.yml

@@ -5,4 +5,6 @@ scrape_configs:
   static_configs:
   - targets:
     # win/mac hosts: Use address: host.docker.internal instead of address: localhost in the line below
+    # linux hosts: Use address: docker bridge ip (typically 172.17.0.1) instead of address: localhost in the line below
+    # when using docker-compose-deploy.yml, use address: yorkie instead of address: localhost in the line below
     - host.docker.internal:8081