verify undefined values for plugin.install

kubemarine/core/defaults.py

@@ -38,6 +38,7 @@
     "kubemarine.packages.enrich_inventory_associations",
     "kubemarine.system.enrich_upgrade_inventory",
     "kubemarine.core.defaults.compile_inventory",
+    "kubemarine.core.defaults.manage_true_false_values",
     "kubemarine.admission.manage_enrichment",
     "kubemarine.thirdparties.enrich_inventory_apply_upgrade_defaults",
     "kubemarine.procedures.migrate_cri.enrich_inventory",
@@ -545,3 +546,15 @@ def prepare_for_dump(inventory, copy=True):
 
     return dump_inventory
 
+
+def manage_true_false_values(inventory, cluster):
+    # Check undefined values for plugin.name.install and convert it to bool
+    for plugin_name, plugin_item in inventory["plugins"].items():
+        # Check install value
+        if 'install' not in plugin_item:
+            continue
+        value = utils.true_or_false(plugin_item.get('install', False))
+        if value == 'undefined':
+            raise ValueError(f"Found unsupported value for plugin.{plugin_name}.install: {plugin_item['install']}")
+        plugin_item['install'] = value == 'true'
+    return inventory

kubemarine/core/utils.py

@@ -116,7 +116,7 @@ def make_ansible_inventory(location, cluster):
         if inventory.get(group) is not None:
             for service_name, service_configs in inventory[group].items():
                 # write to inventory only plugins, which will be installed
-                if group != 'plugins' or true_or_false(service_configs.get('install', False)) == 'true':
+                if group != 'plugins' or service_configs.get('install', False):
 
                     config['cluster:vars'].append('\n# %s.%s' % (group, service_name))
 

kubemarine/plugins/__init__.py

@@ -135,8 +135,7 @@ def install(cluster, plugins=None):
     plugins_queue = []
     max_priority = 0
     for plugin_name, plugin_item in plugins.items():
-        if utils.true_or_false(plugin_item.get("install", False)) == 'true' and \
-                plugin_item.get("installation", {}).get('procedures') is not None:
+        if plugin_item.get("install", False) and plugin_item.get("installation", {}).get('procedures') is not None:
             plugin_item['plugin_name'] = plugin_name
             plugins_queue.append(plugin_item)
             if plugin_item.get("installation", {}).get('priority') is not None \

kubemarine/plugins/calico.py

@@ -29,14 +29,14 @@ def enrich_inventory(inventory, cluster):
     # By default installation parameter is unset, means user did not made any decision
     if inventory["plugins"]["calico"].get("install") is None:
         # Is user defined Flannel plugin and set it to install?
-        flannel_required = utils.true_or_false(inventory["plugins"].get("flannel", {}).get("install", False)) == 'true'
+        flannel_required = inventory["plugins"].get("flannel", {}).get("install", False)
         # Is user defined Canal plugin and set it to install?
-        canal_required = utils.true_or_false(inventory["plugins"].get("canal", {}).get("install", False)) == 'true'
+        canal_required = inventory["plugins"].get("canal", {}).get("install", False)
         # If Flannel and Canal is unset or not required to install, then install Calico
         if not flannel_required and not canal_required:
             inventory["plugins"]["calico"]["install"] = True
 
-    if utils.true_or_false(inventory["plugins"]["calico"]["install"]) == 'true':
+    if inventory["plugins"]["calico"]["install"]:
         # Check if original YAML and final YAML have different paths (applicable for non Jinja2 template)
         items = inventory['plugins']['calico']['installation']['procedures']
         for item in items:

kubemarine/plugins/nginx_ingress.py

@@ -19,7 +19,7 @@
 
 
 def verify_inventory(inventory, _):
-    if utils.true_or_false(inventory["plugins"]["nginx-ingress-controller"]["install"]) != "true":
+    if not inventory["plugins"]["nginx-ingress-controller"]["install"]:
         return inventory
 
     nginx_plugin = inventory["plugins"]["nginx-ingress-controller"]
@@ -43,7 +43,7 @@ def verify_inventory(inventory, _):
 
 
 def enrich_inventory(inventory, _):
-    if utils.true_or_false(inventory["plugins"]["nginx-ingress-controller"]["install"]) != "true":
+    if not inventory["plugins"]["nginx-ingress-controller"]["install"]:
         return inventory
 
     if inventory["plugins"]["nginx-ingress-controller"].get('custom_headers'):
@@ -63,7 +63,7 @@ def cert_renew_enrichment(inventory, cluster):
     nginx_plugin = inventory["plugins"]["nginx-ingress-controller"]
 
     # check that renewal is possible
-    if utils.true_or_false(nginx_plugin["install"]) != 'true':
+    if not nginx_plugin["install"]:
         raise Exception("Certificates can not be renewed for nginx plugin since it is not installed")
 
     # update certificates in inventory, other check will be performed in "verify_inventory" function

kubemarine/procedures/check_paas.py

@@ -557,7 +557,7 @@ def kubernetes_dashboard_status(cluster):
         i = 0
         while not test_succeeded and i < retries:
             i += 1
-            if utils.true_or_false(cluster.inventory['plugins']['kubernetes-dashboard']['install']) == 'true':
+            if cluster.inventory['plugins']['kubernetes-dashboard']['install']:
                 results = cluster.nodes['control-plane'].get_first_member().sudo("kubectl get svc -n kubernetes-dashboard kubernetes-dashboard -o=jsonpath=\"{['spec.clusterIP']}\"", warn=True)
                 for control_plane, result in results.items():
                     if result.failed:
@@ -982,8 +982,7 @@ def default_services_configuration_status(cluster):
                     for service in services:
                         for service_name, properties in service.items():
                             if service_name == "ingress-nginx-controller":
-                                if utils.true_or_false(
-                                        cluster.inventory['plugins']['nginx-ingress-controller']['install']) != 'true':
+                                if not cluster.inventory['plugins']['nginx-ingress-controller']['install']:
                                     break
                             content = first_control_plane.sudo(f"kubectl get {type} {service_name} -n {namespace} -oyaml").get_simple_out()
                             content = yaml.safe_load(content)
@@ -1020,8 +1019,7 @@ def default_services_health_status(cluster):
                     if type == 'DaemonSet':
                         for service in services:
                             if service == "ingress-nginx-controller":
-                                if utils.true_or_false(
-                                        cluster.inventory['plugins']['nginx-ingress-controller']['install']) != 'true':
+                                if not cluster.inventory['plugins']['nginx-ingress-controller']['install']:
                                     break
                             daemon_set = DaemonSet(cluster, name=service, namespace=namespace)
                             ready = daemon_set.reload(control_plane=first_control_plane, suppress_exceptions=True).is_actual_and_ready()