Server installation properties
The server properties in the installed.properties file control details about the server, such as what ports it uses.
The installed.properties
file
The server properties in the installed.properties file contains details about the server, such as what ports it uses. By default, this file is in the folder /opt/devops-deploy/server/conf/server.
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.For example, the server adds the property
server.host, which specifies the IP addresses on which the server
listens for connections. In most cases, the server sets this property to the value
0.0.0.0, which means that the server listens for connections on all IP
addresses that it has available. You can specify a specific IP address in this property to
limit the IP addresses that the server listens on.
Some of these properties are listed in the following table:
| Property | Default value | Description |
|---|---|---|
| agentcomm.clientCertificate.enforceExpiration | None | Set the property to true to enforce server
certificate expiration and automatic generation of expired certificates. |
| agentcomm.clientCertificate.maxAgeDays | None | Defines the validity of certificate in days. The minimum allowed value is 90 days. |
| agentcomm.keystore | ../conf/server/s2s-client-identity.keystore | Used with Web agents. See Web agent configuration |
| agentcomm.proxy.uri | None | The WebSocket connection that is used to communicate with an
agent relay. May have the format http://host-or-ip:port. |
| agentcomm.uri | wss://host-or-ip:7919 | WebSocket connection that is used to communicate with Web
agents. The WebSocket secure URL must have the format
wss://host-or-ip:port. 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. |
| component.name | DevOps Deploy |
The name of the Deploy component during installation. The default property is required for the installer during Deploy installation. The property is essential for determining default values. Note: You must use the default value during installation.
Changing the default values results in the failure of the installation.
|
| component.directory | devops-deploy/server |
The directory where the Deploy component is installed. The default property is required for the installer during Deploy installation. The property is essential for determining the default values. Note: You must use the default value during installation.
Changing the default values results in the failure of the installation.
|
|
com.urbancode.ds.subsys.audit.A uditFactory.daysToKeepRestLog |
30 | The number of days you want to keep the REST call log records.
To keep the last 10 days of data, set the value to 10. Note: Restart your server instance for the change to take effect. |
|
com.urbancode.ds.web.rest.integ ration.vsys.VsysHelper.timeout |
120 | The time, in seconds, that server waits while it provisions an
IBM® PureApplication® System
environment. For complicated patterns, you might have to increase this value.
Specify a value greater than the longest provision session requires. For example, if
no provision is expected to take longer than 10 minutes, specify
900, or 15 minutes. |
|
com.urbancode.ds.workflow.cop yChildPropertiesToParentContext |
true | Set this property to false if you are not using children process properties. This can provide a performance boost. |
| com.urbancode.resource.sync.interval | 5 | Synchronizes the resource template changes at a regular interval
of time. Enter the time interval (in minutes) at which the resource sync service
runs on the system. Default is 5. Setting the time interval to 15
minutes may help in improving the performance of the system. Note that changes in a resource template structure are
automatically picked up by the resource sync service but any change in the role
properties of a resource template will not be synchronized. |
| database.type | mysql | The type of database. Valid values are mysql,
oracle, sqlserver, and
db2.
Warning: Do not use Derby for evaluation or a production server. |
| encryption.keystore | ../conf/encryption.keystore | The path to the encryption keystore. This parameter is optional if you have an existing installation that you are upgrading. |
| encryption.keystore.alias | desedekeyuniqueID |
The encryption keystore alias. This parameter is optional if you have an existing installation that you are upgrading. |
| hibernate.connection.driver_class | The default value depends on the type of database | The class name of the database driver. Such as
com.ibm.db2.jcc.DB2Driver for DB2® database. |
| hibernate.connection.password | password |
The password for the database connection. This password is encrypted during the installation process. |
| hibernate.connection.url | jdbc:db2://localhost:50000/deploy |
The connection URL for the database. For more information on building a database connection string, refer to documentation from your database provider. |
| hibernate.connection.username | devops-deploy |
The user name for the database connection. Unless
skip.db.install is set to Y, this user must
have permission to create tables in the database. |
| hibernate.default_schema | None | The name of the database schema. This property is required only for Oracle databases on Windows™. |
| install.ha | N |
Specify Y if the new server is part of a
high-availability cluster. In this case, you must specify database information in
properties such as database.type and
hibernate.connection.url. |
| install.java.home | The value of the JAVA_HOME system variable | The location of the installation of Java™ to use. This value must match the value of the JAVA_HOME system variable. It must also match the location of the JRE or JDK that you use to run the installation file. |
| install.server.dir | (Linux™) or C:\Program Files\devops-deploy\server (Windows™) | The installation directory for the server. |
| install.server.web.always.secure | Y |
Specify Y to always use secure connections to
the server. Specify N to allow non-secure connections. |
| install.server.web.host | The host name of the server | 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. |
| install.server.web.https.port | 8443 | 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.
|
| install.server.web.ip | 0.0.0.0 | The IP address that the server listens on. Specify
0.0.0.0 to listen on all addresses that are available to the
system. |
| install.server.web.port | 8080 | 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.
|
| install.service | None | To install Deploy as Windows service, enter install.service=Y. |
| install.service.name | None | To install Deploy as Windows service, enter install.service.name=devops-deploy-server. |
| install.service.login | None | To install Deploy as Windows service, enter install.service.login=.\\localsystem. |
| install.service.password | None | Enter the password for the administrative user. |
| install.service.autostart | None | Enter install.service.autostart=N. |
| java.home | Defaults to value of JAVA_HOME environment variable | If Java is installed in a location other than the default
location, then you must update the java.home property
accordingly. |
| license.server.url | None | Specify the connection information for the license server. This parameter is optional if you have an existing installation that you are upgrading. |
| require.token.basic | False | When set to true then tools, such as udclient, will only be able
to interact with the server using authtoken authentication ( --authtoken
3fb19dc4-f879-4684-906b-123456789abc ) and prevented from using the basic
--username --password flags. |
|
server.agentCommunicationAlwaysEnc rypted |
false |
Set this property to true to accept connections only from agents that use secure connections. |
| server.appdata.dir | The default application data folder is /opt/devops-deploy/server/appdata on Linux™ and C:\Program Files\devops-deploy\server\appdata on Windows™. | The path to 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. |
| server.initial.password | None | Specify the starting password for the administrator account on the
server. The administrator user name is admin.Note: When you perform a
silent installation, this property is required enry in the
install.properties file. |
| server.keystore | None | The path to the server keystore. |
| server.keystore.password | changeit |
The password for the server keystore. This password is encrypted
during the installation process. Additionally, this password is initially assigned
to the encryption.keystore.password property. |
| server.key.alias | NA | The name of the shared web agent communication server keypair
and certificate located in the server keystore. On upgrade, after automatic
rotation of keys, the server.key.alias property is added to
the installed.properties file as
below: The key aliases are stored in the server keystore defined by the server.keystore property, which defaults to $APPDATA/conf/server.keystore. |
| server.userIdAuthScheme | false |
Set to true to enable the authentication method
needed to have a Distributed Frontend Server. Must be set on the backend servers to
allow the frontend servers to communicate with them. |
| server.userPassAuth.enabled | None | Set to false to disable password-based
authentication.This property also disables admin login through the admin login page. You can use this property if you want to login via OpenID Connect only. |
| skip.db.install | N | If the value is Y or yes,
then:
|
| tomcat.key.alias | server | The keystore alias name. |
| nonInteractive | false |
Set to true to install or upgrade the server in
silent mode. |
The secured-installed.properties file
The server properties in the secured-installed.properties file stores sensitive information in an encrypted form, such as the server keystore password. By default, the secured-installed.properties file is located in /opt/devops-deploy/server/conf/server folder.
The property values in the secured-installed.properties file are displayed in the encrypted form after the server is started.
| Property | Description |
|---|---|
| agentcomm.keystore.password | The password for the Web agent keystore. |
| encryption.keystore.password | The password for the server encryption keystore. |
| hibernate.connection.password | The password for the database connection. This password is encrypted during the installation process. |
| server.key.password | The password for the server certificate private keystore. |
| server.keystore.password | The password for the server keystore. This password is
encrypted during the installation process. Additionally, this password is
initially assigned to the |
| tomcat.key.password | The password for the Tomcat certificate private key. The
property is referenced in the |
| tomcat.keystore.password | The password for the Tomcat keystore. The property is
referenced in the |