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.

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

WX-1417 New database role strategy #7366

Merged
merged 3 commits into from
Feb 15, 2024
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Docs
  • Loading branch information
jgainerdewar committed Feb 14, 2024
commit 6a63fb4624b83e2fed6e21e5a656d7f07f9cb3c8
28 changes: 28 additions & 0 deletions docs/Configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,34 @@ database {
}
```

If you want multiple database users to be able to read Cromwell's data from a Postgresql database, you'll need to create a
role that all relevant users have access to, and adjust Cromwell to use this role. This is because each Large Object is owned
by, and only readable by, the role that wrote it.

First, pass these options when executing Cromwell. They will ensure that Cromwell's database tables are
owned by the role, not the initial login user.
* `-DengineSharedCromwellDbRole=your_role` to control the role that owns the engine tables
* `-DsharedCromwellDbRole=your_role` to control the role that owns the metadata tables

Next, use the config key `pgLargeObjectWriteRole` to set the role that should own all large objects, as shown below.
This config will have no effect if you aren't using Postgresql. The configured login user can be any user that is
granted the shared role.

```hocon
database {
profile = "slick.jdbc.PostgresProfile$"
pgLargeObjectWriteRole = "your_role"
db {
driver = "org.postgresql.Driver"
url = "jdbc:postgresql://localhost:5432/cromwell"
user = "user"
password = "pass"
port = 5432
connectionTimeout = 5000
}
}
```

**Using Cromwell with file-based database (No server required)**

SQLite is currently not supported. However, HSQLDB does support running with a persistence file.
Expand Down
Loading