Releases: bento-platform/bento
Releases · bento-platform/bento
Version 17.1
Key Points
- Beacon API
- Search by gene ID
- Gateway
- Fix TLS termination
- TLS termination reverse proxy guide
- Gohan
- Gohan can now work with non-human chromosomes
- Katsu
- Experiments results HTML support
- Fix wrong search counts on nested properties
- Public
- Beacon network
- Beacon chromosome selector + non-hard-coded chromosome options
- Help text for Bento entities
- Translation improvements
- Dataset cards
- Performance improvements and bug fixes
- Reference
- Fix Refget multi-accept headers
- Web
- HTML files display
- Various bug fixes and improvements
Service Updates
- Aggregation 0.19.8 -> 0.19.9
- Authorization 0.10.1 -> 0.10.2
- Beacon 0.16.0 -> 0.18.1
- Drop Box 1.1.10 -> 1.1.11
- DRS 0.18.0 -> 0.19.0
- Event Relay 3.1.5 -> 3.1.6
- Gateway 0.13.0 -> 0.13.2
- Gohan 5.0.2 -> 6.0.0
- Katsu 9.0.0 -> 9.1.0
- Keycloak (Bento distribution) 2024.09.26 -> 2024.11.22
- Notification 3.1.6 -> 3.1.7
- Public 0.20.0 -> 0.22.0
- Reference 0.3.0 -> 0.3.2
- Service-registry 1.4.2 -> 1.4.3
- Web 6.0.0 -> 6.1.1
- WES 0.14.5 -> 0.14.6
What's Changed
- fix: bentoctl init-auth JSON error handling + compose up fix by @davidlougheed in #276
- pass reference url to beacon by @gsfk in #278
- bump beacon to 0.17.0 by @gsfk in #280
- fix: no ssl configuration by @v-rocheleau in #281
- chore: update Gohan to 6.0.0 by @davidlougheed in #282
- chore: update DRS to 0.19.0 by @davidlougheed in #283
- chore: update various services (no functional changes) by @davidlougheed in #284
- chore: bump web to 6.1.0 by @davidlougheed in #285
- chore: bump reference service to 0.3.2 by @davidlougheed in #286
- chore: bump aggregation to 0.19.9 and beacon to 0.18.0 by @davidlougheed in #288
- [17.1] bump beacon to 0.18.0 by @gsfk in #287
- chore: bump public to 0.21.0 by @davidlougheed in #290
- chore: bump public to 0.22.0 by @davidlougheed in #291
- chore: update katsu to 9.1.0 by @v-rocheleau in #292
- chore: bump beacon to 0.18.1 by @davidlougheed in #293
- Release v17.1 by @davidlougheed in #277
- chore: bump bento web to 6.1.1 by @v-rocheleau in #294
Full Changelog: v17...v17.1
Version 17
Key Points
- Bento Public
- Project/Dataset scope selection
- Scoped and authorized requests to Katsu/Beacon
- Reflected in the charts, provenance, search and Beacon results
- Show individual search matches for authorized users
- Bug fixes, improvements, libraries and image updates
- Project/Dataset scope selection
- Bento Web (private portal)
- Monitoring tab for users in the Grafana group
- Advanced search tables for biosample experiments
- Project/Dataset scoped discovery configuration
- Set and edit the discovery configuration at the project and dataset levels
- Improved error messages
- Bug fixes, improvements, libraries and image updates
- Monitoring stack (NEW)
- Initial work to improve observability on the Bento platform
- Services logs can be queried from a Grafana interface that now ships with Bento
- Authorized access by Keycloak group membership
- Enabled by a feature flag
- See documentation
- Katsu
- Authorization support on public endpoints for uncensored data
- Improved biosample experiment text search
- Allow downloading DATS JSON as attachment
- Continuous-Integration: publish JSON-schema files as a Katsu release artifact
- Bug fixes, improvements, libraries and image updates
- Authorization
- CLI: new command for public data access
- Bug fixes, improvements, libraries and image updates
- Beacon
- Beacon Network
- Query multiple Beacon APIs
- Handles authorized and scoped requests
- Anonymous requests use the discovery config
- Bug fixes, improvements, libraries and image updates
- Beacon Network
- Gateway
- Allow endpoints that are now authorized server-side
- Bug fixes, improvements, libraries and image updates
- WES
- Library and image updates
- Reference
- Fix refget response
- Uses file streaming and DRS resolver
- Bug fixes, improvements, libraries and image updates
New Services
- Grafana: 11.1.5
- Secure web interface to query, analyse and aggregate logs produced by all Bento services
- Loki: 3.1.1
- Logs storage
- Data source for Grafana
- Promtail: 2.9.10
- Forwards Docker logs to Loki
Service Updates
- Aggregation 0.19.5 -> 0.19.8
- Authorization 0.9.2 -> 0.10.1
- Beacon 0.15.2 -> 0.16.0
- Drop-box 1.1.8 -> 1.1.10
- DRS 0.17.1 -> 0.18.0
- Event-relay 3.1.3 -> 3.1.5
- Gateway 0.12.0 -> 0.13.0
- Gohan 5.0.1 -> 5.0.2
- Gohan-ES 5.0.1 -> 5.0.2
- Katsu 8.0.1 -> 9.0.0
- Keycloak (Bento distribution) 2024.06.03 -> 2024.09.26
- Notification 3.1.4 -> 3.1.6
- Public 0.19.1 -> 0.20.0
- Reference 0.2.2 -> 0.3.0
- Service-registry 1.4.1 -> 1.4.2
- Web 5.0.1 -> 6.0.0
- WES 0.14.2 -> 0.14.5
What's Changed
- feat: monitoring system by @v-rocheleau in #256
- fix: grafana oauth email by @v-rocheleau in #260
- refact(bentoctl): factor out common client/secret creation code by @davidlougheed in #262
- feat(grafana): authorization by group membership by @v-rocheleau in #261
- chore(deps): bump cryptography from 42.0.8 to 43.0.1 by @dependabot in #263
- docs: scoped discovery by @v-rocheleau in #247
- feat!: authorized Katsu endpoints + slightly auth-aware Beacon by @davidlougheed in #258
- Add beacon network by @gsfk in #259
- docs: monitoring tools documentation by @v-rocheleau in #265
- chore: update service patch versions by @davidlougheed in #266
- fix: remove adminer from local compose file by @v-rocheleau in #267
- update Bento Public to the Go-free version by @davidlougheed in #268
- Fixes/beacon network patch by @gsfk in #264
- fix: Bento healthchecks + patch Keycloak version by @davidlougheed in #269
- fix: reference service should wait for db to start by @davidlougheed in #270
- chore: bump gateway version to 0.13.0 by @v-rocheleau in #272
- chore: bump katsu to v9.0.0 by @v-rocheleau in #271
- chore: update translations by @v-rocheleau in #273
- [17] Fixes/beacon wait for auth by @gsfk in #274
- chore: bump bento_public to v0.20.0 by @v-rocheleau in #275
- Release v17 by @davidlougheed in #257
Full Changelog: v16...v17
Version 16
Key Points
- Bento Public:
- Various bug fixes
- Users can now authenticate on Bento Public to have unlimited Beacon filters
- Updated user interface with new colour scheme for charts and side menu
- Histogram charts
- Removed "missing" notion in charts
- Bento Web (private portal)
- Various bug fixes
- Uses Ant Design 5
- Increased permissions awareness
- Data Manager now includes an access control tab to manage grants and groups permissions
- Hide/show UI elements based on the user's permissions
- Dataset level permissions awareness coming in v17
- Workflow
- Workflow run output tab
- Run wizard steps for export workflows
- Explorer
- Show biosample ID with link in experiment data
- Experiment type filtering for experiments
- Data Manager
- DRS object search with details and delete button
- DRS resource validity column
- Reference Service
- Support for GFF3 ingestion
- Public read access
- Drop-box
- Search bar
- Katsu
- Various bug fixes
- Support for charts/search using nested JSONField data
- Biosample time_of_collection included in CSV exports
- Experiment results with files ingestion
- JSON Schemas endpoints with subschema resolving
- Public rules endpoint, rules de-coupled from overview responses
- Project/Dataset scoped discovery (to be integrated in Bento Public and Web in v17)
- Discovery config can be specified at three different levels: node, project, dataset
- For now, only node level is supported through the Katsu config for backwards compatibility
- Will allow project/dataset selection with granular search and charts config in Bento Public
- Project/Dataset scoping of endpoints with Discovery
- Will allow Bento Public to retrieve censored data belonging to a specific project/dataset
- Discovery config can be specified at three different levels: node, project, dataset
- Authorization
- Grant list endpoint
- Data type narrowing
- Beacon
- Public info endpoints don't require permissions
- Uses Katsu's public rules endpoint
- DRS
- Extension properties in ingest response
- Object deletion
- Gateway
- Pass-troughs for non-authz service endpoints
- WES
- Ensembl-VEP and VCF2MAF for cBio workflows
- Require persistent data dir, persist file artifacts from workflows
- Reference
- Genome feature support
- IGV.js search endpoint
- REFGET v2 implementation
Service Updates
- Aggregation 0.19.3 -> 0.19.5
- Authorization 0.8.0 -> 0.9.2
- Beacon 0.14.0 -> 0.15.2
- cBioPortal 4.1.13 -> 5.4.10
- cBioPortal-session 0.5.0 -> 0.6.2
- cBioPortal-database 6.0.4 -> 6.0.15
- Drop-box 1.1.5 -> 1.1.8
- DRS 0.15.3 -> 0.17.1
- Event-relay 3.1.1 -> 3.1.3
- Gateway 0.10.2 -> 0.12.0
- Gohan 5.0.0 -> 5.0.1
- Gohan-ES 5.0.0 -> 5.0.1
- Katsu 7.0.2 -> 8.0.1
- Keycloak (Bento distribution) 2024.02.16 -> 2024.06.03
- Notification 3.1.1 -> 3.1.4
- Public 0.18.0 -> 0.19.1
- Reference 0.1.2 -> 0.2.2
- Service-registry 1.3.6 -> 1.4.1
- Web 4.1.4 -> 5.0.1
- WES 0.12.8 -> 0.14.2
What's Changed
- feat: split data directories for storage resources by @v-rocheleau in #216
- chore: new compose structure to address changes in compose 2.24 by @davidlougheed in #225
- refact: fixed/refactored compose file setup by @davidlougheed in #228
- feat: new WES outputs + artifacts by @davidlougheed in #229
- feat: bento public authentication by @v-rocheleau in #230
- feat: updated cBioPortal support by @davidlougheed in #226
- [16]: fix: dev docs by @gsfk in #232
- chore(deps): bump idna from 3.6 to 3.7 by @dependabot in #233
- Created beacon config template, added bentoctl tool to copy files for beacon, katsu by @SanjeevLakhwani in #234
- [16]: update katsu example config by @gsfk in #235
- Update Instructions for Setting Up Gohan's Gene Catalogue by @SanjeevLakhwani in #239
- Modified bento public dev docker yaml to have en/fr_about.html files by @SanjeevLakhwani in #242
- Support histograms in katsu config by @SanjeevLakhwani in #241
- feat: reference service 0.2.0 by @davidlougheed in #240
- Fix public loading by @SanjeevLakhwani in #243
- docs: update authz grants instructions for reference genome by @v-rocheleau in #244
- chore(deps): bump urllib3 from 2.2.0 to 2.2.2 by @dependabot in #245
- chore(deps): bump requests from 2.31.0 to 2.32.2 by @dependabot in #246
- chore(deps): bump tqdm from 4.66.1 to 4.66.3 by @dependabot in #236
- chore(deps): bump certifi from 2024.2.2 to 2024.7.4 by @dependabot in #250
- chore: bentoctl bump docker-py version to 7.1.0 by @v-rocheleau in #251
- chore: update other bentoctl dependencies by @davidlougheed in #252
- set web to 5.0.0, bump other service patch versions by @davidlougheed in #253
- chore: bump katsu version to 8.0.1 by @v-rocheleau in #254
- docs: new ingestion instructions for reference material by @davidlougheed in #255
- Release v16 by @davidlougheed in #222
Full Changelog: v15.2...v16
Version 15.2
Key Points
- Bento now properly supports plain-HTTP deployments that are behind an HTTPS-terminated proxy.
- Gohan's Elasticsearch JVM now can be configured with an options file, which is recommended for production deployments.
Service Updates
- Auth 2023.10.31 -> 2024.02.16 (Keycloak 22 to 23)
- Authorization 0.7.0 -> 0.8.0
- Beacon 0.13.0 -> 0.14.0
- DRS 0.15.2 -> 0.15.3
- Event Relay 3.1.0 -> 3.1.1
- Gateway 0.10.0 -> 0.10.2
- Notification 3.1.0 -> 3.1.1
- Public 0.17.3 -> 0.18.0
- Service Registry 1.3.5 -> 1.3.6
Additionally, Redis was updated from 7.0.14 -> 7.0.15.
Merged PRs
- docs: fix 15.1 migration guide by @davidlougheed in #221
- chore(deps): bump cryptography from 42.0.2 to 42.0.4 by @dependabot in #224
- refactor: gohan elasticsearch jvm heap options file by @v-rocheleau in #231
- Release v15.2 by @davidlougheed in #223
Full Changelog: v15.1...v15.2
Version 15.1
Key Points
- The gateway can now handle plain-HTTP connections and/or a past-URL redirect to a new URL, if configured.
- Experiment results in Katsu can now store URIs/index URI records
- Sampled tissues on biosamples in Katsu are now correctly nullable
- The private portal has received some miscellaneous improvements and bug fixes
- The public portal has received some bug fixes and small styling tweaks
- We have a new library,
bento_auth_js
, which we are now using for authx inbento_web
which we will use for the public portal in the future too.
Service Updates
- Aggregation 0.19.2 -> 0.19.3
- Authorization 0.6.0 -> 0.7.0
- Beacon 0.12.1 -> 0.13.0
- Drop box 1.1.2 -> 1.1.5
- DRS 0.15.1 -> 0.15.2
- Gateway 0.8.1 -> 0.10.0
- Katsu 6.0.0 -> 7.0.2
- Public 0.17.0 -> 0.17.3
- Reference 0.1.1 -> 0.1.2
- Service registry 1.3.2 -> 1.3.5
- Web 4.0.0 -> 4.1.4
Additionally, bentoctl
has received some bug fixes and minor tweaks.
Merged PRs
- fix(bentoctl): phenopacket convertion extra properties stash fix by @v-rocheleau in #211
- [15.1] bump beacon version by @gsfk in #213
- Added a minimal list of properties to change in local.env for dev by @dbujold in #214
- [15.1] Fix broken image links in docs by @gsfk in #215
- feat(scripts): certbot init certs only by @v-rocheleau in #217
- [15.1] bump beacon by @gsfk in #218
- feat: switchable gateway/auth TLS by @davidlougheed in #212
- feat: configurable domain redirect for gateway by @v-rocheleau in #220
- Release v15.1 by @davidlougheed in #210
New Contributors
Full Changelog: v15...v15.1
Version 15
Key Points
- Breaking: Katsu has switched to Phenopackets v2. All clinical/phenotypic metadata must be remapped to the new schema. We've also included a converter in
bentoctl
. - New service: reference service (for reference genomes and other reference material in the future)
- Now, non-human variants can be ingested via first ingesting a non-human reference genome
- A database password must be set in
local.env
:BENTO_REFERENCE_DB_PASSWORD=...
- Permissions must be configured for the reference service
- Several small improvements to the public portal, including translations and chart presentation
Service Updates
- Authorization 0.4.0 -> 0.6.0
- Beacon 0.11.0 -> 0.12.1
- DRS 0.13.0 -> 0.15.1
- Event relay 3.0.2 -> 3.1.0
- Gateway 0.7.1 -> 0.8.1
- Gohan 4.0.1 -> 5.0.0
- Katsu 5.0.0 -> 6.0.0
- Notification 3.0.1 -> 3.1.0
- Public 0.16.2 -> 0.17.0
- Service registry 1.2.2 -> 1.3.2
- Web 3.2.2 -> 4.0.0
- WES 0.11.0 -> 0.12.6
- New service: Reference service 0.1.1
What's Changed
- [15] Allow public to contact Gohan via container URL by @noctillion in #189
- Elasticsearch GUI client by @v-rocheleau in #201
- [15] Implement new authorization service / evaluation / WES by @davidlougheed in #202
- [15] feat: Phenopacket V2 by @v-rocheleau in #190
- [15] chore: update various service tags + fix a small bug in bentoctl by @davidlougheed in #205
- feat: local package dev by @v-rocheleau in #206
- [15] beacon version by @gsfk in #207
- [15] add reference service by @davidlougheed in #204
- docs: split README into multiple guides by @davidlougheed in #208
- chore: set up a volume to hold DRS tempfiles for ingest by @davidlougheed in #209
- Release v15 by @davidlougheed in #196
- chore(deps): bump cryptography from 41.0.4 to 41.0.6 by @dependabot in #203
Full Changelog: v14...v15
Version 14
Key Points
- Breaking: MCODE was removed from Katsu
- Beacon now can provide full response granularity when given an authorized bearer token
- Documents such as PDFs and spreadsheets can now be ingested as experiment results into Katsu
- The provenance display of
bento_public
has been improved - Several services' base images and dependencies have been updated (patch releases)
Service Updates
- Aggregation 0.19.1 -> 0.19.2
- Beacon 0.9.1 -> 0.11.0
- DRS 0.12.6 -> 0.13.0
- Gohan 4.0.0 -> 4.0.1
- Katsu 4.4.0 -> 5.0.0
- Keycloak 22.0.3 -> 22.0.5 (Bento distribution)
- Notification 3.0.0 -> 3.0.1
- Public 0.15.0 -> 0.16.2
- Redis 7.0.12 -> 7.0.14
- Service registry 1.2.1 -> 1.2.2
- Web 3.1.2 -> 3.2.2
- WES 0.10.1 -> 0.11.0
Merged PRs
- chore(deps): bump urllib3 from 1.26.17 to 1.26.18 by @dependabot in #192
- [14] chore: configure Beacon for Bento v14 by @gsfk in #199
- prod cert renewal script and variables by @v-rocheleau in #200
- Release v14 by @davidlougheed in #197
Full Changelog: v13.2...v14
Version 13.2
Key Points
- A small web bugfix and a security patch for aggregation
Service Updates
- Aggregation 0.19.0 -> 0.19.1
- Web 3.1.1 -> 3.1.2
Full Changelog: v13.1...v13.2
Version 13.1
Key Points
- Improvements to the
bento_web
individual explorer interface - Katsu can now ingest more types of experiments/additional library strategies and sources
Service Updates
- Drop box 1.0.0 -> 1.0.1
- DRS 0.12.5 -> 0.12.6
- Gateway 0.6.0 -> 0.7.1
- Katsu 4.0.0 -> 4.4.0
- Keycloak 22.0.0 -> 22.0.3 (Bento distribution)
- Public 0.14.1 -> 0.15.0
- Service registry 1.2.0 -> 1.2.1
- Web 3.0.1 -> 3.1.1
Additionally, bentoctl
was updated and is now v0.4.0
Merged PRs
- [14] chore: use the same postgres image for katsu-db vs rest of stack by @davidlougheed in #178
- [14] fix(bentoctl):
prod all
subcommand by @davidlougheed in #183 - remove dead beacon env values by @gsfk in #184
- chore(deps): bump cryptography from 39.0.1 to 41.0.3 by @dependabot in #161
- Release v13.1 by @davidlougheed in #185
- chore(deps): bump urllib3 from 1.26.13 to 1.26.17 by @dependabot in #187
Full Changelog: v13.0...v13.1
Version 13.0
Key Points
- Authorization checks were added to several more services
- The Bento concept of "tables" was removed
- Make sure to read the migration guide!
Service Updates
- Aggregation 0.18.1 -> 0.19.0
- Authorization 0.2.1 -> 0.4.0
- Beacon 0.7.1 -> 0.9.1
- DRS 0.10.2 -> 0.12.5
- Gateway 0.5.3 -> 0.6.0
- Gohan 3.9.1 -> 4.0.0
- Katsu 3.0.1 -> 4.0.0
- Keycloak 20.0 -> 22.0 (Bento distribution)
- Notification 2.4.1 -> 3.0.0
- Public 0.13.2 -> 0.14.1
- Service registry 1.0.0 -> 1.2.0
- Web 2.1.2 -> 3.0.1
- WES 0.9.0 -> 0.10.1
Additionally, bentoctl
was updated and is now v0.3.0
Merged PRs
- [13] chore: rm unused env var for public by @davidlougheed in #144
- [13] chore: bump redis to 7.0.12 by @davidlougheed in #149
- [13] feat!: new notification service with authz by @davidlougheed in #151
- [13] pass BENTO_BEACON_UI_ENABLED param to beacon by @gsfk in #145
- [13] chore: bump gateway to 0.5.5 by @davidlougheed in #154
- [13] chore: don't run keycloak with legacy logout redirect uri flag by @davidlougheed in #153
- chore(deps): bump cryptography from 39.0.1 to 41.0.2 by @dependabot in #155
- [13] feat!: new DRS (0.10.2 --> 0.12.3) with authz + CORS by @davidlougheed in #148
- chore(deps): bump certifi from 2022.12.7 to 2023.7.22 by @dependabot in #157
- chore(deps): bump requests from 2.28.1 to 2.31.0 by @dependabot in #156
- [13] chore: disable Keycloak plain HTTP and use Bento Keycloak image by @davidlougheed in #158
- [13] chore: bump authz to 0.4.0 by @davidlougheed in #162
- [13] chore: bump public to 0.14.0 by @davidlougheed in #163
- [13] feat!: connect bento_public to WES for showing last ingest times by @noctillion in #146
- [13] Beacon updates by @davidlougheed in #152
- [13] remove stale values from beacon config by @gsfk in #169
- [13] feat!: new WES with authz by @davidlougheed in #150
- [13] docs: add v13 migration guide by @davidlougheed in #168
- [13] chore: set up new aggregation service by @davidlougheed in #165
- [13] chore: clean up pointless props in bento_services.json by @davidlougheed in #171
- chore: update service registry to 1.1.0 by @davidlougheed in #172
- [13] table removal integration by @v-rocheleau in #160
- chore: upgrade service-registry to 1.1.1 by @davidlougheed in #173
- chore: pin aggregation to 0.19.0 by @davidlougheed in #174
- chore: pin WES to 0.10.0 by @davidlougheed in #175
- add org urls to beacon config by @gsfk in #177
- chore: gateway no longer depends on redis by @davidlougheed in #180
- chore(bentoctl): remove orphan containers on docker compose down by @davidlougheed in #181
- bump beacon to v0.9.1 by @gsfk in #182
- Release v13 by @davidlougheed in #147
New Contributors
- @dependabot made their first contribution in #155
Full Changelog: v12.2...v13.0