Skip to content
Snippets Groups Projects
Commit ba29dc1b authored by yangalicace1's avatar yangalicace1
Browse files

Deployed 088e5dea to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent f87ca70b
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
public/develop/search/search_index.json
+ 1
− 1
View file @ ba29dc1b
Source diff could not be displayed: it is too large. Options to address this: view the blob.
public/develop/supported_nbis/index.html
+ 137
− 84
View file @ ba29dc1b
......@@ -516,47 +516,68 @@
<h1>6. Supported NBIs</h1>
<p>This section summarizes the NBI connectors supported by the TeraFlowSDN controller to interoperate with OSS/BSS/NFVO on top of it.</p>
<pre><code>- [6.1. TFS API](#61-tfs-apie)
- [6.2. ETSI Bandwidth Management (BWM)](#62-etsi-bandwidth-management-bwm)
- [6.3. IETF L2VPN Service Delivery (L2SM) [RFC8466]](#63-ietf-l2vpn-service-delivery-l2sm-rfc8466)
- [6.4. IETF L3VPN Service Delivery (L3SM) [RFC8299]](#64-ietf-l3vpn-service-delivery-l3sm-rfc8299)
- [6.5. IETF Network Topology [RFC8345]](#65-ietf-network-topology-rfc8345)
- [6.6. IETF Network Slice Service [draft-ietf-teas-ietf-network-slice-nbi-yang]](#66-ietf-network-slice-service-draft-ietf-teas-ietf-network-slice-nbi-yang)
</code></pre>
<ul>
<li><a href="#61-tfs-apie">6.1. TFS API</a></li>
<li><a href="#62-etsi-bandwidth-management-bwm">6.2. ETSI Bandwidth Management (BWM)</a></li>
<li><a href="#63-ietf-l2vpn-service-delivery-l2sm-rfc8466">6.3. IETF L2VPN Service Delivery (L2SM) [RFC8466]</a></li>
<li><a href="#64-ietf-l3vpn-service-delivery-l3sm-rfc8299">6.4. IETF L3VPN Service Delivery (L3SM) [RFC8299]</a></li>
<li><a href="#65-ietf-network-topology-rfc8345">6.5. IETF Network Topology [RFC8345]</a></li>
<li><a href="#66-ietf-network-slice-service-draft-ietf-teas-ietf-network-slice-nbi-yang">6.6. IETF Network Slice Service [draft-ietf-teas-ietf-network-slice-nbi-yang]</a></li>
</ul>
<h2 id="61-tfs-apie"><strong>6.1. TFS APIe</strong></h2>
<p>This NBI connector exposes the basic gRPC methods of TeraFlowSDN that enable to manage contexts, topologies, devices, links, services, slices, connections, and policies.</p>
<h3><u>Exposed endpoints:</h3>
<p></u></p>
<p><strong>Endpoint <code>/tfs-api/context_ids</code></strong>
- Method: <code>GET</code>
- Used to list the context identifiers</p>
<p><strong>Endpoint <code>/tfs-api/contexts</code></strong>
- Method: <code>GET</code>
- Used to list the details of all contexts</p>
<p><strong>Endpoint <code>/tfs-api/dummy_contexts</code></strong>
- Method: <code>GET</code>
- Used to dump contexts (including related topologies, devices, links, services, slices, and connections) in a snapshot format that can be imported directly in TeraFlowSDN WebUI.
- IMPORTANT: the resulting document is processed by WebUI in dummy mode, i.e., just to populate Context database, but not interacting with Device, Service, and Slice components.</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;</code></strong>
- Method: <code>GET</code>
- Used to retrieve a specific context</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/topology_ids</code></strong>
- Method: <code>GET</code>
- Used to list the topology identifiers in a context</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/topologies</code></strong>
- Method: <code>GET</code>
- Used to list all the topology details in a context</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/topology/&lt;path:topology_uuid&gt;</code></strong>
- Method: <code>GET</code>
- Used to retrieve a specific topology in a context</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/service_ids</code></strong>
- Method: <code>GET</code>
- Used to list the service identifiers in a context</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/services</code></strong>
- Method: <code>GET</code>
- Used to list all the service details in a context</p>
<p><strong>Endpoint <code>/tfs-api/context_ids</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the context identifiers</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/contexts</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the details of all contexts</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/dummy_contexts</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to dump contexts (including related topologies, devices, links, services, slices, and connections) in a snapshot format that can be imported directly in TeraFlowSDN WebUI.</li>
<li>IMPORTANT: the resulting document is processed by WebUI in dummy mode, i.e., just to populate Context database, but not interacting with Device, Service, and Slice components.</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to retrieve a specific context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/topology_ids</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the topology identifiers in a context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/topologies</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list all the topology details in a context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/topology/&lt;path:topology_uuid&gt;</code></strong></p>
<ul>
<li>Method: <code>POST</code></li>
<li>Method: <code>GET</code></li>
<li>Used to retrieve a specific topology in a context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/service_ids</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the service identifiers in a context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/services</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>
<p>Used to list all the service details in a context</p>
</li>
<li>
<p>Method: <code>POST</code></p>
</li>
<li>
<p>Used to create a service</p>
</li>
......@@ -571,54 +592,86 @@
</li>
<li>Used to delete a service</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/service/&lt;path:service_uuid&gt;</code></strong>
- Method: <code>GET</code>
- Used to retrieve a specific service in a context</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/slice_ids</code></strong>
- Method: <code>GET</code>
- Used to list the slice identifiers in a context</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/slices</code></strong>
- Method: <code>GET</code>
- Used to list all the slice details in a context</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/slice/&lt;path:slice_uuid&gt;</code></strong>
- Method: <code>GET</code>
- Used to retrieve a specific slice in a context</p>
<p><strong>Endpoint <code>/tfs-api/device_ids</code></strong>
- Method: <code>GET</code>
- Used to list the device identifiers</p>
<p><strong>Endpoint <code>/tfs-api/devices</code></strong>
- Method: <code>GET</code>
- Used to list the device details</p>
<p><strong>Endpoint <code>/tfs-api/device/&lt;path:device_uuid&gt;</code></strong>
- Method: <code>GET</code>
- Used to retrieve a specific device</p>
<p><strong>Endpoint <code>/tfs-api/link_ids</code></strong>
- Method: <code>GET</code>
- Used to list the link identifiers</p>
<p><strong>Endpoint <code>/tfs-api/links</code></strong>
- Method: <code>GET</code>
- Used to list the link details</p>
<p><strong>Endpoint <code>/tfs-api/link/&lt;path:link_uuid&gt;</code></strong>
- Method: <code>GET</code>
- Used to retrieve a specific link</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/service/&lt;path:service_uuid&gt;/connection_ids</code></strong>
- Method: <code>GET</code>
- Used to list the connection identifiers related to a service</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/service/&lt;path:service_uuid&gt;/connections</code></strong>
- Method: <code>GET</code>
- Used to list all the connection details related to a service</p>
<p><strong>Endpoint <code>/tfs-api/connection/&lt;path:connection_uuid&gt;</code></strong>
- Method: <code>GET</code>
- Used to retrieve a specific connection</p>
<p><strong>Endpoint <code>/tfs-api/policyrule_ids</code></strong>
- Method: <code>GET</code>
- Used to list all the policy rule identifiers</p>
<p><strong>Endpoint <code>/tfs-api/policyrules</code></strong>
- Method: <code>GET</code>
- Used to list all the policy rule details</p>
<p><strong>Endpoint <code>/tfs-api/policyrule/&lt;path:policyrule_uuid&gt;</code></strong>
- Method: <code>GET</code>
- Used to retrieve a specific policy rule</p>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/service/&lt;path:service_uuid&gt;</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to retrieve a specific service in a context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/slice_ids</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the slice identifiers in a context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/slices</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list all the slice details in a context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/slice/&lt;path:slice_uuid&gt;</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to retrieve a specific slice in a context</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/device_ids</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the device identifiers</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/devices</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the device details</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/device/&lt;path:device_uuid&gt;</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to retrieve a specific device</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/link_ids</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the link identifiers</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/links</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the link details</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/link/&lt;path:link_uuid&gt;</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to retrieve a specific link</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/service/&lt;path:service_uuid&gt;/connection_ids</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list the connection identifiers related to a service</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/context/&lt;path:context_uuid&gt;/service/&lt;path:service_uuid&gt;/connections</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list all the connection details related to a service</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/connection/&lt;path:connection_uuid&gt;</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to retrieve a specific connection</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/policyrule_ids</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list all the policy rule identifiers</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/policyrules</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to list all the policy rule details</li>
</ul>
<p><strong>Endpoint <code>/tfs-api/policyrule/&lt;path:policyrule_uuid&gt;</code></strong></p>
<ul>
<li>Method: <code>GET</code></li>
<li>Used to retrieve a specific policy rule</li>
</ul>
<h2 id="62-etsi-bandwidth-management-bwm"><strong>6.2. ETSI Bandwidth Management (BWM)</strong></h2>
<p>ETSI Traffic Bandwidth Management (BWM) API (GS MEC 015)</p>
<p><strong>Documentation in progress</strong></p>
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment