Metabase & Monk

This repository contains Monk.io template to deploy Metabase system either locally or on cloud of your choice (AWS, GCP, Azure, Digital Ocean).

Start

Setup Monk - https://docs.monk.io/monk-in-10/

Start monkd and login.

monk login --email=<email> --password=<password>

Local Deployment

This template is available directly from Monkhub.io therefore if you want a quick deploy simply run below command after launching monkd:

➜ monk list metabase
Type      Template           Repository  Version  Tags
runnable  metabase/db        local       -        -
group     metabase/metabase  local       -        -
runnable  metabase/server    local       -        analytics, sql, dashboard
➜  monk run metabase/metabase

✔ Started metabase/metabase

🔩 templates/local/metabase/metabase
 └─🧊 Peer QmPtVZCdz2nD8j9sUTUaXZ2L2Dsox2EfNj7DuXiRES72rf
    ├─📦 templates-local-metabase-metabase-metabase
    │  ├─🧩 metabase/metabase:latest
    │  └─🔌 open localhost:3000 -> 3000
    └─📦 templates-local-metabase-postgres-postgres
       ├─🧩 postgres:12
       ├─💾 /Users/karol/.monk/volumes/db_data -> /var/lib/postgresql/data
       └─🔌 open localhost:5432 -> 5432

💡 You can inspect and manage your above stack with these commands:
  monk logs (-f) metabase/metabase - Inspect logs
  monk shell     metabase/metabase - Connect to the container's shell
  monk do        metabase/metabase/action_name - Run defined action (if exists)
💡 Check monk help for more!

Cloud Deployment

To deploy the above system to your cloud provider, create a new Monk cluster and provision your instances.

➜  monk cluster new
? New cluster name metabase-deployment
✔ Cluster created
Your cluster has been created successfully.

➜  monk cluster provider add
? Cloud provider gcp
? GOOGLE_APPLICATION_CREDENTIALS is set. Try load it? Yes
✔ Provider added successfully

➜  monk cluster grow -p gcp
? Name for the new instance metabase-instance
? Tags (split by whitespace) metabase
? Instance region (gcp) europe-west2
? Instance zone (gcp) europe-west2-c
? Instance type (gcp) e2-standard-2
? Disk Size (GBs) 30
? Number of instances (or press ENTER to use default = 1) 2
✔ Creating a new instance(s) on gcp...
✔ Syncing nodes DONE
✔ Cluster grown successfully

Once cluster is ready execute the same command as for local just specify the tag

➜  monk run -t metabase metabase/metabase

Configuration

You can add/remove or override current configuration of the template or create a brand new one which could inherit the components that you require.

The current variables can be found in metabase/metabase/variables section

  variables:
    postgres-db-user:
      type: string
      value: metabase
    postgres-db-password:
      type: string
      value: DB_PASS
    postgres-db-name:
      type: string
      value: metabase
    metabase-port:
      type: string
      value: 3000

To override the settings or add new ones for your own template you can inherit it in this way:

namespace: my-metabase

metabase-prod:
  defines: process-group
  inherits: metabase/metabase
  variables:
    postgres-db-user: metabase-prod
    postgres-db-password: secure-postgres-pass

Logs & Shell

➜  monk logs -f metabase/metabase

➜  monk shell metabase/metabase