Skip to content

Commit

Permalink
PM-1832 update README with new task details
Browse files Browse the repository at this point in the history
  • Loading branch information
simisimis committed Jul 5, 2024
1 parent 92f4b71 commit d95191b
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ Set these environment variables for the Postgres connection:
- `POSTGRES_USER` - Username for PostgreSQL authentication.
- `POSTGRES_PASSWORD` - Password for the specified PostgreSQL user.

> **Optional**(Used with `invoke create-ro-user` task):
- `POSTGRES_RO_USER` - Desired username for creating read only postgres user.
- `POSTGRES_RO_PASSWORD` - Desired password for read only postgres user.

Create a database and relevant tables before first-time program execution using Python `invoke` tasks:

1. **Create database and tables**:
Expand Down Expand Up @@ -121,6 +125,13 @@ It is possible to drop database using:
invoke drop-database
```

A task to create a read only user that later can be used to connect to Delegation Program database with services such as `leaderboard`.

```
invoke create-ro-user
```
> **Note:** This task uses `POSTGRES_RO_USER` and `POSTGRES_RO_PASSWORD` env variables.
### AWS Keyspaces/Cassandra Configuration

To connect to AWS Keyspaces/Cassandra, the following environment variables need to be set:
Expand Down Expand Up @@ -217,4 +228,4 @@ The system's database can grow over time, but typically, keeping more than 90 da
SELECT cleanup_old_data(180);
```

**Note:** It is advisable to perform a database backup before initiating the cleanup process.
**Note:** It is advisable to perform a database backup before initiating the cleanup process.

0 comments on commit d95191b

Please sign in to comment.