Deprecations and Breaking Changes
As Kargo continues to evolve, features that have outlived their usefulness, having often been replaced with better alternatives, are sometimes sunset. This page documents past and pending deprecated features and breaking changes.
Deprecations
The table below summarizes features that have been deprecated and either removed or scheduled for removal.
| Feature | Deprecated In | Removed In | Replacement/Notes |
|---|---|---|---|
Warehouse's container image subscription's semverConstraint field | v1.7.0 | Scheduled for v1.9.0 | Users should migrate to using the constraint field field which accepts the same value but is named to better indicate it can also be used for tag selection (e.g. latest) when the image selection strategy is set to Digest. |
Project specification | v1.5.0 | v1.7.0 | Users should migrate to the dedicated ProjectConfig resource. This resource kind accepts a .spec identitical to the Project, but allows for fine-grain permissions. |
secrets object in the Promotion variables | v1.5.0 | v1.7.0 | Users should migrate to the secret() function which resolves Secrets on-demand, reducing overhead. |
prNumber field in git-open-pr Promotion Step output | v1.5.0 | v1.7.0 | Users should migrate to using the pr.id for referencing pull request IDs. |
messageFromSteps of git-commit Promotion Step | v1.3.0 | Scheduled for v1.5.0 | Use the message field in combination with expressions. Refer to the documentation for more information. |
| Promotion Steps Fields | v1.1.0 | v1.3.0 | Several fields in promotion steps, such as prNumberFromStep in the git-wait-for-pr step, are now deprecated. These fields were originally the only way to reference output from previous promotion steps. With the introduction of expressions, these fields have outlived their purpose, as expressions like ${{ outputs['open-pr'].pr.id }} present a more flexible and straightforward way to reference the same output. more info |
helm-update-image step | v1.1.0 | v1.3.0 | Use the more flexible yaml-update step. more info |
| Legacy Promotion Mechanisms | v0.9.0 | v1.0.0 | Migrate to promotion steps. more info |
Breaking Changes
This section summarizes significant changes that create potential for disruption upon upgrade. The Kargo team strives to keep changes of this nature to an absolute minimum.
| Change | Version | Impact | Migration Path |
|---|---|---|---|
| Global Credential Store Changes | v1.0.0 | Affects installations using controller.globalCredentials.namespaces | Manually create a RoleBindings to permit controller access to "global" credential namespaces or set controller.serviceAccount.clusterWideSecretReadingEnabled to true at install time (not recommended). more info |