Installing the Agent for Databricks

This topic guides you through the installation of the Databricks Agent in an AE system without using authentication. If you want to use one of the methods that are available for authenticating the Agent, you must follow additional installation steps. For more information, see Agent Authentication in the Automic Automation documentation.

It is best to install the agent in a separate directory (such as C:\AUTOMIC\AGENTS\Databricks or Automic/Agent/Databricks).

Connecting the Databricks Agent to the Automation Engine

The Automation Engine and the Agent communicate using TLS/SSL, which requires using trusted certificates to prove the identity of the respective communication partner. Make sure you are familiar with the TLS/SSL and certificate implementation before installing the Agent. For more information, see TLS/SSL Considerations for Automic Automation in the Automic Automation documentation.

When the Agent communicates with an on-premises Automic Automation environment, the Agent establishes a connection with the Java communication process (JCP).

When you use certificates signed by a CA, the certificates are stored in the respective Java trust store by default. In this case, you only have to check that the root certificates already are in the respective store. If you do not want to use the default locations for the Agent, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

When the Agent communicates with the Automic Automation Kubernetes Edition, it establishes a connection to an ingress / HTTPS load balancer. Make sure that the address of the load balancer is defined on both sides: the Automation Engine and the Agent and that your HTTPS load balancer has the required certificates in place. For more information, see Connecting to AWI, the JCP and REST Processes Using an Ingress in the Automic Automation documentation.

Java Runtime Environment (JRE)

On the admin and/or user computer where the Agent is installed, install the Java Runtime Environment (JRE). For a list of compatible Java versions, see compatibility matrix.

If you have JRE installed, you can ignore this step.

Use the following command to check the version of the current Java virtual machine (VM):

java -version

If several JRE or Java SDK Versions are installed on the computer, make sure that the order of the directories is correct in the %PATH% or $PATH settings, since the first JRE that is found in the list of directories is used.

You can download the required JRE from https://www.oracle.com/java/technologies/.

Installing the Databricks Agent

1. If you have not already done so, install the Java Runtime Environment (JRE).

2. Download the installation package from https://marketplace.automic.com/

   The installation package has an Agents\Databricks\bin directory with the following content:

   • lib

     ecc-ae-sheet-ra-databricks.jar

     Contains the AWI panels.

   • uc.msl

     Message library

   • ucxjcitx.unix.ini

     Agent configuration file for UNIX

   • ucxjcitx.win.ini

     Agent configuration file for Windows

   • ucxjdatabricks.jar

3. On the host, install the Agent.

   UNIX

   1. Log in using the AE user.

   2. Transfer the ucxjdatabricks.tar file to a directory, for example Databricks

   3. Switch to the Databricks directory: cd databricks.

   4. Unpack the .tar file:

      gzip -d ucxjdatabricks.tar

      tar xvfo ucxjdatabricks.tar

      Make sure all files have been unpacked correctly and to note all .tar messages, which can come from various owners. After that you can delete the .tar file if you like.

   5. Make sure all files have the correct owner and group entries.

   6. Rename the supplied INI file ucxjcitx.ori.ini to ucxjcitx.ini.

   7. Adjust the INI file to your system environment.

      • If you use certificates signed by a CA, the certificates are stored in the respective Java or OS store by default. In this case, you only have to check that the root certificates are already in the respective store.

        If you do not want to use the default location for this component, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

        For more information, see Securing Connections to the AE (TLS/SSL) in the Automic Automation documentation.

      • name

        Name of the Agent object.

        Maximum length: 32 characters

        Allowed characters: "A-Z", "0-9", "_", ".", "$", "@", "-" and "#".

        Hyphens ("-") are only allowed in Agent names. They must not be used in the names of any other objects.

      • system

        Automation Engine system name. This entry must be identical to the entry in the .ini file of the Automation Engine server.

      • ra

        Used for additional trace. Before starting a newly installed or upgraded Agent, it is a good idea to turn Rapid Automation trace on by adding ra=99. This will give more troubleshooting information if something goes wrong during the installation. After a successful Agent start, you can set ra=0, and restart the Agent to turn Rapid Automation trace off.

      • connection

        Address of the communication process in the Automation Engine system to which the Agent should connect itself. The format is:

        <DNS name or TCP/IP address>:<port number>

      For more information, see Agent RA Core.

   WINDOWS

   1. Run setup.exe to start the program.

   2. Adjust the INI file to your system environment.

      • If you use certificates signed by a CA, the certificates are stored in the respective Java or OS store by default. In this case, you only have to check that the root certificates are already in the respective store.

        If you do not want to use the default location for this component, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

        For more information, see Securing Connections to the AE (TLS/SSL) in the Automic Automation documentation.

      • name

        Name of the Agent object.

        Maximum length: 32 characters

        Allowed characters: "A-Z", "0-9", "_", ".", "$", "@", "-" and "#".

        Hyphens ("-") are only allowed in Agent names. They must not be used in the names of any other objects.

      • system

        Automation Engine system name. This entry must be identical to the entry in the .ini file of the Automation Engine server.

      • ra

        Used for additional trace. Before starting a newly installed or upgraded Agent, it is a good idea to turn Rapid Automation trace on by adding ra=99. This will give more troubleshooting information if something goes wrong during the installation. After a successful Agent start, you can set ra=0, and restart the Agent to turn Rapid Automation trace off.

      • connection

        Address of the communication process in the Automation Engine system to which the Agent should connect itself. The format is:

        <DNS name or TCP/IP address>:<port number>

      For more information, see Agent RA Core.

4. Start the Agent.

   1. Make sure that the AE system is running on the server computer.

   2. On the host, start the Agent with the following commands:

      • Windows:

        <path to java> -Xrs -jar ucxjdatabricks.jar

        If java is installed in a folder which contains spaces the command needs to be placed in quotes.

        Example

        "C:\Program Files (x86)\Java\jre8\bin\java" -jar -Xrs -Xmx1G ucxjdatabricks.jar

      • UNIX:

        <path to java> -jar ucxjdatabricks.jar

        Example

        /usr/bin/java -jar ucxjdatabricks.jar

   3. In AWI (Client 0) verify that the Agent is logged on to the Automation Engine.

      Newly logged on Agents are not assigned to a client automatically and can only be viewed in Client 0. Once you have logged in to Client 0, access the Administration perspective and select Agents & Groups.

      For example (click to expand):

      

   Assign the new Agent to clients with the required rights using the Agent object definition. For more information see the Authorizations Page on the Automic Automation documentation.

Agents are an AE background program and are started as a service in the Service Manager.

Managing the Agent through the Service Manager

The Service Manager, one of Automic Automation's components, provides an easy and convenient way to start, stop, and access components, such as Agents, from a central point. Usually, you install the Service Manager when you install the Automic Automation components.

You can manage the Agent from the Service Manager, too. For this purpose, you must add the Agent to the Service Manager first. For information about how to do it, see the Adding Components section in the Service Manager - Dialog program documentation.

Next Step

Once you have finished the installation, the Agent is available in the Administration perspective in Client 0. You can configure the Agent properties in Client 0 using the Automic Web Interface, see Defining the Databricks Agent.

For more information about Agents, see Agents (HOST) in the Automic Automation documentation.

See also:

• Automic Automation / Databricks Agent Integration

• Implementation Overview for the Databricks Agent

• Establishing the Connection to Databricks