Merge pull request #779 from rrinco/fix-mkp-management

Server Site MKP management not working #777

Author: robin-checkmk

changelogs/fragments/fix-mkp-management.yml

@@ -0,0 +1,5 @@
+bugfixes:
+  - roles/server/tasks/mkp was using 'omd su site -c' to execute comands a site user but it does not work in all flavors/versions so changed to become_user instead (https://github.com/Checkmk/ansible-collection-checkmk.general/issues/777)
+  - roles/server/tasks/mkp fails when try to install a mkp packages that already exists in the server. Added a conditional to validate stderr and don't fail if "exists on the site" is found (https://github.com/Checkmk/ansible-collection-checkmk.general/issues/777)
+minor_changes:
+  - roles/server/tasks/mkp expects a boolean value for __mkp.installed and __mkp.enabled but in README.md and defaults.yml the usage examples set them as string. Changed README.md but also added "| bool" to force boolean even if string is defined (https://github.com/Checkmk/ansible-collection-checkmk.general/issues/777)

roles/server/README.md

@@ -88,8 +88,8 @@ Note: this is not a recommended procedure, and will not be supported for enterpr
             src: '/path/to/my.mkp'
             url: 'https://exchange.checkmk.com/packages/mypackage/4711/mypackage-1.0.0.mkp'
             checksum: 'md5:mychecksum'
-            installed: 'true'
-            enabled: 'true'
+            installed: true
+            enabled: true
 
 A dictionary of sites, containing the desired version, admin password, site configuration options, extension packages and state.
 The more advanced settings will be outlined below.

roles/server/defaults/main.yml

@@ -51,8 +51,8 @@ checkmk_server_sites: []
 #       src: '/path/to/my.mkp'
 #       url: 'https://exchange.checkmk.com/packages/mypackage/4711/mypackage-1.0.0.mkp'
 #       checksum: 'md5:mychecksum'
-#       installed: 'true'
-#       enabled: 'true'
+#       installed: true
+#       enabled: true
 
 checkmk_server_configure_firewall: 'true'
 

roles/server/tasks/mkp.yml

@@ -3,7 +3,7 @@
   ansible.builtin.get_url:
     url: "{{ __mkp.url }}"
     dest: "{{ __checkmk_server_tmp_dir }}/{{ __mkp.name }}-{{ __mkp.version }}.mkp"
-    mode: "0640"
+    mode: "0644"
     url_username: "{{ __mkp.download_user | default(omit) }}"
     url_password: "{{ __mkp.download_password | default(omit) }}"
     checksum: "{{ __mkp.checksum | default(omit) }}"
@@ -19,7 +19,7 @@
   ansible.builtin.copy:
     src: "{{ __mkp.src }}"
     dest: "{{ __checkmk_server_tmp_dir }}/{{ __mkp.name }}-{{ __mkp.version }}.mkp"
-    mode: "0640"
+    mode: "0644"
   loop: "{{ __site.mkp_packages }}"
   loop_control:
     loop_var: __mkp
@@ -29,48 +29,53 @@
 
 - name: "Install mkp packages."
   become: true
-  ansible.builtin.command: "omd su {{ __site.name }} -c mkp add {{ __checkmk_server_tmp_dir }}/{{ __mkp.name }}-{{ __mkp.version }}.mkp"
+  become_user: "{{ __site.name }}"
+  ansible.builtin.command: "/bin/bash -l -c 'mkp add {{ __checkmk_server_tmp_dir }}/{{ __mkp.name }}-{{ __mkp.version }}.mkp'"
   changed_when: __checkmk_server_mkp_install_output.rc == 0
+  failed_when: __checkmk_server_mkp_install_output.rc != 0 and 'exists on the site' not in __checkmk_server_mkp_install_output.stderr
   register: __checkmk_server_mkp_install_output
   loop: "{{ __site.mkp_packages }}"
   loop_control:
     loop_var: __mkp
-  when: (__mkp.installed | default(true) )
+  when: (__mkp.installed | default(true) ) | bool
   tags:
     - manage-mkp-packages
 
 - name: "Enable mkp packages."
   become: true
-  ansible.builtin.command: "omd su {{ __site.name }} -c mkp enable {{ __mkp.name }} {{ __mkp.version }}"
+  become_user: "{{ __site.name }}"
+  ansible.builtin.command: "/bin/bash -l -c 'mkp enable {{ __mkp.name }} {{ __mkp.version }}'"
   changed_when: __checkmk_server_mkp_enable_output.rc == 0
   register: __checkmk_server_mkp_enable_output
   loop: "{{ __site.mkp_packages }}"
   loop_control:
     loop_var: __mkp
-  when: (__mkp.enabled | default(true))
+  when: (__mkp.enabled | default(true)) | bool
   tags:
     - manage-mkp-packages
 
 - name: "Disable mkp packages."
   become: true
-  ansible.builtin.command: "omd su {{ __site.name }} -c mkp disable {{ __mkp.name }} {{ __mkp.version }}"
+  become_user: "{{ __site.name }}"
+  ansible.builtin.command: "/bin/bash -l -c 'mkp disable {{ __mkp.name }} {{ __mkp.version }}'"
   changed_when: __checkmk_server_mkp_disable_output.rc == 0
   register: __checkmk_server_mkp_disable_output
   loop: "{{ __site.mkp_packages }}"
   loop_control:
     loop_var: __mkp
-  when: __mkp.enabled is defined and not __mkp.enabled
+  when: __mkp.enabled is defined and (not __mkp.enabled | bool)
   tags:
     - manage-mkp-packages
 
 - name: "Remove mkp packages."
   become: true
-  ansible.builtin.command: "omd su {{ __site.name }} -c mkp remove {{ __mkp.name }} {{ __mkp.version }}"
+  become_user: "{{ __site.name }}"
+  ansible.builtin.command: "/bin/bash -l -c 'mkp remove {{ __mkp.name }} {{ __mkp.version }}'"
   changed_when: __checkmk_server_mkp_remove_output.rc == 0
   register: __checkmk_server_mkp_remove_output
   loop: "{{ __site.mkp_packages }}"
   loop_control:
     loop_var: __mkp
-  when: __mkp.installed is defined and not __mkp.installed
+  when: __mkp.installed is defined and (not __mkp.installed | bool)
   tags:
     - manage-mkp-packages