Installing agent relays in interactive mode

Installing an agent relay from the command line involves running a batch file or shell script and specifying information about the agent relay.

Ensure that the computer on which you are installing the agent relay has a supported version of the Java™ Runtime Environment (JRE) or Java Development Kit (JDK).
For more information, see SPCR for Deploy.
Important: You must choose a Java version above the minimum supported level for your Deploy installation. This ensures maximum flexibility for future software upgrades, letting you update Deploy and Java in separate steps rather than simultaneously. For instance, Deploy 8.1.x supports Java 11 (minimum), 17, and 21, installing Java 17 prevents a mandatory concurrent Java upgrade when moving to the next major Deploy release.
If the target computer has an IBM® JRE or Java developer kit, update to a supported version of the IBM JRE or Java developer kit.
Set the PATH variable to contain the location of the JRE or JDK that you are using.
Ensure that the firewall on the computer allows connection to the Deploy server through HTTP/HTTPS.
Install the Deploy server.
Ensure that you have an authentication token for the relay. If you intend to use the component version replication option, the token must be assigned to a user with the server configuration permission Read Artifact Set List. For information about tokens, see Setting server configuration security.
Set up an account on the computer for the agent relay to use.
Your networks and firewalls allow communication on the required ports. See Firewall and communication configuration.
Ensured that there is no limit on the maximum memory size and virtual memory size. For example, on most Linux™ systems, you can run the ulimit -m and ulimit -v commands and ensure that both return the value unlimited. To find out how to remove the limit on the maximum memory size and virtual memory size, refer to the documentation for the operating system.

Download and extract the agent relay installer to the computer on which you want to install the agent relay:
- To download the installer from the server, click Help , located in the upper-right corner of the page, and then click Tools. Then, click DevOps Deploy Agent Relay and download and extract the file.
- To find the installer on the server with the command line, go to the following location and copy the file to the target system: installation_folder/opt/tomcat/webapps/ROOT/tools/devops-deploy-agentrelay.zip
Expand the compressed installation file.
From within the expanded directory, run the devops-deploy-agentrelay-install/install.cmd script (Windows™) or the devops-deploy-agentrelay-install/install.sh file (Linux or UNIX™).
The installation program prompts you for the following information.
You can accept the default values (displayed within brackets) by pressing Enter. If two options are given, such as Y/n, the capitalized option is the default value.

Enter the home directory for the JRE/JDK that the relay should use.

Specify the directory in which Java is installed. Press Y to accept the location set in the JAVA_HOME parameter.

Enter the directory to install the agent relay into.

Enter the directory for the relay. If you enter an existing directory, the program prompts you to upgrade the relay. For information about upgrading, see Upgrading the server. The default value is /opt/devops-deploy/agentrelay on Linux and C:\Program Files\devops-deploy\agentrelay on Windows.

The specified directory does not exist. Do you want to create it?

Press Y to create the installation directory.

Enter a unique name for this relay.

Enter the name of the agent relay. Each relay must have a unique name. The default name is agent-relay.

Enter the port number that this Agent Relay listens for proxy HTTP requests on.

Enter the port on which the agent relay listens for HTTP requests coming from agents. The default value is 20080.
Note: In addition, the relay automatically listens for CodeStation requests on port HTTP_proxy + 1 on the system where the agent relay is located. If you use the default port for HTTP requests, the relay uses 20081 for CodeStation requests and artifact transfers. If the CodeStation request port is blocked, agents cannot download artifacts.

Enter the web agent communication URL for your Deploy server. It must begin with 'wss://'.

Specify the WebSocket connection that is used to communicate with the server. The WebSocket secure URL must have the format wss://host-or-ip:port.

Do you want to configure another failover server connection?

If you specify a failover connection, you specify one or more additional servers. When the relay starts, it contacts one of the specified servers at random. If that server fails, it switches to another server from the list. For more information, see Configuring agent relays for failover.

Enable the agent relay to verify the server HTTPS certificate? If enabled, you must import the server certificate to the JRE keystore on the agent relay.

Specify whether to verify the server HTTPS certificate.

Enter the full web URL for the central server.

Enter the complete URL, that uses the following syntax: scheme://domain:port. For example: https://myServer.com:8080.

Do you want to cache files on the relay that are downloaded by connected agents?

If you want to cache files on the agent relay, enter Y.
Note: If you cache files on the relay, do not put the CodeStation cache on an NFS file system.

Do you want to install the Agent Relay as Windows service?

If you are installing the relay on Windows, you can install it as a Windows service. The default value is N.
If the relay is on Linux or UNIX and will connect to 400 or more agents, increase the process and file limit for the server:
1. Add the following lines to the file that sets process and file limits.
  For example, for Red Hat Enterprise Linux, version 7, use the /etc/security/limits.conf file. For AIX, use the /etc/security/limits.d/90-nproc.conf file.
```
relayUser             soft    nofile          60000
relayUser             hard    nofile          60000
relayUser             soft    nproc           65535
relayUser             hard    nproc           65535
```
  Use the name of the operating system user that is running the agent relay for relayUser. By default, the agent relay installation program creates a user that is named agentrelay.
2. Restart the computer that hosts the agent relay.
To start the agent relay, go to the installation folder for the relay and run the following command:
```
bin/agentrelay start
```

If you must modify the relay, you can edit these properties in the agentrelay.properties file in the relay_installation\conf directory.

Now you can install agents and connect them to the relay. See Installing agents.

To monitor the status of the relay and the agents that are connected to it, click Resources > Agent Relays. This tab shows the number of active and offline agents that are connected to each relay. For more information about an agent relay, in the Name column, click the relay.