Merge pull request #27 from claranet/ssl_by_default_2

Enable SSL by default and change default value of postgresql_config_change_allow_restart to false

Author: davidassigbi

.ansible-lint

@@ -0,0 +1,4 @@
+---
+profile: production # min, basic, moderate, safety, shared, production
+exclude_paths:
+  - .github/workflows/galaxy.yml

.github/workflows/molecule.yml

@@ -37,12 +37,14 @@ jobs:
     steps:
       - name: checkout
         uses: actions/checkout@v4
-        with:
-          path: "${{ github.repository }}"
       - name: Run ansible lint
-        uses: ansible/ansible-lint[email protected]
+        uses: ansible/ansible-lint@main
         with:
-          path: "."
+          args: ""
+          setup_python: "true"
+          working_directory: ""
+          requirements_file: "./molecule/shared/tools/requirements.yml"
+
 
   test:
     name: Scenario "${{ matrix.scenario }}", pg-${{ matrix.postgresql_version }} on ${{ matrix.config.image }}:${{ matrix.config.tag }}

CONTRIBUTING.md

@@ -46,7 +46,7 @@ git clone <link-to-this-repository> ansible-role-postgresql
 cd ansible-role-postgresql
 python3 -m venv env # Create a virtual environnement
 source env/bin/activate # Activate the environnement
-pip3 install ansible ansible-lint molecule[docker] # Install the python packages in the virutal environnement
+pip3 install ansible ansible-lint molecule-plugins[docker] # Install the python packages in the virutal environnement
 ```
 
 After setting up the environnement you can use molecule to test the role as you wish. If you are not very familiar with molecule, checkout the following table for some basic commands you can run against this role.

README.md

@@ -181,10 +181,16 @@ postgresql_hba_raw: |
 postgresql_config_change_allow_restart: true
 # Controls running tasks handling: configuration
 postgresql_configure: true
+# Enable SSL
+postgresql_ca_enabled: true
+# Certificate file subject used during generation
+postgresql_ssl_cert_subj: /C=FR/ST=FR
 ```
 
 _Notes:_
 
+SSL configuration (introduced in `v3.0.0`) is enabled by default. The associated key and cert files are only regenerated if they are missing on the remote host. 
+
 By default, this role restarts the PostgreSQL service during subsequent configuration changes after the initial engine installation, ensuring all changes are applied immediately. However, this behavior can cause potential service outages.
 
 To prevent automatic restarts, you can set the variable `postgresql_config_change_allow_restart` (introduced in `v2.1.0`) to `false`. Starting with (`v3.0.0`), the default value of this variable will change to `false`, meaning the role will avoid restarting PostgreSQL by default. If you rely on the current behavior, you will need to explicitly set this variable to true in your configuration.
@@ -603,6 +609,10 @@ postgresql_tempfile_dest_path: /etc/tmpfiles.d/postgresql-common.conf
 postgresql_tempfile_mode: '0644'
 postgresql_tempfile_owner: root
 postgresql_tempfile_group: root
+# SSL cert file path, can be absolute or relative (to data dir)
+# postgresql_ssl_cert_file: (default is os specific. vars/<os>.yml)
+# SSL key file path, can be absolute or relative (to data dir)
+# postgresql_ssl_key_file: (default is os specific. vars/<os>.yml)
 
 # Controls running tasks handling: cluster initialization
 postgresql_initialize: true

defaults/main.yml

@@ -39,8 +39,17 @@ postgresql_unix_socket_directories:
   - /run/postgresql
 # Permissions for the PostgreSQL unix sockets (default is distro dependant)
 postgresql_unix_socket_directories_mode: ''
-# Allow service restart for configuration changes that require it
-postgresql_config_change_allow_restart: "{{ (postgresql_restarted_state | d('restarted')) == 'restarted' }}"
+# Allow service restart for conf changes that require it (default changed to false in v3.0.0+)
+postgresql_config_change_allow_restart: false
+# SSL related variables
+# Enable SSL
+postgresql_ca_enabled: true
+# SSL cert file path, can be absolute or relative
+# postgresql_ssl_cert_file: (default is os specific. vars/<os>.yml)
+# SSL key file path, can be absolute or relative
+# postgresql_ssl_key_file: (default is os specific. vars/<os>.yml)
+# Certificate file subject used during generation
+postgresql_ssl_cert_subj: /C=FR/ST=FR
 
 
 # Global configuration options that will be set in postgresql.conf.
@@ -61,6 +70,13 @@ postgresql_global_config_options:
     value: "{{ _postgresql_config_path }}/pg_hba.conf"
   - option: max_connections
     value: "{{ postgresql_max_connections }}"
+  - option: ssl
+    value: "{{ 'on' if postgresql_ca_enabled else 'off' }}"
+  - option: ssl_cert_file
+    value: '{{ postgresql_ssl_cert_file }}'
+  - option: ssl_key_file
+    value: '{{ postgresql_ssl_key_file }}'
+
 # Extra configuration options that are always inserted inside postgresql.conf
 postgresql_global_config_options_extra: []
 # Actual postgresql log directory
@@ -370,7 +386,8 @@ postgresql_uninstall_1: false
 postgresql_uninstall_2: false
 
 
-# Tells the role that the PostgreSQL instance is managed by Patroni therefore automatically disabling some features initialization,auto tuning,regular configuration, actual replication configuration
+# Tells the role that the PostgreSQL instance is managed by Patroni therefore automatically
+# disabling some features initialization,auto tuning,regular configuration, actual replication configuration
 postgresql_is_patroni: false
 # When combined with postgresql_install:true, this essentially skips all remaining tasks after packages installation
 postgresql_only_install: false

molecule/all_features/verify.yml

@@ -6,5 +6,5 @@
     - name: Include default verification
       ansible.builtin.include_tasks: tasks/verify_default.yml
 
-    - name: Include default verification
+    - name: Include vacuum verification
       ansible.builtin.include_tasks: tasks/verify_vacuum.yml

molecule/cluster/verify.yml

@@ -17,6 +17,7 @@
       ansible.builtin.command: psql -q -A -t -c "SELECT datname FROM pg_database"
       register: databases
       changed_when: false
+      become: true
       become_user: postgres
       vars:
         ansible_ssh_pipelining: true
@@ -37,15 +38,16 @@
       vars:
         ansible_ssh_pipelining: true
 
-    - name: Retrieve databases on replica nodes
+    - name: Retrieve databases on replica nodes to check deletion
       ansible.builtin.command: psql -q -A -t -c "SELECT datname FROM pg_database"
       register: databases
       changed_when: false
+      become: true
       become_user: postgres
       vars:
         ansible_ssh_pipelining: true
 
-    - name: Assert db created on primary is also present on the replicas
+    - name: Assert db not created on primary is also present on the replicas
       ansible.builtin.assert:
         that: '"db2" not in databases.stdout_lines'
 

molecule/shared/tasks/verify_default.yml

@@ -56,3 +56,16 @@
     msg: "Timeout waiting for 5432 to respond"
   register: port_check
   ignore_errors: true
+
+- name: Retrieve ssl option value
+  ansible.builtin.command: psql -q -A -t -c "show ssl"
+  register: ssl_res
+  changed_when: false
+  become: true
+  become_user: postgres
+  vars:
+    ansible_ssh_pipelining: true
+
+- name: Assert ssl is on by default
+  ansible.builtin.assert:
+    that: '"on" == (ssl_res.stdout | trim)'

molecule/shared/tasks/verify_vacuum.yml

@@ -1,10 +1,12 @@
 ---
 - name: Check if vacuum script works
   ansible.builtin.command: /var/scripts/pgsql_vacuumDB.sh vacuumanalyze
+  changed_when: true
   become: true
   become_user: postgres
 
 - name: Check min last vacuum date
   ansible.builtin.command: psql db1 -c "select min(last_vacuum) from pg_stat_user_tables;"
+  changed_when: false
   become: true
   become_user: postgres

molecule/shared/vars/main_all_features.yml

@@ -10,7 +10,7 @@ postgresql_global_config_options_extra:
   - option: log_statement
     value: all
   - option: logging_collector
-    value: on
+    value: 'on'
 postgresql_hba_entries_extra: []
   # - {contype: local, databases: all, users: postgres, method: peer}
 
@@ -36,20 +36,20 @@ postgresql_users:
 postgresql_memberships:
 # Ensure the role 'user1' belongs to group 'group1'
   - groups:
-    - group1
+      - group1
     target_roles:
-    - user1
+      - user1
     state: present
 # Ensure the role 'user2' does not belong to the group 'group2'
   - groups:
-    - group2
+      - group2
     target_roles:
-    - user2
+      - user2
     state: absent
 # Ensure the role 'jdoe' does not belong to any group
   - groups: []
     target_roles:
-    - jdoe
+      - jdoe
     state: exact
 
 postgresql_tablespaces: