Skip to content

Commit

Permalink
docs: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paulobressan committed Dec 12, 2023
1 parent fb916ae commit 4b8a321
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,30 @@

This project is a Kubernetes custom controller to create users on dbsync's Postgres. This controller defines a new CRD DbSyncPort on Kubernetes and when the new users enable the External Dbsync, the Demiter will generate a manifest with the kind DbSyncPort and the controller will be watching for creating a new user on Postgres.

> [!IMPORTANT]
> The metrics collector uses the `pg_stat_statements` extension enabled on Postgres. To enable that extension follow the steps bellow.
- set pg_stat_statements at `shared_preload_libraries` on postgresql.conf
```
shared_preload_libraries = 'pg_stat_statements'
```
- create the extension on postgres
```
CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
```

## Environment

| Key | Value |
| -------------- | ------------------------------------- |
| ADDR | 0.0.0.0:5000 |
| DB_URL_MAINNET | postgres://user:password@host:post/db |
| DB_URL_PREPROD | postgres://user:password@host:post/db |
| DB_URL_PREVIEW | postgres://user:password@host:post/db |
| Key | Value |
| ---------------------- | ------------------------------------- |
| ADDR | 0.0.0.0:5000 |
| DB_URL_MAINNET | postgres://user:password@host:post/db |
| DB_URL_PREPROD | postgres://user:password@host:post/db |
| DB_URL_PREVIEW | postgres://user:password@host:post/db |
| METRICS_DELAY | 30 |
| DCU_PER_SECOND_MAINNET | 10 |
| DCU_PER_SECOND_PREPROD | 10 |
| DCU_PER_SECOND_PREVIEW | 10 |

## Commands

Expand Down

0 comments on commit 4b8a321

Please sign in to comment.