​

Speckle Enterprise Desktop UI deployment guide

​

Prerequisites

1. License Acquisition: Acquired a commercial license for Speckle Enterprise from Speckle Systems. This license should include permissions for deploying Desktop UI.
2. Package Registry Token: Obtained a package registry token from Speckle Systems to access the private Helm charts & Docker images for Enterprise features.
3. Package Registry URL: Received the URL for the private package registry hosting the Desktop UI Helm charts and Docker images.

​

Infrastructure

• Kubernetes Cluster: A Kubernetes cluster to host the Desktop UI components. This can be a managed service (e.g., EKS, AKS, GKE) or a self-hosted cluster.
  • It is possible to host Desktop UI in the same cluster as your Speckle Enterprise Server deployment.
  • We recommend using a separate namespace for isolation, resource management, and security.
• Domain: A domain name for accessing the Desktop UI. This must be a different domain from your Speckle Server deployment as there may be path routing conflicts if hosted on the same domain.

​

Configuration Steps

​

Retrieving the Helm Chart

1. To access the private Helm charts for Speckle Enterprise Desktop UI, you need to log in to the Speckle Enterprise package registry:
   helm login <PACKAGE_REGISTRY_URL> --username <PACKAGE_REGISTRY_USERNAME> --password <PACKAGE_REGISTRY_TOKEN>
   
2. Once authenticated, you can pull the Desktop UI Helm chart and investigate its contents:
   helm pull <PACKAGE_REGISTRY_URL>/speckle-dui-chart --untar
   
3. We recommend reading the values.yaml file included in the Helm chart to understand all the configuration options available for Desktop UI. A json.schema file is also included to provide validation and documentation for each configuration option.
4. We also recommend understanding the architecture of the Kubernetes resources deployed by the Helm chart. Please contact your Speckle representative if you have further questions.
5. Create an empty values.yaml file which we will use to configure our deployment:
   touch values.yaml
   

​

Image Pull Secrets

1. Create a Kubernetes Secret of type dockerconfigjson:
   kubectl create secret docker-registry speckle-enterprise-registry \
   --docker-server=<PACKAGE_REGISTRY_URL> \
   --docker-username=<PACKAGE_REGISTRY_USERNAME> \
   --docker-password=<PACKAGE_REGISTRY_TOKEN> \
   -n <NAMESPACE> \
   --dry-run=client \
   -o yaml | kubectl apply -f -
   
2. Confirm the secret is deployed successfully.
   kubectl get secret speckle-enterprise-registry -n <NAMESPACE>
   
3. Update the Helm values.yaml file to reference the image pull secret:
   imagePullSecrets:
     - name: speckle-enterprise-registry
   

​

Security settings

​

Ingress Configuration

1. Update the Helm values.yaml file to include the appropriate ingress settings for your deployment:
   ingress:
     enabled: true
     className: "nginx"
     annotations:
       # Add any necessary annotations for your ingress controller here, e.g. for cert-manager integration:
       cert-manager.io/cluster-issuer: letsencrypt-prod
     hosts:
       - host: yourSpeckleDUIDomain.example.com
         paths:
           # Please retain this path, the dashboards expect to serve all paths under the root.
           - path: /
             pathType: ImplementationSpecific
     tls:
       - secretName: speckle-dui-tls
         hosts:
           - yourSpeckleDUIDomain.example.com
   

​

Gateway API HttpRoute Configuration

1. Update the Helm values.yaml file to include the appropriate configuration for your deployment:
   httpRoute:
     enabled: true
     annotations: {}
     parentRefs:
     - name: gateway
       sectionName: http
     hostnames:
     - yourSpeckleDUIDomain.example.com
     rules:
     - matches:
       # Please retain this path, the dashboards expect to serve all paths under the root.
       - path:
           type: PathPrefix
           value: /
   

​

Deploying the Helm Chart

1. The Kubernetes RBAC user deploying the Desktop UI will require permissions to create namespaces, deployments, services, configmaps, secrets, and other resources required by the Helm Chart. Please ensure your user has the necessary permissions before proceeding.
2. Use Helm to deploy Speckle Enterprise Desktop UI:
   helm install speckle-dui <PACKAGE_REGISTRY_URL>/speckle-dui-chart \
   --namespace <NAMESPACE> \
   -f values.yaml
   

​

Updating Connectors configuration