[28.x] deprecate NetworkSettingsBase, DefaultNetworkSettings #50839
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akerouanton
added
area/api
vvoland
requested changes
Aug 28, 2025
akerouanton
force-pushed
the
28.x-deprecate-NetworkSettingsBase
branch
from
81753cc to
79f906f
Compare
vvoland
approved these changes
Aug 28, 2025
thaJeztah
reviewed
Aug 28, 2025
api/types/types_deprecated.go
Outdated
| // | ||
| // Deprecated: use [container.NetworkSettingsBase]. | ||
| type NetworkSettingsBase = container.NetworkSettingsBase | ||
| // Deprecated: use [container.NetworkSettings]. |
Member
There was a problem hiding this comment.
Was this intentionally pointing to the other type? (not "base")?
Member
Author
There was a problem hiding this comment.
NetworkSettingsBase is deprecated but it contains three fields that aren't — namely SandboxID, SandboxKey and Ports. These will be moved to NetworkSettings in v29.
This type is embedded in NetworkSettings, so aliasing NetworkSettingsBase to container.NetworkSettings would provide seamless migration to api v2.
But I'm not sure whether this is the right approach. Let me know what you think about that.
Member
Author
There was a problem hiding this comment.
It's probably a bad idea though. So, I decided to not touch the alias itself but to only update the deprecation warning.
container.NetworkSettingsBase is deprecated in v28.4, and scheduled for
removal in v29. However, it contains three fields that aren't deprecated
and that will be moved to NetworkSettings.
Update the deprecation notice on NetworkSettingsBase to advise users
to access NetworkSettingsBase's fields through NetworkSettings.
vvoland
requested changes
Aug 28, 2025
vvoland
reviewed
Aug 28, 2025
akerouanton
added
the
impact/go-sdk
This field provides little value as it's only set when the daemon is started with --bridge flag specified, and the inspected container is connected to the default bridge network. Unfortunately, there's no equivalent field in NetworkSettings.Networks. Signed-off-by: Albin Kerouanton <[email protected]> (cherry picked from commit 16dc391) Signed-off-by: Albin Kerouanton <[email protected]>
akerouanton
force-pushed
the
28.x-deprecate-NetworkSettingsBase
branch
2 times, most recently
from
ddebb28 to
e49d304
Compare
vvoland
approved these changes
Aug 29, 2025
Most fields in NetworkSettingsBase are deprecated, so deprecate the whole struct. The few fields which aren't deprecated will move to the NetworkSettings struct in v29. Signed-off-by: Albin Kerouanton <[email protected]> (cherry picked from commit 80bb864) Signed-off-by: Albin Kerouanton <[email protected]>
Signed-off-by: Albin Kerouanton <[email protected]> (cherry picked from commit d0de293) Signed-off-by: Albin Kerouanton <[email protected]>
This struct is only used to report the networking state for the default bridge network when the container is connected to it. It was deprecated in v1.09 (API v1.21), and scheduled for removal in v1.11. Unfortunately, the deprecation warning was wrongly formatted in the Go code. However, deprecation warnings are already present in swagger.yaml, so don't touch it. Signed-off-by: Albin Kerouanton <[email protected]> (cherry picked from commit b7c597e) Signed-off-by: Albin Kerouanton <[email protected]>
container.NetworkSettingsBase is deprecated in v28.4, and scheduled for removal in v29. However, it contains three fields that aren't deprecated and that will be moved to NetworkSettings. Update the deprecation notice on NetworkSettingsBase to advise users to access NetworkSettingsBase's fields through NetworkSettings. Signed-off-by: Albin Kerouanton <[email protected]>
akerouanton
force-pushed
the
28.x-deprecate-NetworkSettingsBase
branch
from
e49d304 to
660b67b
Compare
robmry
approved these changes
Aug 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
- What I did
api/t/ctr: deprecate NetworkSettingsBase.Bridge
This field provides little value as it's only set when the daemon is started with --bridge flag specified. There's no equivalent field in NetworkSettings. Deprecate it.
api/t/ctr: deprecate NetworkSettingsBase
Most fields in NetworkSettingsBase are deprecated, so deprecate the whole struct. The few fields which aren't deprecated will move to the NetworkSettings struct in v29.
Mark all deprecated fields as
omitempty.api/t/ctr: deprecate DefaultNetworkSettings
This struct is only used to report the networking state for the default bridge network when the container is connected to it.
It was deprecated in v1.09 (API v1.21) but has never been removed since then. Unfortunately, the deprecation warning was wrongly formatted.
Fix the deprecation warning.
- Human readable description for the release notes