Uploaded image for project: 'VNF Requirements'
  1. VNF Requirements
  2. VNFRQTS-189

Change Management Requirements to include PNF

XMLWordPrintable

       

      Update the following requirements to reflect that they apply to PNFs as well as VNFs by changing VNF to xNF.

       

      The xNF MUST conform to the NETCONF RFC 5717, "Partial Lock Remote Procedure Call".
      The xNF MUST allow the entire configuration of the xNF to be retrieved via NETCONF's <get-config> and <edit-config>, independently of whether it was configured via NETCONF or other mechanisms.
      The xNF Package MUST include documentation describing all parameters that are available to monitor the xNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected for reporting purposes. The documentation must include a list of: •Monitoring parameters/counters exposed for virtual resource management and xNF application management. •KPIs and metrics that need to be collected at each VM for capacity planning and performance management purposes. •The monitoring parameters must include latencies, success rates, retry rates, load and quality (e.g., DPM) for the key transactions/functions supported by the xNF and those that must be exercised by the xNF in order to perform its function. •For each KPI, provide lower and upper limits. •When relevant, provide a threshold crossing alert point for each KPI and describe the significance of the threshold crossing. •For each KPI, identify the suggested actions that need to be performed when a threshold crossing alert event is recorded. •Describe any requirements for the monitoring component of tools for Network Cloud automation and management to provide these records to components of the xNF. •When applicable, provide calculators needed to convert raw data into appropriate reporting artifacts.
      The xNF Package MUST include documentation describing the fault, performance, capacity events/alarms and other event records that are made available by the xNF. The document must include: •A unique identification string for the specific xNF, a description of the problem that caused the error, and steps or procedures to perform Root Cause Analysis and resolve the issue. •All events, severity level (e.g., informational, warning, error) and descriptions including causes/fixes if applicable for the event. •All events (fault, measurement for xNF Scaling, Syslogs, State Change and Mobile Flow), that need to be collected at each VM, xNFC (defined in VNF Guidelines ) and for the overall xNF.
      The xNF MUST implement the protocol operation: lock(target) - Lock the configuration datastore target.
      The xNF MUST permit locking at the finest granularity if a xNF needs to lock an object for configuration to avoid blocking simultaneous configuration operations on unrelated objects (e.g., BGP configuration should not be locked out if an interface is being configured or entire Interface configuration should not be locked out if a non-overlapping parameter on the interface is being configured).
      The xNF MUST, by ONAP Policy, provide the ONAP addresses as data destinations for each xNF, and may be changed by Policy while the xNF is in operation. We expect the xNF to be capable of redirecting traffic to changed destinations with no loss of data, for example from one REST URL to another, or from one TCP host and port to another.
      The xNF MUST release locks to prevent permanent lock-outs when the corresponding <partial-unlock> operation succeeds.
      The xNF MUST conform to the NETCONF RFC 4742, "Using the NETCONF Configuration Protocol over Secure Shell (SSH)".
      The xNF provider MUST provide their testing scripts to support testing.
      The xNF MUST support get-schema (ietf-netconf-monitoring) to pull YANG model over session.
      The xNF MUST deliver asynchronous data as data becomes available, or according to the configured frequency.
      The xNF MUST support all operations, administration and management (OAM) functions available from the supplier for xNFs using the supplied YANG code and associated NETCONF servers.
      The xNF MUST conform to the NETCONF RFC 6241, "NETCONF Configuration Protocol".
      The xNF MAY use other options which are expected to include •REST delivery of binary encoded data sets. •TCP for high volume streaming asynchronous data sets and for other high volume data sets. TCP delivery can be used for either JSON or binary encoded data sets. •SFTP for asynchronous bulk files, such as bulk files that contain large volumes of data collected over a long time interval or data collected across many xNFs. This is not preferred. Preferred is to reorganize the data into more frequent or more focused data sets, and deliver these by REST or TCP as appropriate. •REST for synchronous data, using RESTCONF (e.g., for xNF state polling).
      The xNF SHOULD conform its YANG model to RFC 7223, "A YANG Data Model for Interface Management".
      The xNF MUST allow another NETCONF session to be able to initiate the release of the lock by killing the session owning the lock, using the <kill-session> operation to guard against hung NETCONF sessions.
      The xNF MUST conform its YANG model to RFC 6244, "An Architecture for Network Management Using NETCONF and YANG".
      The xNF MUST support parallel and simultaneous configuration of separate objects within itself.
      The xNF MUST implement the protocol operation: kill-session(session) - Force the termination of session.
      The xNF MUST respond with content encoded in JSON, as described in the RESTCONF specification. This way the encoding of a synchronous communication will be consistent with Avro.
      The xNF MUST fully support the XPath 1.0 specification for filtered retrieval of configuration and other database contents. The "type" attribute within the <filter> parameter for <get> and <get-config> operations may be set to "xpath". The "select" attribute (which contains the XPath expression) will also be supported by the server. A server may support partial XPath retrieval filtering, but it cannot advertise the :xpath capability unless the entire XPath 1.0 specification is supported.
      The xNF SHOULD conform its YANG model to RFC 7223, "IANA Interface Type YANG Module".
      The xNF provider MUST provide cookbooks to be loaded on the appropriate Chef Server.
      The xNF MUST conform to the NETCONF RFC 5277, "NETCONF Event Notification".
      The xNF MUST Upon completion of the chef-client run, POST back on the callback URL, a JSON object as described in Table A2 if the chef-client run list includes a cookbook/recipe that is callback capable. Failure to POST on the Callback Url should not be considered a critical error. That is, if the chef-client successfully completes the xNF action, it should reflect this status on the Chef Server regardless of whether the Callback succeeded or not.
      The xNF provider MUST provide configurable parameters (if unable to conform to YANG model) including xNF attributes/parameters and valid values, dynamic attributes and cross parameter dependencies (e.g., customer provisioning data).
      The xNF provider MUST provide a JSON file for each supported action for the xNF. The JSON file must contain key value pairs with all relevant values populated with sample data that illustrates its usage. The fields and their description are defined in Appendix B.
      The xNF provider MUST provide a JSON file for each supported action for the xNF. The JSON file must contain key value pairs with all relevant values populated with sample data that illustrates its usage. The fields and their description are defined in Appendix A.
      The xNF MUST implement the protocol operation: discard-changes() - Revert the candidate configuration datastore to the running configuration.
      The xNF MUST encode and serialize content delivered to ONAP using JSON (option 1). High-volume data is to be encoded and serialized using Avro, where Avro data format are described using JSON (option 2) [6]. •JSON plain text format is preferred for moderate volume data sets (option 1), as JSON has the advantage of having well-understood simple processing and being human-readable without additional decoding. Examples of moderate volume data sets include the fault alarms and performance alerts, heartbeat messages, measurements used for xNF scaling and syslogs. •Binary format using Avro is preferred for high volume data sets (option 2) such as mobility flow measurements and other high-volume streaming events (such as mobility signaling events or SIP signaling) or bulk data, as this will significantly reduce the volume of data to be transmitted. As of the date of this document, all events are reported using plain text JSON and REST. •Avro content is self-documented, using a JSON schema. The JSON schema is delivered along with the data content (http://avro.apache.org/docs/current/ ). This means the presence and position of data fields can be recognized automatically, as well as the data format, definition and other attributes. Avro content can be serialized as JSON tagged text or as binary. In binary format, the JSON schema is included as a separate data block, so the content is not tagged, further compressing the volume. For streaming data, Avro will read the schema when the stream is established and apply the schema to the received content.
      The xNF MUST implement at least one of the capabilities :candidate or :writable-running. If both :candidate and :writable-running are provided then two locks should be supported.
      The xNF MUST conform its YANG model to RFC 6470, "NETCONF Base Notifications".
      The xNF provider MUST provide documentation for the xNF Policy Description to manage the xNF runtime lifecycle. The document must include a description of how the policies (conditions and actions) are implemented in the xNF.
      The xNF SHOULD conform its YANG model to RFC 6536, "NETCONF Access Control Model".
      The xNF SHOULD conform its YANG model to RFC 7407, "A YANG Data Model for SNMP Configuration".
      The xNF PACKAGE MUST validated YANG code using the open source pyang [3] program using the following commands:
      The xNF MUST follow the data model upgrade rules defined in [RFC6020] section 10. All deviations from section 10 rules shall be handled by a built-in automatic upgrade mechanism.
      The xNF MUST support NETCONF server that can be mounted on OpenDaylight (client) and perform the following operations: •Modify, update, change, rollback configurations using each configuration data element. •Query each state (non-configuration) data element. •Execute each YANG RPC. •Receive data through each notification statement.
      The xNF Package MUST include a run list of roles/cookbooks/recipes, for each supported xNF action, that will perform the desired xNF action in its entirety as specified by ONAP (see Section 8.c, ONAP Controller APIs and Behavior, for list of xNF actions and requirements), when triggered by a chef-client run list in JSON file.
      The xNF provider MUST provide the binaries and images needed to instantiate the xNF (xNF and xNFC images).
      The xNF Package MUST include all relevant Chef artifacts (roles/cookbooks/recipes) required to execute xNF actions requested by ONAP for loading on appropriate Chef Server.
      The xNF provider MUST provide an XML file that contains a list of xNF error codes, descriptions of the error, and possible causes/corrective action.
      The xNF MUST conform its YANG model to RFC 6060, "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"
      The xNF MUST support :partial-lock and :partial-unlock capabilities, defined in RFC 5717. This allows multiple independent clients to each write to a different part of the <running> configuration at the same time.
      The xNF SHOULD implement the protocol operation: copy-config(target, source) - Copy the content of the configuration datastore source to the configuration datastore target.
      The xNF MUST implement the protocol operation: get-config(source, filter) - Retrieve a (filtered subset of a) configuration from the configuration datastore source.
      The xNF MUST support locking if a common object is being manipulated by two simultaneous NETCONF configuration operations on the same xNF within the context of the same writable running data store (e.g., if an interface parameter is being configured then it should be locked out for configuration by a simultaneous configuration operation on that same interface parameter).
      The xNF MUST conform its YANG model to RFC 6022, "YANG module for NETCONF monitoring".
      The xNF provider MUST provide a Resource/Device YANG model as a foundation for creating the YANG model for configuration. This will include xNF attributes/parameters and valid values/attributes configurable by policy.
      The xNF Package MUST have appropriate cookbooks that are designed to automatically "rollback" to the original state in case of any errors for actions that change state of the xNF (e.g., configure).
      The xNF MUST support the HealthCheck RPC. The HealthCheck RPC, executes a xNF providor-defined xNF Healthcheck over the scope of the entire xNF (e.g., if there are multiple xNFCs, then run a health check, as appropriate, for all xNFCs). It returns a 200 OK if the test completes. A JSON object is returned indicating state (healthy, unhealthy), scope identifier, time-stamp and one or more blocks containing info and fault information. If the xNF is unable to run the HealthCheck, return a standard http error code and message.
      The xNF MUST have routable FQDNs that are reachable via the Ansible Server for the endpoints (VMs) of a xNF on which playbooks will be executed. ONAP will initiate requests to the Ansible Server for invocation of playbooks against these end points [4].
      The xNF MUST NOT use any instance specific parameters in a playbook.
      The xNF MUST conform to the NETCONF RFC 4741, "NETCONF Configuration Protocol".
      The xNF SHOULD conform its YANG model to **RFC 6991, "Common YANG Data Types".
      The xNF MUST use the RESTCONF/NETCONF framework used by the ONAP configuration subsystem for synchronous communication.
      The xNF MUST must support SSH and allow SSH access to the Ansible server for the endpoint VM(s) and comply with the Network Cloud Service Provider guidelines for authentication and access.
      The xNF Package MUST include xNF topology that describes basic network and application connectivity internal and external to the xNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if applicable) for each interface.
      The xNF provider MUST provide documentation describing xNF Functional Capabilities that are utilized to operationalize the xNF and compose complex services.
      The xNF MUST accept all necessary instance specific data from the environment or node object attributes for the xNF in roles/cookbooks/recipes invoked for a xNF action.
      The xNF MUST make available (or load on xNF Ansible Server) playbooks that conform to the ONAP requirement.
      The xNF provider MUST enumerate all of the open source licenses their xNF(s) incorporate.
      The xNF MUST be able to specify the granularity of the lock via a restricted or full XPath expression.
      The xNF MUST respond to data requests from ONAP as soon as those requests are received, as a synchronous response.
      The xNF MUST support secure connections and transports.
      The xNF MUST use playbooks designed to allow Ansible Server to infer failure or success based on the "PLAY_RECAP" capability.
      The xNF SHOULD use "Modeling JSON text with YANG", https://trac.tools.ietf.org/id/draft-lhotka-netmod-yang-json-00.html, If YANG models need to be translated to and from JSON. YANG configuration and content can be represented via JSON, consistent with Avro, as described in "Encoding and Serialization" section.
      The xNF Package MUST include documentation describing the tests that were conducted by the xNF provider and the test results.
      The xNF MUST populate an attribute, defined as node["PushJobOutput"] with the desired output on all nodes in the push job that execute chef-client run if the xNF action requires the output of a chef-client run be made available (e.g., get running configuration).
      The xNF provider MUST agree to the process that can be met by Service Provider reporting infrastructure. The Contract shall define the reporting process and the available reporting tools.
      The xNF MUST implement the protocol operation: edit-config(target, default-operation, test-option, error-option, config) - Edit the target configuration datastore by merging, replacing, creating, or deleting new config elements.
      The xNF MUST control access to ONAP and to xNFs, and creation of connections, through secure credentials, log-on and exchange mechanisms.
      The xNF provider MUST NOT require additional infrastructure such as a xNF provider license server for xNF providor functions and metrics..
      The xNF MUST respond to an ONAP request to deliver granular data on device or subsystem status or performance, referencing the YANG configuration model for the xNF by returning the requested data elements.
      The xNF Package MUST include configuration scripts for boot sequence and configuration.
      The xNF MAY expose a single endpoint that is responsible for all functionality.
      The xNF MUST carry data in motion only over secure connections.
      The xNF provider MUST support the metadata about licenses (and their applicable entitlements) as defined in this document for xNF software, and any license keys required to authorize use of the xNF software. This metadata will be used to facilitate onboarding the xNF into the ONAP environment and automating processes for putting the licenses into use and managing the full lifecycle of the licenses. The details of this license model are described in Appendix C. Note: License metadata support in ONAP is not currently available and planned for 1Q 2018.
      The xNF Package MUST include documentation describing the characteristics for the xNF reliability and high availability.
      The xNF MUST utilize information from key value pairs that will be provided by the Ansible Server as extra-vars during invocation to execute the desired xNF action. If the playbook requires files, they must also be supplied using the methodology detailed in the Ansible Server API.
      The xNF SHOULD conform its YANG model to RFC 7277, "A YANG Data Model for IP Management".
      The xNF MUST implement :confirmed-commit If :candidate is supported.
      The xNF MUST support each xNF action by invocation of one playbook [7]. The playbook will be responsible for executing all necessary tasks (as well as calling other playbooks) to complete the request.
      The xNF MUST write to a specific set of text files that will be retrieved and made available by the Ansible Server If, as part of a xNF action (e.g., audit), a playbook is required to return any xNF information.
      The xNF SHOULD use playbooks that are designed to automatically "rollback" to the original state in case of any errors for actions that change state of the xNF (e.g., configure).
      The xNF MUST provide all telemetry (e.g., fault event records, syslog records, performance records etc.) to ONAP using the model, format and mechanisms described in this section.
      The xNF MUST apply locking based on the sequence of NETCONF operations, with the first configuration operation locking out all others until completed.
      The xNF MUST conform its YANG model to RFC 6087, "Guidelines for Authors and Reviewers of YANG Data Model Documents".
      The xNF MUST release locks to prevent permanent lock-outs when/if a session applying the lock is terminated (e.g., SSH session is terminated).
      The xNF MUST have Python >= 2.7 on the endpoint VM(s) of a xNF on which an Ansible playbook will be executed.
      The xNF Package MUST include documentation describing supported xNF scaling capabilities and capacity limits (e.g., number of users, bandwidth, throughput, concurrent calls).
      The xNF MUST implement the :with-defaults capability [RFC6243].
      The xNF provider MUST provide software components that can be packaged with/near the xNF, if needed, to simulate any functions or systems that connect to the xNF system under test. This component is necessary only if the existing testing environment does not have the necessary simulators.
      The xNF MUST implement the data model discovery and download as defined in [RFC6022].
      The xNF MUST implement the protocol operation: get(filter) - Retrieve (a filtered subset of) the running configuration and device state information. This should include the list of xNF supported schemas.
      The xNF MUST support sub tree filtering.
      The xNF MUST over-ride any default values for configurable parameters that can be set by ONAP in the roles, cookbooks and recipes.
      The xNF MUST allow all configuration data shall to be edited through a NETCONF <edit-config> operation. Proprietary NETCONF RPCs that make configuration changes are not sufficient.
      The xNF MUST release locks to prevent permanent lock-outs when a user configured timer has expired forcing the NETCONF SSH Session termination (i.e., product must expose a configuration knob for a user setting of a lock expiration timer)
      The xNF MUST have the echo command return a zero value otherwise the validation has failed
      The xNF SHOULD support callback URLs to return information to ONAP upon completion of the chef-client run for any chef-client run associated with a xNF action.
      The xNF Package MUST include xNF Identification Data to uniquely identify the resource for a given xNF provider. The identification data must include: an identifier for the xNF, the name of the xNF as was given by the xNF provider, xNF description, xNF provider, and version.
      The xNF MUST guarantee the xNF configuration integrity for all simultaneous configuration operations (e.g., if a change is attempted to the BUM filter rate from multiple interfaces on the same EVC, then they need to be sequenced in the xNF without locking either configuration method out).
      The xNF MUST be installed with: •Chef-Client >= 12.0 •Chef push jobs client >= 2.0
      The xNF MUST encrypt any content containing Sensitive Personal Information (SPI) or certain proprietary data, in addition to applying the regular procedures for securing access and delivery.
      The xNF MUST support the :url value to specify protocol operation source and target parameters. The capability URI for this feature will indicate which schemes (e.g., file, https, sftp) that the server supports within a particular URL value. The "file" scheme allows for editable local configuration databases. The other schemes allow for remote storage of configuration databases.
      The xNF MUST support the :startup capability. It will allow the running configuration to be copied to this special database. It can also be locked and unlocked.
      The xNF Package MUST include documentation describing xNF Management APIs. The document must include information and tools for: •ONAP to deploy and configure (initially and ongoing) the xNF application(s) (e.g., NETCONF APIs). Includes description of configurable parameters for the xNF and whether the parameters can be configured after xNF instantiation. •ONAP to monitor the health of the xNF (conditions that require healing and/or scaling responses). Includes a description of: •Parameters that can be monitored for the xNF and event records (status, fault, flow, session, call, control plane, etc.) generated by the xNF after instantiation. •Runtime lifecycle events and related actions (e.g., control responses, tests) which can be performed for the xNF.
      The xNF MUST respond to an ONAP request to deliver the current data for any of the record types defined in Section 8.d "Data Model for Event Records" by returning the requested record, populated with the current field values. (Currently the defined record types include the common header record, technology independent records such as Fault, Heartbeat, State Change, Syslog, and technology specific records such as Mobile Flow, Signaling and Voice Quality records. Additional record types will be added in the future as they are standardized and become available.)
      The xNF MUST implement the protocol operation: commit(confirmed, confirm-timeout) - Commit candidate configuration datastore to the running configuration.
      The xNF MUST have routable FQDNs for all the endpoints (VMs) of a xNF that contain chef-clients which are used to register with the Chef Server. As part of invoking xNF actions, ONAP will trigger push jobs against FQDNs of endpoints for a xNF, if required.
      The xNF MUST must encode the delivered data using JSON or Avro, addressed and delivered as described in the previous paragraphs.
      The xNF MUST allow the NETCONF server connection parameters to be configurable during virtual machine instantiation through Heat templates where SSH keys, usernames, passwords, SSH service and SSH port numbers are Heat template parameters.
      The xNF provider MUST provide an artifact per xNF that contains all of the xNF Event Records supported. The artifact should include reference to the specific release of the xNF Event Stream Common Event Data Model document it is based on. (e.g., VES Event Listener)
      The xNF provider MUST provide playbooks to be loaded on the appropriate Ansible Server.
      The xNF MUST update status on the Chef Server appropriately (e.g., via a fail or raise an exception) if the chef-client run encounters any critical errors/failures when executing a xNF action.
      The xNF MUST conform to the NETCONF RFC 6242, "Using the Network Configuration Protocol over Secure Shell".
      The xNF MUST have the chef-client be preloaded with validator keys and configuration to register with the designated Chef Server as part of the installation process.
      The xNF MUST support heartbeat via a <get> with null filter.
      The xNF MUST implement the :validate capability
      The xNF MUST support :rollback-on-error value for the <error-option> parameter to the <edit-config> operation. If any error occurs during the requested edit operation, then the target database (usually the running configuration) will be left affected. This provides an "all-or-nothing" edit mode for a single <edit-config> request.
      The xNF Package MUST include documentation describing xNF Functional APIs that are utilized to build network and application services. This document describes the externally exposed functional inputs and outputs for the xNF, including interface format and protocols supported.
      The xNF MUST have the capability of maintaining a primary and backup DNS name (URL) for connecting to ONAP collectors, with the ability to switch between addresses based on conditions defined by policy such as time-outs, and buffering to store messages until they can be delivered. At its discretion, the service provider may choose to populate only one collector address for a xNF. In this case, the network will promptly resolve connectivity problems caused by a collector or network failure transparently to the xNF.
      The xNF MUST provide metrics (e.g., number of sessions, number of subscribers, number of seats, etc.) to ONAP for tracking every license.
      The xNF provider MUST provide a universal license key per xNF to be used as needed by services (i.e., not tied to a VM instance) as the recommended solution. The xNF provider may provide pools of Unique xNF License Keys, where there is a unique key for each xNF instance as an alternate solution. Licensing issues should be resolved without interrupting in-service xNFs.
      The xNF SHOULD conform its YANG model to RFC 7317, "A YANG Data Model for System Management".
      The xNF SHOULD implement the NETCONF Event Notifications [RFC5277].
      The xNF MUST include a NETCONF server enabling runtime configuration and lifecycle management capabilities.
      The xNF SHOULD implement the protocol operation: delete-config(target) - Delete the named configuration datastore target.
      The xNF SHOULD use REST using HTTPS delivery of plain text JSON for moderate sized asynchronous data sets, and for high volume data sets when feasible.
      The xNF MUST support simultaneous <commit> operations within the context of this locking requirements framework.
      The xNF MUST support and provide artifacts for configuration management using at least one of the following technologies: •Netconf/YANG •Chef •Ansible
      The xNF MUST implement the protocol operation: close-session()- Gracefully close the current session.
      The xNF MUST define all data models in YANG [RFC6020], and the mapping to NETCONF shall follow the rules defined in this RFC.
      The xNF MUST provide a NETCONF interface fully defined by supplied YANG models for the embedded NETCONF server.
      The xNF MUST implement the protocol operation: unlock(target) - Unlock the configuration datastore target.
      The xNF provider MUST NOT require audits of Service Provider's business.
      The xNF SHOULD implement the protocol operation: get-schema(identifier, version, format) - Retrieve the YANG schema.
      The xNF MUST vary the frequency that asynchronous data is delivered based on the content and how data may be aggregated or grouped together. For example, alarms and alerts are expected to be delivered as soon as they appear. In contrast, other content, such as performance measurements, KPIs or reported network signaling may have various ways of packaging and delivering content. Some content should be streamed immediately; or content may be monitored over a time interval, then packaged as collection of records and delivered as block; or data may be collected until a package of a certain size has been collected; or content may be summarized statistically over a time interval, or computed as a KPI, with the summary or KPI being delivered. ◦We expect the reporting frequency to be configurable depending on the virtual network function’s needs for management. For example, Service Provider may choose to vary the frequency of collection between normal and trouble-shooting scenarios. ◦Decisions about the frequency of data reporting will affect the size of delivered data sets, recommended delivery method, and how the data will be interpreted by ONAP. These considerations should not affect deserialization and decoding of the data, which will be guided by the accompanying JSON schema or GPB definition files.
      The xNF provider MUST provide information regarding any dependency (e.g., affinity, anti-affinity) with other xNFs and resources.
      The xNF MUST NOT use any instance specific parameters for the xNF in roles/cookbooks/recipes invoked for a xNF action.

            hp1256 hp1256
            hp1256 hp1256
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: