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.

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.