Installing the server in silent mode

Before you begin

Ensure that you have performed the following tasks:

You have a license server with available licenses if installing in a production environment. See Managing Licenses for more information.
The system that you are installing the server on meets the system requirements. See System Requirements..
A supported version of Java™ Runtime Environment (JRE) or Java™ Development Kit (JDK) is installed on the computer on which you are installing the Deploy server. For a list of supported Java versions, see Java.
Important: You should install a version later than the minimum supported version. Using the suggested version gives you some time to offset the Java upgrades from the Deploy server upgrades. For example, Deploy 8.1.x supports Java versions 11, 17, and 21. So, when you install Java 17, you are not required to update the Java for the next 2 long-term support (LTS) releases of Deploy.
Set the JAVA_HOME system variable to the location of the JRE.
Installed and configured the server database. See Installing the server database.
Placed the JAR file for the database driver in the lib/ext folder of the installation program.
If installing the server on AIX® platform, install the unzip program.
Your networks and firewalls allow communication on the required ports. See Firewall and communication configuration.
To install and run the server on Linux™ as a non-root user, create a user to use when you install and run the server. Also, ensure that the user has read and write permission to the folder to which you are installing the server.
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, see the documentation for the operating system.

If you are adding the server to a high-availability cluster, including as a cold standby server, ensure that:

You have configured the high-availability cluster. See Setting up high-availability clusters.
The system on which you are installing the new server has a connection to the cluster network storage and that the system can connect to the database that the cluster is using.
Each server in the cluster must run the same version of Deploy.

For information about high-availability clusters, see High availability and failover. For information about cold standby, see Adding cold standby servers.

About this task

You specify the server installation properties in the install.properties file, which is located in the root folder of the installation files. During the installation process, the server stores these properties in the installed.properties file, which is in the conf/server folder of the server installation files. If you have an already existing installation, you can use its installed.properties file as an example of the properties.

Note: Some of the properties in the table below can be changed after the server has been installed and others cannot. After the server starts for the first time, the server adds other properties to the installed.properties file. Some of these additional properties can be changed and others cannot.

Procedure

Download and extract the installation files for Deploy.
You can download the files from the My HCLSoftware (MHS) portal.
Customize the installation by specifying the properties in the server installation properties file
If you do not specify a property, the default value is used. These properties are copied to the installed.properties file of the completed installation.
If you specify a path in a property on a Windows™ system, you must escape any backslash (\) characters that are in the path. For example, to set the install.server.dir property to C:\devops-deploy, specify install.server.dir=C\:\\devops-deploy. See java.util Class Properties.

Note: The server.initial.password needs to be specified or install will fail.

The file looks similar to the following example:
```
component.name=DevOps Deploy 
component.directory=devops-deploy/server 
version=8.1.0.0.123456 
nonInteractive=true 
install.server.dir=/opt/devops-deploy/server 
install.java.home=/opt/java/ibm-java-i386-80 
install.server.web.always.secure=Y 
install.server.web.host=myserver.example.com 
install.server.web.https.port=8443 
install.server.web.ip=0.0.0.0 
install.server.web.port=8080 
database.type=db2 
hibernate.connection.username=deploy 
hibernate.connection.password=password 
hibernate.connection.url=jdbc:db2://host-or-ip:50000/data  
license.server.url=27000@RCLServer.example.com 
server.initial.password=admin
```
Save the file.

Run the installer along with the argument for silent install, that is -silent.

You can use additional arguments with the installation command. These arguments corresponds to properties in the install.properties file. When you use the installation arguments, the values in the install.properties file are overriden.

Table 1.
Argument	Corresponding property in the `install.properties` file	Description
-silent	`nonInteractive=true`	This argument installs Deploy without the interactive command-line prompts. You must use the `-install-dir` flag and also, specify the non-default configuration in the install.properties file. Note: When running the installer with the `-silent` flag and without the -install-dir flag, results in an error.
-install-dir /path/to/dir	`install.server.dir=/path/to/dir`	Specify the path to the installation directory. The installation directory can be an existing server directory (upgrade) or a new path (fresh installation). Note: Setting the `install-dir` argument that already has an existing server results in a server upgrade.
-java-home /path/to/jdk	`install.java.home=/path/to/jdk`	Specify the path to the JDK version to be used for the installation. Note: Running the command with the `-java-home` for a server upgrade results in an error.
-fips-semeru	None	This argument installs Deploy on a FIPS-compliant server. Note: If you install a FIPS-compliant server, cloud provisioning is not available. Deploy supports only IBM Semeru versions 11.0.24, 17.0.12, 21.0.4 or higher.

For example,

Run the installer by entering the command on Windows™ as:

install-server.bat -silent -install-dir /path/to/install -java-home /path/to/jdk

Run the installer by entering the command on Linux™ as:

install-server.sh -silent -install-dir /path/to/install -java-home /path/to/jdk

Results

The installation program installs the server. The properties that are set during installation are recorded in the file server_install/conf/server/installed.properties on the server.

If you install the server as a node in high-availability cluster, the installer loads the existing encryption keystore that is in the shared storage folder by using the default settings. If the default password is incorrect, you are prompted for the password. If after three attempts you do not enter the correct password, the installation process stops. If the keystore has more than one alias, you are prompted to specify an alias.

What to do next

To start the server, see Starting and stopping the server.

When you run the server for the first time, you might see an error message that says that no agent or tag is configured to import new component versions. To import component versions, including built artifacts, you must use an agent, and the server requires that you specify a default agent for this purpose. You can override this default setting when you create a component. Follow these steps to specify a default agent or agent tag:

To specify a default agent, click System > System Settings and under General Settings, clear the Use Agent Tag For Integration check box. Then, select an agent in the Agent for Version Imports list. Then, at the bottom of the page, click Save.
To specify a default agent tag, click Settings > System Settings and under General Settings, clear the Use Agent Tag For Integration check box. Then, select an agent tag in the Agent Tag for version imports list. Then, at the bottom of the page, click Save. If no tags are listed, add a tag to one or more agents on the server.

If you see "Out of memory" errors, increase the amount of memory that is available to the Deploy service. See Increasing the amount of memory that is available to the server.