docs: add missing IPAM options to API docs #26857
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aboch
reviewed
Sep 26, 2016
| @@ -3045,6 +3045,7 @@ Content-Type: application/json | |||
| "Id": "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99", | |||
| "Scope": "local", | |||
| "Driver": "bridge", | |||
| "EnableIPv6": false, | |||
There was a problem hiding this comment.
I think this is a spurious change, and this flag was not ther ein 1.22 API version
There was a problem hiding this comment.
Good catch! removed it :)
thaJeztah
force-pushed
the
docs-add-missing-IPAM-options
branch
2 times, most recently
from
786254a
to
bd87eab
Compare
aboch
reviewed
Sep 26, 2016
| - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver | ||
| - **IPAM** - Optional custom IP scheme for the network | ||
| - **Driver** - Name of the IPAM driver to use. Defaults to `default` driver | ||
| - **Config** - List of IPAM configuration options, specified as a map: | ||
| `{"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>}` |
There was a problem hiding this comment.
If this has to be an exhaustive list, we should also add "AuxAddress": <device_name:IP address>
|
ping @thaJeztah 👼 |
Commit dd28ded brought in new networking features and API, but did not document the available IPAM options. This adds a description of those options. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
docs-add-missing-IPAM-options
branch
from
bd87eab
to
d69fce7
Compare
|
Yay, finally updated 😄 ping @aboch @vdemeester PTAL |
|
author LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #26853
Commit dd28ded (#16645)
brought in new networking features and API, but
did not document the available IPAM options.
This adds a description of those options.
Also change the value of
CheckDuplicateused in the examples,because "false" is the default, so not the best value to illustrate its usage
ping @mavenugo @aboch PTAL if descriptions are correct