A Helm chart for TIBCO Spotfire Automation Services.
Homepage: https://github.com/TIBCO/Spotfire-cloud-deployment-kit
Kubernetes: >=1.24.0-0
Repository | Name | Version |
---|---|---|
file://../spotfire-common | spotfire-common | 0.1.7 |
This chart deploys the TIBCO Spotfire® Automation Services service on a Kubernetes cluster using the Helm package manager.
The Automation Services pod includes:
- A Fluent Bit sidecar container for log forwarding.
- Service annotations for Prometheus scrapers. The Prometheus server discovers the service endpoint using these specifications and scrapes metrics from the exporter.
- Predefined configuration for horizontal pod autoscaling with KEDA and Prometheus.
This chart is tested to work with Elasticsearch, Prometheus and KEDA.
- A deployed Spotfire Server release using the Spotfire Server chart.
- A Spotfire distribution file (
Spotfire.Dxp.sdn
orSpotfire.Dxp.netcore-linux.sdn
) with client packages deployed to a deployment area (so that the required licenses are in place for the Spotfire Automation Services to start).
- Export the
SPOTFIRE_SERVER
value to connect to thespotfire-server
service:export SPOTFIRE_SERVER=$(kubectl get services --selector=app.kubernetes.io/part-of=spotfire,app.kubernetes.io/name=spotfire-server --output=jsonpath={.items..metadata.name})
- Forward the logs to the
log-forwarder
service:export LOG_FORWARDER=$(kubectl get services --selector=app.kubernetes.io/part-of=spotfire,app.kubernetes.io/name=log-forwarder --output=jsonpath={.items..metadata.name})
- Install this chart with the release name
my-release
and custom values frommy-values.yaml
:helm install my-release . \ --set acceptEUA=true \ --set global.spotfire.image.registry="127.0.0.1:32000" \ --set global.spotfire.image.pullPolicy="Always" \ --set nodemanagerConfig.serverBackendAddress="$SPOTFIRE_SERVER" \ --set logging.logForwarderAddress="$LOG_FORWARDER" \ -f my-values.yaml
Note: This TIBCO Spotfire Helm chart requires setting the parameter acceptEUA
or the parameter global.spotfire.acceptEUA
to the value true
.
By doing so, you agree that your use of the TIBCO Spotfire software running in the managed containers will be governed by the terms of the Cloud Software Group, Inc. End User Agreement.
Note: You must provide your private registry address where the Spotfire container images are stored.
See helm install for command documentation.
You can override the default configuration settings by providing a custom configuration file.
The following example configuration keys are available in the chart:
- config."Spotfire.Dxp.Worker.Automation.config"
- config."Spotfire.Dxp.Worker.Core.config"
- config."Spotfire.Dxp.Worker.Web.config"
- config."Spotfire.Dxp.Worker.Host.dll.config"
- config."log4net.config"
Note: If a configuration file key is non-empty, it overrides the default service configuration file built in the container image.
See Service configuration files and Service logs configuration.
Example: Use my-Spotfire.Dxp.Worker.Automation.config
instead of the default Spotfire.Dxp.Worker.Automation.config
:
helm install my-release . \
--set acceptEUA=true \
--set nodemanagerConfig.serverBackendAddress="$SPOTFIRE_SERVER" \
--set logging.logForwarderAddress="$LOG_FORWARDER" \
--set-file config.'Spotfire\.Dxp\.Worker\.Automation\.config'=my-Spotfire.Dxp.Worker.Automation.config
Note: The keys are quoted because they contain periods. When you set them from the command line, you must escape the periods with a ''.
You can copy the default configuration files from the container image to use them as templates for your custom configuration.
Note: The configuration files content can be version dependent.
Example: Use the following command to get a copy of the original configuration file Spotfire.Dxp.Worker.Automation.config
.
You can replace the file name to get a copy any of the other container configuration files.
docker cp $(docker run -e ACCEPT_EUA=Y --detach --rm --entrypoint=sleep tibco/spotfire-automationservices:<imagetag> 5):/opt/tibco/tsnm/nm/services/AUTOMATION_SERVICES/Spotfire.Dxp.Worker.Automation.config .
The image uses the modules that are built into the image and does not download images from or use a Spotfire deployment area. To use your own custom deployment files (or modules) you can use the argument volumes.customModules
to set a Volume that will be used for loading extra custom modules. See helm/examples/webplayer-custom-modules/README.md in the Spotfire Cloud Deployment Kit repository for an example of how to use this feature.
To uninstall/delete the my-release
deployment:
helm uninstall my-release
See helm uninstall for command documentation.
For scaling the my-release
deployment, do a helm upgrade, providing the target number of pod instances in the replicaCount
variable.
helm upgrade --install my-release . --reuse-values --set replicaCount=3
To use KEDA for autoscaling, first install it in the Kubernetes cluster. You must also install a Prometheus instance that scrapes metrics from the Spotfire pods.
Example: A values.yml
snippet configuration for enabling autoscaling with KEDA:
kedaAutoscaling:
enabled: true
spotfireConfig:
prometheusServerAddress: http://prometheus-server.monitor.svc.cluster.local
threshold: 6
minReplicas: 0
maxReplicas: 3
The spotfire-automationservices
has the following autoscaling defaults:
- metric:
spotfire_Jobs_QueueSize
(Jobs Queue Size of the Automation Services instances). - query: the max
spotfire_Jobs_QueueSize
within the measurement interval for the release name.
With these default settings, if the queue reaches the configured threshold, then another instance is started to scale out the service. If the queue size falls below the threshold, then the service scales in.
Note: You can tune nodemanagerConfig.preStopDrainingTimeoutSeconds
and other timeouts for long-running tasks, so that jobs are not aborted prematurely when an instance is stopped to scale in.
Note: The metric used for autoscaling is scraped from the Spotfire Servers, so if there are more than one Spotfire Server Helm releases in the same namespace, kedaAutoscaling.spotfireConfig.spotfireServerHelmRelease
must also be set.
For more advanced scenarios, see kedaAutoscaling.advanced and kedaAutoscaling.fallback.
Additionally, you can define your own custom scaling triggers. Helm template functionality is available:
kedaAutoscaling:
triggers:
# {list of triggers to activate scaling of the target resource}
Note: For more details on the autoscaling defaults, see the keda-autoscaling.yaml template.
See helm upgrade for command documentation.
When you upgrade to a newer Spotfire Server version and newer Spotfire services versions, upgrade the Spotfire Server first, and then upgrade the Spotfire services.
Some parameters might have been changed, moved or renamed and must be taken into consideration when upgrading the release. See RELEASE-NOTES.md for details.
Key | Type | Default | Description |
---|---|---|---|
acceptEUA | bool | nil |
Accept the Cloud Software Group, Inc. End User Agreement by setting the value to true . |
affinity | object | {} |
|
config."Spotfire.Dxp.Worker.Automation.config" | string | "" |
A custom Spotfire.Dxp.Worker.Automation.config. |
config."Spotfire.Dxp.Worker.Core.config" | string | "" |
A custom Spotfire.Dxp.Worker.Core.config. |
config."Spotfire.Dxp.Worker.Host.dll.config" | string | "" |
A custom Spotfire.Dxp.Worker.Host.dll.config. See Spotfire.Dxp.Worker.Host.exe.config. |
config."Spotfire.Dxp.Worker.Web.config" | string | "" |
A custom Spotfire.Dxp.Worker.Web.config. |
extraEnvVars | list | [] |
Additional environment variables. |
extraEnvVarsCM | string | "" |
The name of the ConfigMap containing additional environment variables. |
extraEnvVarsSecret | string | "" |
The name of the Secret containing extra additional environment variables. |
extraInitContainers | list | [] |
Additional init containers to add to the service pod. |
extraVolumeMounts | list | [] |
Extra volumeMounts for the service container. More info: kubectl explain deployment.spec.template.spec.containers.volumeMounts . |
extraVolumes | list | [] |
Extra volumes for the service container. More info: kubectl explain deployment.spec.template.spec.volumes . |
fluentBitSidecar.image.pullPolicy | string | "IfNotPresent" |
The image pull policy for the fluent-bit logging sidecar image. |
fluentBitSidecar.image.repository | string | "fluent/fluent-bit" |
The image repository for fluent-bit logging sidecar. |
fluentBitSidecar.image.tag | string | "2.1.2" |
The image tag to use for fluent-bit logging sidecar. |
fluentBitSidecar.securityContext | object | {} |
The securityContext setting for fluent-bit sidecar container. Overrides any securityContext setting on the Pod level. |
fullnameOverride | string | "" |
|
global.spotfire.acceptEUA | bool | nil |
Accept the Cloud Software Group, Inc. End User Agreement by setting the value to true . Overrides the value of acceptEUA. |
global.spotfire.image.pullPolicy | string | "IfNotPresent" |
The global container image pull policy. |
global.spotfire.image.pullSecrets | list | [] |
The global container image pull secrets. |
global.spotfire.image.registry | string | nil |
The global container image registry. Used for tibco/spotfire container images, unless it is overridden. |
image.pullPolicy | string | nil |
The spotfire-server image pull policy. Overrides global.spotfire.image.pullPolicy. |
image.pullSecrets | list | [] |
Image pull secrets. |
image.registry | string | nil |
The image registry for spotfire-server. Overrides global.spotfire.image.registry value. |
image.repository | string | "tibco/spotfire-automationservices" |
The spotfire-server image repository. |
image.tag | string | "12.5.0-1.5.0" |
The container image tag to use. |
kedaAutoscaling | object | {"advanced":{},"cooldownPeriod":300,"enabled":false,"fallback":{},"maxReplicas":4,"minReplicas":0,"pollingInterval":30,"spotfireConfig":{"prometheusServerAddress":"http://prometheus-server.monitor.svc.cluster.local","spotfireServerHelmRelease":null},"threshold":8,"triggers":[]} |
KEDA autoscaling configuration. See https://keda.sh/docs/latest/concepts/scaling-deployment for more details. |
kedaAutoscaling.cooldownPeriod | int | 300 |
The period to wait after the last trigger reported active before scaling the resource back to 0. |
kedaAutoscaling.maxReplicas | int | 4 |
This setting is passed to the HPA definition that KEDA creates for a given resource and holds the maximum number of replicas of the target resource. |
kedaAutoscaling.minReplicas | int | 0 |
The minimum number of replicas KEDA scales the resource down to. |
kedaAutoscaling.pollingInterval | int | 30 |
The interval to check each trigger on. |
kedaAutoscaling.spotfireConfig | object | {"prometheusServerAddress":"http://prometheus-server.monitor.svc.cluster.local","spotfireServerHelmRelease":null} |
Spotfire specific settings. |
kedaAutoscaling.spotfireConfig.prometheusServerAddress | string | "http://prometheus-server.monitor.svc.cluster.local" |
REQUIRED. The URL for the Prometheus server from where metrics are fetched. |
kedaAutoscaling.spotfireConfig.spotfireServerHelmRelease | string | nil |
If more than one Spotfire Server release is installed in the same namespace, specify the release to get the correct metrics. |
livenessProbe.enabled | bool | true |
|
livenessProbe.failureThreshold | int | 10 |
|
livenessProbe.httpGet.path | string | "/spotfire/liveness" |
|
livenessProbe.httpGet.port | string | "registration" |
|
livenessProbe.initialDelaySeconds | int | 60 |
|
livenessProbe.periodSeconds | int | 3 |
|
logging.logForwarderAddress | string | "" |
The spotfire-server log-forwarder name. Template. |
logging.logLevel | string | "debug" |
Set to debug , trace , minimal , or leave empty for info. This applies for both node manager and the service. |
nameOverride | string | "" |
|
nodeSelector | object | {} |
|
nodemanagerConfig.preStopDrainingTimeoutSeconds | int | 610 |
The draining timeout after which the service is forcefully shut down. |
nodemanagerConfig.serverBackendAddress | string | "" |
The spotfire-server service name. This value is evaluated as a helm template. |
podAnnotations."prometheus.io/path" | string | "/spotfire/metrics" |
|
podAnnotations."prometheus.io/port" | string | "9080" |
|
podAnnotations."prometheus.io/scrape" | string | "true" |
|
podSecurityContext | object | {} |
The Pod securityContext setting applies to all of the containers inside the Pod. |
readinessProbe.enabled | bool | false |
|
readinessProbe.failureThreshold | int | 10 |
|
readinessProbe.httpGet.path | string | "/spotfire/readiness" |
|
readinessProbe.httpGet.port | string | "registration" |
|
readinessProbe.initialDelaySeconds | int | 60 |
|
readinessProbe.periodSeconds | int | 3 |
|
replicaCount | int | 1 |
|
resources | object | {} |
|
securityContext | object | {} |
The securityContext setting for the service container. Overrides any securityContext setting on the Pod level. |
service.port | int | 9501 |
|
service.type | string | "ClusterIP" |
|
serviceAccount.annotations | object | {} |
|
serviceAccount.create | bool | false |
|
serviceAccount.name | string | "" |
|
startupProbe.enabled | bool | true |
|
startupProbe.failureThreshold | int | 20 |
|
startupProbe.httpGet.path | string | "/spotfire/started" |
|
startupProbe.httpGet.port | string | "registration" |
|
startupProbe.initialDelaySeconds | int | 60 |
|
startupProbe.periodSeconds | int | 3 |
|
tolerations | list | [] |
|
volumes.customModules.existingClaim | string | "" |
When 'persistentVolumeClaim.create' is 'false', then use this value to define an already existing persistent volume claim. |
volumes.customModules.persistentVolumeClaim.create | bool | false |
If 'true', then a 'PersistentVolumeClaim' is created. |
volumes.customModules.persistentVolumeClaim.resources | object | {"requests":{"storage":"2Gi"}} |
Specifies the standard Kubernetes resource requests and/or limits for the volumes.customModules claims. |
volumes.customModules.persistentVolumeClaim.storageClassName | string | "" |
Specifies the name of the 'StorageClass' to use for the volumes.customModules-claim. |
volumes.customModules.persistentVolumeClaim.volumeName | string | nil |
Specifies the name of the persistent volume to use for the volumes.customModules-claim. |
volumes.customModules.subPath | string | "" |
The subPath of the volume to be used for the volume mount |
volumes.troubleshooting.existingClaim | string | "" |
When 'persistentVolumeClaim.create' is 'false', then use this value to define an already existing persistent volume claim. |
volumes.troubleshooting.persistentVolumeClaim.create | bool | false |
If 'true', then a 'PersistentVolumeClaim' will be created. |
volumes.troubleshooting.persistentVolumeClaim.resources | object | {"requests":{"storage":"2Gi"}} |
Specifies the standard Kubernetes resource requests and/or limits for the volumes.troubleshooting claims. |
volumes.troubleshooting.persistentVolumeClaim.storageClassName | string | "" |
Specifies the name of the 'StorageClass' to use for the volumes.troubleshooting-claim. |
volumes.troubleshooting.persistentVolumeClaim.volumeName | string | nil |
Specifies the name of the persistent volume to use for the volumes.troubleshooting-claim. |