This repository has been archived by the owner on Dec 7, 2023. It is now read-only.
Support configuring BindAddress and Protocol for a PortMapping
#299
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,41 @@ | ||
| package v1alpha1 | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "net" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/docker/go-connections/nat" | ||
| ) | ||
|
|
||
| // PortMapping defines a port mapping between the VM and the host | ||
| type PortMapping struct { | ||
| BindAddress net.IP `json:"bindAddress,omitempty"` | ||
| HostPort uint64 `json:"hostPort"` | ||
| VMPort uint64 `json:"vmPort"` | ||
| Protocol Protocol `json:"protocol,omitempty"` | ||
|
There was a problem hiding this comment. I'm think that omitempty doesn't work with custom marshallers, but idk. We can test. If so, then we need to use a pointer here. There was a problem hiding this comment. Now that we're using the standard mashaler and Docker's parser always adding the proto, this isn't an issue. |
||
| } | ||
|
|
||
| var _ fmt.Stringer = PortMapping{} | ||
|
|
||
| func (p PortMapping) String() string { | ||
| var sb strings.Builder | ||
|
|
||
| if p.BindAddress != nil { | ||
| sb.WriteString(p.BindAddress.String()) | ||
| } else { | ||
| sb.WriteString("0.0.0.0") | ||
| } | ||
|
|
||
| sb.WriteString(fmt.Sprintf(":%d->%d", p.HostPort, p.VMPort)) | ||
|
|
||
| if len(p.Protocol) > 0 { | ||
| sb.WriteString(fmt.Sprintf("/%s", p.Protocol)) | ||
| } | ||
|
|
||
| return sb.String() | ||
| } | ||
|
|
||
| // PortMappings represents a list of port mappings | ||
|
|
@@ -27,32 +46,56 @@ var _ fmt.Stringer = PortMappings{} | |
| func ParsePortMappings(input []string) (PortMappings, error) { | ||
|
There was a problem hiding this comment. I'm strongly of the opinion that we should not duplicate code here that we already have vendored. |
||
| result := make(PortMappings, 0, len(input)) | ||
|
|
||
| _, bindings, err := nat.ParsePortSpecs(input) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| for port, bindings := range bindings { | ||
| if len(bindings) > 1 { | ||
| // TODO: For now only support mapping a VM port to a single host IP/port | ||
| return nil, fmt.Errorf("only one host binding per VM binding supported for now, received %d", len(bindings)) | ||
| } | ||
|
|
||
| binding := bindings[0] | ||
| var err error | ||
| var bindAddress net.IP | ||
| var hostPort uint64 | ||
| var vmPort uint64 | ||
| var protocol Protocol | ||
|
|
||
| if len(binding.HostIP) > 0 { | ||
| if bindAddress = net.ParseIP(binding.HostIP); bindAddress == nil { | ||
| return nil, fmt.Errorf("invalid bind address: %q", binding.HostIP) | ||
| } | ||
| } | ||
|
|
||
| if hostPort, err = strconv.ParseUint(binding.HostPort, 10, 64); err != nil { | ||
| return nil, fmt.Errorf("invalid host port: %q", binding.HostPort) | ||
| } | ||
|
|
||
| if vmPort, err = strconv.ParseUint(port.Port(), 10, 64); err != nil { | ||
| return nil, fmt.Errorf("invalid VM port: %q", port.Port()) | ||
| } | ||
|
|
||
| if protocol, err = protocolFromString(port.Proto()); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| mapping := PortMapping{ | ||
| BindAddress: bindAddress, | ||
| HostPort: hostPort, | ||
| VMPort: vmPort, | ||
| Protocol: protocol, | ||
| } | ||
|
|
||
| for _, portMapping := range result { | ||
| if portMapping.HostPort == mapping.HostPort && portMapping.Protocol == mapping.Protocol { | ||
| return nil, fmt.Errorf("cannot use a port/protocol combination on the host twice") | ||
| } | ||
| } | ||
|
|
||
| result = append(result, mapping) | ||
| } | ||
|
|
||
| return result, nil | ||
|
|
@@ -74,6 +117,40 @@ func (p PortMappings) String() string { | |
| return sb.String() | ||
| } | ||
|
|
||
| // Protocol specifies a network port protocol | ||
| type Protocol string | ||
|
|
||
| const ( | ||
| ProtocolTCP Protocol = "tcp" | ||
| ProtocolUDP Protocol = "udp" | ||
| ) | ||
|
|
||
| var _ fmt.Stringer = Protocol("") | ||
|
|
||
| func protocolFromString(input string) (Protocol, error) { | ||
| for _, protocol := range []Protocol{ProtocolTCP, ProtocolUDP} { | ||
| if protocol.String() == input { | ||
| return protocol, nil | ||
| } | ||
| } | ||
|
|
||
| return "", fmt.Errorf("invalid protocol: %q", input) | ||
| } | ||
|
|
||
| func (p Protocol) String() string { | ||
| return string(p) | ||
| } | ||
|
|
||
| func (p *Protocol) UnmarshalJSON(b []byte) (err error) { | ||
| var s string | ||
| if err = json.Unmarshal(b, &s); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| *p, err = protocolFromString(s) | ||
| return | ||
| } | ||
|
|
||
| // IPAddresses represents a list of VM IP addresses | ||
| type IPAddresses []net.IP | ||
|
|
||
|
|
||
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is optional; I'd prefer for this to be a pointer (although, technically maybe omitempty works here)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
net.IPis a[]byte, which can benil, so omitempty works just fine.