Skip to content

Commit

Permalink
Adding provider extended attributes to API ref page
Browse files Browse the repository at this point in the history 
Partial-Bug: #1157159

Change-Id: I048eaec00167e35cd7cf93a46b4647ffbbacb778
author: diane fleming
  • Loading branch information
@dian4554
dian4554 committed Sep 25, 2013
1 parent 6f7c835 commit 60c494a
Show file tree
Hide file tree
Showing 37 changed files with 6,169 additions and 185 deletions.
2 changes: 1 addition & 1 deletion api-ref/pom.xml
View file
Expand Up @@ -13,7 +13,7 @@
<name>OpenStack API Page Project</name>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<doctools.version>1.10.0</doctools.version>
<doctools.version>1.9.3</doctools.version>
</properties>
<build>
<plugins>
Expand Down
38 changes: 37 additions & 1 deletion api-ref/src/docbkx/api-ref-networking.xml
View file
Expand Up @@ -54,7 +54,7 @@
associate IP address blocks and other network configuration
settings with a neutron network. You can choose a specific IP
address from the block or let neutron choose the first available
IP address. </para>
IP address.</para>
<section xml:id="networks">
<title>Networks</title>
<para>Lists, creates, deletes, and updates neutron
Expand All @@ -76,4 +76,40 @@
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
</chapter>
<chapter xml:id="netconn-api-provider-ext">
<title>Networking API v2.0 Extensions</title>
<section xml:id="provider-overview">
<title>Provider Extension for Networks and Ports</title>
<para>The <parameter>provider</parameter> extended attributes
for networks and ports enables administrative users to specify
how network and port objects map to the underlying networking
infrastructure. These extended attributes also appear when
administrative users query networks or ports.</para>
<para>The technology back end of the particular plug-in
determines the semantics of these attributes. To understand
which values to specify for each attribute when you deploy
OpenStack Networking with a particular plug-in, see the
plug-in documentation and the <link
xlink:href="http://docs.openstack.org/grizzly/openstack-network/admin/content/"
><citetitle>OpenStack Networking Administration
Guide</citetitle></link>. The following examples use the
Open vSwitch plug-in.</para>
<note>
<para>The default policy settings enable only administrative
users to specify and view these attributes. If you cannot
see these attributes in a &GET;
<code>/networks/&lt;network-id&gt;</code> or &GET;
<code>/ports/&lt;port-id&gt;</code> operation, you do not
have administrative privileges.</para>
</note>
<para>Use the <parameter>provider</parameter> extended
attributes to get information about, create, and update
networks and ports.</para>
<wadl:resources
href="../wadls/netconn-api/src/os-networks-provider-ext.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
<wadl:resources href="../wadls/netconn-api/src/os-ports-provider-ext.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
</chapter>
</book>
1 change: 0 additions & 1 deletion api-ref/src/wadls/compute-api/src/xsd/version.xsd
View file
Expand Up @@ -4,7 +4,6 @@
<!-- (C) 2011 OpenStack LLC., All Rights Reserved -->

<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified"
targetNamespace="http://docs.openstack.org/common/api/v1.0"
xmlns:vers="http://docs.openstack.org/common/api/v1.0"
xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
Expand Down
14 changes: 9 additions & 5 deletions api-ref/src/wadls/netconn-api/src/api_samples/networks-get-resp.xml
View file
@@ -1,32 +1,36 @@
<networks xmlns="http://openstack.org/quantum/api/v2.0" xmlns:provider="http://docs.openstack.org/ext/provider/api/v1.0" xmlns:quantum="http://openstack.org/quantum/api/v2.0" xmlns:router="http://docs.openstack.org/ext/quantum/router/api/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<networks xmlns="http://openstack.org/quantum/api/v2.0"
xmlns:provider="http://docs.openstack.org/ext/provider/api/v1.0"
xmlns:quantum="http://openstack.org/quantum/api/v2.0"
xmlns:router="http://docs.openstack.org/ext/quantum/router/api/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<network>
<status>ACTIVE</status>
<subnets>
<subnet>a318fcb4-9ff0-4485-b78c-9e6738c21b26</subnet>
</subnets>
<name>private</name>
<provider:physical_network xsi:nil="true" />
<provider:physical_network xsi:nil="true"/>
<admin_state_up quantum:type="bool">True</admin_state_up>
<tenant_id>625887121e364204873d362b553ab171</tenant_id>
<provider:network_type>local</provider:network_type>
<router:external quantum:type="bool">False</router:external>
<shared quantum:type="bool">False</shared>
<id>9d83c053-b0a4-4682-ae80-c00df269ce0a</id>
<provider:segmentation_id xsi:nil="true" />
<provider:segmentation_id xsi:nil="true"/>
</network>
<network>
<status>ACTIVE</status>
<subnets>
<subnet>aca4d43c-c48c-4a2c-9bb6-ba374ef7e135</subnet>
</subnets>
<name>nova</name>
<provider:physical_network xsi:nil="true" />
<provider:physical_network xsi:nil="true"/>
<admin_state_up quantum:type="bool">True</admin_state_up>
<tenant_id>63878e4c5dd649d2a980e37aefddfa87</tenant_id>
<provider:network_type>local</provider:network_type>
<router:external quantum:type="bool">True</router:external>
<shared quantum:type="bool">False</shared>
<id>ebda9658-093b-41ba-80ce-0cf8cb8365d4</id>
<provider:segmentation_id xsi:nil="true" />
<provider:segmentation_id xsi:nil="true"/>
</network>
</networks>
174 changes: 87 additions & 87 deletions api-ref/src/wadls/netconn-api/src/api_samples/ports-get-resp.json
View file
@@ -1,88 +1,88 @@
{
"ports": [
{
"status": "ACTIVE",
"name": "",
"admin_state_up": true,
"network_id": "ebda9658-093b-41ba-80ce-0cf8cb8365d4",
"tenant_id": "63878e4c5dd649d2a980e37aefddfa87",
"binding:vif_type": "ovs",
"device_owner": "compute:None",
"binding:capabilities": {
"port_filter": false
},
"mac_address": "fa:16:3e:b9:ef:05",
"fixed_ips": [
{
"subnet_id": "aca4d43c-c48c-4a2c-9bb6-ba374ef7e135",
"ip_address": "172.24.4.227"
}
],
"id": "664ebd1a-facd-4c20-948c-07a784475ab0",
"device_id": "f288bb5f-920d-4276-8345-2c0319c16f58"
},
{
"status": "DOWN",
"name": "",
"admin_state_up": true,
"network_id": "ebda9658-093b-41ba-80ce-0cf8cb8365d4",
"tenant_id": "",
"binding:vif_type": "ovs",
"device_owner": "network:router_gateway",
"binding:capabilities": {
"port_filter": false
},
"mac_address": "fa:16:3e:4a:3a:a2",
"fixed_ips": [
{
"subnet_id": "aca4d43c-c48c-4a2c-9bb6-ba374ef7e135",
"ip_address": "172.24.4.226"
}
],
"id": "c5ca7017-c390-4ccc-8cd7-333747e57fef",
"device_id": "0dc517bf-9169-4aa6-88b7-569219962881"
},
{
"status": "ACTIVE",
"name": "",
"admin_state_up": true,
"network_id": "9d83c053-b0a4-4682-ae80-c00df269ce0a",
"tenant_id": "625887121e364204873d362b553ab171",
"binding:vif_type": "ovs",
"device_owner": "network:router_interface",
"binding:capabilities": {
"port_filter": false
},
"mac_address": "fa:16:3e:2d:dc:7e",
"fixed_ips": [
{
"subnet_id": "a318fcb4-9ff0-4485-b78c-9e6738c21b26",
"ip_address": "10.0.0.1"
}
],
"id": "d7815f5b-a228-47bb-a5e5-f139c4e476f6",
"device_id": "0dc517bf-9169-4aa6-88b7-569219962881"
},
{
"status": "ACTIVE",
"name": "",
"admin_state_up": true,
"network_id": "9d83c053-b0a4-4682-ae80-c00df269ce0a",
"tenant_id": "625887121e364204873d362b553ab171",
"binding:vif_type": "ovs",
"device_owner": "network:dhcp",
"binding:capabilities": {
"port_filter": false
},
"mac_address": "fa:16:3e:73:6d:1c",
"fixed_ips": [
{
"subnet_id": "a318fcb4-9ff0-4485-b78c-9e6738c21b26",
"ip_address": "10.0.0.2"
}
],
"id": "f8639521-fab2-4879-94b2-83a47bee8a26",
"device_id": "dhcpe1b8334f-9be9-5e49-aeee-b31e6df6c847-9d83c053-b0a4-4682-ae80-c00df269ce0a"
}
]
}
"ports":[
{
"status":"ACTIVE",
"name":"",
"admin_state_up":true,
"network_id":"ebda9658-093b-41ba-80ce-0cf8cb8365d4",
"tenant_id":"63878e4c5dd649d2a980e37aefddfa87",
"binding:vif_type":"ovs",
"device_owner":"compute:None",
"binding:capabilities":{
"port_filter":false
},
"mac_address":"fa:16:3e:b9:ef:05",
"fixed_ips":[
{
"subnet_id":"aca4d43c-c48c-4a2c-9bb6-ba374ef7e135",
"ip_address":"172.24.4.227"
}
],
"id":"664ebd1a-facd-4c20-948c-07a784475ab0",
"device_id":"f288bb5f-920d-4276-8345-2c0319c16f58"
},
{
"status":"DOWN",
"name":"",
"admin_state_up":true,
"network_id":"ebda9658-093b-41ba-80ce-0cf8cb8365d4",
"tenant_id":"",
"binding:vif_type":"ovs",
"device_owner":"network:router_gateway",
"binding:capabilities":{
"port_filter":false
},
"mac_address":"fa:16:3e:4a:3a:a2",
"fixed_ips":[
{
"subnet_id":"aca4d43c-c48c-4a2c-9bb6-ba374ef7e135",
"ip_address":"172.24.4.226"
}
],
"id":"c5ca7017-c390-4ccc-8cd7-333747e57fef",
"device_id":"0dc517bf-9169-4aa6-88b7-569219962881"
},
{
"status":"ACTIVE",
"name":"",
"admin_state_up":true,
"network_id":"9d83c053-b0a4-4682-ae80-c00df269ce0a",
"tenant_id":"625887121e364204873d362b553ab171",
"binding:vif_type":"ovs",
"device_owner":"network:router_interface",
"binding:capabilities":{
"port_filter":false
},
"mac_address":"fa:16:3e:2d:dc:7e",
"fixed_ips":[
{
"subnet_id":"a318fcb4-9ff0-4485-b78c-9e6738c21b26",
"ip_address":"10.0.0.1"
}
],
"id":"d7815f5b-a228-47bb-a5e5-f139c4e476f6",
"device_id":"0dc517bf-9169-4aa6-88b7-569219962881"
},
{
"status":"ACTIVE",
"name":"",
"admin_state_up":true,
"network_id":"9d83c053-b0a4-4682-ae80-c00df269ce0a",
"tenant_id":"625887121e364204873d362b553ab171",
"binding:vif_type":"ovs",
"device_owner":"network:dhcp",
"binding:capabilities":{
"port_filter":false
},
"mac_address":"fa:16:3e:73:6d:1c",
"fixed_ips":[
{
"subnet_id":"a318fcb4-9ff0-4485-b78c-9e6738c21b26",
"ip_address":"10.0.0.2"
}
],
"id":"f8639521-fab2-4879-94b2-83a47bee8a26",
"device_id":"dhcpe1b8334f-9be9-5e49-aeee-b31e6df6c847-9d83c053-b0a4-4682-ae80-c00df269ce0a"
}
]
}

0 comments on commit 60c494a

Please sign in to comment.