adding pause loop feature (redhat-cop#844)

* new file:   changelogs/fragments/pause_loop.yml
	modified:   roles/applications/README.md
	modified:   roles/applications/defaults/main.yml
	modified:   roles/applications/tasks/main.yml
	modified:   roles/bulk_host_create/README.md
	modified:   roles/bulk_host_create/defaults/main.yml
	modified:   roles/bulk_host_create/tasks/main.yml
	modified:   roles/bulk_job_launch/README.md
	modified:   roles/bulk_job_launch/defaults/main.yml
	modified:   roles/bulk_job_launch/tasks/main.yml
	modified:   roles/credential_input_sources/README.md
	modified:   roles/credential_input_sources/defaults/main.yml
	modified:   roles/credential_input_sources/tasks/main.yml
	modified:   roles/credential_types/README.md
	modified:   roles/credential_types/defaults/main.yml
	modified:   roles/credential_types/tasks/main.yml
	modified:   roles/credentials/README.md
	modified:   roles/credentials/defaults/main.yml
	modified:   roles/credentials/tasks/main.yml
	modified:   roles/execution_environments/README.md
	modified:   roles/execution_environments/defaults/main.yml
	modified:   roles/execution_environments/tasks/main.yml
	modified:   roles/groups/README.md
	modified:   roles/groups/defaults/main.yml
	modified:   roles/groups/tasks/main.yml
	modified:   roles/hosts/README.md
	modified:   roles/hosts/defaults/main.yml
	modified:   roles/hosts/tasks/main.yml
	modified:   roles/instance_groups/README.md
	modified:   roles/instance_groups/defaults/main.yml
	modified:   roles/instance_groups/tasks/main.yml
	modified:   roles/instances/README.md
	modified:   roles/instances/defaults/main.yml
	modified:   roles/instances/tasks/main.yml
	modified:   roles/inventories/README.md
	modified:   roles/inventories/defaults/main.yml
	modified:   roles/inventories/tasks/main.yml
	modified:   roles/inventory_source_update/README.md
	modified:   roles/inventory_source_update/defaults/main.yml
	modified:   roles/inventory_source_update/tasks/main.yml
	modified:   roles/inventory_sources/README.md
	modified:   roles/inventory_sources/defaults/main.yml
	modified:   roles/inventory_sources/tasks/main.yml
	modified:   roles/job_templates/README.md
	modified:   roles/job_templates/defaults/main.yml
	modified:   roles/job_templates/tasks/main.yml
	modified:   roles/labels/README.md
	modified:   roles/labels/defaults/main.yml
	modified:   roles/labels/tasks/main.yml
	modified:   roles/notification_templates/README.md
	modified:   roles/notification_templates/defaults/main.yml
	modified:   roles/notification_templates/tasks/main.yml
	modified:   roles/organizations/README.md
	modified:   roles/organizations/defaults/main.yml
	modified:   roles/organizations/tasks/main.yml
	modified:   roles/project_update/README.md
	modified:   roles/project_update/defaults/main.yml
	modified:   roles/project_update/tasks/main.yml
	modified:   roles/projects/README.md
	modified:   roles/projects/defaults/main.yml
	modified:   roles/projects/tasks/main.yml
	modified:   roles/roles/README.md
	modified:   roles/roles/defaults/main.yml
	modified:   roles/roles/tasks/main.yml
	modified:   roles/schedules/README.md
	modified:   roles/schedules/defaults/main.yml
	modified:   roles/schedules/tasks/main.yml
	modified:   roles/settings/README.md
	modified:   roles/settings/defaults/main.yml
	modified:   roles/settings/tasks/main.yml
	modified:   roles/teams/README.md
	modified:   roles/teams/defaults/main.yml
	modified:   roles/teams/tasks/main.yml
	modified:   roles/users/README.md
	modified:   roles/users/defaults/main.yml
	modified:   roles/users/tasks/main.yml
	modified:   roles/workflow_job_templates/README.md
	modified:   roles/workflow_job_templates/defaults/main.yml
	modified:   roles/workflow_job_templates/tasks/add_workflows_schema.yml
	modified:   tests/templated_role_example/README.md

* modified:   roles/projects/README.md

changelogs/fragments/pause_loop.yml

@@ -0,0 +1,4 @@
+---
+minor_changes:
+  - Added `controller_configuration_loop_delay` and role specific var to give users the option to add a pause during the async loop to slow it down a bit when they are seeing controller API overloaded.
+...

roles/applications/README.md

@@ -66,6 +66,8 @@ This also speeds up the overall role.
 |`controller_configuration_applications_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_applications_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_applications_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ## Data Structure

roles/applications/defaults/main.yml

@@ -4,6 +4,7 @@ controller_applications: []
 controller_configuration_applications_secure_logging: "{{ controller_configuration_secure_logging | default('false') }}"
 controller_configuration_applications_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_applications_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_applications_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 controller_configuration_async_dir: null
 controller_configuration_applications_enforce_defaults: "{{ controller_configuration_enforce_defaults | default(false) }}"
 ...

roles/applications/tasks/main.yml

@@ -24,6 +24,7 @@
   loop_control:
     loop_var: "__application_item"
     label: "{{ __operation.verb }} Controller Application {{ __application_item.name }}"
+    pause: "{{ controller_configuration_applications_loop_delay }}"
   no_log: "{{ controller_configuration_applications_secure_logging }}"
   async: "{{ ansible_check_mode | ternary(0, 1000) }}"
   poll: 0

roles/bulk_host_create/README.md

@@ -49,6 +49,8 @@ This also speeds up the overall role.
 |`controller_configuration_bulk_hosts_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_bulk_hosts_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_bulk_hosts_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ## Data Structure

roles/bulk_host_create/defaults/main.yml

@@ -2,5 +2,6 @@
 controller_configuration_bulk_hosts_secure_logging: "{{ controller_configuration_secure_logging | default('false') }}"
 controller_configuration_bulk_hosts_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_bulk_hosts_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_bulk_hosts_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 controller_configuration_async_dir: null
 ...

roles/bulk_host_create/tasks/main.yml

@@ -16,6 +16,7 @@
   loop: "{{ controller_bulk_hosts }}"
   loop_control:
     loop_var: __controller_bulk_hosts_item
+    pause: "{{ controller_configuration_bulk_hosts_loop_delay }}"
   no_log: "{{ controller_configuration_bulk_hosts_secure_logging }}"
   async: "{{ ansible_check_mode | ternary(0, 1000) }}"
   poll: 0

roles/bulk_job_launch/README.md

@@ -50,6 +50,8 @@ This also speeds up the overall role.
 |`controller_configuration_bulk_job_launch_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_bulk_job_launch_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_bulk_job_launch_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 
 ## Data Structure
 

roles/bulk_job_launch/defaults/main.yml

@@ -2,4 +2,5 @@
 controller_configuration_bulk_job_launch_secure_logging: "{{ controller_configuration_secure_logging | default('false') }}"
 controller_configuration_bulk_job_launch_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_bulk_job_launch_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_bulk_job_launch_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 ...

roles/bulk_job_launch/tasks/main.yml

@@ -27,6 +27,7 @@
   loop_control:
     loop_var: "__bulk_job_launch_item"
     label: "{{ (__bulk_job_launch_item.organization | default('<no_org>')) }}/{{ __bulk_job_launch_item.name }}"
+    pause: "{{ controller_configuration_bulk_job_launch_loop_delay }}"
   no_log: "{{ controller_configuration_bulk_job_launch_secure_logging }}"
   register: bulk_launched_controller_jobs
   when: controller_bulk_launch_jobs is defined

roles/credential_input_sources/README.md

@@ -66,6 +66,8 @@ This also speeds up the overall role.
 |`controller_configuration_credential_input_sources_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_credential_input_sources_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_credential_input_sources_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ## Data Structure

roles/credential_input_sources/defaults/main.yml

@@ -4,6 +4,7 @@ controller_credential_input_sources: []
 controller_configuration_credential_input_sources_secure_logging: "{{ controller_configuration_secure_logging | default('false') }}"
 controller_configuration_credential_input_sources_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_credential_input_sources_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_credential_input_sources_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 controller_configuration_async_dir: null
 controller_configuration_credential_input_sources_enforce_defaults: "{{ controller_configuration_enforce_defaults | default(false) }}"
 ...

roles/credential_input_sources/tasks/main.yml

@@ -20,6 +20,7 @@
   loop_control:
     loop_var: "__cred_input_src_item"
     label: "{{ __operation.verb }} Controller Credential Input Source for Credential {{ __cred_input_src_item.target_credential }}"
+    pause: "{{ controller_configuration_credential_input_sources_loop_delay }}"
   no_log: "{{ controller_configuration_credential_input_sources_secure_logging }}"
   async: "{{ ansible_check_mode | ternary(0, 1000) }}"
   poll: 0

roles/credential_types/README.md

@@ -66,6 +66,8 @@ This also speeds up the overall role.
 |`controller_configuration_credential_types_async_retries`|`controller_configuration_async_retries`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_credential_types_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_credential_types_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ## Data Structure

roles/credential_types/defaults/main.yml

@@ -4,6 +4,7 @@ controller_credential_types: []
 controller_configuration_credential_types_secure_logging: "{{ controller_configuration_secure_logging | default('false') }}"
 controller_configuration_credential_types_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_credential_types_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_credential_types_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 controller_configuration_async_dir: null
 controller_configuration_credential_types_enforce_defaults: "{{ controller_configuration_enforce_defaults | default(false) }}"
 ...

roles/credential_types/tasks/main.yml

@@ -21,6 +21,7 @@
   loop_control:
     loop_var: __controller_credential_type_item
     label: "{{ __operation.verb }} Credential Type {{ __controller_credential_type_item.name }}"
+    pause: "{{ controller_configuration_credential_types_loop_delay }}"
   no_log: "{{ controller_configuration_credential_types_secure_logging }}"
   async: "{{ ansible_check_mode | ternary(0, 1000) }}"
   poll: 0

roles/credentials/README.md

@@ -66,6 +66,8 @@ This also speeds up the overall role.
 |`controller_configuration_credentials_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_credentials_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_credentials_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ## Data Structure

roles/credentials/defaults/main.yml

@@ -4,6 +4,7 @@ controller_credentials: []
 controller_configuration_credentials_secure_logging: "{{ controller_configuration_secure_logging | default(true) }}"
 controller_configuration_credentials_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_credentials_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_credentials_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 controller_configuration_async_dir: null
 controller_configuration_credentials_enforce_defaults: "{{ controller_configuration_enforce_defaults | default(false) }}"
 ...

roles/credentials/tasks/main.yml

@@ -24,6 +24,7 @@
   loop_control:
     loop_var: __controller_credentials_item
     label: "{{ __operation.verb }} Credential {{ __controller_credentials_item.name }}"
+    pause: "{{ controller_configuration_credentials_loop_delay }}"
   no_log: "{{ controller_configuration_credentials_secure_logging }}"
   async: "{{ ansible_check_mode | ternary(0, 1000) }}"
   poll: 0

roles/execution_environments/README.md

@@ -66,6 +66,8 @@ This also speeds up the overall role.
 |`controller_configuration_execution_environments_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_execution_environments_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_execution_environments_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ## Data Structure

roles/execution_environments/defaults/main.yml

@@ -3,6 +3,7 @@
 controller_configuration_execution_environments_secure_logging: "{{ controller_configuration_secure_logging | default('false') }}"
 controller_configuration_execution_environments_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_execution_environments_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_execution_environments_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 controller_configuration_async_dir: null
 controller_configuration_execution_environments_enforce_defaults: "{{ controller_configuration_enforce_defaults | default(false) }}"
 ...

roles/execution_environments/tasks/main.yml

@@ -23,6 +23,7 @@
   loop_control:
     loop_var: "__execution_environments_item"
     label: "{{ __operation.verb }} Controller Execution Environment {{ __execution_environments_item }}"
+    pause: "{{ controller_configuration_execution_environments_loop_delay }}"
   no_log: "{{ controller_configuration_execution_environments_secure_logging }}"
   when: controller_execution_environments is defined
   async: "{{ ansible_check_mode | ternary(0, 1000) }}"

roles/groups/README.md

@@ -66,6 +66,8 @@ This also speeds up the overall role.
 |`controller_configuration_groups_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_groups_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_group_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ### Formating Variables

roles/groups/defaults/main.yml

@@ -4,6 +4,7 @@ controller_groups: []
 controller_configuration_group_secure_logging: "{{ controller_configuration_secure_logging | default('false') }}"
 controller_configuration_group_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_group_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_group_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 controller_configuration_async_dir: null
 controller_configuration_groups_enforce_defaults: "{{ controller_configuration_enforce_defaults | default(false) }}"
 ...

roles/groups/tasks/main.yml

@@ -26,6 +26,7 @@
   loop_control:
     loop_var: __controller_groups_item
     label: "{{ __operation.verb }} Controller Group {{ __controller_groups_item.name }}"
+    pause: "{{ controller_configuration_group_loop_delay }}"
   no_log: "{{ controller_configuration_group_secure_logging }}"
   async: "{{ ansible_check_mode | ternary(0, 1000) }}"
   poll: 0

roles/hosts/README.md

@@ -66,6 +66,8 @@ This also speeds up the overall role.
 |`controller_configuration_host_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_host_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_hosts_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ### Formating Variables

roles/hosts/defaults/main.yml

@@ -4,6 +4,7 @@ controller_hosts: []
 controller_configuration_hosts_secure_logging: "{{ controller_configuration_secure_logging | default('false') }}"
 controller_configuration_hosts_async_retries: "{{ controller_configuration_async_retries | default(30) }}"
 controller_configuration_hosts_async_delay: "{{ controller_configuration_async_delay | default(1) }}"
+controller_configuration_hosts_loop_delay: "{{ controller_configuration_loop_delay | default(0) }}"
 controller_configuration_async_dir: null
 controller_configuration_host_enforce_defaults: "{{ controller_configuration_enforce_defaults | default(false) }}"
 ...

roles/hosts/tasks/main.yml

@@ -21,6 +21,7 @@
   loop_control:
     loop_var: __controller_host_item
     label: "{{ __operation.verb }} Controller host {{ __controller_host_item.name }}"
+    pause: "{{ controller_configuration_hosts_loop_delay }}"
   no_log: "{{ controller_configuration_hosts_secure_logging }}"
   async: "{{ ansible_check_mode | ternary(0, 1000) }}"
   poll: 0

roles/instance_groups/README.md

@@ -66,6 +66,8 @@ This also speeds up the overall role.
 |`controller_configuration_instance_groups_async_retries`|`{{ controller_configuration_async_retries }}`|no|This variable sets the number of retries to attempt for the role.|
 |`controller_configuration_async_delay`|1|no|This sets the delay between retries for the role globally.|
 |`controller_configuration_instance_groups_async_delay`|`controller_configuration_async_delay`|no|This sets the delay between retries for the role.|
+|`controller_configuration_loop_delay`|0|no|This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.|
+|`controller_configuration_instance_groups_loop_delay`|`controller_configuration_loop_delay`|no|This sets the pause between each item in the loop for the role. To help when API is getting overloaded.|
 |`controller_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.|
 
 ## Data Structure