Using pre-built Spotfire artifacts from the OCI Registry
The Spotfire container images and Helm charts are hosted on the Spotfire OCI registry at oci.spotfire.com.
The Spotfire OCI registry is an OCI (Open Container Initiative) ⧉ compliant registry. An OCI registry is a service that stores and distributes container images and other OCI artifacts. It follows the OCI Distribution Specification ⧉, which defines a standard API for container image distribution. This allows users to push, pull, and manage container images and Helm charts in a consistent and interoperable manner across different platforms and tools.
This guide is for users who want to utilize pre-built Spotfire container images and Helm charts provided by Spotfire. If you prefer to build your own images or charts, or modify the existing ones, refer to the Spotfire Cloud Deployment Kit ⧉ on GitHub.
Accessing the Spotfire OCI Registry
To request access to the Spotfire OCI registry, follow these steps:
- Open a support case via the Support Portal ⧉ stating that you want access to the Spotfire OCI registry. Make sure you select "Spotfire Server" as the Product when creating the case.
- Support will provide you with the necessary access credentials along with any additional instructions.
With these credentials, you can pull container images and charts from the Spotfire OCI registry. Set the username and password provided by support in your shell using the following commands:
To log in to the registry for Helm charts, use the following command:
To log in to the registry for container images, use the following command:
Now you are ready to install Spotfire directly from the OCI registry. Refer to Deploying Spotfire on Kubernetes after you have logged in.
Using the Spotfire OCI Registry
To pull Spotfire container images and Helm charts from the Spotfire OCI registry, follow the procedures below. You can also push them to your private registry, if preferred.
This guide uses curl to list available images and charts via the standard Registry HTTP API ⧉, but other tools can also be used. Additionally, you can visit the Spotfire Cloud Deployment Kit releases page ⧉ on GitHub to view available images and tags.
Helm charts
To list available Helm charts in the Spotfire OCI registry, use the following curl commands:
List charts in the registry:
List versions for a specific chart:
curl --user $REGISTRY_USERNAME:$REGISTRY_PASSWORD https://oci.spotfire.com/v2/charts/spotfire-server/tags/list
To pull the Spotfire server chart with a specific version, use the following command:
To transfer Helm charts to your private registry, use the following commands:
helm pull oci://oci.spotfire.com/charts/spotfire-server --version 1.0.0
helm push spotfire-server-<version>.tgz <your-chart-registry>/spotfire/spotfire-server
Repeat the above steps for each Spotfire Helm chart.
Container images
To list available images and charts in the Spotfire OCI registry, use the following curl commands:
List images in the registry:
List tags for a specific image:
curl --user $REGISTRY_USERNAME:$REGISTRY_PASSWORD https://oci.spotfire.com/v2/spotfire/spotfire-server/tags/list
To pull a container image, log in to the registry and pull the desired image:
For example, to pull the Spotfire server image with tag 14.5.0-v3.0.0:
To transfer images to your private registry, use the following commands for each image:
docker pull oci.spotfire.com/spotfire/spotfire-server:14.5.0-v3.0.0
docker tag oci.spotfire.com/spotfire/spotfire-server:14.5.0-v3.0.0 <your-container-registry>/spotfire/spotfire-server:14.5.0-v3.0.0
docker push <your-container-registry>/spotfire/spotfire-server:14.5.0-v3.0.0
Note: The spotfire-server is used as an example. Replace it with the actual image name and tag you intend to use.