Add optional documentation links to validations steps #76

tasks/validate/configuration/experimental-variables.yml

@@ -5,7 +5,9 @@
     that:
       - k3s_use_experimental is defined and k3s_use_experimental
     success_msg: "Experimental variables are defined and enabled."
-    fail_msg: "Experimental variable k3s_etcd_datastore has been configured. If you want to use this ensure you set k3s_use_experimental"
+    fail_msg: >-
+      Experimental variable k3s_etcd_datastore has been configured.
+      If you want to use this ensure you set k3s_use_experimental,
   when: k3s_etcd_datastore is defined and k3s_etcd_datastore
         and (k3s_release_version | replace('v', '')) is version_compare("1.19.5", '<')
 
@@ -14,7 +16,12 @@
     that:
       - k3s_use_experimental is defined and k3s_use_experimental
     success_msg: "Experimental variables are defined and enabled."
-    fail_msg: "Experimental variable {{ item.setting }} has been configured. If you want to use this ensure you set k3s_use_experimental"
+    fail_msg: >-
+      Experimental variable {{ item.setting }} has been configured.
+      If you want to use this ensure you set k3s_use_experimental.
+      {% if item.document is defined %}
+      Documentation: {{ item.documentation }}
+      {% endif %}
   loop: "{{ k3s_experimental_config }}"
   when: (item.setting in k3s_runtime_config and k3s_runtime_config[item.setting])
         and ((item.until is not defined) or

tasks/validate/configuration/variables.yml

@@ -12,7 +12,12 @@
     that:
       - (item.setting not in k3s_runtime_config)
     success_msg: "{{ item.setting }} not found in server/agent config"
-    fail_msg: "{{ item.setting }} found in server/agent config. Please set {{ item.correction }} to use this option."
+    fail_msg: >-
+      {{ item.setting }} found in server/agent config.
+      Please set {{ item.correction }} to use this option.
+      {% if item.document is defined %}
+      Documentation: {{ item.documentation }}
+      {% endif %}
   loop: "{{ k3s_config_exclude }}"
 
 - name: Check configuration in k3s_server and k3s_agent for deprecated configuration
@@ -20,7 +25,12 @@
     that:
       - (item.setting not in k3s_runtime_config)
     success_msg: "{{ item.setting }} not found in server/agent config"
-    fail_msg: "{{ item.setting }} found in server/agent config. Please set {{ item.correction }} to use this option."
+    fail_msg: >-
+      {{ item.setting }} found in server/agent config.
+      Please set {{ item.correction }} to use this option.
+      {% if item.document is defined %}
+      Documentation: {{ item.documentation }}
+      {% endif %}
   loop: "{{ k3s_deprecated_config }}"
   when: (item.when is not defined
         or (item.when is defined and (k3s_release_version | replace('v', '')) is version_compare(item.when, '>=')))
@@ -31,7 +41,12 @@
     that:
       - (k3s_release_version | replace('v', '')) is version_compare(item.version, '>=')
     success_msg: "{{ item.setting }} is supported by {{ k3s_release_version }}"
-    fail_msg: "{{ item.setting }} is not supported in {{ k3s_release_version }}. Please update to v{{ item.version }} to use this option."
+    fail_msg: >-
+      {{ item.setting }} is not supported in {{ k3s_release_version }}.
+      Please update to v{{ item.version }} to use this option.
+      {% if item.document is defined %}
+      Documentation: {{ item.documentation }}
+      {% endif %}
   loop: "{{ k3s_config_version_check }}"
   when: k3s_config_version_check is defined
         and item.setting in k3s_runtime_config

tasks/validate/environment/remote/packages.yml

@@ -10,8 +10,12 @@
   ansible.builtin.assert:
     that:
       - check_k3s_required_package.rc == 0
-    success_msg: "Found required package: {{ package.name }}"
-    fail_msg: "Could not find package: {{ package.name }}"
+    success_msg: "Found required package: {{ package.name }}."
+    fail_msg: >-
+      Could not find package: {{ package.name }}.
+      {% if package.documentation is defined %}
+      Documentation: {{ package.documentation }}
+      {% endif %}
   when: (package.until is not defined
           or k3s_release_version is version_compare(package.until, '>='))
         and (package.from is not defined