Add Ansible Playbook to Validate Compose Config

Author: waleedbaroudi

.github/workflows/build-validation.yml

@@ -22,7 +22,18 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Login to GitHub Container Registry
+      - name: Install Ansible
+        run: sudo apt-get update && sudo apt-get install -y ansible
+
+      - name: Validate Docker Compose config with Ansible
+        env:
+          IMAGE_TAG: dummy
+          OPEN_WEBUI_API_KEY_CHAT: dummy_key
+          OPEN_WEBUI_API_KEY_GEN: dummy_key
+          LANGSMITH_API_KEY: dummy_key
+        run: ansible-playbook ansible/validate-compose.yml
+
+      - name: Login to GitHub Container Registry # TODO: why? - remove?
         uses: docker/login-action@v3
         with:
           registry: ghcr.io

.github/workflows/deploy_vm.yml

@@ -91,7 +91,7 @@ jobs:
           OPEN_WEBUI_API_KEY_CHAT: ${{ secrets.OPEN_WEBUI_API_KEY_CHAT }}
           OPEN_WEBUI_API_KEY_GEN: ${{ secrets.OPEN_WEBUI_API_KEY_GEN }}
           LANGSMITH_API_KEY: ${{ secrets.LANGSMITH_API_KEY }}
-        run: ansible-playbook -i inventory.ini deploy/ansible/deploy.yml
+        run: ansible-playbook -i inventory.ini ansible/deploy.yml
 
   deploy-k8s:
     needs: build-and-push

deploy/ansible/deploy.yml ansible/deploy.ymldeploy/ansible/deploy.yml renamed to ansible/deploy.yml

@@ -5,25 +5,23 @@
 
   vars:
     project_dir: /home/ubuntu/app
-    image_tag: "{{ lookup('env','IMAGE_TAG') }}"
-    open_webui_api_key_chat: "{{ lookup('env','OPEN_WEBUI_API_KEY_CHAT') }}"
-    open_webui_api_key_gen: "{{ lookup('env','OPEN_WEBUI_API_KEY_GEN') }}"
-    langsmith_api_key: "{{ lookup('env','LANGSMITH_API_KEY') }}"
 
   tasks:
+    - include_tasks: tasks/env_vars.yml # load env variables
+    
     - name: Ensure project directory exists
       file:
         path: "{{ project_dir }}"
         state: directory
 
     - name: Template compose with image tags
       template:
-        src: ../../docker-compose.yml.j2
+        src: ../docker-compose.yml.j2
         dest: "{{ project_dir }}/docker-compose.yml"
 
     - name: Copy Traefik configuration files
       copy:
-        src: ../../traefik/
+        src: ../traefik/
         dest: "{{ project_dir }}/traefik/"
 
     - name: Create acme.json file for Let's Encrypt certificates
@@ -36,7 +34,7 @@
 
     - name: Copy Prometheus configuration files
       copy:
-        src: ../../monitoring/prometheus/
+        src: ../monitoring/prometheus/
         dest: "{{ project_dir }}/monitoring/prometheus/"
 
 

ansible/tasks/env_vars.yml

@@ -0,0 +1,23 @@
+# validate_docker_compose.yaml
+- name: Validate Docker Compose Jinja template
+  hosts: localhost
+  gather_facts: false
+
+  tasks:
+    - include_tasks: tasks/env_vars.yml # load env variables
+
+    - name: Template compose file
+      template:
+        src: ../docker-compose.yml.j2
+        dest: /tmp/compose-validation.yaml
+        mode: '0644'
+
+    - name: Validate Docker Compose config
+      command: docker compose -f /tmp/compose-validation.yaml config
+      register: result
+      failed_when: result.rc != 0
+
+    - name: Delete temp file
+      file:
+        path: /tmp/compose-validation.yaml
+        state: absent