Merge pull request #54 from blinklabs-io/feat/tx-submit-api-mirror

feat: tx-submit-api-mirror role

roles/tx_submit_api_mirror/README.md

@@ -0,0 +1,51 @@
+tx_submit_api_mirror
+=========
+
+This role deploys a Tx Submit API mirror instance.
+
+Requirements
+------------
+
+Any pre-requisites that may not be covered by Ansible itself or the role should
+be mentioned here. For instance, if the role uses the EC2 module, it may be a
+good idea to mention in this section that the boto package is required.
+
+Role Variables
+--------------
+
+A description of the settable variables for this role should go here, including
+any variables that are in defaults/main.yml, vars/main.yml, and any variables
+that can/should be set via parameters to the role. Any variables that are read
+from other roles and/or the global scope (ie. hostvars, group vars, etc.)
+should be mentioned here as well.
+
+Dependencies
+------------
+
+A list of other roles hosted on Galaxy should go here, plus any details in
+regards to parameters that may need to be set for other roles, or variables
+that are used from other roles.
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables
+passed in as parameters) is always nice for users too:
+
+```yaml
+    - hosts: servers
+      tasks:
+        - include_role:
+            name: blinklabs.cardano.tx_submit_api_mirror
+```
+
+License
+-------
+
+Apache 2.0
+
+Author Information
+------------------
+
+An optional section for the role authors to include contact information, or a
+website (HTML is not allowed).

roles/tx_submit_api_mirror/defaults/main.yml

@@ -0,0 +1,24 @@
+---
+# Install method
+tx_submit_api_mirror_install_method: 'docker'
+
+# Cardano Submit API version
+tx_submit_api_mirror_version: '0.3.1'
+
+# Docker image
+tx_submit_api_mirror_docker_image: 'ghcr.io/blinklabs-io/tx-submit-api-mirror:{{ tx_submit_api_mirror_version }}'
+
+# Docker container name
+tx_submit_api_mirror_docker_container_name: tx-submit-api-mirror
+
+# Port for host/container
+tx_submit_api_mirror_container_port: 8090
+tx_submit_api_mirror_port: '{{ tx_submit_api_mirror_container_port }}'
+
+# Metrics port for host/container
+tx_submit_api_mirror_metrics_container_port: 8081
+tx_submit_api_mirror_metrics_port: '{{ tx_submit_api_mirror_metrics_container_port }}'
+
+# Backends to forward to
+tx_submit_api_mirror_backends:
+  - https://example.com/api/tx/submit

roles/tx_submit_api_mirror/meta/main.yml

@@ -0,0 +1,3 @@
+galaxy_info: {}
+
+dependencies: []

roles/tx_submit_api_mirror/tasks/docker.yml

@@ -0,0 +1,12 @@
+---
+- name: Create container
+  docker_container:
+    name: '{{ tx_submit_api_mirror_docker_container_name }}'
+    image: '{{ tx_submit_api_mirror_docker_image }}'
+    restart_policy: unless-stopped
+    ports:
+      - '{{ tx_submit_api_mirror_port }}:{{ tx_submit_api_mirror_container_port }}'
+      - '{{ tx_submit_api_mirror_metrics_port }}:{{ tx_submit_api_mirror_metrics_container_port }}'
+    env:
+      API_LISTEN_PORT: '{{ tx_submit_api_mirror_container_port | string }}'
+      BACKENDS: "{{ tx_submit_api_mirror_backends | join(',') }}"

roles/tx_submit_api_mirror/tasks/main.yml

@@ -0,0 +1,12 @@
+---
+- name: Check install method
+  vars:
+    _allowed_install_methods: ['docker']
+  ansible.builtin.assert:
+    that:
+      - tx_submit_api_mirror_install_method in _allowed_install_methods
+    fail_msg: 'The specified install method ({{ tx_submit_api_mirror_install_method }}) is not one of the allowed values ({{ _allowed_install_methods | join(", ") }})'
+
+- name: Include docker-related tasks
+  ansible.builtin.include_tasks: docker.yml
+  when: tx_submit_api_mirror_install_method == 'docker'