How to use host network for docker compose?

Question

I want to use docker compose with the host network.

I have a docker container that access a local REST api. Usually I run

docker run --net=host -p 18080:8080 -t -i containera

which can access the host REST api which runs at http://127.0.0.1:8080. Since I want to scale the container containera I found docker compose to scale the container. But the docker compose file from the documentation does not work. The docker container does not query the REST API.

I tried the following compose file but the property

version: "3"
services:
  web:
    image: conatinera:latest
    network_mode: "host"
    deploy:
      replicas: 1
      resources:
        limits:
          cpus: "0.5"
          memory: 4G 
      restart_policy:
        condition: on-failure
    ports:
      - "18080:8080"

but the property network_mode is ignored/not allowed. with the message

Ignoring unsupported options: network_mode

Are you using docker swarm? How are you deploying? docker-compose up or docker stack deploy? Depending on this your current compose file can have several mistakes on it. — codestation
– codestation, Commented Jun 13, 2019 at 17:57
Currently I use the swarm. but when I use docker-compose up also returns services.web.build contains unsupported option: 'network' — A.Dumas
– A.Dumas, Commented Jun 13, 2019 at 18:10
Swarm and compose deployments are very different and your yml file is mostly invalid in both modes because you are mixing options from both modes. Please indicate what deployment method are you intending to use so you can get a proper answer (and add the docker-swarm tag and remove the docker-compose one depending what answer do you want) — codestation
– codestation, Commented Jun 13, 2019 at 18:17
Thank you for the clarification. I want to use compose deployment and will add it to the question — A.Dumas
– A.Dumas, Commented Jun 13, 2019 at 18:21

djvg · Accepted Answer · 2025-02-03 19:48:54Z

194

The equivalent configuration for docker-compose v3 is using the network_mode key:

https://docs.docker.com/reference/compose-file/services/#network_mode

You should set network_mode to "host" in your docker-compose.yml.

If using docker swarm, see codestation's answer.

edited Feb 3 at 19:48

djvg

14.8k7 gold badges84 silver badges120 bronze badges

answered Jun 13, 2019 at 14:17

ford

12.1k4 gold badges50 silver badges58 bronze badges

Sign up to request clarification or add additional context in comments.

8 Comments

A.Dumas Over a year ago

How can I use this network mode for version 3 in a swarm? or how can I add the network mode since I get a unsupported compose file version different from 3

ford Over a year ago

network_mode is used in v3 and v2. v1 called it net: docs.docker.com/compose/compose-file/compose-file-v1/#net

ford Over a year ago

With the compose file in your updated question, you have version: "3", so you should be using network_mode.

A.Dumas Over a year ago

tried both but the network_mode still get the ignore

user3379167 Over a year ago

When you set network_mode host you should get rid of the networks: stackoverflow.com/questions/63777655/…

|

codestation · Accepted Answer · 2019-06-13 18:24:54Z

94

You are mixing options that are invalid on either compose and swarm deployments.

If you are deploying with docker-compose up then your compose file should be like this:

version: "3"
services:
  web:
    image: conatinera:latest
    network_mode: "host"        
    restart: on-failure

Te options deploy is ignored on compose mode and the ports option is ignored when using host mode networking. I recommend to don't use host mode networking and use a reverse proxy in another container to balance your scaled containers.

(Feel free to ignore this part of the answer as you clarified that you aren't using swarm deployments).

If you are using swarm deployment then your compose file should be like this:

version: "3.4"
services:
  web:
    image: conatinera:latest
    deploy:
      replicas: 1
      resources:
        limits:
          cpus: "0.5"
          memory: 4G 
      restart_policy:
        condition: on-failure
    networks:
      - host

networks:
  host:
    name: host
    external: true

Again, published ports and host mode networking do not mix. Also is probably that your scaling will fail because all the containers will try to bind to the same port. I recommend to don't use host mode networking and let docker load balance your replicas.

answered Jun 13, 2019 at 18:24

codestation

3,5661 gold badge26 silver badges23 bronze badges

3 Comments

shgnInc Over a year ago

I get this error: networks.host Additional property name is not allowed

sorosh_sabz Over a year ago

I get this error: Error response from daemon: network-scoped alias is supported only for containers in user defined networks

Niklas Rosencrantz Oct 31 at 16:49

I don't understand.

Sadman Amin · Accepted Answer · 2021-09-05 11:03:08Z

33

I was facing the same problem. I found that when network_mode is set to host, port mapping doesn't work as the container will look for the port of the host. So, removing the port mapping worked for me like the following.

services:
  web-abc:
    build: ./abc
    # ports:
    #   - "7000:7000"
    volumes:
      - .:/code
    network_mode: host

answered Sep 5, 2021 at 11:03

Sadman Amin

5855 silver badges7 bronze badges

Comments

Victor Oduor · Accepted Answer · 2022-09-28 13:01:01Z

29

In docker compose this worked perfectly

extra_hosts:
      - "host.docker.internal:host-gateway"

here is an explanation What is the equivalent of --add-host=host.docker.internal:host-gateway in a Compose file

edited Sep 28, 2022 at 13:01

answered Sep 28, 2022 at 8:45

Victor Oduor

2993 silver badges3 bronze badges

2 Comments

Maksym Kosenko Over a year ago

If host REST api considers a client's request URL it will be like http(s)://host.docker.internal/restservice in your case, so if it is needed to get some specific URL feel free to use any alias instead of host.docker.internal, for example: specific-url.local:host-gateway

Eugene Over a year ago

Inside the container on a MacOS you may need to use docker.for.mac.host.internal instead of host.docker.internal

Ntwobike · Accepted Answer · 2020-07-07 15:28:50Z

13

Which platform you are on? host mode is working in Linux only AFAIK. If network_mode is not working try network: host?

version: '3.4'
serivces:
  some_service:
  build:
    network: host

edited Jul 7, 2020 at 15:28

answered Jun 13, 2019 at 16:19

Ntwobike

2,7691 gold badge24 silver badges29 bronze badges

3 Comments

A.Dumas Over a year ago

On arch linux I get the error message ` services.web.build Additional property network is not allowed`

Bunyod Over a year ago

on Ubuntu: Unsupported config option for services.build: 'network'

Developerium Over a year ago

This was the issue with my configuration, thank you

Gianmarco Carrieri · Accepted Answer · 2019-06-13 16:23:36Z

8

i think you should define the docker-compose file like this: This is just an example, please read the docuementation: https://docs.docker.com/compose/compose-file/#network-configuration-reference

version: "3"
services:
  web:
    image: conatinera:latest
    networks:
      mynetwork: {}
    deploy:
      replicas: 1
      resources:
        limits:
          cpus: "0.5"
          memory: 4G 
      restart_policy:
        condition: on-failure
    ports:
      - "18080:8080"
networks:
  mynetwork:
    external: true
    name: host

answered Jun 13, 2019 at 16:23

Gianmarco Carrieri

9192 gold badges11 silver badges20 bronze badges

3 Comments

A.Dumas Over a year ago

I get the error message name Additional property name is not allowed

Gianmarco Carrieri Over a year ago

try to use the version 3.7 of docker-compose

sorosh_sabz Over a year ago

I get this error: Error response from daemon: network-scoped alias is supported only for containers in user defined networks

isaadabbasi · Accepted Answer · 2022-02-01 10:11:08Z

2

network_mode: host is not allowed in swarm mode.

answered Feb 1, 2022 at 10:11

isaadabbasi

1076 bronze badges

Comments

Aryeh Leib Taurog · Accepted Answer · 2022-03-23 18:54:37Z

I myself did not have success with networks or network_mode, but if you want to access a network service on the host, you can simply have the host service listen on the docker0 network interface, which is accessible from the container (depending on your network mode) at the same ip address. Proof of concept below.

On the host:

$ ip -4 a | grep docker0
4: docker0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN group default 
    inet 172.17.0.1/16 brd 172.17.255.255 scope global docker0

$ echo hello world | nc -l -p 8888 -s 172.17.0.1

On the container:

$ docker run --rm -it alpine nc -w1 172.17.0.1 8888
hello world

Another way to make a host service accessible to a docker container is to listen on a unix socket, which can be mounted in the container.

Collectives™ on Stack Overflow

How to use host network for docker compose?

8 Answers 8

8 Comments

3 Comments

Comments

2 Comments

3 Comments

3 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

8 Comments

3 Comments

Comments

2 Comments

3 Comments

3 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related