Installing a Snaplex on Linux

In this article

Install a Snaplex on Linux

This article describes the procedures for installing an on-premise Snaplex in a Linux environment. An on-premise Snaplex is also known as a Groundplex. This document uses the term Groundplex to distinguish this type of Snaplex (on-premise) from other types, such as a Cloudplex or an eXtremeplex. However, in command syntax and references to the UI, the generic term Snaplex is used.

Groundplex installation covers the following tasks:

  1. Setting up a Groundplex.
  2. Importing a certificate.

For prerequisites, see Requirements for On-premises Snaplex

Setting up a Groundplex

  1. Log into SnapLogic Manager as an Org admin.

  2. Navigate to the project where you want to create your Groundplex, then do one of the following:

    • Click the Snaplex tab, then click  to display the Snaplex dialog.
      OR
    • Click to display the Assets drop-down list, then select Snaplex; the Snaplex dialog appears.



  3. Enter the required information on the Create Snaplex form. Once completed, the Downloads tab on the Snaplex popup appears. The Downloads tab has links to the installer and configuration files.

  4. Download the RPM/DEB and the configuration file onto a Linux machine:

    • For CentOS (or Redhat) 6.3 or newer, run the following command:
      $ sudo rpm -i <filename>.rpm

    • For Ubuntu 14.04 or newer, run the following command: 
      $ sudo dpkg -i <filename>.deb

      Where <filename> is the name of the current installer file.

  5. After the software is installed, place the downloaded configuration file in the /opt/snaplogic/etc directory and make sure the file name ends with .slpropz. Change the .slpropz file so that snapuser owns it by running the following commands:

  6. To start the Snaplex service, run:

    $ sudo /opt/snaplogic/bin/jcc.sh start

  7. To verify the Snaplex has started, visit https://elastic.snaplogic.com/sl/dashboard.html#Health. The newly installed Snaplex node should appear in the list of nodes for the Snaplex.

Importing a Certificate to SnapLogic JCC nodes

To generate and import a self-signed certificate on all the JCC nodes in the Snaplex:

  1. Obtain the certificate (.pem) file by using SSH.

  2. Import the file by using the following command in the JCC node:

  3. Restart the JCC node process to confirm the import.

  4. Run the following command to list certificates from the CAcerts file:

Automatically Start and Stop a Groundplex on Linux

You can use either the systemd or init.d utility to start and stop the Snaplex. Procedures for both are included below. The procedures vary depending on which Linux distribution is installed on the Snaplex host.

Starting and Stopping the Groundplex by Using the Linux Systems Call

Use this procedure for Red Hat-like Linux distributions such as Red Hat, Fedora CoreOS, CentOS, and SuSE.

To add the Snaplex as a Service:

  1. Login to the host as a root or sudo user.

  2. Create the startup service file:

  3. Change the permissions on the file:

    This change provides read and write permissions for the owner and group, and read permission for others.

  4. Open the file with a text editor. For example, the using a vim editor:

  5. Add the following text to the file:

  6. Save and exit the file.

  7. Enable the service by running the following command:

    The service will start automatically when the host reboots.

  8. Start the service:

  9. To stop the Snaplex as a service, run the following command:

Starting and Stopping the Groundplex by Using the init.d Utility

Use this procedure for Red Hat-like Linux distributions such as Red Hat, Fedora CoreOS, CentOS, and SuSE.

To add the Snaplex as a service:

  1. Login to the Linux machine as root.

  2. Change directories:

  3. Create a softlink to the jcc.sh file: 

  4. Add the softlink to chkconfig management:


To delete the Snaplex as a service, remove the service from the chkconfig management:

Debian-like Distribution (Debian and Ubuntu)

To add the Snaplex as a Service:

  1. Log in to the Linux machine as root.

  2. Change directories:

  3. Create a soft-link to the jcc.sh file: 

  4. Install the service using update-rc.d. For example: 

  5. To stop the Snaplex as a Service, remove the service from update-rc.d management:

Configure Java 11 on Linux

To update your JCC nodes to OpenJDK Java 11:

  1. Stop the existing JCC node by running the following command:
    $ sudo /opt/snaplogic/bin/jcc.sh stop

  2. Download the new Snaplex installer and install the Groundplex, running the RPM, DEB, or Docker installers as appropriate.
    • For RPM systems, run the following command:
      rpm -U snaplogic-snaplex.rpm
    • For DEB systems, run  the following command:
      dpkg -i snaplogic-snaplex.deb
    • For Docker, stop the existing container and start a new container using the latest image.

  3. Add the following entry to the /etc/sysconfig/jcc directory. You must create this directory and file if neither are present. 
    export SL_JAVA_HOME=/opt/snaplogic/pkgs/openjdk-11.0.5+10-jre/

  4. Start the JCC node by running the following command:
    $ sudo /opt/snaplogic/bin/jcc.sh start.

Changing the Installation Folder

If you want to use the/myopt/myroot instead of the /opt/snaplogic as the installation folder and myuser instead of snapuser, do the following steps:

  1. Run the following commands after installing the RPM/DEB package:
    1. $ sudo mv /opt/snaplogic /myopt/myroot
    2. $ sudo chown -R myuser /myopt/myroot
  2. Add the following properties in the /etc/sysconfig/jcc file. If this file does not exist, create it.
    1. export SL_USER=myuser
    2. export SL_ROOT=/myopt/myroot
  3. Restart the service with the following command: 
    $ sudo /myopt/myroot/bin/jcc.sh restart
  4. To make a service using init.d, make the /etc/init.d/snaplex file a symlink to the /myopt/myroot/bin/jcc.sh file.

Uninstalling the SnapLogic RPM from your environment

To uninstall the SnapLogic Linux-based package from your environment:

  1. Remove all content from the /etc/snaplogic and /opt/snaplogic folders by running the following commands:
    1. $ rpm -qa | grep snaplogic
    2. $ sudo rpm -e snaplogic-sidekick-4.main_9292-1.x86_64
    3. $ sudo rm -rf /opt/snaplogic
    4. $ sudo rm -rf /etc/snaplogic
  2. Verify that the packages were deleted from the /etc/snaplogic and /opt/snaplogic folders.


System Limits

Some Linux installations have system ulimit settings that are set to lower values. This low setting can cause errors when running higher Pipeline loads on the Groundplex JCC node, such as, java.lang.OutOfMemoryError: unable to create new native thread.

To fix this issue, you need to increase the system limits for the Snapuser user. You can add the following in the /etc/security/limits.conf folder to increase the file and process limits.


See Also

Video: Installing a Groundplex through a Debian-based Linux Distribution