Add metal-v2-client role to install V2 client library. (#525)

Author: Gerrit91

control-plane/README.md

@@ -51,6 +51,7 @@ The `defaults` folder contains defaults that are used by multiple roles in the c
 | [meili-backup-restore](roles/meili-backup-restore)                     | A role for deploying a meilisearch database with a [backup-restore-sidecar](https://github.com/metal-stack/backup-restore-sidecar) |
 | [metal-db](roles/metal-db)                                             | Deploys a database for the metal-api                                                                                               |
 | [metal-python](roles/metal-python)                                     | Installs metal-python                                                                                                              |
+| [metal-v2-client](roles/metal-v2-client)                               | Installs metal-stack-api                                                                                                           |
 | [metal](roles/metal)                                                   | Deploys all metal-stack components of the metal-control-plane via Helm chart                                                       |
 | [monitoring](roles/monitoring)                                         | Deploys metal-stack control plane monitoring components                                                                            |
 | [nsq](roles/nsq)                                                       | Deploys [nsq](https://nsq.io/)                                                                                                     |

control-plane/roles/metal-v2-client/README.md

@@ -0,0 +1,16 @@
+# metal-v2-client
+
+Sets up [metal-stack-api](https://pypi.org/project/metal-stack-api/) client library from [api](https://github.com/metal-stack/api).
+
+By default, this role uses the release vector to derive the fitting version of the client library.
+
+## Requirements
+
+None
+
+## Variables
+
+| Name                                            | Mandatory | Description                                                                               |
+| ----------------------------------------------- | --------- | ----------------------------------------------------------------------------------------- |
+| metal_v2_client_install_latest_on_version_error |           | Whether to just install latest client library version when given version was not found    |
+| metal_v2_client_install_from_git_repository     |           | Alternatively, install directly from the git repository (e.g. for testing a devel branch) |

control-plane/roles/metal-v2-client/defaults/main.yaml

@@ -0,0 +1,3 @@
+---
+metal_v2_client_install_latest_on_version_error: true
+metal_v2_client_install_from_git_repository: false

control-plane/roles/metal-v2-client/meta/main.yaml

@@ -0,0 +1,16 @@
+---
+galaxy_info:
+  role_name: metal-v2-client
+  author: metal-stack
+  description: Installs the metal-stack v2 client library.
+  license: MIT
+  min_ansible_version: "2.18"
+  galaxy_tags: []
+
+  platforms:
+    - name: GenericLinux
+      versions:
+        - all
+
+dependencies:
+  - role: metal-roles/common/roles/defaults

control-plane/roles/metal-v2-client/tasks/main.yaml

@@ -0,0 +1,40 @@
+---
+- name: Gather releases
+  setup_yaml:
+
+- name: Install metal-stack-api
+  block:
+    - name: Install metal-stack-api client library {{ metal_api_version }}
+      pip:
+        name:
+          - metal-stack-api=={{ metal_api_version }}
+          - bufbuild-protovalidate-protocolbuffers-python
+      environment:
+        # to install the bug module we need for now a download from the buf.build index:
+        # https://github.com/bufbuild/protovalidate-python/pull/367
+        PIP_EXTRA_INDEX_URL: https://buf.build/gen/python
+
+      when: not metal_v2_client_install_from_git_repository | bool
+
+    - name: Install metal-stack-api client library {{ metal_api_version }} from git repository
+      pip:
+        name: git+https://github.com/metal-stack/api.git@{{ metal_api_version }}#subdirectory=python
+      when: metal_v2_client_install_from_git_repository | bool
+      environment:
+        VERSION: "{{ metal_api_version }}"
+
+  rescue:
+    # attempt with latest available client when fitting client is not available
+    - name: Install latest metal-stack-api client library (fallback)
+      pip:
+        name:
+          - metal-stack-api
+          - bufbuild-protovalidate-protocolbuffers-python
+      environment:
+        PIP_EXTRA_INDEX_URL: https://buf.build/gen/python
+      when: metal_v2_client_install_latest_on_version_error | bool
+
+    - name: Fail on unavailable version
+      fail:
+        msg: "given metal-stack-api version not found"
+      when: not metal_v2_client_install_latest_on_version_error | bool