Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spotfiresoftware/spotfire-cloud-deployment-kit

Vanilla recipes to build container images and Helm charts for Spotfire®
https://github.com/spotfiresoftware/spotfire-cloud-deployment-kit

charts containers helm helm-charts kubernetes spotfire

Last synced: 3 months ago
JSON representation

Vanilla recipes to build container images and Helm charts for Spotfire®

Awesome Lists containing this project

README 

        
# Cloud Deployment Kit for Spotfire



## Overview



The **Cloud Deployment Kit for Spotfire®** provides a reference and starting point for deploying [Spotfire®](https://www.spotfire.com/) using [containers](https://www.docker.com/resources/what-container) and [Helm charts](https://helm.sh/) on a [Kubernetes cluster](http://kubernetes.io/).



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](versions.mk).

They might work for other Spotfire versions with some modifications.

For more information, see [how versions are related](docs/how-versions-are-related.md).



**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")](https://www.cloud.com/content/dam/cloud/documents/legal/tibco-cloud-computing-environment-licensing-policy.pdf) 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



- Required Spotfire installation packages. If you have a TIBCO account, you can download the packages from [TIBCO eDelivery](https://edelivery.tibco.com/storefront/index.ep).

- Kubernetes 1.24+, a working Kubernetes cluster from a [certified K8s distro](https://www.cncf.io/certification/software-conformance/).

- Helm 3+, for building and deploying the charts.

- An [OCI-compliant](https://opencontainers.org/) container image building tool (for example, `docker`, `podman`, or alternative), for building the container images.



## 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](https://spotfi.re/docs).



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](https://www.haproxy.org/)) for accessing the Spotfire Server cluster service, with session affinity for external HTTP access.

- An [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) with routing rules for accessing the configured reverse proxy.

- Shared storage locations ([Persistent Volumes](https://kubernetes.io/docs/concepts/storage/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](https://spotfi.re/sr/).



## Basic workflow



1. Fetch the required [Spotfire installation packages](containers/README.md#prerequisites).

2. Build and push the [Spotfire container images](containers/README.md#build-the-images).

3. Build and publish the [Spotfire helm charts](helm/README.md#building-the-charts).

4. Deploy your Spotfire environment using the [Spotfire helm charts](helm/README.md).



# Issues



You are welcome to raise issues and improvements related to this project in the [GitHub Issues tab](https://github.com/spotfiresoftware/spotfire-cloud-deployment-kit/issues).



For issues related to the Spotfire products, use the [support channel](https://spotfi.re/support).



For improvements related to the Spotfire products, use the [Ideas portal](https://spotfi.re/ideas).



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](LICENSE).



## Spotfire software



When you build and use the Spotfire container images, you fetch and use Spotfire software developed at

[Cloud Software Group, Inc.](https://www.cloud.com/)

The Spotfire software running in these containers will be governed by the terms of the [Cloud Software Group, Inc. End User Agreement](https://www.cloud.com/legal/terms).



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](./containers/README.md#licenses).



## 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](docs/analyze-container-image-licenses.md).



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](docs/third-party-software-licenses.md).



---



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](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.