Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README and docker-compose to require use of TimescaleDB v1.7 #341

Merged
merged 2 commits into from
Jan 12, 2021
Merged

docs: Update README and docker-compose to require use of TimescaleDB v1.7 #341

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a49a698
docs: Update README and docker-compose to require use of TimescaleDB …
placer14 Jan 4, 2021
1b7feeb
chore(docs): Include quick testing blurb
placer14 Jan 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 3 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,14 @@ Build the `sentinel-visor` binary to the root of the project directory:
$ make build
```

Install PostgreSQL:
Install TimescaleDB v1.7.4:

```sh
brew install postgresql@12
```

Install TimescaleDB:

```sh
brew tap timescale/tap
brew install timescaledb
```

You may need to run the following _before_ installing timescale to get it to compile:
Copy link
Contributor Author

@placer14 placer14 Jan 4, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that homebrew no longer makes v1.7 available for download via this method. Changed to use docker-compose as recommended means for getting the correct (and tuned) versions of Postgres/TimescaleDB in the least amount of effort. (This approach is also OS-agnostic.)

In a separate shell, use docker-compose to start the appropriate version of Postgres with TimescaleDB. (Note: Visor requires TimescaleDB v1.7.x and will not work with v2.0.)

```sh
ln -s /usr/local/Cellar/postgresql@12/12.5/include/postgresql/server /usr/local/Cellar/postgresql@12/12.5/include/server
docker-compose up --build timescaledb
```

Run `timescaledb-tune` and/or activate TimescaleDB by adding `shared_preload_libraries = 'timescaledb'` to `postgresql.conf`. Ensure you run `timescaledb_move.sh` as homebrew asks to finish the installation and then restart the postgres server if it's running.

### Running tests
placer14 marked this conversation as resolved.
Show resolved Hide resolved

Create a new DB in postgres for testing:
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: '3.5'
services:
timescaledb:
container_name: timescaledb
image: timescale/timescaledb:latest-pg12
image: timescale/timescaledb:1.7.4-pg12
ports:
- "5432:5432"
environment:
Expand Down