Docker Support¶
A pre-built Docker image can be used as an alternative to installing a Python environment with the libraries required for the File Transfer DXL service. Docker images for the File Transfer DXL service are posted to the following Docker repository:
https://hub.docker.com/r/opendxlcommunity/opendxl-file-transfer-service-python/
The remainder of this page walks through the steps required to configure the service, pull the image from the repository, and run the File Transfer DXL service via a Docker container.
Service Configuration¶
The first step is to connect to the host that is running Docker and configure the File Transfer DXL service. The configuration files that are required for the File Transfer DXL service will reside on the host system and be made available to the Docker container via a data volume.
Once you have logged into the host system, perform the following steps:
1.) Create a directory to contain the configuration files
mkdir dxlfiletransferservice-config2.) Change to the newly created directory
cd dxlfiletransferservice-config3.) Download the latest configuration files for the File Transfer DXL service
The latest release of the service can be found at the following page:
https://github.com/opendxl-community/opendxl-file-transfer-service-python/releases/latest
Download the latest configuration package (dxlfiletransferservice-python-dist-config). For example:
wget https://github.com/opendxl-community/opendxl-file-transfer-service-python/releases/download/0.1.1/dxlfiletransferservice-python-dist-config-0.1.1.zip4.) Extract the configuration package
unzip dxlfiletransferservice-python-dist-config-0.1.1.zip5.) Populate the configuration files:
Pull Docker Image¶
The next step is to pull the File Transfer DXL service image from the Docker repository.
The image can be pulled using the following Docker command:
docker pull opendxlcommunity/opendxl-file-transfer-service-python:<release-version>
The following parameters must be specified:
release-version
The release version of the File Transfer DXL service
For example:
docker pull opendxlcommunity/opendxl-file-transfer-service-python:0.1.1
Create Docker Container¶
The final step is to create a Docker container based on the pulled image.
The container can be created using the following Docker command:
docker run -d --name dxlfiletransferservice -v <host-config-dir>:/opt/dxlfiletransferservice-config opendxlcommunity/opendxl-file-transfer-service-python:<release-version>
The following parameters must be specified:
host-config-dir
The directory on the host that contains the service configuration filesrelease-version
The version of the image (See "Pull Docker Image" section above)
For example:
docker run -d --name dxlfiletransferservice -v /home/myuser/dxlfiletransferservice-config:/opt/dxlfiletransferservice-config opendxlcommunity/opendxl-file-transfer-service-python:0.1.1
Note: A restart policy can be specified via the restart flag
(--restart <policy>
). This flag can be used to restart the container when
the system reboots or if the service terminates abnormally. The
unless-stopped
policy will restart the container unless it has been
explicitly stopped.
Additional Docker Commands¶
The following Docker commands are useful once the container has been created.
Container Status
The
ps
command can be used to show the status of the container.
docker ps --filter name=dxlfiletransferservice
Example output:
CONTAINER ID COMMAND CREATED STATUS c60eaf0788fe "python -m dxlfiletra" 7 minutes ago Up 7 minutesContainer Logs
The
logs
command can be used to display the log messages for the container.
docker logs dxlfiletransferservice
Example output:
Running application ... On 'run' callback. On 'load configuration' callback. Incoming message configuration: queueSize=1000, threadCount=10 Message callback configuration: queueSize=1000, threadCount=10 Attempting to connect to DXL fabric ... Connected to DXL fabric. Registering service: file_transfer_service Registering request callback: file_transfer_service_file_store. Topic: /opendxl-file-transfer/service/file-transfer/file/store. Using storage dir: /root/dxl-file-store On 'DXL connect' callback.The log output can be followed by adding a
-f
flag (similar to tail) to the logs command.Stop/Restart/Start
The container can be stopped, restarted, and started using the following commands:
docker stop dxlfiletransferservice
docker restart dxlfiletransferservice
docker start dxlfiletransferservice