Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lucymcnatt committed Feb 8, 2025
1 parent b181c03 commit 5ef83f3
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 12 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## 88 Release Notes

### Mysql 8.4

Cromwell now supports MySQL 8.4 and 8.4-compatible databases. While older versions of MySQL are no longer officially supported or tested, but they are not explicitly forbidden from use.

### New feature: Prevent Job start during Cloud Quota exhaustion

This optional feature prevents Cromwell from starting new jobs in a group that is currently experiencing
Expand Down
2 changes: 2 additions & 0 deletions docs/Configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@ database {
}
```

Note: Cromwell currently only officially supports MySQL version 8.4

To see the full list of possible parameters and values for the `db` stanza see [the slick documentation](http://slick.lightbend.com/doc/3.2.0/api/index.html#slick.jdbc.JdbcBackend$DatabaseFactoryDef@forConfig(String,Config,Driver):Database).

**Cromwell server on MySQL Database**
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/PersistentServer.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Cromwell remembers everything it knows!
- Start the MySQL docker container with the following line:

```bash
docker run -p 3306:3306 --name NameOfTheContainer -e MYSQL_ROOT_PASSWORD=YourPassword -e MYSQL_DATABASE=DatabaseName -e MYSQL_USER=ChooseAName -e MYSQL_PASSWORD=YourOtherPassword -d mysql/mysql-server:5.5
docker run -p 3306:3306 --name NameOfTheContainer -e MYSQL_ROOT_PASSWORD=YourPassword -e MYSQL_DATABASE=DatabaseName -e MYSQL_USER=ChooseAName -e MYSQL_PASSWORD=YourOtherPassword -d mysql/mysql-server:8.4
```

- Update your `application.conf` file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ docker run \
--env MYSQL_DATABASE=cromwell_test \
--env MYSQL_USER=cromwell \
--env MYSQL_PASSWORD=test \
--rm mysql/mysql-server:5.6
--rm mysql:8.4
39 changes: 29 additions & 10 deletions src/ci/resources/build_application.inc.conf
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,36 @@ system {
}

# See documentation for these values in cromwell.examples.conf
services.MetadataService.config.metadata-write-statistics {
enabled = true
cache-size = 20000
metadata-row-alert-interval = 5000 # Quite low... but we don't expect much metadata from test workflows, right?
sub-workflow-bundling = true
}

services.GcpCostCatalogService.config {
enabled = true
catalogExpirySeconds = 86400
services {
MetadataService {
class = "cromwell.services.metadata.impl.MetadataServiceActor"
config {
metadata-write-statistics {
enabled = true
cache-size = 20000
metadata-row-alert-interval = 5000
sub-workflow-bundling = true
}
}
GcpCostCatalogService {
class = "cromwell.services.cost.GcpCostCatalogService"
config {
enabled = true
catalogExpirySeconds = 86400
}
}
}
; services.MetadataService.config.metadata-write-statistics {
; enabled = true
; cache-size = 20000
; metadata-row-alert-interval = 5000 # Quite low... but we don't expect much metadata from test workflows, right?
; sub-workflow-bundling = true
; }
;
; services.GcpCostCatalogService.config {
; enabled = true
; catalogExpirySeconds = 86400
; }

# Make the shutdown timeout conspicuously long, so that if it hangs, it is an obvious problem in CI.
# See https://github.com/broadinstitute/cromwell/issues/2575
Expand Down

0 comments on commit 5ef83f3

Please sign in to comment.