Add ansible role for xatu-cannon

Author: mininny

roles/xatu_cannon/README.md

@@ -0,0 +1,38 @@
+# ethpandaops.general.xatu_cannon
+
+This role will run a [xatu cannon](https://github.com/ethpandaops/xatu) within a docker container.
+
+## Requirements
+
+You'll need docker on the target system. Make sure to install it upfront.
+
+## Role Variables
+
+Default variables are defined in [defaults/main.yaml](defaults/main.yaml)
+
+## Dependencies
+
+You'll need docker to run this role. One way of installing docker could be via ansible galaxy with the following dependencies set within `requirements.yaml`:
+
+```yaml
+roles:
+- src: geerlingguy.docker
+  version: latest
+- src: geerlingguy.pip
+  version: latest
+```
+
+## Example Playbook
+
+Your playbook could look like this:
+
+```yaml
+- hosts: localhost
+  become: true
+  roles:
+  - role: geerlingguy.docker
+  - role: geerlingguy.pip
+    pip_install_packages:
+    - name: docker
+  - role: ethpandaops.general.xatu_cannon
+```

roles/xatu_cannon/defaults/main.yaml

@@ -0,0 +1,51 @@
+xatu_cannon_cleanup: false
+
+xatu_cannon_user: "xatu-cannon"
+
+xatu_cannon_container_name: "xatu-cannon"
+xatu_cannon_container_image: "ethpandaops/xatu:latest"
+xatu_cannon_container_env: {}
+xatu_cannon_container_ports: []
+xatu_cannon_container_volumes:
+  - "{{ xatu_cannon_paths_config }}/config.yaml:/config.yaml:ro"
+
+xatu_cannon_container_stop_timeout: "120"
+xatu_cannon_container_networks: []
+
+xatu_cannon_paths_config: /etc/xatu-cannon/
+
+xatu_cannon_container_command:
+  - cannon
+  - --config=/config.yaml
+
+xatu_cannon_config_name: "{{ inventory_hostname }}"
+xatu_cannon_config_beacon_uri: your-beacon-node:4000
+xatu_cannon_config_server_address: remote-xatu-server:1234
+xatu_cannon_config_server_tls_enabled: true
+xatu_cannon_config_server_auth_user: xatu-user
+xatu_cannon_config_server_auth_password: xatu-password
+xatu_cannon_config_coordinator_address: remote-xatu-server:1234
+xatu_cannon_config_coordinator_tls_enabled: true
+xatu_cannon_config_coordinator_authorization: coordinator-secret
+xatu_cannon_config_network_name_override: ""
+
+xatu_cannon_config: |
+  logging: "info"
+  metricsAddr: ":9090"
+  name: "{{ xatu_cannon_config_name }}"
+  ethereum:
+    beaconNodeAddress: {{ xatu_cannon_config_beacon_uri }}
+    overrideNetworkName: {{ xatu_cannon_config_network_name_override }}
+  coordinator:
+    address: {{ xatu_cannon_config_coordinator_address }}
+    tls: {{ xatu_cannon_config_coordinator_tls_enabled }}
+    headers:
+      authorization: "Bearer {{ xatu_cannon_config_coordinator_authorization | b64encode }}"
+  outputs:
+  - name: grpc
+    type: xatu
+    config:
+      address: {{ xatu_cannon_config_server_address }}
+      tls: {{ xatu_cannon_config_server_tls_enabled }}
+      headers:
+        authorization: "Basic {{ (xatu_cannon_config_server_auth_user + ":" + xatu_cannon_config_server_auth_password) | b64encode }}"

roles/xatu_cannon/handlers/main.yaml

@@ -0,0 +1,5 @@
+- name: Restart xatu cannon container
+  community.docker.docker_container:
+    name: "{{ xatu_cannon_container_name }}"
+    state: started
+    restart: true

roles/xatu_cannon/tasks/cleanup.yaml

@@ -0,0 +1,4 @@
+- name: Remove xatu cannon container
+  community.docker.docker_container:
+    name: "{{ xatu_cannon_container_name }}"
+    state: absent

roles/xatu_cannon/tasks/main.yaml

@@ -0,0 +1,7 @@
+- name: Setup xatu cannon
+  ansible.builtin.import_tasks: setup.yaml
+  when: not xatu_cannon_cleanup
+
+- name: Cleanup xatu cannon
+  ansible.builtin.import_tasks: cleanup.yaml
+  when: xatu_cannon_cleanup

roles/xatu_cannon/tasks/setup.yaml

@@ -0,0 +1,44 @@
+- name: Add xatu cannon user
+  ansible.builtin.user:
+    name: "{{ xatu_cannon_user }}"
+    shell: /bin/nologin
+
+- name: Get xatu cannon uid
+  ansible.builtin.getent:
+    database: passwd
+    key: "{{ xatu_cannon_user }}"
+  register: xatu_cannon_user_getent
+
+- name: Create xatu cannon dirs
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: directory
+    mode: '0777'
+    owner: "{{ xatu_cannon_user }}"
+    group: "{{ xatu_cannon_user }}"
+  loop:
+    - "{{ xatu_cannon_paths_config }}"
+
+- name: Create xatu cannon config
+  ansible.builtin.copy:
+    content: "{{ xatu_cannon_config }}"
+    dest: "{{ xatu_cannon_paths_config }}/config.yaml"
+    owner: "{{ xatu_cannon_user }}"
+    group: "{{ xatu_cannon_user }}"
+    mode: '0640'
+  notify: Restart xatu cannon container
+
+- name: Run xatu cannon container
+  community.docker.docker_container:
+    name: "{{ xatu_cannon_container_name }}"
+    image: "{{ xatu_cannon_container_image }}"
+    image_name_mismatch: recreate
+    user: "{{ xatu_cannon_user_getent.ansible_facts.getent_passwd[xatu_cannon_user][1] }}"
+    state: started
+    restart_policy: always
+    stop_timeout: "{{ xatu_cannon_container_stop_timeout }}"
+    ports: "{{ xatu_cannon_container_ports }}"
+    volumes: "{{ xatu_cannon_container_volumes }}"
+    env: "{{ xatu_cannon_container_env }}"
+    networks: "{{ xatu_cannon_container_networks }}"
+    command: "{{ xatu_cannon_container_command }}"