diff options
Diffstat (limited to 'docs/Chapter7')
| -rwxr-xr-x | docs/Chapter7/Monitoring-And-Management.rst | 95 | ||||
| -rw-r--r-- | docs/Chapter7/PNF-Plug-and-Play.rst | 181 |
2 files changed, 174 insertions, 102 deletions
diff --git a/docs/Chapter7/Monitoring-And-Management.rst b/docs/Chapter7/Monitoring-And-Management.rst index d622b5a..8ff1eb3 100755 --- a/docs/Chapter7/Monitoring-And-Management.rst +++ b/docs/Chapter7/Monitoring-And-Management.rst @@ -21,9 +21,9 @@ is directly dependent on the interfaces provided by the xNFs’ APIs. These can be in the form of asynchronous interfaces for event, fault notifications, and autonomous data streams. They can also be synchronous interfaces for on-demand requests to retrieve various performance, usage, and other event information. -It should be understood that events are well structured packages of information, -identified by an eventName, which are communicated to subscribers who are -interested in the eventName. Events are simply a way of communicating +It should be understood that events are well structured packages of +information, identified by an eventName, which are communicated to subscribers +who are interested in the eventName. Events are simply a way of communicating well-structured packages of information to one or more instances of an Event Listener service. @@ -45,15 +45,17 @@ Data Model for Event Records This section describes the data model for the collection of telemetry data from xNFs by Service Providers (SPs) to manage xNF health and run-time life cycle. -This data model is referred to as the VES Data Model. The VES acronym originally -stood for Virtual-function Event Streaming, but VES has been generalized to -support network-function event streaming, whether virtualized or not. +This data model is referred to as the VES Data Model. The VES acronym +originally stood for Virtual-function Event Streaming, but VES has been +generalized to support network-function event streaming, whether virtualized or +not. The VES Data Model describes a vendor-agnostic common vocabulary of event payloads. Vendor-specific, product-specific or service-specific data is -supported by the inclusion of a flexible additional information field structure. -The VES Data Models' common vocabulary is used to drive standard and automated -data analytics (policy-driven analytics) within the ONAP DCAE Framework. +supported by the inclusion of a flexible additional information field +structure. The VES Data Models' common vocabulary is used to drive +standard and automated data analytics (policy-driven analytics) within the +ONAP DCAE Framework. While this document is focused on specifying some of the records from the ONAP perspective, there may be other external bodies using the same framework to @@ -64,10 +66,10 @@ network devices, etc.) and virtual infrastructure managers (cloud controllers, SDN controllers). It uses ONAP’s VES Agent to generate VES events from the xNF and Intel’s collectD agent to generate infrastructure VES events. Note that any configurable parameters for these data records (e.g., frequency, granularity, -policy-based configuration) will be managed using the “Configuration” framework -described in the prior sections of this document. The infrastructure metrics have -been funneled via the ONAP Multi-VIM Project and are now included in current -specifications. +policy-based configuration) will be managed using the "Configuration" framework +described in the prior sections of this document. The infrastructure metrics +have been funneled via the ONAP Multi-VIM Project and are now included in +current specifications. The Data Model consists of: @@ -76,24 +78,25 @@ The Data Model consists of: * Technology Independent Records: This version of the document specifies the model for Fault, Heartbeat, Measurements, Notification, pnfRegistration, - State Change, Syslog, and Threshold Crossing Alerts records. In the future, - these may be extended to support other types of technology independent - records (work is currently progressing to define a new Performance Domain - that would be able to support already defined 3GPP Metrics for xNF, e.g. - 5G RAN device Use Case in Casablanca). Each of these records allows - additional fields (name/ value pairs) for extensibility. The xNF provider - may use these xNF provider-specific additional fields to provide additional - information that may be relevant to the managing systems. + State Change, Syslog, and Threshold Crossing Alerts records. In the + future, these may be extended to support other types of technology + independent records (work is currently progressing to define a new + Performance Domain that would be able to support already defined 3GPP + Metrics for xNF, e.g. 5G RAN device Use Case in Casablanca). Each of + these records allows additional fields (name/ value pairs) for + extensibility. The xNF provider may use these xNF provider-specific + additional fields to provide additional information that may be relevant + to the managing systems. * Technology Specific Records: This version of the document specifies the - model for Mobile Flow records, Signaling and Voice Quality records. In the - future, these may be extended to support other types of records (e.g. - Network Fabric, Security records, etc.). Each of these records allows - additional fields (name/value pairs) for extensibility. The xNF provider - can use these xNF-specific additional fields to provide additional - information that may be relevant to the managing systems. A placeholder for - additional technology specific areas of interest to be defined in the - future documents has been depicted. + model for Mobile Flow records, Signaling and Voice Quality records. + In the future, these may be extended to support other types of records + (e.g. Network Fabric, Security records, etc.). Each of these records + allows additional fields (name/value pairs) for extensibility. The xNF + provider can use these xNF-specific additional fields to provide + additional information that may be relevant to the managing systems. + A placeholder for additional technology specific areas of interest to + be defined in the future documents has been depicted. |image0| @@ -163,13 +166,14 @@ independent event records: etc. * ``Heartbeat`` - the Heartbeat Record provides an optional structure for - communicating information about device health. Heartbeat records would only - have the Common Event Header block. An optional heartbeat domain is - available to specify information such as heartbeat interval and recommended - action upon missing heartbeat interval. Heartbeat avoids the need to ping - a device. A communication failure can be determined via missing heartbeat - events being delivered to DCAE and appropriate action (e.g. restart VM, - rebuild xNF or create ticket) can be taken by DCAE CLAMP. + communicating information about device health. Heartbeat records would + only have the Common Event Header block. An optional heartbeat domain is + available to specify information such as heartbeat interval and + recommended action upon missing heartbeat interval. Heartbeat avoids the + need to ping a device. A communication failure can be determined via + missing heartbeat events being delivered to DCAE and appropriate action + (e.g. restart VM, rebuild xNF or create ticket) can be taken by DCAE + CLAMP. * ``Measurements`` - the Measurements Record contains information about xNF and xNF resource structure and its condition to help in the management of @@ -195,9 +199,10 @@ independent event records: domain ideas.) * ``pnfRegistration`` - the pnfRegistration Record provides a structure for - registration of a physical network function. The pnfRegistration Record can - contain information about attributes related to the physical network function - including serial number, software revision, unit type and vendor name. + registration of a physical network function. The pnfRegistration Record + can contain information about attributes related to the physical network + function including serial number, software revision, unit type and vendor + name. * ``State Change`` - the State Change Record provides a structure for communicating information about data flow through the xNF. The State @@ -327,10 +332,10 @@ Data Structure Specification of the Event Record conditions repeat within a specified time interval, using the semantics and syntax described by the :doc:`VES Event Registration specification<../../../../vnfsdk/module.git/files/VESEventRegistration_3_0>`. -**NOTE:** The Service Provider may override xNF provider Event Registrations using -the ONAP SDC Design Studio to finalizes Service Provider engineering rules -for the processing of the xNF events. These changes may modify any of the -following: +**NOTE:** The Service Provider may override xNF provider Event +Registrations using the ONAP SDC Design Studio to finalizes Service +Provider engineering rules for the processing of the xNF events. +These changes may modify any of the following: * Threshold levels * Specified actions related to conditions @@ -461,8 +466,8 @@ xNF Telemetry using Google Protocol Buffers Figure 3. xNF Telemetry using Google Protocol Buffers -**NOTE:** For high-volume xNF telemetry, native (binary) Google Protocol Buffers -(GPB) is the preferred serialization method. While supporting the GPB +**NOTE:** For high-volume xNF telemetry, native (binary) Google Protocol +Buffers (GPB) is the preferred serialization method. While supporting the GPB telemetry delivery approach described above, the default delivery method is the VES/REST JSON based model in DCAE. The purpose of the diagram above is to illustrate the GPB delivery concept only and not to imply a specific diff --git a/docs/Chapter7/PNF-Plug-and-Play.rst b/docs/Chapter7/PNF-Plug-and-Play.rst index 8a23af6..78c25d1 100644 --- a/docs/Chapter7/PNF-Plug-and-Play.rst +++ b/docs/Chapter7/PNF-Plug-and-Play.rst @@ -1,4 +1,3 @@ - .. Modifications Copyright © 2017-2018 AT&T Intellectual Property. .. Licensed under the Creative Commons License, Attribution 4.0 Intl. @@ -24,117 +23,157 @@ The following are the requirements related to PNF Plug and Play. .. req:: :id: R-56718 - :target: XNF + :target: PNF :keyword: MAY :introduced: casablanca - The PNF Vendor **MAY** (optional) provide software Version(s) to be supported by PNF for SDC Design Studio PNF Model. This is set in the PNF Model property software_versions. + The PNF Vendor **MAY** provide software version(s) to be supported by PNF + for SDC Design Studio PNF Model. This is set in the PNF Model property + software_versions. .. req:: :id: R-106240 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - The following VES Events **MUST** be supported by the PNF: pnfRegistration VES Event, HVol VES Event, and Fault VES Event. These are onboarded via the SDC Design Studio. - Note: these VES Events are emitted from the PNF to support PNF Plug and Play, High Volume Measurements, and Fault events respectively." + The following VES Events **MUST** be supported by the PNF: pnfRegistration + VES Event, HVol VES Event, and Fault VES Event. These are onboarded via + he SDC Design Studio. + + Note: these VES Events are emitted from the PNF to support PNF Plug and + Play, High Volume Measurements, and Fault events respectively. .. req:: :id: R-258352 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - The PNF **MUST** support & accept the provisioning of an ONAP contact IP address (in IPv4 or IPv6 format). - Note: For example, it a possibility is that an external EMS would configure & provision the ONAP contact IP address to the PNF (in either IPv4 or IPv6 format). For the PNF Plug and Play Use Case, this IP address is the service provider's ""point of entry"" to the DCAE VES Listener. + The PNF **MUST** support & accept the provisioning of an ONAP contact IP + address (in IPv4 or IPv6 format). + + Note: For example, it a possibility is that an external EMS would configure + & provision the ONAP contact IP address to the PNF (in either IPv4 or + IPv6 format). For the PNF Plug and Play Use Case, this IP address is the + service provider's "point of entry" to the DCAE VES Listener. - Note: different service provider's network architecture may also require special setup to allow an external PNF to contact the ONAP installation. For example, in the AT&T network, a maintenance tunnel is used to access ONAP. + Note: different service provider's network architecture may also require + special setup to allow an external PNF to contact the ONAP installation. + For example, in the AT&T network, a maintenance tunnel is used to access + ONAP. .. req:: :id: R-793716 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - The PNF **MUST** have ""ONAP Aware"" software which is capable of performing PNF PnP registration with ONAP. The ""ONAP Aware"" software is capable of performing the PNF PnP Registration with ONAP MUST either be loaded separately or integrated into the PNF software upon physical delivery and installation of the PNF. + The PNF **MUST** have "ONAP Aware" software which is capable of performing + PNF PnP registration with ONAP. The "ONAP Aware" software is capable of + performing the PNF PnP Registration with ONAP MUST either be loaded + separately or integrated into the PNF software upon physical delivery + and installation of the PNF. - Note: It is up to the specific vendor to design the software management functions. " + Note: It is up to the specific vendor to design the software management + functions. .. req:: :id: R-01427 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - - The PNF **MUST** support the provisioning of security and authentication parameters (HTTP username and password) in order to be able to authenticate with DCAE (in ONAP). - Note: In R3, a username and password are used with the DCAE VES Event Listener which are used for HTTP Basic Authentication. + The PNF **MUST** support the provisioning of security and authentication + parameters (HTTP username and password) in order to be able to authenticate + with DCAE (in ONAP). - Note: The configuration management and provisioning software are specific to a vendor architecture. " + Note: In R3, a username and password are used with the DCAE VES Event + Listener which are used for HTTP Basic Authentication. + + Note: The configuration management and provisioning software are specific + to a vendor architecture. .. req:: :id: R-894004 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - When the PNF sets up a HTTP or HTTPS connection, it **MUST** provide a username and password to the DCAE VES Collector for HTTP Basic Authentication. + When the PNF sets up a HTTP or HTTPS connection, it **MUST** provide a + username and password to the DCAE VES Collector for HTTP Basic + Authentication. - Note: HTTP Basic Authentication has 4 steps: Request, Authenticate, Authorization with Username/Password Credentials, and Authentication Status as per RFC7617 and RFC 2617 + Note: HTTP Basic Authentication has 4 steps: Request, Authenticate, + Authorization with Username/Password Credentials, and Authentication Status + as per RFC7617 and RFC 2617. .. req:: :id: R-952314 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - If the PNF set up a TLS connection and mutual (two-way) authentication is being used, then the PNF **MUST** provide its own X.509v3 Certificate to the DCAE VES Collector for authentication. + If the PNF set up a TLS connection and mutual (two-way) authentication is + being used, then the PNF **MUST** provide its own X.509v3 Certificate to + the DCAE VES Collector for authentication. - Note: This allows TLS authentication by DCAE VES Collector.. + Note: This allows TLS authentication by DCAE VES Collector. - Note: The PNF got its X.509 certificate through Enrollment with an operator certificate authority or a X.509 vendor certificate from the vendor factory CA. + Note: The PNF got its X.509 certificate through Enrollment with an + operator certificate authority or a X.509 vendor certificate from the + vendor factory CA. Note: In R3 three authentication options are supported: - (1) HTTP with Username & Password and no TLS + (1) HTTP with Username & Password and no TLS. - (2) HTTP with Username & Password & TLS with two-way certificate authentication; + (2) HTTP with Username & Password & TLS with two-way certificate + authentication. - (3) HTTP with Username & Password & TLS with server-side certificate authentication." + (3) HTTP with Username & Password & TLS with server-side + certificate authentication. .. req:: :id: R-809261 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca The PNF **MUST** use a IP address to contact ONAP. - Note: it is expected that an ONAP operator can ascertain the ONAP IP address or the security gateway to reach ONAP on the VID or ONAP portal GUI. Note: The ONAP contact IP address has been previously configured and provisioned prior to this step. + Note: it is expected that an ONAP operator can ascertain the ONAP IP + address or the security gateway to reach ONAP on the VID or ONAP portal + GUI. + + Note: The ONAP contact IP address has been previously configured and + provisioned prior to this step. - Note: The ONAP IP address could be provisioned or resolved through FQDN & DNS. + Note: The ONAP IP address could be provisioned or resolved through + FQDN & DNS. .. req:: :id: R-763774 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - The PNF **MUST** support a HTTPS connection to the DCAE VES Event Listener. + The PNF **MUST** support a HTTPS connection to the DCAE VES Event + Listener. .. req:: :id: R-579051 - :target: XNF + :target: PNF :keyword: MAY :introduced: casablanca The PNF **MAY** support a HTTP connection to the DCAE VES Event Listener. - Note: HTTP is allowed but not recommended." + Note: HTTP is allowed but not recommended. .. req:: :id: R-686466 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca @@ -142,7 +181,7 @@ The following are the requirements related to PNF Plug and Play. .. req:: :id: R-980039 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca @@ -150,69 +189,97 @@ The following are the requirements related to PNF Plug and Play. .. req:: :id: R-981585 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca The pnfRegistration VES event periodicity **MUST** be configurable. - Note: The PNF uses the service configuration request as a semaphore to stop sending the pnfRegistration sent. See the requirement PNP-5360 requirement." + Note: The PNF uses the service configuration request as a semaphore to + stop sending the pnfRegistration sent. See the requirement PNP-5360 + requirement. .. req:: :id: R-284934 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - If the PNF encounters an error authenticating, reaching the ONAP DCAE VES Event listener or recieves an error response from sending the pnfRegistration VES Event, it **MAY** log the error, and notify the operator. + If the PNF encounters an error authenticating, reaching the ONAP DCAE VES + Event listener or recieves an error response from sending the pnfRegistration + VES Event, it **MAY** log the error, and notify the operator. - Note: the design of how errors are logged, retrieved and reported will be a vendor-specific architecture. Reporting faults and errors is also a vendor specific design. It is expected that the PNF shall have a means to log an error and notify a user when a fault condition occurs in trying to contact ONAP, authenticate or send a pnfRegistration event." + Note: the design of how errors are logged, retrieved and reported + will be a vendor-specific architecture. Reporting faults and errors + is also a vendor specific design. It is expected that the PNF shall + have a means to log an error and notify a user when a fault condition + occurs in trying to contact ONAP, authenticate or send a pnfRegistration + event. .. req:: :id: R-256347 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - The PNF **MUST** support the Ansible protocol for a Service Configuration message exchange between the PNF and PNF Controller (in ONAP). + The PNF **MUST** support the Ansible protocol for a Service Configuration + message exchange between the PNF and PNF Controller (in ONAP). - Note: this exchange may be either Ansible, Chef, or NetConf depending on the PNF. Note: The PNF Controller may be VF-C, APP-C or SDN-C based on the PNF and PNF domain. Note: for R3 (Casablanca) only Ansible is supported." + Note: this exchange may be either Ansible, Chef, or NetConf depending on + the PNF. Note: The PNF Controller may be VF-C, APP-C or SDN-C based on the + PNF and PNF domain. Note: for R3 (Casablanca) only Ansible is supported. .. req:: :id: R-707977 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - When the PNF receives a Service configuration from ONAP, the PNF **MUST** cease sending the pnfRegistration VES Event. + When the PNF receives a Service configuration from ONAP, the PNF **MUST** + cease sending the pnfRegistration VES Event. .. req:: :id: R-17624 - :target: XNF + :target: PNF :keyword: MAY :introduced: casablanca - The PNF **MAY** support the optional parameters for Service Configuration Parameters. + The PNF **MAY** support the optional parameters for Service + Configuration Parameters. - Note: These are detailed in the Stage 5 PnP + Note: These are detailed in the Stage 5 PnP - Note: These parameters are optional, and not all PNFs will support any or all of these parameters, it is up to the vendor and service provider to ascertain which ones are supported up to an including all of the ones that have been defined. Note: It is expected that there will be a growing list of supported configuration parameters in future releases of ONAP." + Note: These parameters are optional, and not all PNFs will support any + or all of these parameters, it is up to the vendor and service provider + to ascertain which ones are supported up to an including all of the ones + that have been defined. Note: It is expected that there will be a growing + list of supported configuration parameters in future releases of ONAP. .. req:: :id: R-378131 - :target: XNF + :target: PNF :keyword: MAY :introduced: casablanca - (Error Case) - If an error is encountered by the PNF during a Service Configuration exchange with ONAP, the PNF **MAY** log the error and notify an operator. + (Error Case) - If an error is encountered by the PNF during a + Service Configuration exchange with ONAP, the PNF **MAY** log the + error and notify an operator. .. req:: :id: R-638216 - :target: XNF + :target: PNF :keyword: MUST :introduced: casablanca - (Error Case) - The PNF **MUST** support a configurable timer to stop the periodicity sending of the pnfRegistration VES event. If this timer expires during a Service Configuration exchange between the PNF and ONAP, it MAY log a time-out error and notify an operator. - - Note: It is expected that each vendor will enforce and define a PNF service configuration timeout period. This is because the PNF cannot wait indefinitely as there may also be a technician on-site trying to complete installation & commissioning. The management of the VES event exchange is also a requirement on the PNF to be developed by the PNF vendor." + (Error Case) - The PNF **MUST** support a configurable timer to stop the + periodicity sending of the pnfRegistration VES event. If this timer expires + during a Service Configuration exchange between the PNF and ONAP, it + MAY log a time-out error and notify an operator. + + Note: It is expected that each vendor will enforce and define a PNF + service configuration timeout period. This is because the PNF cannot + wait indefinitely as there may also be a technician on-site trying to + complete installation & commissioning. The management of the VES event + exchange is also a requirement on the PNF to be developed by the PNF + vendor. |