Run an express agent command-line installation

The agent software must be installed on each machine you intend to use with CloudBees CD/RO. An agent is a CloudBees CD/RO component that runs on a machine resource. The agent executes CloudBees CD/RO job steps, monitors step progress, and records job completion information.

Review Before You Install CloudBees CD/RO before performing this procedure.

If you have not already done so, download the full installer file. To download this version, select:
- Linux full installer: 2024.09.0.176472
For more details on installers, refer to Install CloudBees CD/RO on traditional platforms.

For legacy installer downloads, navigate to CloudBees CD/RO downloads.
Start the installer:
1. Enter the following command to make the installer file executable:
  Command
  Current version
  chmod +x CloudBeesFlow-x64-<version>
  ▼
  chmod +x CloudBeesFlow-x64-2024.09.0.176472
  ▼
2. Start the installation:
  
  For more information about required user privileges, refer to Linux services user permissions.
  - For root or sudo installations, run:
    
    Command
    Current version
    
    ./CloudBeesFlow-x64-<version>
    ▼
    
    ./CloudBeesFlow-x64-2024.09.0.176472
    ▼
    
    For root or sudo installations on Linux systems with a graphical interface systems, run:
    
    Command
    Current version
    
    ./CloudBeesFlow-x64-<version> --mode console
    ▼
    
    ./CloudBeesFlow-x64-2024.09.0.176472 --mode console
    ▼
  - For non-root/non-sudo installations, run:
    
    Command
    Current version
    
    ./CloudBeesFlow-x64-<version> --nonRoot
    ▼
    
    ./CloudBeesFlow-x64-2024.09.0.176472 --nonRoot
    ▼
    
    For non-root/non-sudo installations on Linux systems with a graphical interface systems, run:
    
    Command
    Current version
    
    ./CloudBeesFlow-x64-<version> \ --nonRoot \ --mode console
    ▼
    
    ./CloudBeesFlow-x64-2024.09.0.176472 \ --nonRoot \ --mode console
    ▼
A warning about automatic server start-up with non-root/non- sudo installations appears. Enter Yes to dismiss the warning.

The following prompt appears:

Specify the type of setup you would like to perform: expressServer, expressAgent, or advanced. [expressServer]▼

Enter: expressAgent.

The following prompt appears:

Discover the plugins directory from a remote CloudBees CD/RO server? [n/Y]▼

Enter y if you want the agent machine to have access to the plugins directory. You should allow access to the plugins directory so agents have access to collections of features, third-party integrations, or third-party tools.

The plugins directory on the CloudBees CD/RO server must be shared before the agent machine can use discover to find the directory. For more information, see Universal Access to the Plugins Directory .

The following prompt appears:

Create a resource for the installed agent on a remote CloudBees CD/RO server? [n/Y]▼

Enter y to automatically create a resource object for the agent on a remote CloudBees CD/RO server. This option is recommended to save time configuring new CloudBees CD/RO resources for pre-existing CloudBees CD/RO servers.

The following prompt appears:

Register as trusted agent (required for gateway)? [y/N]▼

Making an agent trusted restricts the agent to one CloudBees CD/RO server. The agent will not respond to incoming communication from any other CloudBees CD/RO server. This is useful when you want to create a secure production environment, but generally not needed for test or development systems.

You can run gateways without trusted agents. However, you should use gateways with trusted agents to prevent security issues in the firewall between zones connected by a gateway.

There are exceptions to using gateways without trusted agents:

The firewall between two zones is not required in your environment or is needed only to protect the CloudBees CD/RO server.
There is a specific reason to use gateways without trusted agents, such as a requirement to prevent unauthorized users from accessing your network. All incoming traffic from the internet is routed to a data center through a load balancer, and the load balancer routes the traffic to the appropriate machine in your network.

Choose one of the following options:
- If a gateway used to communicate with the CloudBees CD/RO server, you must select y. This option allows you to create a trusted network connection between the agent and server under the same certificate authority. This will allow the agent and the CloudBees CD/RO server to communicate across the network.
- If there is no gateway between the agent and CloudBees CD/RO server, enter n.
  
  If you deviated from the recommended agent options, you will see variations in the installation options that appear on your system.
  
  The following prompt appears:
  Create repository and/or agent in the default zone? [n/Y]
  ▼

Enter y to create the agent in the default zone.

The following prompt appears:

Specify the hostName:port of a remote CloudBees CD/RO server the agent, repository server and/or web server being installed can link to. The port is only required if it is not the default. [] <hostName:port>▼

Enter the Server Host Name of the CloudBees CD/RO server that will communicate with this agent.

You must specify the Server Host Name as <hostName>:>port> if the remote server is using a non-default HTTPS port. If you do not specify a port, HTTPS port 8443 is assumed (the same as the CloudBees CD/RO server default port).

The following prompt appears:
```
Specify the user name with which to login to <hostName>:<port>. [admin]▼
```
Enter the user name of a user on the CloudBees CD/RO server who has sufficient privileges to create a resource. The default is the CloudBees CD/RO-supplied admin user.

The following prompt appears:
```
Specify the password for "<CloudBees CD/RO_user>" on <hostName>:<port>. []▼
```
Enter the password for the CloudBees CD/RO user. The default password for the admin user is changeme.

The following prompt appears:
```
Specify the name of the resource to create on <<hostName>:<port>. [<resource_name>]▼
```

Enter the following information if the agent must be registered as a trusted agent. These options only appear if you entered y for Register as trusted agent (required for gateway)? [y/N].

Enter a resource name to use on the CloudBees CD/RO server.

The following prompt appears:
```
Specify the agent gateway URL in the form of ‘ipOrHostname:port’ []▼
```
Enter an agent gateway URL. This is the URL of the gateway used to communicate with the CloudBees CD/RO server.

The following prompt appears:
```
Specify the zone name for the agent and/or repository []▼
```

Enter the Zone Name. This is the zone used during remote agent and or remote repository creation.

The following prompt appears:

Specify the user the agent will run as. []▼

Enter a user name. This is the user who owns the CloudBees CD/RO agent process. For example, you might enter build.

For security, CloudBees recommends not installing an agent on the server host or giving any agents access to the server file system. Doing so may give an agent access to sensitive files such as the server passkey, database configuration, and other system resources allotted to CloudBees CD/RO.

If the agent is installed on the server host or given access to the server file system, CloudBees strongly recommends using separate users for server and agent services, so it is possible to prevent the agent from accessing sensitive files. Using the same user for both services also gives agents the same access permissions as the server user.

CloudBees strongly recommends not running agents as sudo or ROOT users in production, or long-lived development and testing environments. Running agents with these privileges poses significant security risks, as they have unlimited ability to execute operations which can be used to access any file on the agent host, or modify the configuration of that host.

Assign CloudBees CD/RO agent users only the necessary privileges to perform their functions, following the Principle of Least Privilege (PoLP). This helps to prevent permission escalation and data exposure should an agent become compromised.

For more information on how to mitigate agent security risks, refer to Agent security recommendations.

If you specify root, enter y when the following confirmation appears:

It is not recommended to use the 'root' user for running the agent process. Please confirm if you would like to proceed [y/N]▼

The following prompt appears:

Specify the group the agent will run as. []▼

Enter a Group Name. This is the group that owns the CloudBees CD/RO agent process. For example, you might enter build.

CloudBees CD/RO is installed on the machine. When the installation completes successfully, a prompt that contains the line " CloudBees CD/RO <version> was successfully installed! " appears.