Online / Offline Status

The OneCloud service and OneCloud GroundRunner need to have a constant heartbeat where messages are exchanged with instructions on how to run jobs and any relevant information about a particular job. To that end, if a OneCloud GroundRunner goes offline, then the OneCloud administrators will receive a single warning email, and the GroundRunner will no longer be able to respond to commands. It is possible to disable the warning email. The live status of a GroundRunner can be viewed by selecting the Admin ➡️ Runners:

📓 Automatic reconnection

The GroundRunner will automatically try to re-establish communication if the network gets disrupted.


Getting GroundRunner Host System Status

The GroundRunner can fetch the resource status of the host operating system by selecting "Show Status".

Platform Configuration Settings

The following settings can be configured within the platform for each GroundRunner that is deployed. To edit these settings navigate to the vertical ellipses and go to edit. These values should match the deployed GroundRunner configuration settings below.

Configuration

Valid Settings

Protocol

http or https

Host Address / Hostname

Should be a resolvable DNS name of the machine or IP Address

Port

Port matching the deployed GroundRunner configuration file

Configuration Settings

A few of the OneCloud GroundRunners configurations can be changed by opening the file "ocrunner.config" in the directory where the binaries are installed. The following settings are available:

Configuration

Valid Settings

PORT

Do not change unless the GroundRunner is being configured to operate with a specific port (0 - 65535).

PROFILER_PORT

Internal use.

COMPANY_TOKEN

Do not change unless the GroundRunner is being configured to operate with a different OneCloud tenant.

HTTP_PROXY_URL

A valid URL for your proxy server, with the port included if necessary (i.e., http//yourproxy3000)

NO_PROXY

A comma-separated list of hosts that should be reached directly, bypassing the proxy. The patterns may start or end with a '*' for wildcards. Any host matching one of these patterns will be reached through a direct connection instead of through a proxy.

OC_LONG_POLL

When enabled, tells the runner to use HTTP long polling to communicate with the OneCloud platform. The default method of communication is to use a websocket connection, which is compatible with the majority of proxy servers. This environment variable should be set to true only in cases where your proxy server does not support a websocket connection. Default: false

CLOSE_REQUESTS

Tells the GroundRunner not to reuse HTTP connections. This setting is not applicable to the vast majority of GroundRunners - it is intended for use with Firewalls that sometimes will unintentionally interrupt connectivity to the platform.

To enable, set this value to "true"

LOG_LEVEL

"info" or "debug" (default)

AUTH_HOST

Internal use.

PROTOCOL

Internal use.

GROUNDRUNNER_CERT

"/path/to/certificate_file.crt"

This variable is required for encrypted communications between two different GroundRunners.

GROUNDRUNNER_CERT_KEY

"/path/to/certificate_key.key"

This variable is required for encrypted communications between two different GroundRunners.

The ocrunner.config is located in the OneCloud GroundRunner home "Contents" directory:

# INSTRUCTIONS
# If you would like to change the port that the GroundRunner
# listens on internally, set the port via the PORT variable
# e.g. PORT=8821
#PORT=8821
#PROFILER_PORT=
# Enter the company token that was issued to you here.
# e.g. COMPANY_TOKEN=aqx4cM8WbfocNoTePs62WDBA
COMPANY_TOKEN=aqx4cM8WbfocNoTePs62WDBA

# Proxy configuration
# The HTTP_PROXY_URL should be a full URL to the proxy e.g. https://myproxy:1234
# HTTP_PROXY_URL=
# HTTP_PROXY_URL=http://localhost:8888

# To use the NO_PROXY option, set the value to a comma separated list of domains. You may use wildcards '*'
# such as *.acme.io. All of the domains in the list will bypass the HTTP_PROXY.
# NOTE: You only should set this if you have set the HTTP_PROXY_URL
# NO_PROXY=

# OC_LONG_POLL determines whether or not the Runner will use long polling to receive commands.
# This is not recommended but is needed if you are using an http proxy that does not support web sockets
OC_LONG_POLL=false

# Enter the host name the Runner will authorize with.
AUTH_HOST=app.onecloud.io

# DO NOT MODIFY BELOW THIS LINE
PROTOCOL=http


Whitelist IP Address

In some cases, your organization may require that the OneCloud service is whitelisted within your network. Please see the following GroundRunner Whitelist Domains.

Service Account User ID

If the GroundRunner needs to access shared resources such as Windows UNC (Universal Naming Convention) paths, then the GroundRunner needs to start under a user account with adequate privileges' to access the resource. The default GroundRunner installation will leverage a local administrative account, but this access will be inadequate to leverage other remote resources such as a shared drive.

Installation Directory Considerations

Due to the production readiness nature of the GroundRunner jobs and needing to be available for job processing demands it is imperative that other system processes not place restrictions on any of the files within the GroundRunner installation directory.

It is the recommendation of OneCloud to ensure that the GroundRunner installation directory to be excluded from these processes.

Backup Software

If the files within the directory need to be backed-up please ensure the software does not place "file-locks" on any of the files. If there are no waivers to SysOPS policies then the GroundRunner must first be stopped prior to running the backup and then restarted after the backup is completed.

Malware / Antivirus Software

Often times Malware or Antivirus software can intercept and incorrectly identify OneCloud BizApp software. This will cause the BizApp commands to error out and not correctly process. The most common evidence of this behavior is contained within the GroundRunner logs stating that a recently downloaded BizApp cannot be found; as displayed below.

"Error starting command: exec: \"\\fileutils_windows.exe\": file does not exist" commandExecutorId=14700144

It is the recommendation of OneCloud to ensure that the GroundRunner installation directory to be excluded from the scanning software.

Did this answer your question?