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

Solution 1

The equivalent configuration for docker-compose v3 is using the network_mode key: https://docs.docker.com/compose/compose-file/compose-file-v3/#network_mode

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

If using docker swarm, see codestation's answer.

Solution 2

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.

Solution 3

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

Solution 4

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

Solution 5

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

View more solutions

Comments

[codestation]

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.

[A.Dumas]

Currently I use the swarm. but when I use docker-compose up also returns services.web.build contains unsupported option: 'network'

[codestation]

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)

[A.Dumas]

Thank you for the clarification. I want to use compose deployment and will add it to the question

[A.Dumas]

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]

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

[A.Dumas]

I added net to my compose file but the net property is ignored

[ford]

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

[A.Dumas]

tried both but the network_mode still get the ignore

[A.Dumas]

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

[A.Dumas]

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

[Gianmarco Carrieri]

try to use the version 3.7 of docker-compose

[Bob]

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

[Suz'l Shrestha]

Thank you. Saved my life.