Page History
Table of Contents |
---|
Introduction
Initial Operation is performed after installation of
...
Initial Operation
the JS7 Controller, Agent and JOC Cockpit.
Operation of a Controller Cluster is subject to the agreements of the JS7 - License.
- Use of Standalone Controllers:
- available to Open Source License holders and to commercial license holders.
- Use of Controller Clusters:
- available to commercial license holders,
- for details see JS7 - Management of Controller Clusters
For a Standalone Controller initial tasks include
- registering a Standalone Controller,
- registering Agents.
Prerequisites
Initial Operation requires that a JS7 This step requires that a Controller, Agent and JOC Cockpit are successfully installed and are up and running.
- For details see JS7 - Installation
- The steps for initial operation are the same for any same for all supported platforms (On Premises, Docker, Cloud) are
...
Installation Video
This video explains how to register a Standalone Controller and Agents with JOC Cockpit:
Widget Connector | ||
---|---|---|
|
Initial Operation
Login to the JOC Cockpit User Interface
...
Users can navigate with their browser to the JOC Cockpit URL and enter the User Account and Password. Typically the URL
...
will include the hostname and port that JOC Cockpit has been installed for:
For example,
Please checkhttp://myhost:4446
.Check that the JOC Cockpit port is accessible
which might include to add. This might require additional firewall rules to allow access to
thisthe port from the computer that
you operatethe user's browser is operated for.
After initial installation of JOC Cockpit the default
User Account and Password ofroot:root
will be available if no changes have been made to theshiro.ini
configuration file.Note that the root useruser account
root
and passwordroot
are available.
Note: The root
user account is assigned the all
role in the default configuration
...
and is granted all available permissions.
...
For details see the JS7 - Identity Services and JS7 - Authentication articles.
Note: JOC Cockpit might take a number of seconds
...
to start and to display the login window.
Register Controller and Agents
After A dialog window appears after successful login to JOC Cockpit a dialog window appears. This . The popup window asks to register a Controller. You
Users will find the same dialog later on from the User -> Manage Controllers/Agents menu item.
You have a choice to register a Standalone Controller (n scope of the JS7 Open Source License) or a Controller Cluster for high availability (requires a JS7 Commercial License, see JS7 - Licensing).
New Controller button in the right hand upper corner.
Registering a
...
Standalone Controller
Registering a Standalone Controller is a straightforward taskbrings forward the following popup window:
Explanation
- Title: The title added for the Controller will be visible in each Controller instance is displayed with the JS7 - Dashboard view.
- The URL for JOC Cockpit is the hostname and port of the Controller as seen by JOC Cockpit. This URL is used by JOC Cockpit to connect to a Controller.
- Consider that the Controller's port is accessible which might include to add firewall rules to allow access to this port from the server that JOC Cockpit is operated for.
Register Controller Cluster
A Controller Cluster implements high availability for automated fail-over should a Controller instance be terminated or become unavailable.
Note that high availability by clustering is subject to JS7 - Licensing. Without a license fail-over/switch-over will not take place between Controller cluster members.
Explanation
- : The Controller instances are accessed by this URL from JOC Cockpit.
- The URL includes the protocol,
- This dialog allows to specify the Primary Controller instance, the Secondary Controller instance and an Agent Cluster Watcher.
- The title added for each Controller instance will be visible in the JS7 - Dashboard view.
- Primary and Secondary Controller instances require a URL as seen from JOC Cockpit. This URL is used by JOC Cockpit to connect to the Controller instances respectively.
- The URL of the Controller typically includes the
- hostname and port that the relevant Controller instance is operated for.
- The Agent Cluster Watcher is required for operation of a Controller Cluster. The Agent is contacted by both Controller Cluster members to verify the cluster status should no direct connection between Controller Cluster members be available.
- The Agent is assigned an
Agent ID
which is a unique identifier for this Agent that cannot be modified during lifetime of an Agent. Change of theAgent ID
requires to remove and to add the Agent with JOC Cockpit, it is not required to uninstall/reinstall an Agent. - The
Agent Name
is a unique identifier that is used for example in the Configuration view to assign Agents to jobs. TheAgent Name
can be modified later on. - The
Agent URL
is the hostname and port for which the Agent is operated.
Consider that the following connections should be accessible which might include to add - The Agent is assigned an
- By default the HTTP protocol is used. The HTTPS protocol can be used if TLS/SSL certificates are in place, see JS7 - Controller HTTPS Connections.
Note: The following connections should be accessible and might require additional firewall rules to allow access to the relevant ports:
- JOC Cockpit connection
- to the Primary Controller host and port.
- JOC Cockpit connection to the Secondary Standalone Controller's host and port.
- Primary Controller connection to the Secondary Controller host and port.
- Secondary Controller connection to the Primary Controller host and port.
- Standalone Controller connection
- to any Agent's Primary Controller connection to the Cluster Watcher Agent host and port.Secondary Controller connection to the Cluster Watcher Agent host and port
For more information about network connections see JS7 - System Architecture.
Register Agents
After Users can add Agents after the connection between JOC Cockpit and the Controller is established you can add Agents. To register an Agent switch to the Manage Controller/Agents view from the user menu. Click on the Action Menu of the Controller for which an Agent should be registered and select Add Agent.
Explanation:
- The Agent is assigned an
Agent ID
which is a unique identifier for this Agent that cannot be modified during the lifetime of an Agent. Change of theAgent ID
requires to remove and to add the Agent with JOC Cockpit, it is not required to uninstall/reinstall an Agent. - The
Agent Name
is a unique identifier that is used for example in the Configuration view to assign Agents to jobs. TheAgent Name
can be modified later on - In addition, you can add
Agent Alias Names
to make the same Agent available by different names. - The
Agent URL
is the hostname and port for which the Agent is operated.
Configuration
...
.
The icon in the JOC Cockpit main menu offers to select the Manage Controllers/Agents view:
This brings forward the following view that offers to add an Agent from the Controller's action menu:
The following popup window is displayed to add a Standalone Agent:
Explanation:
- Agent ID: A unique identifier of the Agent. Uniqueness is applied for all Agents registered with the same Controller. This identifier cannot be changed later on.
- Agent Name: The name of an Agent is used for example when assigning the Agent to jobs. Similarly to the Agent ID the Agent Name has to be unique but can be changed later on.
- Title: An individual description that can be searched for.
- Alias Names: The same Agent 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 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.
- URL: The protocol HTTP or HTTPS, host name or IP address and port by which the Agent is accessible to the Controller.
Further References
- Installation
- Operation
- Configuration