Help Desk

Submit a ticket My Tickets
Welcome
Login

Advanced GroundRunner Notes

The following notes provide additional insight into configuring and managing the OneCloud GroundRunner.

OneCloud Reference Architecture

Users securely interface with the OneCloud service over the HTTPS (TLS 1.2) protocol via web and mobile-enabled devices. Running within the OneCloud host is the primary OneCloud service, an AES-enabled database that securely houses the application metadata as well as a queue to manage communication and task execution on remote OneCloud service agents (GroundRunners). While agents are external, they are controlled by the OneCloud host to execute discrete tasks that make up a workflow chain.

In summary, the OneCloud architecture has the following key components (see diagram below): 

  1. The secure browser-based end-user interface to build, run, and administer integrations. 
  2. The central OneCloud multi-tenant cloud service hosted in Amazon Web Services (AWS). 
  3. Remote execution agents for interfacing with cloud and on-premises applications. 

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 by  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 is the network gets disrupted.

Getting GroundRunner Host System Status

The GroundRunner can fetch the resource status of the host operating system by selection -> Show Status

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:

ConfigurationValid Settings
PORTDo not change unless the GroundRunner is being configured to operate with a specific port (0 - 65535).
PROFILER_PORT
Internal use.
COMPANY_TOKENDo not change unless the GroundRunner is being configured to operate with a different OneCloud tenant.
HTTP_PROXY_URLA valid URL for your proxy server, with the port included if necessary (i.e., http//yourproxy3000)
NO_PROXYA 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
LOG_LEVEL
"info" or "debug" (default)
AUTH_HOST
Internal use.
PROTOCOL
Internal use.

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=1gN2xxxxxxxxxxxKa6UX2i

# 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
LOG_LEVEL=debug

# Enter the host name the Runner will authorize with.
AUTH_HOST=${MOTHERSHIP_HOST}

# 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.

GroundRunner FAQ

Which ports need to be open for a GroundRunner?

The OneCloud GroundRunner does not require any ports to be open. During the installation, by default, the GroundRunner will listen on port 8821 for communication between GroundRunners. It is optional to have this open, and only necessary if you want GroundRunners on different servers to be able to share command outputs inside your corporate network. You can also adjust the port used via the GroundRunner configuration file in the installation directory.

GroundRunner fails to start?

If the OneCloud tenant is operating under a trial license, and that license has expired, then it is likely that the OneCloud agent will not start with the following error:

Your subscription to OneCloud has expired or your GroundRunner has been terminated. Please contact support@onecloud.io to resolve this issue.

To resolve this issue, simply remove the .expired  file located where the OneCloud GroundRunner is installed and then restart the OneCloud GroundRunner.

Valid Trial License Required!

Note that if your OneCloud trial has expired, then as soon as you start your OneCloud GroundRunner, then a new .expired will be created. To extend your trial, please contact support@onecloud.io.

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 priveledges 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.

B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.