## Context Originally, the [Azure Storage Driver](https://gitlab.com/gitlab-org/container-registry/-/blob/a3f64464c3ec1c5a599c0a2daa99ebcbc0100b9a/docs-gitlab/README.md#azure-storage-driver) would write to `//` as the root directory, also appearing in some places as `/<no-name>/` within the Azure UI. `trimlegacyrootprefix` can be set to `true` to build root paths without an extra leading slash. ## Problem This legacy behavior must be preserved to support older deployments using this driver; however, when moving to Azure from another storage driver, this behavior essentially "hides" all the data until `trimlegacyrootprefix: true` is set. Defaulting to `true` however, would have the same effect on legacy deployments of Azure, which would be even more disruptive. ## Solutions The storage driver should default to the correct behavior, using `/` as the root directory, but it's unclear how to approach this change. ### Breaking Change on New GitLab Release We could schedule the changes to take place during a new major release of GitLab. This gives us the freedom to make breaking changes, and we could then either make `trimlegacyrootprefix` default to true, or we could rename this into something like `legacyrootprefix` with `legacyrootprefix: true` using `//` as the root directory. Either of these solutions are fairly trivial code changes, but would require a one-time configuration change (or perhaps a migration from `//` to `/`) for every Azure user of the registry. ### ~~Smart Detection of Legacy Deployments~~ ~~Instead of requiring users on older deployments to adjust their configurations, we could instead explore the possibility of detecting these deployments and adjusting the behavior of the driver. If we detect the presence of the `//` directory ahead of the root prefix, we can then use that as the root, while defaulting to `/` in all other cases. This solution does not require a breaking change; however, it requires more sophisticated code, and it raises the complexity of the driver behavior. Additionally, we'd need to provide a way to force the new behavior to enable users to migrate without deleting the original prefix.~~ With: https://gitlab.com/gitlab-org/container-registry/-/merge_requests/1196 we're going to make a breaking change, as outlined above. ## Breaking change tasks ### Affected Topology This affects Self-Managed users of GitLab. ### Affected Tier All tiers are affected. * Free * Premium * Ultimate ### Checklists **Labels** - [x] This issue is labeled ~deprecation, and with the relevant `~devops::`, `~group::`, and `~Category:` labels. - [x] This issue is labeled ~"breaking change" if the removal of the deprecated item will be a [breaking change](https://about.gitlab.com/handbook/product/gitlab-the-product/#examples-of-breaking-changes). **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): - [x] A [deprecation announcement entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-a-deprecation-announcement) has been created so the deprecation will appear in release posts and on the [general deprecation page](https://docs.gitlab.com/ee/update/deprecations). - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108051 - [x] Documentation has been updated to mark the feature as [deprecated](https://docs.gitlab.com/ee/development/documentation/versions.html#deprecations-and-removals) -https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108340 - [x] On or before the major milestone: A [removal entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#removals) has been created so the removal will appear on the [removals by milestones](https://docs.gitlab.com/ee/update/removals) page and be announced in the release post. - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108051 - On the major milestone: - [ ] The deprecated item has been removed. - [x] If the removal of the deprecated item is a [breaking change](https://about.gitlab.com/handbook/product/gitlab-the-product/#examples-of-breaking-changes), the merge request is labeled ~"breaking change". **Mentions** - [x] Your stage's stable counterparts have been `@mentioned` on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager: @heather. - To see who the stable counterparts are for a product team visit [product categories](https://about.gitlab.com/handbook/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` - [x] Your GPM @jreporter 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 15.8 ### Planned Removal Milestone 16.0