Configurable DB Parameters: Implementation

[lgarber-akamai]

📝 Description

This pull request adds support for setting the engine_config field using the linode.cloud.database_mysql_v2 and linode.cloud.database_postgresql_v2 modules. Additionally, users can retrieve all valid configuration parameters using the new linode.cloud.database_config_info module.

✔️ How to Test

The following test steps assume you have pulled down this PR locally and run make install.

Integration Testing

make test-int TEST_ARGS="-v database_postgresql_v2_engine_config database_mysql_v2_engine_config database_config_info"

Manual Testing

The following test steps assume you have pointed your local shell environment at a Linode API instance that supports configurable database parameters:

export LINODE_TOKEN=MY_TOKEN
export LINODE_API_TOKEN=$LINODE_TOKEN

export LINODE_API_URL=https://my.dev.api.linode.com/
export LINODE_CA=/path/to/my/cert.pem

You may also need to forcibly reinstall from this Ansible Collections requirements.txt to pick up the corresponding SDK changes.

linode.cloud.database_config_info

1. In an ansible_linode sandbox environment (e.g. dx-devenv), run the following playbook:

---
- name: ansible_linode Sandbox Playbook
  hosts: localhost
  tasks:
    - name: Retrieve all valid MySQL engine_config fields
      linode.cloud.database_config_info:
        engine: mysql
      register: mysql_config_fields

    - debug:
        var: mysql_config_fields

2. Ensure the output contains all engine_config valid fields for MySQL databases.

linode.cloud.database_mysql_v2

1. In an ansible_linode sandbox environment (e.g. dx-devenv), run the following playbook:

---
- name: ansible_linode Sandbox Playbook
  hosts: localhost
  tasks:
    - name: Create a database with an explicit engine_config
      linode.cloud.database_mysql_v2:
        label: ansible-test-manual
        region: us-mia
        engine: "mysql/8"
        type: g6-nanode-1
        cluster_size: 1
        engine_config:
          binlog_retention_period: 600
          mysql:
            connect_timeout: 20
        state: present
        register: db_create

    - debug:
        var: db_create

2. Ensure the playbook runs successfully and the engine_config is included in the output.

linode.cloud.database_postgresql_v2

1. In an ansible_linode sandbox environment (e.g. dx-devenv), run the following playbook:

---
- name: ansible_linode Sandbox Playbook
  hosts: localhost
  tasks:
    - name: Create a database with an explicit engine_config
      linode.cloud.database_postgresql_v2:
        label: ansible-test-manual
        region: us-mia
        engine: "postgresql/17"
        type: g6-nanode-1
        cluster_size: 1
        engine_config:
          pg:
            autovacuum_analyze_scale_factor: 0.2
          work_mem: 1024
        state: present
        register: db_create

    - debug:
        var: db_create

2. Ensure the playbook runs successfully and the engine_config is included in the output.

[ezilber-akamai]

Clever design with the shared config info module! Tests are passing locally and implementation looks good and aligns with the API spec.

[yec-akamai]

When running the integration test I got this error:

TASK [database_postgresql_v2_engine_config : Assert the error message includes default_toast_compression version check] ***
fatal: [testhost]: FAILED! => {
    "msg": "The conditional check 'db_result.msg is search(\"default_toast_compression\")' failed. The error was: error while evaluating conditional (db_result.msg is search(\"default_toast_compression\")): 'dict object' has no attribute 'msg'"
}

It seems the test case didn't fail as expected

[ykim-akamai]

When running the integration test I got this error:

TASK [database_postgresql_v2_engine_config : Assert the error message includes default_toast_compression version check] ***
fatal: [testhost]: FAILED! => {
    "msg": "The conditional check 'db_result.msg is search(\"default_toast_compression\")' failed. The error was: error while evaluating conditional (db_result.msg is search(\"default_toast_compression\")): 'dict object' has no attribute 'msg'"
}

It seems the test case didn't fail as expected

Looks like they removed Postgresql 13 from prod, staging, and alpha. I will remove this test case as it is no longer needed

[yec-akamai]

Tests are all passing now, nice work 🎉