Skip to content

spotfire-nodemanager

About this image

This directory contains the official container recipe for Spotfire® node manager.

What is Spotfire node manager?

Spotfire® node manager is the service used for controlling the Spotfire services.

The Spotfire node manager can manage the following Spotfire services:

  • Spotfire® Web Player service: enables users to perform analyses from a web browser.
  • Spotfire® Automation Services: allows scheduling custom jobs.
  • Spotfire® Enterprise Runtime for R - Server Edition (a/k/a the TERR™ service): allows additional calculations and advanced analytics using Spotfire Enterprise Runtime for R (a/k/a TERR™).
  • Spotfire® Service for Python: allows additional calculations and advanced analytics using Python.

For more information, see the Introduction to the Spotfire environment ⧉.

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 spotfirenodemanager-<version>.x86_64.tar.gz package into the build/ directory within this folder.
  2. From the <this-repo>/containers folder, run make spotfire-nodemanager to build this image, or make spotfire-nodemanager --dry-run to preview the required commands.

How to use this image

Prerequisites:

  • To start the spotfire-nodemanager container, first you need a configured spotfire-server to connect to.

Start a node manager container

You can start an instance of the Spotfire node manager container with: 

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

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 ⧉.

Adding services to the node manager

Prerequisites:

As with on-premises deployment, you can manually add Spotfire services to be managed by the Spotfire node manager as described below.

IMPORTANT: This image recipe is provided only for reference and testing purposes. Installation of Spotfire services in this image requires installation of additional software and changes to the Spotfire services configuration. Instead of installing services in this image, use the specialized container images to run the Spotfire services. For example, the spotfire-pythonservice or the spotfire-webplayer.

Note: A Spotfire service running on a node manager runs in a separate process.

Note: In bare-metal or VM configurations, a node manager can control several Spotfire services in the same host and each Spotfire service can manage multiple instances. When running in containers, create only one Spotfire service and one Spotfire service instance in that service for each running container instance.

You can automatically add the Spotfire service in the container on startup by providing a default Spotfire services configuration file. For example: 

docker run -d --rm -e ACCEPT_EUA=Y \
  -e SERVER_BACKEND_ADDRESS=spotfire-server \
  -v "$(pwd)/default.conf:/opt/spotfire/nodemanager/nm/config/default-container.conf" \
  spotfire/spotfire-nodemanager

For more information, see Automatically installing services ⧉.

Note: Do not mount over /opt/spotfire/nodemanager/nm/config/default.conf (as described in the product documentation), because this file is deleted during startup. Instead, follow the example provided above.

Note: The Spotfire service installation files are copied in the image under /opt/spotfire/nodemanager/services/.

Environment variables