Skip to content

Latest commit

 

History

History
118 lines (82 loc) · 7.47 KB

README.md

File metadata and controls

118 lines (82 loc) · 7.47 KB
Raw

Cloud Deployment Kit for Spotfire

Overview

The Cloud Deployment Kit for Spotfire® provides a reference and starting point for deploying Spotfire® using containers and Helm charts on a Kubernetes cluster.

This repository contains recipes to build container images and Helm charts for certain Spotfire® products. You can extend and customize these recipes and examples.

This repository does not include Spotfire® software or other third party software. This repository contains quick guides, templates, configuration examples, and scripts.

The recipes have been validated with the Spotfire® releases identified in Spotfire components versions. They might work for other Spotfire versions with some modifications. For more information, see how versions are related.

Note: Spotfire products are commercially licensed products and are subject to the payment of license fees. You must have a valid license for each of the Spotfire applications you choose to build and run in a container. Additional license fees might be due to Cloud Software Group for the license rights required to deploy a Spotfire product to a Cloud Computing Environment. Carefully review the Cloud Computing Environment Licensing Policy (“CCEL Policy") to understand the requirements, including how to calculate the number of Processor Units that you must license when a Spotfire product is deployed in a Cloud Computing Environment.

Prerequisites

  • Spotfire Installation Packages: Required packages are listed in containers/build-files.mk. You can download them from TIBCO eDelivery.
  • Linux Host: A Linux host with permissions to build and execute the containers. This can be a bare metal server, a virtual machine, or WSL on Windows.
  • OCI-Compliant Container Image Building Tool: An OCI-compliant tool like docker or podman for building the container images.
  • GNU Make 3.82+: Ensure make is installed on your system to use the provided Makefiles for building the images and charts.
  • Kubernetes 1.24+: A working Kubernetes cluster from a certified K8s distro (required for deploying the charts and containers).
  • Helm 3+: For building and deploying the charts (required for deploying the charts and containers).

Components

The following applications have been validated in this Cloud Deployment Kit (CDK) for Spotfire:

  • Spotfire® Server
  • Spotfire® Web Player
  • Spotfire® Automation Services
  • Spotfire® Service for Python
  • Spotfire® Service for R
  • Spotfire® Enterprise Runtime for R - Server Edition (a/k/a TERR service)

Note: For more information on Spotfire® and its components, see the Spotfire® Documentation.

Using the provided charts, you can also deploy the following:

  • The required Spotfire Server® database schemas on a supported database server (for example, PostgreSQL).
  • A reverse proxy (HAProxy) for accessing the Spotfire Server cluster service, with session affinity for external HTTP access.
  • An Ingress with routing rules for accessing the configured reverse proxy.
  • Shared storage locations (Persistent Volumes) for the Spotfire Library import and export, custom jars, deployment packages, and so on.

Note: For information on sizing and supported third party software, see the System requirements for Spotfire® products.

Basic workflow

  1. Fetch the required Spotfire installation packages.
  2. Build and push the Spotfire container images.
  3. Build and publish the Spotfire helm charts.
  4. Deploy your Spotfire environment using the Spotfire helm charts.

Issues

You are welcome to raise issues and improvements related to this project in the GitHub Issues tab.

For issues related to the Spotfire products, use the support channel.

For improvements related to the Spotfire products, use the Ideas portal.

When reporting issues or seeking help make sure to collect as much relevant information as possible. Example of such information include:

  • Description of the issue, including any error messages
  • Steps to reproduce the issue, including commands and values used
  • Time and date, identifiers such as usernames, file paths
  • Helm, container and Kubernetes versions
  • Any other relevant information

The script generate-troubleshooting-bundle.sh can be used as starting point when collecting information from a Spotfire Helm deployment.

For issues related to third party products, see their respective documentation.

Licenses

This project (Cloud Deployment Kit for Spotfire) is licensed under the Apache 2.0 License.

Spotfire software

When you build and use the Spotfire container images, you fetch and use Spotfire software developed at Cloud Software Group, Inc. The Spotfire software running in these containers will be governed by the terms of the Cloud Software Group, Inc. End User Agreement.

Each of the Spotfire container images includes the applicable Spotfire application license file(s), which include a copy of the Cloud Software Group, Inc. End User Agreement, and the list of included Open Source Software components with their associated licenses. This list was generated using third party software as of the date listed in the file. This list may change with specific application versions of the product and may not be complete; it is provided “As-Is.”

See how to fetch the applicable Spotfire application license file(s) from the container images.

Other software

When you build and use the container images, you fetch and use other software components that are subject to their own licenses. See how to analyze container images to identify included artifacts and their individual licenses.

When you build and use the Helm charts, you fetch and use other charts that might fetch other container images, each with their own licenses. A partial summary of the third party software and licenses used in this project is available here.

Copyright 2022-2024 Cloud Software Group, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.