diff options
Diffstat (limited to 'docs')
19 files changed, 789 insertions, 162 deletions
diff --git a/docs/architecture/SO Internal Arc.pptx b/docs/architecture/SO Internal Arc.pptx Binary files differindex 3472b92a73..ccb7ee78ce 100644 --- a/docs/architecture/SO Internal Arc.pptx +++ b/docs/architecture/SO Internal Arc.pptx diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst index d59429a366..7cfb276cf7 100644 --- a/docs/architecture/architecture.rst +++ b/docs/architecture/architecture.rst @@ -9,7 +9,7 @@ SO - Architecture SO Functional View ------------------ -.. image:: ../images/SO_Architecture_1.png +.. image:: ../images/SO_Architecture_2.png SO Deployment View -------------------- @@ -110,9 +110,22 @@ SO Sub-Components * Create, Instantiate, Terminate and Delete VNF, including Granting, Subscription and Lifecycle Notifications * Tracking capability which VNFM instance has handled with which VNF instance * BPMN Building Block workflows and Java-based recipes for VNF LCM + * Conformance of SOL001 VNFD and SOL004 VNF package specifications + * Interfacing with the ETSI Catalog Manager (a.k.a. etsicatalog) for retrieving ETSI VNF descriptors and artifacts * VNFM Simulator for validating SO VNFM Adapter NBI and SBI for integration testing - * The SO ETSI CSIT Tests and running them, https://wiki.onap.org/display/DW/SO+ETSI+CSIT - * Testing the SO ETSI Alignment manually (Instantiate VNF using SVNFM), https://wiki.onap.org/pages/viewpage.action?pageId=68524128 + +.. image:: ../images/SO-SOL003-Adapter-Architecture-1.png + +**SO ETSI NFVO** + + Support ETSI NFVO functions which manages Network Service LCM + * Create, Instantiate, Terminate and Delete NS + * Decomposing an NS request into associated VNF request(s) and managing VNF LCM (Create, Instantiate, Terminate, Delete VNF) through SO VNFMN Adapter + * Leveraging SOL005 for its NBI and SOl003 for its SBI + * Conformance of SOL001 NSD and SOL007 NS package specifications + * Interfacing with the ETSI Catalog Manager (a.k.a. etsicatalog) for retrieving ETSI NS descriptors and artifacts + +.. image:: ../images/SO-NFVO-Architecture-1.png Third Party and Open Source --------------------------- diff --git a/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst b/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst index b1ef356c35..3af3dc8dc9 100644 --- a/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst +++ b/docs/developer_info/BPMN-INFRA_Workflow_Understanding.rst @@ -16,8 +16,8 @@ curl -v -H "Content-Type: application/json" -X POST --data @request_body_file_na Request Body: - { - "service":{ + { + "service":{ "name":"SliceService", "description":"SliceService", "serviceInvariantUuid":"dfcd7471-16c7-444e-8268-d4c50d90593a", @@ -62,18 +62,18 @@ curl -v -H "Content-Type: application/json" -X POST --data @request_body_file_na "nstar0_allottedresource0_providing_service_invariant_uuid": "1899e5c1-df4e-43a8-a889-48c157dad7bc" } } - } + } .. code-block:: bash Response body: - { + { "service": { "serviceId": "ebe2d37f-f65b-43d8-8906-f81811ed8f22", "operationId": "ed9b4c84-17db-4874-8896-25324a0401fe" + } } - } Code flows: @@ -120,8 +120,8 @@ Payload will be reaching to bpmn in the form of: .. code-block:: bash - { - "variables": { + { + "variables": { "bpmnRequest": { "value": { "requestDetails": { @@ -305,8 +305,8 @@ Payload will be reaching to bpmn in the form of: "value": false, "type": "Boolean" } - } - } + } + } Based on the serviceUuid which is mentioned in the request body it will call the the CreateCommunicationService.bpmn file and This CreateCommunicationService.bpmn is taken as a example to this workflow Understanding which then call the subprocess of this flow and so on. @@ -349,8 +349,8 @@ Based on the serviceUuid which is mentioned in the request body it will call the .. code-block:: bash - { - "serviceResources": { + { + "serviceResources": { "modelInfo": { "modelName": "CST", "modelUuid": "bfc2775b-64ad-41e5-95fe-d3bc57df6c73", @@ -547,8 +547,8 @@ Based on the serviceUuid which is mentioned in the request body it will call the } ], "serviceAllottedResources": [] - } - } + } + } 5. CreateCommunicationService--> prepareDoComposeE2E() @@ -572,17 +572,17 @@ Based on the serviceUuid which is mentioned in the request body it will call the d. Request body for PUT request to the AAI from bpmn: -{ - "service-instance-name": "SliceService", - "service-role": "communication-service", - "environment-context": "01-70CAA6B", - "created-at": "2020-06-23 05:02:56", - "model-invariant-id": "d4df55ca-c985-46c9-8088-f952181f553e", - "model-version-id": "bfc2775b-64ad-41e5-95fe-d3bc57df6c73", - "orchestration-status": "processing", - "input-parameters": "{ \"service\":{ \"name\":\"SliceService\", \"description\":\"SliceService\", \"serviceInvariantUuid\":\"d4df55ca-c985-46c9-8088-f952181f553e\", \"serviceUuid\":\"bfc2775b-64ad-41e5-95fe-d3bc57df6c73\", \"globalSubscriberId\":\"5GCustomer\", \"serviceType\":\"5G\", \"parameters\":{ \"locationConstraints\":[ ], \"resources\":[ { \"resourceIndex\":\"1\", \"resourceName\":\"allottedResource\", \"resourceInvariantUuid\":\"eeefcd86-7b5b-41ae-9516-08acc5d59d92\", \"resourceUuid\":\"265da937-76c7-4152-98e3-5f0d0a844b7f\", \"resourceCustomizationUuid\":\"a4eda1d9-1af4-424b-997f-12c57b74c67a\", \"parameters\":{ \"locationConstraints\":[ ], \"resources\":[ ], \"requestInputs\":{ } } } ], \"requestInputs\":{\t\t\t \"sST\": \"embb\", \"sNSSAI\": \"1-10101\", \"uEMobilityLevel\": \"stationary\", \"areaTrafficCapDL\": 123, \"maxNumberofUEs\": 1000, \"expDataRateUL\": 2000, \"plmnIdList\": \"39-00|39-01\", \"areaTrafficCapUL\": 456, \"latency\": 300, \"expDataRateDL\": 400, \"coverageAreaTAList\": 101001, \"activityFactor\": 99, \"resourceSharingLevel\": \"shared\", \"nstar0_allottedresource0_providing_service_uuid\": \"4e8d930b-7483-4b9b-8c82-4708638ade4a\", \"nstar0_allottedresource0_providing_service_invariant_uuid\": \"1899e5c1-df4e-43a8-a889-48c157dad7bc\" } } }}" - -} + { + "service-instance-name": "SliceService", + "service-role": "communication-service", + "environment-context": "01-70CAA6B", + "created-at": "2020-06-23 05:02:56", + "model-invariant-id": "d4df55ca-c985-46c9-8088-f952181f553e", + "model-version-id": "bfc2775b-64ad-41e5-95fe-d3bc57df6c73", + "orchestration-status": "processing", + "input-parameters": "{ \"service\":{ \"name\":\"SliceService\", \"description\":\"SliceService\", \"serviceInvariantUuid\":\"d4df55ca-c985-46c9-8088-f952181f553e\", \"serviceUuid\":\"bfc2775b-64ad-41e5-95fe-d3bc57df6c73\", \"globalSubscriberId\":\"5GCustomer\", \"serviceType\":\"5G\", \"parameters\":{ \"locationConstraints\":[ ], \"resources\":[ { \"resourceIndex\":\"1\", \"resourceName\":\"allottedResource\", \"resourceInvariantUuid\":\"eeefcd86-7b5b-41ae-9516-08acc5d59d92\", \"resourceUuid\":\"265da937-76c7-4152-98e3-5f0d0a844b7f\", \"resourceCustomizationUuid\":\"a4eda1d9-1af4-424b-997f-12c57b74c67a\", \"parameters\":{ \"locationConstraints\":[ ], \"resources\":[ ], \"requestInputs\":{ } } } ], \"requestInputs\":{\t\t\t \"sST\": \"embb\", \"sNSSAI\": \"1-10101\", \"uEMobilityLevel\": \"stationary\", \"areaTrafficCapDL\": 123, \"maxNumberofUEs\": 1000, \"expDataRateUL\": 2000, \"plmnIdList\": \"39-00|39-01\", \"areaTrafficCapUL\": 456, \"latency\": 300, \"expDataRateDL\": 400, \"coverageAreaTAList\": 101001, \"activityFactor\": 99, \"resourceSharingLevel\": \"shared\", \"nstar0_allottedresource0_providing_service_uuid\": \"4e8d930b-7483-4b9b-8c82-4708638ade4a\", \"nstar0_allottedresource0_providing_service_invariant_uuid\": \"1899e5c1-df4e-43a8-a889-48c157dad7bc\" } } }}" + + } Response: Response is returned with an empty entity @@ -593,7 +593,7 @@ https://aai.onap:8443/aai/v19/business/customers/customer/5GCustomer/service-sub payload: -{"profile-id":"202a5e9a-d1d7-4afd-922f-3e7a709c780c","max-number-of-UEs":1000,"latency":300,"exp-data-rate-UL":2000,"exp-data-rate-DL":400,"ue-mobility-level":"stationary","resource-sharing-level":"shared"} + {"profile-id":"202a5e9a-d1d7-4afd-922f-3e7a709c780c","max-number-of-UEs":1000,"latency":300,"exp-data-rate-UL":2000,"exp-data-rate-DL":400,"ue-mobility-level":"stationary","resource-sharing-level":"shared"} Response: Response is returned with an empty entity @@ -603,13 +603,13 @@ Response: Response is returned with an empty entity b. Response Body: - { + { "service": { "serviceId":"8a95e3ac-32cd-4ffb-b9e3-5366b393a7a2", "operationId":"a970a804-7ac5-4de9-b6db-17352afbc6fa" - } + } 9. CreateCommunicationService--> generateE2EServiceProfile() @@ -641,11 +641,10 @@ Response: Response is returned with an empty entity b. Request body: - { + { "related-link":"aai/v16/business/customers/customer/5GCustomer/service-subscriptions/service- subscription/5G/service-instances/service-instance/2e6c2d7f-85c0-4b1f-b7fd-5f2364c27ea7" - - } + } 15. CreateCommunicationService--> prepareUpdateOperationStatus() diff --git a/docs/developer_info/CSIT_Macroflow_developer_info.rst b/docs/developer_info/CSIT_Macroflow_developer_info.rst new file mode 100644 index 0000000000..d8c52a4a71 --- /dev/null +++ b/docs/developer_info/CSIT_Macroflow_developer_info.rst @@ -0,0 +1,153 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2022 Huawei Technologies Co., Ltd. + +SO CSIT (Macroflow) +======================== + +Ensure you have a healthy ONAP Deployment running. The following components will be required/used as part of this guide: + +- SO +- SDC +- AAI +- DMAAP +- SDNC +- MultiCloud + +What is Macroflow? +----------------- + +The SO building blocks are a set of database-driven, configurable and generic process steps to be leveraged through several actions defined as 'Macro' flows. For each of the macro flows, there are a set of actions to be performed which are implemented as building blocks - which then implement generic logic to handle the orchestration of services and various type of resources orchestrated by ONAP, as well as their corresponding actions. + +**Macroflow** method allows the user to build and send only one request to instantiate all objects : Service, VNFs, VFModules and Networks. + +How to run CSIT Macroflow? +-------------------------- + +The follow steps are to be installed and run on an Ubuntu 18.04 (desktop) installation. +Later versions of Ubuntu and Java may work for the tests. + +**Prerequisite:** +Install Java 11, Maven, docker, docker-compose + +Following steps need to be followed to run the CSIT Macroflow: + +First pull the CSIT repo from Gerrit, either with or without the hooks + +… code-block:: + + git clone "https://gerrit.onap.org/r/integration/csit" +or + +.. code-block:: + + git clone "https://gerrit.onap.org/r/integration/csit" && (cd "csit" && mkdir -p .git/hooks && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit.onap.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse --git-dir`/hooks/commit-msg) + +Once this is downloaded a few more installations are required. + +Install pip (if required) + +.. code-block:: + + sudo apt install python-pip + +Install Robot Framework through pip + +.. code-block:: + + pip install robotframework + +Run Script + +Once all of this is done, then the tests should be run by calling the run-csit.sh script and giving it the location of our test folder (csit/plans/so/macroflow). + +From the csit projects root folder run the following command: + +.. code-block:: + + ./run-csit.sh plans/so/macroflow + +This should successfully run the CSIT Macroflow + +The run-csit.sh will automatically set up a Robot environment for you, and execute the test plan defined in the plans/so/macroflow directory. + +If you look at the contents of the plans/so/macroflow you will see the following: + +**setup.sh:** the shell script that starts all the necessary docker containers required by this test plan, as well as passing the necessary environment variables to Robot. +**testplan.txt:** the text file listing, in order, the test suites that should be executed by Robot for this particular test plan. This allows you to refactor test suites to be reused by multiple test plans as necessary. +**teardown.sh:** the shell script that kills all the docker containers that were started by this test plan. +**docker-compose.yml:** This lists all the requrired docker. + +How to run tests against specific SO versions +-------------------------------------------- +It is possible to run the CSIT Macroflow suite against local docker images although it is not the default. Through this method specific versions of SO can be tested. + +There are two changes required to make this work. + +1. The env file, located at [containing folder]/csit/plans/so/macroflow/config/env, first needs to be changed. The DOCKER_ENVIROMENT needs to be changed from "remote" to "local". Also the TAG value might need to be changed. This Tag relates to the version of images being used. Make sure the cnf-adapter image version also need to be changed here. + +2. Secondly all of the required docker images must be present on system. + +This should be enough to run the CSIT Macroflow test suite locally. + +CSIT Macroflow Tests High Level Scenarios +--------------------------------------------------- + +**Step 1:** + +Perform Configuration / Setup Steps prior to running tests + +**Step 2:** + +Onoboard the Macroflow Csar Package to complete the distribution from sdc-controller. This will be done by RoboFramework itlself. ASDC saves both heat and helm info into mso catalogdb. + +**Step 3:** + +Once the distribution done, next Instantiation will be executed for Macrolfow. RoboFramework is used to trigger the Instantiation flow. In this case, API handler receives the call and fetches required information from mso catalogdb. + +**Step 4:** + +Bpmn-Infra is called and fetches required information from mso catalogdb and executes all the selected building blocks which will call cnf-adapter or openstack adapter on the basis of usecase whether it is Macroflow Heat or Macroflow Helm. + +**Step 5:** + +Bpmn-Infra also fetches and updates Action infromation to the AAI-Simulator and SDNC-Simulator + +**Step 6:** + +Cnf-Adapter will then call to Multicloud (Multicloud-Simulator) and complete the Execution of Macroflow. + +Follow the diagram in the image below to understand the step + +.. image:: ../images/Architecture_flow.png + +What are the tests doing? +------------------------- +There are three tests currently being run "Distribute Service Template", "Invoke Service Instantiation". + +**Distribute Service Template** + +As the name would suggest the aim for the "Distribute Service Template" test is to distribute a service template within the SDC controller pod. Once a http session of the SDC controller is created a post request can be made to it. This post requests sends binary data from "serviceBasicVfCnfnotification.json" for Macroflow heat and "serviceBasicVfCnfWithHelm.json" for Macroflow helm. These json files contain the information of resources and artifacts required to distribute a service. These json file gather information from the Csar package which resides in the plans/so/macroflow/config/distribution-test-zip directory. Once this post request is sent, the response status code is checked to see if it is 200. If the code is not equal to 200 then the test is thought to be a failure. + +**Invoke Service Instantiation** + +The aim of the "Invoke Service Instantiation" test is to invoke the service distributed to the sdc controller in the previous test. A http session of the api handler pod is created. This session is sent a post request containing "macroflow.json" for Macroflow heat and "MacroflowWithHelm.json" for Macroflow helm. Once these request are made the response is checked if it a valid code is returned. A for loop is used to continually make calls to check the orchestration request for both the request, to check the status of service instantiation. Only once this orchestration returns either a fail or success, will we break out of the for loop. Once outside the for loop a final statement is used to check if service has been successfully instantiated. + +Troubleshooting +--------------- +There are a number of simple issues relating from Python and its libraries + +A correct installation of the robot framework to run our tests requiring python and the following pip libraries. + +- robotframework +- robotframework-extendedselenium2library +- robotframework-httplibrary +- robotframework-onap +- robotframework-requests +- robotframework-selenium2library + +To make sure each of the previous libraries is installed run the following command + +.. code-block:: + + pip -list diff --git a/docs/developer_info/Docker-Config_Understanding.rst b/docs/developer_info/Docker-Config_Understanding.rst index e684c6c480..d62503e1c8 100644 --- a/docs/developer_info/Docker-Config_Understanding.rst +++ b/docs/developer_info/Docker-Config_Understanding.rst @@ -58,132 +58,132 @@ Path:- /docker-config/volumes/so/config/api-handler-infra/onapheat/override.yaml .. code-block:: bash - server: - port: 8080 - tomcat: - max-threads: 50 - ssl-enable: false - - mso: - msoKey: 07a7159d3bf51a0e53be7a8f89699be7 - logPath: logs - site-name: onapheat - adapters: - requestDb: - endpoint: http://request-db-adapter:8083 - auth: Basic YnBlbDpwYXNzd29yZDEk - catalog: - db: - spring: - endpoint: http://catalog-db-adapter:8082 - db: - auth: Basic YnBlbDpwYXNzd29yZDEk - config: - path: /src/main/resources/ - infra: - default: - alacarte: - orchestrationUri: /mso/async/services/ALaCarteOrchestrator - recipeTimeout: 180 - testApi: VNF_API - service: - macro: - default: - testApi: GR_API - camundaURL: http://bpmn-infra:8081 - camundaAuth: AE2E9BE6EF9249085AF98689C4EE087736A5500629A72F35068FFB88813A023581DD6E765071F1C04075B36EA4213A - async: - core-pool-size: 50 - max-pool-size: 50 - queue-capacity: 500 - sdc: - client: - auth: F3473596C526938329DF877495B494DC374D1C4198ED3AD305EA3ADCBBDA1862 - activate: - instanceid: test - userid: cs0008 - endpoint: http://c1.vm1.mso.simpledemo.onap.org:28090 - tenant: - isolation: - retry: - count: 3 - aai: - endpoint: https://aai.api.simpledemo.onap.org:8443 - auth: 2630606608347B7124C244AB0FE34F6F - extApi: - endpoint: http://nbi.onap:8080/nbi/api/v3 - so: - operational-environment: - dmaap: - username: testuser - password: VjR5NDcxSzA= - host: http://c1.vm1.mso.simpledemo.onap.org:28090 - auth: 51EA5414022D7BE536E7516C4D1A6361416921849B72C0D6FC1C7F262FD9F2BBC2AD124190A332D9845A188AD80955567A4F975C84C221EEA8243BFD92FFE6896CDD1EA16ADD34E1E3D47D4A - publisher: - topic: com.att.ecomp.mso.operationalEnvironmentEvent - - spring: - datasource: - hikari: - jdbcUrl: jdbc:mariadb://mariadb:3306/catalogdb - username: cataloguser - password: catalog123 - driver-class-name: org.mariadb.jdbc.Driver - pool-name: catdb-pool - registerMbeans: true - jpa: - show-sql: true - hibernate: - dialect: org.hibernate.dialect.MySQL5Dialect - ddl-auto: validate - naming-strategy: org.hibernate.cfg.ImprovedNamingStrategy - enable-lazy-load-no-trans: true - jersey: - type: filter - - security: - usercredentials: - - - username: sitecontrol - password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' - role: SiteControl-Client - - - username: gui - password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' - role: GUI-Client - - - username: infraportal - password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' - role: InfraPortal-Client - - - username: InfraPortalClient - password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' - role: InfraPortal-Client - - - username: bpel - password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' - role: BPEL-Client - - - username: mso_admin - password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' - role: ACTUATOR - - request: - datasource: - hikari: - jdbcUrl: jdbc:mariadb://mariadb:3306/requestdb - username: requestuser - password: request123 - driver-class-name: org.mariadb.jdbc.Driver - pool-name: reqdb-pool - registerMbeans: true - org: - onap: - so: - cloud-owner: CloudOwner + server: + port: 8080 + tomcat: + max-threads: 50 + ssl-enable: false + + mso: + msoKey: 07a7159d3bf51a0e53be7a8f89699be7 + logPath: logs + site-name: onapheat adapters: - network: - encryptionKey: 07a7159d3bf51a0e53be7a8f89699be7 + requestDb: + endpoint: http://request-db-adapter:8083 + auth: Basic YnBlbDpwYXNzd29yZDEk + catalog: + db: + spring: + endpoint: http://catalog-db-adapter:8082 + db: + auth: Basic YnBlbDpwYXNzd29yZDEk + config: + path: /src/main/resources/ + infra: + default: + alacarte: + orchestrationUri: /mso/async/services/ALaCarteOrchestrator + recipeTimeout: 180 + testApi: VNF_API + service: + macro: + default: + testApi: GR_API + camundaURL: http://bpmn-infra:8081 + camundaAuth: AE2E9BE6EF9249085AF98689C4EE087736A5500629A72F35068FFB88813A023581DD6E765071F1C04075B36EA4213A + async: + core-pool-size: 50 + max-pool-size: 50 + queue-capacity: 500 + sdc: + client: + auth: F3473596C526938329DF877495B494DC374D1C4198ED3AD305EA3ADCBBDA1862 + activate: + instanceid: test + userid: cs0008 + endpoint: http://c1.vm1.mso.simpledemo.onap.org:28090 + tenant: + isolation: + retry: + count: 3 + aai: + endpoint: https://aai.api.simpledemo.onap.org:8443 + auth: 2630606608347B7124C244AB0FE34F6F + extApi: + endpoint: http://nbi.onap:8080/nbi/api/v3 + so: + operational-environment: + dmaap: + username: testuser + password: VjR5NDcxSzA= + host: http://c1.vm1.mso.simpledemo.onap.org:28090 + auth: 51EA5414022D7BE536E7516C4D1A6361416921849B72C0D6FC1C7F262FD9F2BBC2AD124190A332D9845A188AD80955567A4F975C84C221EEA8243BFD92FFE6896CDD1EA16ADD34E1E3D47D4A + publisher: + topic: com.att.ecomp.mso.operationalEnvironmentEvent + + spring: + datasource: + hikari: + jdbcUrl: jdbc:mariadb://mariadb:3306/catalogdb + username: cataloguser + password: catalog123 + driver-class-name: org.mariadb.jdbc.Driver + pool-name: catdb-pool + registerMbeans: true + jpa: + show-sql: true + hibernate: + dialect: org.hibernate.dialect.MySQL5Dialect + ddl-auto: validate + naming-strategy: org.hibernate.cfg.ImprovedNamingStrategy + enable-lazy-load-no-trans: true + jersey: + type: filter + + security: + usercredentials: + - + username: sitecontrol + password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' + role: SiteControl-Client + - + username: gui + password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' + role: GUI-Client + - + username: infraportal + password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' + role: InfraPortal-Client + - + username: InfraPortalClient + password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' + role: InfraPortal-Client + - + username: bpel + password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' + role: BPEL-Client + - + username: mso_admin + password: '$2a$10$Fh9ffgPw2vnmsghsRD3ZauBL1aKXebigbq3BB1RPWtE62UDILsjke' + role: ACTUATOR + + request: + datasource: + hikari: + jdbcUrl: jdbc:mariadb://mariadb:3306/requestdb + username: requestuser + password: request123 + driver-class-name: org.mariadb.jdbc.Driver + pool-name: reqdb-pool + registerMbeans: true + org: + onap: + so: + cloud-owner: CloudOwner + adapters: + network: + encryptionKey: 07a7159d3bf51a0e53be7a8f89699be7 @@ -245,8 +245,8 @@ Example Output: .. code-block:: bash - [ - { + [ + { "Id": "sha256:2573165483e9ac87826da9c08984a9d0e1d93a90c681b22d9b4f90ed579350dc", "RepoTags": [ "onap/so/api-handler-infra:1.3.0-SNAPSHOT", @@ -360,5 +360,5 @@ Example Output: "sha256:2163a1f989859fdb3af6e253b74094e92a0fc1ee59f5eb959971f94eb1f98094" ] } - } - ] + } + ] diff --git a/docs/developer_info/E2E_Network_Slicing_Understanding.rst b/docs/developer_info/E2E_Network_Slicing_Understanding.rst new file mode 100644 index 0000000000..169dd64a79 --- /dev/null +++ b/docs/developer_info/E2E_Network_Slicing_Understanding.rst @@ -0,0 +1,111 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2021 Wipro Ltd. + +E2E Network Slicing +=================== +The objective of this use case is to realize **End-to-End 5G Network +Slicing** using ONAP. An End-to-End Network Slice consists of RAN (Radio +Access Network), Transport Network (TN) and Core Network (CN) slice +sub-nets. This use case intends to demonstrate the modeling, +orchestration (life cycle and resources) and assurance of a network +slice which are implemented in alignment with relevant standards. + +Overall High level view for ONAP-based Slice Management +======================================================= + +Architecture Choice +------------------- + +3GPP(TS 28.801) defines three layer slice management functions which include: + +CSMF(Communication Service Management Function): + +- Responsible for translating the communication service related requirement to network slice related requirements. + +- Communicate with Network Slice Management Function (NSMF). + +NSMF(Network Slice Management Function): + +- Responsible for management and orchestration of NSI. + +- Derive network slice subnet related requirements from network slice related requirements. + +- Communicate with the Network Slice Subnet Management Function (NSSMF) and Communication Service Management Function. + +NSSMF(Network Slice Subnet Management Function): + +- Responsible for management and orchestration of NSSI. + +- Communicate with the NSMF. + +.. image:: ../images/e2e-network-slicing-architecture.png + +To realize the three layers of the slice management function, we need to decide whether to implement CSMF, NSMF or NSMF within ONAP, or use the external CSMF, NSMF or NSSMF. This implies that for ONAP-based network slice management, we have different choices from an architectural perspective: + +1. Implement CSMF, NSMF, NSSMF all within ONAP; + +2. Connect an external CSMF from the Northbound, Implement NSMF and NSSMF within ONAP; + +3. Connect an external CSMF from the Northbound, Implement NSMF within ONAP, Connect a 3rd party NSSMF from the Southbound; + +4. Implement CSMF, NSMF within ONAP, Connect a 3rd party NSSMF from then Southbound. + +5. Use external CSMF and NSMF, only implement NSSMF within ONAP. + +.. image:: ../images/architecture-choices-e2e-slicing.png + +Slice Management Functions - Realization in SO +---------------------------------------------- + +- CSMF and NSMF is realized within ONAP (enhancement in Frankfurt functionality), and the NB interfaces is standardized using ExtAPI. + +- All 3 NSSMFs shall be realized within ONAP (From Guilin). + +- ONAP acting as NSMF shall also interact with external RAN and Transport NSSMF using 3GPP APIs + +- CSMF reliazed within SO receives service requirements from EXT-API, which translates service requirements to slice profile(NST selection) and sends request to NSMF for slice allocation. + +- NSMF reliazed within SO receives request for slice allocation (slice profile, S-NSSAI, NST) and determines slice instantiation/modification (with OOF) to fulfil the slice allocation request. + +- NSSMF reliazed within SO receive information from NSMF & trigger RAN/Core/Transport NSSMF for orchestration actions. + +Network Slice Instance (NSI) Life Cycle View +-------------------------------------------- + +Design and pre-provision: Creation of necessary slice/slice sub-net templates. Creation, activation, deactivation and termination of NSI, including its constituent slice sub-nets (RAN, Core and Transport) + +3GPP Specification (3GPP TS 28.530) describes management aspects of a Network Slice Instance, which can be described by the four phases: + +Preparation: The preparation phase includes network slice design, network slice capacity planning, on-boarding and evaluation of the network functions, preparing the network environment and other necessary preparations required to be done before the creation of an NSI + +Commisioning: NSI provisioning in the commissioning phase includes creation of the NSI. During NSI creation all needed resources are allocated and configured to satisfy the network slice requirements. The creation of an NSI can include creation and/or modification of the NSI constituents + +Operation: The Operation phase includes the activation, supervision, performance reporting (e.g. for KPI monitoring), resource capacity planning, modification,and de-activation of an NSI. + +Decommissioning: Network slice instance provisioning in the decommissioning phase includes decommissioning of non-shared constituents if required and removing the NSI specific configuration from the shared constituents. After the decommissioning phase, the NSI is terminated and does not exist anymore. The ONAP-based NSI lifecycle management will finally provide the demonstration of all these phases. + +The ONAP-based NSI lifecycle management will finally provide the demonstration of all these phases. + +.. image:: ../images/lifecycle-of-network-slice-instance.png + +Support for Option1 &Option2 in E2E Network Slicing +--------------------------------------------------- + +ONAP E2E Network Slicing option 1 and 2 differs on the RAN and FH/BH relationship. + +- In option 1, RAN NSSMF will decide FH/MH requirements and send to TN side, so RAN NSST will nest FH/MH NSST, and slice profile requirements will contain not only RAN side requirements but also FH/MH. + +Template design for option 1: https://wiki.onap.org/display/DW/Template+Design+for+Option+1 + +.. image:: ../images/slicing-option1.png + +- In option 2, FH and MH are independent requirments when doing E2E requirements decomposition. Detailed background of option 1 and 2, please see E2E Network Slicing Use Case in R7 Guilin. + +Template design for option 2: https://wiki.onap.org/display/DW/Template+Design+for+Option2 + +.. image:: ../images/slicing-option2.png + +3 domain combination solution -Endpoint +--------------------------------------- +In order to enable 3 subnet connectivity, making end-to-end forwarding and control plane interacting, in slicing services, we need slicing interworking identifier and information to tell how RAN and Core connect with TN. Slicing interworking identifier(in ONAP is vlan Id, allocated by NSMF) is used to isolate differerent service datas, and identify the unique slicing service across RAN, TN and Core, 1 S-NSSAI will need to be assigned with 1 slicing interworking identifier(vlan Id). The slicing interworking information is used as bridges to connect RAN/Core and TN,it should be RAN/Core side outgress and TN ingress, like port, ipAddress, next hops and etc. diff --git a/docs/developer_info/ETSI_CSIT_NFVO_VNFM.rst b/docs/developer_info/ETSI_CSIT_NFVO_VNFM.rst new file mode 100644 index 0000000000..3bc8393d56 --- /dev/null +++ b/docs/developer_info/ETSI_CSIT_NFVO_VNFM.rst @@ -0,0 +1,227 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2022 Ericsson Software Technologies + +SO ETSI CSIT (NFVO and VNFM) +============================ +This guide will go through the CSIT of the ETSI NFVO and VNFM. + +Ensure you have a healthy ONAP Deployment running. The following components will be required/used as part of this guide: + +- SO +- SDC +- AAI +- DMAAP +- Modeling + +What is ETSI? +------------- +The European Telecommunications Standards Institute (ETSI) produces globally-applicable standards +for Information and Communications Technologies. ETSI set out standards covering the functionalities +of the interfaces specified on the reference points, which use the acronym NFV-SOL +(standing for “NFV Solutions”). As of ONAPs Dublin release the SO SVNFM adapter supports +SOL003 standards for Create, Instantiate, Terminate and Delete operations with Granting, Subscription +and Notification. As of ONAP Honolulu release, the SO ETSI NFVO sub-component supports +SOL005 (NBI) and SOL003 (SBI) standards for Create, Instantiate, Terminate and Delete NS and VNF +(through the SOL003 Adapter) operations. + +How to Run CSIT Tests +--------------------- +The follow steps are to install and run on an Ubuntu 18.04 (desktop) installation. +Later versions of Ubuntu and Java may work for the tests. + +First pull the CSIT repo from Gerrit, either with or without the hooks + +.. code-block:: + + git clone "https://gerrit.onap.org/r/integration/csit" + +or + +.. code-block:: + + git clone "https://gerrit.onap.org/r/integration/csit" && (cd "csit" && mkdir -p .git/hooks && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit.onap.org/r/tools/hooks/commit-msg; chmod +x `git rev-parse --git-dir`/hooks/commit-msg) + +Once this is downloaded a few more installations are required. + +Install pip (if required) + +.. code-block:: + + sudo apt install python-pip + +Install Robot Framework through pip + +.. code-block:: + + pip install robotframework + +Run Script + +Once all of this is done, then the tests should be run by calling the run-csit.sh script and giving it the location of our test folder (csit/plans/so/integration-etsi-testing). +From the csit projects root folder run the following command: + +.. code-block:: + + ./run-csit.sh plans/so/integration-etsi-testing + +This should successfully run the ETSI CSIT suite + +How to run tests againt specific SO versions +-------------------------------------------- +It is possible to run the ETSI CSIT suite against local docker images although it is not the default. +Through this method specific versions of SO can be tested. +There are two changes required to make this work. +The env file, located at [containing folder]/csit/plans/so/integration-etsi-testing/config/env, +first needs to be changed. The DOCKER_ENVIROMENT needs to be changed from "remote" to "local". +Also the TAG value might need to be changed. This Tag relates to the version of images being used. + +Secondly all of the required docker images must be present on system. + +This should be enough to run the ETSI CSIT test suite locally. + +ETSI NFVO Automated CSIT Tests High Level Scenarios +--------------------------------------------------- +**Step 1:** + +Perform Configuration / Setup Steps prior to running tests + +**Step 2:** + +Onboard SOL004 Package and SOL007 directly into ETSI Catalog using ROBOT framework + +**Step 3:** + +ETSI Catalog Gets Package from SDC Simulator (New: ETSI Catalog and Modeling ETSI Catalog DB will need to be set up and spun up for CSIT. May be some impact on SDC Simulator here) + +**Step 4:** + +ETSI Catalog Stores Package in its Modeling ETSI Catalog DB + +**Step 5:** + +ROBOT framework used to trigger NS LCM requests, e.g., INSTANTIATE NS + +**Step 6:** + +ETSI NFVO NS LCM gets required data from ETSI Catalog, e.g., Get and Parse NSD + +**Step 7:** + +If e.g., a CREATE NS task, ETSI NFVO NS LCM checks to see if already exists in ETSI NFVO DB + +**Step 8:** + +Create Generic VNF and connect to Service Instance in A&AI Simulator (May be some impact on A&AI Simulator here) + +**Step 9:** + +Instantiate VNF through SOL003 Adapter + +**Step 10:** + +SOL003 Adapter processes requests through A&AI and (May be some impact on A&AI Simulator here) + +**Step 11:** + +SOL003 Adapter processes requests through ETSI-Catalog + +**Step 12:** + +SOL003 Adapter sends notification to SOL003 NBI, etc. + +What are the tests doing? +------------------------- +There are three tests currently being run "Distribute Service Template", "Invoke Service Instantiation", +"Invoke NS Instantiation", "Delete NS Instance", "Invoke VNF Instantiation", "Delete VNF Instance" and +"Delete Service Instance". + +Distribute Service Template + +As the name would suggest the aim for the "Distribute Service Template" test is to distribute a service +template within the SDC controller pod. Once a http session of the SDC controller is created a post request +can be made to it. This post requests sends binary data from "distributeServiceTemplate.json". +This json file contains resources and artifacts required to distribute a service. Once this post request +is sent, the response status code is checked to see if it is 200. If the code is not equal to 200 then +the test is thought to be a failure. + +Invoke Service Instantiation + +The aim of the "Invoke Service Instantiation" test is to invoke the service distributed to the sdc controller +in the previous test. A http session of the api handler pod is created. This session is sent a post request +containing "serviceInstantiationRequest.json". Once this request is made the response is checked if it +a valid code is returned. A for loop is used to continually make calls to check the orchestration request, +to check the status of service instantiation. Only once this orchestration returns either a fail or success, +will we break out of the for loop.Once outside the for loop a final statement is used to check if service +has been successfully instantiated. + +Invoke NS Instance + +The aim of "Invoke NS Instantiation" test is to now instantiate the NS that relates to service in the +previous test. This test requires the ID of the service instance created in the previous test. If this is +not provided then the test will fail from the get go. Once again a http session of the api handler pod is +created. Similarly a post request using the json data within "nsInstantiationRequest.json". +Once this request is made if it returns a success code then the test moves on to a for loop. Within this +for a loop an orchestration request is made each time, when this request signals that either the instantiation +request has failed or fully succeeded then the loop is escaped. The test will either be a pass or fail depending +on this final orchestration request. + +Delete NS Instance + +This test will delete the NS Instance created in the previous test. Both the ID of the NS instance created +in the previous test and the service instance created in the test before that. If either of these values is +not provided then the test will fail. This test once again makes use of a session of the api handler pod. +A post request is made using the data from "nsDeleteRequest.json". Once this request is made if it returns +a success code then the test moves on to a for loop. Within this for a loop an orchestration request is made +each time, when this request signals that either the instantiation request has failed or fully succeeded +then the loop is escaped. The test will either be a pass or fail depending on this final orchestration request. + +Invoke VNF Instance + +The aim of "Invoke VNF Instantiation" test is to now instantiate the VNF that relates to service in +the previous test. This test requires the ID of the service instance created in the previous test. +If this is not provided then the test will fail from the get go. Once again a http session of the +api handler pod is created. Similarly a post request using the json data within "vnfInstantiationRequest.json". +Once this request is made if it returns a success code then the test moves on to a for loop. Within this +for a loop an orchestration request is made each time, when this request signals that either the instantiation +request has failed or fully succeeded then the loop is escaped. The test will either be a pass or fail +depending on this final orchestration request. + +Delete VNF Instance + +This test will delete the VNF Instance created in the previous test. Both the ID of the vnf instance created +in the previous test and the service instance created in the test before that. If either of these values is +not provided then the test will fail. This test once again makes use of a session of the api handler pod. +A post request is made using the data from "vnfDeleteRequest.json". Once this request is made if it returns +a success code then the test moves on to a for loop. Within this for a loop an orchestration request is made +each time, when this request signals that either the instantiation request has failed or fully succeeded then +the loop is escaped. The test will either be a pass or fail depending on this final orchestration request. + +Delete Service Instance + +This test will delete the service instance created in earlier test. To delete the service the ID of previously + created Service Instance is required, if this is not supplied then the test will fail before starting. + A post request is then made to the API handler containing data from "serviceDeleteRquest.json". + Once this request is made if it returns a success code then the test moves on to a for loop. + Within this for a loop an orchestration request is made each time, when this request signals that either + the instantiation request has failed or fully succeeded then the loop is escaped. The test will either be + a pass or fail depending on this final orchestration request. + +Troubleshooting +--------------- +There are a number of simple issues relating from Python and its libraries + +A correct installation of the robot framework to run our tests requiring python and the following pip libraries. + +- robotframework +- robotframework-extendedselenium2library +- robotframework-httplibrary +- robotframework-onap +- robotframework-requests +- robotframework-selenium2library + +To make sure each of the previous libraries is installed run the following command + +.. code-block:: + + pip -list
\ No newline at end of file diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst index e174133d6f..11b515248a 100644 --- a/docs/developer_info/developer_information.rst +++ b/docs/developer_info/developer_information.rst @@ -15,6 +15,7 @@ SO Developer Information Camunda_Cockpit_Community_Edition.rst Camunda_Cockpit_Enterprise_Edition.rst Camunda_Modeler.rst + CSIT_Macroflow_developer_info.rst BPMN_Project_Structure.rst BPMN_Main_Process_Flows.rst BPMN_Subprocess_Process_Flows.rst diff --git a/docs/images/Architecture_flow.png b/docs/images/Architecture_flow.png Binary files differnew file mode 100644 index 0000000000..112192560d --- /dev/null +++ b/docs/images/Architecture_flow.png diff --git a/docs/images/SO-NFVO-Architecture-1.png b/docs/images/SO-NFVO-Architecture-1.png Binary files differnew file mode 100644 index 0000000000..dd04a7b2e4 --- /dev/null +++ b/docs/images/SO-NFVO-Architecture-1.png diff --git a/docs/images/SO-SOL003-Adapter-Architecture-1.png b/docs/images/SO-SOL003-Adapter-Architecture-1.png Binary files differnew file mode 100644 index 0000000000..932d5d1bcd --- /dev/null +++ b/docs/images/SO-SOL003-Adapter-Architecture-1.png diff --git a/docs/images/SO_Architecture_2.png b/docs/images/SO_Architecture_2.png Binary files differnew file mode 100644 index 0000000000..45ffd953e6 --- /dev/null +++ b/docs/images/SO_Architecture_2.png diff --git a/docs/images/architecture-choices-e2e-slicing.png b/docs/images/architecture-choices-e2e-slicing.png Binary files differnew file mode 100644 index 0000000000..b240215017 --- /dev/null +++ b/docs/images/architecture-choices-e2e-slicing.png diff --git a/docs/images/e2e-network-slicing-architecture.png b/docs/images/e2e-network-slicing-architecture.png Binary files differnew file mode 100644 index 0000000000..922419d0a8 --- /dev/null +++ b/docs/images/e2e-network-slicing-architecture.png diff --git a/docs/images/lifecycle-of-network-slice-instance.png b/docs/images/lifecycle-of-network-slice-instance.png Binary files differnew file mode 100644 index 0000000000..0959783b89 --- /dev/null +++ b/docs/images/lifecycle-of-network-slice-instance.png diff --git a/docs/images/slicing-option1.png b/docs/images/slicing-option1.png Binary files differnew file mode 100644 index 0000000000..e19a257828 --- /dev/null +++ b/docs/images/slicing-option1.png diff --git a/docs/images/slicing-option2.png b/docs/images/slicing-option2.png Binary files differnew file mode 100644 index 0000000000..945c7c5612 --- /dev/null +++ b/docs/images/slicing-option2.png diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 58902f3d27..4299041911 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -14,6 +14,127 @@ The SO provides the highest level of service orchestration in the ONAP architect Release Notes ============= +Version: 1.10.0 +============== + + :Release Date: 2022-04-08 + +SO Release Image Versions +-------------------------- + - so-bpmn-infra + + :Version: 1.10.0 + + - so-catalog-db-adapter + + :Version: 1.10.0 + + - so-admin-cockpit + + :Version: 1.8.3 + + - so-nssmf-adapter + + :Version: 1.9.1 + + - so-openstack-adapter + + :Version: 1.10.0 + + - so-request-db-adapter + + :Version: 1.10.0 + + - so-sdc-controller + + :Version: 1.10.0 + + - so-sdnc-adapter + + :Version: 1.10.0 + + - so-sol003-adapter + + :Version: 1.8.2 + + - so-api-handler + + :Version: 1.10.0 + + - so-etsi-nfvo-ns-lcm + + :Version: 1.8.2 + + - so-oof-adapter + + :Version: 1.8.3 + + - so-cnf-adapter + + :Version: 1.10.0 + +Release Purpose +---------------- +SO Jakarta Release. +The key deliverable for this release is refactoring SO for better internal architecture. + + +**Epics** + +* `REQ-890 <https://jira.onap.org/browse/REQ-890>`_ - ONAP CNF orchestration - Jakarta Enhancements +* `REQ-1041 <https://jira.onap.org/browse/REQ-1041>`_ - VNF LCM Support in SO +* `SO-3802 <https://jira.onap.org/browse/SO-3802>`_ - Global Requirements Approval +* `SO-3826 <https://jira.onap.org/browse/SO-3826>`_ - SO impacts for E2E Network Slicing in Jakarta Release + +**Stories** + +The full list of implemented tasks is available on `JIRA Jakarta STORY <https://jira.onap.org/browse/SO-3748?jql=project%20%3D%20%22Service%20Orchestrator%22%20%20AND%20issuetype%20%3D%20story%20AND%20fixVersion%20%3D%20%22Jakarta%20Release%22>`_ + + +**Tasks** + +The full list of implemented tasks is available on `JIRA Jakarta TASKS <https://jira.onap.org/browse/SO-3930?jql=project%20%3D%20%22Service%20Orchestrator%22%20%20AND%20issuetype%20%3D%20Task%20AND%20fixVersion%20%3D%20%22Jakarta%20Release%22>`_ + +**Bug Fixes** + +The full list of fixed bugs is available on `JIRA Jakarta BUGS +<https://jira.onap.org/browse/SO-3908?jql=project%20%3D%20%22Service%20Orchestrator%22%20%20AND%20issuetype%20%3D%20Bug%20AND%20fixVersion%20%3D%20%22jakarta%20Release%22>`_ + +Security Notes +-------------- + +*Fixed Security Issues* + +* `SO-3735 <https://jira.onap.org/browse/SO-3735>`_ +* `SO-3825 <https://jira.onap.org/browse/SO-3825>`_ +* `SO-3846 <https://jira.onap.org/browse/SO-3846>`_ + + +Quick Links: + +- `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`__ +- `Passing Badge information for SDC <https://bestpractices.coreinfrastructure.org/en/projects/1702>`__ + +**Known Issues** + +* `SO-3237 <https://jira.onap.org/browse/SO-3237>`_ - Exposed HTTP port. +* `SO-3745 <https://jira.onap.org/browse/SO-3745>`_ - SO images contain 1 GPLv3 lib + +**Upgrade Notes** + + N/A + +**Deprecation Notes** + + SO modules Ve-Vnfm-adapter and appc-orchestrator are deprectaed since istanbul release. + +**Other** + + N/A +*************************************************************************************** + + + Version: 1.9.2 ============== diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 74a3b7a3fd..3b3441a807 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1 +1,3 @@ lfdocs-conf +sphinx>=4.2.0 # BSD +sphinx-rtd-theme>=1.0.0 # MIT |
