This collection of code samples includes examples that demonstrate containerization of STK Engine on Linux.

The following is a list of the examples in this collection along with a description of what they demonstrate. Each example project provides:

• A README.md file with instructions and explanations on what the example does and how to build and run the container either using directly the Docker command line or using Docker Compose (i.e., using the docker-compose.yml file in the same folder)
• A Dockerfile containing all the commands to assemble the image
• A docker-compose.yml file, enabling the use of Docker Compose to build and run the images

The images in these examples are built upon each other, and you need to build them in the correct order. Since almost all examples eventually derive from stk-engine-baseline, we recommend starting there. After that, if you have a specific example you'd like to experiment with, navigate to that folder's README.md file and follow the prerequisites section to determine what images need to be built for that example to work.

All of the images are built upon the Red Hat Universal Base Image 8 from dockerhub, but there are instructions in each README.md, Dockerfile, and docker-compose.yml file to use the UBI8 image from IronBank. In order to pull the base images from IronBank please follow these instructions.

Further information can be found in the AGI Programming Help.

Provides the STK Engine installation with the runtime configuration (environment variables) to run STK Engine applications.

• Images: redhat/ubi8:latest
• Files: STK Engine for Linux v12.4.0+

Provides the environment required to communicate with the Yum and Pip package managers in your organization. This is optional if you are directly connected to the internet. It is required if you are using a proxy/firewall or isolated network requiring different certificates, settings, or both.

• Images: stk-engine-baseline, redhat/ubi8:latest
• Files: Custom Certificate Authorities, Yum Repositories

Derives from the base STK Engine image and runs the connectconsole executable to expose Connect through a socket from the container.

• Images: stk-engine-baseline
• Files: N/A

Derives from the base STK Engine image and adds Python 3 to the image.

• Images: stk-engine-baseline or stk-engine-custom-baseline
• Files: N/A

Derives from the Python STK Engine image and exposes JupyterLab from the container. Go to JupyterLab in your web browser to exercise Python notebooks using STK Engine for computations. AGI also provides an example notebook.

• Images: stk-engine-python
• Files: N/A

Derives from the Python STK Engine image and shows how to develop and include your own web service(s) in the Docker image. You can write those web services in Java and Python for Linux, and also with .NET if using a Windows container. This is just a bare-bones minimal web service example using the Flask development server and is not production ready. Please refer to the Flask documentation for best practices on how to create and deploy a production-ready web service.

• Images: stk-engine-python
• Files: N/A

Provides three example images and composes two of them together to run a full STK Parallel Computing Server cluster. The first image, in the coordinator subdirectory, contains the STK Parallel Computing Server Coordinator. The second image, in the Python subdirectory, derives from the Python STK Engine image and includes the STK Parallel Computing Python API. The third image, in the agent subdirectory, derives from the Python image in this example and contains the STK Parallel Computing Server Agent. This project includes an example client script that demonstrates how to exercise the STK Parallel Computing Java/.NET/Python APIs to drive batch STK Engine computations and tasks.

• Images: stk-engine-python, redhat/ubi8:latest / custom/redhat/ubi8:latest
• Files: STK Parallel Computing Server v2.4.0+