From 58e1986f5a7bec6e3bd4ce72522706cb647ae101 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Mon, 25 May 2020 19:28:22 -0400 Subject: [PATCH] Remove nemo docs This project no longer participates in the managed release so remove it's docs. Signed-off-by: Thanh Ha Change-Id: Iad80aa724527170815a555d55d12fe54d693f235 --- docs/developer-guide/index.rst | 1 - docs/developer-guide/nemo-developer-guide.rst | 71 --------------- docs/user-guide/index.rst | 1 - docs/user-guide/nemo-user-guide.rst | 90 ------------------- 4 files changed, 163 deletions(-) delete mode 100644 docs/developer-guide/nemo-developer-guide.rst delete mode 100644 docs/user-guide/nemo-user-guide.rst diff --git a/docs/developer-guide/index.rst b/docs/developer-guide/index.rst index a7f47d6b6..fdfc9c926 100644 --- a/docs/developer-guide/index.rst +++ b/docs/developer-guide/index.rst @@ -27,7 +27,6 @@ Project-specific Developer Guides distribution-version distribution-test-features - nemo-developer-guide neutron-service-developer-guide neutron-northbound odl-parent-developer-guide diff --git a/docs/developer-guide/nemo-developer-guide.rst b/docs/developer-guide/nemo-developer-guide.rst deleted file mode 100644 index ab4778a4e..000000000 --- a/docs/developer-guide/nemo-developer-guide.rst +++ /dev/null @@ -1,71 +0,0 @@ -.. _nemo-dev-guide: - -NEtwork MOdeling (NEMO) -======================= - -Overview --------- - -The NEMO engine provides REST APIs to express intent, and manage it. With this -northbound API, user could query what intents have been handled successfully, and -what types have been predefined. - -NEMO Architecture ------------------ - -In NEMO project, it provides three features facing developer. - -* ``odl-nemo-engine``: it is a whole model to handle intent. - -* ``odl-nemo-openflow-renderer``: it is a southbound render to translate intent to flow - table in devices supporting for OpenFlow protocol. - -* ``odl-nemo-cli-render``: it is also a southbound render to translate intent into forwarding - table in devices supporting for traditional protocol. - -Key APIs and Interfaces ------------------------ - -NEMO projects provide four basic REST methods for user to use. - -* PUT: store the information expressed in NEMO model directly without handled by NEMO engine. - -* POST: the information expressed in NEMO model will be handled by NEMO engine, and will - be translated into southbound configuration. - -* GET: obtain the data stored in data store. - -* DELETE: delete the data in data store. - -NEMO Intent API -~~~~~~~~~~~~~~~ - -NEMO provides several RPCs to handle user's intent. All RPCs use POST method. - -- ``http://{controller-ip}:8181/restconf/operations/nemo-intent:register-user``: a REST API - to register a new user. It is the first and necessary step to express intent. - -- ``http://{controller-ip}:8181/restconf/operations/nemo-intent:transaction-begin``: a REST - type to start a transaction. The intent exist in the transaction will be handled together. - -- ``http://{controller-ip}:8181/restconf/operations/nemo-intent:transaction-end``: a REST API - to end a transaction. The intent exist in the transaction will be handled together. - -- ``http://{controller-ip}:8181/restconf/operations/nemo-intent:structure-style-nemo-update``: a - REST API to create, import or update intent in a structure style, that is, user could express the - structure of intent in json body. - -- ``http://{controller-ip}:8181/restconf/operations/nemo-intent:structure-style-nemo-delete``: a - REST API to delete intent in a structure style. - -- ``http://{controller-ip}:8181/restconf/operations/nemo-intent:language-style-nemo-request``: a REST - API to create, import, update and delete intent in a language style, that is, user could express - intent with NEMO script. On the other hand, with this interface, user could query which intent have - been handled successfully. - -API Reference Documentation ---------------------------- - -Go to ``http://${IPADDRESS}:8181/apidoc/explorer/index.html``. User could see many useful APIs to -deploy or query intent. - diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst index 7d60f5788..39bf09203 100644 --- a/docs/user-guide/index.rst +++ b/docs/user-guide/index.rst @@ -25,7 +25,6 @@ Project-specific User Guides :maxdepth: 1 distribution-version-user-guide - nemo-user-guide neutron-service-user-guide p4plugin-user-guide service-function-chaining diff --git a/docs/user-guide/nemo-user-guide.rst b/docs/user-guide/nemo-user-guide.rst deleted file mode 100644 index c8c4b7df2..000000000 --- a/docs/user-guide/nemo-user-guide.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _nemo-user-guide: - -NEtwork MOdeling (NEMO) -======================= - -This section describes how to use the NEMO feature in OpenDaylight -and contains contains configuration, administration, and management -sections for the feature. - -Overview --------- - -With the network becoming more complicated, users and applications must handle -more complex configurations to deploy new services. NEMO project aims to simplify -the usage of network by providing a new intent northbound interface (NBI). Instead -of tons of APIs, users/applications just need to describe their intent without -caring about complex physical devices and implementation means. The intent will -be translated into detailed configurations on the devices in the NEMO engine. A -typical scenario is user just need to assign which nodes to implement an VPN, -without considering which technique is used. - -NEMO Engine Architecture ------------------------- - -* NEMO API - * The NEMO API provide users the NEMO model, which guides users how to construct the - instance of intent, and how to construct the instance of predefined types. -* NEMO REST - * The NEMO REST provides users REST APIs to access NEMO engine, that is, user could - transmit the intent instance to NEMO engine through basic REST methods. - -Installing NEMO engine ----------------------- - -To install NEMO engine, download OpenDaylight and use the Karaf console -to install the following feature: - -odl-nemo-engine-ui - -Administering or Managing NEMO Engine -------------------------------------- - -After install features NEMO engine used, user could use NEMO to express his intent -with NEMO UI or REST APIs in apidoc. - -Go to ``http://{controller-ip}:8181/index.html``. In this interface, user could go to -NEMO UI, and use the tabs and input box to input intent, and see the state of intent -deployment with the image. - -Go to ``http://{controller-ip}:8181/apidoc/explorer/index.html``. In this interface, user -could REST methods "POST", "PUT","GET" and "DELETE" to deploy intent or query the state -of deployment. - -Tutorials ---------- - -Below are tutorials for NEMO Engine. - -Using NEMO Engine -~~~~~~~~~~~~~~~~~ - -The purpose of the tutorial is to describe how to use use UI to deploy intent. - -Overview -^^^^^^^^ - -This tutorial will describe how to use the NEMO UI to check the operated resources, the steps -to deploy service, and the ultimate state. - -Prerequisites -^^^^^^^^^^^^^ - -To understand the tutorial well, we hope there are a physical or virtual network exist, and -OpenDaylight with NEMO engine must be deployed in one host. - -Target Environment -^^^^^^^^^^^^^^^^^^ - -The intent expressed by NEMO model is depended on network resources, so user need to have enough -resources to use, or else, the deployment of intent will fail. - -Instructions -^^^^^^^^^^^^ - -- Run the OpenDaylight distribution and install odl-nemo-engine-ui from the Karaf console. -- Go to ``http://{controller-ip}:8181/index.html``, and sign in. -- Go the NEMO UI interface. And Register a new user with user name, password, and tenant. -- Check the existing resources to see if it is consistent with yours. -- Deploy service with NEMO model by the create intent menu. - -- 2.36.6