Servers with no allocation (#86)

* Update packages

* Docker: server with no allocation

* None bracking package updates

* Make SEVRER_IP 127.0.0.1

* Compare to port and not IP

* This is not needed anymore as we use 127.0.0.1:0

* Fix ForceOutgoingIp

* Fix packages conflict

Author: QuintenQVD0

environment/allocations.go

@@ -9,6 +9,12 @@ import (
 	"github.com/pelican-dev/wings/config"
 )
 
+
+// DefaultAllocationMapping defines the IP and port mapping for a server
+type DefaultAllocationMapping struct {
+	Ip   string `json:"ip"`
+	Port int    `json:"port"`
+}
 // Defines the allocations available for a given server. When using the Docker environment
 // driver these correspond to mappings for the container that allow external connections.
 type Allocations struct {
@@ -17,13 +23,11 @@ type Allocations struct {
 	// the DefaultMapping's IP. This is important to servers which rely on external
 	// services that check the IP of the server (Source Engine servers, for example).
 	ForceOutgoingIP bool `json:"force_outgoing_ip"`
+	
 	// Defines the default allocation that should be used for this server. This is
 	// what will be used for {SERVER_IP} and {SERVER_PORT} when modifying configuration
 	// files or the startup arguments for a server.
-	DefaultMapping struct {
-		Ip   string `json:"ip"`
-		Port int    `json:"port"`
-	} `json:"default"`
+	DefaultMapping *DefaultAllocationMapping `json:"default"`
 
 	// Mappings contains all the ports that should be assigned to a given server
 	// attached to the IP they correspond to.

environment/docker/api.go

@@ -10,6 +10,7 @@ import (
 
 	"emperror.dev/errors"
 	"github.com/docker/docker/api/types"
+	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/versions"
 	"github.com/docker/docker/client"
 	"github.com/docker/docker/errdefs"
@@ -49,7 +50,7 @@ func configure(c *client.Client) {
 // a large number of requests to this endpoint are spawned by Wings, and the
 // standard "encoding/json" shows its performance woes badly even with single
 // containers running.
-func (e *Environment) ContainerInspect(ctx context.Context) (types.ContainerJSON, error) {
+func (e *Environment) ContainerInspect(ctx context.Context) (container.InspectResponse, error) {
 	configure(e.client)
 
 	// Support feature flagging of this functionality so that if something goes
@@ -59,7 +60,7 @@ func (e *Environment) ContainerInspect(ctx context.Context) (types.ContainerJSON
 		return e.client.ContainerInspect(ctx, e.Id)
 	}
 
-	var st types.ContainerJSON
+	var st container.InspectResponse
 	req, err := http.NewRequestWithContext(ctx, http.MethodGet, "/containers/"+e.Id+"/json", nil)
 	if err != nil {
 		return st, errors.WithStack(err)

environment/docker/container.go

@@ -155,11 +155,15 @@ func (e *Environment) Create() error {
 	cfg := config.Get()
 	a := e.Configuration.Allocations()
 	evs := e.Configuration.EnvironmentVariables()
-	for i, v := range evs {
-		// Convert 127.0.0.1 to the pelican0 network interface if the environment is Docker
-		// so that the server operates as expected.
-		if v == "SERVER_IP=127.0.0.1" {
-			evs[i] = "SERVER_IP=" + cfg.Docker.Network.Interface
+
+	// If port is 0 then we have a server with no allocation and this should stay 127.0.0.1 and not the docker network interface ip.
+	if a.DefaultMapping.Port != 0 {
+		for i, v := range evs {
+			// Convert 127.0.0.1 to the pelican0 network interface if the environment is Docker
+			// so that the server operates as expected.
+			if v == "SERVER_IP=127.0.0.1" {
+				evs[i] = "SERVER_IP=" + cfg.Docker.Network.Interface
+			}
 		}
 	}
 
@@ -196,31 +200,36 @@ func (e *Environment) Create() error {
 
 	networkMode := container.NetworkMode(cfg.Docker.Network.Mode)
 	if a.ForceOutgoingIP {
-		enableIPv6 := false
-		e.log().Debug("environment/docker: forcing outgoing IP address")
-		networkName := "ip-" + strings.ReplaceAll(strings.ReplaceAll(a.DefaultMapping.Ip, ".", "-"), ":", "-")
-		networkMode = container.NetworkMode(networkName)
-
-		if _, err := e.client.NetworkInspect(ctx, networkName, network.InspectOptions{}); err != nil {
-			if !client.IsErrNotFound(err) {
-				return err
-			}
+		// We can't use ForceOutgoingIP if we made a server with no allocation
+		if a.DefaultMapping.Port != 0 {
+			enableIPv6 := false
+			e.log().Debug("environment/docker: forcing outgoing IP address")
+			networkName := "ip-" + strings.ReplaceAll(strings.ReplaceAll(a.DefaultMapping.Ip, ".", "-"), ":", "-")
+			networkMode = container.NetworkMode(networkName)
+
+			if _, err := e.client.NetworkInspect(ctx, networkName, network.InspectOptions{}); err != nil {
+				if !client.IsErrNotFound(err) {
+					return err
+				}
 
-			if _, err := e.client.NetworkCreate(ctx, networkName, network.CreateOptions{
-				Driver:     "bridge",
-				EnableIPv6: &enableIPv6,
-				Internal:   false,
-				Attachable: false,
-				Ingress:    false,
-				ConfigOnly: false,
-				Options: map[string]string{
-					"encryption": "false",
-					"com.docker.network.bridge.default_bridge": "false",
-					"com.docker.network.host_ipv4":             a.DefaultMapping.Ip,
-				},
-			}); err != nil {
-				return err
+				if _, err := e.client.NetworkCreate(ctx, networkName, network.CreateOptions{
+					Driver:     "bridge",
+					EnableIPv6: &enableIPv6,
+					Internal:   false,
+					Attachable: false,
+					Ingress:    false,
+					ConfigOnly: false,
+					Options: map[string]string{
+						"encryption": "false",
+						"com.docker.network.bridge.default_bridge": "false",
+						"com.docker.network.host_ipv4":             a.DefaultMapping.Ip,
+					},
+				}); err != nil {
+					return err
+				}
 			}
+		} else {
+			e.log().Warn("environment/docker: Cannot force outgoing IP - server has no allocation")
 		}
 	}
 

go.mod

@@ -151,4 +151,4 @@ require (
 	modernc.org/mathutil v1.6.0 // indirect
 	modernc.org/memory v1.8.0 // indirect
 	modernc.org/sqlite v1.29.6 // indirect
-)
+)

go.sum

@@ -714,4 +714,4 @@ nullprogram.com/x/optparse v1.0.0/go.mod h1:KdyPE+Igbe0jQUrVfMqDMeJQIJZEuyV7pjYm
 rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
 rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=
 rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
-rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
+rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=

server/server.go

@@ -166,6 +166,7 @@ func DetermineServerTimezone(envvars map[string]interface{}, defaultTimezone str
 	return defaultTimezone
 }
 
+
 // parseInvocation parses the start command in the same way we already do in the entrypoint
 // We can use this to set the container command with all variables replaced.
 func parseInvocation(invocation string, envvars map[string]interface{}, memory int64, port int, ip string) (parsed string) {