Install SDC Edge

Download and install SDC Edge on each edge device where you want to run edge pipelines.

After installation, you can start SDC Edge manually. Or, you can register SDC Edge to run as a system service and then start SDC Edge as a service.

Install Data Collector Edge (SDC Edge) on an edge device in one of the following ways:
  • Download the SDC Edge executable as a tarball or ZIP file from the Edge Data Collectors view in Control Hub.
  • Download the SDC Edge executable as a tarball, ZIP file, or Windows MSI installer from the StreamSets website.
  • Run an SDC Edge container from the Docker image.
Tip: Downloading the executable from Control Hub is the simplest way to install SDC Edge because you can automatically register the SDC Edge with Control Hub during the installation. If you use another installation method, you'll need to manually register the SDC Edge with Control Hub after the installation.

Downloading from Control Hub

You can download the SDC Edge executable as a tarball or ZIP file from Control Hub. Choose to enable Control Hub during the download to automatically register the SDC Edge with Control Hub.

  1. In the Navigation panel, click Execute > Edge Data Collectors.
  2. Click the Download icon: .
  3. In the Download SDC Edge Executable window, select the operating system and architecture of the edge device.
  4. Select Enable Control Hub so that the downloaded SDC Edge is automatically registered with Control Hub at start up.
  5. Optionally configure the following properties:
    Property Description
    Labels Labels to assign to this SDC Edge. Use labels to group Edge Data Collectors registered with Control Hub. To assign multiple labels, enter a comma-separated list of labels.

    Default is "all", which you can use to run a job on all registered instances of SDC Edge.

    For more information, see Labels Overview.

    Ping Frequency Frequency in milliseconds that SDC Edge notifies Control Hub that it is running.
    Status Events Interval Frequency in milliseconds that SDC Edge informs Control Hub of the status of all pipelines running on this SDC Edge.
  6. Click Download.
    Control Hub downloads a tarball or ZIP file to your machine.
  7. Move the downloaded file to the edge device.
  8. Extract the downloaded file.
    For example, use the following command on Linux to extract the tarball to the desired location on the edge device, typically /opt/local:
    tar xf streamsets-datacollector-edge-<version>-<os>-<architecture>.tgz

Downloading from the StreamSets Website

You can download the SDC Edge executable from the StreamSets website as a tarball, ZIP file, or a Windows MSI installer for Windows operating systems.

  1. Use the following URL to download SDC Edge from the StreamSets website: https://streamsets.com/opensource.
    The downloaded file includes the SDC Edge executable.
  2. Install the downloaded file based on the file type:
    • For a tarball or ZIP file, move the downloaded file to the edge device and then extract the downloaded file.
      For example, use the following command on Linux to extract the tarball to the desired location on the edge device, typically /opt/local:
      tar xf streamsets-datacollector-edge-<version>-<os>-<architecture>.tgz
    • For a Windows MSI installer, move the downloaded file to the edge device and then run the installer.

      Or, you can use the command line to remotely install the MSI file on any Windows machine in the network. For details, see Microsoft Windows documentation.

  3. After the installation, manually register the SDC Edge to work with Control Hub.

Registering SDC Edge as a System Service

After installation, you can register SDC Edge to run as a system service on the edge device.

When you run SDC Edge as a system service, SDC Edge starts when the operating system is started and runs in the background. However, you cannot modify the log level when SDC Edge starts as a service. This task is available only when you manually start SDC Edge.

To register SDC Edge to run as a system service, run the following command as an administrator from the SDC Edge home directory:
bin/edge -service install

Use the same command on all supported operating systems. On Linux or Darwin, use sudo to run the command as an administrator. On Windows, open the command prompt as an administrator and then run the command.

For example, if you installed SDC Edge to /opt/local on Linux, run the following command:
sudo opt/local/streamsets-datacollector-edge/bin/edge -service install
The registered system service is named "datacollector-edge" on all operating systems.

After SDC Edge is registered as a system service, you can manage the service by running the following commands as an administrator. Or, if you register SDC Edge as a system service on Windows, you can also use the Windows Services Application to start, stop, and restart the service.

SDC Edge Service Command Description
bin/edge -service start Start the SDC Edge service.
bin/edge -service stop Stop the SDC Edge service.
bin/edge -service restart Restart the SDC Edge service.
bin/edge -service uninstall Uninstall the SDC Edge service.
bin/edge -service status Displays the status of the SDC Edge service.

Running from Docker

You can run a SDC Edge container from the StreamSets Data Collector Edge Docker image.

To run an SDC Edge container from the Docker image, use the following command in the Docker Quickstart Terminal:
docker run --publish 18633:18633 --name edge --rm streamsets/datacollector-edge

After the installation, manually register the SDC Edge to work with Control Hub.