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) in one of the following ways:
  • Download the SDC Edge executable as a tarball or ZIP file along with your designed edge pipeline from Data Collector.
  • 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: Using Data Collector to download the executable along with your edge pipelines is the simplest way to deploy your designed edge pipeline to an edge device. If you use another installation method, you'll need to deploy your edge pipelines from Data Collector to SDC Edge.

Downloading from Data Collector

Use Data Collector to download the SDC Edge executable along with your designed edge pipeline. The downloaded file includes the SDC Edge executable and your selected edge pipeline.

Selecting an edge pipeline and downloading it with the SDC Edge executable is the simplest way to deploy your designed edge pipeline to an edge device. If you use another installation method, you'll need to deploy your edge pipelines from Data Collector to SDC Edge.

  1. Open an edge pipeline and then click the Download Edge Executable icon: .
  2. In the Download Edge Executable window, select the operating system and architecture of the edge device.
  3. Click Download.
    Data Collector downloads a tarball or ZIP file to the local machine. The file includes the SDC Edge executable and the selected edge pipeline.
  4. Move the file downloaded on the Data Collector machine to the edge device.
  5. 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.

Registering SDC Edge as a System Service

After installation, you can register SDC Edge to run as a system service named 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 perform the following tasks that are available when you manually start SDC Edge:
  • Start an edge pipeline at the same time that SDC Edge starts.
  • Modify the log level and the location where the log files are written.
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.

Running from Docker

You can run an 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

Uninstalling SDC Edge

Uninstall SDC Edge based on whether you started SDC Edge manually or as a service:

Manual start
  1. To shut down SDC Edge, type Ctrl+C in the command prompt.
  2. Remove the SDC Edge home directory from the edge device.
Service start
  1. To stop SDC Edge, run the following command as an administrator from the SDC Edge home directory:
    bin/edge -service stop
    For example, you might run the following command on Linux:
    sudo opt/local/streamsets-datacollector-edge/bin/edge -service stop
  2. To uninstall SDC Edge as a service, run the following command as an administrator from the SDC Edge home directory:
    bin/edge -service uninstall
    For example, you might run the following command on Linux:
    sudo opt/local/streamsets-datacollector-edge/bin/edge -service uninstall
  3. Remove the SDC Edge home directory from the edge device.