On this Page

Overview

Remote Python Script Snap can execute a Python script natively on local or remote Python executors. The Remote Python Executor (RPE) can be installed either on the same node as the Snaplex or on a remote node that is accessible by the Snaplex.

Steps

Establish an SSH connection to the node.
Install Docker CE.
Create and start the RPE container.

SSH to the Node

Establish an SSH connection to the node where you want to install the RPE. The latter steps may require root access.

Install Docker

Follow the instructions on the official Docker site to install Docker CE on your machine. To install Docker on specific operating systems use the following links:

Limitation

The Remote Python Execute can be installed only on Groundplexes and not on Cloudplexes.

Start RPE

Docker Images

A Docker container is an instance created from a Docker image. We provide RPE as a Docker image, which you can download from here. This is the type available: min: the minimal version for CPU instances.

CPU Instance

Execute the following command to start the RPE container minimal version:

sudo docker pull snaplogic/rpe:min
sudo docker run --memory-swap="-1" --restart=always -dti -p 5301:5301 -e "REMOTE_PYTHON_EXECUTOR_TOKEN=" -v /opt/remote_python_executor_log/:/opt/remote_python_executor_log/ --name=rpe snaplogic/rpe:min

Options

The following table describes each option:

Option	Format	Description
--memory-swap="-1" --restart=always	--memory-swap="<memory_swap_limit>" --restart=always	The container can use unlimited space for memory swapping. See Memory Swap for more information. "–restart=always" automatically restarts the docker container if the machine restarts.
-p 5301:5301	-p <host_port>:5301	The RPE is accessible from the host port which is 5301 by default. You may change the host port to support multiple containers on the same node.
-e "REMOTE_PYTHON_EXECUTOR_TOKEN="	-e "REMOTE_PYTHON_EXECUTOR_TOKEN=<token>"	The default token is empty. A strong token is recommended.
-v /opt/remote_python_executor_log/:/opt/remote_python_executor_log/	-v <log_dir>/opt/remote_python_executor_log/	The log is mounted to /opt/remote_python_executor_log/by default. This location can be changed.
--name=rpe	--name=<container_name>	The container’s name can be changed in case of multiple containers on the same node.

Manage RPE

Since the RPE starts with the container, use the following commands to start, stop, restart, and remove the RPE.

sudo docker start rpe
sudo docker stop rpe
sudo docker restart rpe
sudo docker rm rpe

Custom Image

Download the custom RPE package. This package contains Dockerfile and others. You can modify the Dockerfile and add required libraries in requirements.txt. Then, run the following command to build the Docker image.

Make sure to cd into the directory containing the Dockerfile.

 sudo docker build --no-cache -t snaplogic_custom_rpe .

Once the image is built, execute the following command to create and start the custom RPE container.

sudo docker run --memory-swap="-1" --restart=always -dti -p 5301:5301 -e "REMOTE_PYTHON_EXECUTOR_TOKEN=" -v /opt/remote_python_executor_log/:/opt/remote_python_executor_log/ --name=rpe snaplogic_custom_rpe

	File	Modified

No files shared here yet.

Remote Python Executor (RPE) Installation