Skip to content
This repository has been archived by the owner on Dec 29, 2020. It is now read-only.

Commit

Permalink
fix(docs): add a brief getting started guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ssube committed Nov 28, 2019
1 parent c79d2cb commit e9f55e5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,21 @@ prune older data, compression will not be available, and queries will be slower.
- [Features](#features)
- [Status](#status)
- [Contents](#contents)
- [Getting Started](#getting-started)
- [Schema](#schema)
- [Label ID](#label-id)

## Getting Started

- run TimescaleDB somewhere, like [Kubernetes](https://hub.docker.com/r/timescale/timescaledb) or [Timescale Cloud](https://www.timescale.com/cloud)
- set the `PG*` environment variables for your connection info (`PGHOST`, `PGPORT`, `PGUSER`, `PGPASSWORD`, `PGDATABASE`)
- create a database
- run `./scripts/schema-create.sh [license-level] [retain-live] [retain-total]`
- create a role for the adapter to write samples
- run `./scripts/schema-grant.sh role-name adapter`
- create roles for Grafana, developers, etc
- run `./scripts/schema-grant.sh role-name grafana` for each reader

## Schema

This adapter uses a schema that is compatible with [the Timescale `pg_prometheus` adapter](https://github.com/timescale/prometheus-postgresql-adapter/) but does not require the `pg_prometheus` extension or `SUPERUSER`/plugin permissions.
Expand Down

0 comments on commit e9f55e5

Please sign in to comment.