Skip to content

docker.md

Latest commit

 

History

History
44 lines (30 loc) · 1.69 KB

docker.md

File metadata and controls

44 lines (30 loc) · 1.69 KB

🐳 Docker

🔧 Running Docker

A docker image for the Promscale Connector is available on Docker Hub at timescale/promscale.

A docker image of TimescaleDB with the promscale extension is available at on Docker Hub at timescaledev/promscale-extension:latest-pg12.

🕞 Setting up cron jobs

Docker installations also need to make sure the execute_maintenance() procedure on a regular basis (e.g. via cron). We recommend executing it every 30 minutes. This is necessary to execute maintenance tasks such as enforcing data retention policies according to the configured policy.

🔥 Configuring Prometheus to use this remote storage connector

You must tell prometheus to use this remote storage connector by adding the following lines to prometheus.yml:

remote_write:
  - url: "http://<connector-address>:9201/write"
remote_read:
  - url: "http://<connector-address>:9201/read"

⚙️ Configuration

The Promscale Connector binary is configured through either CLI flags, environment variables, or a YAML configuration file. Precedence goes like this: CLI flag value, if not set, environment variable value, if not set, configuration file value, if not set, default value.

All environment variables are prefixed with PROMSCALE.

Configuration file is a YAML file where the keys are CLI flag names and values are their respective flag values.

The list of available cli flags is available in here in our docs or by running with the -h flag (e.g. promscale -h)

🛠 Building from source

You can build the Docker container using the Dockerfile