Manage Sevco Runners

Install, manage, delete, and uninstall Sevco Runners

The Sevco Runner enables the Sevco platform to connect to and retrieve data from on-premise only Source Integrations. Many Source Integrations are cloud-based services that do not require us to access your network. Those Source Integrations do not need a Sevco Runner (refer to the Manage Sevco Integrations article instead). However, if the Source you're integrating is within your on-premises network (we call this an "on prem" Source), it requires a Sevco Runner.

Understand Sevco Runners

The Runner is a shell program that you to deploy in your environment and, instead of Sevco reaching into your network, our Runner reaches out from your network to Sevco, creating a pipe between your network and the Sevco backend that collects the Source Integration's data. The Sevco Runner is standalone multi-platform single-executable application you can run anywhere. It connects to Sevco over HTTPS, and registers itself within your organization.

Once you install it, the Runner reaches out to Sevco, downloads the required plugin, and starts running the plugin in that machine, collecting data from your network and sending it to Sevco. One Runner can run 10 on-prem Source Integrations; for more than ten Source Integrations, install another Runner.

System Requirements

The Sevco Runner can be installed on Windows, Mac, and Linux. They are statically linked executables and have no external library dependencies.

Minimum Operating System

  • Windows (7, 8, 8.1, 10 and Windows Server)
  • Mac OS (10.7 or later)
  • Linux (kernel 2.6.32+, glibc 2.17+)

Minimum Hardware

  • CPU: 2 64-bit core processors.
  • RAM: 8GB
  • Storage: OS minimum

Note: For organizations using less than 5 Source Integrations, a minimum of 1GB of RAM per Source Integration will be required.

Communication

HTTPS (TCP 443) outbound access to the following domains:

  • api.sev.co
  • plugins.api.sev.co

For Windows Runners:

Sevco recommends that Windows runners be installed on a device which is a member of the domain.



Runners Page

The left panel of the Runners page guides you through the configuration of a Runner. The right panel displays the Runners you have already installed, along with the icons of the Source Integration plugins running inside each Runner. The status of all deployed Runners and their respective activity timestamps are also displayed. When you first use Sevco, this panel will be empty.



Install a Sevco Runner

To add a Sevco Runner:

  1. Download and install the OS-specific file as shown above.
  2. Follow the OS-specific installation instructions in your UI.
  3. Then follow the remaining steps in the image shown above.
  4. You must now integrate, or configure, Sevco Integration plugins into the Runner. You can install a Source Integration directly into the Runner here, or do so in the Integration page.


Reset a Runner Token

⚠️

All existing runners will stop uploading to Sevco immediately after the Reset Runner Token is selected. You must apply your new runner token to all runners to resume.

You can reset the runner token for your organization from the Runners page. Start by selecting the Reset Runner Token button, then select the Copy Runner Token button to copy your new token.

From here, you can follow the instructions for your operating system to complete this process.


Windows

  1. Navigate to C:\Program Files\Sevco\ then open config.xml in Notepad or a similar editor.
  2. Edit <Params api_key="YOUR TOKEN"> by removing your old token and replacing it with your new one.
  3. Open Services and locate Sevco Runner Service. Right-click and select Restart to complete this process.


CentOS, RHEL, Ubuntu, Debian

  1. Edit /opt/sevco/runner-environment by replacing your old token with your new one in SEVCO_API_KEY="YOUR TOKEN”.
  2. Run systemctl restart sevco-runner to complete this process.

MacOS

  1. Navigate to /etc/sevco/ then open runner.conf in TextEdit or a similar editor.
  2. Edit api_key: "YOUR TOKEN" by removing your old token and replacing it with your new one.
  3. Run launchctl kickstart -k system/com.sevco.runner via the command line to complete this process.


Delete a Sevco Runner

Deleting a Sevco runner in the Sevco platform removes it as a source from your Sevco environment. To completely remove the services and files associated with a Sevco runner that were installed on the client hardware follow the instructions to Uninstall a Sevco Runner below.

To delete a Sevco Runner, navigate to the Runners page, hover over the Runner you want to delete, and click the Settings gear that displays to go to the Runner Details page.

1734

In the Runner Details page, click Delete.

780

Uninstall a Sevco Runner

First, delete the Sevco runner from the Sevco platform as instructed in the previous section. Then follow the instructions for your operating system to uninstall the Sevco runner.

Windows

  1. Uninstall Sevco runner services right in the Windows desktop:
    • You can go to SettingsApps, and select Sevco from the Apps & features list. Click Uninstall.
    • You can also click the Windows icon in the lower left corner of your desktop, scroll to Sevco in the list of apps that displays, right-click on it, and select Uninstall.
  2. Follow the standard wizard to remove the Sevco runner services.
  3. Complete the file cleanup by deleting the C:\Program Files\Sevco folder.

CentOS / RHEL

  1. Uninstall Sevco runner services via the CentOS cmdline: rpm -e sevco-runner.
  2. Complete the file cleanup with this command: rm -rf /opt/sevco.

Ubuntu / Debian

  1. Uninstall Sevco runner services via the cmdline: dpkg -P sevco-runner.
  2. Complete the file cleanup with this command: rm -rf /opt/sevco.

macOS

  1. Uninstall Sevco runner services via the command line:
    launchctl remove com.sevco.runner.
  2. Complete the file cleanup with these two commands:
    • rm /usr/local/bin/sevco_runner
    • rm /etc/sevco/runner.conf