Docker Network Should Support Specifying Node

[ben-freke]

Is your feature request related to a problem? Please describe

I am trying to create macvlan networks on several Docker Swarm nodes. Whilst I know this is straying from a best-practice architecture, Swarm and Portainer do support this.

When creating a configuration-only network on Docker Swrm, the Portainer UI allows the user to specify which node they wish to configure the network on.

From a bit of digging, it looks like this is passed in the X-PortainerAgent-Target request in order to arrive on the correct node.

However, the portainer_docker_network resource does not support supplying the Node ID with the request, meaning it's always created on the node the Server is running on.

Describe the solution you'd like

An attribute on the resource that allows the user to specify the Node ID that the network is going to be created on for configuration-only networks. Terraform would then pass this in the request header as above. This option would be available on either config_only configurations for macvlan drivers or networks created with ipvlan drivers. For example:

resource "portainer_docker_network" "macvlan_config" {
  endpoint_id = 1
  name        = "macvlan-config"
  driver      = "macvlan"
  attachable  = false
  config_only = true
  swarm_node = my-swarm-node
}

It looks like whilst the UI Screenshot I posted above supports selecting multiple for one config, it's making multiple calls under the hood.

Describe alternatives you've considered

I am currently creating the configuration-only networks manually in the console, and then using the portainer_docker_network in Terraform to use config_from and consuming the manually-created resources. This is not ideal, especially as there is currently no import functionality for docker_network meaning that the entire network will need to be destroyed and re-created.

Additional context

Just to add some additional context, the typical approach here for macvlan in swarm is to:

1. Create a config-only network on each node (this is the aim of this feature request)
2. Create a network from this config (by name) with the scope of the swarm.

[grulicht]

Hi @ben-freke

Thanks a lot for using the Portainer Terraform provider and for taking the time to raise this issue!🙌🏽

You’re absolutely right — implementing both the ability to specify the swarm_node, setting the X-PortainerAgent-Target header for config-only networks is now not implement.

We’re confirming acceptance of this feature request, and we will proceed with the implementation.
Once it is done and released, we will let you know here.🤝🏽

Thanks again — feel free to reach out with any other ideas or needs regarding the provider!👍🏽

[grulicht]

Hi @ben-freke 👋

Thanks again for raising this!

We’re happy to let you know that starting from v1.7.0, the portainer_docker_network resource has been enhanced to support specifying the target Swarm node for macvlan networks created.

• This feature has been implemented and tested. You can now define the target node using the appropriate attribute and the provider will pass the X-PortainerAgent-Target header automatically as needed.

• You can find info in the documnetation - Terraform Registry.

• This should resolve your use case entirely – allowing you to automate macvlan configuration-only networks per node in Swarm directly via Terraform, without needing manual CLI steps or external setup.

Thanks again for using the Portainer Terraform provider! 🙌

[ben-freke]

This is really great news, thanks @grulicht 👍 I'll give this a whirl later this week! Thanks for getting it done so fast 💪

[grulicht]

@ben-freke Great, let me know if everything works as it should or if something still needs to be fine-tuned to make it work 100% as you need it. 🙌

[ben-freke]

Hey @grulicht 👋🏼 Apologies for the delay in testing this out, I've been on an extended holiday.

I've got:

resource "portainer_docker_network" "this" {
  endpoint_id = var.portainer_endpoint_id
  name        = "network-name"
  driver      = "macvlan"
  config_only = true
  swarm_node_id = "node-id"
  options = {
    "parent"           = "bond0.1"
  }
}

Which I think, looking at the docs, is correct. But I recieve

Error: failed to create docker network: {"message":"configuration network can only contain network specific fields. Network operator fields like [ ingress | internal | attachable | scope ] are not supported."}

I have a feeling this might be caused by the defaults, as the plan generates:

  # portainer_docker_network.this will be created
  + resource "portainer_docker_network" "this" {
      + attachable    = false
      + config_only   = true
      + driver        = "macvlan"
      + enable_ipv4   = true
      + enable_ipv6   = false
      + endpoint_id   = 1
      + id            = (known after apply)
      + ingress       = false
      + internal      = false
      + ipam_driver   = "default"
      + name          = "network-name"
      + options       = {
          + "parent" = "bond0.1"
        }
      + scope         = "local"
      + swarm_node_id = "node-id"
    }

When I try and specify ingress = null, it doesn't override the default.

Running version 1.11.0

[grulicht]

@ben-freke Hi, at the weekend I will check this. 🙌

[grulicht]

Hi @ben-freke ,
new release version v1.12.0 with patch is out. 🙌