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

Add upgrade notes #1490

Merged
merged 1 commit into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
24 changes: 24 additions & 0 deletions docs/getting-started/upgrading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### Upgrading to 0.6.0

* The `kafka.topic.prefix` configuration was renamed to `dt.kafka.topic.prefix` to prevent
collisions with native Kafka properties ([hyades/#1392]).
* Configuration names for task cron expressions and lock durations have changed ([apiserver/#840]).
They now follow a consistent `task.<task-name>.<config>` scheme. Lock durations are now specified
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) format instead of milliseconds.
Refer to the [task scheduling configuration reference] for details. Example of name change:

| Before | After |
|:------------------------------------------------|:--------------------------------------------------|
| `task.cron.metrics.portfolio` | `task.portfolio.metrics.update.cron` |
| `task.metrics.portfolio.lockAtMostForInMillis` | `task.portfolio.metrics.update.lock.max.duration` |
| `task.metrics.portfolio.lockAtLeastForInMillis` | `task.portfolio.metrics.update.lock.min.duration` |

* The `/api/v1/vulnerability/source/{source}/vuln/{vuln}/projects` REST API endpoint now supports pagination
([apiserver/#888]). Like all other paginated endpoints, the page size defaults to `100`.
Clients currently expecting *all* items to be returned at once must be updated to deal with pagination.

[apiserver/#840]: https://github.com/DependencyTrack/hyades-apiserver/pull/840
[apiserver/#888]: https://github.com/DependencyTrack/hyades-apiserver/pull/888
[hyades/#1392]: https://github.com/DependencyTrack/hyades/issues/1392

[task scheduling configuration reference]: ../reference/configuration/api-server.md#task-scheduling
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ nav:
- Overview: index.md
- Changes over v4: getting-started/changes-over-v4.md
- Migrating from v4: getting-started/migrating-from-v4.md
- Upgrading: getting-started/upgrading.md
- Usage:
- Policy Compliance:
- Overview: usage/policy-compliance/overview.md
Expand Down
Loading