diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/usecases/media/dd-postman-runner.png | bin | 140243 -> 0 bytes | |||
| -rw-r--r-- | docs/usecases/media/pnf-simulator-demo-cba-enriched.zip | bin | 31920 -> 0 bytes | |||
| -rw-r--r-- | docs/usecases/media/pnf-simulator-demo-cba-unenriched.zip | bin | 14491 -> 0 bytes | |||
| -rw-r--r-- | docs/usecases/media/pnf-simulator.postman_collection.json | 37 | ||||
| -rw-r--r-- | docs/usecases/media/save-response-postman.png | bin | 154196 -> 0 bytes | |||
| -rw-r--r-- | docs/usecases/pnf-simulator.rst | 774 | ||||
| -rw-r--r-- | docs/userguide/media/create_run_config_kt.png | bin | 99443 -> 95597 bytes | |||
| -rw-r--r-- | docs/userguide/media/import_project.png | bin | 33478 -> 35239 bytes | |||
| -rw-r--r-- | docs/userguide/media/run-config-set-up.png | bin | 0 -> 45625 bytes | |||
| -rw-r--r-- | docs/userguide/running-bp-processor-in-ide.rst | 59 |
10 files changed, 251 insertions, 619 deletions
diff --git a/docs/usecases/media/dd-postman-runner.png b/docs/usecases/media/dd-postman-runner.png Binary files differdeleted file mode 100644 index 747e86231..000000000 --- a/docs/usecases/media/dd-postman-runner.png +++ /dev/null diff --git a/docs/usecases/media/pnf-simulator-demo-cba-enriched.zip b/docs/usecases/media/pnf-simulator-demo-cba-enriched.zip Binary files differdeleted file mode 100644 index 08ee91b76..000000000 --- a/docs/usecases/media/pnf-simulator-demo-cba-enriched.zip +++ /dev/null diff --git a/docs/usecases/media/pnf-simulator-demo-cba-unenriched.zip b/docs/usecases/media/pnf-simulator-demo-cba-unenriched.zip Binary files differdeleted file mode 100644 index a373f5083..000000000 --- a/docs/usecases/media/pnf-simulator-demo-cba-unenriched.zip +++ /dev/null diff --git a/docs/usecases/media/pnf-simulator.postman_collection.json b/docs/usecases/media/pnf-simulator.postman_collection.json index a4834f0cd..cab40da85 100644 --- a/docs/usecases/media/pnf-simulator.postman_collection.json +++ b/docs/usecases/media/pnf-simulator.postman_collection.json @@ -1,6 +1,6 @@ { "info": { - "_postman_id": "1fa613b3-d757-4887-b6b4-94c596bbe821", + "_postman_id": "0175f488-96af-4253-ad35-d2a670330091", "name": "CDS PNF Simulator Use Case", "description": "This collection contains all API calls to do the \"PNF Simulator Day-N config-assign and config-deploy use case\" in CDS. ", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" @@ -341,7 +341,7 @@ { "listen": "prerequest", "script": { - "id": "ffcd53f6-a19e-4ecb-9220-bea23105b997", + "id": "697ce54a-7333-4b86-9d51-9591f741ad7d", "exec": [ "var allDD = pm.environment.get(\"allDD\");\r", "\r", @@ -517,7 +517,7 @@ { "listen": "test", "script": { - "id": "79594336-6372-432e-8111-9b1d2c89d2e2", + "id": "ba9ff38c-cfb4-4e76-a58c-11c28b62a394", "exec": [ "var allDD = pm.environment.get(\"allDD\");\r", "\r", @@ -874,7 +874,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"actionIdentifiers\": {\n \"mode\": \"sync\",\n \"blueprintName\": \"pnf_netconf\",\n \"blueprintVersion\": \"1.0.0\",\n \"actionName\": \"config-assign\"\n },\n \"payload\": {\n \"config-assign-request\": {\n \"template-prefix\": [\n \"pnf\", \"netconfrpc\"\n ],\n \"resolution-key\": \"day-1\",\n \"config-assign-properties\": {\n \"pnf-id\": \"abcd\",\n \"pnf-ipv4-address\": \"172.17.0.2\",\n \"netconf-password\": \"netconf\",\n \"netconf-username\": \"netconf\",\n \"netconf-server-port\": \"830\",\n \"stream-count\": 5\n }\n }\n },\n \"commonHeader\": {\n \"subRequestId\": \"143748f9-3cd5-4910-81c9-a4601ff2ea58\",\n \"requestId\": \"e5eb1f1e-3386-435d-b290-d49d8af8db4c\",\n \"originatorId\": \"SDNC_DG\"\n }\n}", + "raw": "{\n\n \"actionIdentifiers\": {\n \"mode\": \"sync\",\n \"blueprintName\": \"pnf_netconf\",\n \"blueprintVersion\": \"1.0.0\",\n \"actionName\": \"config-assign\"\n },\n \"payload\": {\n \"config-assign-request\": {\n \"resolution-key\": \"day-1\",\n \"config-assign-properties\": {\n \"stream-count\": 5\n }\n }\n },\n \"commonHeader\": {\n \"subRequestId\": \"143748f9-3cd5-4910-81c9-a4601ff2ea58\",\n \"requestId\": \"e5eb1f1e-3386-435d-b290-d49d8af8db4c\",\n \"originatorId\": \"SDNC_DG\"\n }\n}", "options": { "formdata": {}, "raw": { @@ -951,7 +951,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"actionIdentifiers\": {\n \"mode\": \"sync\",\n \"blueprintName\": \"pnf_netconf\",\n \"blueprintVersion\": \"1.0.0\",\n \"actionName\": \"config-assign\"\n },\n \"payload\": {\n \"config-assign-request\": {\n \"template-prefix\": [\n \"pnf\", \"netconfrpc\"\n ],\n \"resolution-key\": \"day-2\",\n \"config-assign-properties\": {\n \"pnf-id\": \"abcd\",\n \"pnf-ipv4-address\": \"172.17.0.2\",\n \"netconf-password\": \"netconf\",\n \"netconf-username\": \"netconf\",\n \"netconf-server-port\": \"830\",\n \"stream-count\": 10\n }\n }\n },\n \"commonHeader\": {\n \"subRequestId\": \"143748f9-3cd5-4910-81c9-a4601ff2ea58\",\n \"requestId\": \"e5eb1f1e-3386-435d-b290-d49d8af8db4c\",\n \"originatorId\": \"SDNC_DG\"\n }\n}", + "raw": "{\n \"actionIdentifiers\": {\n \"mode\": \"sync\",\n \"blueprintName\": \"pnf_netconf\",\n \"blueprintVersion\": \"1.0.0\",\n \"actionName\": \"config-assign\"\n },\n \"payload\": {\n \"config-assign-request\": {\n \"resolution-key\": \"day-2\",\n \"config-assign-properties\": {\n \"stream-count\": 10\n }\n }\n },\n \"commonHeader\": {\n \"subRequestId\": \"143748f9-3cd5-4910-81c9-a4601ff2ea58\",\n \"requestId\": \"e5eb1f1e-3386-435d-b290-d49d8af8db4c\",\n \"originatorId\": \"SDNC_DG\"\n }\n}", "options": { "formdata": {}, "raw": { @@ -1028,7 +1028,7 @@ ], "body": { "mode": "raw", - "raw": "{\n\t\"actionIdentifiers\": {\n\t\t\"mode\": \"sync\",\n\t\t\"blueprintName\": \"pnf_netconf\",\n\t\t\"blueprintVersion\": \"1.0.0\",\n\t\t\"actionName\": \"config-deploy\"\n\t},\n\t\"payload\": {\n\t\t\"config-deploy-request\": {\n\t\t\t\"resolution-key\": \"day-1\",\n\t\t\t\"config-deploy-properties\": {\n\t\t\t\t\"pnf-id\": \"abcd\",\n\t\t\t\t\"pnf-ipv4-address\": \"172.17.0.2\",\n\t\t\t\t\"netconf-password\": \"netconf\",\n\t\t\t\t\"netconf-username\": \"netconf\"\n\t\t\t}\n\t\t}\n\t}\n\n\t,\n\t\"commonHeader\": {\n\t\t\"subRequestId\": \"143748f9-3cd5-4910-81c9-a4601ff2ea58\",\n\t\t\"requestId\": \"e5eb1f1e-3386-435d-b290-d49d8af8db4c\",\n\t\t\"originatorId\": \"SDNC_DG\"\n\t}\n}\n", + "raw": "{\n\t\"actionIdentifiers\": {\n\t\t\"mode\": \"sync\",\n\t\t\"blueprintName\": \"pnf_netconf\",\n\t\t\"blueprintVersion\": \"1.0.0\",\n\t\t\"actionName\": \"config-deploy\"\n\t},\n\t\"payload\": {\n\t\t\"config-deploy-request\": {\n\t\t\t\"resolution-key\": \"day-1\",\n\t\t\t\t\"pnf-ipv4-address\": \"{{pnf-ipv4-address}}\",\n \"netconf-username\": \"{{netconf-username}}\",\n\t\t\t\t\"netconf-password\": \"{{netconf-password}}\"\n\t\t}\n\t},\n\t\"commonHeader\": {\n\t\t\"subRequestId\": \"143748f9-3cd5-4910-81c9-a4601ff2ea58\",\n\t\t\"requestId\": \"e5eb1f1e-3386-435d-b290-d49d8af8db4c\",\n\t\t\"originatorId\": \"SDNC_DG\"\n\t}\n}", "options": { "formdata": {}, "raw": { @@ -1105,7 +1105,7 @@ ], "body": { "mode": "raw", - "raw": "{\n\t\"actionIdentifiers\": {\n\t\t\"mode\": \"sync\",\n\t\t\"blueprintName\": \"pnf_netconf\",\n\t\t\"blueprintVersion\": \"1.0.0\",\n\t\t\"actionName\": \"config-deploy\"\n\t},\n\t\"payload\": {\n\t\t\"config-deploy-request\": {\n\t\t\t\"resolution-key\": \"day-2\",\n\t\t\t\"config-deploy-properties\": {\n\t\t\t\t\"pnf-id\": \"abcd\",\n\t\t\t\t\"pnf-ipv4-address\": \"172.17.0.2\",\n\t\t\t\t\"netconf-password\": \"netconf\",\n\t\t\t\t\"netconf-username\": \"netconf\"\n\t\t\t}\n\t\t}\n\t}\n\n\t,\n\t\"commonHeader\": {\n\t\t\"subRequestId\": \"143748f9-3cd5-4910-81c9-a4601ff2ea58\",\n\t\t\"requestId\": \"e5eb1f1e-3386-435d-b290-d49d8af8db4c\",\n\t\t\"originatorId\": \"SDNC_DG\"\n\t}\n}\n", + "raw": "{\n\t\"actionIdentifiers\": {\n\t\t\"mode\": \"sync\",\n\t\t\"blueprintName\": \"pnf_netconf\",\n\t\t\"blueprintVersion\": \"1.0.0\",\n\t\t\"actionName\": \"config-deploy\"\n\t},\n\t\"payload\": {\n\t\t\"config-deploy-request\": {\n\t\t\t\"resolution-key\": \"day-2\",\n\t\t\t\t\"pnf-ipv4-address\": \"{{pnf-ipv4-address}}\",\n \"netconf-username\": \"{{netconf-username}}\",\n\t\t\t\t\"netconf-password\": \"{{netconf-password}}\"\n\t\t}\n\t},\n\t\"commonHeader\": {\n\t\t\"subRequestId\": \"143748f9-3cd5-4910-81c9-a4601ff2ea58\",\n\t\t\"requestId\": \"e5eb1f1e-3386-435d-b290-d49d8af8db4c\",\n\t\t\"originatorId\": \"SDNC_DG\"\n\t}\n}", "options": { "formdata": {}, "raw": { @@ -1135,7 +1135,7 @@ { "listen": "prerequest", "script": { - "id": "2bd5eabc-8019-408f-844e-35354a896c38", + "id": "b3476f00-24ef-4484-af58-525137927dc5", "type": "text/javascript", "exec": [ "" @@ -1145,7 +1145,7 @@ { "listen": "test", "script": { - "id": "b52b4979-114a-4642-84d7-73534f26c077", + "id": "4715993f-2476-4d02-a1e3-7f72b9dafeba", "type": "text/javascript", "exec": [ "" @@ -1155,14 +1155,29 @@ ], "variable": [ { - "id": "9cedb535-6b95-4348-8e42-8786c0731503", + "id": "a1d2b48e-7c0f-4c95-a476-430be6228e95", "key": "host", "value": "localhost" }, { - "id": "4dcce46f-d0c4-4059-9ba0-157f9b85e8ad", + "id": "9202dd75-6852-44fd-b7b0-b8ad0714e8c7", "key": "port", "value": "8081" + }, + { + "id": "0087a55c-64f3-44c6-9b56-6300c4b4362e", + "key": "pnf-ipv4-address", + "value": "127.17.0.2" + }, + { + "id": "fd1a7cfe-9526-4261-beb4-61935e8d4ab0", + "key": "netconf-username", + "value": "netconf" + }, + { + "id": "8b004a49-14a3-415e-9646-5c82033bf0ea", + "key": "netconf-password", + "value": "netconf" } ], "protocolProfileBehavior": {} diff --git a/docs/usecases/media/save-response-postman.png b/docs/usecases/media/save-response-postman.png Binary files differdeleted file mode 100644 index d46c0fe21..000000000 --- a/docs/usecases/media/save-response-postman.png +++ /dev/null diff --git a/docs/usecases/pnf-simulator.rst b/docs/usecases/pnf-simulator.rst index 5e44967c4..3712253ee 100644 --- a/docs/usecases/pnf-simulator.rst +++ b/docs/usecases/pnf-simulator.rst @@ -9,13 +9,13 @@ PNF Simulator Day-N config-assign/deploy Overview ~~~~~~~~~~ -This use case shows in a very simple way how a blueprint model of a PNF is created in CDS and how the day-n configuration is -assigned and deployed through CDS. A Netconf server (docker image `sysrepo/sysrepo-netopeer2`) is used for simulating the PNF. +This use case shows in a very simple way how the day-n configuration is assigned and deployed to a PNF through CDS. +A Netconf server (docker image `sysrepo/sysrepo-netopeer2`) is used for simulating the PNF. This use case (POC) solely requires a running CDS and the PNF Simulator running on a VM (Ubuntu is used by the author). No other module of ONAP is needed. -There are different ways to run CDS, to run PNF simulator and to do configuration deployment. This guide will show +There are different ways to run CDS and the PNF simulator. This guide will show different possible options to allow the greatest possible flexibility. Run CDS (Blueprint Processor) @@ -336,591 +336,194 @@ here but they are not tested by the author of this guide. Config-assign and config-deploy in CDS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In the following steps the CBA is published in CDS, config-assignment is done and the config is deployed to to the -Netconf server through CDS in the last step. We will use this CBA: :download:`zip <media/pnf-simulator-demo-cba-unenriched.zip>`. -If you want to use scripts instead of Postman the CBA also contains all necessary scripts. +In the following steps config-assignment is done and the config is deployed to the +Netconf server through CDS. Example requests are in the following Postman collection +:download:`JSON <media/pnf-simulator.postman_collection.json>`. You can also use bash scripting to call the APIs. -.. tabs:: - - .. tab:: Scripts - - **There will be different scripts depending on your CDS installation. For running it in an IDE always use scripts with** - **-ide.sh prefix. For running CDS in Kubernetes use scripts with -k8s.sh ending. In scripts with -ide.sh prefix** - **host will be localhost and port will be 8081. For K8s host ip adress gets automatically detected, port is 8000.** - - **Set up CDS:** - - Unzip the downloaded CBA and go to ``/Scripts/`` directory. - - The below script will call Bootstrap API of CDS which loads the CDS default model artifacts into CDS DB. - You should get HTTP status 200 for the below command. - - .. code-block:: sh - - bash -x ./bootstrap-cds-ide.sh - # bash -x ./bootstrap-cds-k8s.sh - - Call ``bash -x ./get-cds-blueprint-models-ide.sh`` / ``bash -x ./get-cds-blueprint-models-k8s.sh`` to get all blueprint models in the CDS database. - You will see a default model ``"artifactName": "vFW-CDS"`` which was loaded by calling bootstrap. - - Push the PNF CDS blueprint model data dictionary to CDS by calling ``bash -x ./dd-microk8s-ide.sh ./dd.json`` / - ``bash -x ./dd-microk8s-k8s.sh ./dd.json``. - This will call the data dictionary endpoint of CDS. - - Check CDS database for PNF data dictionaries by entering the DB. You should see 6 rows as shown below. - - **For running CDS in an IDE (accessing mariadb container):** - - .. code-block:: sh - - sudo docker exec -it mariadb_container_id mysql -uroot -psdnctl - > USE sdnctl; - > select name, data_type from RESOURCE_DICTIONARY where updated_by='Aarna service <vmuthukrishnan@aarnanetworks.com>'; - - +---------------------+-----------+ - | name | data_type | - +---------------------+-----------+ - | netconf-password | string | - | netconf-server-port | string | - | netconf-username | string | - | pnf-id | string | - | pnf-ipv4-address | string | - | stream-count | integer | - +---------------------+-----------+ - - quit - - Replace the container id with your running mariadb container id. - - - **For running CDS in K8s (accessing MariaDB pod):** - - .. code-block:: sh - - ./connect-cds-mariadb-k8s.sh - - select name, data_type from RESOURCE_DICTIONARY where updated_by='Aarna service <vmuthukrishnan@aarnanetworks.com>'; - - +---------------------+-----------+ - | name | data_type | - +---------------------+-----------+ - | netconf-password | string | - | netconf-server-port | string | - | netconf-username | string | - | pnf-id | string | - | pnf-ipv4-address | string | - | stream-count | integer | - +---------------------+-----------+ - - quit - - **Enrichment:** - - Move to the main folder of the CBA with ``cd ..`` and archive all folders with ``zip -r pnf-demo.zip *``. - - .. warning:: - Sometimes there might be issues during enrichment (e.g. some parameters get deleted in the CBA)). If you face problems - during enrichment or deployment later on use the following CBA, which is already enriched: - :download:`zip <media/pnf-simulator-demo-cba-enriched.zip>`. If you use the enriched CBA, skip - this section until Deploy/Save Blueprint. - - Enrich the blueprint through calling the following script. Take care to provide the zip file you downloader earlier. - - .. code-block:: sh - - cd Scripts - bash -x ./enrich-and-download-cds-blueprint-ide.sh ../pnf-demo.zip - # bash -x ./enrich-and-download-cds-blueprint-k8s.sh ../pnf-demo.zip - - Go to the enriched CBA folder with ``cd /tmp/CBA/`` and unzip with ``unzip pnf-demo.zip``. - - **Deploy/Save the Blueprint into CDS database** - - Go to Scripts folder with ``cd Scripts``. - - Run the following script to save/deploy the Blueprint into the CDS database. - - .. code-block:: sh - - bash -x ./save-enriched-blueprint-ide.sh ../pnf-demo.zip - # bash -x ./save-enriched-blueprint-k8s.sh ../pnf-demo.zip - - After that you should see the new model "artifactName": "pnf_netconf" by calling ``bash -x ./get-cds-blueprint-models.sh`` - - **Config-Assign** - - The assumption is that we are using the same host to run PNF NETCONF simulator as well as CDS. You will need the - IP Adress of the Netconf server container which can be found out with - ``docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' netopeer2``. In the - following examples we will use 172.17.0.2. - - Day-1 configuration: - - .. code-block:: sh - - bash -x ./create-config-assing-data-ide.sh day-1 172.17.0.2 5 - # bash -x ./create-config-assing-data-k8s.sh day-1 172.17.0.2 5 - - You can verify the day-1 NETCONF RPC payload looking into CDS DB. You should see the NETCONF RPC with 5 - streams (fw_udp_1 TO fw_udp_5). Connect to the DB like mentioned above and run the below statement. You should - see the day-1 configuration as an output. - - .. code-block:: sh - - MariaDB [sdnctl]> select * from TEMPLATE_RESOLUTION where resolution_key='day-1' AND artifact_name='netconfrpc'; - - <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1"> - <edit-config> - <target> - <running/> - </target> - <config> - <sample-plugin xmlns="urn:opendaylight:params:xml:ns:yang:sample-plugin"> - <pg-streams> - <pg-stream> - <id>fw_udp_1</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_2</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_3</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_4</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_5</id> - <is-enabled>true</is-enabled> - </pg-stream> - </pg-streams> - </sample-plugin> - </config> - </edit-config> - </rpc> - - Create PNF configuration for resolution-key = day-2 (stream-count = 10). - You can verify the CURL command JSON pay load file /tmp/day-n-pnf-config.json - - .. code-block:: sh - - bash -x ./create-config-assing-data-ide.sh day-2 172.17.0.2 10 - # bash -x ./create-config-assing-data-k8s.sh day-2 172.17.0.2 10 - - You can verify the day-2 NETCONF RPC payload looking into CDS DB. You should see the NETCONF RPC with 10 - streams (fw_udp_1 TO fw_udp_10). Connect to the DB like mentioned above and run the below statement. You should - see the day-2 configuration as an output. - - .. code-block:: sh - - MariaDB [sdnctl]> select * from TEMPLATE_RESOLUTION where resolution_key='day-2' AND artifact_name='netconfrpc'; - - <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1"> - <edit-config> - <target> - <running/> - </target> - <config> - <sample-plugin xmlns="urn:opendaylight:params:xml:ns:yang:sample-plugin"> - <pg-streams> - <pg-stream> - <id>fw_udp_1</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_2</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_3</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_4</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_5</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_6</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_7</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_8</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_9</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_10</id> - <is-enabled>true</is-enabled> - </pg-stream> - </pg-streams> - </sample-plugin> - </config> - </edit-config> - </rpc> - - .. note:: - Until this step CDS did not interact with the PNF simulator or device. We just created the day-1 and day-2 - configurations and stored it in CDS database - - **Config-Deploy:** - - Now we will make the CDS REST API calls to push the day-1 and day-2 configuration changes to the PNF simulator. - - If you run CDS in Kubernetes open a new terminal and keep it running with ``bash -x ./tail-cds-bp-log.sh``, - we can use this to review the config-deploy actions. If you run CDS in an IDE you can have a look into the IDE terminal. - - Following command will deploy day-1 configuration. - Syntax is ``# bash -x ./process-config-deploy.sh RESOLUTION_KEY PNF_IP_ADDRESS`` - - .. code-block:: sh - - bash -x ./process-config-deploy-ide.sh day-1 127.17.0.2 - # bash -x ./process-config-deploy-k8s.sh day-1 127.17.0.2 - - Go back to PNF netopeer cli console like mentioned above and verify if you can see 5 streams fw_udp_1 to fw_udp_5 enabled. If the 5 streams - appear in the output as follows, the day-1 configuration got successfully deployed and the use case is successfully done. - - .. code-block:: sh - - > get --filter-xpath /sample-plugin:* - DATA - <sample-plugin xmlns="urn:opendaylight:params:xml:ns:yang:sample-plugin"> - <pg-streams> - <pg-stream> - <id>1</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_1</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_2</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_3</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_4</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_5</id> - <is-enabled>true</is-enabled> - </pg-stream> - </pg-streams> - </sample-plugin> - > - - The same can be done for day-2 config (follow same steps just with day-2 configuration). - - .. note:: - Through deployment we did not deploy the PNF, we just modified the PNF. The PNF could also be installed by CDS - but this is not targeted in this guide. - - .. tab:: Postman - - Download the Postman collection :download:`json <media/pnf-simulator.postman_collection.json>` and import it into - your Postman application. Set the collection variables `ip adress` and `port` depending on your CDS installation. - This can be done by right clicking the collection, click `edit` and then go to variables. - For running CDS in an IDE host should be localhost and port should be 8081. If you run CDS in Kubernetes you can find - out ip adress and port number of CDS blueprint processor by executing following command: - - .. code-block:: bash - - kubectl get svc -n onap | grep 'cds-blueprints-processor-http' - - cds-blueprints-processor-http ClusterIP 10.152.183.211 <none> 8080/TCP 3h19m - - **Set up CDS:** - - First run `Bootstrap` request which will call Bootstrap API of CDS. This loads the CDS default model artifacts into CDS DB. - You should get HTTP status 200 as a response. - - You can execute `Get Blueprints` to get all blueprint models in the CDS database. You will see a default - model "artifactName": "vFW-CDS" in the response body which was loaded by calling bootstrap. - - Push the PNF CDS blueprint model data dictionary to CDS with `Data Dictionary` request. Request body contains the - data from ``dd.json`` of the CBA. This will call the data dictionary endpoint of CDS. - - .. note:: - For every data dictionary entry CDS API needs to be called seperately. The postman collection contains a loop to - go through all entries of :file:`dd.json` and call data dictionary endpoint seperately. To execute this loop, - open `Runner` in Postman and run `Data Dictionary` request like it is shown in the picture below. - - |imageDDPostmanRunner| - - Check CDS database for PNF data dictionaries by entering the DB in a terminal. You should see 6 rows as shown below. - - For running CDS in an IDE (accessing mariadb container): - - .. code-block:: sh - - sudo docker exec -it mariadb_container_id mysql -uroot -psdnctl - > USE sdnctl; - > select name, data_type from RESOURCE_DICTIONARY where updated_by='Aarna service <vmuthukrishnan@aarnanetworks.com>'; - - +---------------------+-----------+ - | name | data_type | - +---------------------+-----------+ - | netconf-password | string | - | netconf-server-port | string | - | netconf-username | string | - | pnf-id | string | - | pnf-ipv4-address | string | - | stream-count | integer | - +---------------------+-----------+ - - Replace the container id with your running mariadb container id. - - - For running CDS in K8s (accessing MariaDB pod): - - Open a terminal and go to ``/Scripts`` directory of your CBA. - - .. code-block:: sh - - ./connect-cds-mariadb-k8s.sh - - select name, data_type from RESOURCE_DICTIONARY where updated_by='Aarna service <vmuthukrishnan@aarnanetworks.com>'; - - +---------------------+-----------+ - | name | data_type | - +---------------------+-----------+ - | netconf-password | string | - | netconf-server-port | string | - | netconf-username | string | - | pnf-id | string | - | pnf-ipv4-address | string | - | stream-count | integer | - +---------------------+-----------+ - - - **Enrichment:** - - .. warning:: - Sometimes there might be issues during enrichment (e.g. some parameters get deleted in the CBA). If you face problems - during enrichment or deployment later on use the following CBA, which is already enriched: - :download:`zip <media/pnf-simulator-demo-cba-enriched.zip>`. If you use the enriched CBA, skip - this section until Deploy/Save Blueprint. - - Enrich the blueprint through executing the `Enrich Blueprint` request. Take care to provide the CBA file which you - downloaded earlier in the request body. After the request got executed save the response body, this will be the - enriched CBA file. - - |saveResponseImage| - - - **Deploy/Save the Blueprint into CDS database** - - Run `Save Blueprint` request to save/deploy the Blueprint into the CDS database. Take care to provide the enriched - CBA file in the request body. - - After that you should see the new model "artifactName": "pnf_netconf" by calling `Get Blueprints` request. - - **Config-Assign** - - The assumption is that we are using the same host to run PNF NETCONF simulator as well as CDS. You will need the - IP Adress of the Netconf server container which can be found out in terminal with - ``docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' netopeer2``. In the provided - postman collection 172.17.0.2 is set as default. - - For creating the day-n config we are using the template file ``day-n-pnf-config.template`` in the folder - ``Scripts/templates`` of the CBA. ``CONFIG_NAME``, ``PNF_IP_ADDRESS`` and ``STREAM_COUNT`` are replaced with specific values. - - Day-1 configuration: - - Execute the request `Create Config Assign Day-1`. Replace the values in the reqest body if needed. - - You can verify the day-1 NETCONF RPC payload looking into CDS DB. You should see the NETCONF RPC with 5 - streams (fw_udp_1 TO fw_udp_5). Connect to the DB like mentioned above and run the below statement. You should - see the day-1 configuration as an output. +.. note:: + The CBA for this PNF Demo gets loaded, enriched and saved in CDS through calling bootstrap. If not done before, call + Bootstrap API - .. code-block:: sh - - MariaDB [sdnctl]> select * from TEMPLATE_RESOLUTION where resolution_key='day-1' AND artifact_name='netconfrpc'; - - <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1"> - <edit-config> - <target> - <running/> - </target> - <config> - <sample-plugin xmlns="urn:opendaylight:params:xml:ns:yang:sample-plugin"> - <pg-streams> - <pg-stream> - <id>fw_udp_1</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_2</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_3</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_4</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_5</id> - <is-enabled>true</is-enabled> - </pg-stream> - </pg-streams> - </sample-plugin> - </config> - </edit-config> - </rpc> - - - **Day-2 configuration:** - - Execute the request `Create Config Assign Day-2`. It will do the same request like in day-1-config just with - different values (resolution-key = day-2, stream-count = 10). - - You can verify the day-2 NETCONF RPC payload looking into CDS DB. You should see the NETCONF RPC with 10 - streams (fw_udp_1 TO fw_udp_10). Connect to the DB like mentioned above and run the below statement. You should - see the day-2 configuration as an output. - - .. code-block:: sh - - MariaDB [sdnctl]> select * from TEMPLATE_RESOLUTION where resolution_key='day-2' AND artifact_name='netconfrpc'; - - <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1"> - <edit-config> - <target> - <running/> - </target> - <config> - <sample-plugin xmlns="urn:opendaylight:params:xml:ns:yang:sample-plugin"> - <pg-streams> - <pg-stream> - <id>fw_udp_1</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_2</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_3</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_4</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_5</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_6</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_7</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_8</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_9</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_10</id> - <is-enabled>true</is-enabled> - </pg-stream> - </pg-streams> - </sample-plugin> - </config> - </edit-config> - </rpc> - - .. note:: - Until this step CDS did not interact with the PNF simulator or device. We just created the day-1 and day-2 - configurations and stored it in CDS database - - **Config-Deploy:** - - Now we will make the CDS REST API calls to push the day-1 and day-2 configuration changes to the PNF simulator. - - If you run CDS in Kubernetes open a terminal in `/Scripts` folder and keep it running with ``bash -x ./tail-cds-bp-log.sh``, - we can use this to review the config-deploy actions. If you run CDS in an IDE you can have a look into the IDE terminal. - - Executing `Config Assign Day-1 Deploy` request will deploy day-1 configuration. Take care to provide the right PNF - IP Adress in the request body. - - Go back to PNF netopeer cli console like mentioned above and verify if you can see 5 streams fw_udp_1 to fw_udp_5 enabled. If the 5 streams - appear in the output as follows, the day-1 configuration got successfully deployed and the use case is successfully done. +Password and username for API calls will be `ccsdkapps`. - .. code-block:: sh - - > get --filter-xpath /sample-plugin:* - DATA - <sample-plugin xmlns="urn:opendaylight:params:xml:ns:yang:sample-plugin"> - <pg-streams> - <pg-stream> - <id>1</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_1</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_2</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_3</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_4</id> - <is-enabled>true</is-enabled> - </pg-stream> - <pg-stream> - <id>fw_udp_5</id> - <is-enabled>true</is-enabled> - </pg-stream> - </pg-streams> - </sample-plugin> - > +**Config-Assign:** - Day-2 configuration can be deployed the same way, just use `day-2` as a resolution key in the `Config Assign Depoy` - request. +The assumption is that we are using the same host to run PNF NETCONF simulator as well as CDS. You will need the +IP Adress of the Netconf server container which can be found out with +``docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' netopeer2``. In the +following example payloads we will use 172.17.0.2. - .. note:: - Through deployment we did not deploy the PNF, we just modified the PNF. The PNF could also be installed by CDS - but this is not targeted in this guide. +Call the `process` API (``http://{{host}}:{{port}}/api/v1/execution-service/process``) with POST method to +create day-1 configuration. Use the following payload: +.. code-block:: JSON -.. warning:: - Both CBA file and Postman collection should be integrated into source code of CDS. There is already an approach for that, - see https://gerrit.onap.org/r/c/ccsdk/cds/+/112288. Updated Scripts and Postman collection needs to be added to this change. + { + "actionIdentifiers": { + "mode": "sync", + "blueprintName": "pnf_netconf", + "blueprintVersion": "1.0.0", + "actionName": "config-assign" + }, + "payload": { + "config-assign-request": { + "resolution-key": "day-1", + "config-assign-properties": { + "stream-count": 5 + } + } + }, + "commonHeader": { + "subRequestId": "143748f9-3cd5-4910-81c9-a4601ff2ea58", + "requestId": "e5eb1f1e-3386-435d-b290-d49d8af8db4c", + "originatorId": "SDNC_DG" + } + } + +You can verify the day-1 NETCONF RPC payload looking into CDS DB. You should see the NETCONF RPC with 5 +streams (fw_udp_1 TO fw_udp_5). Connect to the DB and run the below statement. You should +see the day-1 configuration as an output. + +.. code-block:: sh + + MariaDB [sdnctl]> select * from TEMPLATE_RESOLUTION where resolution_key='day-1' AND artifact_name='netconfrpc'; + + <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1"> + <edit-config> + <target> + <running/> + </target> + <config> + <sample-plugin xmlns="urn:opendaylight:params:xml:ns:yang:sample-plugin"> + <pg-streams> + <pg-stream> + <id>fw_udp_1</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_2</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_3</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_4</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_5</id> + <is-enabled>true</is-enabled> + </pg-stream> + </pg-streams> + </sample-plugin> + </config> + </edit-config> + </rpc> + +For creating day-2 configuration call the same endpoint and use the following payload: + +.. code-block:: JSON + + { + "actionIdentifiers": { + "mode": "sync", + "blueprintName": "pnf_netconf", + "blueprintVersion": "1.0.0", + "actionName": "config-assign" + }, + "payload": { + "config-assign-request": { + "resolution-key": "day-2", + "config-assign-properties": { + "stream-count": 10 + } + } + }, + "commonHeader": { + "subRequestId": "143748f9-3cd5-4910-81c9-a4601ff2ea58", + "requestId": "e5eb1f1e-3386-435d-b290-d49d8af8db4c", + "originatorId": "SDNC_DG" + } + } + + +.. note:: + Until this step CDS did not interact with the PNF simulator or device. We just created the day-1 and day-2 + configurations and stored it in CDS database + +**Config-Deploy:** + +Now we will make the CDS REST API calls to push the day-1 and day-2 configuration changes to the PNF simulator. +Call the same endpoint `process` with the following payload: + +.. code-block:: JSON + + { + "actionIdentifiers": { + "mode": "sync", + "blueprintName": "pnf_netconf", + "blueprintVersion": "1.0.0", + "actionName": "config-deploy" + }, + "payload": { + "config-deploy-request": { + "resolution-key": "day-1", + "pnf-ipv4-address": "127.17.0.2", + "netconf-username": "netconf", + "netconf-password": "netconf" + } + }, + "commonHeader": { + "subRequestId": "143748f9-3cd5-4910-81c9-a4601ff2ea58", + "requestId": "e5eb1f1e-3386-435d-b290-d49d8af8db4c", + "originatorId": "SDNC_DG" + } + } + +Go back to PNF netopeer cli console like mentioned above and verify if you can see 5 streams fw_udp_1 to fw_udp_5 enabled. If the 5 streams +appear in the output as follows, the day-1 configuration got successfully deployed and the use case is successfully done. + +.. code-block:: sh + + > get --filter-xpath /sample-plugin:* + DATA + <sample-plugin xmlns="urn:opendaylight:params:xml:ns:yang:sample-plugin"> + <pg-streams> + <pg-stream> + <id>1</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_1</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_2</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_3</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_4</id> + <is-enabled>true</is-enabled> + </pg-stream> + <pg-stream> + <id>fw_udp_5</id> + <is-enabled>true</is-enabled> + </pg-stream> + </pg-streams> + </sample-plugin> + > + +The same can be done for day-2 config (follow same steps just with day-2 in payload). + +.. note:: + Through deployment we did not deploy the PNF, we just modified the PNF. The PNF could also be installed by CDS + but this is not targeted in this guide. Creators of this guide @@ -930,11 +533,4 @@ Deutsche Telekom AG Jakob Krieg (Rocketchat @jakob.Krieg); Eli Halych (Rocketchat @elihalych) -This guide is a derivate from https://wiki.onap.org/display/DW/PNF+Simulator+Day-N+config-assign+and+config-deploy+use+case. - - -.. |saveResponseImage| image:: media/save-response-postman.png - :width: 500pt - -.. |imageDDPostmanRunner| image:: media/dd-postman-runner.png - :width: 500pt
\ No newline at end of file +This guide is a derivate from https://wiki.onap.org/display/DW/PNF+Simulator+Day-N+config-assign+and+config-deploy+use+case.
\ No newline at end of file diff --git a/docs/userguide/media/create_run_config_kt.png b/docs/userguide/media/create_run_config_kt.png Binary files differindex 6f86a7e3a..566ff609c 100644 --- a/docs/userguide/media/create_run_config_kt.png +++ b/docs/userguide/media/create_run_config_kt.png diff --git a/docs/userguide/media/import_project.png b/docs/userguide/media/import_project.png Binary files differindex 06b36c53d..ce7eb3ac5 100644 --- a/docs/userguide/media/import_project.png +++ b/docs/userguide/media/import_project.png diff --git a/docs/userguide/media/run-config-set-up.png b/docs/userguide/media/run-config-set-up.png Binary files differnew file mode 100644 index 000000000..3c2e5fb4f --- /dev/null +++ b/docs/userguide/media/run-config-set-up.png diff --git a/docs/userguide/running-bp-processor-in-ide.rst b/docs/userguide/running-bp-processor-in-ide.rst index e5ea2b09d..3cbcc18b1 100644 --- a/docs/userguide/running-bp-processor-in-ide.rst +++ b/docs/userguide/running-bp-processor-in-ide.rst @@ -9,7 +9,7 @@ Running Blueprints Processor Microservice in an IDE Objective ~~~~~~~~~~~~ -Have the blueprint processor running locally is to use the IDE to run the code, while having the database running in a container. +Run the blueprint processor locally in an IDE, while having the database running in a container. This way, code changes can be conveniently tested and debugged. Check out the code @@ -26,6 +26,8 @@ In the checked out directory, type mvn clean install -Pq -Dadditionalparam=-Xdoclint:none +Wait for the maven install command to finish until you go further. + Spin up a Docker container with the database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -33,7 +35,7 @@ The Blueprints Processor project uses a database to store information about the and therefore it needs to be online before attempting to run it. One way to create the database is by using the :file:`docker-compose.yaml` file. -This database will require a local directory to mount a volume, before running docker-compose remember to create following directory: +This database will require a local directory to mount a volume, therefore before running docker-compose create following directory: .. code-block:: bash @@ -99,18 +101,21 @@ Import the project into the IDE .. tab:: IntelliJ IDEA - Go to *File | Open* and choose the :file:`pom.xml` file of the cds directory: + .. note:: + This is the recommended IDE for running CDS blueprint processor. + + Go to *File | Open* and choose the :file:`pom.xml` file of the cds/ms/blueprintprocessor directory: |imageImportProject| - Sometimes it may be necessary to reimport Maven project: + Import as a project. Sometimes it may be necessary to reimport Maven project, e.g. if some dependencies can't be found: |imageReimportMaven| **Override some application properties:** - After the project is compiled, a Run Configuration profile overriding some application properties - with custom values needs to be created, to reflect the local environment characteristics. + Next steps will create a run configuration profile overriding some application properties with custom values, + to reflect the local environment characteristics. .. tabs:: @@ -120,8 +125,10 @@ Import the project into the IDE ``ms/blueprintsprocessor/application/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.kt``. - Right-click inside it, at any point, to load the context menu and select create - BlueprintProcessorApplication configuration from context: + After dependencies are imported and indexes are set up you will see a green arrow + next to main function of BlueprintProcessorApplication class, indicating that the run configuration can now be + created. Right-click inside the class at any point to load the context menu and select create + a run configuration from context: |imageCreateRunConfigKt| @@ -136,7 +143,7 @@ Import the project into the IDE -Dspring.profiles.active=dev - You can override any value from **application-dev.properties** file here. Use the following pattern: + Optional: You can override any value from **application-dev.properties** file here. In this case use the following pattern: .. code-block:: java @@ -148,8 +155,10 @@ Import the project into the IDE ``ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java.`` - Right-click inside it, at any point, to load the context menu and select create - BlueprintProcessorApplication configuration from context: + After dependencies are imported and indexes are set up you will see a green arrow + next to main function of BlueprintProcessorApplication class, indicating that the run configuration can now be + created. Right-click inside the class at any point to load the context menu and select create + a run configuration from context: |imageCreateRunConfigJava| @@ -164,7 +173,7 @@ Import the project into the IDE -Dspring.profiles.active=dev - You can override any value from **application-dev.properties** file here. Use the following pattern: + Optional: You can override any value from **application-dev.properties** file here. In this case use the following pattern: .. code-block:: java @@ -176,8 +185,10 @@ Import the project into the IDE ``ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java``. - Right-click inside it, at any point, to load the context menu and select create - BlueprintProcessorApplication configuration from context: + After dependencies are imported and indexes are set up you will see a green arrow + next to main function of BlueprintProcessorApplication class, indicating that the run configuration can now be + created. Right-click inside the class at any point to load the context menu and select create + a run configuration from context: |imageCreateRunConfigJava| @@ -185,7 +196,7 @@ Import the project into the IDE |imageRunConfigJava| - **Add the following in that field:** + **Add the following in the field `VM Options`** .. code-block:: java :caption: **Custom values for properties** @@ -233,10 +244,14 @@ Import the project into the IDE -Dserver.port=55555 - **Browse Working Directory to your application path** ``.../cds/ms/blueprintsprocessor/application`` + **In the field 'Working Directory' browse to your application path** ``.../cds/ms/blueprintsprocessor/application`` **if path is not already specified correctly.** - **Add/replace the following in Blueprint's application-dev.properties file:** + Run configuration should now look something like this: + + |imageRunConfigSetUp| + + **Add/replace the following in Blueprint's application-dev.properties file.** .. code-block:: java @@ -247,10 +262,13 @@ Import the project into the IDE blueprintprocessor.remoteScriptCommand.enabled=true + Take care that if a parameter already exist you need to change the value of the existing parameter to avoid duplicates. + **Run the application:** - Select either run or debug for this Run Configuration to start the Blueprints Processor: + Before running Blueprint Processor check that you use the correct Java version in IntelliJ. + Select either run or debug for the created Run Configuration to start the Blueprints Processor: |imageRunDebug| @@ -360,7 +378,6 @@ Imported packages or annotiations are not found, Run Config not available? Compilation error? ******************* - * Change Java Version to 11 @@ -401,3 +418,7 @@ Compilation error? .. |imageLogsVSC| image:: media/vsc_logs.png :width: 500pt :align: middle + +.. |imageRunConfigSetUp| image:: media/run-config-set-up.png + :width: 500pt + :align: middle |
