Merge pull request #10377 from kdelee/control_plane_ee

Break out control plane EE as its own thing

awx/main/management/commands/register_default_execution_environments.py

@@ -15,7 +15,7 @@ class Command(BaseCommand):
     help = """
     Creates or updates the execution environments set in settings.DEFAULT_EXECUTION_ENVIRONMENTS if they are not yet created.
     Optionally provide authentication details to create or update a container registry credential that will be set on all of these default execution environments.
-    Note that settings.DEFAULT_EXECUTION_ENVIRONMENTS is and ordered list, the first in the list will be used for project updates and system jobs.
+    Note that settings.DEFAULT_EXECUTION_ENVIRONMENTS is and ordered list, the first in the list will be used for project updates.
     """
 
     # Preserves newlines in the help text
@@ -68,35 +68,66 @@ class Command(BaseCommand):
                 sys.stderr.write("No registry credential type found")
                 sys.exit(1)
 
-            registry_cred, created = Credential.objects.get_or_create(
-                name="Default Execution Environment Registry Credential", managed_by_tower=True, credential_type=registry_cred_type[0]
-            )
-
-            if created:
-                print("Default Execution Environment Credential registered.")
-
             inputs = {
                 "host": options.get("registry_url"),
                 "password": options.get("registry_password"),
                 "username": options.get("registry_username"),
                 "verify_ssl": options.get("verify_ssl"),
             }
-
+            registry_cred, cred_created = Credential.objects.get_or_create(
-            registry_cred.inputs = inputs
+                name="Default Execution Environment Registry Credential",
-            registry_cred.save()
+                managed_by_tower=True,
-            changed = True
+                credential_type=registry_cred_type[0],
-
+                defaults={'inputs': inputs},
-            if not created:
-                print('Updated Default Execution Environment Credential')
-
-        for ee in reversed(settings.DEFAULT_EXECUTION_ENVIRONMENTS):
-            _, created = ExecutionEnvironment.objects.update_or_create(
-                name=ee["name"], defaults={"image": ee["image"], "managed_by_tower": True, "credential": registry_cred}
             )
 
-        if created:
+            if cred_created:
+                changed = True
+                print("'Default Execution Environment Credential' registered.")
+
+            for key, value in inputs.items():
+                if not registry_cred.inputs.get(key) or registry_cred.get_input(key) != value:
+                    registry_cred.inputs[key] = value
+                    changed = True
+
+            if changed:
+                registry_cred.save()
+                print("'Default Execution Environment Credential' updated.")
+
+        # Create default globally available Execution Environments
+        for ee in reversed(settings.GLOBAL_JOB_EXECUTION_ENVIRONMENTS):
+            _this_ee, ee_created = ExecutionEnvironment.objects.get_or_create(name=ee["name"], defaults={'image': ee["image"], 'credential': registry_cred})
+            if ee_created:
+                changed = True
+                print(f"'{ee['name']}' Default Execution Environment registered.")
+            else:
+                if _this_ee.image != ee["image"]:
+                    _this_ee.image = ee["image"]
+                    changed = True
+                if _this_ee.credential != registry_cred:
+                    _this_ee.credential = registry_cred
+                    changed = True
+            if changed:
+                _this_ee.save()
+                print(f"'{ee['name']}' Default Execution Environment updated.")
+
+        # Create the control plane execution environment that is used for project updates and system jobs
+        ee = settings.CONTROL_PLANE_EXECUTION_ENVIRONMENT
+        _this_ee, cp_created = ExecutionEnvironment.objects.get_or_create(
+            name="Control Plane Execution Environment", defaults={'image': ee, 'managed_by_tower': True, 'credential': registry_cred}
+        )
+        if cp_created:
             changed = True
-            print("Default Execution Environment(s) registered.")
+            print("Control Plane Execution Environment registered.")
+        else:
+            if _this_ee.image != ee:
+                _this_ee.image = ee
+                changed = True
+            if _this_ee.credential != registry_cred:
+                _this_ee.credential = registry_cred
+                changed = True
+        if changed:
+            _this_ee.save()
 
         if changed:
             print("(changed: True)")

awx/settings/defaults.py

@@ -180,7 +180,15 @@ DEFAULT_EXECUTION_ENVIRONMENT = None
 
 # This list is used for creating default EEs when running awx-manage create_preload_data.
 # Should be ordered from highest to lowest precedence.
-DEFAULT_EXECUTION_ENVIRONMENTS = [{'name': 'AWX EE 0.2.0', 'image': 'quay.io/ansible/awx-ee:0.2.0'}]
+# The awx-manage register_default_execution_environments command reads this setting and registers the EE(s)
+# If a registry credential is needed to pull the image, that can be provided to the awx-manage command
+GLOBAL_JOB_EXECUTION_ENVIRONMENTS = [{'name': 'AWX EE 0.3.0', 'image': 'quay.io/ansible/awx-ee:0.3.0'}]
+# This setting controls which EE will be used for project updates.
+# The awx-manage register_default_execution_environments command reads this setting and registers the EE
+# This image is distinguished from others by having "managed_by_tower" set to True and users have limited
+# ability to modify it through the API.
+# If a registry credential is needed to pull the image, that can be provided to the awx-manage command
+CONTROL_PLANE_EXECUTION_ENVIRONMENT = 'quay.io/ansible/awx-ee:0.3.0'
 
 # Note: This setting may be overridden by database settings.
 STDOUT_MAX_BYTES_DISPLAY = 1048576