Skip to content

Commit

Permalink
docs: add missing IPAM options to API docs
Browse files Browse the repository at this point in the history 
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>
  • Loading branch information
@thaJeztah
thaJeztah committed Oct 28, 2016
1 parent 406c19f commit d69fce7
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 8 deletions.
7 changes: 6 additions & 1 deletion docs/reference/api/docker_remote_api_v1.21.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2798,8 +2798,10 @@ Content-Type: application/json
{
"Name":"isolated_nw",
"CheckDuplicate":true,
"Driver":"bridge",
"IPAM":{
"Driver": "default",
"Config":[
{
"Subnet":"172.20.0.0/16",
Expand Down Expand Up @@ -2832,10 +2834,13 @@ Content-Type: application/json
**JSON parameters**:

- **Name** - The new network's name. this is a mandatory field
- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false`
- **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>, "AuxAddress": <device_name:IP address>}`
- **Options** - Network specific options to be used by the drivers
- **CheckDuplicate** - Requests daemon to check for networks with same name

### Connect a container to a network

Expand Down
8 changes: 7 additions & 1 deletion docs/reference/api/docker_remote_api_v1.22.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3118,8 +3118,10 @@ Content-Type: application/json
{
"Name":"isolated_nw",
"CheckDuplicate":true,
"Driver":"bridge",
"IPAM":{
"Driver": "default",
"Config":[
{
"Subnet":"172.20.0.0/16",
Expand Down Expand Up @@ -3160,10 +3162,14 @@ Content-Type: application/json
**JSON parameters**:

- **Name** - The new network's name. this is a mandatory field
- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false`
- **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>, "AuxAddress": <device_name:IP address>}`
- **Options** - Driver-specific options, specified as a map: `{"option":"value" [,"option2":"value2"]}`
- **Options** - Network specific options to be used by the drivers
- **CheckDuplicate** - Requests daemon to check for networks with same name

### Connect a container to a network

Expand Down
9 changes: 7 additions & 2 deletions docs/reference/api/docker_remote_api_v1.23.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3217,10 +3217,11 @@ Content-Type: application/json
{
"Name":"isolated_nw",
"CheckDuplicate":false,
"CheckDuplicate":true,
"Driver":"bridge",
"EnableIPv6": true,
"IPAM":{
"Driver": "default",
"Config":[
{
"Subnet":"172.20.0.0/16",
Expand Down Expand Up @@ -3273,10 +3274,14 @@ Content-Type: application/json
**JSON parameters**:

- **Name** - The new network's name. this is a mandatory field
- **CheckDuplicate** - Requests daemon to check for networks with same name
- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false`
- **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver
- **Internal** - Restrict external access to the network
- **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>, "AuxAddress": <device_name:IP address>}`
- **Options** - Driver-specific options, specified as a map: `{"option":"value" [,"option2":"value2"]}`
- **EnableIPv6** - Enable IPv6 on the network
- **Options** - Network specific options to be used by the drivers
- **Labels** - Labels to set on the network, specified as a map: `{"key":"value" [,"key2":"value2"]}`
Expand Down
9 changes: 7 additions & 2 deletions docs/reference/api/docker_remote_api_v1.24.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3267,10 +3267,11 @@ Content-Type: application/json
{
"Name":"isolated_nw",
"CheckDuplicate":false,
"CheckDuplicate":true,
"Driver":"bridge",
"EnableIPv6": true,
"IPAM":{
"Driver": "default",
"Config":[
{
"Subnet":"172.20.0.0/16",
Expand Down Expand Up @@ -3323,10 +3324,14 @@ Content-Type: application/json
**JSON parameters**:

- **Name** - The new network's name. this is a mandatory field
- **CheckDuplicate** - Requests daemon to check for networks with same name
- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false`
- **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver
- **Internal** - Restrict external access to the network
- **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>, "AuxAddress": <device_name:IP address>}`
- **Options** - Driver-specific options, specified as a map: `{"option":"value" [,"option2":"value2"]}`
- **EnableIPv6** - Enable IPv6 on the network
- **Options** - Network specific options to be used by the drivers
- **Labels** - Labels to set on the network, specified as a map: `{"key":"value" [,"key2":"value2"]}`
Expand Down
9 changes: 7 additions & 2 deletions docs/reference/api/docker_remote_api_v1.25.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3742,10 +3742,11 @@ Content-Type: application/json
{
"Name":"isolated_nw",
"CheckDuplicate":false,
"CheckDuplicate":true,
"Driver":"bridge",
"EnableIPv6": true,
"IPAM":{
"Driver": "default",
"Config":[
{
"Subnet":"172.20.0.0/16",
Expand Down Expand Up @@ -3798,10 +3799,14 @@ Content-Type: application/json
**JSON parameters**:

- **Name** - The new network's name. this is a mandatory field
- **CheckDuplicate** - Requests daemon to check for networks with same name
- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false`
- **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver
- **Internal** - Restrict external access to the network
- **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>, "AuxAddress": <device_name:IP address>}`
- **Options** - Driver-specific options, specified as a map: `{"option":"value" [,"option2":"value2"]}`
- **EnableIPv6** - Enable IPv6 on the network
- **Options** - Network specific options to be used by the drivers
- **Labels** - Labels to set on the network, specified as a map: `{"key":"value" [,"key2":"value2"]}`
Expand Down

0 comments on commit d69fce7

Please sign in to comment.