Skip to content

spotfire-automationservices

About this image

This directory contains the official container recipe for Spotfire® Automation Services.

What is Spotfire Automation Services?

Spotfire® Automation Services is a service for automatically executing multi-step jobs within your Spotfire® environment.

For a quick overview, see the Introduction to the Spotfire environment ⧉.

For more information on the Spotfire product family, see the Spotfire® Documentation ⧉.

How to build this image

The easiest and recommended way to build all the Spotfire container images is using the provided containers/Makefile. See Spotfire Cloud Deployment Kit on GitHub ⧉.

You can also build this image individually. Follow the instructions below or adjust them according to your needs.

Prerequisites:

Steps:

  1. Copy the Spotfire.Dxp.netcore-linux.sdn package into the build/ directory within this folder.
  2. From the <this-repo>/containers folder, run make spotfire-automationservices to build this image, or make spotfire-automationservices --dry-run to just view the commands.

Adding custom Spotfire packages

At build time, put custom spk files in the build/ folder.

Adding additional ODBC drivers

Some Spotfire connectors will not be available in the default image unless you install required ODBC driver for the connector. To install additional ODBC drivers container image, you can create a custom Dockerfile. Here's a basic example of how you can do this:

# Start from the default image
FROM spotfire-automationservices:tag

# Switch to root user to install additional packages
USER root

# Install the ODBC driver
RUN echo "Add installation steps here"

# Switch back to the spotfire user
USER spotfire

Replace spotfire-automationservices:tag with the name and tag of the default spotfire-automationservices image. This image needs to be available before you can use it as a base image for your custom image. After creating this Dockerfile, you can build your custom image with the following command:

docker build -t custom_image:tag -f Dockerfile .

Replace custom_image:tag with the name and tag you want to give to your custom image. You can then use this image to start a container with the additional ODBC driver installed.

How to use this image

Prerequisites:

  • A running spotfire server container instance to connect to.
  • Spotfire client packages deployed to a deployment area so that the required licenses exist for spotfire-automationservices to start.

Start an Automation Services container

You can start an instance of the Spotfire Automation Services container with: 

docker run -d --rm -e ACCEPT_EUA=Y \
  -e SERVER_BACKEND_ADDRESS=spotfire-server \
  spotfire/spotfire-automationservices

Note: This Spotfire container image requires setting the environment variable ACCEPT_EUA. By passing the value Y to the environment variable ACCEPT_EUA, you agree that your use of the Spotfire software running in this container will be governed by the terms of the Cloud Software Group, Inc. End User Agreement ⧉.

Starting with a custom configuration

You can also start the spotfire-automationservices with a custom configuration by providing a Spotfire services configuration file: 

docker run -d --rm -e ACCEPT_EUA=Y \
  -e SERVER_BACKEND_ADDRESS=spotfire-server \
  -v "$(pwd)/Spotfire.Dxp.Worker.Web.config:/opt/spotfire/nodemanager/nm/services/AUTOMATION_SERVICES/Spotfire.Dxp.Worker.Web.config" \
  spotfire/spotfire-automationservices

For more information, see Service configuration files ⧉ and Service logs configuration ⧉.

Environment variables

  • LOGGING_SERVICELOG_MAX - Maximum number of automation services log files to save. Default 2
  • LOGGING_SERVICELOG_SIZE - Maximum size for automation services service log files. Default 10MB
  • LOGGING_WORKERHOST_LOGLEVEL - Log configuration for the Web Player service. Currently available configs are: standard, minimum, info, debug, monitoring, fullmonitoring, trace

See the common Spotfire node manager environment variables.