Enable game server ip address allocation for macvlan driver. #49

Freddo3000 · 2024-10-29T04:20:42Z

This is pterodactyl/wings#203 cherrypicked onto current main branch.

Issue:
For macvlan driver default docker config assign first available ip. Game servers get ip assigned in order of container creation.

Solution proposal:
Wings support only one docker network for each game server. To assign correct IP default allocation could be used. Allocations > doesn't limit IPs at all, admin could set desired game server container ip and port by default allocation.

Tagging @madpeteguy for notice.

Issue: For macvlan driver default docker config assign first available ip. Game servers get ip assigned in order of container creation. Solution proposal: Wings support only one docker network for each game server. To assign correct IP default allocation could be used. Allocations doesn't limit IPs at all, admin could set desired game server container ip and port by default allocation.

QuintenQVD0 · 2024-11-03T11:16:21Z

This seems fine to me. I don't think it would work yet as our config loading order still first loads the default struct

madpeteguy · 2024-11-29T05:49:43Z

I can test if it will work with pelican.
This would be a good reason for me to switch from pterodactyl.
For my setup this feature is a must, and I'm tired of building own images. Using official ones is more convenient for my homelab cd.

Freddo3000 · 2024-12-04T02:19:58Z

I can test if it will work with pelican. This would be a good reason for me to switch from pterodactyl. For my setup this feature is a must, and I'm tired of building own images. Using official ones is more convenient for my homelab cd.

I've been running it for more than a month now without any noteworthy issue.

QuintenQVD0 · 2024-12-04T06:42:19Z

I can test if it will work with pelican. This would be a good reason for me to switch from pterodactyl. For my setup this feature is a must, and I'm tired of building own images. Using official ones is more convenient for my homelab cd.

I've been running it for more than a month now without any noteworthy issue.

The question is does it still work for people that does not use macvlan.

madpeteguy · 2024-12-04T12:23:36Z

I can test if it will work with pelican. This would be a good reason for me to switch from pterodactyl. For my setup this feature is a must, and I'm tired of building own images. Using official ones is more convenient for my homelab cd.

I've been running it for more than a month now without any noteworthy issue.

The question is does it still work for people that does not use macvlan.

In short: the proposed change applies only to wings that set docker.network.driver == “macvlan” in the configuration, for standard bridge and host allocations work as before.

The current implementation does not work for an interface of type macvlan, because server containers that connect to this type of network receive the first free IP address from the network pool, so there is no way to determine on which IP the game server will be available (unless we have only one server on this network).

My proposed fix makes the containers assigned to macvlan receive an IP address from the Default Allocation in the server configuration.
If the other allocations are assigned other IP addresses then those IP addresses will be ignored.

It is worth remembering that the use of macvlan has its security downsides, I can describe the ones I know of if necessary.
In addition, port allocations in the case of macvlan are only for informational purposes in the panel, in the network configuration they have no meaning.

Edit:
I am not a GO programmer, but i think this line may not be null safe: var serverNetConfig = config.Get().Docker.Network.
It's worth checking whether there will be a problem in the absence of a docker network configuration.

QuintenQVD0 · 2024-12-21T10:08:26Z

I can test if it will work with pelican. This would be a good reason for me to switch from pterodactyl. For my setup this feature is a must, and I'm tired of building own images. Using official ones is more convenient for my homelab cd.

I've been running it for more than a month now without any noteworthy issue.

The question is does it still work for people that does not use macvlan.

In short: the proposed change applies only to wings that set docker.network.driver == “macvlan” in the configuration, for standard bridge and host allocations work as before.

The current implementation does not work for an interface of type macvlan, because server containers that connect to this type of network receive the first free IP address from the network pool, so there is no way to determine on which IP the game server will be available (unless we have only one server on this network).

My proposed fix makes the containers assigned to macvlan receive an IP address from the Default Allocation in the server configuration. If the other allocations are assigned other IP addresses then those IP addresses will be ignored.

It is worth remembering that the use of macvlan has its security downsides, I can describe the ones I know of if necessary. In addition, port allocations in the case of macvlan are only for informational purposes in the panel, in the network configuration they have no meaning.

Edit: I am not a GO programmer, but i think this line may not be null safe: var serverNetConfig = config.Get().Docker.Network. It's worth checking whether there will be a problem in the absence of a docker network configuration.

The config logic should fil in all fields that are empty and can not be empty

Crunch41 · 2025-02-15T18:53:38Z

@madpeteguy Would you happen to have a pelican build with this fix? Was using your pterodactyl build on unraid but want to move over to pelican & was bummed to find out pelican defaults to the default first available ip same as pterodactyl. Would love to see this officially merged into pelican whenever / if possible.

Edit: Made my own build here https://hub.docker.com/r/crunch41/pelican-wing hope that's alright, Have only tested on unraid but looks like it works as it should now with specified ip addresses being assigned. Only wish you could change the docker container names now haha

madpeteguy · 2025-02-16T14:09:16Z

@Crunch41 Sorry, I did not have time to migrate to Pelican yet.

KeyboardDabbler · 2025-02-27T10:31:06Z

@Crunch41 Thank you for making this image available with the pull changes, and a big thanks to @madpeteguy for making it possible!

I’m currently using this build on Unraid after also encountering issues with the way the default egg/container is created and how IPs are assigned sequentially on a macvlan network.

So far, everything has worked great on a fresh install. However, when migrating from an existing install to this image, I noticed SQL database errors when deleting existing port allocations and attempting to remove allocations. I’ll do further testing and provide more details to help investigate.

Copilot

Pull Request Overview

This PR cherry-picks support for assigning a specific IP from the default allocation when using the macvlan Docker driver, ensuring game servers receive the intended address.

Imported Docker’s network types and added logic to detect macvlan driver.
Constructed a NetworkingConfig using the server’s default allocation IP and gateway.
Updated both server/install.go and environment/docker/container.go to pass the new config into ContainerCreate.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
server/install.go	Added macvlan network config generation and passed it into the container creation call.
environment/docker/container.go	Mirrored macvlan networking logic in the environment’s `Create` method for consistency.

Comments suppressed due to low confidence (2)

server/install.go:464

[nitpick] Consider renaming defaultMapping to something more descriptive like ipAllocation to improve readability.

		var defaultMapping = ip.Server.Config().Allocations.DefaultMapping

environment/docker/container.go:264

There are no tests covering the newly added macvlan network configuration path; consider adding unit tests to verify correct behavior.

	var netConf *network.NetworkingConfig = nil //In case when no networking config is needed set nil

Copilot · 2025-06-26T06:46:16Z

server/install.go

 	}()

-	r, err := ip.client.ContainerCreate(ctx, conf, hostConf, nil, nil, ip.Server.ID()+"_installer")
+	var netConf *network.NetworkingConfig = nil //In case when no networking config is needed set nil


You can simplify the nil initialization by declaring var netConf *network.NetworkingConfig without explicitly assigning nil.

Suggested change

var netConf *network.NetworkingConfig = nil //In case when no networking config is needed set nil

var netConf *network.NetworkingConfig // In case when no networking config is needed, defaults to nil

server/install.go

Copilot · 2025-06-26T06:46:17Z

server/install.go

+	var serverNetConfig = config.Get().Docker.Network
+	if "macvlan" == serverNetConfig.Driver { //Generate networking config for macvlan driver
+		var defaultMapping = ip.Server.Config().Allocations.DefaultMapping
+		ip.Server.Log().Debug("Set macvlan " + serverNetConfig.Name + " IP to " + defaultMapping.Ip)


[nitpick] Use formatted logging (e.g., Debugf) instead of string concatenation for better readability and performance.

Suggested change

ip.Server.Log().Debug("Set macvlan " + serverNetConfig.Name + " IP to " + defaultMapping.Ip)

ip.Server.Log().Debugf("Set macvlan %s IP to %s", serverNetConfig.Name, defaultMapping.Ip)

server/install.go

parkervcp

LGTM

lancepioch assigned QuintenQVD0 Jun 25, 2025

lancepioch requested a review from Copilot June 25, 2025 23:56

This comment was marked as outdated.

Sign in to view

QuintenQVD0 requested a review from Copilot June 26, 2025 06:45

Copilot AI reviewed Jun 26, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/main' into feature/macvlan

6ac7b3f

Freddo3000 requested a review from a team as a code owner July 11, 2025 11:47

QuintenQVD0 requested a review from parkervcp October 11, 2025 07:40

parkervcp approved these changes Dec 19, 2025

View reviewed changes

parkervcp merged commit 2647985 into pelican-dev:main Dec 19, 2025
6 checks passed

Freddo3000 deleted the feature/macvlan branch December 22, 2025 01:35

	var netConf *network.NetworkingConfig = nil //In case when no networking config is needed set nil
	var netConf *network.NetworkingConfig // In case when no networking config is needed, defaults to nil

	ip.Server.Log().Debug("Set macvlan " + serverNetConfig.Name + " IP to " + defaultMapping.Ip)
	ip.Server.Log().Debugf("Set macvlan %s IP to %s", serverNetConfig.Name, defaultMapping.Ip)

Enable game server ip address allocation for macvlan driver. #49

Enable game server ip address allocation for macvlan driver. #49

Uh oh!

Conversation

Freddo3000 commented Oct 29, 2024

Uh oh!

QuintenQVD0 commented Nov 3, 2024

Uh oh!

madpeteguy commented Nov 29, 2024

Uh oh!

Freddo3000 commented Dec 4, 2024

Uh oh!

QuintenQVD0 commented Dec 4, 2024

Uh oh!

madpeteguy commented Dec 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

QuintenQVD0 commented Dec 21, 2024

Uh oh!

Crunch41 commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

madpeteguy commented Feb 16, 2025

Uh oh!

KeyboardDabbler commented Feb 27, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

parkervcp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

madpeteguy commented Dec 4, 2024 •

edited

Loading

Crunch41 commented Feb 15, 2025 •

edited

Loading