Fix repository management issues and simplify configuration (#347)

* prevent Ceph repository from being removed, fixes #342
* translate *_repository_line role variables to their respective *_repository deb822 counterparts
* refactor: remove legacy repository configurations

Author: PendaGTP

README.md

@@ -379,13 +379,12 @@ serially during a maintenance period.) It will also enable the IPMI watchdog.
 ```
 [variable]: [default] #[description/purpose]
 pve_group: proxmox # host group that contains the Proxmox hosts to be clustered together
-# Proxmox repository configuration for PVE 9 and above
+# Proxmox repository configuration
 pve_repository:
-  uris: # List of URIs for the Proxmox repository
-  suites: # List of suites for the Proxmox repository
-  components: # List of components for the Proxmox repository
-# Proxmox repository configuration for PVE 8 and below
-pve_repository_line: "deb http://download.proxmox.com/debian/pve bookworm pve-no-subscription" # apt-repository configuration - change to enterprise if needed (although TODO further configuration may be needed)
+  uris: http://download.proxmox.com/debian/pve
+  suites: "{{ ansible_distribution_release }}"
+  components: pve-no-subscription # change to enterprise if needed (although TODO further configuration may be needed)
+# pve_repository_line: "" # apt-repository configuration, backward compatibility, prefer to use pve_repository instead
 pve_remove_subscription_warning: true # patches the subscription warning messages in proxmox if you are using the community edition
 pve_extra_packages: [] # Any extra packages you may want to install, e.g. ngrep
 pve_run_system_upgrades: false # Let role perform system upgrades
@@ -412,13 +411,12 @@ pve_zfs_enabled: no # Specifies whether or not to install and configure ZFS pack
 # pve_zfs_zed_email: "" # Should be set to an email to receive ZFS notifications
 pve_zfs_create_volumes: [] # List of ZFS Volumes to create (to use as PVE Storages). See section on Storage Management.
 pve_ceph_enabled: false # Specifies wheter or not to install and configure Ceph packages. See below for an example configuration.
-# Proxmox Ceph repository configuration for PVE 9 and above
+# Proxmox Ceph Repository
 pve_ceph_repository:
-  uris: # List of URIs for the Ceph repository
-  suites: # List of suites for the Ceph repository
-  components: # List of components for the Ceph repository
-# Proxmox Ceph repository configuration for PVE 8 and below
-pve_ceph_repository_line: "deb http://download.proxmox.com/debian/ceph-pacific bookworm main" # apt-repository configuration. Will be automatically set for 6.x and 7.x (Further information: https://pve.proxmox.com/wiki/Package_Repositories)
+  uris: http://download.proxmox.com/debian/ceph-{{ pve_ceph_default_version }}
+  suites: "{{ ansible_distribution_release }}"
+  components: "{{ pve_ceph_debian_component }}"
+#pve_ceph_repository_line: "" # apt-repository configuration, backward compatibility, prefer to use pve_ceph_repository instead
 pve_ceph_network: "{{ (ansible_default_ipv4.network +'/'+ ansible_default_ipv4.netmask) | ansible.utils.ipaddr('net') }}" # Ceph public network
 # pve_ceph_cluster_network: "" # Optional, if the ceph cluster network is different from the public network (see https://pve.proxmox.com/pve-docs/chapter-pveceph.html#pve_ceph_install_wizard)
 pve_ceph_nodes: "{{ pve_group }}" # Host group containing all Ceph nodes

defaults/main.yml

@@ -1,12 +1,12 @@
 ---
 # defaults file for ansible-role-proxmox
 pve_group: proxmox
+# Proxmox PVE Repository
 pve_repository:
   uris: http://download.proxmox.com/debian/pve
   suites: "{{ ansible_distribution_release }}"
   components: pve-no-subscription
-# Repo configuration for Proxmox VE < 9
-pve_repository_line: "deb http://download.proxmox.com/debian/pve {{ ansible_distribution_release }} pve-no-subscription"
+# pve_repository_line: ""
 pve_remove_subscription_warning: true
 pve_extra_packages: []
 pve_check_for_kernel_update: true
@@ -33,15 +33,12 @@ pve_zfs_enabled: no
 # pve_zfs_zed_email: "email address for zfs events"
 pve_zfs_create_volumes: []
 pve_ceph_enabled: false
+# Proxmox Ceph Repository
 pve_ceph_repository:
   uris: http://download.proxmox.com/debian/ceph-{{ pve_ceph_default_version }}
   suites: "{{ ansible_distribution_release }}"
   components: "{{ pve_ceph_debian_component }}"
-# Ceph Repo configuration for Proxmox VE < 9
-pve_ceph_repository_line: >-
-  deb http://download.proxmox.com/debian/ceph-{{ pve_ceph_default_version }}
-  {{ ansible_distribution_release }}
-  {{ pve_ceph_debian_component }}
+# pve_ceph_repository_line: ""
 pve_ceph_network: >-
   {{ (ansible_default_ipv4.network + '/' + ansible_default_ipv4.netmask) |
     ansible.utils.ipaddr('net') }}

tasks/main.yml

@@ -131,59 +131,8 @@
     name: os-prober
     state: absent
 
-- ansible.builtin.import_tasks: remove_enterprise_repos.yml
-  when:
-    - "'pve-no-subscription' in pve_repository_line"
-
-- name: Manage apt repositories
-  block:
-    - name: Add Proxmox repository
-      ansible.builtin.apt_repository:
-        repo: "{{ pve_repository_line }}"
-        filename: proxmox
-        state: present
-      register: _pve_repo
-
-    - name: Add Proxmox Ceph repository
-      ansible.builtin.apt_repository:
-        repo: '{{ pve_ceph_repository_line }}'
-        filename: ceph
-        state: present
-      register: _pve_ceph_repo
-      when: "pve_ceph_enabled | bool"
-  when: "ansible_distribution_major_version | int <= 12"
-
-- name: Manage deb822 repositories
-  block:
-    - name: Add Proxmox repository
-      ansible.builtin.deb822_repository:
-        name: proxmox
-        types: deb
-        uris: "{{ pve_repository.uris }}"
-        suites: "{{ pve_repository.suites }}"
-        components: "{{ pve_repository.components }}"
-        signed_by: /etc/apt/trusted.gpg.d/proxmox-release-{{ ansible_distribution_release }}.gpg
-        state: present
-      register: _pve_repo
-
-    - name: Add Proxmox Ceph repository
-      ansible.builtin.deb822_repository:
-        name: ceph
-        types: deb
-        uris: "{{ pve_ceph_repository.uris }}"
-        suites: "{{ pve_ceph_repository.suites }}"
-        components: "{{ pve_ceph_repository.components }}"
-        signed_by: /etc/apt/trusted.gpg.d/proxmox-release-{{ ansible_distribution_release }}.gpg
-        state: present
-      register: _pve_ceph_repo
-      when: "pve_ceph_enabled | bool"
-
-    - name: Update repositories cache
-      ansible.builtin.apt:
-        update_cache: yes
-      when: _pve_repo is changed or _pve_ceph_repo is changed
-
-  when: "ansible_distribution_major_version | int > 12"
+- name: Setup Proxmox repositories
+  ansible.builtin.import_tasks: repositories.yml
 
 - name: Run apt-get dist-upgrade on repository changes
   ansible.builtin.apt:
@@ -232,20 +181,20 @@
   register: _proxmox_install
   until: _proxmox_install is succeeded
 
-- block:
-    - ansible.builtin.import_tasks: remove_enterprise_repos.yml
-
-    - name: Remove subscription check wrapper function in web UI
-      ansible.builtin.lineinfile:
-        path: /usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js
-        line: "        orig_cmd(); return;"
-        insertafter: "^\\s+checked_command: function\\s?\\(orig_cmd\\) {$"
-        firstmatch: yes
-        backup: yes
-      when:
-        - "pve_remove_subscription_warning | bool"
+# Once Proxmox is installed, enterprise repositories are automatically added
+# This task ensure to update repositories with desired configuration
+- name: Ensure Proxmox repositories configuration
+  ansible.builtin.import_tasks: repositories.yml
+
+- name: Remove subscription check wrapper function in web UI
+  ansible.builtin.lineinfile:
+    path: /usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js
+    line: "        orig_cmd(); return;"
+    insertafter: "^\\s+checked_command: function\\s?\\(orig_cmd\\) {$"
+    firstmatch: yes
+    backup: yes
   when:
-    - "'pve-no-subscription' in pve_repository_line"
+    - "pve_remove_subscription_warning | bool"
 
 - ansible.builtin.import_tasks: pcie_passthrough.yml
   when: "pve_pcie_passthrough_enabled | bool"
@@ -288,7 +237,7 @@
     state: "{{ item.state | default('present') }}"
     comment: "{{ item.comment | default(omit) }}"
   with_items: "{{ pve_groups }}"
-  when: "not pve_cluster_enabled | bool or (pve_cluster_enabled | bool and inventory_hostname == _init_node)"
+  when: "not pve_cluster_enabled or (pve_cluster_enabled | bool and inventory_hostname == _init_node)"
 
 - name: Configure Proxmox user accounts
   proxmox_user:

tasks/remove_enterprise_repos.yml

@@ -0,0 +1,78 @@
+---
+- name: Convert pve_repository_line to pve_repository format
+  ansible.builtin.set_fact:
+    pve_repository:
+      uris: "{{ (pve_repository_line | trim | split(' '))[1] }}"
+      suites: "{{ (pve_repository_line | trim | split(' '))[2] }}"
+      components: "{{ (pve_repository_line | trim | split(' '))[3:] }}"
+  when:
+    - pve_repository_line is defined
+
+- name: Convert pve_ceph_repository_line to pve_ceph_repository format
+  ansible.builtin.set_fact:
+    pve_ceph_repository:
+      uris: "{{ (pve_ceph_repository_line | trim | split(' '))[1] }}"
+      suites: "{{ (pve_ceph_repository_line | trim | split(' '))[2] }}"
+      components: "{{ (pve_ceph_repository_line | trim | split(' '))[3:] }}"
+  when:
+    - pve_ceph_repository_line is defined
+    - pve_ceph_enabled | bool
+
+- name: Add PVE repository (deb822)
+  ansible.builtin.deb822_repository:
+    name: proxmox
+    types: deb
+    uris: "{{ pve_repository.uris }}"
+    suites: "{{ pve_repository.suites }}"
+    components: "{{ pve_repository.components }}"
+    signed_by: "/etc/apt/trusted.gpg.d/proxmox-release-{{ ansible_distribution_release }}.gpg"
+    state: present
+    enabled: true
+  register: _pve_repo
+
+- name: Ensure Ceph repository (PVE 8 and below) is compatible with new filename (PVE 9)
+  ansible.builtin.command:
+    mv "{{ _pve_ceph_repo_file_old }}" "{{ _pve_ceph_repo_file }}"
+  args:
+    creates: "{{ _pve_ceph_repo_file }}"
+    removes: "{{ _pve_ceph_repo_file_old }}"
+  vars:
+    _pve_ceph_repo_file: /etc/apt/sources.list.d/ceph.sources
+    _pve_ceph_repo_file_old: /etc/apt/sources.list.d/ceph.list
+  when:
+    - pve_ceph_enabled | bool
+
+- name: Add Ceph repository (deb822)
+  ansible.builtin.deb822_repository:
+    name: ceph
+    types: deb
+    uris: "{{ pve_ceph_repository.uris }}"
+    suites: "{{ pve_ceph_repository.suites }}"
+    components: "{{ pve_ceph_repository.components }}"
+    signed_by: "/etc/apt/trusted.gpg.d/proxmox-release-{{ ansible_distribution_release }}.gpg"
+    state: present
+    enabled: true
+  register: _pve_ceph_repo
+  when:
+    - pve_ceph_enabled | bool
+
+- name: Update repositories
+  ansible.builtin.apt:
+    update_cache: true
+  when: _pve_repo is changed or _pve_ceph_repo is changed
+
+- name: Ensure PVE enterprise repository is absent (deb822)
+  ansible.builtin.deb822_repository:
+    name: pve-enterprise
+    enabled: false
+    state: absent
+  when:
+    - pve_repository.components != "pve-enterprise"
+
+- name: Ensure PVE enterprise repository is absent (legacy)
+  ansible.builtin.apt_repository:
+    repo: "deb {{ pve_repository.uris }} {{ pve_repository.suites }} pve-enterprise"
+    state: absent
+    filename: pve-enterprise
+  when:
+    - pve_repository.components != "pve-enterprise"