📓 OneCloud GroundRunners are execution agents that perform various integration and automation tasks on remote computing environments.

Step 1: Pre-Requisites

In order to take full advantage of the features of the OneCloud GroundRunner, the GroundRunner requires Java version 8 or higher is installed. Java is available from Oracle's download center or by download OpenJDK.

📓 Java Terminology

When installing Java, you may encounter the terminology JDK (Java Development Kit) and JRE (Java Runtime Environment). Only the JRE is required in order to use the GroundRunner. Java should also be installed in the PATH so it can be accessed globally (i.e., the command java should be available in the command prompt).

⚠️ Java Keystore Certificates

When using a self-signed certificate, or a certificate not issued via a named certificate authority it may be required to import the certificate into the Java Keystore. This is a requirement of JAVA/SSL security.

  1. Obtain a copy of your certificate used to secure your site from your IT Administrators or via your Web browser. You can also use Edge, Chrome or FireFox to export the SSL certificate to your computer.

  2. Copy the exported certificate to where your GroundRunner is installed.

  3. Import the certificate into your Java Keystore. An example command would be:

    keytool -import -trustcacerts -keystore "C:\Program Files\Java\jre1.8.0_251\lib\security\cacerts" -storepass changeit -noprompt -alias <alias_name> -file <path_to_exported_file>

Step 2: Download the GroundRunner

The first step to configure a GroundRunner is to download the installer from the OneCloud application website. OneCloud users with the role of administrator can navigate to the administrative area of OneCloud. Follow the path:

Admin ➡️ Runners ➡️ Downloads.

⚠️ Admin Option

If Admin option on the left-hand side of the OneCloud interface is not visible, then please speak to your OneCloud administrator.

From the Downloads page, select the appropriate GroundRunner based upon the host operating environment. A Company Token is required to configure the GroudRunner. The autogenerated company token is accessible on the Downloads page.

Step 3: Select Installation Instructions

Based upon the GroundRunner's host operating system, choose the appropriate installation path:

Step 4: Activate the GroundRunner

After the GroundRunner is installed and started, the GroundRunner will try to connect to the main OneCloud service. When this connection is successful, a new notification will appear in the OneCloud console, and the new Runner will need to be activated and registered.

Step 5: Name the GroundRunner

Name the GroundRunner with a short-descriptive name that typically would include the name of the server and organization name.

📓 See the Advanced GroundRunner document for advanced configuration details.

Step 6: Specify the GroundRunner Environments

For added security GroundRunners can be setup by Administrators to be available for certain environments. This helps control and audit runner security.

A GroundRunner can be specified as:

  • Global ➡️ Available to be used by all Workspaces and Environments when connections are defined.

  • Environments ➡️ Available to only those defined Workspaces and Environments

Step 7: Assign to a Connection

Once the new GroundRunner is registered, it can be used by OneCloud Connections and will appear in the Runner dropdown as an available service:

Please feel free to ask any questions or offer feedback on this post. If additional assistance is needed, email us at support@onecloud.io.

Did this answer your question?