Upgrading to v0.6.0¶
- The
kafka.topic.prefixconfiguration was renamed todt.kafka.topic.prefixto 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 format instead of milliseconds. Example of name change:Before After task.cron.metrics.portfoliotask.portfolio.metrics.update.crontask.metrics.portfolio.lockAtMostForInMillistask.portfolio.metrics.update.lock.max.durationtask.metrics.portfolio.lockAtLeastForInMillistask.portfolio.metrics.update.lock.min.duration -
The
/api/v1/vulnerability/source/{source}/vuln/{vuln}/projectsREST API endpoint now supports pagination (apiserver/#888). Like all other paginated endpoints, the page size defaults to100. Clients currently expecting all items to be returned at once must be updated to deal with pagination. -
The
alpine.prefix was removed from Kafka processor properties of the API server (apiserver/#904). Example of name change:Before After alpine.kafka.processor.vuln.scan.result.processing.orderkafka.processor.vuln.scan.result.processing.order -
The endpoints deprecated in v4.x mentioned below were removed (apiserver/#910):
Removed endpoint Replacement POST /api/v1/policy/{policyUuid}/tag/{tagName}POST /api/v1/tag/{name}/policyDELETE /api/v1/policy/{policyUuid}/tag/{tagName}DELETE /api/v1/tag/{name}/policyGET /api/v1/tag/{policyUuid}GET /api/v1/tag/policy/{uuid}GET /api/v1/bom/token/{uuid}GET /api/v1/event/token/{uuid} -
The required PostgreSQL version has been raised from 11 to 13 (hyades/#1724). Lower versions may still work, but are no longer tested against.
-
User records in the database are consolidated from the separate
LDAPUSER,MANAGEDUSER, andOIDCUSERtables, into a singleUSERtable (apiserver/#1169). The newUSERtable enforces uniqueness of usernames. To prevent data loss,LDAPUSERandOIDCUSERrecords with conflicting usernames get their values suffixed with-CONFLICT-LDAPand-CONFLICT-OIDCrespectively. Affected users cannot authenticate. Administrators are expected to resolve this by removing users or renaming them as desired. Note that this is an edge case and should not affect most deployments. -
The metrics tables
DEPENDENCYMETRICS,PORTFOLIOMETRICS, andPROJECTMETRICSare partitioned by date (apiserver/#1141). The migration procedure involves copying existing metrics data, thus requiring up to double the amount of storage for the duration of the migration. To reduce the amount of data being copied, consider temporarily reducing the metrics retention timespan in the administration panel under Configuration → Maintenance. Only historic data falling within the configured retention duration gets migrated. -
Database migrations have been integrated into the broader concept of initialization tasks. As a result, the following configuration properties were renamed:
Before After database.run.migrationsinit.tasks.enableddatabase.run.migrations.onlyinit.and.exitdatabase.migration.urlinit.tasks.database.urldatabase.migration.usernameinit.tasks.database.usernamedatabase.migration.passwordinit.tasks.database.password