Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remote API docs - Create Network - IPAM driver missing #26853

Closed
Khazrak opened this issue Sep 23, 2016 · 2 comments · Fixed by #26857
Closed

Remote API docs - Create Network - IPAM driver missing #26853

Khazrak opened this issue Sep 23, 2016 · 2 comments · Fixed by #26857
Labels
area/docs kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. version/1.12

Comments

@Khazrak
Copy link

Khazrak commented Sep 23, 2016

Description
In the documentation for the Remote API in the request Json for creating a network the IPAM part of the json is missing "Driver".
In the cli this is sent by --ipam-driver string

https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/create-a-network
(maybe earlier docs also)

Steps to reproduce the issue:

  1. Create a new network
  2. Check the Json that is sent

Describe the results you received:
No Documentation to set Driver for IPAM

Describe the results you expected:
Documentation to set Driver for IPAM

Additional information you deem important (e.g. issue happens only occasionally):

Output of docker version:

Client:
 Version:      1.12.1
 API version:  1.24
 Go version:   go1.7
 Git commit:   23cf638
 Built:        Fri Aug 19 02:03:02 2016
 OS/Arch:      linux/amd64

Server:
 Version:      1.12.1
 API version:  1.24
 Go version:   go1.7
 Git commit:   23cf638
 Built:        Fri Aug 19 02:03:02 2016
 OS/Arch:      linux/amd64

Output of docker info:

Containers: 3
 Running: 0
 Paused: 0
 Stopped: 3
Images: 4
Server Version: 1.12.1
Storage Driver: devicemapper
 Pool Name: docker-253:1-10223820-pool
 Pool Blocksize: 65.54 kB
 Base Device Size: 10.74 GB
 Backing Filesystem: xfs
 Data file: /dev/loop0
 Metadata file: /dev/loop1
 Data Space Used: 885.9 MB
 Data Space Total: 107.4 GB
 Data Space Available: 106.5 GB
 Metadata Space Used: 1.847 MB
 Metadata Space Total: 2.147 GB
 Metadata Space Available: 2.146 GB
 Thin Pool Minimum Free Space: 10.74 GB
 Udev Sync Supported: true
 Deferred Removal Enabled: false
 Deferred Deletion Enabled: false
 Deferred Deleted Device Count: 0
 Data loop file: /var/lib/docker/devicemapper/devicemapper/data
 WARNING: Usage of loopback devices is strongly discouraged for production use. Use `--storage-opt dm.thinpooldev` to specify a custom block storage device.
 Metadata loop file: /var/lib/docker/devicemapper/devicemapper/metadata
 Library Version: 1.02.134 (2016-09-07)
Logging Driver: json-file
Cgroup Driver: cgroupfs
Plugins:
 Volume: local
 Network: bridge host null overlay
Swarm: inactive
Runtimes: runc
Default Runtime: runc
Security Options: seccomp
Kernel Version: 4.7.4-1-ARCH
Operating System: Arch Linux
OSType: linux
Architecture: x86_64
CPUs: 8
Total Memory: 23.49 GiB
Name: karl_rog
ID: IOCD:Y7FK:RDB6:43I7:QLCF:OBP5:LKJR:QLYD:NC6U:V7GA:ROQA:TCVE
Docker Root Dir: /var/lib/docker
Debug Mode (client): false
Debug Mode (server): false
Registry: https://index.docker.io/v1/
Insecure Registries:
 127.0.0.0/8

Additional environment details (AWS, VirtualBox, physical, etc.):

@thaJeztah thaJeztah added kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. area/docs labels Sep 23, 2016
@thaJeztah
Copy link
Member

Thanks! Looks like the options below IPAM were not documented. Note that the "Driver" is not a require parameter (default is used when omitted)

Working on a PR to add those options to the docs

@thaJeztah
Copy link
Member

PR is up; #26857

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. version/1.12
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants