Installing the server in interactive mode

In interactive mode, you install the server by typing configuration information on the command line.

Before you begin

  • If installing in a production environment, make sure that you have a license server with available licenses. See Managing Licenses for more information.
  • Ensure that the system that you are installing the server on meets the system requirements. Contact HCL support for more information.
  • Ensure that a supported version of a Java™ Runtime Environment (JRE) or Java™ Development Kit (JDK) is installed on the computer on which you are installing HCL DevOps Deploy (Deploy).
    Important: The Deploy server, agent, and relays require a Java™ Runtime Environment (JRE) or Java™ Development Kit (JDK) version 11.
    Important:

    For best results, download and use the latest available version of Java Runtime Environment (JRE) for the Deploy server, agents, and relays. Be sure to set the JAVA_HOME system variable to the location of the JRE. If you are updating or changing the JRE to the latest version, see Changing or updating the JRE of servers, Changing or updating the JRE of agents, and Updating the JRE location for agent relays for instructions.

  • If you are installing the server in a production environment, install and configure the server database before you install the server. See Installing the server database.
  • Ensure that you have placed the JAR file for the database driver in the lib/ext folder of the installation program.
  • If you are installing the server on AIX® platform, the unzip program is required.
  • Make sure that 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.
  • Ensure 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:
  • Configure the high-availability cluster; see Setting up high-availability clusters.
  • Ensure that 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

Install the server in interactive mode as follows:

Procedure

  1. Download and extract the installation files for Deploy.
    You can download the files from the My HCLSoftware (MHS) portal.
  2. From the command line, run the server installer program.
    • On Windows™, run the install-server.bat file.
    • On Linux™, run ./install-server.sh.
    • To install a FIPS-compliant server, add the -fips-semeru parameter to the command, such as install-server.sh -fips-semeru.
      Note:
      • If you install a FIPS-compliant server, cloud provisioning is not available.
      • Deploy supports IBM Semeru versions 11.0.24, 17.0.12, 21.0.4 or higher.
    Depending on your system settings, you might need to run this file as an administrator.
  3. Specify the configuration information as the installation program prompts you.
    Enter the directory of the server to upgrade(leave blank for installing to a clean directory).
    To install Deploy, press Enter.
    Enter the home directory for the JRE/JDK that the new server or already installed server uses.
    Specify the location of the JRE or JDK for the server. The default value is the value of the JAVA_HOME system variable.
  4. Read the license agreements for the software package. Press Enter to show one page at a time, or press F and then press Enter to show the entire license at once.
  5. If you agree to the terms of all of the license agreements, press Y and then press Enter.
  6. Specify the following information as the installation program prompts you.
    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 directory where the DevOps Deploy server should be installed.
    Specify the installation directory for the server. The default server installation directory is /opt/devops-deploy/server on Linux™ and C:\Program Files\devops-deploy\server on Windows™.
    Note: Do not use any shell expansions or abbreviations, such as the tilde character (~).
    The specified directory does not exist. Do you want to create it?
    Press Y to create the installation directory.
    Will this server be used as a node in a high availability cluster?
    Press Y to add the server to a high-availability (HA) cluster, including cold standby clusters. Selecting this option sets the property com.urbancode.ds.UDeployServer.multiserver to true on the new server, which indicates that it is part of a high-availability installation.
    Where should the server store application data such as logs, plugins, and keystores?
    Type the name of the application data directory. The directory must be accessible to the server, and you must have the appropriate permissions. If you are installing a node in a high-availability cluster, this directory must be on the cluster network storage. The default application data folder is /opt/devops-deploy/server/appdata on Linux™ and C:\Program Files\devops-deploy\server\appdata on Windows™.

    Depending on whether the shared folder exists or is empty, you are prompted with one of the following options:

    • If the folder does not exist, you are prompted with the following option: The specified directory for application data doesn't exist. Do you want to create it?. Press Y to create the application data directory. If you select N, the installation process ends.
    • If the shared folder exists and is not empty, you are prompted with the following option: The specified directory for shared resources already exists and is non-empty. Do you want to use the existing data?. Press Y to use the data. If you select N, the installation process ends; in this case, you must manually clear the application data folder to use it.
    • If the shared folder exists but is empty, the folder is used and you are not prompted to use the existing data.
    Note: Do not use any shell expansions or abbreviations, such as the tilde character (~).
    What host name will users access the web UI at?
    If you are installing a stand-alone server, specify the host name of the computer that hosts the server. If you are installing a stand-alone server in a production environment, consider specifying a host name that is not tied to the physical computer. By specifying such a host name, you can expand the server to a high-availability system later. If you are installing a server in a high-availability cluster, specify the host name of the load balancer for the cluster.

    The server listens on all IP addresses that are available to it, not just this host name or IP address.

    Do you want the Web UI to always use secure connections using SSL?
    Press Y to use secure connections to the server. If you select this option, you must configure a certificate for the server; see Configuring SSL on Apache Tomcat and LDAP servers.
    Enter the port on which the Web UI should listen for secure HTTPS requests.
    Specify the HTTPS port for the server. The default value is 8443. If you are installing Deploy, IBM DevOps Velocity, and IBM DevOps Release, be sure to use a different port for each product. If you are installing multiple instances of Deploy on the same computer, be sure to use a different port for each instance.
    Enter the port on which the Web UI should redirect unsecured HTTP requests.
    Specify the HTTP port for the server. The default value is 8080.If you are installing Deploy, IBM DevOps Velocity, and IBM DevOps Release, be sure to use a different port for each product. If you are installing multiple instances of Deploy on the same computer, be sure to use a different port for each instance.
    Enter the initial password for the admin user.
    Specify the starting password for the administrator account on the server. The administrator user name is admin. Then, type the password again to verify it.
    Enter the web agent communication URL for this server.
    The WebSocket secure URL must have the format wss://host-or-ip:port. For example, wss://mydeploy:7919. The default WebSocket port is 7919. Each server must have a unique URL, and every server in a HA cluster must be able to connect to this URL. Web agents use this URL to communicate with the sever.
    Enter the URL of the License Server for DevOps Deploy, in the form of https://hclsoftware.compliance.flexnetoperations.com/instances/YOUR_SERVER_ID/request. Alternatively, you may leave this blank to begin a 60-day evaluation period.
    • Specify the connection information for the license server. For 8.0.1.3, specify the HCL license server path, such as https://FQDNhostname:LLSport/v1/licensepools/deploymentID. For earlier versions, you can specify the FlexNet license server path as https://hclsoftware.compliance.flexnetoperations.com/instances/YOUR_SERVER_ID/request.
    • Alternatively, you may leave this blank to explore Deploy features without a license for 60 days. To continue using Deploy, specify license.server.url property in the server installation properties file. See Server installation properties for more information.
    Create database schema?
    In most cases, press Y to create new schema definitions in the database. However, if you have a pre-populated database, such as if you are adding a server to a cluster, press N. If you are adding the server to a high-availability cluster, press N unless the server is the first node in the cluster.
    Enter the database type to use.
    Specify the type of database. Valid values are mysql, oracle, sqlserver, and db2.
    Note: Apache Derby is no longer shipped with Deploy. You must not use Derby for evaluation and on production environment.
    Depending on the type of database that you select, new fields appear for information about the database. Specify the following database-related parameters:
    Enter the database driver.
    Specify the class name of the database driver.
    Please place the jar file containing the driver for your database inside the lib/ext directory in the DevOps Deploy installer.
    Verify that you placed the JAR file for the database driver in the lib/ext folder of the installation program and then press Enter.
    Enter the database connection string.
    Specify the complete connection string for the database, such as the following string:
    jdbc:db2://localhost:50000/deploy
    Enter the database schema name.
    Specify the name of the database schema to create or use. This field is required on Windows™ if the user has the database administrator role. This field applies only to Oracle databases.
    Enter the database username.
    Specify the user name for the database. If you are creating the database schema, this user must have permission to create tables in the database.
    Enter the database password.
    Specify the password for the database.
  7. If you are installing on Windows™, the installation program prompts you with the following questions after a pause:
    Do you want to install the Server as Windows service?
    Press Y to install the server as a Windows™ service.
    Enter a unique service name. No spaces allowed.
    Specify a name for the Windows™ service. The default service name is devops-deploy-server. The name must be unique on the system and must not contain spaces.
    Enter the user account name including domain path to run the service
    Specify the user account with which to run the service, including the domain path. Prefix local accounts with a period, such as .\localsystem.
    Do you want to start the service automatically?
    Press Y to start the server automatically. Otherwise, you can start and stop the server manually. See Starting and stopping the server.
    User account password
    Specify the password for the user account.

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.