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

Groundplex Installation

The Linux installer comes bundled with the JRE necessary for this Snaplex. We recommend you use the patch version of Java 11 that is bundled with the installer for your Linux environment. 

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, and perform one of the following steps:

    • 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:

    $ sudo chown snapuser:snapuser /opt/snaplogic/etc/myplex.slpropz
    $ sudo chmod 600 /opt/snaplogic/etc/myplex.slpropz
  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.

Disable noexec Setting

Some Snaps, such as the SQL Bulk Load Snaps, require write and execute permissions to the /tmp directory. Make sure you disable the noexec setting in the mount used for the /tmp directory. Else, the Snap execution could fail with an error like Failed to map segment from shared object: Operation not permitted. You can also specify a different location as the temporary folder.

FeedMaster Installation

Ultra Pipelines require that you set up a FeedMaster along with the JCC (Java Component Container) nodes in your Groundplex. For details, see Deploying a FeedMaster Node.

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:

    This example is an excerpt from 1.8.0_45; the directory path might vary based on the Java installation directory.

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

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

The steps to import the certificate to the JCC node can vary based on the certificate format and the OS.

Invalid Self-signed certificate

While configuring accounts for various Snap Packs, you might encounter the following error message:

Failed to validate account: Invalid credentials Cause: Could not send Message. (Reason: unable to find valid certification path to requested target; Resolution: Please provide valid credentials.)

If this error occurs, update the CAcert trust store in the SnapLogic JCC nodes to enable a successful TLS (SSL) handshake to the target endpoint.

Find the trust store at /opt/snaplogic/pkgs/java version/lib/security/cacerts, and confirm that every node in the Groundplex has the certificate imported.

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. Log in to the host as a root or sudo user.

  2. Create the startup service file:

    touch /etc/systemd/system/snaplogic.service
  3. Change the permissions on the file:

    chmod 664 /etc/systemd/system/snaplogic.service

    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:

     vim /etc/systemd/system/snaplogic.service
  5. Add the following text to the file:

  6. Save and exit the file.

  7. Enable the service by running the following command:

     systemctl enable snaplogic.service

    The service will start automatically when the host reboots.

  8. Start the service:

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

     systemctl disable snaplogic.service

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:

    cd /etc/init.d/
  3. Create a softlink to the jcc.sh file: 

    ln -s /opt/snaplogic/bin/jcc.sh snaplex
  4. Add the softlink to chkconfig management:

    chkconfig --add snaplex

We recommend that you reboot the machine to verify if the Snaplex service is restarting automatically on machine reboot. Under some conditions, the symlink resolution might fail when the machine is starting up. In this case, you can change the Snaplex startup script to be a file instead of a symlink. Run the following commands a root user:

rm /etc/init.d/snaplex
cp /opt/snaplogic/bin/jcc.sh /etc/init.d/snaplex
echo "export SL_ROOT=/opt/snaplogic" >> /etc/sysconfig/jcc


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

chkconfig --del snaplex

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:

    cd /etc/init.d/
  3. Create a soft-link to the jcc.sh file: 

    ln -s /opt/snaplogic/bin/jcc.sh snaplex
  4. Install the service using update-rc.d. For example: 

    sudo update-rc.d snaplex defaults 98 02

    Troubleshooting if the machine reboot fails

    We recommend that you reboot the machine to verify whether the Snaplex service is restarting automatically on machine reboot. Under some conditions, the symlink resolution might fail when the machine is starting up. In this case, you can change the Snaplex startup script to be a file instead of a symlink. Run the following commands a root user:

    rm /etc/init.d/snaplex
    cp /opt/snaplogic/bin/jcc.sh /etc/init.d/snaplex
    echo "export SL_ROOT=/opt/snaplogic" >> /etc/sysconfig/jcc

    On a Debian system, the /etc/sysconfig directory would need to be created if not already present.

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

    update-rc.d -f snaplex remove

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/jdk-11.0.10+9-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, perform 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.

Enhanced Encryption Keys

When using Enhanced Account Encryption, the private key for the Org is stored in the /etc/snaplogic directory. We recommend that you also maintain a copy of the private key elsewhere. If the private keys are not available, then Accounts created in SnapLogic cannot be used.


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.

The JCC process needs to be restarted after the limits are updated.

snapuser soft nproc 8192
snapuser hard nproc 65536
snapuser soft nofile 8192
snapuser hard nofile 65536


Setting limits for Docker Containers

For Docker deployments, you may not be able to set these limits because of permissions issues with the su – user user. Instead you can set the ulimits using the --ulimit parameter when running the docker run command. The limits described above also apply to the Docker container ulimits.

See Also

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