| Main Parameters | | | |
--action | Defines whether you are installing or upgrading. | {install,upgrade} | This parameter is always required |
--coordinator | Primary Coordinator installation | {enabled,disabled} | You cannot install a primary and a secondary Coordinator on the same machine |
--secondary-coordinator | Secondary Coordinator installation | {enabled,disabled} | You cannot install a primary and a secondary Coordinator on the same machine |
--initiator | Initiator Agent installation | {enabled,disabled} | Can be installed on the same machine as a helper and a Primary Coordinator |
--helper | Helper Agent installation | {enabled,disabled} | Can be installed on the same machine as an Initiator and a Primary Coordinator |
--build-cache-service | Installs a Build Cache Service that hosts shared Build Cache. | {enabled,disabled} | Cannot be installed on a machine with a Helper, Initiator, or Coordinator. |
--coordinator-machine | The IP address or hostname of the Primary Coordinator machine. | Must use a static identifier - either a static IP address or a hostname | Required for the installation of an Initiator, Helper, or Secondary Coordinator on a remote machine. It establishes the communication with the Primary Coordinator.
When an Agent is installed with the Coordinator on the same machine, this parameter is not needed. |
--data-dir | The path to the storage directory, where Incredibuild DBs, log files, and helper file cache (for helper machines only) will be stored. | | This parameter must be included in the installation of all components. Incredibuild will automatically create a link to this path.
The storage directory cannot be under: /opt/incredibuild, the user’s home directory, or /etc/incredibuild.
The directory cannot be located on any of the following operating systems: fuse, cifs, smb, vxfs, tmpfs, nfs.
You must have execute permissions on this directory. |
--accept-eula | Pre-approves the end user license agreement (EULA). If this is not done, you will be asked to approve the agreement during installation in the command line. | {true,false} | |
| Optional Parameters | | | |
--helper-cache-size | The size of the helper file cache in GB. | Integer | Default is 10. |
--build-cache-service-size | The size of the Build Cache service in GB. | Integer | Default is 100. Only for Build Cache Service machines. |
--local-build-cache-size | The size of the local Build Cache on an Initiator in GB. | Integer | Default is 100. |
--skip-coordinator-test | For Agent installations, skip the connectivity test to the Primary Coordinator that is performed by default. | {true,false} | The test is performed by default and is only skipped if you set this parameter to true. |
--disable-telemetry | Opt out of sending product usage data to Incredibuild. | {true,false} | False by default |
| Port Parameters - Optional | | | |
--coordinator-message-transport-port | Internal TCP port required for communication with the Coordinator. | Integer | Default is 5672. Only for Primary Coordinators. |
--coordinator-ui-port | Modifies the port for accessing the Web Management Console using HTTPS. | Integer | Default is 8000. Only for Primary Coordinators. |
--local-http-port | Modifies the port for accessing the Web Management Console using HTTP. | Integer | Default is 8080. For all machines except Primary Coordinators. |
--local-https-port | Modifies the port for accessing the Web Management Console using HTTPS. | Integer | Default is 8081. For all machines except Primary Coordinators. |
--temp-dir | The temporary location to extract installer files | | |
--utility-port | The Coordinator Utility Port for helper allocation. | Integer between 1-65535 | Default is 9953 |
