PubSub+ Cache for Docker

This repository contains the scripts required to create a Docker image that runs PubSub+ Cache.

Preparation

See the instructions on Installing PubSub+ Cache for obtaining the PubSub+ Cache software. This is provided in the form of a zipped tar file. Copy the file to the build-dir subdirectory.

This also requires the PubSub+ C Language client. Download the Linux 2.6 x64 zipped tar file from the Solace Downloads Page and copy it to the build-dir subdirectory.

Edit the config/config.txt file, entering the connection information to a PubSub+ broker that has been configured to use PubSub+ Cache. This file was copied from the sample config file included with PubSub+ Cache version 1.0.6, and it has been modified to send logging output to stdout rather than syslog.

Building the image

There are two ways to build the image.

Modifying the Dockerfile

Edit the Dockerfile and change the lines containing CACHE_FILENAME and SOLCLIENT_FILENAME to match the filenames you downloaded. Then run the build script.

Using Build Args

The other way to build the image is to run

export DOCKER_CONTENT_TRUST=1
docker build -t solcache:latest --file=Dockerfile --build-arg CACHE_FILENAME=SolaceCache_Linux26-x86_64_opt_1.0.6.tar.gz --build-arg SOLCLIENT_FILENAME=solclient_Linux26-x86_64_opt_7.11.08.tar.gz build-dir

Running the image

To run the image, run the run script. It will start the container and run it in the forground. Press ctrl-C to stop the container.

Note: depending on your Docker configuration you may need to use sudo if the script fails to execute with a not authorized error.

The config file is made available to the container using a mounted volume, it is not built into the image.

Note: If using secure connection to the Solace message broker, you'll also need to make the message broker server's CA certificate available. Place the certificate in a truststore directory and modify the run script with an additional -v argument to also mount this directory, similarly to how the config dir is mounted. Also configure SESSION_SSL_TRUST_STORE_DIR in the config file to point to the mounted truststore directory.

Security Considerations

The following security best practices were observed in writing the Dockerfile:

• It is based on an official trusted base image, Centos 7.
• The build script uses the DOCKER_CONTENT_TRUST environment variable.
• A user is created in the container, and the executable is owned and run by that user.
• The Dockerfile does not use the ADD command to fetch remote files.
• No secrets are stored in the image or the Dockerfile.

Next steps

Follow the instructions on Managing PubSub+ Cache to add this new Cache Instance to a Distributed Cache on the Solace message router.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the Apache License, Version 2.0. - See the LICENSE file for details.

Resources

For more information try these resources:

• The Solace Developer Portal website at: http://dev.solace.com
• Get a better understanding of Solace technology.
• Check out the Solace blog for other interesting discussions around Solace technology
• Ask the Solace community.