docker-compose network ipam config values are not allowed

[minmay]

It seems as though either the documentation is wrong, or there is a problem with reading the networks ipam config properties.

Docker Version 1.13.1-beta42 (15350)
Channel: beta
2ffb2b4915

version: '3'
...
networks:
  test:
    driver: bridge
    ipam:
      config:
        - subnet: 172.28.0.0/16
          ip_range: 172.28.0.0/24
          gateway: 172.28.0.255
          aux_addreses:
            db: 172.28.0.1
            ui: 172.28.0.5

$docker-compose up
The Compose file './docker-compose.yml' is invalid because:
networks.test.ipam.config value Additional properties are not allowed ('aux_addreses', 'ip_range', 'gateway' were unexpected)

[shin-]

Please see #4366

[minmay]

Yes, #4366 will probably have the same route cause. However, that ticket fails to state that aux_addresses, and ip_range are invalid values. Is the documentation wrong? Or is the code wrong? Because when I view the docker-compose file reference, it lists those options.

[shin-]

It's a documentation issue. I just submitted docker/docs#1636 which should help.

[minmay]

alright, thank you!

[shin-]

Thank you for your report. Docs have now been updated, so I'll close the ticket.

[blop]

docker/docs#1636 (comment)

[jamallmahmoudi]

Test with this simple syntax.
networks:
entry-net:
driver: overlay
external:
name: entry_entry-net

agent_network:
driver: overlay
attachable: true
ipam:
config:
- subnet: 172.21.0.0/16