openstack/neutron-lib
Code Issues Proposed changes

api ref for dns integration

Browse Source 
This patch adds info to the API reference for the dns-integration and
dns-domain-ports extension including details about the extension as well
as documented request/response parameters.

Change-Id: Ia5630ceb97d833b85d88cef323bcd2d6c9780c81
Closes-Bug: #1711992
This commit is contained in:
Boden R 2017-08-22 13:39:12 -06:00
parent 44b5a73d22
commit 2a0d9fa798
32 changed files with 208 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
api-ref/source/v2/floatingips.inc
View File

@ -2,6 +2,14 @@
Floating IPs (floatingips)
==========================
DNS integration
===============
The ``dns-integration`` extension adds the ``dns_name`` and ``dns_domain``
attributes to floating IPs allowing them to be specified at creation time.
The data in these attributes will be published in an external DNS service
when Neutron is configured to integrate with such a service.
List floating IPs
=================
@ -51,6 +59,8 @@ Response Parameters
- updated_at: updated_at_resource
- revision_number: revision_number
- description: description
- dns_domain: dns_domain
- dns_name: dns_name
- floating_network_id: floating_network_id
- fixed_ip_address: floatingip-fixed_ip_address
- floating_ip_address: floating_ip_address
@ -135,6 +145,8 @@ Request
- port_id: floatingip-port_id-post-request
- subnet_id: floatingip-subnet_id
- description: description-request
- dns_domain: dns_domain-request
- dns_name: dns_name-request
Request Example
---------------
@ -151,6 +163,8 @@ Response Parameters
- router_id: floatingip-router_id
- status: floatingip-status
- description: description
- dns_domain: dns_domain
- dns_name: dns_name
- tenant_id: project_id
- created_at: created_at_resource
- updated_at: updated_at_resource
@ -212,6 +226,8 @@ Response Parameters
- router_id: floatingip-router_id
- status: floatingip-status
- description: description
- dns_domain: dns_domain
- dns_name: dns_name
- tenant_id: project_id
- created_at: created_at_resource
- updated_at: updated_at_resource
@ -291,6 +307,8 @@ Response Parameters
- updated_at: updated_at_resource
- revision_number: revision_number
- description: description
- dns_domain: dns_domain
- dns_name: dns_name
Response Example
----------------

16
api-ref/source/v2/networks.inc
View File

@ -57,6 +57,14 @@ The ``net-mtu`` extension allows plug-ins to expose the MTU that is guaranteed
to pass through the data path of the segments in the network. This extension
introduces a read-only ``mtu`` attribute.
DNS integration
===============
The ``dns-integration`` extension adds the ``dns_domain`` attribute to networks.
The ``dns_domain`` of a network in conjunction with the ``dns_name`` attribute
of its ports will be published in an external DNS service when Neutron is
configured to integrate with such a service.
Show network details
====================
@ -92,6 +100,7 @@ Response Parameters
- availability_zone_hints: availability_zone_hints
- availability_zones: availability_zones
- created_at: created_at_resource
- dns_domain: dns_domain
- id: network-id
- mtu: mtu
- name: network-name
@ -148,6 +157,7 @@ Request
- network_id: network_id-path
- network: network
- admin_state_up: network-admin_state_up-request
- dns_domain: dns_domain-request
- name: network-name-request
- port_security_enabled: network-port_security_enabled-request
- provider:network_type: provider:network_type
@ -186,6 +196,7 @@ Response Parameters
- admin_state_up: network-admin_state_up
- availability_zone_hints: availability_zone_hints
- availability_zones: availability_zones
- dns_domain: dns_domain
- id: network-id
- mtu: mtu
- name: network-name
@ -282,6 +293,7 @@ Response Parameters
- admin_state_up: network-admin_state_up
- availability_zone_hints: availability_zone_hints
- availability_zones: availability_zones
- dns_domain: dns_domain
- id: network-id
- mtu: mtu
- name: network-name
@ -339,6 +351,7 @@ Request
- network: network
- admin_state_up: network-admin_state_up-request
- dns_domain: dns_domain-request
- name: network-name-request
- port_security_enabled: network-port_security_enabled-request
- project_id: project_id-request
@ -380,6 +393,7 @@ Response Parameters
- admin_state_up: network-admin_state_up
- availability_zone_hints: availability_zone_hints
- availability_zones: availability_zones
- dns_domain: dns_domain
- id: network-id
- mtu: mtu
- name: network-name
@ -439,6 +453,7 @@ Request
- networks: networks
- admin_state_up: network-admin_state_up-request
- dns_domain: dns_domain-request
- name: network-name-request
- port_security_enabled: network-port_security_enabled-request
- project_id: project_id-request
@ -468,6 +483,7 @@ Response Parameters
- admin_state_up: network-admin_state_up
- availability_zone_hints: availability_zone_hints
- availability_zones: availability_zones
- dns_domain: dns_domain
- id: network-id
- mtu: mtu
- name: network-name

31
api-ref/source/v2/parameters.yaml
View File

@ -1434,6 +1434,37 @@ direction_2:
in: body
required: true
type: string
dns_assignment:
description: |
Data assigned to a port by the Networking internal DNS including the
``hostname``, ``ip_address`` and ``fqdn``.
in: body
required: true
type: object
dns_domain:
description: |
A valid DNS domain.
in: body
required: true
type: string
dns_domain-request:
description: |
A valid DNS domain.
in: body
required: false
type: string
dns_name:
description: |
A valid DNS name.
in: body
required: true
type: string
dns_name-request:
description: |
A valid DNS name.
in: body
required: false
type: string
dpd:
description: |
A dictionary with dead peer detection (DPD)

35
api-ref/source/v2/ports.inc
View File

@ -32,6 +32,20 @@ Supported data plane status values:
- ``ACTIVE``: the underlying data plane is up and running
- ``DOWN``: no traffic can flow from/to the port
DNS integration
===============
The ``dns-integration`` extension adds the ``dns_name`` and ``dns_assignment``
attributes to port resources. While the ``dns_name`` can be set on create and
update operations, the ``dns_assignment`` is read-only and shows the
``hostname``, ``ip_address`` and ``fqdn`` for the port's internal DNS
assignment.
To enable the ``dns_domain`` on port resources, the ``dns-domain-ports``
extension must be used in conjunction with the ``dns-integration`` extension.
When enabled and set, a port level ``dns_domain`` take precedence over a
``dns_domain`` specified in the port's network allowing per-port DNS domains.
Show port details
=================
@ -76,6 +90,9 @@ Response Parameters
- description: description
- device_id: device_id
- device_owner: device_owner
- dns_assignment: dns_assignment
- dns_domain: dns_domain
- dns_name: dns_name
- extra_dhcp_opts: extra_dhcp_opts
- fixed_ips: fixed_ips
- id: id
@ -149,6 +166,8 @@ Request
- description: description-request
- device_id: device_id-request
- device_owner: device_owner-request
- dns_domain: dns_domain-request
- dns_name: dns_name-request
- extra_dhcp_opts: extra_dhcp_opts-request
- fixed_ips: fixed_ips-request
- mac_address: mac_address-request-put
@ -186,6 +205,9 @@ Response Parameters
- description: description
- device_id: device_id
- device_owner: device_owner
- dns_assignment: dns_assignment
- dns_domain: dns_domain
- dns_name: dns_name
- extra_dhcp_opts: extra_dhcp_opts
- fixed_ips: fixed_ips
- id: id
@ -283,6 +305,9 @@ Response Parameters
- description: description
- device_id: device_id
- device_owner: device_owner
- dns_assignment: dns_assignment
- dns_domain: dns_domain
- dns_name: dns_name
- extra_dhcp_opts: extra_dhcp_opts
- fixed_ips: fixed_ips
- id: id
@ -336,6 +361,8 @@ Request
- description: description-request
- device_id: device_id-request
- device_owner: device_owner-request
- dns_domain: dns_domain-request
- dns_name: dns_name-request
- extra_dhcp_opts: extra_dhcp_opts-request
- fixed_ips: fixed_ips-request
- mac_address: mac_address-request
@ -376,6 +403,9 @@ Response Parameters
- description: description
- device_id: device_id
- device_owner: device_owner
- dns_assignment: dns_assignment
- dns_domain: dns_domain
- dns_name: dns_name
- extra_dhcp_opts: extra_dhcp_opts
- fixed_ips: fixed_ips
- id: id
@ -428,6 +458,8 @@ Request
- description: description-request
- device_id: device_id-request
- device_owner: device_owner-request
- dns_domain: dns_domain-request
- dns_name: dns_name-request
- extra_dhcp_opts: extra_dhcp_opts-request
- fixed_ips: fixed_ips-request
- mac_address: mac_address-request
@ -462,6 +494,9 @@ Response Parameters
- description: description
- device_id: device_id
- device_owner: device_owner
- dns_assignment: dns_assignment
- dns_domain: dns_domain
- dns_name: dns_name
- extra_dhcp_opts: extra_dhcp_opts
- fixed_ips: fixed_ips
- id: id

4
api-ref/source/v2/samples/floatingips/floating-ips-list-response.json
View File

@ -3,6 +3,8 @@
{
"router_id": "d23abc8d-2991-4a55-ba98-2aaea84cc72f",
"description": "for test",
"dns_domain": "my-domain.org.",
"dns_name": "myfip",
"created_at": "2016-12-21T10:55:50Z",
"updated_at": "2016-12-21T10:55:53Z",
"revision_number": 1,
@ -18,6 +20,8 @@
{
"router_id": null,
"description": "for test",
"dns_domain": "my-domain.org.",
"dns_name": "myfip2",
"created_at": "2016-12-21T11:55:50Z",
"updated_at": "2016-12-21T11:55:53Z",
"revision_number": 2,

4
api-ref/source/v2/samples/floatingips/floatingip-create-request.json
View File

@ -5,6 +5,8 @@
"subnet_id": "278d9507-36e7-403c-bb80-1d7093318fe6",
"fixed_ip_address": "10.0.0.3",
"floating_ip_address": "172.24.4.228",
"description": "floating ip for testing"
"description": "floating ip for testing",
"dns_domain": "my-domain.org.",
"dns_name": "myfip"
}
}

2
api-ref/source/v2/samples/floatingips/floatingip-create-response.json
View File

@ -10,6 +10,8 @@
"project_id": "4969c491a3c74ee4af974e6d800c62de",
"tenant_id": "4969c491a3c74ee4af974e6d800c62de",
"description": "floating ip for testing",
"dns_domain": "my-domain.org.",
"dns_name": "myfip",
"created_at": "2016-12-21T01:36:04Z",
"updated_at": "2016-12-21T01:36:04Z",
"revision_number": 1

2
api-ref/source/v2/samples/floatingips/floatingip-show-response.json
View File

@ -10,6 +10,8 @@
"port_id": "ce705c24-c1ef-408a-bda3-7bbd946164ab",
"id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7",
"description": "floating ip for testing",
"dns_domain": "my-domain.org.",
"dns_name": "myfip",
"created_at": "2016-12-21T01:36:04Z",
"updated_at": "2016-12-21T01:36:04Z",
"revision_number": 1

2
api-ref/source/v2/samples/floatingips/floatingip-update-response.json
View File

@ -2,6 +2,8 @@
"floatingip": {
"created_at": "2016-12-21T10:55:50Z",
"description": "floating ip for testing",
"dns_domain": "my-domain.org.",
"dns_name": "myfip",
"fixed_ip_address": "10.0.0.4",
"floating_ip_address": "172.24.4.228",
"floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57",

1
api-ref/source/v2/samples/networks/network-create-request.json
View File

@ -2,6 +2,7 @@
"network": {
"name": "sample_network",
"admin_state_up": true,
"dns_domain": "my-domain.org.",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e"
}
}

1
api-ref/source/v2/samples/networks/network-create-response.json
View File

@ -6,6 +6,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "my-domain.org.",
"id": "4e8e5957-649f-477b-9e5b-f1f75b21c03c",
"mtu": 1500,
"name": "net1",

1
api-ref/source/v2/samples/networks/network-multi-create-response.json
View File

@ -4,6 +4,7 @@
"subnets": [],
"name": "net1",
"admin_state_up": true,
"dns_domain": "",
"project_id": "9bacb3c5d39d41a79512987f338cf177",
"tenant_id": "9bacb3c5d39d41a79512987f338cf177",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e",

1
api-ref/source/v2/samples/networks/network-multi-show-response.json
View File

@ -6,6 +6,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "my-domain.org.",
"id": "4e8e5957-649f-477b-9e5b-f1f75b21c03c",
"mtu": 1500,
"name": "net1",

1
api-ref/source/v2/samples/networks/network-provider-create-response.json
View File

@ -3,6 +3,7 @@
"status": "ACTIVE",
"subnets": [],
"availability_zone_hints": [],
"dns_domain": "",
"name": "net1",
"provider:physical_network": "public",
"admin_state_up": true,

1
api-ref/source/v2/samples/networks/network-provider-show-response.json
View File

@ -6,6 +6,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "my-domain.org.",
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
"mtu": 1500,
"name": "private-network",

1
api-ref/source/v2/samples/networks/network-show-response.json
View File

@ -6,6 +6,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "my-domain.org.",
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
"mtu": 1500,
"name": "private-network",

1
api-ref/source/v2/samples/networks/network-update-request.json
View File

@ -1,5 +1,6 @@
{
"network": {
"dns_domain": "my-domain.org.",
"name": "sample_network_5_updated",
"qos_policy_id": "6a8454ade84346f59e8d40665f878b2e"
}

1
api-ref/source/v2/samples/networks/network-update-response.json
View File

@ -6,6 +6,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "my-domain.org.",
"id": "1f370095-98f6-4079-be64-6d3d4a6adcc6",
"mtu": 1500,
"name": "sample_network_5_updated",

2
api-ref/source/v2/samples/networks/networks-bulk-create-response.json
View File

@ -7,6 +7,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "",
"id": "bc1a76cb-8767-4c3a-bb95-018b822f2130",
"mtu": 1500,
"name": "sample_network3",
@ -28,6 +29,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "",
"id": "af374017-c9ae-4a1d-b799-ab73111476e2",
"mtu": 1500,
"name": "sample_network4",

2
api-ref/source/v2/samples/networks/networks-list-response.json
View File

@ -7,6 +7,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "my-domain.org.",
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
"mtu": 1500,
"name": "net1",
@ -30,6 +31,7 @@
"availability_zones": [
"nova"
],
"dns_domain": "my-domain.org.",
"id": "db193ab3-96e3-4cb3-8fc5-05f4296d0324",
"mtu": 1500,
"name": "net2",

2
api-ref/source/v2/samples/networks/networks-provider-list-response.json
View File

@ -7,6 +7,7 @@
"nova"
],
"created_at": "2016-03-08T20:19:41",
"dns_domain": "my-domain.org.",
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
"mtu": 1500,
"name": "net1",
@ -32,6 +33,7 @@
"availability_zones": [
"nova"
],
"dns_domain": "my-domain.org.",
"id": "db193ab3-96e3-4cb3-8fc5-05f4296d0324",
"mtu": 1450,
"name": "net2",

4
api-ref/source/v2/samples/ports/port-bind-create-request.json
View File

@ -12,6 +12,8 @@
},
"binding:vnic_type": "baremetal",
"device_id": "d90a13da-be41-461f-9f99-1dbcf438fdf2",
"device_owner": "baremetal:none"
"device_owner": "baremetal:none",
"dns_domain": "my-domain.org.",
"dns_name": "myport"
}
}

7
api-ref/source/v2/samples/ports/port-bind-create-response.json
View File

@ -19,6 +19,13 @@
"description": "",
"device_id": "d90a13da-be41-461f-9f99-1dbcf438fdf2",
"device_owner": "baremetal:none",
"dns_assignment": {
"hostname": "myport",
"ip_address": "10.0.0.2",
"fqdn": "myport.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"fixed_ips": [
{
"ip_address": "10.0.0.2",

7
api-ref/source/v2/samples/ports/port-bind-show-response.json
View File

@ -15,6 +15,13 @@
"description": "",
"device_id": "5e3898d7-11be-483e-9732-b2f5eccd2b2e",
"device_owner": "network:router_interface",
"dns_assignment": {
"hostname": "myport",
"ip_address": "10.0.0.1",
"fqdn": "myport.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"extra_dhcp_opts": [],
"fixed_ips": [
{

7
api-ref/source/v2/samples/ports/port-bind-update-response.json
View File

@ -11,6 +11,13 @@
"description": "",
"device_id": "d90a13da-be41-461f-9f99-1dbcf438fdf2",
"device_owner": "compute:nova",
"dns_assignment": {
"hostname": "myport",
"ip_address": "20.20.0.4",
"fqdn": "myport.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"extra_dhcp_opts": [],
"fixed_ips": [
{

2
api-ref/source/v2/samples/ports/port-create-request.json
View File

@ -1,6 +1,8 @@
{
"port": {
"admin_state_up": true,
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"name": "private-port",
"network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7"
}

7
api-ref/source/v2/samples/ports/port-create-response.json
View File

@ -7,6 +7,13 @@
"description": "",
"device_id": "",
"device_owner": "",
"dns_assignment": {
"hostname": "myport",
"ip_address": "10.0.0.2",
"fqdn": "myport.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"extra_dhcp_opts": [],
"fixed_ips": [
{

7
api-ref/source/v2/samples/ports/port-show-response.json
View File

@ -7,6 +7,13 @@
"description": "",
"device_id": "5e3898d7-11be-483e-9732-b2f5eccd2b2e",
"device_owner": "network:router_interface",
"dns_assignment": {
"hostname": "myport",
"ip_address": "10.0.0.1",
"fqdn": "myport.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"extra_dhcp_opts": [],
"fixed_ips": [
{

7
api-ref/source/v2/samples/ports/port-update-response.json
View File

@ -11,6 +11,13 @@
"description": "",
"device_id": "d90a13da-be41-461f-9f99-1dbcf438fdf2",
"device_owner": "compute:nova",
"dns_assignment": {
"hostname": "myport",
"ip_address": "20.20.0.4",
"fqdn": "myport.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"extra_dhcp_opts": [],
"fixed_ips": [
{

14
api-ref/source/v2/samples/ports/ports-bind-list-response.json
View File

@ -15,6 +15,13 @@
"description": "",
"device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824",
"device_owner": "network:router_gateway",
"dns_assignment": {
"hostname": "myport",
"ip_address": "172.24.4.2",
"fqdn": "myport.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"extra_dhcp_opts": [],
"fixed_ips": [
{
@ -47,6 +54,13 @@
"description": "",
"device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824",
"device_owner": "network:router_interface",
"dns_assignment": {
"hostname": "myport2",
"ip_address": "10.0.0.1",
"fqdn": "myport2.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport2",
"extra_dhcp_opts": [],
"fixed_ips": [
{

5
api-ref/source/v2/samples/ports/ports-bulk-create-response.json
View File

@ -7,6 +7,8 @@
"description": "",
"device_id": "",
"device_owner": "",
"dns_domain": "",
"dns_name": "",
"fixed_ips": [
{
"ip_address": "10.0.0.5",
@ -31,6 +33,9 @@
"description": "",
"device_id": "",
"device_owner": "",
"dns_assignment": {},
"dns_domain": "",
"dns_name": "",
"fixed_ips": [
{
"ip_address": "10.0.0.6",

14
api-ref/source/v2/samples/ports/ports-list-response.json
View File

@ -7,6 +7,13 @@
"description": "",
"device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824",
"device_owner": "network:router_gateway",
"dns_assignment": {
"hostname": "myport",
"ip_address": "172.24.4.2",
"fqdn": "myport.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport",
"extra_dhcp_opts": [],
"fixed_ips": [
{
@ -30,6 +37,13 @@
"description": "",
"device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824",
"device_owner": "network:router_interface",
"dns_assignment": {
"hostname": "myport2",
"ip_address": "10.0.0.1",
"fqdn": "myport2.my-domain.org"
},
"dns_domain": "my-domain.org.",
"dns_name": "myport2",
"extra_dhcp_opts": [],
"fixed_ips": [
{