api: Add consts for predefined networks#46447
Merged
thaJeztah merged 1 commit intomoby:masterfrom Nov 24, 2023
Merged
Conversation
Constants for both platform-specific and platform-independent networks are added to the api/network package. Signed-off-by: Albin Kerouanton <[email protected]>
akerouanton
added
status/2-code-review
kind/refactor
akerouanton
force-pushed
the
api-predefined-networks
branch
from
cacb321 to
a8975c9
Compare
thaJeztah
reviewed
Sep 11, 2023
| func (n NetworkMode) NetworkName() string { | ||
| if n.IsDefault() { | ||
| return "default" | ||
| return network.NetworkDefault |
Member
There was a problem hiding this comment.
Would it make sense to define the types in this package? (Given that NetworkMode is also defined here 🤔)
Member
Author
There was a problem hiding this comment.
I went back and forth and I couldn't find any prevailing argument. But here's my final reasoning on that:
- These consts are about predefined networks. As a client user, I'd expect networking stuff, including consts for predefined networks, to be defined in the
networkpackage ; - They're used in other places than just this package ;
NetworkModeis about the main network of a container, these consts aren't related to containers ;
Member
Author
There was a problem hiding this comment.
@thaJeztah Are you still on the fence on that?
Member
There was a problem hiding this comment.
Are you still on the fence on that?
Yeah, probably shouldn't block the PR though.
It's just very messy because
- we conflated "mode" and "network-names" (which was intentional, but implementation of that wasn't great in hindsight)
- "default" is horrible, or more specifically, horrible because it's used in some places, but may not work in other places, which also relates to the above (does
docker network create --driver=defaultwork?) - for places where we're currently checking for "names" ("modes"), we should more look at properties of the network (is this network "attachable", does it support "x", can it be "created" / instantiated?)
- we still need to look at making some checks platform-independent; i.e. we should probably not allow creating a network named
bridgeon Windows, or vice-versa, a network namedtransparent(ornat) on Linux. We currently define some reserved names based on the platform the daemon is running on, but I think we should make those a general "reserved names" (or something like that)
(does
docker network create --driver=defaultwork?)
Answering myself: it doesn't
docker network create --driver=default hellonetwork
Error response from daemon: plugin "default" not found
cpuguy83
reviewed
Nov 9, 2023
| func (n NetworkMode) NetworkName() string { | ||
| if n.IsBridge() { | ||
| return "bridge" | ||
| return network.NetworkBridge |
Member
There was a problem hiding this comment.
This whole function makes me weep.
cpuguy83
approved these changes
Nov 9, 2023
vvoland
approved these changes
Nov 24, 2023
thaJeztah
approved these changes
Nov 24, 2023
Member
thaJeztah
left a comment
thaJeztah
left a comment
There was a problem hiding this comment.
"LGTM"
but we should really start looking if we can clean up this mess (see my comments)
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
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.
Related to:
- What I did
Constants for both platform-specific and platform-independent networks are added to the api/network package.
- A picture of a cute animal (not mandatory but encouraged)