feat: add resource limits for ansible (#5274)

* feat: add resource limits for ansible

Signed-off-by: Camila Macedo <[email protected]>

* nit suggestion abut changelog info

Author: camilamacedo86

changelog/fragments/ansible-limits.yaml

@@ -0,0 +1,51 @@
+# entries is a list of entries to include in
+# release notes and/or the migration guide
+entries:
+  - description: >
+      For Ansible-based operators, add default resource limits for the manager.
+
+    # kind is one of:
+    # - addition
+    # - change
+    # - deprecation
+    # - removal
+    # - bugfix
+    kind: "addition"
+
+    # Is this a breaking change?
+    breaking: false
+
+    # NOTE: ONLY USE `pull_request_override` WHEN ADDING THIS
+    # FILE FOR A PREVIOUSLY MERGED PULL_REQUEST!
+    #
+    # The generator auto-detects the PR number from the commit
+    # message in which this file was originally added.
+    #
+    # What is the pull request number (without the "#")?
+    # pull_request_override: 0
+
+
+    # Migration can be defined to automatically add a section to
+    # the migration guide. This is required for breaking changes.
+    migration:
+      header: Header text for the migration section
+      body: >
+        Add into the config/manager/manager.yaml` the following limits scaffold by default:
+
+        ```yaml
+        ...
+        # TODO(user): Configure the resources accordingly based on the project requirements.
+        # More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+        resources:
+          limits:
+            cpu: 500m
+            memory: 768Mi
+          requests:
+            cpu: 10m
+            memory: 256Mi
+        ...
+        ```
+
+        **IMPORTANT:** Having resource limits is a best-practice and these values are reasonable
+        defaults, but Operator authors should optimize these values based on their project's
+        requirements.

hack/generate/samples/internal/ansible/testdata/tasks/reconciliationtest_test.yml

@@ -18,7 +18,7 @@
   register: reconciliation_test
 - name: Retreive the number of iterations on the ConfigMap
   debug: var=cm.data.iterations
-  retries: 10
+  retries: 20
   delay: 2
   until: "cm.data.iterations|int == 5"
   vars:

hack/generate/samples/internal/ansible/testdata/tasks/secretstest_test.yml

@@ -21,7 +21,7 @@
     namespace: '{{ namespace }}'
   register: result
   until: result.resources
-  retries: 10
+  retries: 20
 
 - name: Assert that the configmap has the proper content
   assert:
@@ -49,7 +49,7 @@
     namespace: '{{ namespace }}'
   register: result
   until: result.resources.0.data.new is defined
-  retries: 10
+  retries: 20
 
 - name: Assert that the configmap has the proper content
   assert:

internal/plugins/ansible/v1/init.go

@@ -172,8 +172,7 @@ func addInitCustomizations(projectName string) error {
 		return err
 	}
 
-	// remove the resources limits
-	// todo: remove it when we solve the issue operator-framework/operator-sdk#3573
+	// update default resource request and limits with bigger values
 	const resourcesLimitsFragment = `  resources:
           limits:
             cpu: 500m
@@ -182,7 +181,17 @@ func addInitCustomizations(projectName string) error {
             cpu: 10m
             memory: 64Mi
       `
-	err = util.ReplaceInFile(managerFile, resourcesLimitsFragment, "")
+
+	const resourcesLimitsAnsibleFragment = `  resources:
+          limits:
+            cpu: 500m
+            memory: 768Mi
+          requests:
+            cpu: 10m
+            memory: 256Mi
+      `
+
+	err = util.ReplaceInFile(managerFile, resourcesLimitsFragment, resourcesLimitsAnsibleFragment)
 	if err != nil {
 		return err
 	}

testdata/ansible/memcached-operator/bundle/manifests/memcached-operator.clusterserviceversion.yaml

@@ -141,7 +141,13 @@ spec:
                     port: 6789
                   initialDelaySeconds: 5
                   periodSeconds: 10
-                resources: {}
+                resources:
+                  limits:
+                    cpu: 500m
+                    memory: 768Mi
+                  requests:
+                    cpu: 10m
+                    memory: 256Mi
                 securityContext:
                   allowPrivilegeEscalation: false
               securityContext:

testdata/ansible/memcached-operator/config/manager/manager.yaml

@@ -51,5 +51,12 @@ spec:
           periodSeconds: 10
         # TODO(user): Configure the resources accordingly based on the project requirements.
         # More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+        resources:
+          limits:
+            cpu: 500m
+            memory: 768Mi
+          requests:
+            cpu: 10m
+            memory: 256Mi
       serviceAccountName: controller-manager
       terminationGracePeriodSeconds: 10