new: [plausible] add charm

clickhouse/README.org

@@ -0,0 +1,7 @@
+# -*- ispell-local-dictionary: "english" -*-
+
+* Info
+
+This charm is provided to work with plausible charm
+
+* Usage

clickhouse/hooks/init

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+## Init is run on host
+## For now it is run every time the script is launched, but
+## it should be launched only once after build.
+
+## Accessible variables are:
+## - SERVICE_NAME        Name of current service
+## - DOCKER_BASE_IMAGE   Base image from which this service might be built if any
+## - SERVICE_DATASTORE           Location on host of the DATASTORE of this service
+## - SERVICE_CONFIGSTORE         Location on host of the CONFIGSTORE of this service
+
+set -e
+
+init-config-add "
+$SERVICE_NAME:
+  environment:
+    CLICKHOUSE_SKIP_USER_SETUP: 1
+  healthcheck:
+    test: [ \"CMD-SHELL\", \"wget --no-verbose --tries=1 -O - http://127.0.0.1:8123/ping || exit 1\" ]
+"

clickhouse/metadata.yml

@@ -0,0 +1,21 @@
+docker-image: docker.0k.io/clickhouse:24.12-alpine
+#docker-image: clickhouse/clickhouse-server:24.12-alpine
+
+data-resources:
+  - /var/lib/clickhouse
+  - /var/log/clickhouse-server
+
+charm-resources:
+  - /etc/clickhouse-server/config.d/logs.xml
+  - /etc/clickhouse-server/config.d/ipv4-only.xml
+  - /etc/clickhouse-server/config.d/low-resources.xml
+
+provides:
+  event-db:
+
+uses:
+  log-rotate:
+    constraint: recommended
+    auto: pair
+    solves:
+      disk-leak: "/var/log/clickhouse-server"

clickhouse/resources/etc/clickhouse-server/config.d/ipv4-only.xml

@@ -0,0 +1,3 @@
+<clickhouse>
+    <listen_host>0.0.0.0</listen_host>
+</clickhouse>

clickhouse/resources/etc/clickhouse-server/config.d/logs.xml

@@ -0,0 +1,28 @@
+<clickhouse>
+    <logger>
+        <level>warning</level>
+        <console>true</console>
+    </logger>
+
+    <query_log replace="1">
+        <database>system</database>
+        <table>query_log</table>
+        <flush_interval_milliseconds>7500</flush_interval_milliseconds>
+        <engine>
+            ENGINE = MergeTree
+            PARTITION BY event_date
+            ORDER BY (event_time)
+            TTL event_date + interval 30 day
+            SETTINGS ttl_only_drop_parts=1
+        </engine>
+    </query_log>
+
+    <!-- Stops unnecessary logging -->
+    <metric_log remove="remove" />
+    <asynchronous_metric_log remove="remove" />
+    <query_thread_log remove="remove" />
+    <text_log remove="remove" />
+    <trace_log remove="remove" />
+    <session_log remove="remove" />
+    <part_log remove="remove" />
+</clickhouse>

clickhouse/resources/etc/clickhouse-server/config.d/low-resources.xml

@@ -0,0 +1,23 @@
+<!-- https://clickhouse.com/docs/en/operations/tips#using-less-than-16gb-of-ram -->
+<clickhouse>
+    <!--
+    https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#mark_cache_size -->
+    <mark_cache_size>524288000</mark_cache_size>
+
+    <profile>
+        <default>
+            <!-- https://clickhouse.com/docs/en/operations/settings/settings#max_threads -->
+            <max_threads>1</max_threads>
+            <!-- https://clickhouse.com/docs/en/operations/settings/settings#max_block_size -->
+            <max_block_size>8192</max_block_size>
+            <!-- https://clickhouse.com/docs/en/operations/settings/settings#max_download_threads -->
+            <max_download_threads>1</max_download_threads>
+            <!--
+            https://clickhouse.com/docs/en/operations/settings/settings#input_format_parallel_parsing -->
+            <input_format_parallel_parsing>0</input_format_parallel_parsing>
+            <!--
+            https://clickhouse.com/docs/en/operations/settings/settings#output_format_parallel_formatting -->
+            <output_format_parallel_formatting>0</output_format_parallel_formatting>
+        </default>
+    </profile>
+</clickhouse>

plausible/README.org

@@ -0,0 +1,7 @@
+# -*- ispell-local-dictionary: "english" -*-
+
+* Info 
+
+From: https://github.com/plausible/community-edition/
+
+* Usage

plausible/hooks/event_db-relation-joined

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -e
+
+
+
+config-add "\
+services:
+  $MASTER_BASE_SERVICE_NAME:
+    environment:
+      CLICKHOUSE_DATABASE_URL: http://$TARGET_SERVICE_NAME:8123/$TARGET_SERVICE_NAME
+"
+
+info "Configured $SERVICE_NAME code for $TARGET_SERVICE_NAME access."

plausible/hooks/init

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+SECRET_KEY_BASE="$SERVICE_DATASTORE"/secret-key
+
+SHARE_DIR="$SERVICE_DATASTORE"/var/lib/plausible
+
+uid=$(docker_get_uid "$SERVICE_NAME" "plausible")
+
+if ! [ -f "$SECRET_KEY_BASE" ]; then
+    info "Generating secret key"
+    mkdir -p "${SECRET_KEY_BASE%/*}"
+    umask 077
+    openssl rand -base64 64 > "$SECRET_KEY_BASE"
+else
+    info "Using existing secret key"
+fi
+
+secret_key_base=$(cat "$SECRET_KEY_BASE")
+
+init-config-add "
+$SERVICE_NAME:
+  environment:
+    SECRET_KEY_BASE: \"$secret_key_base\"
+"
+
+chown -v "$uid" "$SHARE_DIR"

plausible/hooks/postgres_database-relation-joined

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+PASSWORD="$(relation-get password)"
+USER="$(relation-get user)"
+DBNAME="$(relation-get dbname)"
+
+
+config-add "\
+services:
+  $MASTER_BASE_SERVICE_NAME:
+    environment:
+      DATABASE_URL: postgres://$USER:$PASSWORD@$TARGET_SERVICE_NAME:5432/$DBNAME
+"
+
+info "Configured $SERVICE_NAME code for $TARGET_SERVICE_NAME access."

plausible/hooks/smtp_server-relation-joined

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -e
+
+host=$(relation-get host) || exit 1
+port=$(relation-get port) || exit 1
+user=$(relation-get login) || exit 1
+password="$(relation-get password)" || exit 1
+
+
+config-add "\
+services:
+  $MASTER_BASE_SERVICE_NAME:
+    environment:
+      SMTP_HOST_NAME: \"$user\"
+      SMTP_HOST_PASS: \"${password//\$/\$\$}\"
+      SMTP_HOST_ADDR: \"$host\"
+      SMTP_HOST_PORT: \"$port\"
+    #   SMTP_HOST_SSL_ENABLE: \"true\"
+"
+

plausible/hooks/web_proxy-relation-joined

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -e
+
+DOMAIN=$(relation-get domain) || {
+    echo "Failed to get domain"
+    exit 1
+}
+
+config-add "\
+services:
+  $MASTER_BASE_SERVICE_NAME:
+    environment:
+      BASE_URL: \"https:\/\/${DOMAIN}\"
+"
+

plausible/metadata.yml

@@ -0,0 +1,58 @@
+docker-image:  docker.0k.io/plausible:3.0.1
+#docker-image:  ghcr.io/plausible/community-edition:v3.0.1
+
+data-resources:
+  - /var/lib/plausible
+
+docker-compose:
+  entrypoint: sh -c "/entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh run"
+  #entrypoint: sh -c "/entrypoint.sh run"
+uses:
+  event-db:
+    #constraint: required | recommended | optional
+    #auto: pair | summon | none ## default: pair
+    constraint: required
+    auto: summon
+    solves:
+      database: "event db"
+  postgres-database:
+    #constraint: required | recommended | optional
+    #auto: pair | summon | none ## default: pair
+    constraint: required
+    auto: summon
+    solves:
+      database: "main storage"
+    default-options:
+      extensions:
+        - citext
+  smtp-server:
+    constraint: required
+    auto: summon
+    solves:
+      proxy: "Public access"
+  web-proxy:
+    #constraint: required | recommended | optional
+    #auto: pair | summon | none ## default: pair
+    constraint: recommended
+    auto: pair
+    solves:
+      proxy: "Public access"
+    default-options:
+      target: !var-expand ${MASTER_BASE_SERVICE_NAME}:8000
+      apache-custom-rules:
+        - !var-expand |
+          ProxyPreserveHost On
+        
+          #Set web sockets
+          RewriteEngine On
+          RewriteCond %{HTTP:Upgrade} =websocket [NC]
+          RewriteCond %{HTTP:Connection} upgrade [NC]
+          RewriteRule ^/(live/websocket)$ ws://${MASTER_BASE_SERVICE_NAME}:8000/\$1 [P,L]
+
+
+  backup:
+    constraint: recommended
+    auto: pair
+    solves:
+      backup: "Automatic regular backup"
+    default-options: