Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 3.72 KB

docker.md

File metadata and controls

90 lines (62 loc) · 3.72 KB
Raw

🐳 Docker

🔧 Running Docker

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

To fetch the latest Promscale image, please refer to the releases section of Promscale github repository.

A docker image of TimescaleDB with the promscale extension is available at on Docker Hub at timescaledev/promscale-extension:latest-pg12. You can install this via docker pull timescaledev/promscale-extension:latest-pg12.

Example using docker:

First, let's create a network specific to Promscale-TimescaleDB.

docker network create --driver bridge promscale-timescaledb

Install and run TimescaleDB with Promscale extension:

docker run --name timescaledb -e POSTGRES_PASSWORD=<password> -d -p 5432:5432 --network promscale-timescaledb timescaledev/promscale-extension:latest-pg12 postgres -csynchronous_commit=off

Finally, let's run Promscale:

docker run --name promscale -d -p 9201:9201 --network promscale-timescaledb timescale/promscale:<version-tag> -db-password=<password> -db-port=5432 -db-name=postgres -db-host=timescaledb -db-ssl-mode=allow

Note: db-ssl-mode=allow is just for explanatory purposes. In production environments, we advise you to use db-ssl-mode=require for security purposes.

This should make Promscale running along with TimescaleDB.

Example using docker-compose:

You can also run Promscale also by using docker-compose. The docker-compose.yml is available in the build directory of our repository. You can start Promscale and related services simply via docker-compose up.

For updating Promscale in this method, you need to stop the Promscale that is currently running using docker-compose stop and then pull the image with the tag you want to upgrade to with docker pull timescale/promscale:<version-tag>. This will pull the respective image to your local docker registry. You can then run the updated image with docker-compose up.

🕞 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.

Example:

CALL execute_maintenance();

🔥 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"
    read_recent: true

Note: Setting read_recent to true will make Prometheus query data from Promscale for all PromQL queries. This is highly recommended.

⚙️ 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.