lifecycle_state: 'Incubation'
project_category: ''
project_lead: &onap_doc_ptl
- name: 'Sofia Wallin'
- email: 'sofia.wallin@est.tech'
- id: 'sofiawallin'
- company: 'Ericsson Software Technology'
- timezone: 'Europe/Stockholm'
+ name: 'Thomas Kulik'
+ email: 'thomas.kulik@telekom.de'
+ id: 'thmsdt'
+ company: 'Deutsche Telekom'
+ timezone: 'Europe/Berlin'
primary_contact: *onap_doc_ptl
issue_tracking:
type: 'jira'
email: 'andreas-geissler@telekom.de'
company: 'Deutsche Telekom'
id: 'andreasgeissler'
- timezone: 'Germany/Cologne'
+ timezone: 'Germany/Berlin'
+ - name: 'Thomas Kulik'
+ email: 'thomas.kulik@telekom.de'
+ company: 'Deutsche Telekom'
+ id: 'thmsdt'
+ timezone: 'Germany/Berlin'
tsc:
approval: 'https://lists.onap.org/pipermail/onap-tsc'
changes:
intersphinx_mapping = {}
-intersphinx_mapping['onap-oom-offline-installer'] = (
- '{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-music-distributed-kv-store'] = (
- '{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-holmes-engine-management'] = (
- '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-modeling-toscaparsers'] = (
- '{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None)
+# Latest (change to branch)
+intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = (
'{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = (
- '{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = (
- '{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = (
- '{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-holmes-engine-management'] = (
+ '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-holmes-rule-management'] = (
'{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-oom-platform-cert-service'] = (
'{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-platform-plugins'] = (
- '{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-distribution-client'] = (
- '{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-policy-clamp'] = ('{}/onap-policy-clamp/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-clamp'] = ('{}/onap-clamp/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None)
+
+# Guilin
+branch = 'guilin'
+intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None)
+
+# Frankfurt
+branch = 'frankfurt'
+intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None)
+
+# Latest
+branch = 'latest'
+intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-ccsdk-platform-plugins'] = (
+ '{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = (
+ '{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-modeling-toscaparsers'] = (
+ '{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None)
-
+intersphinx_mapping['onap-music-distributed-kv-store'] = (
+ '{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-sdc-sdc-distribution-client'] = (
+ '{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = (
+ '{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = (
+ '{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None)
linkcheck_ignore = [
'http://localhost',
project: onap
# Change this to ReleaseBranchName to modify the header
-default-version: frankfurt
+default-version: latest
#
:maxdepth: 1
:titlesonly:
-* :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:master_index>`
+* :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:master_index>`
* :ref:`Portal<onap-portal:offeredapis>`
* :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
* :ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>`
* :ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>`
* :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>`
* :ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>`
+* :ref:`CPS - Configuration Persistence Service<onap-cps:design>`
* :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>`
* :ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>`
* :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>`
Figure 2 below, provides a simplified functional view of the architecture,
which highlights the role of a few key components:
-#. Design time environment for onboarding services and resources into ONAP and
- designing required services.
-#. External API provides northbound interoperability for the ONAP Platform and
- Multi-VIM/Cloud provides cloud interoperability for the ONAP workloads.
+#. ONAP Design time environment provides onboarding services and resources
+ into ONAP and designing required services.
+#. External API provides northbound interoperability for the ONAP Platform.
+#. ONAP Runtime environment provides a model- and policy-driven orchestration
+ and conrol framework for an automated instantiation and configuration of
+ services and resources. Multi-VIM/Cloud provides cloud interoperability for
+ the ONAP workloads. Analytic framework that closely monitors the service
+ behavior handles close loop management for handling healing, scaling and
+ update dynamically.
#. OOM provides the ability to manage cloud-native installation and deployments
to Kubernetes-managed cloud environments.
#. ONAP Shared Services provides shared capabilities for ONAP modules. The ONAP
Optimization Framework (OOF) provides a declarative, policy-driven approach
for creating and running optimization applications like Homing/Placement,
- and Change Management Scheduling Optimization.
-#. ONAP shared utilities provide utilities for the support of the ONAP
- components.
-#. Information Model and framework utilities continue to evolve to harmonize
- the topology, workflow, and policy models from a number of SDOs including
- ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF,
- and MEF.
+ and Change Management Scheduling Optimization. ONAP shared utilities provide
+ utilities for the support of the ONAP components.
+
+Information Model and framework utilities continue to evolve to harmonize
+the topology, workflow, and policy models from a number of SDOs including
+ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF,
+and MEF.
|image2|
Shared Services
===============
ONAP provides a set of operational services for all ONAP components including
-activity logging, reporting, common data layer, access control, secret and
-credential management, resiliency, and software lifecycle management.
+activity logging, reporting, common data layer, configuration, persistence, access control,
+secret and credential management, resiliency, and software lifecycle management.
These services provide access management and security enforcement, data backup,
-restoration and recovery. They support standardized VNF interfaces and
-guidelines.
+configuration persistence, restoration and recovery. They support standardized
+VNF interfaces and guidelines.
Operating in a virtualized environment introduces new security challenges and
opportunities. ONAP provides increased security by embedding access controls in
each ONAP platform component, augmented by analytics and policy components
specifically designed for the detection and mitigation of security violations.
+Configuration Persistence Service (CPS)
+---------------------------------------
+The Configuration Persistence Service (CPS) provides storage for real-time run-time configuration
+and operational parameters that need to be used by ONAP.
+In R8, Honolulu, the CPS is a stand-alone component, and its details in
+:ref:`CPS - Configuration Persistence Service<onap-cps:architecture>`.
+
ONAP Modeling
=============
ONAP provides models to assist with service design, the development of ONAP
:titlesonly:
| :ref:`APPC CDT Application Controller Design Tool<onap-appc:appc_lcm_api_guide>`
-| :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:architecture>`
+| :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:architecture>`
| :ref:`CLI - Command Line Interface<onap-cli:architecture>`
| :ref:`PORTAL<onap-portal:architecture>`
| :ref:`SDC - Service Design and Creation<onap-sdc:architecture>`
| :ref:`AAF - Application Authorization Framework<onap-aaf-authz:master_index>`
| :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:architecture>`
| :ref:`AAI ESR<onap-aai-esr-gui:architecture>`
+| :ref:`CPS - Configuration Persistence Service<onap-cps:architecture>`
| :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:architecture>`
| :ref:`ExtAPI - External API NBI<onap-externalapi-nbi:architecture>`
| :ref:`Logging Framework -<onap-logging-analytics:logging_user_guide>`
* - Document
- Description
- * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_
- - AAF Architecture, APIs and Guides
+ * - :ref:`AAF (Latest)<onap-aaf-authz:master_index>`
+ - (unmaintained) AAF Architecture, APIs and Guides
AAI - Active and Available Inventory
------------------------------------
- Description
* - :ref:`AAI<onap-aai-aai-common:master_index>`
- AAI Architecture, APIs and Guides
- * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_
- - External System Registry GUI Documentation
- * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
- - External System Registry Server Documentation
- * - (in Maintenance) :ref:`AAI UI<onap-aai-sparky-be:master_index>`
+ * - :ref:`ESR GUI (Latest)<onap-aai-esr-gui:master_index>`
+ - (unmaintained) External System Registry GUI Documentation
+ * - :ref:`ESR Server (Latest)<onap-aai-esr-server:master_index>`
+ - (unmaintained) External System Registry Server Documentation
+ * - :ref:`AAI UI<onap-aai-sparky-be:master_index>`
- Sparky - AAI Inventory UI Documentation
APPC - Application Controller
* - Document
- Description
- * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_
- - APPC Architecture, APIs and Guides
- * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_
- - APPC Deployment Documentation
+ * - :ref:`APPC (Frankfurt)<onap-appc:master_index>`
+ - (unmaintained) APPC Architecture, APIs and Guides
+ * - :ref:`APPC Deployment (Frankfurt)<onap-appc-deployment:master_index>`
+ - (unmaintained) APPC Deployment Documentation
CCSDK - Common Controller Software Development Kit
--------------------------------------------------
* - Document
- Description
- * - :ref:`CLAMP <onap-clamp:master_index>`
+ * - :ref:`CLAMP <onap-policy-clamp:master_index>`
- CLAMP Architecture and Guides
CLI - Command Line Interface
* - :ref:`CLI <onap-cli:master_index>`
- CLI Documentation
+CPS - Configuration Persistence Service
+---------------------------------------
+
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - :ref:`CPS <onap-cps:master_index>`
+ - CPS Documentation
+
DCAE - Data Collection, Analysis and Events
-------------------------------------------
* - :ref:`DCAE<onap-dcaegen2:master_index>`
- DCAE Architecture and Guides
-DMAAP - Data Management as a Platform
--------------------------------------
+DMAAP - Data Movement as a Platform
+-----------------------------------
.. list-table::
:widths: 20 80
* - Document
- Description
- * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
- - ONAP Centralized Logging Documentation
+ * - :ref:`LOGGING (Latest)<onap-logging-analytics:master_index>`
+ - (unmaintained) ONAP Centralized Logging Documentation
MSB - Microservices Bus
-----------------------
* - Document
- Description
- * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_
- - MUSIC Architecture and Guides
- * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_
- - MUSIC Distribute KV Store Documents
+ * - :ref:`MUSIC (Frankfurt)<onap-music:master_index>`
+ - (unmaintained) MUSIC Architecture and Guides
+ * - :ref:`MUSIC KV (Latest)<onap-music-distributed-kv-store:master_index>`
+ - (unmaintained) MUSIC Distribute KV Store Documents
OOF - Optimization Framework
----------------------------
- ONAP Operations Manager Documentation
* - :ref:`OOM Certification Service<onap-oom-platform-cert-service:master_index>`
- ONAP CMPv2 certification support
+ * - :ref:`OOM Offline Installer<onap-oom-offline-installer:master_index>`
+ - OOM Offline Installer
+
ORAN - Open-RAN Support in ONAP
-------------------------------
* - Document
- Description
- * - :ref:`Portal<onap-portal:master_index>`
- - ONAP Portal Platform Documentation
+ * - :ref:`Portal (Guilin)<onap-portal:master_index>`
+ - (unmaintained) ONAP Portal Platform Documentation
SDC - Service Design & Creation
-------------------------------
+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0
-.. International License. http://creativecommons.org/licenses/by/4.0
-
-Addendum
-========
-
-Index File
-----------
-
-The index file must relatively reference your other rst files in that directory.
-
-Here is an example index.rst :
-
-.. code-block:: bash
-
- *******************
- Documentation Title
- *******************
-
- .. toctree::
- :numbered:
- :maxdepth: 2
-
- documentation-example
-
-Source Files
-------------
-
-Document source files have to be written in reStructuredText format (rst).
-Each file would be built as an html page.
-
-Here is an example source rst file :
-
-.. code-block:: bash
-
- =============
- Chapter Title
- =============
-
- Section Title
- =============
-
- Subsection Title
- ----------------
-
- Hello!
-
-Writing RST Markdown
---------------------
-
-See http://sphinx-doc.org/rest.html .
-
-**Hint:**
-You can add html content that only appears in html output by using the
-'only' directive with build type
-('html' and 'singlehtml') for an ONAP document. But, this is not encouraged.
-
-.. code-block:: bash
-
- .. only:: html
- This line will be shown only in html version.
-
-
-Creating Indices
-----------------
-
-Building an index for your Sphinx project is relatively simple. First, tell Sphinx that
-you want it to build an index by adding something like this after your TOC tree:
-
-.. code-block:: rst
-
- Indices and Search
- ==================
-
- * :ref:`genindex`
- * :ref:`search`
-
-**Hint:**
-Note that search was included here. It works out of the box with any Sphinx project, so you
-don't need to do anything except include a reference to it in your :code:`index.rst` file.
-
-Now, to generate a index entry in your RST, do one of the following:
-
-.. code-block:: rst
-
- Some content that requires an :index:`index`.
-
-or
-
-.. code-block:: rst
-
- .. index::
- single: myterm
-
- Some header containing myterm
- =============================
-
-In the second case, Sphinx will create a link in the index to the paragraph that follows
-the index entry declaration.
-
-When your project is built, Sphinx will generate an index page populated with the entries
-you created in the source RST.
-
-These are simple cases with simple options. For more information about indexing with Sphinx,
-please see the `official Sphinx documentation <http://www.sphinx-doc.org/en/stable/markup/misc.html>`_.
-
-
-Jenkins Jobs
-------------
-
-Verify Job
-++++++++++
-
-The verify job name is **doc-{stream}-verify-rtd**
-
-Proposed changes in files in any repository with top level docs folder
-in the repository and RST files in below this folder
-will be verified by this job as part of a gerrit code review.
-
-.. Important::
- The contributing author and every reviewer on a gerrit code review
- should always review the Jenkins log before approving and merging a
- change. The log review should include:
-
- * Using a browser or other editor to search for a pattern in the
- *console log* that matches files in the patch set. This will quickly
- identify errors and warnings that are related to the patch set and
- repository being changed.
-
- * Using a browser to click on the *html* folder included in the log
- and preview how the proposed changes will look when published at
- Read The Docs. Small changes can be easily made in the patch set.
-
-Merge Job
-+++++++++
-
-The merge job name is **doc-{stream}-merge-rtd**.
-
-When a committer merges a patch that includes files matching the
-path described above, the doc project merge job will trigger an
-update at readthedocs. There may be some delay after the merge job
-completes until new version appears at Read The Docs.
-
-Read The Docs URLs
-------------------
-
-When referencing versions of documentation a Read The Docs the following
-URL conventions should be used
-
- +----------------------------------+----------------------------------------+
- | URL | To Refer to |
- +==================================+========================================+
- | docs.onap.org | Most recent approved named release |
- +----------------------------------+----------------------------------------+
- | docs.onap.org/en/latest | Latest master branch all projects |
- +----------------------------------+----------------------------------------+
- | docs.onap.org/en/*named release* | An approved name release eg. amsterdam |
- +----------------------------------+----------------------------------------+
api-swagger-guide
templates
converting-to-rst
- addendum
.. toctree::
:hidden:
When there are subsequent, significant contributions to a source file
from a different contributor, a new copyright line may be appended
after the last existing copyright line.
+
+Read The Docs URLs
+------------------
+
+When referencing versions of documentation a Read The Docs the following
+URL conventions should be used
+
+ +----------------------------------+----------------------------------------+
+ | URL | To Refer to |
+ +==================================+========================================+
+ | docs.onap.org | Most recent approved named release |
+ +----------------------------------+----------------------------------------+
+ | docs.onap.org/en/latest | Latest master branch all projects |
+ +----------------------------------+----------------------------------------+
+ | docs.onap.org/en/*named release* | An approved name release eg. amsterdam |
+ +----------------------------------+----------------------------------------+
the labels with the project name to help share the label space, e.g.,
``sfc-user-guide`` instead of just ``user-guide``.
+Index File
+----------
+
+The index file must relatively reference your other rst files in that directory.
+
+Here is an example index.rst :
+
+.. code-block:: bash
+
+ *******************
+ Documentation Title
+ *******************
+
+ .. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ documentation-example
+
+Source Files
+------------
+
+Document source files have to be written in reStructuredText format (rst).
+Each file would be built as an html page.
+
+Here is an example source rst file :
+
+.. code-block:: bash
+
+ =============
+ Chapter Title
+ =============
+
+ Section Title
+ =============
+
+ Subsection Title
+ ----------------
+
+ Hello!
+
+Writing RST Markdown
+--------------------
+
+See http://sphinx-doc.org/rest.html .
+
+**Hint:**
+You can add html content that only appears in html output by using the
+'only' directive with build type
+('html' and 'singlehtml') for an ONAP document. But, this is not encouraged.
+
+.. code-block:: bash
+
+ .. only:: html
+ This line will be shown only in html version.
+
+
+Creating Indices
+----------------
+
+Building an index for your Sphinx project is relatively simple. First, tell Sphinx that
+you want it to build an index by adding something like this after your TOC tree:
+
+.. code-block:: rst
+
+ Indices and Search
+ ==================
+
+ * :ref:`genindex`
+ * :ref:`search`
+
+**Hint:**
+Note that search was included here. It works out of the box with any Sphinx project, so you
+don't need to do anything except include a reference to it in your :code:`index.rst` file.
+
+Now, to generate a index entry in your RST, do one of the following:
+
+.. code-block:: rst
+
+ Some content that requires an :index:`index`.
+
+or
+
+.. code-block:: rst
+
+ .. index::
+ single: myterm
+
+ Some header containing myterm
+ =============================
+
+In the second case, Sphinx will create a link in the index to the paragraph that follows
+the index entry declaration.
+
+When your project is built, Sphinx will generate an index page populated with the entries
+you created in the source RST.
+
+These are simple cases with simple options. For more information about indexing with Sphinx,
+please see the `official Sphinx documentation <http://www.sphinx-doc.org/en/stable/markup/misc.html>`_.
+
+
+Jenkins Jobs
+------------
+
+Verify Job
+++++++++++
+
+The verify job name is **doc-{stream}-verify-rtd**
+
+Proposed changes in files in any repository with top level docs folder
+in the repository and RST files in below this folder
+will be verified by this job as part of a gerrit code review.
+
+.. Important::
+ The contributing author and every reviewer on a gerrit code review
+ should always review the Jenkins log before approving and merging a
+ change. The log review should include:
+
+ * Using a browser or other editor to search for a pattern in the
+ *console log* that matches files in the patch set. This will quickly
+ identify errors and warnings that are related to the patch set and
+ repository being changed.
+
+ * Using a browser to click on the *html* folder included in the log
+ and preview how the proposed changes will look when published at
+ Read The Docs. Small changes can be easily made in the patch set.
+
+Merge Job
++++++++++
+
+The merge job name is **doc-{stream}-merge-rtd**.
+
+When a committer merges a patch that includes files matching the
+path described above, the doc project merge job will trigger an
+update at readthedocs. There may be some delay after the merge job
+completes until new version appears at Read The Docs.
+
Testing
=======
::
- kubectl -n onap delete onap-so-so-bpmn-infra-79fdf6f9d5-t8qr4
+ kubectl -n onap delete po onap-so-so-bpmn-infra-79fdf6f9d5-t8qr4
Then, wait for the pod to restart. To check:
.. This work is licensed under a Creative Commons Attribution 4.0
.. International License. http://creativecommons.org/licenses/by/4.0
-.. Copyright © 2017-2020 Aarna Networks, Inc.
+.. Copyright 2017-2020 Aarna Networks, Inc.
.. Links
.. Github web page to download the latest version of velero open source tool
Backup and Restore Solution
###########################
+.. warning::
+ This description is not covering the Backup & Restore procedure of the full
+ ONAP platform, but gives examples for the usage of Velero.
+ The ONAP community will focus on Disaster Recovery including B&R
+ in the coming releases.
+
+
Problem Statement and Requirement (User Story)
==============================================
Using Schedules and Restore-Only Mode
-If you periodically back up your cluster’s resources, you are able to return to a previous state in case of some unexpected mishap, such as a service outage.
+If you periodically back up your cluster resources, you are able to return to a previous state in case of some unexpected mishap, such as a service outage.
Cluster migration
~~~~~~~~~~~~~~~~~
onap_backup_restore.rst
-.. note::
- Refer to the wiki page for further details:
- `Legacy Backup and Restore Solution <https://wiki.onap.org/display/DW/Backup+and+Restore+Solution%3A+ONAP-OOM>`_
-
ONAP Multisite Deployment
-------------------------
.. Modifications Copyright 2018 Amdocs
.. Modifications Copyright 2018 Huawei
.. Modifications Copyright 2019 Orange
+.. Modifications Copyright 2021 Nokia
Setting Up ONAP
===============
:ref:`ONAP on HA Kubernetes Cluster<onap-oom:onap-on-kubernetes-with-rancher>`
+Some ONAP functionalities require optional PaaS components described here:
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+:ref:`ONAP PaaS set-up (optional)<onap-oom:oom_setup_paas>`
+
ONAP installation is described here:
.. toctree::
- :ref:`VNF LifeCycle Command templating<onap-appc:master_index>`
- :ref:`Workflow Design<onap-sdc:workflow>`
- :ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>`
-- :ref:`Control Loop Automation Management<onap-clamp:master_index>`
+- :ref:`Control Loop Automation Management<onap-policy-clamp:master_index>`
.. |image1| image:: media/Design-Overview.png
vFW Design Tutorial <./vfw-design-tutorial/index.rst>
vFW Deployment Tutorial <./vfw-deployment-tutorial/index.rst>
vFWCL Design Tutorial <./vfwcl-design-tutorial/index.rst>
+ vFWCL Deployment Tutorial <./vfwcl-deployment-tutorial/index.rst>
Verified Use Cases
------------------
ONAP will collect and assign all required parameters/values by itself.
- .. Note:: **Macro** method is not (yet) available via ONAP VID
- nor via extAPI/NBI
+.. Note::
+ VID supports the "macro" flow orchestration in a ModernUI, which can be enabled by the system operator.
+
+ **Macro** method is not (yet) available via extAPI/NBI.
With "A La Carte" method
------------------------
.. toctree::
:maxdepth: 1
- using ONAP VID Portal <../vid/index.rst>
+ using ONAP VID Portal <../vid1/index.rst>
using ONAP NBI REST API (TM Forum) <../nbi/index.rst>
using ONAP SO REST API <../so1/index.rst>
.. toctree::
:maxdepth: 1
+ using ONAP VID Portal <../vid2/index.rst>
using ONAP SO REST API <../so2/index.rst>
:maxdepth: 1
:titlesonly:
-:ref:`vidgit docs instantiaterst<onap-vid:instantiate>`
+:ref:`Instantiate Service, VNF, VF modules and Network<onap-vid:instantiate>`
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2019 ONAP Contributors. All rights reserved.
+
+
+Macro mode Service Instantiation via ONAP VID Portal
+=========================================================
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+:ref:`Instantiate Service, “Macro” mode (PNF example)<onap-vid:instantiatemacro>`
.. toctree::
:maxdepth: 1
- using ONAP VID Portal <../vid/index.rst>
+ using ONAP VID Portal <../vid1/index.rst>
using ONAP SO REST API <../so1/index.rst>
With "Macro" method
.. toctree::
:maxdepth: 1
- using ONAP VID Portal <../vid/index.rst>
+ using ONAP VID Portal <../vid1/index.rst>
using ONAP SO REST API <../so1/index.rst>
With "Macro" method
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright © 2017-2021 Aarna Networks, Inc.
+
+vFWCL deployment Tutorial
+#########################
+
+Introduction
+============
+
+This tutorial describes the step by step instructions on how to achieve the control loop for vFW use case. Instructions in this tutorial will enable you to deploy the vfw control loop specific usecase.
+
+vFW service components
+~~~~~~~~~~~~~~~~~~~~~~
+
+The vFW service is composed of the following components
+
+vPKG VNF
+
+- It is a packet generator which sends periodically different volumes of traffic to the sink through the firewall (vFw)
+
+vFWSNK VNF
+
+- Firewall: Reports the volume of traffic passing through to the DCAE collector (VES collector). The vFW has no real firewalling functionality.
+- Traffic sink: Provides a graphical representation (bar charts) showing the volume of incoming traffic.
+
+The below block diagram shows about the components part of vFW usecase
+
+|image25|
+
+vFWCL service overview
+~~~~~~~~~~~~~~~~~~~~~~
+
+The vFW contol loop use case consists in applying policy rules that aim to re-adjust the traffic volume
+when high threshold (700 packets/10s) or low threshold (300 packets/10s) are crossed. In fact, the DCAE collects
+events from the vFW, applies analytics (Threshold Crossing Analytics: TCA microservice) and publishes events to DMaap.
+When detecting the triggering event, the policy engine executes the operational policy via the APP-C that modifies
+vPKG application configurations in order to adjust the traffic volume to 500 packet per 10 seconds.
+
+The vFW control loop is based on VES (VNF Event Stream) reported measurements that TCA analyses and publishes
+related alams to DMaap. The policy has the responsibility for triggering ModifyConfig action that APPC executes
+on the target vnf (vPKG). All closed loop interactions are relying on the Message router (DMaap) by publishing
+topics and subscribing to them.
+
+The ladder diagram below describes the components and their interactions that take place while running the vFWCL
+
+|image53|
+
+Prerequisite:
+vFW service design and deployment should be completed before following the steps of this tutorial
+
+Refer the below tutorials for doing vFW service design and deployment
+
+.. toctree::
+ :maxdepth: 1
+
+ vFW Design Tutorial <../vfw-design-tutorial/index.rst>
+ vFW Deployment Tutorial <../vfw-deployment-tutorial/index.rst>
+
+Adding DCAE artifacts and policies
+==================================
+
+Follow the below steps to upload the blueprint for the TCA (Threshold Checking Application) DCAE microservice
+and Distribute the service to the CLAMP
+
+1. Login as DESIGNER (cs0008) and create the service, checkin and certify
+
+|image16|
+
+2. Add any VNF (ex: vfw_pg) that was already created during the SDC design phase
+
+In the composition canvas drag and drop a resource of type VF from the abstract section in the Elements section (left hand side panel)
+
+|image15|
+
+3. Download the required DCAE MS blueprint to be attached to the service
+
+Use the sample TCA blueprint located here:
+https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-tcagen2-clampnode.yaml
+
+.. note::
+ * Check if the version of the plugin used in the blueprint is different from existing, then update the blueprint import to match
+ * To check the version run this: `cfy plugins list | grep k8splugin`
+
+4. Now upload the Control Loop Artifact. The procedure to upload the artifact is
+
+ * Click on the VF, as in the picture above the ‘vsp_pg 0’ is selected
+ * Click on ‘DEPLOYMENT ARTIFACTS’ and then click on “Add Artifact”
+
+ |image5|
+
+ * Fill the details and in the type select DCAE_INVENTORY_BLUEPRINT, then click on Done as in the picture shown below
+
+ |image13|
+
+5. After uploading the DCAE artifact to the SDC Service, attach the policy model to the Service. From the left drop down,
+select TCA policy under Policies, and click on the Add policy
+
+|image1|
+
+6. Click on Checkin on top right corner then click OK
+
+|image12|
+
+7. Search and select the same service from CATALOG and click on Certify on top right corner
+
+|image14|
+
+8. Click Distribute to distribute the service, then click on Distribution in the left hand side panel and monitor until
+the distribution is complete. We should see artifacts deployed in CLAMP and Policy engine, as can be seen in the picture below
+
+|image19|
+
+At this point we can open the CLAMP GUI and verify that the DCAE microservice design template is in place
+
+Deploy DCAE and Policy through CLAMP
+====================================
+
+CLAMP is a GUI tool which enables the users to design the policies, distribute them to the DROOLS engine and eventually deploy
+the DCAE microservices.
+
+1. Add the necessary certificates in the browser to login to the CLAMP GUI
+
+The default certificate can be found here: https://gerrit.onap.org/r/gitweb?p=clamp.git;a=blob;f=src/main/resources/clds/aaf/org.onap.clamp.p12;h=268aa1a3ce56e01448f8043cc0b05b5fceb5a47d;hb=HEAD
+
+The password is: "China in the Spring"
+The certificate must be loaded into your favorite browser before trying to load the CLAMP UI.
+
+2. After the certificate is added, the CLAMP GUI can be accessed at:
+`https://<host_IP>:30258` (host_IP is the node IP where CLAMP is running)
+
+3. Before designing the policy we need to undeploy the default tca policy.
+To undeploy default policy execute the below commands on control node
+
+.. code-block::
+
+ > kubectl get deployments -n onap | grep "dep-dcae-tca-analytics\|dcaegen2-analytics-tca" | awk '{print $1}' |
+ xargs kubectl delete deployments -n onap
+ > kubectl get svc -n onap | grep "dcae-tca-analytics\|dcaegen2-analytics-tca" | awk '{print $1}' |
+ xargs kubectl delete svc -n onap
+ To Verify there are no dcae-analytics POD, run the below command
+ > kubectl get pods -n onap | grep 'analytics'
+
+4. If the service has been distributed correctly, following is how the service design templates
+listed in the Loop Templates as below
+
+|image7|
+
+Available Policy Models
+
+|image10|
+
+5. Create the loop from the templates distributed by SDC
+
+|image4|
+
+|image20|
+
+6. Add the Operational Policy
+Click on Loop Instance drop down and select Modify then click, select the policy model type then click Add
+
+|image9|
+
+|image3|
+
+7. Click on the MS application box and configure
+Fill the details in the pop up window and click on the save changes button.
+
+ A. Click on app and Edit the Policy details, fill the below details
+
+ * eventName: vFirewallBroadcastPackets
+ * policyScope: DCAE
+ * policyVersion: v0.0.1
+ * Select controlLoopSchemaType as VM
+ * policyName: DCAE.Config_tca-hi-lo
+ * Select Pdp Group Info from the drop down as defaultGroup & xacm
+
+ |image17|
+
+ B. Click on the Add monitoring threshold1 button and fill the below details
+
+ * version : 1.0.2
+ * closedLoopControlName : name of the CL (ex: LOOP_TEMPLATE_mytest_srv_v1_0_vsp_pg0_k8s-tca)
+ * select the direction from dropdown (ex: LESS)
+
+ |image11|
+
+ C. Click on the Add monitoring threshold2 button and fill the details same as above then click on Save Changes button
+
+ |image24|
+
+8. Click on the Operational policy box and configure
+Fill the details in the pop window then click on save changes
+
+|image22|
+
+|image18|
+
+9. Submit the control loop to the policy
+From Loop Operations drop down select SUBMIT and click
+
+|image23|
+
+10. Deploy the control loop to DCAE
+From Loop Operations drop down select DEPLOY and click, verify the details and click Deploy
+
+|image2|
+
+|image8|
+
+Status Logs
+
+|image21|
+
+A successful deployment will make the service as DEPLOYED
+
+11. You can login into the control node and verify whether your new analytics application got deployed using below command
+
+.. code-block::
+
+ > kubectl get pods -n onap | grep analytics
+ Sample output
+ dep-dcae-tca-analytics-7fccbf459-xkxlq 2/2 Running 0 6m15s
+
+ > cfy deployment list | grep CLAMP
+ Sample output
+ | CLAMP_615bb47a-ea3e-4a02-8928-0564df900826 | CLAMP_615bb47a-ea3e-4a02-8928-0564df900826 | 2020-11-10 19:23:22.286 |
+ 2020-11-10 19:23:22.286 | tenant | default_tenant | admin |
+
+Robot heatbridge
+================
+
+Run the Robot heatbridge script to populate the vserver (OAM IP, VM flavor name, ID etc.) related information in AAI.
+This is required by APPC/SDNC for performing LCM operations.
+
+Following is the command usage along with the example
+
+./demo-k8s.sh <namespace> heatbridge <stack_name> <service_instance_id> <service> <oam-ip-address>
+
+.. note::
+ The stack_name & oam-ip-address of the VNF VM can be obtained from OpenStack Horizon and service_instance_id from the VID screen
+
+.. code-block::
+
+ ./demo-k8s.sh onap heatbridge vfw_sinc_vf e039b3d4-7ee5-4ad2-8108-ae31086ac7c0 vFW 172.29.249.157
+ Number of parameters:
+ 6
+ KEY:
+ heatbridge
+ ++ kubectl --namespace onap get pods
+ ++ sed 's/ .*//'
+ ++ grep robot
+ + POD=dev-robot-58f85bb64d-zz5bh
+ ++ dirname ./demo-k8s.sh
+ + DIR=.
+ + SCRIPTDIR=scripts/demoscript
+ + ETEHOME=/var/opt/ONAP
+ + '[' ']'
+ ++ kubectl --namespace onap exec dev-robot-58f85bb64d-zz5bh -- bash -c 'ls -1q /share/logs/ | wc -l'
+ + export GLOBAL_BUILD_NUMBER=13
+ + GLOBAL_BUILD_NUMBER=13
+ ++ printf %04d 13
+ + OUTPUT_FOLDER=0013_demo_heatbridge
+ + DISPLAY_NUM=103
+ + VARIABLEFILES='-V /share/config/robot_properties.py'
+ + kubectl --namespace onap exec dev-robot-58f85bb64d-zz5bh -- /var/opt/ONAP/runTags.sh -V /share/config/robot_properties.py -v HB_STACK:vfw_sinc_vf
+ -v HB_VNF:e039b3d4-7ee5-4ad2-8108-ae31086ac7c0 -v HB_VNF:vFW -v HB_SERVICE:vFW -v HB_IPV4_OAM_ADDRESS:172.29.249.157 -d /share/logs/0013_demo_heatbridge
+ -i heatbridge --display 103
+ Starting Xvfb on display :103 with res 1280x1024x24
+ Executing robot tests at log level TRACE
+ ==============================================================================
+ Testsuites
+ ==============================================================================
+ Testsuites.Demo :: Executes the VNF Orchestration Test cases including setu...
+ ==============================================================================
+ Run Heatbridge :: Try to run heatbridge | PASS |
+ ------------------------------------------------------------------------------
+ Testsuites.Demo :: Executes the VNF Orchestration Test cases inclu... | PASS |
+ 1 critical test, 1 passed, 0 failed
+ 1 test total, 1 passed, 0 failed
+ ==============================================================================
+ Testsuites | PASS |
+ 1 critical test, 1 passed, 0 failed
+ 1 test total, 1 passed, 0 failed
+ ==============================================================================
+ Output: /share/logs/0013_demo_heatbridge/output.xml
+ Log: /share/logs/0013_demo_heatbridge/log.html
+ Report: /share/logs/0013_demo_heatbridge/report.html
+
+Update the operational policy
+=============================
+
+1. GET the modelInvariantID of vPG
+
+Following is the command usage along with the sample output
+
+.. code-block::
+
+ curl -k -X GET https://<kubernetes-host>:30233/aai/v11/network/generic-vnfs/ -H 'Accept: application/json' -H 'Authorization: Basic QUFJOkFBSQ==' -H ' Content-Type: application/json' -H 'X-FromAppId: Postman' -H 'X-TransactionId: get_generic_vnf' | jq
+
+ {
+ "generic-vnf": [
+ {
+ "vnf-id": "edc085e8-5088-4b73-bcdc-b8b0bf5e528b",
+ "vnf-name": "vfw_vpg_vnf",
+ "vnf-type": "vFWCL_service/vsp_vpg 0",
+ "service-id": "929190d1-fed1-4dff-883f-f0ede779065e",
+ "prov-status": "PREPROV",
+ "orchestration-status": "Created",
+ "in-maint": false,
+ "is-closed-loop-disabled": false,
+ "resource-version": "1609783281808",
+ "model-invariant-id": "7d4fef5e-f9b0-4e03-a653-712d6630f389",
+ "model-version-id": "a248f68e-c1f2-4b25-8120-c4f7310b0d1e",
+ "model-customization-id": "cf0019db-f51f-472a-996d-9da19d41f7b4",
+ "relationship-list": {
+ "relationship": [
+ {
+ "related-to": "service-instance",
+ "related-link": "/aai/v11/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vFWCL/service-instances/service- instance/e039b3d4-7ee5-4ad2-8108-ae31086ac7c0",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vFWCL"
+ },
+ {
+ "relationship-key": "service-instance.service-instance-id",
+ "relationship-value": "e039b3d4-7ee5-4ad2-8108-ae31086ac7c0"
+ }
+ ],
+ "related-to-property": [
+ {
+ "property-key": "service-instance.service-instance-name",
+ "property-value": "vFWCL_srv_00"
+ }
+ ]
+ },
+ {
+ "related-to": "platform",
+ "related-link": "/aai/v11/business/platforms/platform/Platform-Demonstration",
+ "relationship-data": [
+ {
+ "relationship-key": "platform.platform-name",
+ "relationship-value": "Platform-Demonstration"
+ }
+ ]
+ },
+ {
+ "related-to": "line-of-business",
+ "related-link": "/aai/v11/business/lines-of-business/line-of-business/LOB-Demonstration",
+ "relationship-data": [
+ {
+ "relationship-key": "line-of-business.line-of-business-name",
+ "relationship-value": "LOB-Demonstration"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "vnf-id": "816040b6-d9bf-43ba-b852-e31e21a0a5f4",
+ "vnf-name": "vfw_sinc_vnf",
+ "vnf-type": "vFWCL_service/vsp_sinc 0",
+ "service-id": "929190d1-fed1-4dff-883f-f0ede779065e",
+ "prov-status": "ACTIVE",
+ "orchestration-status": "Active",
+ "in-maint": false,
+ "is-closed-loop-disabled": false,
+ "resource-version": "1609788164862",
+ "model-invariant-id": "4d432903-4338-48ae-a105-47c0c8d19193",
+ "model-version-id": "86b98636-150b-4f1c-a768-61e6c43a3199",
+ "model-customization-id": "d3671119-5b65-40ed-abea-d1fe0d09c3ba",
+ "relationship-list": {
+ "relationship": [
+ {
+ "related-to": "vserver",
+ "related-link": "/aai/v11/cloud-infrastructure/cloud-regions/cloud- region/CloudOwner/RegionOne/tenants/tenant/747a01548b494670892413c496c1c250/vservers/vserver/3353a853-87cc-47cc-9e6a-4f45b6dc580f",
+ "relationship-data": [
+ {
+ "relationship-key": "cloud-region.cloud-owner",
+ "relationship-value": "CloudOwner"
+ },
+ {
+ "relationship-key": "cloud-region.cloud-region-id",
+ "relationship-value": "RegionOne"
+ },
+ {
+ "relationship-key": "tenant.tenant-id",
+ "relationship-value": "747a01548b494670892413c496c1c250"
+ },
+ {
+ "relationship-key": "vserver.vserver-id",
+ "relationship-value": "3353a853-87cc-47cc-9e6a-4f45b6dc580f"
+ }
+ ],
+ "related-to-property": [
+ {
+ "property-key": "vserver.vserver-name",
+ "property-value": "zdfw1fwl01snk01"
+ }
+ ]
+ },
+ {
+ "related-to": "vserver",
+ "related-link": "/aai/v11/cloud-infrastructure/cloud-regions/cloud- region/CloudOwner/RegionOne/tenants/tenant/747a01548b494670892413c496c1c250/vservers/vserver/642b5709-4f3d-405b-bcb2-dc82884cb8de",
+ "relationship-data": [
+ {
+ "relationship-key": "cloud-region.cloud-owner",
+ "relationship-value": "CloudOwner"
+ },
+ {
+ "relationship-key": "cloud-region.cloud-region-id",
+ "relationship-value": "RegionOne"
+ },
+ {
+ "relationship-key": "tenant.tenant-id",
+ "relationship-value": "747a01548b494670892413c496c1c250"
+ },
+ {
+ "relationship-key": "vserver.vserver-id",
+ "relationship-value": "642b5709-4f3d-405b-bcb2-dc82884cb8de"
+ }
+ ],
+ "related-to-property": [
+ {
+ "property-key": "vserver.vserver-name",
+ "property-value": "zdfw1fwl01fwl01"
+ }
+ ]
+ },
+ {
+ "related-to": "service-instance",
+ "related-link": "/aai/v11/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vFWCL/service-instances/service- instance/e039b3d4-7ee5-4ad2-8108-ae31086ac7c0",
+ "relationship-data": [
+ {
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ },
+ {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vFWCL"
+ },
+ {
+ "relationship-key": "service-instance.service-instance-id",
+ "relationship-value": "e039b3d4-7ee5-4ad2-8108-ae31086ac7c0"
+ }
+ ],
+ "related-to-property": [
+ {
+ "property-key": "service-instance.service-instance-name",
+ "property-value": "vFWCL_srv_00"
+ }
+ ]
+ },
+ {
+ "related-to": "platform",
+ "related-link": "/aai/v11/business/platforms/platform/Platform-Demonstration",
+ "relationship-data": [
+ {
+ "relationship-key": "platform.platform-name",
+ "relationship-value": "Platform-Demonstration"
+ }
+ ]
+ },
+ {
+ "related-to": "line-of-business",
+ "related-link": "/aai/v11/business/lines-of-business/line-of-business/LOB-Demonstration",
+ "relationship-data": [
+ {
+ "relationship-key": "line-of-business.line-of-business-name",
+ "relationship-value": "LOB-Demonstration"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+
+2. Get the Operational policy name and version
+
+Following is the command usage and the sample output
+
+.. code-block::
+
+ curl -k -u 'healthcheck:zb!XztG34' -X GET -H 'Accept:application/json' https://<kubernetes-host>:6969/policy/pap/v1/pdps
+
+ #sample command and output
+ curl -k -u 'healthcheck:zb!XztG34' -X GET -H 'Accept:application/json' https://10.43.244.213:6969/policy/pap/v1/pdps | jq
+ % Total % Received % Xferd Average Speed Time Time Time Current
+ Dload Upload Total Spent Left Speed
+ 100 2678 100 2678 0 0 7695 0 --:--:-- --:--:-- --:--:-- 7695
+ {
+ "groups": [
+ {
+ "name": "defaultGroup",
+ "description": "The default group that registers all supported policy types and pdps.",
+ "pdpGroupState": "ACTIVE",
+ "properties": {},
+ "pdpSubgroups": [
+ {
+ "pdpType": "apex",
+ "supportedPolicyTypes": [
+ {
+ "name": "onap.policies.controlloop.operational.Apex",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.controlloop.operational.common.Apex",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.native.Apex",
+ "version": "1.0.0"
+ }
+ ],
+ "policies": [],
+ "currentInstanceCount": 1,
+ "desiredInstanceCount": 1,
+ "properties": {},
+ "pdpInstances": [
+ {
+ "instanceId": "dev-policy-apex-pdp-0",
+ "pdpState": "ACTIVE",
+ "healthy": "HEALTHY",
+ "message": "Pdp Heartbeat"
+ }
+ ]
+ },
+ {
+ "pdpType": "drools",
+ "supportedPolicyTypes": [
+ {
+ "name": "onap.policies.controlloop.Operational",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.controlloop.operational.common.Drools",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.native.drools.Controller",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.native.drools.Artifact",
+ "version": "1.0.0"
+ }
+ ],
+ "policies": [],
+ "currentInstanceCount": 1,
+ "desiredInstanceCount": 1,
+ "properties": {},
+ "pdpInstances": [
+ {
+ "instanceId": "dev-drools-0",
+ "pdpState": "ACTIVE",
+ "healthy": "HEALTHY"
+ }
+ ]
+ },
+ {
+ "pdpType": "xacml",
+ "supportedPolicyTypes": [
+ {
+ "name": "onap.policies.controlloop.guard.common.FrequencyLimiter",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.controlloop.guard.common.MinMax",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.controlloop.guard.common.Blacklist",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.controlloop.guard.coordination.FirstBlocksSecond",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.monitoring.*",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.*",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.resource.AffinityPolicy",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.resource.DistancePolicy",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.resource.HpaPolicy",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.resource.OptimizationPolicy",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.resource.PciPolicy",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.service.QueryPolicy",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.service.SubscriberPolicy",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.resource.Vim_fit",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.optimization.resource.VnfPolicy",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.native.Xacml",
+ "version": "1.0.0"
+ },
+ {
+ "name": "onap.policies.Naming",
+ "version": "1.0.0"
+ }
+ ],
+ "policies": [
+ {
+ "name": "SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP",
+ "version": "1.0.0"
+ }
+ ],
+ "currentInstanceCount": 1,
+ "desiredInstanceCount": 1,
+ "properties": {},
+ "pdpInstances": [
+ {
+ "instanceId": "dev-policy-xacml-pdp-6c5f6db887-zkh6h",
+ "pdpState": "ACTIVE",
+ "healthy": "HEALTHY"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+
+3. Remove the vFW Policy from PDP
+
+Following is the command usage
+
+.. code-block::
+
+ POLICY_ID = "OPERATIONAL_dcae_service_v1_0_Drools_1_0_0_of6"
+ POLICY_VERSION = "1.0.0"
+
+ curl -k -u 'healthcheck:zb!XztG34' -X DELETE -H 'Content-Type:application/json' https://<kubernetes-host>:6969/policy/pap/v1/pdps/policies/$POLICY_ID/versions/$POLICY_VERSION
+
+4. Get latest policy
+
+Following is the command usage and sample output
+
+.. code-block::
+
+ POLICY_TYPEID="onap.policies.controlloop.operational.common.Drools"
+ VERSIONID='1.0.0'
+ POLICY_ID="OPERATIONAL_dcae_service_v1_0_Drools_1_0_0_of6"
+
+ curl -k -u 'healthcheck:zb!XztG34' -X GET -H 'Accept:application/json' https://<kubernetes-host>:6969/policy/api/v1/policytypes/$POLICY_TYPEID/versions/$VERSIONID/policies/$POLICY_ID/versions/latest > operational_policy_template.json
+
+5. Update this policy in the policy DB
+
+Following is the command usage and sample output
+
+.. code-block::
+
+ POLICY_TYPEID="onap.policies.controlloop.operational.common.Drools"
+ VERSIONID='1.0.0'
+
+ curl -k -u 'healthcheck:zb!XztG34' -X POST -H 'Content-Type:application/json' --data @./operational_policy_template.json https://<kubernetes-host>:6969/policy/api/v1/policytypes/$POLICY_TYPEID/versions/$VERSIONID/policies
+
+ {
+ "tosca_definitions_version": "tosca_simple_yaml_1_1_0",
+ "topology_template": {
+ "policies": [{
+ "OPERATIONAL_dcae_service_v1_0_Drools_1_0_0_of6": {
+ "type": "onap.policies.controlloop.operational.common.Drools",
+ "type_version": "1.0.0",
+ "properties": {
+ "abatement": true,
+ "operations": [{
+ "failure_retries": "final_failure_retries",
+ "id": "ModifyConfig",
+ "failure_timeout": "final_failure_timeout",
+ "failure": "final_failure",
+ "operation": {
+ "payload": {
+ "active-streams": 5
+ },
+ "target": {
+ "entityIds": {
+ "resourceID": "7d4fef5e-f9b0-4e03-a653-712d6630f389"
+ },
+ "targetType": "VNF"
+ },
+ "actor": "APPC",
+ "operation": "ModifyConfig"
+ },
+ "failure_guard": "final_failure_guard",
+ "retries": 3,
+ "timeout": 3600,
+ "failure_exception": "final_failure_exception",
+ "description": "ModifyConfig",
+ "success": "final_success"
+ }],
+ "trigger": "ModifyConfig",
+ "timeout": 3600,
+ "id": "LOOP_tca"
+ },
+ "name": "OPERATIONAL_dcae_service_v1_0_Drools_1_0_0_of6",
+ "version": "1.0.0",
+ "metadata": {
+ "policy-id": "OPERATIONAL_dcae_service_v1_0_Drools_1_0_0_of6",
+ "policy-version": "1.0.0"
+ }
+ }
+ }]
+ },
+ "name": "ToscaServiceTemplateSimple",
+ "version": "1.0.0",
+ "metadata": {}
+ }
+
+6. Deploy this version of the policy using PAP API
+
+Prepare the payload for the deployment API by naming the file as pap_template.json. The contents are policy name, version and command usage as below
+
+.. code-block::
+
+ cat pap_template.json
+ {
+ "policies" : [
+ {
+ "policy-id": "OPERATIONAL_dcae_service_v1_0_Drools_1_0_0_of6",
+ "policy-version": "3"
+ }
+ ]
+ }
+
+ curl -k -u 'healthcheck:zb!XztG34' -X POST --data @./pap_template.json -H 'Content-Type:application/json' https://<kubernetes-host>:6969/policy/pap/v1/pdps/policies
+
+Set network topology for vPG in APPC
+====================================
+
+1. Enable direct access to vFW PG VNF instance from control node
+
+.. note::
+ These steps are applicable only when your openstack instance is running on the GCP
+
+ You can refer to `Google Cloud Docs <https://cloud.google.com/vpc/docs/configure-alias-ip-ranges>`_ to find
+ more details about how to add IP alias to a running GCP instance
+
+Execute the below commands from your laptop using gcloud CLI
+
+a. Find the Default interface name and primary internal IP for the GCP instance
+
+.. code-block::
+
+ gcloud compute instances describe openstack-01 | grep 'nic\|networkIP'
+
+ #sample command output
+ name: nic0
+ networkIP: 10.128.0.43
+
+b. For the Default interface nic0 add an IP alias from the default subnet
+
+.. code-block::
+
+ gcloud compute instances network-interfaces update openstack-01 \
+ --zone us-central1-f \
+ --network-interface nic0 \
+ --aliases "/30"
+
+ # sample output
+ Updating network interface [nic0] of instance [openstack-01]...done
+
+c. Verify if the instance has got a new IP alias
+
+.. code-block::
+
+ gcloud compute instances describe openstack-01 | grep 'nic\|networkIP\|aliasIpRanges\|ipCidrRange'
+
+ # from the output note down the IP alias ipCidrRange attribute that you will need it inplace
+ aliasIpRanges:
+ ipCidrRange: 10.128.0.124/30
+ name: nic0
+ networkIP: 10.128.0.22
+
+2. Map openstack-01 GCP IP alias to vFW PG VNF openstack instance public IP
+
+a. SSH into GCP openstack-01 VM instance and verify if you can see the new IP alias in the routing table
+
+.. code-block::
+
+ ip route show table local | grep '/30'
+
+ # sample output
+ local 10.128.0.112/30 dev eth0 proto 66 scope host
+
+b. Find the vFW packet generator public / external network IP address
+
+Run the below command on the openstack instance
+
+.. code-block::
+
+ openstack server list
+ # sample output
+ | ID | Name | Status | Networks | Image | Flavor |
+ | 1faa6593-7e9e-452d-a5dc-1536e18e4b94 | zdfw1fwl01pgn01 | ACTIVE | OAM_NETWORK=10.10.10.12; public=172.29.249.200;
+ zdfw1fwl01_unprotected=192.168.10.200| trusty | m1.medium |
+
+c. Now update openstack-01 GCP instance iptables to forward the traffic to vFW PG VNF VM
+
+Below are the commands to forward all traffic reaching to IP alias (ex: 10.128.0.112/30)
+to vFW PG VNF VM (ex:zdfw1fwl01pgn01) instance public IP (ex:172.29.249.200)
+
+.. code-block::
+
+ # DNAT rule update
+ sudo iptables -t nat -I PREROUTING -d 10.128.0.112 -j DNAT --to-destination 172.29.249.200
+ sudo iptables -t nat -I POSTROUTING -s 172.29.249.200 -j MASQUERADE
+
+ # Update INPUT, FORWARD AND OUTPUT chain to allow traffic for all ports
+ sudo iptables -I INPUT 1 -p udp -j ACCEPT
+ sudo iptables -I FORWARD 1 -p tcp -j ACCEPT
+ sudo iptables -I OUTPUT 1 -p tcp -j ACCEPT
+ sudo iptables -I OUTPUT 1 -p udp -j ACCEPT
+
+d. Verify if you can access vFW PG instance from the control node
+
+SSH into vFW PG VNF instance using the openstack-01 GCP IP alias, it should connect to the vFW PG VNF instance
+
+3. Mount APPC
+
+a. Get the VNF instance ID, either through VID or through AAI. Below the AAI request
+
+Search for the vnf-name as vfw_pg_vsp_002-1 from the output of the below command and find the corresponding vnf-id,
+the value is: a1ca05b4-3231-4e4a-a09c-74f2292fe577
+
+.. code-block::
+
+ curl -X GET https://<kubernetes-host>:30233/aai/v8/network/generic-vnfs/ -H 'Accept: application/json' -H 'Authorization: Basic QUFJOkFBSQ==' -H 'Content-Type:application/json' -H 'X-FromAppId: Postman' -H 'X-TransactionId: get_generic_vnf' -k
+
+ {
+ "generic-vnf": [{
+ "vnf-id": "a1ca05b4-3231-4e4a-a09c-74f2292fe577",
+ "vnf-name": "vfw_pg_vsp_002-1",
+ "vnf-type": "vfw-service-002/vfw_pg_vsp_002 0",
+ "service-id": "f18af052-6dfb-40e8-ad25-f060eb898f53",
+ "prov-status": "ACTIVE",
+ "orchestration-status": "Active",
+ "in-maint": false,
+ "is-closed-loop-disabled": false,
+ "resource-version": "1617776160138",
+ "model-invariant-id": "7a347a5a-8f3f-416c-81f3-13b30631c1e6",
+ "model-version-id": "f988048a-b4f4-4f5e-aa7c-fdaa0d7ea017",
+ "model-customization-id": "601d5d68-fbbe-4c1f-a624-08a3445ae8fe",
+ "relationship-list": {
+ "relationship": [{
+ "related-to": "service-instance",
+ "relationship-label": "org.onap.relationships.inventory.ComposedOf",
+ "related-link": "/aai/v16/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vFW/service-instances/service-instance/6f294c8f-ac67-4b33-9e56-014fb63791a5",
+ "relationship-data": [{
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ }, {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vFW"
+ }, {
+ "relationship-key": "service-instance.service-instance-id",
+ "relationship-value": "6f294c8f-ac67-4b33-9e56-014fb63791a5"
+ }],
+ "related-to-property": [{
+ "property-key": "service-instance.service-instance-name",
+ "property-value": "vfw-service-002-1"
+ }]
+ }, {
+ "related-to": "platform",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v16/business/platforms/platform/Platform-Demonstration",
+ "relationship-data": [{
+ "relationship-key": "platform.platform-name",
+ "relationship-value": "Platform-Demonstration"
+ }]
+ }, {
+ "related-to": "line-of-business",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v16/business/lines-of-business/line-of-business/LOB-Demonstration",
+ "relationship-data": [{
+ "relationship-key": "line-of-business.line-of-business-name",
+ "relationship-value": "LOB-Demonstration"
+ }]
+ }, {
+ "related-to": "vserver",
+ "relationship-label": "tosca.relationships.HostedOn",
+ "related-link": "/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/RegionOne/tenants/tenant/759425709b7a4b3ca257d3f93ef4e91e/vservers/vserver/856aed6e-cc25-4819-a03d-5549f5fe8662",
+ "relationship-data": [{
+ "relationship-key": "cloud-region.cloud-owner",
+ "relationship-value": "CloudOwner"
+ }, {
+ "relationship-key": "cloud-region.cloud-region-id",
+ "relationship-value": "RegionOne"
+ }, {
+ "relationship-key": "tenant.tenant-id",
+ "relationship-value": "759425709b7a4b3ca257d3f93ef4e91e"
+ }, {
+ "relationship-key": "vserver.vserver-id",
+ "relationship-value": "856aed6e-cc25-4819-a03d-5549f5fe8662"
+ }],
+ "related-to-property": [{
+ "property-key": "vserver.vserver-name",
+ "property-value": "zdfw1fwl01pgn01"
+ }]
+ }]
+ }
+ }, {
+ "vnf-id": "be9e190e-a20c-4900-8074-cffec77131f1",
+ "vnf-name": "vfw_sinc_vsp_002-1",
+ "vnf-type": "vfw-service-002/vfw_sinc_vsp_002 0",
+ "service-id": "f18af052-6dfb-40e8-ad25-f060eb898f53",
+ "prov-status": "ACTIVE",
+ "orchestration-status": "Active",
+ "in-maint": false,
+ "is-closed-loop-disabled": false,
+ "resource-version": "1617776104234",
+ "model-invariant-id": "9b25321d-9260-4739-97f8-7c85fba4e755",
+ "model-version-id": "c785c203-9c39-4b6a-9c2e-f24bb8d4d92d",
+ "model-customization-id": "a1e0ddf7-5d50-43a4-a6f1-0bfde3c1de78",
+ "relationship-list": {
+ "relationship": [{
+ "related-to": "service-instance",
+ "relationship-label": "org.onap.relationships.inventory.ComposedOf",
+ "related-link": "/aai/v16/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vFW/service-instances/service-instance/6f294c8f-ac67-4b33-9e56-014fb63791a5",
+ "relationship-data": [{
+ "relationship-key": "customer.global-customer-id",
+ "relationship-value": "Demonstration"
+ }, {
+ "relationship-key": "service-subscription.service-type",
+ "relationship-value": "vFW"
+ }, {
+ "relationship-key": "service-instance.service-instance-id",
+ "relationship-value": "6f294c8f-ac67-4b33-9e56-014fb63791a5"
+ }],
+ "related-to-property": [{
+ "property-key": "service-instance.service-instance-name",
+ "property-value": "vfw-service-002-1"
+ }]
+ }, {
+ "related-to": "platform",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v16/business/platforms/platform/Platform-Demonstration",
+ "relationship-data": [{
+ "relationship-key": "platform.platform-name",
+ "relationship-value": "Platform-Demonstration"
+ }]
+ }, {
+ "related-to": "line-of-business",
+ "relationship-label": "org.onap.relationships.inventory.Uses",
+ "related-link": "/aai/v16/business/lines-of-business/line-of-business/LOB-Demonstration",
+ "relationship-data": [{
+ "relationship-key": "line-of-business.line-of-business-name",
+ "relationship-value": "LOB-Demonstration"
+ }]
+ }, {
+ "related-to": "vserver",
+ "relationship-label": "tosca.relationships.HostedOn",
+ "related-link": "/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/RegionOne/tenants/tenant/759425709b7a4b3ca257d3f93ef4e91e/vservers/vserver/30dd6250-8a74-4ed7-9729-6ce7190c6661",
+ "relationship-data": [{
+ "relationship-key": "cloud-region.cloud-owner",
+ "relationship-value": "CloudOwner"
+ }, {
+ "relationship-key": "cloud-region.cloud-region-id",
+ "relationship-value": "RegionOne"
+ }, {
+ "relationship-key": "tenant.tenant-id",
+ "relationship-value": "759425709b7a4b3ca257d3f93ef4e91e"
+ }, {
+ "relationship-key": "vserver.vserver-id",
+ "relationship-value": "30dd6250-8a74-4ed7-9729-6ce7190c6661"
+ }],
+ "related-to-property": [{
+ "property-key": "vserver.vserver-name",
+ "property-value": "vfw_sinc_vsp_002-1"
+ }]
+ }, {
+ "related-to": "vserver",
+ "relationship-label": "tosca.relationships.HostedOn",
+ "related-link": "/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/RegionOne/tenants/tenant/759425709b7a4b3ca257d3f93ef4e91e/vservers/vserver/9ab8d517-2b1c-4d31-a04c-0fe2f8396815",
+ "relationship-data": [{
+ "relationship-key": "cloud-region.cloud-owner",
+ "relationship-value": "CloudOwner"
+ }, {
+ "relationship-key": "cloud-region.cloud-region-id",
+ "relationship-value": "RegionOne"
+ }, {
+ "relationship-key": "tenant.tenant-id",
+ "relationship-value": "759425709b7a4b3ca257d3f93ef4e91e"
+ }, {
+ "relationship-key": "vserver.vserver-id",
+ "relationship-value": "9ab8d517-2b1c-4d31-a04c-0fe2f8396815"
+ }],
+ "related-to-property": [{
+ "property-key": "vserver.vserver-name",
+ "property-value": "zdfw1fwl01snk01"
+ }]
+ }]
+ }
+ }]
+ }
+
+b. Get the public IP address of the Packet Generator VM from your deployment
+
+c. To mount APPC, run the below command by replacing <vnf-id> and <vnf-ip> with the values obtained from the above steps (a) & (b) respectively
+
+.. code-block::
+
+ curl -X PUT \
+ http://<kubernetes-host>:30230/restconf/config/network-topology:network-topology/topology/topology-netconf/node/<vnf-id> \
+ -H 'Accept: application/xml' \
+ -H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \
+ -H 'Content-Type: text/xml' \
+ -d '<node xmlns="urn:TBD:params:xml:ns:yang:network-topology">
+ <node-id><vnf-id></node-id>
+ <host xmlns="urn:opendaylight:netconf-node-topology"><vnf-ip></host>
+ <port xmlns="urn:opendaylight:netconf-node-topology">830</port>
+ <username xmlns="urn:opendaylight:netconf-node-topology">netconf</username>
+ <password xmlns="urn:opendaylight:netconf-node-topology">netconf</password>
+ <tcp-only xmlns="urn:opendaylight:netconf-node-topology">false</tcp-only>
+ </node>'
+
+ #smaple command and output:
+ curl -vvv -X PUT http://192.168.122.99:30230/restconf/config/network-topology:network-topology/topology/topology-netconf/node/a1ca05b4-3231-4e4a-a09c-74f2292fe577 -H 'Accept: application/xml' -H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' -H 'Content-Type: text/xml' -d '<node xmlns="urn:TBD:params:xml:ns:yang:network-topology"> <node-id>a1ca05b4-3231-4e4a-a09c-74f2292fe577</node-id> <host xmlns="urn:opendaylight:netconf-node-topology">192.168.122.238</host> <port xmlns="urn:opendaylight:netconf-node-topology">830</port> <username xmlns="urn:opendaylight:netconf-node-topology">netconf</username> <password xmlns="urn:opendaylight:netconf-node-topology">netconf</password> <tcp-only xmlns="urn:opendaylight:netconf-node-topology">false</tcp-only> </node>'
+ * Trying 192.168.122.99...
+ * TCP_NODELAY set
+ * Connected to 192.168.122.99 (192.168.122.99) port 30230 (#0)
+ > PUT /restconf/config/network-topology:network-topology/topology/topology-netconf/node/a1ca05b4-3231-4e4a-a09c-74f2292fe577 HTTP/1.1
+ > Host: 192.168.122.99:30230
+ > User-Agent: curl/7.58.0
+ > Accept: application/xml
+ > Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==
+ > Content-Type: text/xml
+ > Content-Length: 488
+ >
+ * upload completely sent off: 488 out of 488 bytes
+ < HTTP/1.1 200 OK
+ < Content-Length: 0
+ <
+ * Connection #0 to host 192.168.122.99 left intact
+
+d. To verify the NETCONF connection has successfully being established, run the following request (replace <vnd-id> with yours)
+
+.. code-block::
+
+ curl -X GET \
+ http://<kubernetes-host>:30230/restconf/operational/network-topology:network-topology/topology/topology-netconf/node/<vnf-id> \
+ -H 'Accept: application/json' \
+ -H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ=='
+
+ #smaple command and output:
+ curl -X GET http://192.168.122.99:30230/restconf/operational/network-topology:network-topology/topology/topology-netconf/node/a1ca05b4-3231-4e4a-a09c-74f2292fe577 -H 'Accept: application/json' -H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' | jq
+ % Total % Received % Xferd Average Speed Time Time Time Current
+ Dload Upload Total Spent Left Speed
+ 100 5368 100 5368 0 0 374k 0 --:--:-- --:--:-- --:--:-- 374k
+ {
+ "node": [
+ {
+ "node-id": "a1ca05b4-3231-4e4a-a09c-74f2292fe577",
+ "netconf-node-topology:unavailable-capabilities": {},
+ "netconf-node-topology:available-capabilities": {
+ "available-capability": [
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:yang-library:1.0?revision=2018-01-17&module-set-id=29"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:base:1.1"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:base:1.0"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:writable-running:1.0"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:validate:1.1"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:with-defaults:1.0?basic-mode=explicit&also-supported=report-all,report-all-tagged,trim,explicit"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:interleave:1.0"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:rollback-on-error:1.0"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:xpath:1.0"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:startup:1.0"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:candidate:1.0"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "urn:ietf:params:netconf:capability:notification:1.0"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:netconf:notification:1.0?revision=2008-07-14)notifications"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:iana-crypt-hash?revision=2014-08-06)iana-crypt-hash"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-x509-cert-to-name?revision=2014-12-10)ietf-x509-cert-to-name"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-system?revision=2014-08-06)ietf-system"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?revision=2010-10-04)ietf-netconf-monitoring"
+ },
+ {
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-datastores?revision=2017-08-17)ietf-datastores"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:1?revision=2017-02-20)yang"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-interfaces?revision=2014-05-08)ietf-interfaces"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:iana-if-type?revision=2014-05-08)iana-if-type"
+ },
+ {
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-netconf-server?revision=2016-11-02)ietf-netconf-server"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:opendaylight:params:xml:ns:yang:sample-plugin?revision=2016-09-18)sample-plugin"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(http://nokia.com/pnf-simulator)pnf-simulator"
+ },
+ {
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-ssh-server?revision=2016-11-02)ietf-ssh-server"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-netconf-notifications?revision=2012-02-06)ietf-netconf-notifications"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:netconf:base:1.0?revision=2011-06-01)ietf-netconf"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-yang-types?revision=2013-07-15)ietf-yang-types"
+ },
+ {
+ "capability": "(urn:mynetconf:test?revision=2019-03-01)mynetconf"
+ },
+ {
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-keystore?revision=2016-10-31)ietf-keystore"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:netmod:notification?revision=2008-07-14)nc-notifications"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-yang-metadata?revision=2016-08-05)ietf-yang-metadata"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-inet-types?revision=2013-07-15)ietf-inet-types"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(http://example.net/turing-machine?revision=2013-12-27)turing-machine"
+ },
+ {
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-tls-server?revision=2016-11-02)ietf-tls-server"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults?revision=2011-06-01)ietf-netconf-with-defaults"
+ },
+ {
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-yang-library?revision=2018-01-17)ietf-yang-library"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-ip?revision=2014-06-16)ietf-ip"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:ietf:params:xml:ns:yang:ietf-netconf-acm?revision=2018-02-14)ietf-netconf-acm"
+ },
+ {
+ "capability-origin": "device-advertised",
+ "capability": "(urn:opendaylight:params:xml:ns:yang:stream-count?revision=2016-09-18)stream-count"
+ }
+ ]
+ },
+ "netconf-node-topology:host": "192.168.122.238",
+ "netconf-node-topology:clustered-connection-status": {
+ "netconf-master-node": "akka.tcp://opendaylight-cluster-data@127.0.0.1:2550"
+ },
+ "netconf-node-topology:connection-status": "connected",
+ "netconf-node-topology:port": 830
+ }
+ ]
+ }
+
+VPP setup
+=========
+
+1. The information that we need to configure the VPP reporter (which is the VES agent application
+that generates events destined for the ONAP VES collector) is the VES IP and port.
+The below instructions can be used for this configuration
+
+.. code-block::
+
+ kubectl get svc -n onap -o wide | grep ves
+ dcae-hv-ves-collector ClusterIP 10.43.130.145 <none> 6061/TCP 12d app=dcae-hv-ves-collector
+ dcae-ves-collector ClusterIP 10.43.83.158 <none> 8080/TCP,8443/TCP 12d app=dcae-ves-collector
+ xdcae-hv-ves-collector NodePort 10.43.32.76 <none> 6061:30222/TCP 12d app=dcae-hv-ves-collector
+ xdcae-ves-collector NodePort 10.43.97.42 <none> 8080:30235/TCP,8443:30417/TCP 12d app=dcae-ves-collector
+
+2. Use the port of xdcae-ves (30235 in this case) and the kubernetes-host IP
+
+- Log in to the vfw sinc VNF as user ubuntu
+- Modify /opt/config/dcae_collector_ip.txt and /opt/config/dcae_collector_port.txt
+- Kill the vpp reporter if running already
+- Start the vpp reporter by executing the script
+
+ - cd /opt/VES/evel/evel-library/code/VESreporting
+ - ./go-client.sh &
+- Add the following route for the metadata service if not present already
+
+ .. code-block::
+
+ sudo ip route add 169.254.169.254 via <vfw_sinc OAM_NETWORK IP> dev <interface name>
+ sample command:
+ # sudo ip route add 169.254.169.254 via 10.10.10.11 dev eth3
+- Verify that the metadata service is accessible by issuing the following command
+
+ - curl http://169.254.169.254
+
+3. The events generated from this program will trigger the vFW CL flow.
+In a successful deployment of the vFW CL, the graphs look as in the screenshot below.
+We can see that the bars are shorter and more uniform as compared to vFW deployment without the CL
+
+Browse to the zdfw1fwl01snk01 on port 667 to see a graph representing the traffic being received
+
+.. code-block::
+
+ http://<zdfw1fwl01snk01>:667/
+
+|image54|
+
+4. Check the events sent by TCA on unauthenticated.DCAE_CL_OUTPUT
+
+These events are the resulting of the TCA application, e.g. TCA has noticed an event was crossing
+a given threshold, hence is sending a message of that particular topic. Then Policy will grab this event
+and perform the appropriate action, as defined in the Policy. In the case of vFWCL, Policy will send
+an event on the APPC_CL topic, that APPC will consume. This will trigger a NETCONF request to the
+packet generator to adjust the traffic.
+
+.. code-block::
+
+ curl -X GET \
+ http://<kubernetes-host>:3904/events/unauthenticated.DCAE_CL_OUTPUT/group1/C1 \
+ -H 'Accept: application/json' \
+ -H 'Content-Type: application/cambria'
+
+ #smaple command and output:
+ curl -X GET http://10.43.214.215:3904/events/unauthenticated.DCAE_CL_OUTPUT/group1/C1 -H 'Accept: application/json' -H 'Content-Type: application/cambria' | jq
+ % Total % Received % Xferd Average Speed Time Time Time Current
+ Dload Upload Total Spent Left Speed
+ 100 909 100 909 0 0 677 0 0:00:01 0:00:01 --:--:-- 677
+ [
+ "{\"closedLoopEventClient\":\"DCAE_INSTANCE_ID.dcae-tca\",\"policyVersion\":\"v0.0.1\",\"policyName\":\"DCAE.Config_tca-hi-lo\",\"policyScope\":\"DCAE\",\"target_type\":\"VM\",\"AAI\":{\"vserver.prov-status\":\"ACTIVE\",\"vserver.resource-version\":\"1617776112073\",\"vserver.is-closed-loop-disabled\":false,\"vserver.vserver-name2\":\"vfw_sinc_vsp_002-1\",\"vserver.vserver-id\":\"30dd6250-8a74-4ed7-9729-6ce7190c6661\",\"vserver.vserver-selflink\":\"http://10.200.142.157:8774/v2.1/servers/30dd6250-8a74-4ed7-9729-6ce7190c6661\",\"vserver.in-maint\":false,\"vserver.vserver-name\":\"vfw_sinc_vsp_002-1\"},\"closedLoopAlarmStart\":1500584201765465,\"closedLoopEventStatus\":\"ONSET\",\"closedLoopControlName\":\"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\",\"version\":\"1.0.2\",\"target\":\"vserver.vserver-name\",\"requestID\":\"2f546551-f304-4e76-9e8e-45c601790823\",\"from\":\"DCAE\"}"
+ ]
+
+5. Check the active streams value in vPG over restconf
+
+The number of streams will change along the time, this is the result of close-loop policy.
+When the traffic goes over a certain threshold, DCAE will publish an event on the unauthenticated.DCAE_CL_OUTPUT
+topic that will be picked up by APPC, that will send a NETCONF request to the packet generator to adjust the traffic it's sending.
+
+Run the below command to check the stream count, you should see the value as 5
+
+.. code-block::
+
+ curl -v --noproxy '*' --user "admin":"Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U" -H "Accept: application/xml" -H "Content-type: application/xml" -X GET http:/<kubernetes-host>:30230/restconf/config/network-topology:network-topology/topology/topology-netconf/node/<VPG VNFID>/yang-ext:mount/stream-count:stream-count/streams/
+
+ #sample command and output
+ curl -v --noproxy '*' --user "admin":"Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U" -H "Accept: application/xml" -H "Content-type: application/xml" -X GET http:/192.168.122.99:30230/restconf/config/network-topology:network-topology/topology/topology-netconf/node/a1ca05b4-3231-4e4a-a09c-74f2292fe577/yang-ext:mount/stream-count:stream-count/streams/
+ Note: Unnecessary use of -X or --request, GET is already inferred.
+ * Unwillingly accepted illegal URL using 1 slash!
+ * Trying 192.168.122.99...
+ * TCP_NODELAY set
+ * Connected to 192.168.122.99 (192.168.122.99) port 30230 (#0)
+ * Server auth using Basic with user 'admin'
+ > GET /restconf/config/network-topology:network-topology/topology/topology-netconf/node/a1ca05b4-3231-4e4a-a09c-74f2292fe577/yang-ext:mount/stream-count:stream- count/streams/ HTTP/1.1
+ > Host: 192.168.122.99:30230
+ > Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==
+ > User-Agent: curl/7.58.0
+ > Accept: application/xml
+ > Content-type: application/xml
+ >
+ < HTTP/1.1 200 OK
+ < Content-Type: application/xml
+ < Content-Length: 110
+ <
+ * Connection #0 to host 192.168.122.99 left intact
+ <streams xmlns="urn:opendaylight:params:xml:ns:yang:stream-count"><active-streams>5</active-streams></streams>
+
+
+.. |image16| image:: media/image16.png
+.. |image15| image:: media/image15.png
+.. |image5| image:: media/image5.png
+.. |image13| image:: media/image13.png
+.. |image1| image:: media/image1.png
+.. |image12| image:: media/image12.png
+.. |image14| image:: media/image14.png
+.. |image19| image:: media/image19.png
+.. |image7| image:: media/image7.png
+.. |image10| image:: media/image10.png
+.. |image4| image:: media/image4.png
+.. |image20| image:: media/image20.png
+.. |image9| image:: media/image9.png
+.. |image3| image:: media/image3.png
+.. |image17| image:: media/image17.png
+.. |image11| image:: media/image11.png
+.. |image24| image:: media/image24.png
+.. |image22| image:: media/image22.png
+.. |image18| image:: media/image18.png
+.. |image23| image:: media/image23.png
+.. |image2| image:: media/image2.png
+.. |image8| image:: media/image8.png
+.. |image21| image:: media/image21.png
+.. |image25| image:: media/image25.png
+.. |image53| image:: media/image53.jpg
+.. |image54| image:: media/image54.png
| | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines |
| | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | :ref:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. We can learn about discovered and fixed |
+ | | vulnerabilities. |
+ +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
.. toctree::
This document provides the release notes for the documentation project.
-Guilin Releases
-===============
+Honolulu Releases
+=================
-The following releases are available for Guilin:
- - `Guilin Maintenance Release 7.0.1`_
- - `Guilin Major Release 7.0.0`_
+The following releases are available for Honolulu:
+ - `Honolulu Major Release 8.0.0`_
-Guilin Maintenance Release 7.0.1
-================================
+Honolulu Major Release 8.0.0
+============================
+--------------------------------------+--------------------------------------+
| **Project** | Documentation Project |
| | |
+--------------------------------------+--------------------------------------+
-| **Release name** | Guilin Maintenance Release |
+| **Release name** | Honolulu |
| | |
+--------------------------------------+--------------------------------------+
-| **Release version** | 7.0.1 |
-| | |
-+--------------------------------------+--------------------------------------+
-
-
-New features
-------------
-
-- Restructured the user guides section and added new tutorials
-
-
-Guilin Major Release 7.0.0
-==========================
-
-+--------------------------------------+--------------------------------------+
-| **Project** | Documentation Project |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release name** | Guilin |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release version** | 7.0.0 |
+| **Release version** | 8.0.0 |
| | |
+--------------------------------------+--------------------------------------+
- Refined and improved parts of the documentation guide.
- Continue with improving the user and admin documentation.
-- Minor corrections after the migration.
- In addition the documentation project is continuously working with improving
processes and tools for documentation. Enabling the community to as easy as
possible document all the aspects of the ONAP platform.
-All JIRA tickets for the Guilin release can be found
+All JIRA tickets for the Honolulu release can be found
`ONAP Documentation Jira`_
-.. _`ONAP Documentation Jira`: https://jira.onap.org/browse/DOC-674?jql=project%20%3D%20DOC%20AND%20fixVersion%20%3D%20%22Guilin%20Release%22
+.. _`ONAP Documentation Jira`: https://jira.onap.org/browse/DOC-730?jql=project%20%3D%20DOC%20AND%20fixVersion%20%3D%20%22Honolulu%20Release%22
.. _onap-release-notes:
-Guilin Release Notes
-^^^^^^^^^^^^^^^^^^^^
+Honolulu Release Notes
+^^^^^^^^^^^^^^^^^^^^^^
-This page provides the release notes for the ONAP Guilin release. This
+This page provides the release notes for the ONAP Honolulu release. This
includes details of software versions, known limitations, and outstanding
trouble reports.
Details on the specific items delivered in each release by each component is
maintained in the component specific release notes.
-Guilin Releases
-===============
+Honolulu Releases
+=================
-The following releases are available for Guilin:
- - `Guilin Maintenance Release 7.0.1`_
- - `Guilin Major Release 7.0.0`_
+The following releases are available for Honolulu:
+ - `Honolulu Major Release 8.0.0`_
-Guilin Maintenance Release 7.0.1
-================================
+Honolulu Major Release 8.0.0
+============================
+--------------------------------------+--------------------------------------+
| **Project** | Open Network Automation Platform |
| | (ONAP) |
+--------------------------------------+--------------------------------------+
-| **Release name** | Guilin Maintenance Release |
+| **Release name** | Honolulu |
| | |
+--------------------------------------+--------------------------------------+
-| **Release version** | 7.0.1 |
+| **Release version** | 8.0.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | February 28th 2021 |
+| **Release date** | May 11th 2021 |
| | |
+--------------------------------------+--------------------------------------+
-New Features
-============
-
-Guilin Maintenance Release 7.0.1 delivered a number of fixes and updates
-across the following projects:
-
- - AAI - bug fixes
- - OOM - bug fixes
- - CCSDK - bug fixes
- - DCAEGEN2 - bug fixes
- - DMaaP - bug fixes
- - DOC - restructure user guides section and added tutorials
- - Integration - new docker for robot framework
- - Music - certificate update
- - MSB - bug fixes
- - OOM - docker improvement
- - SDNC - bug fixes
- - SO - bug fixes
- - VID - certificate update
-
-Details on the specific Jira tickets addressed by each project can be found in
-the component specific Release Notes: :ref:`release notes<doc-releaserepos>`
-
-
-Guilin Major Release 7.0.0
-==========================
-
-+--------------------------------------+--------------------------------------+
-| **Project** | Open Network Automation Platform |
-| | (ONAP) |
-+--------------------------------------+--------------------------------------+
-| **Release name** | Guilin |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release version** | 7.0.0 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release date** | December 3rd 2020 |
-| | |
-+--------------------------------------+--------------------------------------+
+Honolulu Features
+=================
+ONAP Honolulu focusses on:
-Guilin Features
-===============
-ONAP Guilin focusses on:
-
-* 5G network automation and services such as network slicing through RAN, core
- and transport
-* deepening O-RAN Software Community integration along with other leading SDOs
-* seamless orchestration of CNFs, VNFs and PNFs
-* and bringing several new ONAP Blueprint and docs updates.
-
-5G Network Slicing
-------------------
-In the industry evolution toward 5G networks, Guilin expands upon the
-end-to-end network slicing introduced with Frankfurt with the addition of RAN,
-core, and transport through Network Slice Subnet Management Function (NSSMF)
-which completes functionality with the Communication Service Management
-Function (CSMF) and Network Slice Management Function (NSMF) components. In
-addition to the NSSMF included in Guilin, ONAP supports an external RAN NSSMF.
-Next, the RAN domain also has initial support for a simple closed control loop
-and machine learning (ML) for intelligent slicing.
-
-ONAP/O-RAN Alignment
---------------------
-The release also marks greater ONAP + O-RAN Software Community harmonization by
-adding support for the A1 interface (O-RAN A1-AP v1.1), adding to the existing
-O1 support. ONAP can now manage multiple A1 targets with different versions and
-includes a A1 Policy Management Service that interacts with the Near Real-Time
-RIC\19s policy instances and provides a transient cache for these policies.
-
-CNF, VNF and PNF integration
-----------------------------
-Guilin contains a large number of new features classified into design time,
-run time, and ONAP operations to optimize the self-serve control loop and
-dashboard, make it easier to reuse existing models, make xNF pre-onboarding and
-onboarding easier, speed up UI development, and more. For Documentation
-(Usability), ONAP documentation made improvements such as setting up ONAP,
-Platform Operations, Service Design and Deployment, and User Guides. Specific
-to cloud native, The Service Design & Creation (SDC) project, the unified
-design time tool, now supports Helm types to natively support Cloud Native
-Network Functions (CNF).
-
-Enhancements in ONAP Blueprints
--------------------------------
-Other enhancements to the ONAP Blueprints includes a new Standard Defined VNF
-Event Stream (VES) event for Fault Management (FM) / Performance Management
-(PM) Data Collection, the first use of Machine Learning in Self-Organizing
-Networks (SON), and greater support for 5G RAN Wireless Network Resource Model
-(NRM) with Service Modeling and Definition and Intent Based Network supporting
-intent-drive 5G slice creation. The Cross Domain and Cross Layer VPN (CC-VPN)
-includes transport slicing and the MDONS (Multi-Domain Optical Network Service
-) has been extended.
+* Cloud Native Function (CNF) support with with seamless configuration of Helm
+ based CNFs and K8s resources
+* End-to-end 5G network slicing with three network slicing components for RAN,
+ core, and transport
+* Introducing a new component: Configuration Persistence Service (CPS) to store
+ persistent configuation data
+* Modularity to pick and choose the components needed for specific use case
+* Improving integration with many SDOs
Functional Requirements
-----------------------
-The following requirements have been introduced in the Guilin Release:
-
-xNF Integration
-...............
-
-- ONAP CNF orchestration - Enhancements
-- Extension of PNF Pre-onboarding/onboarding
-- Enhancements for PNF Plug & Play'
-- xNF License Management
-Lifecycle Management
-....................
-
-- Policy Based Filtering
-- CLAMP Deployment of Native policies
-- Bulk PM / PM Data Control Extension
-- Support xNF Software Upgrade in association to schema updates
-- Configuration & Persistency Service
-
-Security
-........
-
-- CMPv2 Enhancements
-
-Standard alignment
-..................
-
-- ETSI-Alignment for Guilin
-- ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES
-- Extend ORAN A1 Adapter and add A1 Policy Management
-
-NFV testing Automatic Platform
-...............................
-
-- Test Result Auto Analysis & Certification
-- Test Task Auto Execution
-- Test Environment Auto Deploy
-- Test Topology Auto Design
+Increased Cloud Native Functionality
+....................................
+The Honolulu release has important updates to support cloud native network
+functions (CNF). The functionality includes configuration of Helm based CNFs
+and seamless day 1, 2 operations. The Configuration API allows a user to
+create, modify and delete Kubernetes (K8s) resource templates and their base
+parameters and the Profile API allows for sophisticated day 0 configuration.
+The Query API gathers filtered status of the CNF and the HealthCheck API
+executes dedicated health check jobs to verify the status of a CNF. This new
+functionality is implemented in the Controller Design Studio (CDS) component
+using dedicated templates called Controller Blueprint Archives (CBA).
+In addition, there is Swagger documentation for the API of the K8s plugin
+component in the MutliCloud project.
+
+Deeper 5G Support
+.................
+There is a significant set of new functionality around end-to-end 5G network
+slicing in the Honolulu release. This release includes three internal Network
+Slice Subnet Management Function (NSSMF) components for RAN, core, and
+transport domains. External NSSMFs continue to be supported for RAN and core.
+Next, slice optimization continues to be an area of ongoing effort with closed
+loop automation and intelligent slicing testing. There are also enhancements in
+NST, NSI, and NSSI selection in the OOF project and A&AI includes schema
+changes to accommodate network and transport slicing.
+
+In addition, the ExtAPI project now included Enhanced Service Ordering for
+additional service types and the UUI graphical user interface has improved
+slicing support. The VID graphical user has support for PNF plug-and-play
+allowing operators to interact with PNFs via VID. In addition, there is better
+compliance to standards such as 3GPP TS28.540/541 5G NRM driven xNF models in
+ONAP. Finally the OOF SON functionality supports offline trained ML-models
+providing additional inputs for Physical Cell Identity (PCI) optimization.
+DCAE includes a new KPI microservice.
+
+Configuration Persistence Service
+.................................
+Another key 5G related initiative is the new Configuration Persistence Service
+(CPS) module that allows ONAP projects to store persistent state defined by
+YANG models, deploy YANG models at runtime, and share access to configuration
+management data.
+
+Further O-RAN Integration
+.........................
+A key enhancement in the Honolulu release was increased support for the O-RAN
+A1 standard that is implemented in the CCSDK and SDN-C projects. The O-RAN A1
+interface provides a flexible way for RAN operators to manage wide area RAN
+network optimization reducing capex investment needs. Both the enhanced A1
+interface controller and A1 policy capabilities are now usable in ONAP with a
+Near-Real-Time Radio Intelligent Controller (nRTRIC). This functionality is
+also used downstream in O-RAN-Source Community (OSC) Non-RealTime RIC
+(NONRTRIC) project, strengthening alignment between ONAP & OSC. In addition,
+the DCAE project includes VES 7.2 integration that improves integration with
+both O-RAN and 3GPP. Finally, there is a new CPS interface to query RAN
+configuration data.
+
+Expanded Modularity
+...................
+Modularity has been an important topic in ONAP to allow users to pick and
+choose the components they need for their specific use case and Honolulu
+continues to advance modularity. DCAE now simplifies microservice deployment
+via Helm charts.
+
+Service Design
+..............
+
+- Includes increased support for ETSI standards such as SOL001, SOL004, and
+ SOL007 and allows users to choose unlicensed or externally licensed xNFs.
+- Vendor License Model is now optional
+- SDC distribution status report enhanced
+
+Inventory
+.........
+
+- A&AI includes support for multi tenancy.
+- Model updates for CCVPN Transport Slicing and Network Slicing
+- GraphGraph POC enhanced for schema visualization and visual model generation
+- Sparky UI updates including Browse, Specialized Search, BYOQ, and BYOQ
+ Builder Views
+
+ONAP Operations Manager
+.......................
+
+- Portal-Cassandra image updated to Bitnami, supporting IPv4/IPv6 Dual Stack
+- CMPv2 external issuer implemented which extends Cert-Manager with ability to
+ enroll X.509 certificates from CMPv2 servers
+- New version for MariaDB Galera using Bitnami image, supporting IPv4/IPv6 Dual
+ Stack
+- Support of Helm v3.4 and Helm v3.5
Non-Functional Requirements
---------------------------
-The following 'non-functional' requirements have been introduced in the Guilin
-Release:
+The following 'non-functional' requirements are followed in the
+Honolulu Release:
Best Practice
.............
- ONAP shall use STDOUT for logs collection
-- IPv4/IPv6 dual stack support in ONAP (Guilin)
+- IPv4/IPv6 dual stack support in ONAP
- Containers must crash properly when a failure occurs
- Containers must have no more than one main process
- Application config should be fully prepared before starting the
Security
........
-- ONAP must complete update of the Python language (from 2.7 -> 3.8)
-- ONAP must complete update of the java language (from v8 -> v11)
+- Python language 3.8
+- Java language v11
- All containers must run as non-root user
- Continue hardcoded passwords removal
- Flow management must be activated for ONAP.
Tests
.....
-- More tests integrated in CI/CD but enhancements expected in Honolulu
-- ONAP shall increase the number of Docker Benchmark tests
-
-Others
-......
-
-- ONAP to support Multi - tenancy
+- New E2E tests
+- New IPv4/Ipv6 daily CI chain
.. important::
Some non-functional requirements are not fully finalized. Please, check details
Documentation
=============
-ONAP Guilin Release provides a set selection of documents,
-see `ONAP Documentation <https://docs.onap.org/en/guilin/index.html>`_.
+ONAP Honolulu Release provides a set selection of documents,
+see :ref:`ONAP Documentation<master_index>`.
The `developer wiki <http://wiki.onap.org>`_ remains a good source of
information on meeting plans and notes from committees, project teams and
- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
-In the Guilin release,
+In the Honolulu release,
- 100% projects passed 90% of the CII badge
- 85% projects passed the CII badge
ONAP Maturity Testing Notes
===========================
-For the Guilin release, ONAP continues to improve in multiple areas of
+For the Honolulu release, ONAP continues to improve in multiple areas of
Scalability, Security, Stability and Performance (S3P) metrics.
-In Guilin the Integration team focussed in
+In Honolulu the Integration team focussed in
- Automating ONAP Testing to improve the overall quality
- Adding security and E2E tests
-- Integrated new ONAP Python SDK in E2E testing
More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
Project Specific Release Notes
++++++++++++++++++++++++++++++
+Maintained Projects
+-------------------
+
.. toctree::
:maxdepth: 1
| :ref:`VNF Requirements<onap-vnfrqts-requirements:release_notes>`
| :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:release_notes>`
| :ref:`CCSDK - Common Controller Software Development Kit<onap-ccsdk-distribution:release_notes>`
-| :ref:`CLAMP - Control Loop Automation Platform<onap-clamp:release_notes>`
+| :ref:`CCSDK/ORAN - Open-RAN Support in ONAP<onap-ccsdk-oran:release_notes>`
| :ref:`CLI - Command Line Interface<onap-cli:release_notes>`
+| :ref:`CPS - Configuration Persistence Service<onap-cps:release_notes>`
| :ref:`DCAE - Data Collection Analysis and Events<onap-dcaegen2:release_notes>`
| :ref:`DMAAP - Message Router (MR)<onap-dmaap-messagerouter-messageservice:release_notes>`
| :ref:`DMAAP - Data Router (DR)<onap-dmaap-datarouter:release_notes>`
| :ref:`EXTAPI - External API NorthBound Interface<onap-externalapi-nbi:release_notes>`
| :ref:`HOLMES - Rule Management<onap-holmes-rule-management:release_notes>`
| :ref:`MODELING - Modeling ETSI catalog<onap-modeling-etsicatalog:release_notes>`
+| :ref:`MSB - Microservices Bus<onap-msb-apigateway:release_notes>`
| :ref:`MULTICLOUD - MultiCloud Framework<onap-multicloud-framework:release_notes>`
| :ref:`OOF - Optimization Framework<onap-optf-osdf:release_notes>`
| :ref:`OOM - ONAP Operations Manager<onap-oom:release_notes>`
| :ref:`OOM - Certification Service<onap-oom-platform-cert-service:release_notes>`
| :ref:`POLICY- Policy Framework<onap-policy-parent:release_notes>`
-| :ref:`PORTAL - Portal Platform<onap-portal:release_notes>`
| :ref:`SDC - Service Design & Creation<onap-sdc:release_notes>`
| :ref:`SDNC - Software Defined Network Controller<onap-sdnc-oam:release_notes>`
| :ref:`SO - Service Orchestration<onap-so:release_notes>`
| :ref:`VID - Virtual Infrastructure Deployment<onap-vid:release_notes>`
| :ref:`VNFSDK - VNF Software Development Kit<onap-vnfsdk-model:release_notes>`
| :ref:`VVP - VNF Validation Project<onap-vvp-documentation:release_notes>`
+
+Migrated Projects
+-----------------
+
+.. toctree::
+ :maxdepth: 1
+
+| :ref:`CLAMP - Control Loop Automation Platform<onap-policy-clamp:release_notes>`
+
+Unmaintained Projects
+---------------------
+
+.. toctree::
+ :maxdepth: 1
+
+| :ref:`AAF - Application Authorization Framework<onap-aaf-authz:release_notes>`
+| :ref:`AAI/ESR - External System Registry<onap-aai-esr-server:master_index>`
+| :ref:`APPC - Application Controller<onap-appc:release_notes>`
+| :ref:`MUSIC - ONAP Multi-Site Integration<onap-music:release_notes>`
+| :ref:`PORTAL - Portal Platform<onap-portal:release_notes>`
\ No newline at end of file
### checkdocs.sh
###
### AUTHOR(S):
-### Thomas Kulik, Deutsche Telekom AG, 2020
+### Thomas Kulik, Deutsche Telekom AG, 2020 - 2021
###
### DESCRIPTION:
### Retrieves a full list of ONAP repos from gerrit inluding their state.
### create repo list
### curl -s https://git.onap.org/ | grep "^<tr><td class='toplevel-repo'><a title='" | sed -r "s:^<tr><td class='toplevel-repo'><a title='::" | sed -r "s:'.*::"
###
-### remove branchname from the line
-### cat frankfurt_gerritclone.log | sed 's:frankfurt|::'
+### remove branchname from the line:
+### cat frankfurt_repoclone.log | sed 's:frankfurt|::'
###
### list only image names
### cat master_dockerimagesfull.log | grep image | sed -r 's:image\:::' | sed -r 's:^ +::' | sed '/^[[:space:]]*$/d'
### SHORT: curl -s 'https://gerrit.onap.org/r/projects/?d' | awk '{if(NR>1)print}' | jq -c '.[] | {id, state}' | sed -r 's:%2F:/:g; s:["{}]::g; s:id\:::; s:,state\::|:; /All-Projects/d; /All-Users/d'
###
-script_version="1.2 (2020-11-18)"
+script_version="1.7 (2021-04-12)"
# save command for the restart with logging enabled
command=$0
echo " "
echo " ARGUMENTS: "
echo " -u|--user username "
- echo " linux foundation username used to clone ONAP Gerrit repos"
+ echo " linux foundation username used to clone ONAP repositories"
echo " "
echo " -b|--branches branch1,branch2,branch3 "
echo " list of branches to be cloned. master is automatically "
exit 0
}
+# function to parse wiki (project) lifecycle state information
+# call: getwikilifecyclestate "projectname"
+# result: $return_from_getwikilifecyclestate
+# because bash supports only returning numeric values a variable $return_from_getwikilifecyclestate is used
+
+function getwikilifecyclestate {
+
+ local requested=$1
+ local wikiline=""
+ local wikirepo=""
+ local wikistate=""
+
+ return_from_getwikilifecyclestate=""
+
+ for wikiline in "${wikiplsarray[@]}"
+ do
+
+ wikirepo=$(echo $wikiline | awk -F ";" '{print $1}');
+ wikistate=$(echo $wikiline | awk -F ";" '{print $2}');
+
+ #echo "DBUG: getwikilifecyclestate wikiline = \"${wikiline}\"";
+ #echo "DBUG: getwikilifecyclestate wikirepo = \"${wikirepo}\""
+ #echo "DBUG: getwikilifecyclestate wikistate = \"${wikistate}\""
+
+ if [[ ${wikirepo} == ${requested} ]]; then
+ return_from_getwikilifecyclestate=${wikistate}
+ #echo "DBUG: getwikilifecyclestate wikirepo = \"${wikirepo}\""
+ #echo "DBUG: getwikilifecyclestate requested = \"${requested}\""
+ #echo "DBUG: return_from_getwikilifecyclestate = \"${return_from_getwikilifecyclestate}\"";
+ return 0;
+ fi
+
+ done
+
+ #echo "DBUG: getwikilifecyclestate requested \"${requested}\" NOT FOUND in list"
+ return_from_getwikilifecyclestate=""
+
+}
+
###
### arguments handling
###
usage
exit -1
fi
-# clone master first, the the other branches
+# clone master first, then the other branches
branches_csv="master,${branches_csv}"
# create the branches array by readinging in the values from the variable
echo "checkdocs.sh Version ${script_version}"
echo " "
+#
+# read in wiki (project) lifecycle state
+# always use the lastest available file (derived from date in filename e.g. wiki_lifecycle_state_210409.txt)
+# format is <reponame abbrev>;<state>;<reponame full>
+#
+
+wikiplsfile=$(ls | sed -nr '/wiki_lifecycle_state_[0-9]{6}.txt/Ip' | tail -1);
+
+if [[ $wikiplsfile == "" ]]; then
+ echo "ERROR: wiki_lifecycle_state_yymmdd.txt missing"
+ exit -1
+fi
+
+echo "Using \"${wikiplsfile}\" as the source for wiki (project) lifecycle state information."
+
+readarray -t wikiplsarray < ./${wikiplsfile};
+i=0
+((i++))
+for line in "${wikiplsarray[@]}"
+do
+ wikiplsrepo=$(echo $line | awk -F ";" '{print $1}');
+ wikiplsstate=$(echo $line | awk -F ";" '{print $2}');
+ #echo "DBUG: wikipls line=\"${line}\"";
+ #echo "DBUG: wikipls ${wikiplsrepo}=${wikiplsstate}"
+ ((i++))
+done
+unset i
+unset wikiplsrepo
+unset wikiplsstate
+
+#
# curl must be installed
+#
+
if ! command -v curl &> /dev/null
then
echo "ERROR: curl command could not be found"
echo "Retrieving a full list of ONAP repositories (master) from gerrit.onap.org."
+#
# retrieve the full repolist from gerrit
# workaround because of the (wrong?) response of gerrit.onap.org which makes jq command fail
# "| awk '{if(NR>1)print}'" filters the first line of the response so that jq will work again (thx marek)
+#
+
curl -s 'https://gerrit.onap.org/r/projects/?d' | awk '{if(NR>1)print}' | jq -c '.[] | {id, state}' | sed -r 's:%2F:/:g; s:["{}]::g; s:id\:::; s:,state\::|:; /All-Projects/d; /All-Users/d' >./$repolist
-# process the created repolist
-# only active projects will be cloned in case the requested branch of the project exists
-echo "Accessing gerrit.onap.org with username \"${lfusername}\"."
-echo "Start cloning of repositories."
+# process the created repolist and try to clone the projects from the mirror
+
+source="git://cloud.onap.org/mirror"
+echo "Using \"${source}\" as the source and username \"${lfusername}\" for cloning the repositories."
+echo "Start cloning of repositories ..."
for branch in "${branches[@]}"
do
devcounter=$((devcounter+1))
fi
- if [[ $devcounter -lt "11" ]]; then
+ if [[ $devcounter -lt "50" ]]; then
if [[ $devmode == "TRUE" ]]; then
echo "INFO: devmode! counter=${devcounter}"
echo $reponame
echo $repostate
- if [[ $repostate == "ACTIVE" ]]; then
- echo "Cloning \"${branch}\" branch of ACTIVE project ${reponame}..."
+ if [[ $repostate == "ACTIVE" ]] || [[ $repostate == "READ_ONLY" ]]; then
+ echo "Cloning \"${branch}\" branch of \"${repostate}\" project ${reponame}..."
- git clone --branch ${branch} --recurse-submodules ssh://${lfusername}@gerrit.onap.org:29418/$reponame ./$reponame
+ # previously used: git clone --branch ${branch} --recurse-submodules ssh://${lfusername}@gerrit.onap.org:29418/$reponame ./$reponame
+ # clone script Jess: git clone "git://cloud.onap.org/mirror/${i}" "${LOCALNAME}"
+ git clone --branch ${branch} --recurse-submodules ${source}/${reponame} ./${reponame}
gitexitcode=$?
if [[ ! ${gitexitcode} == "0" ]]; then
errormsg="cloned"
fi
- # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
- echo "${gitexitcode}|${reponame}|${repostate}|${errormsg}" | tee -a ${branch}_gerritclone.log
+ # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
+ echo "${gitexitcode}|${reponame}|${repostate}|${errormsg}" | tee -a ${branch}_repoclone.log
- elif [[ $repostate == "READ_ONLY" ]]; then
- echo "-|${reponame}|${repostate}|ignored" | tee -a ${branch}_gerritclone.log
+ #elif [[ $repostate == "READ_ONLY" ]]; then
+ #echo "-|${reponame}|${repostate}|ignored" | tee -a ${branch}_repoclone.log
else
- echo "-|${reponame}|unknown repo state \"${repostate}\"|-" | tee -a ${branch}_gerritclone.log
+ echo "-|${reponame}|unknown repo state \"${repostate}\"|-" | tee -a ${branch}_repoclone.log
fi
# examine repo
printf "\nindex.rst files:\n"
find ./$reponame -type f -name index.rst | sed -r 's:./::' | sed -r s:${reponame}:[${reponame}]: | tee -a ${branch}_indexrst.log
+ printf "\nINFO.yaml files:\n"
+ find ./$reponame -type f -name INFO.yaml | sed -r 's:./::' | sed -r s:${reponame}:[${reponame}]: | tee -a ${branch}_infoyaml.log
+
fi
# end defcounter loop
# csv column #4: clone message
#
- readarray -t array < ./${branch}_gerritclone.log;
+ readarray -t array < ./${branch}_repoclone.log;
i=0
csv[i]="${csv[i]},${branch_upper} clone message"
((i++))
for line in "${array[@]}"
do
- # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
+ # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
errormsg=$(echo $line | awk -F "|" '{print $4}');
csv[i]="${csv[i]},${errormsg}"
((i++))
unset errormsg
#
- # csv column #5: RELEASE component (yes|no|maybe)
+ # csv column #5: latest branch
+ #
+
+ readarray -t array < ./${repolist};
+ i=0
+ csv[i]="${csv[i]},latest branch"
+ ((i++))
+ for line in "${array[@]}"
+ do
+ reponame=$(echo $line | awk -F "|" '{print $1}');
+ latestbranch=$(git ls-remote -q --heads "${source}/${reponame}" | sed 's/^.*heads\///' | sed -nr '/^master$|^amsterdam$|^beijing$|^casablanca$|^dublin$|^elalto$|^frankfurt$|^guilin$|^honolulu$|^istanbul$/Ip' | tail -2 | head -1);
+ #echo "DBUG: reponame=${reponame}"
+ #echo "DBUG: latestbranch=${latestbranch}"
+ echo "latest available branch for repo \"${reponame}\" is \"${latestbranch}\""
+ csv[i]="${csv[i]},${latestbranch}"
+ ((i++))
+ done
+ unset array
+ unset i
+ unset reponame
+ unset latestbranch
+
+ #
+ # csv column #6: INFO.yaml LC state (project lifecycle state based on INFO.yaml / per repo)
+ # csv column #7: WIKI LC state (project lifecycle state based on ONAP Dev Wiki / per project)
+ # csv column #8: LC state match shows a "match" if both LC states match
+ #
+
+ readarray -t array < ./${repolist};
+ i=0
+ csv[i]="${csv[i]},INFO.yaml LC state,WIKI LC state,LC state match"
+ ((i++))
+ for line in "${array[@]}"
+ do
+ reponame=$(echo $line | awk -F "|" '{print $1}');
+ project=$(echo $reponame | sed 's:/.*$::')
+
+ if [ -f ./${reponame}/INFO.yaml ] ; then
+ # check if repo/branch has a INFO.yaml
+ lifecycleproject=$(grep '^project: ' ./${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//')
+ lifecyclestate=$(grep '^lifecycle_state: ' ./${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//')
+ elif [ ${branch} != "master" ] && [ -f ../master/${reponame}/INFO.yaml ] ; then
+ # if current branch is not master AND if info.yaml not found in the current repo/branch THAN use INFO.yaml of repo/master if available
+ #echo "DBUG: branch=${branch} - checking master for INFO.yaml"
+ lifecycleproject=$(grep '^project: ' ../master/${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//')
+ lifecyclestate=$(grep '^lifecycle_state: ' ../master/${reponame}/INFO.yaml | awk -F ":" '{print $2}' | sed 's:^ ::' | sed "s:'::g" | tr '[:upper:]' '[:lower:]' | sed 's/\r$//')
+ lifecyclestate="(${lifecyclestate})"
+ else
+ lifecyclestate="INFO.yaml not found"
+ fi
+
+ getwikilifecyclestate ${project}
+ # returns value in ${return_from_getwikilifecyclestate}
+
+ #echo "DBUG: working dir is ...";pwd
+ #echo "DBUG: lifecycleproject=${lifecycleproject}"
+ #echo "DBUG: lifecyclestate=${lifecyclestate}"
+ #echo "DBUG: wikilifecyclestate=${return_from_getwikilifecyclestate}"
+
+ #check if YAML.info LC state is not empty _AND_ if WIKI LC state is not empty _AND_ if YAML.info LC state contains WIKI LC state
+ if [[ ${lifecyclestate} != "" ]] && [[ ${return_from_getwikilifecyclestate} != "" ]] && [[ ${lifecyclestate} == *"${return_from_getwikilifecyclestate}"* ]]; then
+ lcstatesmatch="match"
+ else
+ lcstatesmatch=""
+ fi
+
+ csv[i]="${csv[i]},${lifecyclestate},${return_from_getwikilifecyclestate},${lcstatesmatch}"
+ ((i++))
+ done
+ unset array
+ unset i
+ unset reponame
+ unset project
+ unset lifecycleproject
+ unset lifecyclestate
+ unset lcstatesmatch
+
+ #
+ # csv column #9: RELEASE component (yes|maybe|unknown)
# to be filled with values of the planned release config file maintained by
# the onap release manager
#
- # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
- readarray -t array < ./${branch}_gerritclone.log;
+ # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
+ readarray -t array < ./${branch}_repoclone.log;
i=0
csv[i]="${csv[i]},${branch_upper} component"
((i++))
for line in "${array[@]}"
do
- # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
+ # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
gitexitcode=$(echo $line | awk -F "|" '{print $1}');
reponame=$(echo $line | awk -F "|" '{print $2}');
repostate=$(echo $line | awk -F "|" '{print $3}');
if [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "0" ]]; then
releasecomponent="yes"
- elif [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "128" ]]; then
+ elif [ ${repostate} == "ACTIVE" ]; then
+ #elif [[ ${repostate} == "ACTIVE" && ${gitexitcode} == "128" ]]; then
releasecomponent="maybe"
+ elif [[ ${repostate} == "READ_ONLY" && ${gitexitcode} == "0" ]]; then
+ releasecomponent="yes"
elif [ ${repostate} == "READ_ONLY" ]; then
- releasecomponent="no"
+ releasecomponent="maybe"
else
releasecomponent="unknown"
fi
unset releasecomponent
#
- # csv column #6: docs (at repo root directory only; no recursive search!)
- # csv column #7: conf.py
- # csv column #8: tox.ini
- # csv column #9: index.rst
+ # csv column #10: docs (at repo root directory only; no recursive search!)
+ # csv column #11: conf.py
+ # csv column #12: tox.ini
+ # csv column #13: index.rst
#
# columns are filled with values from requested branch.
# if data is not available values from master branch are used.
- # to identify master branch values, data is put into brackets "(...)"
+ # to identify master branch values, data is put into round brackets "(...)"
#
readarray -t array < ./${repolist};
docs="${docs},-"
fi
- # tox.ini
- if [ -f ./${line}/docs/tox.ini ] ; then
+ # tox.ini (check docs dir and also check project root dir)
+ if [ -f ./${line}/docs/tox.ini ] || [ -f ./${line}/tox.ini ]; then
docs="${docs},tox.ini"
- elif [ -f ../master/${line}/docs/tox.ini ] ; then
- docs="${docs},(tox.ini)"
+ # tox.ini @ branch/docs dir
+ if [ -f ./${line}/docs/tox.ini ] ; then
+ docs="${docs} @docs"
+ fi
+ # tox.ini @ branch/project root dir
+ if [ -f ./${line}/tox.ini ] ; then
+ docs="${docs} @root"
+ fi
+ elif [ -f ../master/${line}/docs/tox.ini ] || [ -f ../master/${line}/tox.ini ]; then
+ docs="${docs},(tox.ini"
+ # tox.ini @ master/docs dir
+ if [ -f ../master/${line}/docs/tox.ini ] ; then
+ docs="${docs} @docs"
+ fi
+ # tox.ini @ master/project root dir
+ if [ -f ../master/${line}/tox.ini ] ; then
+ docs="${docs} @root"
+ fi
+ # just add a round bracket at the end of the value
+ docs="${docs})"
else
+ # no tox.ini found in docs or root dir
docs="${docs},-"
fi
unset docs
#
- # csv column #10: index.html@RTD accessibility check
- # csv column #11: index.html url
+ # csv column #14: index.html@RTD accessibility check
+ # csv column #15: index.html url
#
- readarray -t array < ./${branch}_gerritclone.log;
+ readarray -t array < ./${branch}_repoclone.log;
i=0
csv[i]="${csv[i]},index.html@RTD,index.html url"
((i++))
for line in "${array[@]}"
do
- # gerritclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
+ # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg
gitexitcode=$(echo $line | awk -F "|" '{print $1}');
reponame=$(echo $line | awk -F "|" '{print $2}');
repostate=$(echo $line | awk -F "|" '{print $3}');
url=""
curl_result=""
- # this routine works only with release "frankfurt" and later because
+ # this script works only with release "frankfurt" and later because
# earlier releases are using submodule structure for documentation files
if echo "$branch" | grep -q '^[abcde]'; then
curl_result="unsupported release"
else
# we are working on "frankfurt" branch or later ...
- # only if repostate IS ACTIVE a curl test is required
- if [[ ${repostate} == "ACTIVE" ]]; then
+ if [[ ${repostate} == "ACTIVE" ]] || [[ ${repostate} == "READ_ONLY" ]]; then
# OPTIONAL: USE ALSO GITEXITCODE AS A FILTER CRITERIA ???
fi
else
- # repostate IS NOT ACTIVE - no curl test required
+ # repostate IS NOT ACTIVE OR READ_ONLY - no curl test required
curl_result="-"
url="-"
fi
done
#
- # csv column #12: release notes
+ # csv column #16: release notes
#
readarray -t array < ../${repolist};
if [ -d ./${line} ] ; then
# if yes, check if repo name appears in the branch releasenotes.log
relnote=$(find "./${line}" -type f | grep 'release.*note.*.rst' | wc -l);
+ #echo "DBUG: relnote=${relnote}"
# repo dir DOES NOT exist in this branch - so check if repo dir exists in MASTER branch
elif [ -d ../master/${line} ] ; then
# if yes, check if repo name appears in the MASTER releasenotes.log
# count release notes files in MASTER branch (in repo root and its subdirectories)
relnote=$(find "../master/${line}" -type f | grep 'release.*note.*.rst' | wc -l);
+ #echo "DBUG: relnote=${relnote}"
# put results in round brackets to show that this is MASTER data
relnote=$(echo ${relnote} | sed -r s:${relnote}:\(${relnote}\):)
else
relnote="-"
fi
+ #echo "DBUG: relnote=${relnote}"
line="${csv[i]},${relnote}"
csv[i]=${line}
datadir=${branch}_data
mkdir $datadir
cp $repolist $datadir
+ cp $wikiplsfile $datadir
cp ${branch}_table.csv $datadir
cp ${branch}_*.log $datadir
zip -r ${datadir}.zip $datadir
--- /dev/null
+PROJECT;WIKI STATE;WIKI NAME
+aaf;unmaintained;Application Authorization Framework Project
+aai;mature;Active and Available Inventory Project
+appc;unmaintained;Application Controller Project
+ccsdk;mature;Common Controller SDK Project
+ci-management;incubation;CI-Management
+clamp;incubation;CLAMP Project
+cli;incubation;Command Line Interface Project
+cps;incubation;Configuration Persistence Service Project
+dcae;mature;Data Collection Analytics and Events Project
+dmaap;mature;Data Movement as a Platform Project
+doc;incubation;Documentation Project
+externalapi;mature;External API Framework Project
+holmes;incubation;Holmes Project
+integration;incubation;Integration Project
+logging-analytics;unmaintained;Logging Enhancements Project
+modeling;mature;Modeling Project
+msb;incubation;Microservices Bus Project
+multicloud;mature;Multi VIM/Cloud Project
+music;unmaintained;MUSIC Project
+oof;mature;Optimization Framework Project
+oom;incubation;ONAP Operations Manager Project
+policy;mature;Policy Framework Project
+portal;unmaintained;Portal Platform Project
+sdc;mature;Service Design & Creation Project
+sdnc;mature;Software Defined Network Controller Project
+so;mature;Service Orchestrator Project
+university;incubation;ONAP University Project
+uui;mature;Usecase UI Project
+vfc;mature;Virtual Function Controller Project
+vid;incubation;Virtual Infrastructure Deployment Project
+vnfrqts;incubation;VNF Requirements Project
+vnfsdk;incubation;VNF SDK Project
+vvp;incubation;VNF Validation Program Project
\ No newline at end of file
--- /dev/null
+PROJECT;WIKI STATE;WIKI NAME
+aaf;unmaintained;Application Authorization Framework Project
+aai;mature;Active and Available Inventory Project
+appc;unmaintained;Application Controller Project
+ccsdk;mature;Common Controller SDK Project
+ci-management;incubation;CI-Management
+clamp;incubation;CLAMP Project
+cli;incubation;Command Line Interface Project
+cps;incubation;Configuration Persistence Service Project
+dcaegen2;mature;Data Collection Analytics and Events Project
+dmaap;mature;Data Movement as a Platform Project
+doc;incubation;Documentation Project
+externalapi;mature;External API Framework Project
+holmes;incubation;Holmes Project
+integration;incubation;Integration Project
+logging-analytics;unmaintained;Logging Enhancements Project
+modeling;mature;Modeling Project
+msb;incubation;Microservices Bus Project
+multicloud;mature;Multi VIM/Cloud Project
+music;unmaintained;MUSIC Project
+optf;mature;Optimization Framework Project
+oom;incubation;ONAP Operations Manager Project
+policy;mature;Policy Framework Project
+portal;unmaintained;Portal Platform Project
+sdc;mature;Service Design & Creation Project
+sdnc;mature;Software Defined Network Controller Project
+so;mature;Service Orchestrator Project
+university;incubation;ONAP University Project
+usecase-ui;mature;Usecase UI Project
+vfc;mature;Virtual Function Controller Project
+vid;incubation;Virtual Infrastructure Deployment Project
+vnfrqts;incubation;VNF Requirements Project
+vnfsdk;incubation;VNF SDK Project
+vvp;incubation;VNF Validation Program Project
basepython = python3
deps = -r{toxinidir}/etc/requirements.txt
commands =
- sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+ sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
echo "Generated docs available in {toxinidir}/docs/_build/html"
whitelist_externals =
echo
deps = -r{toxinidir}/etc/requirements.txt
commands =
git submodule update --depth 100 --init
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+ sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
echo "Generated docs available in {toxinidir}/docs/_build/html"
whitelist_externals =
echo
[testenv:docs-linkcheck]
basepython = python3
deps = -r{toxinidir}/etc/requirements.txt
-commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
[testenv:spellcheck]
basepython = python3
Code Review / doc.git / commitdiff
