Add vwsfriend (#78)

* Add vwsfriend docker-compose

Author: micxer

defaults/main.yml

@@ -52,9 +52,8 @@ homestack_ha_base_domain: example.com
 homestack_ha_mosquitto_image_version: 2.0.21
 # homestack_ha_mosquitto_base_path: ""  # must be set
 homestack_ha_mosquitto_users: {}
-
 # renovate: image=evcc/evcc
-homestack_ha_evcc_image_version: 0.203.4
+homestack_ha_evcc_image_version: 0.203.6
 # homestack_ha_evcc_base_path: ""  # must be set
 # homestack_ha_evcc_installation_id: ""  # must be set
 homestack_ha_evcc_mqtt_user: evcc
@@ -63,8 +62,28 @@ homestack_ha_evcc_vw_user: mail@example.com
 homestack_ha_evcc_vw_password: supersafe
 homestack_ha_evcc_vw_vin: WVWZZZAAZJD000000
 homestack_ha_evcc_ntfy_uri: https://ntfy.sh/abcdefghijklmnopqrstuvwxyz012345
-homestack_ha_evcc_grid_costs: 0.30  # €/kWh
-homestack_ha_evcc_feedin_revenue: 0.082  # €/kWh
+homestack_ha_evcc_grid_costs: 0.30 # €/kWh
+homestack_ha_evcc_feedin_revenue: 0.082 # €/kWh
+
+# vwsfriend
+homestack_vwsfriend_active: true
+homestack_vwsfriend_base_domain: example.com
+
+# renovate: image=tillsteinbach/vwsfriend
+homestack_vwsfriend_image_version: 0.24.7
+# homestack_vwsfriend_base_path: ""  # must be set
+homestack_vwsfriend_username: admin
+# homestack_vwsfriend_password: secret  # must be set
+# homestack_vwsfriend_weconnect_user: ""  # must be set
+# homestack_vwsfriend_weconnect_password: ""  # must be set
+# homestack_vwsfriend_weconnect_spin: ""  # must be set
+homestack_vwsfriend_weconnect_interval: 120
+homestack_vwsfriend_postgres_image_version: 13.21
+homestack_vwsfriend_db_user: vwsfriend
+# homestack_vwsfriend_db_password: secret  # must be set
+homestack_vwsfriend_db_name: vwsfriend
+homestack_vwsfriend_additional_parameters: ""
+homestack_vwsfriend_grafana_version: 0.24.7
 
 homestack_backup: true
 homestack_backup_script_path: /usr/local/bin

files/backup/evcc_container_backup.sh

@@ -33,7 +33,7 @@ log_message() {
     curl -H "X-Priority: ${priority}" -d "$1" "$NTFY_TOPIC"
 }
 
-# Function to disable maintenance mode and exit
+# Log before exiting
 cleanup() {
     local exit_code=$?
     if [ $exit_code -ne 0 ]; then
@@ -73,7 +73,7 @@ before() {
       exit 1
   fi
 
-  log_message "Local evcc backup successful" low
+  log_message "Local evcc backup snapshot created" low
 }
 
 success() {

tasks/ha.yml

@@ -8,11 +8,11 @@
     mode: "{{ item.mode }}"
   with_items:
     - name: config
-      mode: '0750'
+      mode: "0750"
     - name: data
-      mode: '0750'
+      mode: "0750"
     - name: log
-      mode: '0750'
+      mode: "0750"
 
 - name: ha | Copy mosquitto config files
   ansible.builtin.template:
@@ -36,7 +36,7 @@
     mode: "{{ item.mode }}"
   with_items:
     - name: data
-      mode: '0750'
+      mode: "0750"
 
 - name: ha | Copy evcc configuration
   ansible.builtin.template:

tasks/main.yml

@@ -28,6 +28,10 @@
   ansible.builtin.include_tasks: ha.yml
   when: homestack_ha_active
 
+- name: Include vwsfriend stack tasks
+  ansible.builtin.include_tasks: vwsfriend.yml
+  when: homestack_vwsfriend_active
+
 - name: Include backup tasks
   ansible.builtin.include_tasks: backup.yml
   when: homestack_backup

tasks/monitoring.yml

@@ -8,7 +8,7 @@
     mode: "{{ item.mode }}"
   with_items:
     - name: data
-      mode: '0750'
+      mode: "0750"
 
 - name: monitoring | Copy prometheus specific files to their respective directories
   ansible.builtin.copy:

tasks/nextcloud.yml

@@ -8,11 +8,11 @@
     mode: "{{ item.mode }}"
   with_items:
     - name: custom_apps
-      mode: '0750'
+      mode: "0750"
     - name: data
-      mode: '0770'
+      mode: "0770"
     - name: config
-      mode: '0750'
+      mode: "0750"
 
 - name: nextcloud | Copy nextcloud specific files to their respective directories
   ansible.builtin.copy:

tasks/vwsfriend.yml

@@ -0,0 +1,24 @@
+---
+- name: vwsfriend | Ensure vwsfriend directories exist
+  ansible.builtin.file:
+    path: "{{ homestack_vwsfriend_base_path }}/{{ item.name }}"
+    state: directory
+    owner: "{{ homestack_uid }}"
+    group: "{{ homestack_gid }}"
+    mode: "{{ item.mode }}"
+  with_items:
+    - name: config
+      mode: "0750"
+    - name: db
+      mode: "0750"
+    - name: grafana
+      mode: "0750"
+
+- name: vwsfriend | Write docker-compose file
+  ansible.builtin.template:
+    src: "docker-compose-vwsfriend.yml.j2"
+    dest: "{{ homestack_output_path }}/docker-compose-vwsfriend.yml"
+    owner: "{{ homestack_uid }}"
+    group: "{{ homestack_gid }}"
+    mode: "0600"
+    backup: true

templates/backup/evcc_env_vars.sh.j2

@@ -7,6 +7,6 @@ fi
 
 readonly ZPOOL_EVCC="{{ zfs_pools[0].name }}"
 
-readonly EVCC_DIR="{{ appdata_path }}/evcc"
+readonly EVCC_DIR="{{ homestack_ha_evcc_base_path }}"
 
 readonly NTFY_TOPIC="{{ autorestic_ntfy_topic }}"

templates/backup/nextcloud_env_vars.sh.j2

@@ -9,6 +9,6 @@ readonly NEXTCLOUD_UID="{{ nextcloud_uid }}"
 readonly MYSQL_ROOT_PASSWORD="{{ homestack_nextcloud_mysql_root_password }}"
 readonly ZPOOL_NC="{{ zfs_pools[0].name }}"
 
-readonly NEXTCLOUD_DIR="{{ appdata_path }}/nextcloud"
+readonly NEXTCLOUD_DIR="{{ homestack_nextcloud_base_path }}/nextcloud"
 
 readonly NTFY_TOPIC="{{ autorestic_ntfy_topic }}"

templates/docker-compose-vwsfriend.yml.j2

@@ -0,0 +1,105 @@
+{{ ansible_managed | comment }}
+---
+services:
+  vwsfriend:
+    container_name: vwsfriend
+    depends_on:
+      vwsfriend-db:
+        condition: service_healthy
+    environment:
+      VWSFRIEND_USERNAME: "{{ homestack_vwsfriend_username }}"
+      VWSFRIEND_PASSWORD: "{{ homestack_vwsfriend_password }}"
+      WECONNECT_USER: "{{ homestack_vwsfriend_weconnect_user }}"
+      WECONNECT_PASSWORD: "{{ homestack_vwsfriend_weconnect_password | replace('$', '$$') }}"
+      WECONNECT_SPIN: "{{ homestack_vwsfriend_weconnect_spin }}"
+      WECONNECT_INTERVAL: "{{ homestack_vwsfriend_weconnect_interval }}"
+      DATABASE_URL: "postgresql://{{ homestack_vwsfriend_db_user }}:{{ homestack_vwsfriend_db_password }}@vwsfriend-db:5432/{{ homestack_vwsfriend_db_name }}"
+      ADDITIONAL_PARAMETERS: "--with-database --with-abrp {{ homestack_vwsfriend_additional_parameters }}"
+    healthcheck:
+      test: (wget -qO- http://localhost:4000/healthcheck | grep "ok" -q) || exit 1
+      interval: 10s
+      timeout: 3s
+      retries: 3
+    image: tillsteinbach/vwsfriend:{{ homestack_vwsfriend_image_version }}
+    labels:
+      traefik.enable: true
+      traefik.docker.network: traefik-net
+      traefik.http.routers.vwsfriend.rule: "Host(`vwsfriend.{{ homestack_vwsfriend_base_domain }}`)"
+      traefik.http.routers.vwsfriend.entrypoints: websecure
+      traefik.http.routers.vwsfriend.tls.options: modern@file
+    networks:
+      - traefik
+      - vwsfriend
+    restart: unless-stopped
+    user: "{{ homestack_uid }}:{{ homestack_gid }}"
+    volumes:
+      - "{{ homestack_vwsfriend_base_path }}/config:/config"
+
+  vwsfriend-db:
+    container_name: vwsfriend-db
+    environment:
+      POSTGRES_USER: "{{ homestack_vwsfriend_db_user }}"
+      POSTGRES_PASSWORD: "{{ homestack_vwsfriend_db_password }}"
+      POSTGRES_DB: "{{ homestack_vwsfriend_db_name }}"
+      TZ: "UTC"
+      PGTZ: "UTC"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -p 5432 --username={{ homestack_vwsfriend_db_user }} --dbname={{ homestack_vwsfriend_db_name }}"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    image: postgres:{{ homestack_vwsfriend_postgres_image_version }}
+    networks:
+      - vwsfriend
+    user: "{{ homestack_uid }}:{{ homestack_gid }}"
+    restart: unless-stopped
+    volumes:
+      - "{{ homestack_vwsfriend_base_path }}/db:/var/lib/postgresql/data"
+
+  grafana:
+    container_name: vwsfriend-grafana
+    environment:
+      GF_SECURITY_ADMIN_USER: "{{ homestack_vwsfriend_username }}"
+      GF_SECURITY_ADMIN_PASSWORD: "{{ homestack_vwsfriend_password }}"
+      GF_LOG_LEVEL: info
+      GF_LOG_MODE: console
+      DB_USER: "{{ homestack_vwsfriend_db_user }}"
+      DB_PASSWORD: "{{ homestack_vwsfriend_db_password }}"
+      DB_HOSTNAME: "vwsfriend-db"
+      DB_PORT: "5432"
+      DB_NAME: "{{ homestack_vwsfriend_db_name }}"
+      VWSFRIEND_USERNAME: "{{ homestack_vwsfriend_username }}"
+      VWSFRIEND_PASSWORD: "{{ homestack_vwsfriend_password }}"
+      VWSFRIEND_HOSTNAME: "vwsfriend"
+      VWSFRIEND_PORT: 4000
+    healthcheck:
+      test: ["CMD", "wget", "-O", "/dev/null", "http://localhost:3000"]
+      interval: 10s
+      timeout: 15s
+      retries: 10
+      start_period: 30s 
+    image: tillsteinbach/vwsfriend-grafana:{{ homestack_vwsfriend_grafana_version }}
+    labels:
+      traefik.enable: true
+      traefik.docker.network: traefik-net
+      traefik.http.routers.vwsfriend-grafana.rule: "Host(`vwsfriend-grafana.{{ homestack_vwsfriend_base_domain }}`)"
+      traefik.http.routers.vwsfriend-grafana.entrypoints: websecure
+      traefik.http.routers.vwsfriend-grafana.tls.options: modern@file
+    networks:
+      - traefik
+      - vwsfriend
+    restart: unless-stopped
+    user: "{{ homestack_uid }}:{{ homestack_gid }}"
+    volumes:
+      - "{{ homestack_vwsfriend_base_path }}/grafana:/var/lib/grafana"
+
+networks:
+  traefik:
+    name: traefik-net
+    external: true
+  vwsfriend:
+    name: ha-net
+    internal: true
+    ipam:
+      config:
+        - subnet: 172.20.5.0/24