starwitorg/timescaledb-chart repository overview

⁠Helm chart for TimescaleDB

Use this Helm chart to install a single node TimescaleDB to a Kubernetes cluster. It does not aim for clustered/HA installations, just one TimeScale instance.

TimescaleDB is an extension for PostgreSQL, that makes working with time series data easy. It is an awesome project and please visit their homepage⁠ and see how you can contribute. Chart is using their Docker image⁠.

⁠Usage

Assuming you have a Kubernetes cluster configured, installation can then be done with the following command:

helm -n yournamespace install timescale oci://registry-1.docker.io/starwitorg/timescaledb-chart -f yourvalues.yaml

As usually you can adapt installation using customized values. Following snippet shows an example:

postgresql:
  username: postgres
  password: mysecretpassword
  database: mytimescale

initdb:
  enabled: true
  sql: |
    -- Example bootstrap script
    CREATE TABLE IF NOT EXISTS metrics (
      time TIMESTAMPTZ NOT NULL,
      value DOUBLE PRECISION NULL
    );
    SELECT create_hypertable('metrics', 'time', if_not_exists => TRUE);

persistence:
  enabled: true
  size: 20Gi # request storage space from Kubernetes here
  storageClass: ""

Most noteworthy is the initdb field, which allows you, to run SQL scripts on first data base start. This way you can create schemata, user, hypertables, etc

⁠Contribution

As it has become difficult to find Helm charts for a number of crucial software packages, this chart shall serve as a free alternative for smaller projects. So please consider contributing! Code is released as open source, will stay open source and your contributions will also stay open source.

Bug reports, doc improvements and pull requests are very much welcome!

⁠License

Project is licensed under AGPL 3 and the license can be found here⁠. This component is part of a publicly funded project by the city of Wolfsburg and thus usage in your community is very much encouraged. It is part of a group of software modules that shall help communities to analyze urban space and to gain statistical insights.