Update to 2021-12-01 19:13

roles/metabase/defaults/main.yml

@@ -0,0 +1,56 @@
+---
+
+# Version to deploy
+metabase_version: 0.41.2
+# URL to fetch the jar
+metabase_jar_url: https://downloads.metabase.com/v{{ metabase_version }}/metabase.jar
+# Expected sha1 of the jar
+metabase_jar_sha256: d2303557342f3d88437d634fd38bd4b3657b7a31e5ad891e45b001801c121bf5
+# Should ansible handle upgrades ? If set to false, only the initial install (and the config) will be handled
+metabase_manage_upgrade: True
+
+# User account under which metabase will run
+# Will be created
+metabase_user: metabase
+# Path under which metabase will be installed
+metabase_root_dir: /opt/metabase
+
+# Port on which metabase will listen
+metabase_port: 3002
+# List of IP or CIDR allowed to reach metabase_port
+metabase_src_ip: []
+
+# application database
+# Can be either mysql or postgres
+metabase_db_engine: mysql
+metabase_db_server: "{{ (metabase_db_engine == 'mysql') | ternary(mysql_server, pg_server) | default('localhost') }}"
+metabase_db_port: "{{ (metabase_db_engine == 'mysql') | ternary('3306', '5432') }}"
+metabase_db_name: metabase
+metabase_db_user: metabase
+# A random pass will be generated and stored in the meta dir if not defined
+# metabase_db_pass: S3cr3t.
+
+# Email of the admins
+metabase_admin_email: "{{ system_admin_email }}"
+# From email for emails sent by metabase
+metabase_from_email: metabase-noreply@{{ ansible_domain }}
+# Settings for sending emails
+metabase_smtp_server: localhost
+metabase_smtp_port: 25
+# metabase_smtp_user: metabase@example.org
+# metabase_smtp_pass: S3cr3t.
+metabase_smtp_starttls: False
+
+# Encryption key to protect credentials stored in the DB
+# If not set, a random one will be created and store in the mata directory
+# metabase_encryption_key: SuperS3cr3t.
+
+# Default language for notifications
+metabase_lang: fr
+
+# Public URL to reach metabase.
+# Will most likely need to be adjusted, because you'll put it behind a reverse proxy don't you ?
+metabase_public_url: http://{{ inventory_hostname }}:{{ metabase_port }}/
+
+# Enable or disable big queries cache in metabase DB
+metabase_enable_cache: True

roles/metabase/handlers/main.yml

@@ -0,0 +1,4 @@
+---
+
+- name: restart metabase
+  service: name=metabase state=restarted

roles/metabase/meta/main.yml

@@ -0,0 +1,7 @@
+---
+
+dependencies:
+  - role: mysql_server
+    when: metabase_db_server in ['localhost','127.0.0.1'] and metabase_db_engine == 'mysql'
+  - role: postgresql_server
+    when: metabase_db_server in ['localhost','127.0.0.1'] and metabase_db_engine == 'postgres'

roles/metabase/tasks/archive_post.yml

@@ -0,0 +1,10 @@
+---
+
+- name: Compress previous version
+  command: tar cf {{ metabase_root_dir }}/archives/{{ metabase_current_version }}.tar.zst --use-compress-program=zstd ./
+  environment:
+    ZSTD_CLEVEL: 10
+  args:
+    chdir: "{{ metabase_root_dir }}/archives/{{ metabase_current_version }}"
+    warn: False
+  tags: metabase

roles/metabase/tasks/archive_pre.yml

@@ -0,0 +1,52 @@
+---
+
+- name: Create the archive dir
+  file:
+    path: "{{ metabase_root_dir }}/archives/{{ metabase_current_version }}"
+    state: directory
+  tags: metabase
+
+- name: Archive previous version
+  synchronize:
+    src: "{{ metabase_root_dir }}/{{ item }}"
+    dest: "{{ metabase_root_dir }}/archives/{{ metabase_current_version }}"
+    recursive: True
+    delete: True
+  loop:
+    - app
+    - plugins
+    - data
+    - etc
+  delegate_to: "{{ inventory_hostname }}"
+  tags: metabase
+
+- name: Dump the database
+  mysql_db:
+    state: dump
+    name: "{{ metabase_db_name }}"
+    target: "{{ metabase_root_dir }}/archives/{{ metabase_current_version }}/{{ metabase_db_name }}.sql.xz"
+    login_host: "{{ metabase_db_server }}"
+    login_port: "{{ metabase_db_port }}"
+    login_user: "{{ metabase_db_user }}"
+    login_password: "{{ metabase_db_pass }}"
+    quick: True
+    single_transaction: True
+  environment:
+    XZ_OPT: -T0
+  when: metabase_db_engine == 'mysql'
+  tags: metabase
+
+- name: Dump the database
+  shell: >
+    /usr/pgsql-14/bin/pg_dump
+    --clean
+    --create
+    --host={{ metabase_db_server }}
+    --port={{ metabase_db_port }}
+    --username={{ metabase_db_user }} {{ metabase_db_name }} |
+    zstd -10 -c > {{ metabase_root_dir }}/archives/{{ metabase_current_version }}/{{ metabase_db_name }}.sql.zst
+  environment:
+    - PGPASSWORD: "{{ metabase_db_pass }}"
+  when: metabase_db_engine == 'postgres'
+  tags: metabase
+

roles/metabase/tasks/cleanup.yml

@@ -0,0 +1,8 @@
+---
+
+- name: Remove tmp and unused files
+  file: path={{ item }} state=absent
+  loop:
+    - "{{ metabase_root_dir }}/archives/{{ metabase_current_version }}"
+    - "{{ metabase_root_dir }}/tmp/metabase.jar"
+  tags: metabase

roles/metabase/tasks/conf.yml

@@ -0,0 +1,6 @@
+---
+
+- name: Deploy configuration
+  template: src=env.j2 dest={{ metabase_root_dir }}/etc/env group={{ metabase_user }} mode=640
+  notify: restart metabase
+  tags: metabase

roles/metabase/tasks/directories.yml

@@ -0,0 +1,23 @@
+---
+
+- name: Create needed directories
+  file: path={{ item.dir }} state=directory owner={{ item.owner | default(omit) }} group={{ item.group | default(omit) }} mode={{ item.mode | default(omit) }}
+  loop:
+    - dir: "{{ metabase_root_dir }}/app"
+    - dir: "{{ metabase_root_dir }}/tmp"
+    - dir: "{{ metabase_root_dir }}/data"
+      owner: "{{ metabase_user }}"
+      mode: 700
+    - dir: "{{ metabase_root_dir }}/etc"
+      group: "{{ metabase_user }}"
+      mode: 750
+    - dir: "{{ metabase_root_dir }}/plugins"
+      owner: "{{ metabase_user }}"
+    - dir: "{{ metabase_root_dir }}/archives"
+      mode: 700
+    - dir: "{{ metabase_root_dir }}/meta"
+      mode: 700
+    - dir: "{{ metabase_root_dir }}/backup"
+      mode: 700
+  tags: metabase
+

roles/metabase/tasks/facts.yml

@@ -0,0 +1,29 @@
+---
+
+# Detect installed version (if any)
+- block:
+    - import_tasks: ../includes/webapps_set_install_mode.yml
+      vars:
+        - root_dir: "{{ metabase_root_dir }}"
+        - version: "{{ metabase_version }}"
+    - set_fact: metabase_install_mode={{ (install_mode == 'upgrade' and not metabase_manage_upgrade) | ternary('none',install_mode) }}
+    - set_fact: metabase_current_version={{ current_version | default('') }}
+  tags: metabase
+
+# Create a random pass for the DB if needed
+- block:
+    - import_tasks: ../includes/get_rand_pass.yml
+      vars:
+        - pass_file: "{{ metabase_root_dir }}/meta/ansible_dbpass"
+    - set_fact: metabase_db_pass={{ rand_pass }}
+  when: metabase_db_pass is not defined
+  tags: metabase
+
+# Create a random encryption key
+- block:
+    - import_tasks: ../includes/get_rand_pass.yml
+      vars:
+        - pass_file: "{{ metabase_root_dir }}/meta/ansible_encryption_key"
+    - set_fact: metabase_encryption_key={{ rand_pass }}
+  when: metabase_encryption_key is not defined
+  tags: metabase

roles/metabase/tasks/install.yml

@@ -0,0 +1,79 @@
+---
+
+- name: Install dependencies
+  yum:
+    name:
+      - java-11-openjdk
+  tags: metabase
+
+- name: Stop the service during upgrades
+  service: name=metabase state=stopped
+  when: metabase_install_mode == 'upgrade'
+  tags: metabase
+
+- when: metabase_install_mode != 'none'
+  block:
+    - name: Download metabase JAR file
+      get_url:
+        url: "{{ metabase_jar_url }}"
+        dest: "{{ metabase_root_dir }}/tmp/"
+        checksum: sha256:{{ metabase_jar_sha256 }}
+
+    - name: Move the JAR to the app dir
+      copy: src={{ metabase_root_dir }}/tmp/metabase.jar dest={{ metabase_root_dir }}/app/ mode=644 remote_src=True
+      notify: restart metabase
+      
+  tags: metabase
+
+- name: Deploy systemd unit
+  template: src=metabase.service.j2 dest=/etc/systemd/system/metabase.service
+  register: metabase_unit
+  notify: restart metabase
+  tags: metabase
+
+- name: Reload systemd
+  systemd: daemon_reload=True
+  when: metabase_unit.changed
+  tags: metabase
+
+# Create the database
+- import_tasks: ../includes/webapps_create_mysql_db.yml
+  vars:
+    - db_name: "{{ metabase_db_name }}"
+    - db_user: "{{ metabase_db_user }}"
+    - db_server: "{{ metabase_db_server }}"
+    - db_pass: "{{ metabase_db_pass }}"
+  when: metabase_db_engine == 'mysql'
+  tags: metabase
+
+- when: metabase_db_engine == 'postgres'
+  block:
+    - name: Create postgres user
+      postgresql_user:
+        db: postgres
+        name: "{{ metabase_db_user }}"
+        password: "{{ metabase_db_pass }}"
+        login_host: "{{ metabase_db_server }}"
+        login_user: sqladmin
+        login_password: "{{ pg_admin_pass }}"
+
+    - name: Create the PostgreSQL database
+      postgresql_db:
+        name: "{{ metabase_db_name }}"
+        encoding: UTF-8
+        lc_collate: C
+        lc_ctype: C
+        template: template0
+        owner: "{{ metabase_db_user }}"
+        login_host: "{{ metabase_db_server }}"
+        login_user: sqladmin
+        login_password: "{{ pg_admin_pass }}"
+
+  tags: metabase
+
+- name: Install pre and post backup hooks
+  template: src={{ item }}-backup.j2 dest=/etc/backup/{{ item }}.d/metabase mode=700
+  loop:
+    - pre
+    - post
+  tags: metabase

roles/metabase/tasks/iptables.yml

@@ -0,0 +1,8 @@
+---
+
+- name:  Handle metabase port in the firewall
+  iptables_raw:
+    name: metabase_port
+    state: "{{ (metabase_src_ip | length > 0) | ternary('present','absent') }}"
+    rules: "-A INPUT -m state --state NEW -p tcp --dport {{ metabase_port }} -s {{ metabase_src_ip | join(',') }} -j ACCEPT"
+  tags: firewall,metabase

roles/metabase/tasks/main.yml

@@ -0,0 +1,16 @@
+---
+
+- include: user.yml
+- include: directories.yml
+- include: facts.yml
+- include: archive_pre.yml
+  when: metabase_install_mode == 'upgrade'
+- include: install.yml
+- include: conf.yml
+- include: iptables.yml
+  when: iptables_manage | default(True)
+- include: services.yml
+- include: write_version.yml
+- include: archive_post.yml
+  when: metabase_install_mode == 'upgrade'
+- include: cleanup.yml

roles/metabase/tasks/services.yml

@@ -0,0 +1,5 @@
+---
+
+- name: Start and enable the service
+  service: name=metabase state=started enabled=True
+  tags: metabase

roles/metabase/tasks/user.yml

@@ -0,0 +1,5 @@
+---
+
+- name: Create metabase user account
+  user: name={{ metabase_user }} home={{ metabase_root_dir }} system=True
+  tags: metabase

roles/metabase/tasks/write_version.yml

@@ -0,0 +1,5 @@
+---
+
+- name: Write installed version
+  copy: content={{ metabase_version }} dest={{ metabase_root_dir }}/meta/ansible_version
+  tags: metabase

roles/metabase/templates/env.j2

@@ -0,0 +1,26 @@
+MB_ADMIN_EMAIL={{ metabase_admin_email }}
+MB_EMAIL_FROM_ADDRESS={{ metabase_from_email }}
+MB_EMAIL_SMTP_HOST={{metabase_smtp_server }}
+MB_EMAIL_SMTP_PORT={{ metabase_smtp_port }}
+{% if metabase_smtp_user is defined and metabase_smtp_pass is defined %}
+MB_EMAIL_SMTP_USERNAME={{ metabase_smtp_user }}
+MB_EMAIL_SMTP_PASSWORD={{ metabase_smtp_pass }}
+{% endif %}
+MB_EMAIL_SMTP_SECURITY={{ metabase_smtp_starttls | ternary('starttls','none') }}
+MB_ANON_TRACKING_ENABLED=false
+MB_DB_DBNAME={{ metabase_db_name }}
+MB_DB_HOST={{ metabase_db_server }}
+MB_DB_USER={{ metabase_db_user }}
+MB_DB_PASS={{ metabase_db_pass | quote }}
+MB_DB_PORT={{ metabase_db_port }}
+MB_DB_TYPE={{ metabase_db_engine }}
+MB_ENCRYPTION_SECRET_KEY={{ metabase_encryption_key | quote }}
+MB_JETTY_HOST=0.0.0.0
+MB_JETTY_PORT={{ metabase_port }}
+MB_PLUGINS_DIR={{ metabase_root_dir }}/plugins
+MB_SITE_LOCALE={{ metabase_lang }}
+MB_SITE_URL={{ metabase_public_url }}
+MB_CHECK_FOR_UPDATES=false
+MB_ENABLE_EMBEDDING=true
+MB_ENABLE_PUBLIC_SHARING=true
+MB_ENABLE_QUERY_CACHING={{ metabase_enable_cache | ternary('true', 'false') }}

roles/metabase/templates/metabase.service.j2

@@ -0,0 +1,26 @@
+[Unit]
+Description=Metabase opensource BI
+After=syslog.target network.target
+
+[Service]
+Type=simple
+User={{ metabase_user }}
+WorkingDirectory={{ metabase_root_dir }}/app
+EnvironmentFile={{ metabase_root_dir }}/etc/env
+ExecStart=/usr/bin/java -Djava.net.preferIPv4Stack=true \
+{% if system_proxy is defined and system_proxy != '' %}
+            -Dhttp.proxyHost={{ system_proxy | urlsplit('hostname') }} -Dhttp.proxyPort={{ system_proxy | urlsplit('port') }} \
+            -Dhttps.proxyHost={{ system_proxy | urlsplit('hostname') }} -Dhttps.proxyPort={{ system_proxy | urlsplit('port') }} \
+{% endif %}
+            -jar {{ metabase_root_dir }}/app/metabase.jar
+SuccessExitStatus=143
+PrivateTmp=yes
+PrivateDevices=yes
+ProtectSystem=full
+ProtectHome=yes
+NoNewPrivileges=yes
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+

roles/metabase/templates/post-backup.j2

@@ -0,0 +1,3 @@
+#!/bin/bash -e
+
+rm -f {{ metabase_root_dir }}/backup/*

roles/metabase/templates/pre-backup.j2

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+set -eo pipefail
+
+{% if metabase_db_engine == 'mysql' %}
+/usr/bin/mysqldump \
+{% if metabase_db_server not in ['localhost','127.0.0.1'] %}
+  --user={{ metabase_db_user | quote }} \
+  --password={{ metabase_db_pass | quote }} \
+  --host={{ metabase_db_server | quote }} \
+  --port={{ metabase_db_port | quote }} \
+{% endif %}
+  --quick --single-transaction \
+  --add-drop-table {{ metabase_db_name | quote }} | zstd -c > {{ metabase_root_dir }}/backup/{{ metabase_db_name }}.sql.zst
+{% elif metabase_db_engine == 'postgres' %}
+PGPASSWORD={{ metabase_db_pass | quote }} /usr/pgsql-14/bin/pg_dump \
+  --clean \
+  --create \
+  --username={{ metabase_db_user }} \
+  --host={{ metabase_db_server }} \
+  {{ metabase_db_name }} | zstd -c > {{ metabase_root_dir }}/backup/{{ metabase_db_name }}.sql.zst
+{% endif %}
+cp {{ metabase_root_dir }}/etc/env {{ metabase_root_dir }}/backup/
+