Don't clobber system Python

Install python-openstackclient in a venv for
community_images operations

Author: m-bull

roles/community_images/defaults/main.yml

@@ -1,4 +1,11 @@
 ---
+# The path to the venv that python dependencies will be installed
+# in
+community_images_venv_path: /opt/community-images-venv
+
+# The path to the openstack cli executable
+community_images_openstack_cli_path: >-
+ {{ community_images_venv_path }}/bin/openstack
 
 # The directory into which images will be downloaded / converted
 # If not given, a temporary directory will be used

roles/community_images/tasks/main.yml

@@ -13,13 +13,15 @@
       apt:
         name:
           - python3-pip
+          - python3-venv
           - qemu-utils
         state: present
 
     - name: Ensure OpenStack CLI (and SDK) are available
       pip:
         name: python-openstackclient
-        executable: pip3
+        virtualenv: "{{ community_images_venv_path }}"
+        virtualenv_command: python3 -m venv
   become: yes
 
 - name: Ensure OpenStack config directory exists

roles/community_images/tasks/upload_image.yml

@@ -23,7 +23,10 @@
     path: "{{ community_images_workdir }}"
 
 - name: "List images with name - {{ community_images_image_spec.name }}"
-  command: "openstack image list -f json --name {{ community_images_image_spec.name }}"
+  command: >-
+    {{ community_images_openstack_cli_path }}
+    image list -f json
+    --name {{ community_images_image_spec.name }}
   changed_when: false
   register: community_images_image_list_cmd
 
@@ -37,7 +40,10 @@
         community_images_image_id: "{{ community_images_image_list | map(attribute = 'ID') | first }}"
 
     - name: "Fetch pre-existing image - {{ community_images_image_spec.name }}"
-      command: "openstack image show -f json {{ community_images_image_id }}"
+      command: >-
+        {{ community_images_openstack_cli_path }}
+        image show -f json
+        {{ community_images_image_id }}
       changed_when: false
       register: community_images_image_info
 
@@ -105,7 +111,7 @@
     # Instead, we use the OpenStack CLI directly
     - name: "Upload image - {{ community_images_image_spec.name }}"
       command: >-
-        openstack image create
+        {{ community_images_openstack_cli_path }} image create
           -f json
           --container-format {{ community_images_image_spec.container_format }}
           --disk-format {{ community_images_disk_format }}
@@ -141,12 +147,16 @@
 
 - name: "Set image visibility - {{ community_images_image_spec.name }}"
   command: >-
-    openstack image set --{{ community_images_image_visibility }} {{ community_images_image_id }}
+    {{ community_images_openstack_cli_path }}
+    image set
+    --{{ community_images_image_visibility }}
+    {{ community_images_image_id }}
   when: community_images_image_visibility != community_images_image_current_visibility
 
 - name: "Set custom properties for image - {{ community_images_image_spec.name }}"
   command: >-
-    openstack image set
+    {{ community_images_openstack_cli_path }}
+      image set
       {%- for property in community_images_custom_properties %}
       --property {{ property | quote }}
       {%- endfor %}
@@ -155,7 +165,10 @@
 
 - block:
     - name: "Share image with project - {{ community_images_image_spec.name }}"
-      command: "openstack image add project {{ community_images_image_id }} {{ project_id }}"
+      command: >-
+        {{ community_images_openstack_cli_path }}
+        image add project
+        {{ community_images_image_id }} {{ project_id }}
       register: community_images_image_add_project
       changed_when: community_images_image_add_project.rc == 0
       failed_when: >-
@@ -166,7 +179,10 @@
         loop_var: project_id
 
     - name: "Accept image into project - {{ community_images_image_spec.name }}"
-      command: "openstack image set --accept {{ community_images_image_id }}"
+      command: >-
+        {{ community_images_openstack_cli_path }}
+        image set
+        --accept {{ community_images_image_id }}
       environment:
         OS_CLOUD: "{{ project_key }}"
       loop: "{{ community_images_share_projects | map(attribute = 'key') | list }}"

roles/infra/tasks/main.yml

@@ -10,6 +10,7 @@
         name: azimuth_cloud.azimuth_ops.community_images
         tasks_from: upload_image
       vars:
+        community_images_openstack_cli_path: openstack
         community_images_image_spec:
           name: "{{ infra_image_name }}"
           source_url: "{{ infra_image_source_url }}"