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

Deployed 7add4f9a to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent 8096ce33
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 @ f87ca70b
Source diff could not be displayed: it is too large. Options to address this: view the blob.
public/develop/supported_nbis/index.html
+ 269
− 1
View file @ f87ca70b
...@@ -77,6 +77,11 @@ ...@@ -77,6 +77,11 @@
<label class="md-overlay" for="__drawer"></label> <label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip"> <div data-md-component="skip">
<a href="#61-tfs-apie" class="md-skip">
Skip to content
</a>
</div> </div>
<div data-md-component="announce"> <div data-md-component="announce">
...@@ -357,6 +362,17 @@ ...@@ -357,6 +362,17 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
6. Supported NBIs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
...@@ -367,6 +383,77 @@ ...@@ -367,6 +383,77 @@
</a> </a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#61-tfs-apie" class="md-nav__link">
<span class="md-ellipsis">
6.1. TFS APIe
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#62-etsi-bandwidth-management-bwm" class="md-nav__link">
<span class="md-ellipsis">
6.2. ETSI Bandwidth Management (BWM)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#63-ietf-l2vpn-service-delivery-l2sm-rfc8466" class="md-nav__link">
<span class="md-ellipsis">
6.3. IETF L2VPN Service Delivery (L2SM) [RFC8466]
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#64-ietf-l3vpn-service-delivery-l3sm-rfc8299" class="md-nav__link">
<span class="md-ellipsis">
6.4. IETF L3VPN Service Delivery (L3SM) [RFC8299]
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#65-ietf-network-topology-rfc8345" class="md-nav__link">
<span class="md-ellipsis">
6.5. IETF Network Topology [RFC8345]
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#66-ietf-network-slice-service-draft-ietf-teas-ietf-network-slice-nbi-yang" class="md-nav__link">
<span class="md-ellipsis">
6.6. IETF Network Slice Service [draft-ietf-teas-ietf-network-slice-nbi-yang]
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
...@@ -428,7 +515,188 @@ ...@@ -428,7 +515,188 @@
<h1>6. Supported NBIs</h1> <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>
<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>
<ul>
<li>Method: <code>POST</code></li>
<li>
<p>Used to create a service</p>
</li>
<li>
<p>Method: <code>PUT</code></p>
</li>
<li>
<p>Used to update a service</p>
</li>
<li>
<p>Method: <code>DELETE</code></p>
</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>
<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>
<h3><u>Supported features:</h3>
<p></u>
- L3 connectivity service management</p>
<h3><u>Tested OSS/BSS/NFVO:</h3>
<p></u>
- Proprietary Moonlight extension
- Standalone script</p>
<h3><u>Reference:</h3>
<p></u>
- ETSI Traffic Bandwidth Management (BWM) API (GS MEC 015)</p>
<h2 id="63-ietf-l2vpn-service-delivery-l2sm-rfc8466"><strong>6.3. IETF L2VPN Service Delivery (L2SM) [RFC8466]</strong></h2>
<p>IETF RFC8466: A YANG Data Model for Layer 2 Virtual Private Network (L2VPN) Service Delivery</p>
<p><strong>Documentation in progress</strong></p>
<h3><u>Supported features:</h3>
<p></u>
- L2 VPN management</p>
<h3><u>Tested OSS/BSS/NFVO:</h3>
<p></u>
- ETSI OpenSource MANO v12.1+</p>
<h3><u>Reference:</h3>
<p></u>
- <a href="https://datatracker.ietf.org/doc/html/rfc8466">IETF RFC8466: A YANG Data Model for Layer 2 Virtual Private Network (L2VPN) Service Delivery</a></p>
<h2 id="64-ietf-l3vpn-service-delivery-l3sm-rfc8299"><strong>6.4. IETF L3VPN Service Delivery (L3SM) [RFC8299]</strong></h2>
<p>IETF RFC8299: YANG Data Model for L3VPN Service Delivery</p>
<p><strong>Documentation in progress</strong></p>
<h3><u>Supported features:</h3>
<p></u>
- L3 VPN management</p>
<h3><u>Tested OSS/BSS/NFVO:</h3>
<p></u>
- Proprietary OSM extensions
- Standalone script</p>
<h3><u>Reference:</h3>
<p></u>
- <a href="https://datatracker.ietf.org/doc/html/rfc8299">IETF RFC8299: YANG Data Model for L3VPN Service Delivery</a></p>
<h2 id="65-ietf-network-topology-rfc8345"><strong>6.5. IETF Network Topology [RFC8345]</strong></h2>
<p>IETF RFC8345: A YANG Data Model for Network Topologies</p>
<p><strong>Documentation in progress</strong></p>
<p>This extension also features partial support for:
- IETF RFC 8795: YANG Data Model for Traffic Engineering (TE) Topologies
- IETF RFC draft-ietf-ccamp-eth-client-te-topo-yang-05: A YANG Data Model for Ethernet TE Topology
- IETF RFC draft-ietf-ccamp-client-signal-yang-10: A YANG Data Model for Transport Network Client Signals</p>
<h3><u>Supported features:</h3>
<p></u>
- Static topology exposition</p>
<h3><u>Tested OSS/BSS/NFVO:</h3>
<p></u>
- Proprietary OSM extensions
- Standalone script</p>
<h3><u>Reference:</h3>
<p></u></p>
<ul>
<li><a href="https://datatracker.ietf.org/doc/html/rfc8345">IETF RFC8345: A YANG Data Model for Network Topologies</a></li>
<li><a href="https://datatracker.ietf.org/doc/html/rfc8795">IETF RFC8795: YANG Data Model for Traffic Engineering (TE) Topologies</a></li>
<li><a href="https://datatracker.ietf.org/doc/html/rfc8776">IETF RFC8776: Common YANG Data Types for Traffic Engineering</a></li>
<li><a href="https://datatracker.ietf.org/doc/html/rfc6991">IETF RFC6991: Common YANG Data Types</a></li>
<li><a href="https://datatracker.ietf.org/doc/draft-ietf-ccamp-eth-client-te-topo-yang/">IETF draft-ietf-ccamp-eth-client-te-topo-yang-05: A YANG Data Model for Ethernet TE Topology</a></li>
<li><a href="https://datatracker.ietf.org/doc/draft-ietf-ccamp-client-signal-yang/">IETF draft-ietf-ccamp-client-signal-yang-10: A YANG Data Model for Transport Network Client Signals</a></li>
</ul>
<h2 id="66-ietf-network-slice-service-draft-ietf-teas-ietf-network-slice-nbi-yang"><strong>6.6. IETF Network Slice Service [draft-ietf-teas-ietf-network-slice-nbi-yang]</strong></h2>
<p>IETF draft-ietf-teas-ietf-network-slice-nbi-yang: A YANG Data Model for the RFC 9543 Network Slice Service</p>
<p>Important: implemented version is based on version 2 of the draft:
- draft-ietf-teas-ietf-network-slice-nbi-yang-02: IETF Network Slice Service YANG Model</p>
<p><strong>Documentation in progress</strong></p>
<h3><u>Supported features:</h3>
<p></u>
- L2/L3 slice management</p>
<h3><u>Tested OSS/BSS/NFVO:</h3>
<p></u>
- Standalone script</p>
<h3><u>Reference:</h3>
<p></u></p>
<ul>
<li><a href="https://datatracker.ietf.org/doc/draft-ietf-teas-ietf-network-slice-nbi-yang/02/">IETF draft-ietf-teas-ietf-network-slice-nbi-yang-02: IETF Network Slice Service YANG Model</a></li>
</ul>
......
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