helm


Speckle | Helm Chart

Helm chart for deploying Speckle server to Kubernetes

Speckle is data infrastructure for the AEC industry.


Twitter Follow Community forum users website docs

About Speckle

What is Speckle? Check our YouTube Video Views

Features

Try Speckle now!

Give Speckle a try in no time by:

Speckle Server Helm Charts

This Helm chart bundles all Speckle developed components of the Speckle server deployment. Please note that data storage and persistence requirements of the app are not installed by the chart, as these are external dependencies. The required dependencies are listed in our deployment dependencies page.

Usage

A full guide to deploying on Kubernetes can be found in Speckle’s Documentation, we recommend that you follow this guide if you are new to Kubernetes or Helm.

The below are brief notes which will require additional dependencies and configuration.

Pre-requisite

Helm must be installed to use the charts. Please refer to Helm’s documentation to get started.

Instructions

Once Helm has been set up correctly, add the repo as follows:

$ helm repo add speckle https://specklesystems.github.io/helm

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages. You can then run helm search repo speckle to see the charts.

To install the speckle-server chart:

$ helm upgrade --install --create-namespace --namespace speckle-test my-speckle-server speckle/speckle-server

where my-speckle-server will be the name of the Helm release.

More details about the values to configure for your release can be found in Speckle’s Documentation

By default the chart will install in the speckle-test namespace, that name can be set in the chart values.

Uninstalling

To uninstall the chart:

$ helm uninstall my-speckle-server --namespace speckle-test

Depending on the Infrastructure on which Speckle was released, a load balancer may have been created. This may have to be manually deleted.

Parameters

Namespace

Name Description Value
namespace The name of the namespace in which Speckle will be deployed. speckle-test
create_namespace Enabling this will create a new namespace into which Speckle will be deployed false

SSL

Name Description Value
domain The DNS host name at which this Speckle deployment will be reachable localhost
ssl_canonical_url HTTPS protocol will be the preferred protocol for serving this Speckle deployment true
tlsRejectUnauthorized If ‘1’ (true), Speckle will reject any SSL certificates that are not signed by a trusted Certificate Authority. Should only be disabled in a trusted local development environment. https://nodejs.org/api/cli.html#node_tls_reject_unauthorizedvalue 1
cert_manager_issuer The name of the ClusterIssuer kubernetes resource that provides the SSL Certificate letsencrypt-staging

Feature flags

This object is a central location to define feature flags for the whole chart.

Name Description Value
featureFlags.automateModuleEnabled High level flag fully toggles the integrated automate module false
analytics.enabled Enable or disable analytics true
analytics.mixpanel_token_id The Mixpanel token ID used to identify this Speckle deployment in MixPanel acd87c5a50b56df91a795e999812a3a4
analytics.mixpanel_api_host The Mixpanel API host to which analytics data will be sent https://analytics.speckle.systems

Network Plugin configuration

This is used to define the type of network policy that is deployed. Different Kubernetes Network Plugins or Container Network Interfaces (CNIs) can make use of different types of Network Policy. Some of these provide more features than the standard Kubernetes Network Policy.

Name Description Value
networkPlugin.type (Optional) Used to configure which type of NetworkPolicy is deployed. Options are ‘kubernetes’ or ‘cilium’. kubernetes

Ingress metadata for NetworkPolicy

This section is ignored unless networkPolicy is enabled for frontend or server. The NetworkPolicy uses this value to enable connections from the ingress controller pod in this namespace to reach Speckle. ref: https://kubernetes.io/docs/concepts/services-networking/network-policies/

Name Description Value
ingress.namespace The namespace in which the ingress controller is deployed. ingress-nginx
ingress.controllerName The name of the Kubernetes pod in which the ingress controller is deployed. ingress-nginx

Common parameters

Name Description Value
docker_image_tag Speckle is published as a Docker Image. The version of the image which will be deployed is specified by this tag. 2
imagePullPolicy Determines the conditions when the Docker Images for Speckle should be pulled from the Image registry. IfNotPresent
secretName Deprecated, please use individual secret parameters. This is the name of the Kubernetes Secret resource in which secrets for Speckle are stored. Secrets within this Secret resource may include Postgres and Redis connectin strings, S3 secret values, email server passwords, etc.. server-vars
file_size_limit_mb This maximum size of any single file (unit is Megabytes) that can be uploaded to Speckle 100

Monitoring

This enables metrics generated by Speckle to be ingested by Prometheus: https://prometheus.io/ Enabling this requires Prometheus to have been deployed prior, as this resource expects the Prometheus Customer Resource Definition for the ServiceMonitor to already be existing within the cluster. ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md#related-resources

Name Description Value
enable_prometheus_monitoring If enabled, Speckle deploys a Prometheus ServiceMonitor resource false
prometheusMonitoring.namespace If provided, deploys Speckle’s Prometheus resources (e.g. ServiceMonitor) in the given namespace ""
prometheusMonitoring.release If provided, adds the value to a release label on all the Prometheus resources deployed by Speckle ""
prometheusMonitoring.networkPolicy.inCluster Parameters for allowing ingress from the Prometheus pod that will scrape this Speckle release. It is assumed that Prometheus is deployed within the Kubernetes cluster.  
prometheusMonitoring.networkPolicy.inCluster.kubernetes.podSelector (Kubernetes Network Policy only) The pod Selector yaml object used to uniquely select the prometheus pods within the cluster and given namespace {}
prometheusMonitoring.networkPolicy.inCluster.kubernetes.namespaceSelector (Kubernetes Network Policy only) The namespace selector yaml object used to uniquely select the namespace in which the prometheus pods are deployed {}
prometheusMonitoring.networkPolicy.inCluster.cilium.fromEndpoints (Cilium Network Policy only) The endpoint selector yaml object used to uniquely select the in-cluster endpoint in which the prometheus pods are deployed []

Postgres Database

Defines parameters related to connections to the Postgres database.

Name Description Value
db.useCertificate If enabled, the certificate defined in db.certificate is used to verify TLS connections to the Postgres database false
db.maxConnectionsServer The number of connections to the Postgres database to provide in the connection pool 4
db.certificate The x509 public certificate for SSL connections to the Postgres database. Use of this certificate requires db.useCertificate to be enabled and an appropriate value for db.PGSSLMODE provided. ""
db.PGSSLMODE This defines the level of security used when connecting to the Postgres database require
db.connectionString.secretName Required. A secret containing the full connection string to the Postgres database (e.g. in format of protocol://username:password@host:port/database) stored within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
db.connectionString.secretKey Required. The key within the Kubernetes Secret holding the connection string. ""
db.networkPolicy If networkPolicy is enabled for any service, this provides the NetworkPolicy with the necessary details to allow egress connections to the Postgres database  
db.networkPolicy.externalToCluster Only required if the Postgres database is not hosted within the Kubernetes cluster in which Speckle will be deployed.  
db.networkPolicy.externalToCluster.enabled If enabled, indicates that the Postgres database is hosted externally to the Kubernetes cluster true
db.networkPolicy.inCluster Only required if the Postgres database is hosted within the Kubernetes cluster in which Speckle will be deployed.  
db.networkPolicy.inCluster.enabled If enabled, indicates that the Postgres database is hosted withing the same Kubernetes cluster in which Speckle will be deployed false
db.networkPolicy.inCluster.port the port on the server providing the Postgres database (default: “5432”) ""
db.networkPolicy.inCluster.kubernetes.podSelector (Kubernetes Network Policy only) The pod Selector yaml object used to uniquely select the postgres compatible database pods within the cluster and given namespace {}
db.networkPolicy.inCluster.kubernetes.namespaceSelector (Kubernetes Network Policy only) The namespace selector yaml object used to uniquely select the namespace in which the postgres compatible database pods are deployed {}
db.networkPolicy.inCluster.cilium.endpointSelector (Cilium Network Policy only) The endpoint selector yaml object used to uniquely select the in-cluster endpoint in which the postgres compatible database pods are deployed {}
db.networkPolicy.inCluster.cilium.serviceSelector (Cilium Network Policy only) The service selector yaml object used to uniquely select the in-cluster service providing the postgres compatible database service {}

S3 Compatible Storage

Defines parameters related to connecting to the S3 compatible storage.

Name Description Value
s3.configMap.enabled If enabled, the s3.endpoint, s3.bucket, and s3.access_key values will be determined from a configMap and the values provided in this helm release ignored. false
s3.configMap.name The name of the ConfigMap in which values for the keys (endpoint, bucket, and access_key) are provided. Expected to be in the namespace defined by the namespace parameter of this Helm Chart. ""
s3.endpoint The URL at which the s3 compatible storage is hosted. If s3.configMap.enabled is true, this value is ignored. ""
s3.bucket The s3 compatible bucket in which Speckle data will be stored. If s3.configMap.enabled is true, this value is ignored. ""
s3.access_key The key of the access key used to authenticate with the s3 compatible storage. If s3.configMap.enabled is true, this value is ignored. ""
s3.secret_key.secretName Required. A Kubernetes secret containing the s3 secret_key. This is expected to be the name of an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
s3.secret_key.secretKey Required. The key within the Kubernetes Secret, the value of which is the s3 secret. ""
s3.create_bucket If enabled, will create a bucket with the given bucket name at this endpoint false
s3.region The region in which the bucket resides (or will be created in). ""
s3.networkPolicy If networkPolicy is enabled for any service, this provides the NetworkPolicy with the necessary details to allow egress connections to the s3 compatible storage  
s3.networkPolicy.port the port on the server providing the s3 compatible storage (default: “443”) ""
s3.networkPolicy.externalToCluster Only required if the s3 compatible storage is not hosted within the Kubernetes cluster in which Speckle will be deployed.  
s3.networkPolicy.externalToCluster.enabled If enabled, indicates that the s3 compatible storage is hosted externally to the Kubernetes cluster true
s3.networkPolicy.inCluster Only required if the s3 compatible storage is hosted within the Kubernetes cluster in which Speckle will be deployed.  
s3.networkPolicy.inCluster.enabled If enabled, indicates that the s3 compatible storage is hosted withing the same Kubernetes cluster in which Speckle will be deployed false
s3.networkPolicy.inCluster.kubernetes.podSelector (Kubernetes Network Policy only) The pod Selector yaml object used to uniquely select the s3 compatible storage pods within the cluster and given namespace {}
s3.networkPolicy.inCluster.kubernetes.namespaceSelector (Kubernetes Network Policy only) The namespace selector yaml object used to uniquely select the namespace in which the s3 compatible storage pods are deployed {}
s3.networkPolicy.inCluster.cilium.endpointSelector (Cilium Network Policy only) The endpoint selector yaml object used to uniquely select the in-cluster endpoint in which the s3 compatible storage pods are deployed {}
s3.networkPolicy.inCluster.cilium.serviceSelector (Cilium Network Policy only) The service selector yaml object used to uniquely select the in-cluster service providing the s3 compatible storage service {}

Redis Store

Defines parameters related to connecting to the Redis Store.

Name Description Value
redis.connectionString.secretName Required. A secret containing the full connection string to the Redis store (e.g. in format of protocol://username:password@host:port/database) stored within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
redis.connectionString.secretKey Required. The key within the Kubernetes Secret holding the Redis connection string. ""
redis.networkPolicy If networkPolicy is enabled for Speckle server, this provides the NetworkPolicy with the necessary details to allow egress connections to the Redis store  
redis.networkPolicy.externalToCluster Only required if the Redis store is not hosted within the Kubernetes cluster in which Speckle will be deployed.  
redis.networkPolicy.externalToCluster.enabled If enabled, indicates that the Redis store is hosted externally to the Kubernetes cluster true
redis.networkPolicy.inCluster is only required if the Redis store is hosted within the Kubernetes cluster in which Speckle will be deployed.  
redis.networkPolicy.inCluster.enabled If enabled, indicates that the Redis store is hosted withing the same Kubernetes cluster in which Speckle will be deployed false
redis.networkPolicy.inCluster.port the port on the server providing the Redis store (default: “6379”) ""
redis.networkPolicy.inCluster.kubernetes.podSelector (Kubernetes Network Policy only) The pod Selector yaml object used to uniquely select the redis store pods within the cluster and given namespace {}
redis.networkPolicy.inCluster.kubernetes.namespaceSelector (Kubernetes Network Policy only) The namespace selector yaml object used to uniquely select the namespace in which the redis store pods are deployed {}
redis.networkPolicy.inCluster.cilium.endpointSelector (Cilium Network Policy only) The endpoint selector yaml object used to uniquely select the in-cluster endpoint in which the redis pods are deployed {}
redis.networkPolicy.inCluster.cilium.serviceSelector (Cilium Network Policy only) The service selector yaml object used to uniquely select the in-cluster service providing the redis store service {}

Server

Defines parameters related to the backend server component of Speckle.

Name Description Value
server.replicas The number of instances of the Server pod to be deployed within the cluster. 1
server.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
server.image The Docker image to be used for the Speckle Server component. If blank, defaults to speckle/speckle-server:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
server.enableFe2Messaging If enabled, the related FE1 deployment will show banners/messages about the new frontend false
server.onboarding.stream_url The (cross-server) URL to the project/stream that should be used as the onboarding project base. https://latest.speckle.systems/projects/843d07eb10
server.onboarding.stream_cache_bust_number Increase this number to trigger the re-pulling of the base stream 1
server.inspect.enabled If enabled, indicates that the Speckle server should be deployed with the nodejs inspect feature enabled false
server.inspect.port The port on which the nodejs inspect feature should be exposed 7000
server.adminOverrideEnabled Enables the server side admin authz override false
server.weeklyDigestEnabled Enables sending out the serevr weekly digest emails false
server.max_object_size_mb The maximum size of an individual object which can be uploaded to the server 10
server.max_project_models_per_page The maximum number of models that can be returned in a single page of a query for all models of a project 500
server.speckleAutomateUrl The url of the Speckle Automate instance https://automate.speckle.systems
server.sessionSecret.secretName The name of the Kubernetes Secret containing the Session secret. This is a unique value (can be generated randomly). This is expected to be provided within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
server.sessionSecret.secretKey The key within the Kubernetes Secret holding the Session secret as its value. ""
server.auth Speckle provides a number of different mechanisms for authenticating users. Each available option must be configured here.  
server.auth.local.enabled If enabled, users can register and authenticate with an email address and password. true
server.auth.google.enabled If enabled, users can authenticate via Google with their Google account credentials. If enabling Google, the server.auth.google.client_id parameter is required, and a secret must be provided via the Kubernetes secret referenced in server.auth.google.clientSecret. false
server.auth.google.client_id This is the ID for Speckle that you have registered with Google. ""
server.auth.google.clientSecret.secretName The name of the Kubernetes Secret containing the Google client secret. This is expected to be provided within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
server.auth.google.clientSecret.secretKey The key within the Kubernetes Secret holding the Google client secret as its value. ""
server.auth.github.enabled If enabled, users can authenticate via Github with their Github account credentials. If enabling Github authentication, the server.auth.github.client_id parameter is required. false
server.auth.github.client_id This is the ID for Speckle that you have registered with Github ""
server.auth.github.clientSecret.secretName The name of the Kubernetes Secret containing the GitHub client secret. This is expected to be provided within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
server.auth.github.clientSecret.secretKey The key within the Kubernetes Secret holding the GitHub client secret as its value. ""
server.auth.azure_ad.enabled If enabled, users can authenticate via Azure Active Directory. false
server.auth.azure_ad.org_name This is the Organisation Name that you have registered with Azure ""
server.auth.azure_ad.identity_metadata This is the identity metadata for Speckle that you have registered with Azure ""
server.auth.azure_ad.issuer This is the issuer name for Speckle that you have registered with Azure ""
server.auth.azure_ad.client_id This is the ID for Speckle that you have registered with Azure ""
server.auth.azure_ad.clientSecret.secretName The name of the Kubernetes Secret containing the Azure AD client secret. This is expected to be provided within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
server.auth.azure_ad.clientSecret.secretKey The key within the Kubernetes Secret holding the Azure AD client secret as its value. ""
server.auth.azure_ad.additional_domains List of matchName or matchPattern maps for domains that should be allow-listed for egress in Network Policy. https://docs.microsoft.com/en-us/azure/azure-portal/azure-portal-safelist-urls?tabs=public-cloud are enabled by default. []
server.auth.azure_ad.port Port on server to connect to. Used to allow egress in Network Policy. Defaults to 443 443
server.auth.oidc.enabled If enabled, users can authenticate via OpenID Connect identity provider false
server.auth.oidc.name This is the name that you want displayed on the login button ""
server.auth.oidc.discovery_url This is the OIDC discovery URL for the identity provider you want to use ""
server.auth.oidc.client_id This is the ID for Speckle that you have registered with the OIDC identity provider ""
server.auth.oidc.clientSecret.secretName The name of the Kubernetes Secret containing the OIDC client secret. This is expected to be provided within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
server.auth.oidc.clientSecret.secretKey The key within the Kubernetes Secret holding the OIDC client secret as its value. ""
server.auth.oidc.domains List of matchName or matchPattern maps for domains that should be allow-listed for egress in Network Policy. []
server.email Speckle can communicate with users via email, providing account verification and notification.  
server.email.enabled If enabled, Speckle can send email to users - for example, email verification for account registration. false
server.email.host The domain name or IP address of the server hosting the email service. ""
server.email.port The port on the server for the email service. ""
server.email.from The email address from which Speckle will send emails. Defaults to ‘no-reply@speckle.systems’ if left blank. ""
server.email.username The username with which Speckle will authenticate with the email service. ""
server.email.password.secretName The name of the Kubernetes Secret containing the email password. This is expected to be provided within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
server.email.password.secretKey The key within the Kubernetes Secret holding the email password as its value. ""
server.email.networkPolicy If networkPolicy is enabled for Speckle server, this provides the Network Policy with the necessary details to allow egress connections to the email server  
server.email.networkPolicy.externalToCluster Only required if the Redis store is not hosted within the Kubernetes cluster in which Speckle will be deployed.  
server.email.networkPolicy.externalToCluster.enabled If enabled, indicates that the email server is hosted externally to the Kubernetes cluster true
server.email.networkPolicy.inCluster is only required if the email server is hosted within the Kubernetes cluster in which Speckle will be deployed.  
server.email.networkPolicy.inCluster.enabled If enabled, indicates that the email server is hosted withing the same Kubernetes cluster in which Speckle will be deployed false
server.email.networkPolicy.inCluster.kubernetes.podSelector (Kubernetes Network Policy only) The pod Selector yaml object used to uniquely select the email server pods within the cluster and given namespace {}
server.email.networkPolicy.inCluster.kubernetes.namespaceSelector (Kubernetes Network Policy only) The namespace selector yaml object used to uniquely select the namespace in which the email server pods are deployed {}
server.email.networkPolicy.inCluster.cilium.endpointSelector (Cilium Network Policy only) The endpoint selector yaml object used to uniquely select the in-cluster endpoint in which the email server pods are deployed {}
server.email.networkPolicy.inCluster.cilium.serviceSelector (Cilium Network Policy only) The service selector yaml object used to uniquely select the in-cluster service providing the email server {}
server.requests.cpu The CPU that should be available on a node when scheduling this pod. 1000m
server.requests.memory The Memory that should be available on a node when scheduling this pod. 1Gi
server.limits.cpu The maximum CPU that will be made available to the server Pod in a given period. 1500m
server.limits.memory The maximum Memory that will be made available to the server Pod. 3Gi
server.ratelimiting.all_requests The maximum number of requests that can be made to the Speckle server in a moving one second window. 500
server.ratelimiting.burst_all_requests If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server in a moving one minute window. 2000
server.ratelimiting.user_create The maximum number of requests that can be made to the Speckle server to create a new user in a moving one second window. 6
server.ratelimiting.burst_user_create If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to create a new user in a moving one minute window. 1000
server.ratelimiting.stream_create The maximum number of requests that can be made to the Speckle server to create a new stream in a moving one second window. 1
server.ratelimiting.burst_stream_create If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to create a new stream in a moving one minute window. 100
server.ratelimiting.commit_create The maximum number of requests that can be made to the Speckle server to create a new commit in a moving one second window. 1
server.ratelimiting.burst_commit_create If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to create a new commit in a moving one minute window. 100
server.ratelimiting.post_getobjects_streamid The maximum number of requests that can be made to the Speckle server to get a new object in a moving one second window. 3
server.ratelimiting.burst_post_getobjects_streamid If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to get a new object in a moving one minute window. 200
server.ratelimiting.post_diff_streamid The maximum number of requests that can be made to the Speckle server to undertake a diff in a moving one second window. 10
server.ratelimiting.burst_post_diff_streamid If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to undertake a diff in a moving one minute window. 1000
server.ratelimiting.post_objects_streamid The maximum number of requests that can be made to the Speckle server to post a new object in a moving one second window. 6
server.ratelimiting.burst_post_objects_streamid If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to post a new object in a moving one minute window. 400
server.ratelimiting.get_objects_streamid_objectid The maximum number of requests that can be made to the Speckle server to get an object in a moving one second window. 3
server.ratelimiting.burst_get_objects_streamid_objectid If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to get an object in a moving one minute window. 200
server.ratelimiting.get_objects_streamid_objectid_single The maximum number of requests that can be made to the Speckle server to get a single object in a moving one second window. 3
server.ratelimiting.burst_get_objects_streamid_objectid_single If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to get a single object in a moving one minute window. 200
server.ratelimiting.post_graphql The maximum number of requests that can be made to the GraphQL API in a moving one second window. 50
server.ratelimiting.burst_post_graphql If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the GraphQL API in a moving one minute window. 200
server.ratelimiting.get_auth The maximum number of requests that can be made to the Speckle server to authenticate in a moving 10 minute window. 4
server.ratelimiting.burst_get_auth If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to authenticate in a moving thirty minute window. 10
server.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true
server.fileUploads.enabled If enabled, file uploads on the server will be flagged as enabled true
server.mailchimp.enabled Mailchimp integration feature flag false
server.mailchimp.apikey.secretName The name of the Kubernetes Secret containing the Mailchimp API key. ""
server.mailchimp.apikey.secretKey The key within the Kubernetes Secret holding the Mailchimp API key as its value. mailchimp_apikey
server.mailchimp.serverPrefix Mailchimp api server prefix ""
server.mailchimp.newsletterListId Audience id for the newsletter list ""
server.mailchimp.onboardingListId Audience id for the onboarding list ""
server.mailchimp.onboardingJourneyId Id of the onboarding journey ""
server.mailchimp.onboardingStepId Id of the onboarding journey step we trigger ""
server.migration.movedFrom Indicate the URL where the server moved from ""
server.migration.movedTo Indicate the URL where the server moved to ""
server.monitoring.apollo.enabled (Optional) If enabled, exports metrics from the GraphQL API to Apollo Graphql Studio. false
server.monitoring.apollo.graph_id The ID for Speckle that you registered in Apollo Graphql Studio. ""
server.monitoring.apollo.key.secretName The name of the Kubernetes Secret containing the Apollo monitoring key. This is expected to be provided within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets ""
server.monitoring.apollo.key.secretKey The key within the Kubernetes Secret holding the Apollo monitoring key as its value. ""
server.monitoring.mp (Optional) If server.monitoring.mp.enabled is set to false, metrics will not be collected by the Speckle server. {}
server.sentry_dns (Optional) The Data Source Name that was provided by Sentry.io ""
server.disable_tracking If set to true, will prevent tracking metrics from being collected false
server.disable_tracing If set to true, will prevent tracing metrics from being collected false
server.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
server.affinity Affinity for Speckle server pods scheduling {}
server.nodeSelector Node labels for Speckle server pods scheduling {}
server.tolerations Tolerations for Speckle server pods scheduling []
server.topologySpreadConstraints Spread Constraints for Speckle server pod scheduling []

Server

Defines parameters related to the backend server component of Speckle.

Name Description Value
objects.replicas The number of instances of the Server pod to be deployed within the cluster. 1
objects.image The Docker image to be used for the Speckle Objects component. If blank, defaults to speckle/speckle-server:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
objects.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
objects.inspect.enabled If enabled, indicates that the Speckle server should be deployed with the nodejs inspect feature enabled false
objects.inspect.port The port on which the nodejs inspect feature should be exposed 7000
objects.max_object_size_mb The maximum size of an individual object which can be uploaded to the server 10
objects.requests.cpu The CPU that should be available on a node when scheduling this pod. 1000m
objects.requests.memory The Memory that should be available on a node when scheduling this pod. 1Gi
objects.limits.cpu The maximum CPU that will be made available to the server Pod in a given period. 1500m
objects.limits.memory The maximum Memory that will be made available to the server Pod. 3Gi
objects.ratelimiting.post_objects_streamid The maximum number of requests that can be made to the Speckle server to post a new object in a moving one second window. 6
objects.ratelimiting.burst_post_objects_streamid If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to post a new object in a moving one minute window. 400
objects.ratelimiting.get_objects_streamid_objectid The maximum number of requests that can be made to the Speckle server to get an object in a moving one second window. 3
objects.ratelimiting.burst_get_objects_streamid_objectid If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to get an object in a moving one minute window. 200
objects.ratelimiting.get_objects_streamid_objectid_single The maximum number of requests that can be made to the Speckle server to get a single object in a moving one second window. 3
objects.ratelimiting.burst_get_objects_streamid_objectid_single If the regular limit is exceeded, the limit is increased to the burst limit. This is the maximum number of requests that can be made to the Speckle server to get a single object in a moving one minute window. 200
objects.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true
objects.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
objects.affinity Affinity for Speckle server pods scheduling {}
objects.nodeSelector Node labels for Speckle server pods scheduling {}
objects.tolerations Tolerations for Speckle server pods scheduling []
objects.topologySpreadConstraints Spread Constraints for Speckle server pod scheduling []

Frontend

Defines parameters related to the frontend server component of Speckle.

Name Description Value
frontend.replicas The number of instances of the Frontend pod to be deployed within the cluster. 1
frontend.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
frontend.image The Docker image to be used for the Speckle Frontend component. If blank, defaults to speckle/speckle-frontend:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
frontend.requests.cpu The CPU that should be available on a node when scheduling this pod. 250m
frontend.requests.memory The Memory that should be available on a node when scheduling this pod. 256Mi
frontend.limits.cpu The maximum CPU that will be made available to the frontend Pod in a given period. 1000m
frontend.limits.memory The maximum Memory that will be made available to the frontend Pod. 512Mi
frontend.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
frontend.affinity Affinity for Speckle frontend pod scheduling {}
frontend.nodeSelector Node labels for Speckle frontend pods scheduling {}
frontend.tolerations Tolerations for Speckle frontend pods scheduling []
frontend.topologySpreadConstraints Spread Constraints for Speckle frontend pod scheduling []
frontend.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true

frontend_2

Defines parameters related to the frontend_2 component of Speckle

Name Description Value
frontend_2.image The Docker image to be used for the Speckle Frontend 2 component. If blank, defaults to speckle/speckle-frontend-2:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
frontend_2.logClientApiToken SEQ API token ""
frontend_2.logClientApiEndpoint SEQ endpoint URL ""
frontend_2.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
frontend_2.enabled Feature flag to enable running the new experimental frontend. false
frontend_2.replicas The number of instances of the Frontend 2 server prod to be deployed withing the cluster. 1
frontend_2.requests.cpu The CPU that should be available on a node when scheduling this pod. 250m
frontend_2.requests.memory The Memory that should be available on a node when scheduling this pod. 256Mi
frontend_2.limits.cpu The maximum CPU that will be made available to the frontend Pod in a given period. 1000m
frontend_2.limits.memory The maximum Memory that will be made available to the frontend Pod. 512Mi
frontend_2.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
frontend_2.affinity Affinity for Speckle frontend pod scheduling {}
frontend_2.nodeSelector Node labels for Speckle frontend pods scheduling {}
frontend_2.tolerations Tolerations for Speckle frontend pods scheduling []
frontend_2.topologySpreadConstraints Spread Constraints for Speckle frontend pod scheduling []
frontend_2.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true

Preview Service

Defines parameters related to the Preview Service component of Speckle.

Name Description Value
preview_service.replicas The number of instances of the Preview Service pod to be deployed within the cluster. 1
preview_service.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
preview_service.image The Docker image to be used for the Speckle Preview Service component. If blank, defaults to speckle/speckle-preview-service:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
preview_service.requests.cpu The CPU that should be available on a node when scheduling this pod. 500m
preview_service.requests.memory The Memory that should be available on a node when scheduling this pod. 2Gi
preview_service.limits.cpu The maximum CPU that will be made available to the Preview Service Pod in a given period. 1000m
preview_service.limits.memory The maximum Memory that will be made available to the Preview Service Pod. 4Gi
preview_service.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
preview_service.affinity Affinity for Speckle Preview Service pod scheduling {}
preview_service.nodeSelector Node labels for Speckle Preview Service pods scheduling {}
preview_service.tolerations Tolerations for Speckle Preview Service pods scheduling []
preview_service.topologySpreadConstraints Spread Constraints for Speckle Preview Service pod scheduling []
preview_service.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true

Webhook Service

Defines parameters related to the Webhook Service component of Speckle.

Name Description Value
webhook_service.replicas The number of instances of the Webhook Service pod to be deployed within the cluster. 1
webhook_service.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
webhook_service.image The Docker image to be used for the Speckle Webhook Service component. If blank, defaults to speckle/speckle-webhook-service:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
webhook_service.requests.cpu The CPU that should be available on a node when scheduling this pod. 500m
webhook_service.requests.memory The Memory that should be available on a node when scheduling this pod. 2Gi
webhook_service.limits.cpu The maximum CPU that will be made available to the Webhook Service Pod in a given period. 1000m
webhook_service.limits.memory The maximum Memory that will be made available to the Webhook Service Pod. 4Gi
webhook_service.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
webhook_service.affinity Affinity for Speckle Webhook Service pod scheduling {}
webhook_service.nodeSelector Node labels for Speckle Webhook Service pods scheduling {}
webhook_service.tolerations Tolerations for Speckle Webhook Service pods scheduling []
webhook_service.topologySpreadConstraints Spread Constraints for Speckle Webhook Service pod scheduling []
webhook_service.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true

File Import Service

Defines parameters related to the File Import Service component of Speckle.

Name Description Value
fileimport_service.replicas The number of instances of the FileImport Service pod to be deployed within the cluster. 1
fileimport_service.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
fileimport_service.image The Docker image to be used for the Speckle FileImport Service component. If blank, defaults to speckle/speckle-fileimport-service:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
fileimport_service.requests.cpu The CPU that should be available on a node when scheduling this pod. 100m
fileimport_service.requests.memory The Memory that should be available on a node when scheduling this pod. 512Mi
fileimport_service.limits.cpu The maximum CPU that will be made available to the FileImport Service Pod in a given period. 1000m
fileimport_service.limits.memory The maximum Memory that will be made available to the FileImport Service Pod. 2Gi
fileimport_service.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
fileimport_service.affinity Affinity for Speckle FileImport Service pod scheduling {}
fileimport_service.nodeSelector Node labels for Speckle FileImport Service pods scheduling {}
fileimport_service.tolerations Tolerations for Speckle FileImport Service pods scheduling []
fileimport_service.topologySpreadConstraints Spread Constraints for Speckle FileImport Service pod scheduling []
fileimport_service.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true
fileimport_service.time_limit_min The maximum time that a file can take to be processed by the FileImport Service. 10

Monitoring

Provides Speckle with metrics related to the Postgres database.

Name Description Value
monitoring.replicas The number of instances of the Monitoring pod to be deployed within the cluster. 1
monitoring.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
monitoring.image The Docker image to be used for the Speckle Monitoring component. If blank, defaults to speckle/speckle-monitoring-deployment:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
monitoring.requests.cpu The CPU that should be available on a node when scheduling this pod. 100m
monitoring.requests.memory The Memory that should be available on a node when scheduling this pod. 64Mi
monitoring.limits.cpu The maximum CPU that will be made available to the Monitoring Pod in a given period. 200m
monitoring.limits.memory The maximum Memory that will be made available to the Monitoring Pod. 512Mi
monitoring.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
monitoring.affinity Affinity for Speckle Monitoring pod scheduling {}
monitoring.nodeSelector Node labels for Speckle Monitoring pods scheduling {}
monitoring.tolerations Tolerations for Speckle Monitoring pods scheduling []
monitoring.topologySpreadConstraints Spread Constraints for Speckle Monitoring pod scheduling []
monitoring.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true

Testing

Defines parameters related to testing that the deployment of Speckle has been successful.

Name Description Value
helm_test_enabled If enabled, an additional pod is deployed which verifies some functionality of Speckle to determine if it is deployed correctly true
test.logLevel The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent info
test.image The Docker image to be used for the Speckle Test component. If blank, defaults to speckle/speckle-test-deployment:. If provided, this value should be the full path including tag. The docker_image_tag value will be ignored. ""
test.requests.cpu The CPU that should be available on a node when scheduling this pod. 100m
test.requests.memory The Memory that should be available on a node when scheduling this pod. 64Mi
test.limits.cpu The maximum CPU that will be made available to the Test Pod in a given period. 200m
test.limits.memory The maximum Memory that will be made available to the Test Pod. 512Mi
test.networkPolicy.enabled If enabled, will provide additional security be limiting network traffic into and out of the pod to only the required endpoints and ports. false
test.serviceAccount.create If enabled, a Kubernetes Service Account will be created for this pod. true

Resources

Other repos

Make sure to also check and ⭐️ these other Speckle repositories:

Developing and Debugging

This repository is a clone of the Helm chart in the Speckle Server repository.

⚠️ Pull requests are not accepted to this repository ⚠️. Instead, please contribute to the Helm chart within the Speckle Server repository.

Security

For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.

License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file’s header. If you have any questions, don’t hesitate to get in touch with us via email.