Version 2.5 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

On-premises setup (macOS)

Learn how to set up a macOS Remote Execution cluster on-premises

Summary

Unpack the service package
Install the service
Add your license
Configure the service
Start the service
Configure the client

Requirements

See baseline requirements.

As of release 1.32.0, our Remote Execution software runs on the following versions of macOS:

10.14 (Mojave)
10.15 (Catalina)

Need other OS support or want to run in an AWS or MacStadium environment? Contact us.

1. Unpack the service package

Unpack engflow-re-macos-x64-1-32-0.tar.

It contains the installer for the scheduler and worker services (scheduler.pkg and worker.pkg).

It does not contain a valid license file. We send you a license separately.

2. Install the service

On every machine, make sure you have at least Java 11 installed.

Need support for older versions of Java? Contact us.
Select at least one machine that will run the scheduler and install scheduler.pkg on that machine.
Select at least one machine that will run the worker and install worker.pkg on that machine.

Note that you typically have significantly more workers than schedulers in a cluster.

Warning: do not copy your source tree on these machines. The build tool uploads files if build actions need them.

3. Add your license

Copy your license onto every machine as /etc/engflow/license.

4. Configure the service

See the dedicated articles for details.

Tip: all service instances (schedulers and workers) can use the same config file. Schedulers ignore worker-specific options and vice versa.

(Optional) Customize the config file we sent you as part of the trial agreement
Copy the file to every machine as /etc/engflow/config
(Optional) Customize the file per-machine:
- Set --worker_config on workers

Tip: for a first time trial setup we recommend using the config file we send you as part of the trial agreement. Later (and especially before productionizing) you should customize this config more. Consider:

network settings (e.g. --public_port , --private_ip_selector )
authentication (e.g. --tls_certificate , --client_auth )
execution strategies (e.g. --allow_local ).

As of release 1.32.0, local is the only supported execution strategy on macOS.
executor pools
storage use (--external_storage )
monitoring
JVM flags

See the Service Options Reference for more info.

5. Start the service

The service is configured to start automatically. All you need to do is to reboot the machine.

If rebooting the machine is not possible or not desirable, you can also start the service by SSH into every machine and running the following commands:

On schedulers:

sudo launchctl start com.engflow.re.scheduler

On workers:

sudo launchctl start com.engflow.re.worker

For first-time setup, or after changing the configuration, we recommend to start the service temporarily in a shell session to verify it is up and running:

On schedulers:

/usr/local/bin/engflow/scheduler_service

On workers:
```
/usr/local/bin/engflow/worker_service
```

6. Configure the client

See Client configuration.

2022-04-28