feat: add module for setting LB backend member weight

Author: kangasta

.github/workflows/build-and-release.yml

@@ -27,7 +27,11 @@ jobs:
         run: pip install https://github.com/ansible/ansible/archive/${{env.ANSIBLE_VERSION}}.tar.gz --disable-pip-version-check
 
       - name: Build project release
-        run: mkdir release && ansible-galaxy collection build --output-path release/
+        run: |
+          version=$(grep "version" galaxy.yml | sed -E "s/version:\s+//")
+          test "${{ github.ref_name }}" = "v$version"
+          sed -E "s/(VERSION\s+=\s+).*/\1\"$version\"/" -i plugins/module_utils/client.py
+          mkdir release && ansible-galaxy collection build --output-path release/
 
       - name: Create new release
         uses: ncipollo/[email protected]

.github/workflows/sanity-test.yml

@@ -15,9 +15,9 @@ jobs:
     strategy:
       matrix:
         version:
-          - { ansible: stable-2.17, python: "3.11" }
           - { ansible: stable-2.18, python: "3.11" }
           - { ansible: stable-2.19, python: "3.11" }
+          - { ansible: stable-2.20, python: "3.12" }
           - { ansible: devel, python: "3.12" }
     runs-on: ubuntu-latest
     steps:

.github/workflows/unit-tests.yml

@@ -17,9 +17,9 @@ jobs:
       fail-fast: true
       matrix:
         version:
-          - { ansible: stable-2.17, python: "3.11" }
           - { ansible: stable-2.18, python: "3.11" }
           - { ansible: stable-2.19, python: "3.11" }
+          - { ansible: stable-2.20, python: "3.12" }
           - { ansible: devel, python: "3.12" }
 
     steps:

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Experimental support for managing load balancer backend member weights.
+
+### Changed
+
+- Use `upcloud-ansible-collection` as prefix in the User-Agent header.
+
 ## [0.8.1] - 2025-09-04
 
 ### Fixed

examples/inventory-rolling-update/.gitignore

@@ -0,0 +1 @@
+variables.yml

examples/inventory-rolling-update/README.md

@@ -22,10 +22,10 @@ Configure a NGINX server with static web page by running the [configure-webserve
 
 ```sh
 # For initial configuration, configure all targets in parallel
-ansible-playbook configure-webserver.yml --extra-vars "serial_override=0"
+ansible-playbook configure-webserver.yml --extra-vars "@variables.yml" --extra-vars "serial_override=0"
 
 # When updating the targets, specify which tag (cow, dog, hello, or tiger) to use
-ansible-playbook configure-webserver.yml --extra-vars "animal=tiger"
+ansible-playbook configure-webserver.yml --extra-vars "@variables.yml" --extra-vars "animal=tiger"
 ```
 
 To monitor how the rolling update proceeds, open another terminal window and curl the load-balancer URL. The URL is visible at the output of prevous `terraform apply` command and can be printed by running `terraform output`.

examples/inventory-rolling-update/configure-webserver.yml

@@ -6,6 +6,17 @@
   vars:
     animal: cow
   tasks:
+    - name: Remove from load balancing
+      upcloud.cloud.loadbalancer_backend_member:
+        loadbalancer_uuid: "{{ loadbalancer_uuid }}"
+        backend_name: main
+        member_name: "member_{{ ansible_facts.hostname[-1:] }}"
+        weight: 0
+      when:
+      - serial_override|default(1)|int != 0
+      - loadbalancer_uuid is defined
+      delegate_to: localhost
+      become: false
     - name: Install nginx
       apt:
         package: nginx
@@ -48,6 +59,17 @@
         replace: '80'
       notify:
         - Restart nginx
+    - name: Add back to load balancing
+      upcloud.cloud.loadbalancer_backend_member:
+        loadbalancer_uuid: "{{ loadbalancer_uuid }}"
+        backend_name: main
+        member_name: "member_{{ ansible_facts.hostname[-1:] }}"
+        weight: 100
+      when:
+      - serial_override|default(1)|int != 0
+      - loadbalancer_uuid is defined
+      delegate_to: localhost
+      become: false
   handlers:
     - name: Restart nginx
       service:

examples/inventory-rolling-update/resources/main.tf

@@ -93,3 +93,7 @@ module "load_balancer" {
 output "lb_url" {
   value = module.load_balancer.dns_name
 }
+
+output "lb_uuid" {
+  value = module.load_balancer.id
+}

plugins/inventory/servers.py

@@ -130,12 +130,11 @@
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
 from ansible.utils.display import Display
 
-from ..version import collection_version
+from ..module_utils.client import initialize_upcloud_client
 
 display = Display()
 
 try:
-    import upcloud_api
     from upcloud_api.errors import UpCloudAPIError
     UC_AVAILABLE = True
 except ImportError:
@@ -164,37 +163,7 @@ def _initialize_upcloud_client(self):
             self.token_env
         )
 
-        # Token support was added in upcloud-api 2.8.0, older versions will raise TypeError if token is provided.
-        # Ignore the error if token is not provided, in which case older version should work as well.
-        try:
-            credentials = upcloud_api.Credentials.parse(
-                username=self.username,
-                password=self.password,
-                token=self.token,
-            )
-            self.client = upcloud_api.CloudManager(**credentials.dict)
-        except (AttributeError, TypeError):
-            try:
-                self.client = upcloud_api.CloudManager(self.username, self.password)
-            except Exception:
-                raise AnsibleError(
-                    'Invalid or missing UpCloud API credentials. '
-                    'The version of upcloud-api you are using does not support token authentication or parsing credentials from the environment. '
-                    'Update upcloud-api to version 2.8.0 or later.'
-                ) from None
-
-        version = collection_version() or "dev"
-        self.client.api.user_agent = f"upcloud-ansible-inventory/{version}"
-
-        api_root_env = "UPCLOUD_API_ROOT"
-        if os.getenv(api_root_env):
-            self.client.api.api_root = os.getenv(api_root_env)
-
-    def _test_upcloud_credentials(self):
-        try:
-            self.client.authenticate()
-        except UpCloudAPIError:
-            raise AnsibleError("Invalid UpCloud API credentials.")
+        self.client = initialize_upcloud_client(self.username, self.password, self.token)
 
     def _fetch_servers(self):
         return self.client.get_servers()
@@ -386,7 +355,6 @@ def verify_file(self, path):
 
     def _populate(self):
         self._initialize_upcloud_client()
-        self._test_upcloud_credentials()
         self._get_servers()
         self._filter_servers()