add windows support and new variables (#2)

antmelekhin · web-flow · commit 193e697040e8 · 2023-02-02T00:16:22.000+04:00
* add supported platforms

* add windows support

* add molecule scenario for windows

* add become as block

* fix windows configure task

* add new variables
diff --git a/README.md b/README.md
@@ -8,18 +8,24 @@ Requirements
 
 - Supported version of Ansible: 2.9 and highter.
 - `gnu-tar` on Mac as deployer host (`brew install gnu-tar`).
+- `pywinrm` is a python library for connection Ansible to Windows hosts via [WinRM](https://docs.ansible.com/ansible/latest/user_guide/windows_winrm.html).
 - List of all supported platforms described in role meta.
 
 Role Variables
 --------------
 
 - `postgres_exporter_version` The specific version of Postgres Exporter to download (default: `0.11.1`).
-- `postgres_exporter_archive_name` Postgres Exporter archive name (default: `postgres_exporter-{{ postgres_exporter_version }}.linux-{{ _postgres_exporter_architecture }}`).
+- `postgres_exporter_archive_name` Postgres Exporter archive name (default: `'postgres_exporter-0.11.1.linux-amd64'` or `'postgres_exporter-0.11.1.windows-amd64'`).
 - `postgres_exporter_archive_extension` Postgres Exporter archive extension (default: `tar.gz`)
-- `postgres_exporter_download_url` URL to download an archive with Postgres Exporter.
+- `postgres_exporter_download_url` URL to download an archive with Postgres Exporter (default: `https://github.com/prometheus-community/postgres_exporter/releases/download/v0.11.1`).
 - `postgres_exporter_user` and `postgres_exporter_group` Unix username and group (default: `postgres`).
 - `postgres_exporter_install_path` Path to Postgres Exporter installation directory (default: `/usr/local/bin`).
 - `postgres_exporter_data_source_name` Accepts URI form and key=value form arguments. The URI may contain the username and password to connect with. (default: `user=postgres host=/var/run/postgresql/ sslmode=disable`).
+- `postgres_exporter_listen_address` Address to listen on for web interface and telemetry (default: `0.0.0.0`).
+- `postgres_exporter_listen_port` The port to bind to (default: `9182`).
+- `postgres_exporter_metrics_path` The path at which to serve metrics (default: `metrics`).
+- `postgres_exporter_disable_default_metrics` Use only metrics supplied from queries.yaml via `postgres_exporter_extend_query_path` (default: `false`).
+- `postgres_exporter_disable_settings_metrics` Use the flag if you don't want to scrape pg_settings (default: `false`).
 - `postgres_exporter_extend_query_path` Path to a YAML file containing custom queries to run. (default: `''`).
 - `postgres_exporter_log_level` Postgres Exporter logging level.
 
@@ -29,6 +35,12 @@ Role Variables
   - `warn`
   - `error`
 
+- `postgres_exporter_log_format` Postgres Exporter logging format.
+
+  Available values:
+  - `logfmt` (default)
+  - `json`
+
 Dependencies
 ------------
 
@@ -37,7 +49,7 @@ None.
 Example Playbook
 ----------------
 
-- Install and configure Postgres Exporter:
+- Install and configure `Postgres Exporter`:
 
   ```yaml
   ---
diff --git a/defaults/main.yml b/defaults/main.yml
@@ -1,7 +1,7 @@
 ---
 # See available releases: https://github.com/prometheus-community/postgres_exporter/releases
 postgres_exporter_version: '0.11.1'
-postgres_exporter_archive_name: 'postgres_exporter-{{ postgres_exporter_version }}.linux-{{ _postgres_exporter_architecture }}'
+postgres_exporter_archive_name: 'postgres_exporter-{{ postgres_exporter_version }}.{{ _postgres_exporter_os }}-{{ _postgres_exporter_architecture }}'
 postgres_exporter_archive_extension: 'tar.gz'
 postgres_exporter_download_url: 'https://github.com/prometheus-community/postgres_exporter/releases/download/v{{ postgres_exporter_version }}'
 
@@ -10,11 +10,17 @@ postgres_exporter_user: 'postgres'
 postgres_exporter_group: '{{ postgres_exporter_user }}'
 
 # Postgres Exporter directories.
-postgres_exporter_install_path: '/usr/local/bin'
+postgres_exporter_install_path: '{{ _postgres_exporter_install_path }}'
 
 # See available environment variables: https://github.com/prometheus-community/postgres_exporter#environment-variables
-postgres_exporter_data_source_name: 'user=postgres host=/var/run/postgresql/ sslmode=disable'
+postgres_exporter_data_source_name: '{{ _postgres_exporter_data_source_name }}'
 
 # See available settings flags: https://github.com/prometheus-community/postgres_exporter#flags
+postgres_exporter_listen_address: '0.0.0.0'
+postgres_exporter_listen_port: 9187
+postgres_exporter_metrics_path: '/metrics'
+postgres_exporter_disable_default_metrics: false
+postgres_exporter_disable_settings_metrics: false
 postgres_exporter_extend_query_path: ''
 postgres_exporter_log_level: 'info'
+postgres_exporter_log_format: 'logfmt'
diff --git a/handlers/main.yml b/handlers/main.yml
@@ -1,5 +1,5 @@
 ---
-- name: 'Restart Postgres Exporter'
+- name: 'Linux | Restart Postgres Exporter'
   ansible.builtin.systemd:
     name: postgres_exporter
     state: restarted
diff --git a/meta/main.yml b/meta/main.yml
@@ -18,6 +18,13 @@ galaxy_info:
       versions:
         - 'bionic'
         - 'focal'
+    - name: Debian
+      versions:
+        - 'bullseye'
+    - name: Windows
+      versions:
+        - '2016'
+        - '2019'
 
   galaxy_tags:
     - monitoring
diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml
@@ -1,7 +1,6 @@
 ---
 - name: 'Prepare an Ansible host for Github Actions'
   hosts: localhost
-
   tasks:
     - name: 'Install tar for delegated to localhost tasks'
       apk:
diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml
@@ -22,5 +22,7 @@ platforms:
     pre_build_image: true
 provisioner:
   name: ansible
+  playbooks:
+    verify: ../resources/tests/verify.yml
 verifier:
   name: ansible
diff --git a/molecule/resources/tests/verify.yml b/molecule/resources/tests/verify.yml
@@ -0,0 +1,22 @@
+---
+- name: 'Verify'
+  hosts: all
+  gather_facts: false
+
+  tasks:
+    - name: 'Gathering Service Facts'
+      ansible.builtin.service_facts:
+
+    - name: 'Assert that postgres_exporter service is enabled and running'
+      ansible.builtin.assert:
+        that:
+          - ansible_facts.services['postgres_exporter.service'].state == 'running'
+          - ansible_facts.services['postgres_exporter.service'].status == 'enabled'
+
+    - name: 'Verify postgres_exporter is responding to requests'
+      ansible.builtin.uri:
+        url: 'http://{{ ansible_host }}:9187/metrics'
+      register: _result
+      until: _result.status == 200
+      retries: 120
+      delay: 5
diff --git a/molecule/resources/tests/win_verify.yml b/molecule/resources/tests/win_verify.yml
@@ -0,0 +1,14 @@
+---
+- name: 'Verify'
+  hosts: all
+  gather_facts: false
+
+  tasks:
+    - name: 'Verify postgres_exporter is responding to requests'
+      ansible.builtin.uri:
+        url: 'http://{{ ansible_host }}:9187/metrics'
+      delegate_to: localhost
+      register: _result
+      until: _result.status == 200
+      retries: 120
+      delay: 5
diff --git a/molecule/vagrant-windows/converge.yml b/molecule/vagrant-windows/converge.yml
@@ -0,0 +1,5 @@
+---
+- name: 'Converge'
+  hosts: all
+  roles:
+    - role: antmelekhin.postgres_exporter
diff --git a/molecule/vagrant-windows/molecule.yml b/molecule/vagrant-windows/molecule.yml
@@ -0,0 +1,33 @@
+---
+dependency:
+  name: galaxy
+driver:
+  name: vagrant
+lint: |
+  set -e
+  yamllint .
+platforms:
+  - name: instance
+    box: 'jborean93/WindowsServer2019'
+    interfaces:
+      - network_name: forwarded_port
+        guest: 9187
+        host: 9187
+provisioner:
+  name: ansible
+  inventory:
+    host_vars:
+      instance:
+        ansible_host: 127.0.0.1
+        ansible_port: 55986
+        ansible_user: vagrant
+        ansible_password: vagrant
+        ansible_connection: winrm
+        ansible_winrm_scheme: https
+        ansible_winrm_transport: ntlm
+        ansible_winrm_server_cert_validation: ignore
+        ansible_become: false
+  playbooks:
+    verify: ../resources/tests/win_verify.yml
+verifier:
+  name: ansible
diff --git a/molecule/vagrant-windows/prepare.yml b/molecule/vagrant-windows/prepare.yml
@@ -0,0 +1,5 @@
+---
+- name: 'Prepare'
+  hosts: all
+  gather_facts: False
+  tasks: []
diff --git a/tasks/Linux/configure.yml b/tasks/Linux/configure.yml
@@ -0,0 +1,24 @@
+---
+- name: 'Configure and start Postgres Exporter'
+  block:
+    - name: 'Linux | Configure SystemD unit for Postgres Exporter'
+      ansible.builtin.template:
+        src: 'postgres_exporter.service.j2'
+        dest: '/etc/systemd/system/postgres_exporter.service'
+        owner: '{{ postgres_exporter_user }}'
+        group: '{{ postgres_exporter_group }}'
+        mode: 0644
+      register: _postgres_exporter_service
+
+    - name: 'Linux | Reload systemd daemon if unit file is changed'
+      ansible.builtin.systemd:
+        daemon_reload: true
+      when: _postgres_exporter_service is changed
+      notify: Linux | Restart Postgres Exporter
+
+    - name: 'Linux | Ensure Postgres Exporter is running and enabled at boot'
+      ansible.builtin.systemd:
+        name: postgres_exporter
+        state: started
+        enabled: true
+  become: true
diff --git a/tasks/Linux/install.yml b/tasks/Linux/install.yml
@@ -1,42 +1,37 @@
 ---
-- name: 'Check current Postgres Exporter version'
+- name: 'Linux | Check current Postgres Exporter version'
   ansible.builtin.command:
     cmd: '{{ postgres_exporter_install_path }}/postgres_exporter --version'
   failed_when: false
   changed_when: false
   register: _postgres_exporter_version_check
 
-- name: 'Download and unarchive Postgres Exporter'
+- name: 'Linux | Download and unarchive Postgres Exporter'
   block:
-    - name: 'Set archive fullname and temporary directory for Postgres Exporter'
-      ansible.builtin.set_fact:
-        _postgres_exporter_archive: '{{ postgres_exporter_archive_name }}.{{ postgres_exporter_archive_extension }}'
-        _postgres_exporter_tmp_dir: '{{ postgres_exporter_archive_name }}'
-
-    - name: 'Download Postgres Exporter binary to local folder'
+    - name: 'Linux | Download Postgres Exporter binary to local folder'
       ansible.builtin.get_url:
         url: '{{ postgres_exporter_download_url }}/{{ _postgres_exporter_archive }}'
         dest: '/tmp/{{ _postgres_exporter_archive }}'
         mode: 0644
       delegate_to: localhost
       check_mode: false
 
-    - name: 'Unarchive Postgres Exporter binary'
+    - name: 'Linux | Unarchive Postgres Exporter binary'
       ansible.builtin.unarchive:
         src: '/tmp/{{ _postgres_exporter_archive }}'
         dest: '/tmp'
         creates: '/tmp/{{ _postgres_exporter_tmp_dir }}/postgres_exporter'
       delegate_to: localhost
       check_mode: false
 
-    - name: 'Copy Postgres Exporter binary into place'
+    - name: 'Linux | Copy Postgres Exporter binary into place'
       ansible.builtin.copy:
         src: '/tmp/{{ _postgres_exporter_tmp_dir }}/postgres_exporter'
         dest: '{{ postgres_exporter_install_path }}/postgres_exporter'
         owner: '{{ postgres_exporter_user }}'
         group: '{{ postgres_exporter_group }}'
         mode: 0755
-      notify: Restart Postgres Exporter
+      notify: Linux | Restart Postgres Exporter
       when: not ansible_check_mode
       become: true
   when:
diff --git a/tasks/Linux/pre-install.yml b/tasks/Linux/pre-install.yml
@@ -0,0 +1,19 @@
+---
+- name: 'Prepare to install Postgres Exporter'
+  block:
+    - name: 'Linux | Create Postgres Exporter group'
+      ansible.builtin.group:
+        name: '{{ postgres_exporter_group }}'
+        system: true
+      when: postgres_exporter_group != 'postgres'
+
+    - name: 'Linux | Create Postgres Exporter user'
+      ansible.builtin.user:
+        name: '{{ postgres_exporter_user }}'
+        group: '{{ postgres_exporter_group }}'
+        comment: 'Postgres Exporter'
+        system: true
+        createhome: false
+        shell: '/bin/false'
+      when: postgres_exporter_user != 'postgres'
+  become: true
diff --git a/tasks/Win32NT/configure.yml b/tasks/Win32NT/configure.yml
@@ -0,0 +1,52 @@
+---
+- name: 'Windows | Set an environment variable for Postgres Exporter'
+  win_environment:
+    level: machine
+    name: 'DATA_SOURCE_NAME'
+    value: '{{ postgres_exporter_data_source_name }}'
+    state: present
+
+- name: 'Windows | Set arguments'
+  ansible.builtin.set_fact:
+    _postgres_exporter_arguments: >-
+      --web.listen-address {{ postgres_exporter_listen_address }}:{{ postgres_exporter_listen_port }}
+      --web.telemetry-path {{ postgres_exporter_metrics_path }}
+      {%- if postgres_exporter_disable_default_metrics | bool %} --disable-default-metrics {%- endif %}
+      {%- if postgres_exporter_disable_settings_metrics | bool %} --disable-settings-metrics {%- endif %}
+      {%- if postgres_exporter_extend_query_path | length > 0 %} --extend.query-path {{ postgres_exporter_extend_query_path }} {%- endif %}
+      --log.level {{ postgres_exporter_log_level }}
+      --log.format {{ postgres_exporter_log_format }}
+
+- name: 'Windows | Ensure scheduled task for Postgres Exporter is enabled at boot'
+  win_scheduled_task:
+    name: 'Postgres Exporter'
+    description: 'Prometheus exporter for Postgres server metrics.'
+    actions:
+      - path: '{{ postgres_exporter_install_path }}\postgres_exporter.exe'
+        arguments: '{{ _postgres_exporter_arguments }}'
+    triggers:
+      - type: 'boot'
+    execution_time_limit: 'PT0S'
+    username: 'SYSTEM'
+    enabled: true
+    state: present
+  register: _postgres_exporter_scheduled_task
+
+- name: 'Windows | Ensure scheduled task for Postgres Exporter is running'
+  win_shell: schtasks /end /tn 'Postgres Exporter'; schtasks /run /tn 'Postgres Exporter'
+  when:
+    - not ansible_check_mode
+    - _postgres_exporter_scheduled_task is changed
+
+- name: 'Windows | Ensure firewall rule for Postgres Exporter is allow'
+  win_firewall_rule:
+    name: 'Postgres Exporter'
+    description: 'Inbound rule for Postgres Exporter'
+    program: '{{ postgres_exporter_install_path }}\postgres_exporter.exe'
+    localport: '{{ postgres_exporter_listen_port }}'
+    action: allow
+    direction: in
+    protocol: tcp
+    profiles: 'domain,private,public'
+    enabled: true
+    state: present
diff --git a/tasks/Win32NT/install.yml b/tasks/Win32NT/install.yml
@@ -0,0 +1,34 @@
+---
+- name: 'Windows | Check current Postgres Exporter version'
+  win_command:
+    cmd: '{{ postgres_exporter_install_path }}/postgres_exporter --version'
+  failed_when: false
+  changed_when: false
+  register: _postgres_exporter_version_check
+
+- name: 'Windows | Download and unarchive Postgres Exporter'
+  block:
+    - name: 'Windows | Download Postgres Exporter binary to local folder'
+      ansible.builtin.get_url:
+        url: '{{ postgres_exporter_download_url }}/{{ _postgres_exporter_archive }}'
+        dest: '/tmp/{{ _postgres_exporter_archive }}'
+        mode: 0644
+      delegate_to: localhost
+      check_mode: false
+
+    - name: 'Windows | Unarchive Postgres Exporter binary'
+      ansible.builtin.unarchive:
+        src: '/tmp/{{ _postgres_exporter_archive }}'
+        dest: '/tmp'
+        creates: '/tmp/{{ _postgres_exporter_tmp_dir }}/postgres_exporter.exe'
+      delegate_to: localhost
+      check_mode: false
+
+    - name: 'Windows | Copy Postgres Exporter binary into place'
+      win_copy:
+        src: '/tmp/{{ _postgres_exporter_tmp_dir }}/postgres_exporter.exe'
+        dest: '{{ postgres_exporter_install_path }}\postgres_exporter.exe'
+      when: not ansible_check_mode
+  when:
+    - _postgres_exporter_version_check.stdout is not defined or
+      postgres_exporter_version not in _postgres_exporter_version_check.stdout
diff --git a/tasks/Win32NT/pre-install.yml b/tasks/Win32NT/pre-install.yml
@@ -0,0 +1,5 @@
+---
+- name: 'Windows | Create Postgres Exporter directory'
+  win_file:
+    path: '{{ postgres_exporter_install_path }}'
+    state: directory
diff --git a/tasks/configure.yml b/tasks/configure.yml
diff --git a/tasks/main.yml b/tasks/main.yml
diff --git a/tasks/pre-install.yml b/tasks/pre-install.yml
diff --git a/templates/postgres_exporter.service.j2 b/templates/postgres_exporter.service.j2
diff --git a/vars/Linux.yml b/vars/Linux.yml
diff --git a/vars/Win32NT.yml b/vars/Win32NT.yml
