Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Info

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.

...

Code Block
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.

...

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.

Tip

Make sure to to run cd into the directory containing the Dockerfile.

...