...

Agents can be clustered for high-availability and scalability. The motivation for clustering includes:

• High-availability: Should a server node in the scheduling environment fail then jobs are executed with the Agents on remaining server nodes.
• PerformanceScalability: A single Agent can execute thousands of jobs in parallel tasks, however, for a number of use cases it is preferable to distribute server load. This applies particularly to applications that require horizontal scaling across a number of server nodes instead of vertical scaling on a more powerful single server node.

Agent clustering is subject to the agreements of the JS7 - License and :

• Use of Standalone Agents:
  • is available to Open Source License holders and to commercial license holders.

...

• • for details see JS7 - Management of Standalone Agents.
• Use of Agent Clusters:
  • is available to commercial license holders,
  • Clustered Agents include
    • Agent Director instances that require license keys to be assigned individually

...

• • • ,

...

• • • see JS7 - How to apply a JS7 License Key.

...

• • • Subagents that receive license information from a Director Agent and do not need a license key to be added.

Development Status:

• Subagent Cluster:, see 

  Jira
  server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1954

  
  

  Display feature availability
  StartingFromRelease 2.2.0

• Director Cluster see 

  Jira
  server SOS JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 6dc67751-9d67-34cd-985b-194a8cdc9602 key JS-1955

  
  

  Display feature availability
  StartingFromRelease 2.36.0

Architecture

The architecture is explained with JS7 - Agent Cluster. For the planning of Agent Clusters see JS7 - Strategies for Agent Clustering.

The architecture includes to consider consideration of different aspects of clustering:

...

• The components involved in an Agent Cluster are represented as one a single Agent to the Controller.
• A Controller can manage any number of Agents from different Agent Clusters or as a number of Standalone Agents.

Functional Layer

The architecture allows to define the definition of any number of of Subagent Clusters that include a Selection and Scheduling Mode of Subagents: 

• Any number of Subagents can be selected to be part of a Subagent Cluster.
• The selection includes to specify specification of the Scheduling Mode being one of Mode as either fixed-priority or round-robin:
  • fixed-priority: execute jobs with the first Subagent and switch to the next Subagent only if the first Subagent becomes unavailable (active-passive cluster).
  • round-robin: execute each next job on the next Subagent (active-active cluster).

...

The JS7 - Agent Installation On Premises and JS7 - Agent Installation for Docker Containers articles explain the installation procedure that is the same for Cluster Agents and for Standalone Agents.

The  icon in the JOC Cockpit main menu offers is used to select the Manage Controllers/Agents view:

...

For Cluster Agents the following excerpt from the above screenshot is used:

• In a first position the The Primary Director Agent is available. Optionally a listed first. An optional Secondary Director Agent can may also be availablelisted.
• Below The list of Subagents is listed below the Director Agent entry the list of Subagents is displayed.
  
  

Add Agent Cluster

The Agent Cluster is situated in the operational layer and includes specification of Director Agents and Subagents.

To add an Agent Cluster users can start from the Controller's action menu to of the Controller which the Agent Cluster should be added to:

This brings forward the following popup window:

Image RemovedImage Added

Explanation:

• The first group of input fields specifies the Agent Cluster:
  • Agent ID: A unique identifier of the Agent Cluster. Uniqueness is required for all Standalone Agents and Agent Clusters assigned the same to a Controller. This identifier cannot be changed later on.
  • Agent Cluster Name: The name of the Agent Cluster as displayed in the JOC Cockpit GUI. The name can be changed at any later point in time.
  • Title: An individual description that can be searched for.
  • Alias NameNames: The same Agent Cluster can appear with a number of alias names. This allows to map use of different Agent Clusters, for example is available from a different name. This can be helpful if distinct Agent Names should be assigned the jobs, for example if more Agents are used in a production environment , to use of fewer Agent Cluster using alias names in a test environment.that map to a smaller number of Agents in a non-production environment.
  • Process Limit: Agents can execute an unlimited number of parallel processes. Users can limit parallel processes to prevent exhausting a server's resources and to make orders wait until the next process will be available.
• The second group of input fields specifies the Primary Director Agent:
  • Subagent ID: A unique identifier of the Subagent. Uniqueness is applied required for all Director Agents and Subagents in the same Agent Cluster. This identifier cannot be changed later on.
  • Title: An individual description that can be searched for.
  • URL: The protocol HTTP or HTTPS, host name or IP address and port by which the Controller can use to access the Director Agent is accessible to the Controller.
• The third group of input fields specifies the Secondary Director Agent should Director Agents be clustered.

...

Anchor
add_subagent add_subagent

Add Subagent

With the Once an Agent Cluster being has been added, users can then add further Subagents from the Agent Cluster's action menu:

...

• Subagent ID: A unique identifier of the Subagent. Uniqueness is applied required for all Director Agents and Subagents in the same Agent Cluster. This identifier cannot be changed later on.
• Title: An individual description that can be searched for.
• URL: The protocol HTTP or HTTPS, host name or IP address and port by which the Subagent is accessible to the Director Agent can use to access a Subagent.

Anchor
enable_disable_subagent enable_disable_subagent

Enable/Disable Subagent Subagent

Subagents can be disabled and enabled. They are enabled by default.

• When a Subagent is disabled then it is no longer considered for job execution.
  • At the point in time of disabling the Subagent will continue to complete any tasks running for jobs.
  • No new tasks are added to a disabled Subagent.
  • The remaining Subagent(s) in the cluster will take on over the load.
• When a disabled Subagent is enabled then it is automatically considered for the next job executions.
• The assignment of Subagent Clusters that include a disabled Subagent to jobs in a workflow remains unchanged.
  • For clusters that include more than one Subagent the remaining Subagents will execute the jobs.
  • For Subagent Clusters that hold a single disabled Subagent any orders will wait for the Subagent to become available and enabled. When the Subagent is up and runningOrders will automatically continue in the workflow, for example after a restart, once the Subagent is up and running and is enabled then orders will automatically continue in the workflow.
• Should a Subagent that acts as a Director Agent be disabled, then this will make the Agent Cluster unavailable independently of whether Subagents in the Cluster are enabled or up and running.
  • The Director Agent orchestrates Subagents and is required for a functional Cluster.
  • The Dashboard view displays Agent Clusters with a disabled Director Agent as being failed.

Disabling of Subagents can be used for example to manage maintenance windows on server nodes.

Anchor
reset_subagent reset_subagent

Reset Subagent

Subagents can be reset in case of problems during initial operation or to re-assign Subagents to a different Subagent Cluster.

• Reset: Any running tasks in a Subagent can continue. The Subagent does not accept new tasks. Once running tasks have been completed the Subagent will restart.
• Reset Forced: Any running tasks in a Subagent are killed. The Subagent does not accept new tasks. The Subagent restarts.
• If the Subagent acts as a Director Agent then the following applies:
  • Dropping the Director Agent's journal means that it looses its memory. This operation can be used to seize an Agent, i.e. to assign it a different Controller.
  • This operation should be used with care, for example, if an Agent that is assigned a Controller in a production environment is taken over by a Controller of a different environment.
  • After restart of a Director Agent that has been reset, the Controller will deploy scheduling objects such as workflows and will submit orders as assigned to the Agent.
• If the Subagent is not acting as a Director Agent then after restart it will be assigned tasks by the Director Agent.

Anchor
delete_subagent delete_subagent

Delete Subagent

Subagents can be deleted only if no jobs are not assigned to the Subagent Cluster in question.

• Users can apply the The Search & Replace function can be used for Agent assignments in a workflow that . This function is available from the in the JS7 - Workflow Editor.
• Users can apply the The JS7 - Inventory Search function can be used to replace Agent assignments across workflows.
• Modified workflows have to be deployed to a Controller to make changes effective.

Anchor
deploy_agent_cluster deploy_agent_cluster

Deploy Agent Cluster

With When the configuration of an Agent Cluster being has been completed the cluster can be deployed to its Controller.

• An Agent Cluster and its Subagent Clusters can be used only after deployment to a Controller.
• Changes to an Agent Cluster, for example if the Director Agent's URL is changed or if a Subagent is added or dropped, require to be that the Cluster deployed.
• Deployment of an Agent Cluster includes to deploy deploying any Subagent Clusters configured for the that Agent Cluster. However, Subagent Clusters can be deployed individually, see chapter: see the Deploy Subagent Cluster section.

Anchor
manage_subagent_cluster manage_subagent_cluster

Manage Subagent Clusters

...

To add a Subagent Cluster users can start from the action menu of the Agent Cluster 's action menu to which the Subagent Cluster should be added to:

This brings forward the following view:

• The view displays the list of available Subagent Clusters.
• The indicated status signals that Status entry indicates whether or not the Subagent Cluster has been deployed or has not been deployed.
• The indicated synchronization status signals Sync Status entry indicates that the definition of the Subagent Cluster in the JS7 inventory and the version deployed to the Controller are in syncsynchronized.
  
  

The  buttons in the right upper corner allow to toggle toggling between the Subagent Cluster list view and the card view of Subagent Clustersviews:

Anchor
bulk_subagent_clusters bulk_subagent_clusters

Bulk Operations on Subagent Clusters

For In the Subagent Cluster list view and card view of Subagent Clusters views: buttons for the following bulk operations become available when the checkboxes available with shown for each Subagent Cluster are checked then buttons for the following bulk operations become available:

• Revoke: The Subagent Cluster is revoked from the Controller, i.e. the deployment is undone. The definition of the cluster remains in place and can later on can  be deployed once again later on.
• Delete: The Subagent Cluster is deleted from the Controller and from the JS7 inventory. This operation cannot be undone.
• Deploy: The Subagent Cluster configuration is forwarded to the Controller and can be assigned to jobs.
  
  

...

When adding Subagents the JOC Cockpit can be instructed to automatically create a Subagent Cluster for the single Subagentindividual Subagents.

To add a Subagent Cluster the The Create Subagent Cluster button can be used to add a Subagent Cluster.

This brings up the following popup window:

• The list of available Subagents is shown In the left panel the list of Subagents is available and -hand panel. These can be dragged & dropped to the middle panel.
• The middle panel holds a drop area to which a Subagent can be dragged & droppedfor adding Subagents by drag & drop.
  
  

With the Once a first Subagent being has been added to the cluster the middle panel offers provides additional drag & drop areas:

• The next Subagent can be dropped to the area above the existing Subagent to specify its role as the first Subagent used with in the fixed-priority scheduling mode.
  • In this mode the first Subagent is used and only if it becomes unavailable then will the next Subagent will be used.
• The next Subagent can be dropped to the area below the existing Subagent to specify its roles as the next Subagent used with in the fixed-priority scheduling mode.
  • In this mode the next Subagent is used only if the first previous Subagent becomes unavailable.
• The next Subagent can be dropped to the area right to the existing Subagent to specify use of in the round-robin scheduling mode.
  • In this mode each next task is executed with the next Subagent.
    
    

...

Anchor
deploy_subagent_cluster deploy_subagent_cluster

Deploy Subagent Cluster

With Once the configuration of a Subagent Cluster being has been completed the cluster can be deployed to its Controller.

• A Subagent Cluster can only be used only after deployment to a Controller.
• Changes to a Subagent Cluster require have to be deployed, for example if a Subagent is added or removed from a cluster.
• Deployment of Subagent Clusters can be performed individually and from bulk operations, see chapter: see the Bulk Operations on Subagent Clusters section.
• When deploying Deployment of an Agent Cluster then this includes to deploy deployment of any available Subagent Clusters, see chapter: see the Deploy Agent Cluster section.

The operation to deploy a Subagent Cluster is available from the Deploy button in the right upper corner:

Image Removed

Deploy button in the right upper corner is used to deploy Subagent Clusters:

Image Added

Anchor
revoke_subagent_cluster revoke_subagent_cluster

Revoke Subagent Cluster

Subagent Clusters can be revoked, i.e. they can be withdrawn from a Controller. As a result the Subagent Cluster's deployment will be undone.

• This operation is possible if no jobs are assigned the Subagent Cluster. Otherwise users first have to reassign their jobs different Subagent Clusters.
  • The Search & Replace function can be used to assign a Subagent Cluster to a workflow. This function is available in the JS7 - Workflow Editor.
  • The JS7 - Inventory Search function can be used to replace Subagent Cluster assignment across workflows.
  • Modified workflows have to be deployed to a Controller to make changes effective.
• Once a Subagent Cluster has been revoked, the Controller will no longer know the Subagent Cluster. However, the Subagent Cluster configuration in the JOC Cockpit inventory remains in place and can be deployed at a later point.

Anchor
delete_subagent_cluster delete_subagent_cluster

Delete Subagent Cluster

Subagent Clusters can be deleted only if no jobs are assigned to the Subagent Cluster in question.

• Users can apply the The Search & Replace function for Agent assignments in a workflow that which is available from the in the JS7 - Workflow Editor can be used to assign Subagent clusters in a workflow.
• Users can apply the The JS7 - Inventory Search function can be used to replace Agent assignments across workflows.
• Modified workflows have to be deployed to a Controller to make changes effective.

...

Each Subagent Cluster is individually assigned to a job.

• The property editor offers can be used to select Subagent Clusters from the list of Agents that which can be assigned a jobjobs.
  • This includes Standalone Agents.
  • This includes Subagent Clusters that are grouped by Agent Cluster.
• Assignment of Subagent Clusters can look like this:
  
  

...