[27.1 backport] deprecate packages that are to be removed in the next release #48185

thaJeztah · 2024-07-18T21:41:14Z

For some of these we didn't add a deprecation as they were not used externally; as we're now doing a 27.1 release, that gives us the opportunity to do a deprecation first, just in case someone may be depending on it.

This backports;

And adds 2 extra commits to provide stubs / deprecations.

- Description for the changelog

- the pkg/rootless/specconv package is deprecated, an will be removed in the next release.
- the pkg/containerfs package is deprecated, an will be removed in the next release.
- the pkg/directory.Size() function is deprecated, an will be removed in the next release.

- A picture of a cute animal (not mandatory but encouraged)

corhere · 2024-07-18T22:10:35Z

pkg/rootless/specconv/specconv_deprecated.go

I think this file needs to be renamed to specconv_deprecated_linux.go to make Windows CI happy.

oh! good catch this one didn't have stubs for non-Linux. Should be fixed now 🤞

The container package is the only consumer of this function in our code and there's no known external users; https://grep.app/search?q=.CleanScopedPath%28&filter[lang][0]=Go Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit e2ae690) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

- Improve some GoDoc to use docs links - Change the Windows stub to an actual wrapper function, as we don't want it to be updateable, and it currently shows as "variable" on pkg.go.dev, which is confusing. - Remove "import" comments in preparation of moving this package Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit a3e6ce9) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

The only external consumer are the `graphdriver` and `graphdriver/shim` packages in github.com/docker/go-plugins-helpers, which depended on [ContainerFS][1], which was removed in 9ce2b30. graphdriver-plugins were deprecated in 6da604a, and support for them removed in 555dac5, so removing this should not be an issue. Ideally this package would've been moved inside `daemon/internal`, but it's used by the `daemon` (cleanupContainer), `plugin` package, and by `graphdrivers`, so needs to be in the top-level `internal/` package. [1]: https://github.com/docker/go-plugins-helpers/blob/6eecb7beb65124bb44a23848bb46e98b4f50ae18/graphdriver/api.go#L218 Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit f2970e5) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

There's no (known) external consumers of this, but let's add a deprecation for the 27.1 release. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 80900bd) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 3a3bb1c) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

This package is only used by the daemon, so move it to the internal rootless package instead. Note that technically this could be in daemon/internal, but as there's already an existing internal/rootless package (which needs to be in the top-level internal package because it's also used by /plugin), I'm moving it there. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit efdaca2) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

There's no (known) external consumers of this, but let's add a deprecation for the 27.1 release. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [docker/docker](https://togithub.com/docker/docker) | minor | `27.0.3` -> `27.1.0` | --- ### Release Notes <details> <summary>docker/docker (docker/docker)</summary> ### [`v27.1.0`](https://togithub.com/moby/moby/releases/tag/v27.1.0) [Compare Source](https://togithub.com/docker/docker/compare/v27.0.3...v27.1.0) #### 27.1.0 For a full list of pull requests and changes in this release, refer to the relevant GitHub milestones: - [docker/cli, 27.1.0 milestone](https://togithub.com/docker/cli/issues?q=is%3Aclosed+milestone%3A27.1.0) - [moby/moby, 27.1.0 milestone](https://togithub.com/moby/moby/issues?q=is%3Aclosed+milestone%3A27.1.0) - Deprecated and removed features, see [Deprecated Features](https://togithub.com/docker/cli/blob/v27.1.0/docs/deprecated.md). - Changes to the Engine API, see [API version history](https://togithub.com/moby/moby/blob/v27.1.0/docs/api/version-history.md). ##### Bug fixes and enhancements - rootless: add `Requires=dbus.socket` to prevent errors when starting the daemon on a cgroup v2 host with systemd [moby/moby#48141](https://togithub.com/moby/moby/pull/48141) - containerd integration: `image tag` event is now properly emitted when building images with Buildkit [moby/moby#48182](https://togithub.com/moby/moby/pull/48182) - cli: add OOMScoreAdj to docker service create and docker stack [docker/cli#5274](https://togithub.com/docker/cli/pull/5274) - cli: add support for `DOCKER_CUSTOM_HEADERS` env-var (experimental) [docker/cli#5271](https://togithub.com/docker/cli/pull/5271) - cli: containerd-integration: Fix `docker push` defaulting the `--platform` flag to a value of `DOCKER_DEFAULT_PLATFORM` environment variable on unsupported API versions [docker/cli#5248](https://togithub.com/docker/cli/pull/5248) - cli: fix: ctx cancellation on login prompt [docker/cli#5260](https://togithub.com/docker/cli/pull/5260) - cli: fix: wait for the container to exit before closing the stream when sending a termination request to the CLI while attached to a container [docker/cli#5250](https://togithub.com/docker/cli/pull/5250) ##### Deprecated - the pkg/rootless/specconv package is deprecated, an will be removed in the next release [moby/moby#48185](https://togithub.com/moby/moby/pull/48185) - the pkg/containerfs package is deprecated, an will be removed in the next release [moby/moby#48185](https://togithub.com/moby/moby/pull/48185) - the pkg/directory package is deprecated, an will be removed in the next release [moby/moby#48185](https://togithub.com/moby/moby/pull/48185) - api/types/system: remove deprecated Info.ExecutionDriver [moby/moby#48184](https://togithub.com/moby/moby/pull/48184) ##### Packaging updates - Update Buildx to [v0.16.1](https://togithub.com/docker/buildx/releases/tag/v0.16.1). [moby/docker-ce-packaging#1039](https://togithub.com/docker/docker-ce-packaging/pull/1039) - Update Compose to [v2.29.0](https://togithub.com/docker/compose/releases/tag/v2.29.0). [moby/docker-ce-packaging#1038](https://togithub.com/docker/docker-ce-packaging/pull/1038) - Update Containerd (static binaries only) to [v1.7.20](https://togithub.com/containerd/containerd/releases/tag/v1.7.20). [moby/moby#48191](https://togithub.com/moby/moby/pull/48191) - Update BuildKit to [v0.15.0](https://togithub.com/moby/buildkit/releases/tag/v0.15.0). [moby/moby#48028](48175://togithub.com/moby/moby/pull/48175) - Update Go runtime to 1.21.12, which contains security fixes for [CVE-2024-24791](https://togithub.com/advisories/GHSA-hw49-2p59-3mhj) [moby/moby#48120](48175://togithub.com/moby/moby/pull/48120) **Full Changelog**: moby/moby@v27.0.3...v27.1.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6am on monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/earthly/dind).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [docker/docker](https://togithub.com/docker/docker) | minor | `27.0.3` -> `27.1.0` | --- ### Release Notes <details> <summary>docker/docker (docker/docker)</summary> ### [`v27.1.0`](https://togithub.com/moby/moby/releases/tag/v27.1.0) [Compare Source](https://togithub.com/docker/docker/compare/v27.0.3...v27.1.0) #### 27.1.0 For a full list of pull requests and changes in this release, refer to the relevant GitHub milestones: - [docker/cli, 27.1.0 milestone](https://togithub.com/docker/cli/issues?q=is%3Aclosed+milestone%3A27.1.0) - [moby/moby, 27.1.0 milestone](https://togithub.com/moby/moby/issues?q=is%3Aclosed+milestone%3A27.1.0) - Deprecated and removed features, see [Deprecated Features](https://togithub.com/docker/cli/blob/v27.1.0/docs/deprecated.md). - Changes to the Engine API, see [API version history](https://togithub.com/moby/moby/blob/v27.1.0/docs/api/version-history.md). ##### Bug fixes and enhancements - rootless: add `Requires=dbus.socket` to prevent errors when starting the daemon on a cgroup v2 host with systemd [moby/moby#48141](https://togithub.com/moby/moby/pull/48141) - containerd integration: `image tag` event is now properly emitted when building images with Buildkit [moby/moby#48182](https://togithub.com/moby/moby/pull/48182) - cli: add OOMScoreAdj to docker service create and docker stack [docker/cli#5274](https://togithub.com/docker/cli/pull/5274) - cli: add support for `DOCKER_CUSTOM_HEADERS` env-var (experimental) [docker/cli#5271](https://togithub.com/docker/cli/pull/5271) - cli: containerd-integration: Fix `docker push` defaulting the `--platform` flag to a value of `DOCKER_DEFAULT_PLATFORM` environment variable on unsupported API versions [docker/cli#5248](https://togithub.com/docker/cli/pull/5248) - cli: fix: ctx cancellation on login prompt [docker/cli#5260](https://togithub.com/docker/cli/pull/5260) - cli: fix: wait for the container to exit before closing the stream when sending a termination request to the CLI while attached to a container [docker/cli#5250](https://togithub.com/docker/cli/pull/5250) ##### Deprecated - the pkg/rootless/specconv package is deprecated, an will be removed in the next release [moby/moby#48185](https://togithub.com/moby/moby/pull/48185) - the pkg/containerfs package is deprecated, an will be removed in the next release [moby/moby#48185](https://togithub.com/moby/moby/pull/48185) - the pkg/directory package is deprecated, an will be removed in the next release [moby/moby#48185](https://togithub.com/moby/moby/pull/48185) - api/types/system: remove deprecated Info.ExecutionDriver [moby/moby#48184](https://togithub.com/moby/moby/pull/48184) ##### Packaging updates - Update Buildx to [v0.16.1](https://togithub.com/docker/buildx/releases/tag/v0.16.1). [moby/docker-ce-packaging#1039](https://togithub.com/docker/docker-ce-packaging/pull/1039) - Update Compose to [v2.29.0](https://togithub.com/docker/compose/releases/tag/v2.29.0). [moby/docker-ce-packaging#1038](https://togithub.com/docker/docker-ce-packaging/pull/1038) - Update Containerd (static binaries only) to [v1.7.20](https://togithub.com/containerd/containerd/releases/tag/v1.7.20). [moby/moby#48191](https://togithub.com/moby/moby/pull/48191) - Update BuildKit to [v0.15.0](https://togithub.com/moby/buildkit/releases/tag/v0.15.0). [moby/moby#48175](https://togithub.com/moby/moby/pull/48175) - Update Go runtime to 1.21.12, which contains security fixes for [CVE-2024-24791](https://togithub.com/advisories/GHSA-hw49-2p59-3mhj) [moby/moby#48120](48175://togithub.com/moby/moby/pull/48120) **Full Changelog**: moby/moby@v27.0.3...v27.1.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6am on monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/earthly/dind).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

thaJeztah added status/2-code-review impact/changelog impact/deprecation kind/refactor PR's that refactor, or clean-up code area/go-sdk labels Jul 18, 2024

thaJeztah added this to the 27.1.0 milestone Jul 18, 2024

thaJeztah requested a review from cpuguy83 as a code owner July 18, 2024 21:41

corhere reviewed Jul 18, 2024

View reviewed changes

thaJeztah added 8 commits July 19, 2024 00:23

[27.1] pkg/containerfs: deprecate, and add temporary aliases

d1ea2b1

There's no (known) external consumers of this, but let's add a deprecation for the 27.1 release. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

pkg/directory: fix comment, and remove import comments

68587c3

Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 80900bd) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

pkg/directory: deprecate, and move to internal

c8f1317

Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 3a3bb1c) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

[27.1] pkg/rootless/specconv: deprecate, and add temporary aliases

c9d37a9

There's no (known) external consumers of this, but let's add a deprecation for the 27.1 release. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah force-pushed the 27.1_backport_internalize_pkg_directory branch from 938960d to c9d37a9 Compare July 18, 2024 22:23

corhere approved these changes Jul 18, 2024

View reviewed changes

thaJeztah self-assigned this Jul 18, 2024

thaJeztah merged commit f8f926b into moby:27.0 Jul 19, 2024

thaJeztah deleted the 27.1_backport_internalize_pkg_directory branch July 19, 2024 00:06

thaJeztah changed the title ~~[27.0 backport] deprecate packages that are to be removed in the next release~~ [27.1 backport] deprecate packages that are to be removed in the next release Jul 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[27.1 backport] deprecate packages that are to be removed in the next release #48185

[27.1 backport] deprecate packages that are to be removed in the next release #48185

Uh oh!

thaJeztah commented Jul 18, 2024

Uh oh!

corhere Jul 18, 2024

Uh oh!

thaJeztah Jul 18, 2024

Uh oh!

Uh oh!

[27.1 backport] deprecate packages that are to be removed in the next release #48185

[27.1 backport] deprecate packages that are to be removed in the next release #48185

Uh oh!

Conversation

thaJeztah commented Jul 18, 2024

Uh oh!

corhere Jul 18, 2024

Choose a reason for hiding this comment

Uh oh!

thaJeztah Jul 18, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!