[BUG] incorrect label com.docker.compose.network

[danie-dejager]

Description

I see that a change for better diagnostic message on network label mismatch by @ndeloof in #10639 is possibly creating the following errors when I'm updating zabbix or gitlab using version 2.19.1.
I am able to update when using docker-compose version 2.18.1

network zabbix was found but has incorrect label com.docker.compose.network set to "zabbix"

 "Labels": {
 "com.docker.compose.network": "zabbix",
 "com.docker.compose.project": "zabbix-server",
 "com.docker.compose.version": "1.25.5"
 }

network gitlab was found but has incorrect label com.docker.compose.network set to "gitlab"

 "Labels": {
 "com.docker.compose.network": "gitlab",
 "com.docker.compose.project": "gitlab",
 "com.docker.compose.version": "1.25.5"
 }

I'm not sure how to fix this. Could the error be a bit more descriptive? Can I delete the com.docker.compose.network label or must it be another value?

Steps To Reproduce

docker-compose --env-file=/opt/docker/.env.prod.aws -f /opt/devops/zabbix-server/docker-compose.yml up -d --force-recreate

Compose Version

2.19.1

Docker Environment

Client:
 Context: default
 Debug Mode: false
 Plugins:
 app: Docker App (Docker Inc., v0.9.1-beta3)
 buildx: Build with BuildKit (Docker Inc., v0.5.1-docker)
 scan: Docker Scan (Docker Inc.)

Server:
 Containers: 5
 Running: 5
 Paused: 0
 Stopped: 0
 Images: 17
 Server Version: 20.10.6
 Storage Driver: overlay2
 Backing Filesystem: xfs
 Supports d_type: true
 Native Overlay Diff: false
 userxattr: false
 Logging Driver: json-file
 Cgroup Driver: cgroupfs
 Cgroup Version: 1
 Plugins:
 Volume: local
 Network: bridge host ipvlan macvlan null overlay
 Log: awslogs fluentd gcplogs gelf journald json-file local logentries splunk syslog
 Swarm: inactive
 Runtimes: io.containerd.runc.v2 io.containerd.runtime.v1.linux runc
 Default Runtime: runc
 Init Binary: docker-init
 containerd version: d71fcd7d8303cbf684402823e425e9dd2e99285d
 runc version: b9ee9c6314599f1b4a7f497e1f1f856fe433d3b7
 init version: de40ad0
 Security Options:
 seccomp
 Profile: default
 Kernel Version: 5.4.17-2136.320.7.1.el7uek.x86_64
 Operating System: CentOS Linux 7 (Core)
 OSType: linux
 Architecture: x86_64
 CPUs: 4
 Total Memory: 15.12GiB
 Name: gaewp-dkl
 ID: NDCY:5WEL:3U23:VFFD:QE7A:ZFZW:3RW3:Q5O3:7NLE:5LQ4:JXDF:5YR4
 Docker Root Dir: /var/lib/docker
 Debug Mode: false
 Registry: https://index.docker.io/v1/
 Labels:
 Experimental: false
 Insecure Registries:
 127.0.0.0/8
 Live Restore Enabled: false

Anything else?

No response

[hugoghx]

My error: network net1 was found but has incorrect label com.docker.compose.network set to "net1".

This problem is present on v2.20.0 and v2.19.1. It is not present on v2.18.1.

My docker-compose file's networks looks like this:

networks:
 default:
 name: "net1"

 net1:
 name: "net1"
 ipam:
 config:
 - subnet: "172.21.0.0/16"

 internalnet:
 name: "internalnet"
 driver: "bridge"
 internal: true

 vpn:
 name: "vpn"
 driver: "bridge"
 ipam:
 config:
 - subnet: "172.10.0.0/16"

These networks are then used by the services based on connectivity requirements.

I used

networks:
 default:
 name: "net1"

To set the default network net1 for all containers.
With the introduction of v2.19.1, this stopped working.

[ndeloof]

@hugoamvieira you should not have default network set with same name as net1 network, from a compose model point of view those define two networks. Should be just one used as default:

networks:
 default:
 name: "net1"
 ipam:
 config:
 - subnet: "172.21.0.0/16"

[ndeloof]

@daniejstriata please attach your compose.yaml file for diagnostic

[danie-dejager]

@ndeloof Here it is:

version: "3.8"
services:
 gitlab:
 image: gitlab/gitlab-ce:15.11.11-ce.0 
 container_name: gitlab
 hostname: ${DOCKERHOSTNAME}
 networks:
 nonet:
 ipv4_address: ${IP}
 restart: always
 ports:
 - ${LISTENIP}:443:443
 - ${LISTENIP}:80:80
 - ${LISTENIPSSH}:22:22
 volumes:
 - /opt/devops/dockers/projects/gitlab/sshd_config.d/:/etc/ssh/sshd_config.d:ro
 - /opt/devops/dockers/projects/gitlab/conf/:/etc/gitlab:rw
 - logs:/var/log/gitlab:rw
 - data:/var/opt/gitlab:rw

networks:
 nonet:
 name: gitlab
 ipam:
 driver: default
 config:
 - subnet: ${SUBNET}

volumes:
 data:
 name: gitlab-data
 external: true
 logs:
 name: gitlab-logs
 external: true

[hugoghx]

@hugoamvieira you should not have default network set with same name as net1 network, from a compose model point of view those define two networks. Should be just one used as default:

networks:
 default:
 name: "net1"
 ipam:
 config:
 - subnet: "172.21.0.0/16"

Hey @ndeloof, thanks for the tip! I did try this, but I ran into another problem where I couldn't reference net1 in the containers' networks block. I saw this error: service "<service_name>" refers to undefined network net1: invalid compose project

As far as my understanding goes, if I define a networks block for a container, it will only be associated with the networks within that block, even if a default is specified.

So, if I want a container to be on a network in addition to the default one, I have to specify the default one. This is what I tried:

container:
 image: "bla"
 ...
 networks:
 - "net1"
 - "other-net"

But this leads to the error above.

Perhaps the correct way here is to refer to the default network not by its name but by its object key default?

container:
 image: "bla"
 ...
 networks:
 - "default"
 - "other-net"

This seemed to work, and inspecting the network at runtime does show the containers are associated with net1.

[rtaft]

I'll throw my error out there too, started after an update to 2.19.1.

WARN[0000] a network with name traefik exists but was not created by compose.
Set `external: true` to use an existing network
network traefik was found but has incorrect label com.docker.compose.network set to ""

networks:
 db:
 traefik:
 external: true

Nothing has changed in our compose file.

[ndeloof]

Perhaps the correct way here is to refer to the default network not by its name but by its object key default?

yes indeed, the networks attribute in service definition refers to keys. By the way you can use net1 if you prefer this over default, just don't use 2 entries to define a single network

[mrsarm]

Same issue. Downgrading to 2.18.1 solved it.

If you are going to do the downgrade as a workaround, don't expect (like me 😅) that downgrading docker will downgrade the compose plugin, at least in Ubuntu using the docker-ce distribution you have to downgrade the compose plugin like this:

sudo apt install docker-compose-plugin=2.18.1-1~ubuntu.20.04~focal

[quiin]

I had the same "incorrect label" issue and after a docker system prune, everything went back to normal.

[ilude]

Run the following command to downgrade your docker-compose cli plugin on Ubuntu 22.04 (and above probably)

curl -SL https://github.com/docker/compose/releases/download/v2.18.1/docker-compose-linux-x86_64 -o /usr/local/lib/docker/cli-plugins/docker-compose

[rtaft]

@quiin That was the first thing I tried with no luck.

Our build structure is a bit more complex, we run multiple YML files together. If I only run one service at a time, it works fine on 2.20, but when I run multiple services at once, it fails. Each YML has the same networks entry...with the comment above about "don't use 2 entries to define a single network", I wonder if that would break with having the same network in more than one YML file.

[ndeloof]

I wonder if that would break with having the same network in more than one YML file.

network name is not unique, so running compose concurrently with the same config is at risk when it comes to network as network might be created multiple times and then confuses the other runs. A possible workaround is to first run a dump compose file which just creates required network and run some "hello world" container, then you should be able to run compose concurrently with same network configuration, as all execution will see an existing network matching the expected config.