Skip to content

Deprecate legacy praefect config structure in Omnibus

For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features

Deprecation Summary

Omnibus was recently updated to place Praefect's configuration under praefect['configuration'] hash which gets directly marshaled as TOML for the final Praefect configuration. We are planning on deprecating the old configuration keys.

Documentation Issue: Update documentation to match Praefect's new co... (!110379 - merged)

Breaking Change

This will be a breaking change for users as it requires them to migrate to the updated praefect['configuration'] structure.

Affected Topology

This impacts self-managed users who configure Praefect.

Affected Tier

All tiers are impacted.

Checklists

Labels

  • This issue is labeled deprecation, and with the relevant ~devops::, ~group::, and ~Category: labels.
  • This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.

Timeline

Please add links to the relevant merge requests.

  • As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: 14.8, 14.9, 14.10, 15.0 – 14.8 is the third milestone preceding the major release):
  • On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post.
  • On the major milestone:

Mentions

  • Your stage's stable counterparts have been @mentioned on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager.
    • To see who the stable counterparts are for a product team visit product categories
      • If there is no stable counterpart listed for Sales/CS please mention @timtams
      • If there is no stable counterpart listed for Support please mention @gitlab-com/support/managers
      • If there is no stable counterpart listed for Marketing please mention @cfoster3
  • Your GPM has been @mentioned so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change.

Deprecation Milestone

This is planned to be announced in %15.9

Planned Removal Milestone

The legacy configuration values are scheduled to be removed in %16.0

Links

Mapings from old keys to new keys can be found here.

Edited by Mark Wood