[Podification] Removal of the MiqVimBrokerWorker

[agrare]

After investigating strategies for using the VimBroker in a containerized environment (#469) we decided that the last option should be pursued.

This involves complete removal of the MiqVimBrokerWorker due to DRb being fundamental to the functioning of the broker and DRb being completely unusable in a containerized environment for use across pods.

The broker is currently used for a number of different services on MIQ

1. Inventory Refresh (cache)
2. Provider Operations (connection brokering + cache)
3. Smartstate (connection brokering + cache)
4. Metrics Capture (connection brokering + cache)

For inventory refresh we have the streaming refresh option which will have to be made the only option.
Provider operations can be handled by a new OperationsWorker (ManageIQ/manageiq#19476, #468) can keep a local connection and inventory cache which can be used within the process rather than going out over DRb
Smartstate is essentially just another type of provider operation and can be processed by the OperationsWorker
Metrics capture is also another provider operation, it could either be handled by the operations worker or we could have another cached session in the MetricsCaptureWorker.

Getting the operations worker to work is where most of the time will be spent. Currently all ems_operations queue roles are handled by the generic/priority workers. We will need to add a queue_name to all of these to allow provider workers to optionally handle the this type of work (initial effort ManageIQ/manageiq#19479)

ManageIQ/manageiq#19543

[djberg96]

Mainly for my own sake, a current list of all files where I see an ems_operations role in core:

• app/models/mixins/verify_credentials_mixin.rb (already set to generic)
• app/models/mixins/authentication_mixin.rb (Add queue name to Authentication#change_password_queue manageiq#19595)
• app/models/miq_generic_worker/runner.rb (N/A)
• app/models/cloud_volume.rb (Add queue_name to queued method options for CloudVolume model  manageiq#19570)
• app/models/conversion_host/configurations.rb (Add queue_name to the ConversionHost.queue_configuration singleton method manageiq#19634)
• app/models/infra_conversion_job.rb (N/A)
• app/models/orchestration_stack.rb (Remove OrchestrationStack#update_stack_queue manageiq#19578)
• app/models/cloud_volume_backup.rb (Add queue_name to CloudVolumeBack ems operations, plus specs manageiq#19579)
• app/models/flavor.rb (Add queue_name to queued method options for Flavor model manageiq#19568)
• app/models/cloud_volume_snapshot.rb (Add a queue_name to the CloudVolumeSnapshot#delete_snapshot_queue method manageiq#19601)
• app/models/cloud_object_store_container.rb (Add queue_name to queued method options for CloudObjectStoreContainer model manageiq#19603)
• app/models/cloud_tenant.rb (Add queue_name to queued method options for CloudTenant model manageiq#19602)
• app/models/vm_or_template/operations/relocation.rb (Add queue_name to relocation_queue method manageiq#19614)
• app/models/vm_or_template/operations/snapshot.rb (Add queue_name to VmOrTemplate::Operations::Snapshot queue methods manageiq#19616)
• app/models/cloud_volume/operations.rb (Add queue_name to ems operations within CloudVolume::Operations mixin manageiq#19608)
• app/models/iso_datastore.rb (Add a queue_name to the IsoDatastore#synchronize_advertised_images_queue method manageiq#19604)
• app/models/vm_or_template.rb (looks done)
• app/models/manageiq/providers/base_manager/operations_worker.rb (N/A)
• app/models/manageiq/providers/cloud_manager/auth_key_pair.rb (Add queue_name to ems operations for ManageIQ::Providers::CloudManager::AuthKeyPair manageiq#19651)
• app/models/manageiq/providers/cloud_manager/template.rb (Add queue name for cloud template ems operations manageiq#19620)
• app/models/manageiq/providers/cloud_manager/vm.rb (Add queue name to ManageIQ::Providers::CloudManager::Vm queue methods manageiq#19625)
• app/models/manageiq/providers/cloud_manager/orchestration_template_runner.rb (OrchestrationTemplateRunner#queue_signal queue name manageiq#19635)
• app/models/manageiq/providers/ansible_runner_workflow.rb (N/A)
• app/models/manageiq/providers/ems_refresh_workflow.rb (N/A)

Will cross these off as they're done (or if they're already done).

ems_operations appears, but not specifically in the context of a role:

• app/models/miq_policy.rb (N/A)
• app/models/miq_action.rb (Modify MiqAction so that queue_name is set for ems operations manageiq#19652)
• app/models/ext_management_system.rb (N/A, only queued method is not an ems operation)
• app/models/storage.rb (Effectively handled by Add default queue_name for ems_operations in MiqQueue#submit_job manageiq#19637 in one place, and in the other it's unused)
• app/models/vm_cloud_reconfigure_request.rb (N/A, just setting my_role)
• app/models/vm_migrate_request.rb (N/A, ditto)
• app/models/miq_provision_configured_system_request.rb (N/A, ditto)
• app/models/vm_reconfigure_request.rb (N/A, ditto)
• app/models/miq_queue.rb (Add default queue_name for ems_operations in MiqQueue#submit_job manageiq#19637)
• app/models/physical_server_provision_request.rb (N/A, just setting my_role)
• app/models/miq_provision_request.rb (N/A, ditto)
• app/models/service_reconfigure_request.rb (N/A, ditto)
• app/models/service_template_provision_request.rb (N/A, ditto)
• app/models/physical_server_firmware_update_request.rb (N/A, ditto)
• app/models/manageiq/providers/base_manager/operations_worker/runner.rb (N/A, ditto)

[carbonin]

Also, the broker is the last user of the MiqWorker#send_message_to_worker_monitor method, so something like this patch can also go in when the broker is gone 🙏 :

diff --git a/app/models/miq_server/worker_management/heartbeat.rb b/app/models/miq_server/worker_management/heartbeat.rb
index 74a2d0ef63..6a77e217b9 100644
--- a/app/models/miq_server/worker_management/heartbeat.rb
+++ b/app/models/miq_server/worker_management/heartbeat.rb
@@ -41,11 +41,6 @@ module MiqServer::WorkerManagement::Heartbeat
     end unless @workers_lock.nil?
   end
 
-  def message_for_worker(wid, message, *args)
-    w = MiqWorker.find_by(:id => wid)
-    worker_set_message(w, message, *args) unless w.nil?
-  end
-
   def request_workers_to_sync_config(resync_needed = false)
     processed_worker_ids = []
     miq_workers.each do |w|
diff --git a/app/models/miq_worker.rb b/app/models/miq_worker.rb
index 3ea825f03a..f174c1fb54 100644
--- a/app/models/miq_worker.rb
+++ b/app/models/miq_worker.rb
@@ -291,25 +291,6 @@ class MiqWorker < ApplicationRecord
     MiqWorker.log_status(level)
   end
 
-  def self.send_message_to_worker_monitor(wid, message, *args)
-    w = MiqWorker.find_by(:id => wid)
-    raise _("Worker with id=<%{id}> does not exist") % {:id => wid} if w.nil?
-    w.send_message_to_worker_monitor(message, *args)
-  end
-
-  def send_message_to_worker_monitor(message, *args)
-    MiqQueue.put_deprecated(
-      :class_name  => 'MiqServer',
-      :instance_id => miq_server.id,
-      :method_name => 'message_for_worker',
-      :args        => [id, message, *args],
-      :queue_name  => 'miq_server',
-      :zone        => miq_server.zone.name,
-      :server_guid => miq_server.guid
-    )
-  end
-
-
   # Overriding queue_name as now some queue names can be
   # arrays of names for some workers not just a singular name.
   # We use JSON.parse as the array of names is stored as a string.

[djberg96]

Here's everything that has "vim_broker" or "VimBroker" within it yet:

• app/models/miq_generic_worker/runner.rb
• app/models/miq_server/server_smart_proxy.rb
• app/models/miq_worker/runner.rb
• app/models/job_proxy_dispatcher.rb
• app/models/vm_scan.rb
• app/models/miq_worker_type.rb
• app/models/manageiq/providers/base_manager/refresh_worker/runner.rb
• app/models/miq_queue_worker_base/runner.rb
• app/models/vm_or_template/operations/snapshot.rb

[Fryguy]

Closing now, as the rest are pure cleanup, but the "Removal of the Broker" is done at this point.

🎉 🌮 🎉