diff options
Diffstat (limited to 'docs')
32 files changed, 11320 insertions, 9320 deletions
diff --git a/docs/Chapter1.rst b/docs/Chapter1/index.rst index 4451c1d..a0b917e 100644 --- a/docs/Chapter1.rst +++ b/docs/Chapter1/index.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. - Purpose ======= + - The purpose of these requirements is to accelerate adoption of xNF best practices which will increase innovation, minimize customization needed to onboard xNFs as well as reduce implementation complexity, time and cost diff --git a/docs/Chapter2.rst b/docs/Chapter2/index.rst index c33c5c5..eab491d 100644 --- a/docs/Chapter2.rst +++ b/docs/Chapter2/index.rst @@ -5,6 +5,7 @@ Scope ===== + - The audience for this document are xNF providers, NCSPs and other interested 3rd parties who need to know the design, build and lifecycle management requirements for xNFs to be compliant with ONAP. @@ -63,4 +64,3 @@ To report issues on this document, please perform one of the following steps: to the onap-discuss email discussion list. Refer to the following instructions to subscribe to the mail list: https://wiki.onap.org/display/DW/Mailing+Lists - diff --git a/docs/Chapter3.rst b/docs/Chapter3/index.rst index a018721..84802f7 100644 --- a/docs/Chapter3.rst +++ b/docs/Chapter3/index.rst @@ -5,6 +5,7 @@ Introduction ============ + - These requirements are specific to the current release of ONAP. It is the initial release of requirements based on a merge of the Open-O and OpenECOMP requirements. @@ -42,4 +43,3 @@ Introduction formats. It also contains a list of the requirements that are listed in the other chapters as well as examples and models that are referenced throughout the rest of the chapters. - diff --git a/docs/Chapter4.rst b/docs/Chapter4.rst deleted file mode 100644 index 89df784..0000000 --- a/docs/Chapter4.rst +++ /dev/null @@ -1,1384 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - - -VNF Development Requirements -============================ - -VNF Design ----------- - -Services are composed of VNFs and common components and are designed to -be agnostic of the location to leverage capacity where it exists in the -Network Cloud. VNFs can be instantiated in any location that meets the -performance and latency requirements of the service. - -A key design principle for virtualizing services is decomposition of -network functions using NFV concepts into granular VNFs. This enables -instantiating and customizing only essential functions as needed for the -service, thereby making service delivery more nimble. It provides -flexibility of sizing and scaling and also provides flexibility with -packaging and deploying VNFs as needed for the service. It enables -grouping functions in a common cloud data center to minimize -inter-component latency. The VNFs should be designed with a goal of -being modular and reusable to enable using best-in-breed vendors. - -Section 5.a VNF Design in *VNF Guidelines* describes -the overall guidelines for designing VNFs from VNF Components (VNFCs). -Below are more detailed requirements for composing VNFs. - -VNF Design Requirements - -* R-58421 The VNF **SHOULD** be decomposed into granular re-usable VNFCs. -* R-82223 The VNF **MUST** be decomposed if the functions have - significantly different scaling characteristics (e.g., signaling - versus media functions, control versus data plane functions). -* R-16496 The VNF **MUST** enable instantiating only the functionality that - is needed for the decomposed VNF (e.g., if transcoding is not needed it - should not be instantiated). -* R-02360 The VNFC **MUST** be designed as a standalone, executable process. -* R-34484 The VNF **SHOULD** create a single component VNF for VNFCs - that can be used by other VNFs. -* R-23035 The VNF **MUST** be designed to scale horizontally (more - instances of a VNF or VNFC) and not vertically (moving the existing - instances to larger VMs or increasing the resources within a VM) - to achieve effective utilization of cloud resources. -* R-30650 The VNF **MUST** utilize cloud provided infrastructure and - VNFs (e.g., virtualized Local Load Balancer) as part of the VNF so - that the cloud can manage and provide a consistent service resiliency - and methods across all VNF's. -* R-12709 The VNFC **SHOULD** be independently deployed, configured, - upgraded, scaled, monitored, and administered by ONAP. -* R-37692 The VNFC **MUST** provide API versioning to allow for - independent upgrades of VNFC. -* R-86585 The VNFC **SHOULD** minimize the use of state within - a VNFC to facilitate the movement of traffic from one instance - to another. -* R-65134 The VNF **SHOULD** maintain state in a geographically - redundant datastore that may, in fact, be its own VNFC. -* R-75850 The VNF **SHOULD** decouple persistent data from the VNFC - and keep it in its own datastore that can be reached by all instances - of the VNFC requiring the data. -* R-88199 The VNF **MUST** utilize a persistent datastore service that - can meet the data performance/latency requirements. (For example: - Datastore service could be a VNFC in VNF or a DBaaS in the Cloud - execution environment) -* R-99656 The VNF **MUST** NOT terminate stable sessions if a VNFC - instance fails. -* R-84473 The VNF **MUST** enable DPDK in the guest OS for VNF’s requiring - high packets/sec performance. High packet throughput is defined as greater - than 500K packets/sec. -* R-54430 The VNF **MUST** use the NCSP’s supported library and compute - flavor that supports DPDK to optimize network efficiency if using DPDK. [1]_ -* R-18864 The VNF **MUST** NOT use technologies that bypass virtualization - layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary - to meet functional or performance requirements). -* R-64768 The VNF **MUST** limit the size of application data packets - to no larger than 9000 bytes for SDN network-based tunneling when - guest data packets are transported between tunnel endpoints that - support guest logical networks. -* R-74481 The VNF **MUST** NOT require the use of a dynamic routing - protocol unless necessary to meet functional requirements. - -VNF Resiliency -------------------------- - -The VNF is responsible for meeting its resiliency goals and must factor -in expected availability of the targeted virtualization environment. -This is likely to be much lower than found in a traditional data center. -Resiliency is defined as the ability of the VNF to respond to error -conditions and continue to provide the service intended. A number of -software resiliency dimensions have been identified as areas that should -be addressed to increase resiliency. As VNFs are deployed into the -Network Cloud, resiliency must be designed into the VNF software to -provide high availability versus relying on the Network Cloud to achieve -that end. - -Section 5.a Resiliency in *VNF Guidelines* describes -the overall guidelines for designing VNFs to meet resiliency goals. -Below are more detailed resiliency requirements for VNFs. - -All Layer Redundancy -^^^^^^^^^^^^^^^^^^^^^^ - -Design the VNF to be resilient to the failures of the underlying -virtualized infrastructure (Network Cloud). VNF design considerations -would include techniques such as multiple vLANs, multiple local and -geographic instances, multiple local and geographic data replication, -and virtualized services such as Load Balancers. - - -All Layer Redundancy Requirements - -* R-52499 The VNF **MUST** meet their own resiliency goals and not rely - on the Network Cloud. -* R-42207 The VNF **MUST** design resiliency into a VNF such that the - resiliency deployment model (e.g., active-active) can be chosen at - run-time. -* R-03954 The VNF **MUST** survive any single points of failure within - the Network Cloud (e.g., virtual NIC, VM, disk failure). -* R-89010 The VNF **MUST** survive any single points of software failure - internal to the VNF (e.g., in memory structures, JMS message queues). -* R-67709 The VNF **MUST** be designed, built and packaged to enable - deployment across multiple fault zones (e.g., VNFCs deployed in - different servers, racks, OpenStack regions, geographies) so that - in the event of a planned/unplanned downtime of a fault zone, the - overall operation/throughput of the VNF is maintained. -* R-35291 The VNF **MUST** support the ability to failover a VNFC - automatically to other geographically redundant sites if not - deployed active-active to increase the overall resiliency of the VNF. -* R-36843 The VNF **MUST** support the ability of the VNFC to be deployable - in multi-zoned cloud sites to allow for site support in the event of cloud - zone failure or upgrades. -* R-00098 The VNF **MUST NOT** impact the ability of the VNF to provide - service/function due to a single container restart. -* R-79952 The VNF **SHOULD** support container snapshots if not for rebuild - and evacuate for rollback or back out mechanism. - -Minimize Cross Data-Center Traffic -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Avoid performance-sapping data center-to-data center replication delay -by applying techniques such as caching and persistent transaction paths -- Eliminate replication delay impact between data centers by using a -concept of stickiness (i.e., once a client is routed to data center "A", -the client will stay with Data center “A” until the entire session is -completed). - -Minimize Cross Data-Center Traffic Requirements - -* R-92935 The VNF **SHOULD** minimize the propagation of state information - across multiple data centers to avoid cross data center traffic. - -Application Resilient Error Handling -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Ensure an application communicating with a downstream peer is equipped -to intelligently handle all error conditions. Make sure code can handle -exceptions seamlessly - implement smart retry logic and implement -multi-point entry (multiple data centers) for back-end system -applications. - -Application Resilient Error Handling Requirements - -* R-26371 The VNF **MUST** detect communication failure for inter VNFC - instance and intra/inter VNF and re-establish communication - automatically to maintain the VNF without manual intervention to - provide service continuity. -* R-18725 The VNF **MUST** handle the restart of a single VNFC instance - without requiring all VNFC instances to be restarted. -* R-06668 The VNF **MUST** handle the start or restart of VNFC instances - in any order with each VNFC instance establishing or re-establishing - required connections or relationships with other VNFC instances and/or - VNFs required to perform the VNF function/role without requiring VNFC - instance(s) to be started/restarted in a particular order. -* R-80070 The VNF **MUST** handle errors and exceptions so that they do - not interrupt processing of incoming VNF requests to maintain service - continuity (where the error is not directly impacting the software - handling the incoming request). -* R-32695 The VNF **MUST** provide the ability to modify the number of - retries, the time between retries and the behavior/action taken after - the retries have been exhausted for exception handling to allow the - NCSP to control that behavior, where the interface and/or functional - specification allows for altering behaviour. -* R-48356 The VNF **MUST** fully exploit exception handling to the extent - that resources (e.g., threads and memory) are released when no longer - needed regardless of programming language. -* R-67918 The VNF **MUST** handle replication race conditions both locally - and geo-located in the event of a data base instance failure to maintain - service continuity. -* R-36792 The VNF **MUST** automatically retry/resubmit failed requests - made by the software to its downstream system to increase the success rate. -* R-70013 The VNF **MUST NOT** require any manual steps to get it ready for - service after a container rebuild. -* R-65515 The VNF **MUST** provide a mechanism and tool to start VNF - containers (VMs) without impacting service or service quality assuming - another VNF in same or other geographical location is processing service - requests. -* R-94978 The VNF **MUST** provide a mechanism and tool to perform a graceful - shutdown of all the containers (VMs) in the VNF without impacting service - or service quality assuming another VNF in same or other geographical - location can take over traffic and process service requests. - - -System Resource Optimization -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Ensure an application is using appropriate system resources for the task -at hand; for example, do not use network or IO operations inside -critical sections, which could end up blocking other threads or -processes or eating memory if they are unable to complete. Critical -sections should only contain memory operation, and should not contain -any network or IO operation. - - -System Resource Optimization Requirements - -* R-22059 The VNF **MUST NOT** execute long running tasks (e.g., IO, - database, network operations, service calls) in a critical section - of code, so as to minimize blocking of other operations and increase - concurrent throughput. -* R-63473 The VNF **MUST** automatically advertise newly scaled - components so there is no manual intervention required. -* R-74712 The VNF **MUST** utilize FQDNs (and not IP address) for - both Service Chaining and scaling. -* R-41159 The VNF **MUST** deliver any and all functionality from any - VNFC in the pool (where pooling is the most suitable solution). The - VNFC pool member should be transparent to the client. Upstream and - downstream clients should only recognize the function being performed, - not the member performing it. -* R-85959 The VNF **SHOULD** automatically enable/disable added/removed - sub-components or component so there is no manual intervention required. -* R-06885 The VNF **SHOULD** support the ability to scale down a VNFC pool - without jeopardizing active sessions. Ideally, an active session should - not be tied to any particular VNFC instance. -* R-12538 The VNF **SHOULD** support load balancing and discovery - mechanisms in resource pools containing VNFC instances. -* R-98989 The VNF **SHOULD** utilize resource pooling (threads, - connections, etc.) within the VNF application so that resources - are not being created and destroyed resulting in resource management - overhead. -* R-55345 The VNF **SHOULD** use techniques such as “lazy loading” when - initialization includes loading catalogues and/or lists which can grow - over time, so that the VNF startup time does not grow at a rate - proportional to that of the list. -* R-35532 The VNF **SHOULD** release and clear all shared assets (memory, - database operations, connections, locks, etc.) as soon as possible, - especially before long running sync and asynchronous operations, so as - to not prevent use of these assets by other entities. - - -Application Configuration Management -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Leverage configuration management audit capability to drive conformity -to develop gold configurations for technologies like Java, Python, etc. - -Application Configuration Management Requirements - -* R-77334 The VNF **MUST** allow configurations and configuration parameters - to be managed under version control to ensure consistent configuration - deployment, traceability and rollback. -* R-99766 The VNF **MUST** allow configurations and configuration parameters - to be managed under version control to ensure the ability to rollback to - a known valid configuration. -* R-73583 The VNF **MUST** allow changes of configuration parameters - to be consumed by the VNF without requiring the VNF or its sub-components - to be bounced so that the VNF availability is not effected. - - -Intelligent Transaction Distribution & Management -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Leverage Intelligent Load Balancing and redundant components (hardware -and modules) for all transactions, such that at any point in the -transaction: front end, middleware, back end -- a failure in any one -component does not result in a failure of the application or system; -i.e., transactions will continue to flow, albeit at a possibly reduced -capacity until the failed component restores itself. Create redundancy -in all layers (software and hardware) at local and remote data centers; -minimizing interdependencies of components (i.e. data replication, -deploying non-related elements in the same container). - -Intelligent Transaction Distribution & Management Requirements - -* R-21558 The VNF **SHOULD** use intelligent routing by having knowledge - of multiple downstream/upstream endpoints that are exposed to it, to - ensure there is no dependency on external services (such as load balancers) - to switch to alternate endpoints. -* R-08315 The VNF **SHOULD** use redundant connection pooling to connect - to any backend data source that can be switched between pools in an - automated/scripted fashion to ensure high availability of the connection - to the data source. -* R-27995 The VNF **SHOULD** include control loop mechanisms to notify - the consumer of the VNF of their exceeding SLA thresholds so the consumer - is able to control its load against the VNF. - -Deployment Optimization -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Reduce opportunity for failure, by human or by machine, through smarter -deployment practices and automation. This can include rolling code -deployments, additional testing strategies, and smarter deployment -automation (remove the human from the mix). - -Deployment Optimization Requirements - -* R-73364 The VNF **MUST** support at least two major versions of the - VNF software and/or sub-components to co-exist within production - environments at any time so that upgrades can be applied across - multiple systems in a staggered manner. -* R-02454 The VNF **MUST** support the existence of multiple major/minor - versions of the VNF software and/or sub-components and interfaces that - support both forward and backward compatibility to be transparent to - the Service Provider usage. -* R-57855 The VNF **MUST** support hitless staggered/rolling deployments - between its redundant instances to allow "soak-time/burn in/slow roll" - which can enable the support of low traffic loads to validate the - deployment prior to supporting full traffic loads. -* R-64445 The VNF **MUST** support the ability of a requestor of the - service to determine the version (and therefore capabilities) of the - service so that Network Cloud Service Provider can understand the - capabilities of the service. -* R-56793 The VNF **MUST** test for adherence to the defined performance - budgets at each layer, during each delivery cycle with delivered - results, so that the performance budget is measured and the code - is adjusted to meet performance budget. -* R-77667 The VNF **MUST** test for adherence to the defined performance - budget at each layer, during each delivery cycle so that the performance - budget is measured and feedback is provided where the performance budget - is not met. -* R-49308 The VNF **SHOULD** test for adherence to the defined resiliency - rating recommendation at each layer, during each delivery cycle with - delivered results, so that the resiliency rating is measured and the - code is adjusted to meet software resiliency requirements. -* R-16039 The VNF **SHOULD** test for adherence to the defined - resiliency rating recommendation at each layer, during each - delivery cycle so that the resiliency rating is measured and - feedback is provided where software resiliency requirements are - not met. - -Monitoring & Dashboard -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Promote dashboarding as a tool to monitor and support the general -operational health of a system. It is critical to the support of the -implementation of many resiliency patterns essential to the maintenance -of the system. It can help identify unusual conditions that might -indicate failure or the potential for failure. This would contribute to -improve Mean Time to Identify (MTTI), Mean Time to Repair (MTTR), and -post-incident diagnostics. - -Monitoring & Dashboard Requirements - -* R-34957 The VNF **MUST** provide a method of metrics gathering for each - layer's performance to identify/document variances in the allocations so - they can be addressed. -* R-49224 The VNF **MUST** provide unique traceability of a transaction - through its life cycle to ensure quick and efficient troubleshooting. -* R-52870 The VNF **MUST** provide a method of metrics gathering - and analysis to evaluate the resiliency of the software from both - a granular as well as a holistic standpoint. This includes, but is - not limited to thread utilization, errors, timeouts, and retries. -* R-92571 The VNF **MUST** provide operational instrumentation such as - logging, so as to facilitate quick resolution of issues with the VNF to - provide service continuity. -* R-48917 The VNF **MUST** monitor for and alert on (both sender and - receiver) errant, running longer than expected and missing file transfers, - so as to minimize the impact due to file transfer errors. -* R-28168 The VNF **SHOULD** use an appropriately configured logging - level that can be changed dynamically, so as to not cause performance - degradation of the VNF due to excessive logging. -* R-87352 The VNF **SHOULD** utilize Cloud health checks, when available - from the Network Cloud, from inside the application through APIs to check - the network connectivity, dropped packets rate, injection, and auto failover - to alternate sites if needed. -* R-16560 The VNF **SHOULD** conduct a resiliency impact assessment for all - inter/intra-connectivity points in the VNF to provide an overall resiliency - rating for the VNF to be incorporated into the software design and - development of the VNF. - -VNF Security ----------------------- - -The objective of this section is to provide the key security -requirements that need to be met by VNFs. The security requirements are -grouped into five areas as listed below. Other security areas will be -addressed in future updates. These security requirements are applicable -to all VNFs. Additional security requirements for specific types of VNFs -will be applicable and are outside the scope of these general -requirements. - -Section 5.a Security in *VNF Guidelines* outlines -the five broad security areas for VNFs that are detailed in the -following sections: - -- **VNF General Security**: This section addresses general security - requirements for the VNFs that the VNF provider will need to address. - -- **VNF Identity and Access Management**: This section addresses - security requirements with respect to Identity and Access Management - as these pertain to generic VNFs. - -- **VNF API Security**: This section addresses the generic security - requirements associated with APIs. These requirements are applicable - to those VNFs that use standard APIs for communication and data - exchange. - -- **VNF Security Analytics**: This section addresses the security - requirements associated with analytics for VNFs that deal with - monitoring, data collection and analysis. - -- **VNF Data Protection**: This section addresses the security - requirements associated with data protection. - -VNF General Security Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section provides details on the VNF general security requirements -on various security areas such as user access control, network security, -ACLs, infrastructure security, and vulnerability management. These -requirements cover topics associated with compliance, security patching, -logging/accounting, authentication, encryption, role-based access -control, least privilege access/authorization. The following security -requirements need to be met by the solution in a virtual environment: - -General Security Requirements - -Integration and operation within a robust security environment is necessary -and expected. The security architecture will include one or more of the -following: IDAM (Identity and Access Management) for all system and -applications access, Code scanning, network vulnerability scans, OS, -Database and application patching, malware detection and cleaning, -DDOS prevention, network security gateways (internal and external) -operating at various layers, host and application based tools for -security compliance validation, aggressive security patch application, -tightly controlled software distribution and change control processes -and other state of the art security solutions. The VNF is expected to -function reliably within such an environment and the developer is -expected to understand and accommodate such controls and can expected -to supply responsive interoperability support and testing throughout -the product’s lifecycle. - -* R-23740 The VNF **MUST** accommodate the security principle of - “least privilege” during development, implementation and operation. - The importance of “least privilege” cannot be overstated and must be - observed in all aspects of VNF development and not limited to security. - This is applicable to all sections of this document. -* R-61354 The VNF **MUST** implement access control list for OA&M - services (e.g., restricting access to certain ports or applications). -* R-85633 The VNF **MUST** implement Data Storage Encryption - (database/disk encryption) for Sensitive Personal Information (SPI) - and other subscriber identifiable data. Note: subscriber’s SPI/data - must be encrypted at rest, and other subscriber identifiable data - should be encrypted at rest. Other data protection requirements exist - and should be well understood by the developer. -* R-92207 The VNF **SHOULD** implement a mechanism for automated and - frequent "system configuration (automated provisioning / closed loop)" - auditing. -* R-23882 The VNF **SHOULD** be scanned using both network scanning - and application scanning security tools on all code, including underlying - OS and related configuration. Scan reports shall be provided. Remediation - roadmaps shall be made available for any findings. -* R-46986 The VNF **SHOULD** have source code scanned using scanning - tools (e.g., Fortify) and provide reports. -* R-55830 The VNF **MUST** distribute all production code from NCSP - internal sources only. No production code, libraries, OS images, etc. - shall be distributed from publically accessible depots. -* R-99771 The VNF **MUST** provide all code/configuration files in a - "Locked down" or hardened state or with documented recommendations for - such hardening. All unnecessary services will be disabled. VNF provider - default credentials, community strings and other such artifacts will be - removed or disclosed so that they can be modified or removed during - provisioning. -* R-19768 The VNF **SHOULD** support L3 VPNs that enable segregation of - traffic by application (dropping packets not belonging to the VPN) (i.e., - AVPN, IPSec VPN for Internet routes). -* R-33981 The VNF **SHOULD** interoperate with various access control - mechanisms for the Network Cloud execution environment (e.g., - Hypervisors, containers). -* R-40813 The VNF **SHOULD** support the use of virtual trusted platform - module, hypervisor security testing and standards scanning tools. -* R-56904 The VNF **MUST** interoperate with the ONAP (SDN) Controller so that - it can dynamically modify the firewall rules, ACL rules, QoS rules, virtual - routing and forwarding rules. -* R-26586 The VNF **SHOULD** support the ability to work with aliases - (e.g., gateways, proxies) to protect and encapsulate resources. -* R-49956 The VNF **MUST** pass all access to applications (Bearer, - signaling and OA&M) through various security tools and platforms from - ACLs, stateful firewalls and application layer gateways depending on - manner of deployment. The application is expected to function (and in - some cases, interwork) with these security tools. -* R-69649 The VNF **MUST** have all vulnerabilities patched as soon - as possible. Patching shall be controlled via change control process - with vulnerabilities disclosed along with mitigation recommendations. -* R-78010 The VNF **MUST** use the NCSP’s IDAM API for Identification, - authentication and access control of customer or VNF application users. -* R-42681 The VNF **MUST** use the NCSP’s IDAM API or comply with - the requirements if not using the NCSP’s IDAM API, for identification, - authentication and access control of OA&M and other system level - functions. -* R-68589 The VNF **MUST**, if not using the NCSP’s IDAM API, support - User-IDs and passwords to uniquely identify the user/application. VNF - needs to have appropriate connectors to the Identity, Authentication - and Authorization systems that enables access at OS, Database and - Application levels as appropriate. -* R-52085 The VNF **MUST**, if not using the NCSP’s IDAM API, provide - the ability to support Multi-Factor Authentication (e.g., 1st factor = - Software token on device (RSA SecureID); 2nd factor = User Name+Password, - etc.) for the users. -* R-98391 The VNF **MUST**, if not using the NCSP’s IDAM API, support - Role-Based Access Control to permit/limit the user/application to - performing specific activities. -* R-63217 The VNF **MUST**, if not using the NCSP’s IDAM API, support - logging via ONAP for a historical view of “who did what and when”. -* R-62498 The VNF **MUST**, if not using the NCSP’s IDAM API, encrypt - OA&M access (e.g., SSH, SFTP). -* R-79107 The VNF **MUST**, if not using the NCSP’s IDAM API, enforce - a configurable maximum number of Login attempts policy for the users. - VNF provider must comply with "terminate idle sessions" policy. - Interactive sessions must be terminated, or a secure, locking screensaver - must be activated requiring authentication, after a configurable period - of inactivity. The system-based inactivity timeout for the enterprise - identity and access management system must also be configurable. -* R-35144 The VNF **MUST**, if not using the NCSP’s IDAM API, comply - with the NCSP’s credential management policy. -* R-75041 The VNF **MUST**, if not using the NCSP’s IDAM API, expire - passwords at regular configurable intervals. -* R-46908 The VNF **MUST**, if not using the NCSP’s IDAM API, comply - with "password complexity" policy. When passwords are used, they shall - be complex and shall at least meet the following password construction - requirements: (1) be a minimum configurable number of characters in - length, (2) include 3 of the 4 following types of characters: - upper-case alphabetic, lower-case alphabetic, numeric, and special, - (3) not be the same as the UserID with which they are associated or - other common strings as specified by the environment, (4) not contain - repeating or sequential characters or numbers, (5) not to use special - characters that may have command functions, and (6) new passwords must - not contain sequences of three or more characters from the previous - password. -* R-39342 The VNF **MUST**, if not using the NCSP’s IDAM API, comply - with "password changes (includes default passwords)" policy. Products - will support password aging, syntax and other credential management - practices on a configurable basis. -* R-40521 The VNF **MUST**, if not using the NCSP’s IDAM API, support - use of common third party authentication and authorization tools such - as TACACS+, RADIUS. -* R-41994 The VNF **MUST**, if not using the NCSP’s IDAM API, comply - with "No Self-Signed Certificates" policy. Self-signed certificates - must be used for encryption only, using specified and approved - encryption protocols such as TLS 1.2 or higher or equivalent security - protocols such as IPSec, AES. -* R-23135 The VNF **MUST**, if not using the NCSP’s IDAM API, - authenticate system to system communications where one system - accesses the resources of another system, and must never conceal - individual accountability. - -VNF Identity and Access Management Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The following security requirements for logging, identity, and access -management need to be met by the solution in a virtual environment: - - -Identity and Access Management Requirements - -* R-95105 The VNF **MUST** host connectors for access to the application - layer. -* R-45496 The VNF **MUST** host connectors for access to the OS - (Operating System) layer. -* R-05470 The VNF **MUST** host connectors for access to the database layer. -* R-99174 The VNF **MUST** comply with Individual Accountability - (each person must be assigned a unique ID) when persons or non-person - entities access VNFs. -* R-42874 The VNF **MUST** comply with Least Privilege (no more - privilege than required to perform job functions) when persons - or non-person entities access VNFs. -* R-71787 The VNF **MUST** comply with Segregation of Duties (access to a - single layer and no developer may access production without special - oversight) when persons or non-person entities access VNFs. -* R-86261 The VNF **MUST NOT** allow VNF provider access to VNFs remotely. -* R-49945 The VNF **MUST** authorize VNF provider access through a - client application API by the client application owner and the resource - owner of the VNF before provisioning authorization through Role Based - Access Control (RBAC), Attribute Based Access Control (ABAC), or other - policy based mechanism. -* R-31751 The VNF **MUST** subject VNF provider access to privilege - reconciliation tools to prevent access creep and ensure correct - enforcement of access policies. -* R-34552 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for OWASP Top 10. -* R-29301 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for Password Attacks. -* R-72243 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for Phishing / SMishing. -* R-58998 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for Malware (Key Logger). -* R-14025 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for Session Hijacking. -* R-31412 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for XSS / CSRF. -* R-51883 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for Replay. -* R-44032 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for Man in the Middle (MITM). -* R-58977 The VNF **MUST** provide or support the Identity and Access - Management (IDAM) based threat detection data for Eavesdropping. -* R-24825 The VNF **MUST** provide Context awareness data (device, - location, time, etc.) and be able to integrate with threat detection system. -* R-59391 The VNF provider **MUST**, where a VNF provider requires - the assumption of permissions, such as root or administrator, first - log in under their individual user login ID then switch to the other - higher level account; or where the individual user login is infeasible, - must login with an account with admin privileges in a way that - uniquely identifies the individual performing the function. -* R-85028 The VNF **MUST** authenticate system to system access and - do not conceal a VNF provider user’s individual accountability for - transactions. -* R-80335 The VNF **MUST** make visible a Warning Notice: A formal - statement of resource intent, i.e., a warning notice, upon initial - access to a VNF provider user who accesses private internal networks - or Company computer resources, e.g., upon initial logon to an internal - web site, system or application which requires authentication. -* R-73541 The VNF **MUST** use access controls for VNFs and their - supporting computing systems at all times to restrict access to - authorized personnel only, e.g., least privilege. These controls - could include the use of system configuration or access control - software. -* R-64503 The VNF **MUST** provide minimum privileges for initial - and default settings for new user accounts. -* R-86835 The VNF **MUST** set the default settings for user access - to sensitive commands and data to deny authorization. -* R-77157 The VNF **MUST** conform to approved request, workflow - authorization, and authorization provisioning requirements when - creating privileged users. -* R-81147 The VNF **MUST** have greater restrictions for access and - execution, such as up to 3 factors of authentication and restricted - authorization, for commands affecting network services, such as - commands relating to VNFs. -* R-49109 The VNF **MUST** encrypt TCP/IP--HTTPS (e.g., TLS v1.2) - transmission of data on internal and external networks. -* R-39562 The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs. -* R-15671 The VNF **MUST NOT** provide public or unrestricted access - to any data without the permission of the data owner. All data - classification and access controls must be followed. -* R-89753 The VNF **MUST NOT** install or use systems, tools or - utilities capable of capturing or logging data that was not created - by them or sent specifically to them in production, without - authorization of the VNF system owner. -* R-19082 The VNF **MUST NOT** run security testing tools and - programs, e.g., password cracker, port scanners, hacking tools - in production, without authorization of the VNF system owner. -* R-19790 The VNF **MUST NOT** include authentication credentials - in security audit logs, even if encrypted. -* R-85419 The VNF **SHOULD** use REST APIs exposed to Client - Applications for the implementation of OAuth 2.0 Authorization - Code Grant and Client Credentials Grant, as the standard interface - for a VNF. -* R-48080 The VNF **SHOULD** support SCEP (Simple Certificate - Enrollment Protocol). - - -VNF API Security Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section covers API security requirements when these are used by the -VNFs. Key security areas covered in API security are Access Control, -Authentication, Passwords, PKI Authentication Alarming, Anomaly -Detection, Lawful Intercept, Monitoring and Logging, Input Validation, -Cryptography, Business continuity, Biometric Authentication, -Identification, Confidentiality and Integrity, and Denial of Service. - -The solution in a virtual environment needs to meet the following API -security requirements: - - -API Requirements - -* R-37608 The VNF **MUST** provide a mechanism to restrict access based - on the attributes of the VNF and the attributes of the subject. -* R-43884 The VNF **MUST** integrate with external authentication - and authorization services (e.g., IDAM). -* R-25878 The VNF **MUST** use certificates issued from publicly - recognized Certificate Authorities (CA) for the authentication process - where PKI-based authentication is used. -* R-19804 The VNF **MUST** validate the CA signature on the certificate, - ensure that the date is within the validity period of the certificate, - check the Certificate Revocation List (CRL), and recognize the identity - represented by the certificate where PKI-based authentication is used. -* R-47204 The VNF **MUST** protect the confidentiality and integrity of - data at rest and in transit from unauthorized access and modification. -* R-33488 The VNF **MUST** protect against all denial of service - attacks, both volumetric and non-volumetric, or integrate with external - denial of service protection tools. -* R-21652 The VNF **MUST** implement the following input validation - control: Check the size (length) of all input. Do not permit an amount - of input so great that it would cause the VNF to fail. Where the input - may be a file, the VNF API must enforce a size limit. -* R-54930 The VNF **MUST** implement the following input validation - control: Do not permit input that contains content or characters - inappropriate to the input expected by the design. Inappropriate input, - such as SQL insertions, may cause the system to execute undesirable - and unauthorized transactions against the database or allow other - inappropriate access to the internal network. -* R-21210 The VNF **MUST** implement the following input validation - control: Validate that any input file has a correct and valid - Multipurpose Internet Mail Extensions (MIME) type. Input files - should be tested for spoofed MIME types. -* R-23772 The VNF **MUST** validate input at all layers implementing VNF APIs. -* R-87135 The VNF **MUST** comply with NIST standards and industry - best practices for all implementations of cryptography. -* R-02137 The VNF **MUST** implement all monitoring and logging as - described in the Security Analytics section. -* R-15659 The VNF **MUST** restrict changing the criticality level of - a system security alarm to administrator(s). -* R-19367 The VNF **MUST** monitor API invocation patterns to detect - anomalous access patterns that may represent fraudulent access or - other types of attacks, or integrate with tools that implement anomaly - and abuse detection. -* R-78066 The VNF **MUST** support requests for information from law - enforcement and government agencies. - - -VNF Security Analytics Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section covers VNF security analytics requirements that are mostly -applicable to security monitoring. The VNF Security Analytics cover the -collection and analysis of data following key areas of security -monitoring: - -- Anti-virus software - -- Logging - -- Data capture - -- Tasking - -- DPI - -- API based monitoring - -- Detection and notification - -- Resource exhaustion detection - -- Proactive and scalable monitoring - -- Mobility and guest VNF monitoring - -- Closed loop monitoring - -- Interfaces to management and orchestration - -- Malformed packet detections - -- Service chaining - -- Dynamic security control - -- Dynamic load balancing - -- Connection attempts to inactive ports (malicious port scanning) - -The following requirements of security monitoring need to be met by the -solution in a virtual environment. - -Security Analytics Requirements - -* R-48470 The VNF **MUST** support Real-time detection and - notification of security events. -* R-22286 The VNF **MUST** support Integration functionality via - API/Syslog/SNMP to other functional modules in the network (e.g., - PCRF, PCEF) that enable dynamic security control by blocking the - malicious traffic or malicious end users -* R-32636 The VNF **MUST** support API-based monitoring to take care of - the scenarios where the control interfaces are not exposed, or are - optimized and proprietary in nature. -* R-61648 The VNF **MUST** support event logging, formats, and delivery - tools to provide the required degree of event data to ONAP -* R-22367 The VNF **MUST** support detection of malformed packets due to - software misconfiguration or software vulnerability. -* R-31961 The VNF **MUST** support integrated DPI/monitoring functionality - as part of VNFs (e.g., PGW, MME). -* R-20912 The VNF **MUST** support alternative monitoring capabilities - when VNFs do not expose data or control traffic or use proprietary and - optimized protocols for inter VNF communication. -* R-73223 The VNF **MUST** support proactive monitoring to detect and - report the attacks on resources so that the VNFs and associated VMs can - be isolated, such as detection techniques for resource exhaustion, namely - OS resource attacks, CPU attacks, consumption of kernel memory, local - storage attacks. -* R-58370 The VNF **MUST** coexist and operate normally with commercial - anti-virus software which shall produce alarms every time when there is a - security incident. -* R-56920 The VNF **MUST** protect all security audit logs (including - API, OS and application-generated logs), security audit software, data, - and associated documentation from modification, or unauthorized viewing, - by standard OS access control mechanisms, by sending to a remote system, - or by encryption. -* R-54520 The VNF **MUST** log successful and unsuccessful login attempts. -* R-55478 The VNF **MUST** log logoffs. -* R-08598 The VNF **MUST** log successful and unsuccessful changes to - a privilege level. -* R-13344 The VNF **MUST** log starting and stopping of security - logging. -* R-07617 The VNF **MUST** log creating, removing, or changing the - inherent privilege level of users. -* R-94525 The VNF **MUST** log connections to a network listener of the - resource. -* R-31614 The VNF **MUST** log the field “event type” in the security - audit logs. -* R-97445 The VNF **MUST** log the field “date/time” in the security - audit logs. -* R-25547 The VNF **MUST** log the field “protocol” in the security audit logs. -* R-06413 The VNF **MUST** log the field “service or program used for - access” in the security audit logs. -* R-15325 The VNF **MUST** log the field “success/failure” in the - security audit logs. -* R-89474 The VNF **MUST** log the field “Login ID” in the security audit logs. -* R-04982 The VNF **MUST NOT** include an authentication credential, - e.g., password, in the security audit logs, even if encrypted. -* R-63330 The VNF **MUST** detect when the security audit log storage - medium is approaching capacity (configurable) and issue an alarm via - SMS or equivalent as to allow time for proper actions to be taken to - pre-empt loss of audit data. -* R-41252 The VNF **MUST** support the capability of online storage of - security audit logs. -* R-41825 The VNF **MUST** activate security alarms automatically when - the following event is detected: configurable number of consecutive - unsuccessful login attempts -* R-43332 The VNF **MUST** activate security alarms automatically when - the following event is detected: successful modification of critical - system or application files -* R-74958 The VNF **MUST** activate security alarms automatically when - the following event is detected: unsuccessful attempts to gain permissions - or assume the identity of another user -* R-15884 The VNF **MUST** include the field “date” in the Security alarms - (where applicable and technically feasible). -* R-23957 The VNF **MUST** include the field “time” in the Security alarms - (where applicable and technically feasible). -* R-71842 The VNF **MUST** include the field “service or program used for - access” in the Security alarms (where applicable and technically feasible). -* R-57617 The VNF **MUST** include the field “success/failure” in the - Security alarms (where applicable and technically feasible). -* R-99730 The VNF **MUST** include the field “Login ID” in the Security - alarms (where applicable and technically feasible). -* R-29705 The VNF **MUST** restrict changing the criticality level of a - system security alarm to administrator(s). -* R-13627 The VNF **MUST** monitor API invocation patterns to detect - anomalous access patterns that may represent fraudulent access or other - types of attacks, or integrate with tools that implement anomaly and - abuse detection. -* R-21819 The VNF **MUST** support requests for information from law - enforcement and government agencies. -* R-56786 The VNF **MUST** implement “Closed Loop” automatic implementation - (without human intervention) for Known Threats with detection rate in low - false positives. -* R-25094 The VNF **MUST** perform data capture for security functions. -* R-04492 The VNF **MUST** generate security audit logs that must be sent - to Security Analytics Tools for analysis. -* R-19219 The VNF **MUST** provide audit logs that include user ID, dates, - times for log-on and log-off, and terminal location at minimum. -* R-30932 The VNF **MUST** provide security audit logs including records - of successful and rejected system access data and other resource access - attempts. -* R-54816 The VNF **MUST** support the storage of security audit logs - for agreed period of time for forensic analysis. -* R-57271 The VNF **MUST** provide the capability of generating security - audit logs by interacting with the operating system (OS) as appropriate. -* R-84160 The VNF **MUST** have security logging for VNFs and their - OSs be active from initialization. Audit logging includes automatic - routines to maintain activity records and cleanup programs to ensure - the integrity of the audit/logging systems. - -VNF Data Protection Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section covers VNF data protection requirements that are mostly -applicable to security monitoring. - - -Data Protection Requirements - -* R-58964 The VNF **MUST** provide the capability to restrict read - and write access to data. -* R-99112 The VNF **MUST** provide the capability to restrict access - to data to specific users. -* R-83227 The VNF **MUST** Provide the capability to encrypt data in - transit on a physical or virtual network. -* R-32641 The VNF **MUST** provide the capability to encrypt data on - non-volatile memory. -* R-13151 The VNF **SHOULD** disable the paging of the data requiring - encryption, if possible, where the encryption of non-transient data is - required on a device for which the operating system performs paging to - virtual memory. If not possible to disable the paging of the data - requiring encryption, the virtual memory should be encrypted. -* R-93860 The VNF **MUST** provide the capability to integrate with an - external encryption service. -* R-73067 The VNF **MUST** use industry standard cryptographic algorithms - and standard modes of operations when implementing cryptography. -* R-22645 The VNF **SHOULD** use commercial algorithms only when there - are no applicable governmental standards for specific cryptographic - functions, e.g., public key cryptography, message digests. -* R-12467 The VNF **MUST NOT** use the SHA, DSS, MD5, SHA-1 and - Skipjack algorithms or other compromised encryption. -* R-02170 The VNF **MUST** use, whenever possible, standard implementations - of security applications, protocols, and format, e.g., S/MIME, TLS, SSH, - IPSec, X.509 digital certificates for cryptographic implementations. - These implementations must be purchased from reputable vendors and must - not be developed in-house. -* R-70933 The VNF **MUST** provide the ability to migrate to newer - versions of cryptographic algorithms and protocols with no impact. -* R-44723 The VNF **MUST** use symmetric keys of at least 112 bits in length. -* R-25401 The VNF **MUST** use asymmetric keys of at least 2048 bits in length. -* R-95864 The VNF **MUST** use commercial tools that comply with X.509 - standards and produce x.509 compliant keys for public/private key generation. -* R-12110 The VNF **MUST NOT** use keys generated or derived from - predictable functions or values, e.g., values considered predictable - include user identity information, time of day, stored/transmitted data. -* R-52060 The VNF **MUST** provide the capability to configure encryption - algorithms or devices so that they comply with the laws of the jurisdiction - in which there are plans to use data encryption. -* R-69610 The VNF **MUST** provide the capability of using certificates - issued from a Certificate Authority not provided by the VNF provider. -* R-83500 The VNF **MUST** provide the capability of allowing certificate - renewal and revocation. -* R-29977 The VNF **MUST** provide the capability of testing the validity - of a digital certificate by validating the CA signature on the certificate. -* R-24359 The VNF **MUST** provide the capability of testing the validity - of a digital certificate by validating the date the certificate is being - used is within the validity period for the certificate. -* R-39604 The VNF **MUST** provide the capability of testing the - validity of a digital certificate by checking the Certificate Revocation - List (CRL) for the certificates of that type to ensure that the - certificate has not been revoked. -* R-75343 The VNF **MUST** provide the capability of testing the - validity of a digital certificate by recognizing the identity represented - by the certificate — the "distinguished name". - -VNF Modularity ---------------------------- - -ONAP Heat Orchestration Templates: Overview -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -ONAP supports a modular Heat Orchestration Template design pattern, -referred to as *VNF Modularity.* - -ONAP VNF Modularity Overview -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -With VNF Modularity, a single VNF may be composed from one or more Heat -Orchestration Templates, each of which represents a subset of the -overall VNF. These component parts are referred to as “\ *VNF -Modules*\ ”. During orchestration, these modules are deployed -incrementally to create the complete VNF. - -A modular Heat Orchestration Template can be either one of the following -types: - -1. Base Module - -2. Incremental Module - -3. Cinder Volume Module - -* R-37028 The VNF **MUST** be composed of one “base” module. -* R-41215 The VNF **MAY** have zero to many “incremental” modules. -* R-20974 The VNF **MUST** deploy the base module first, prior to - the incremental modules. - -ONAP also supports the concept of an optional, independently deployed -Cinder volume via a separate Heat Orchestration Templates, referred to -as a Cinder Volume Module. This allows the volume to persist after a -Virtual Machine (VM) (i.e., OS::Nova::Server) is deleted, allowing the -volume to be reused on another instance (e.g., during a failover -activity). - -* R-11200 The VNF **MUST** keep the scope of a Cinder volume module, - when it exists, to be 1:1 with the VNF Base Module or Incremental Module. - -* R-38474 The VNF **MUST** have a corresponding environment file for - a Base Module. -* R-81725 The VNF **MUST** have a corresponding environment file for - an Incremental Module. -* R-53433 The VNF **MUST** have a corresponding environment file for - a Cinder Volume Module. - -These concepts will be described in more detail throughout the document. -This overview is provided to set the stage and help clarify the concepts -that will be introduced. - - -ONAP VNF Modularity -^^^^^^^^^^^^^^^^^^^^^^ - -ONAP supports a modular Heat Orchestration Template design pattern, -referred to as *VNF Modularity.* With this approach, a single VNF may be -composed from one or more Heat Orchestration Templates, each of which -represents a subset of the overall VNF. These component parts are -referred to as “\ *VNF Modules*\ ”. During orchestration, these modules -are deployed incrementally to create the complete VNF. - -A modular Heat Orchestration Template can be either one of the following -types: - -1. Base Module - -2. Incremental Module - -3. Cinder Volume Module - -A VNF must be composed of one “base” module and may be composed of zero -to many “incremental” modules. The base module must be deployed first, -prior to the incremental modules. - -ONAP also supports the concept of an optional, independently deployed -Cinder volume via a separate Heat Orchestration Templates, referred to -as a Cinder Volume Module. This allows the volume to persist after a VM -(i.e., OS::Nova::Server) is deleted, allowing the volume to be reused on -another instance (e.g., during a failover activity). - -The scope of a Cinder volume module, when it exists, must be 1:1 with a -Base module or Incremental Module. - -A Base Module must have a corresponding environment file. - -An Incremental Module must have a corresponding environment file. - -A Cinder Volume Module must have a corresponding environment file. - -A VNF module (base, incremental, cinder) may support nested templates. - -A shared Heat Orchestration Template resource must be defined in the -base module. A shared resource is a resource that that will be -referenced by another resource that is defined in the Base Module and/or -one or more incremental modules. - -When the shared resource needs to be referenced by a resource in an -incremental module, the UUID of the shared resource must be exposed by -declaring an ONAP Base Module Output Parameter. - -Note that a Cinder volume is *not* a shared resource. A volume template -must correspond 1:1 with a base module or incremental module. - -An example of a shared resource is the resource -OS::Neutron::SecurityGroup. Security groups are sets of IP filter rules -that are applied to a VNF’s networking. The resource OS::Neutron::Port -has a property security\_groups which provides the security groups -associated with port. The value of parameter(s) associated with this -property must be the UUIDs of the resource(s) -OS::Neutron::SecurityGroup. - -*Note:* A Cinder volume is *not* considered a shared resource. A volume -template must correspond 1:1 with a base template or add-on module -template. - -Suggested Patterns for Modular VNFs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -There are numerous variations of VNF modularity. Below are two suggested -usage patterns. - -**Option 1: Modules per VNFC type** - -a. Base module contains only the shared resources. - -b. Group all VMs (e.g., VNFCs) of a given type (i.e. {vm-type}) into its - own incremental module. That is, the VNF has an incremental module - for each {vm-type}. - -c. For a given {vm-type} incremental module, the VNF may have - - i. One incremental module used for both initial turn up and re-used - for scaling. This approach is used when the number of VMs - instantiated will be the same for initial deployment and scaling. - - ii. Two incremental modules, where one is used for initial turn up - and one is used for scaling. This approach is used when the - number of VMs instantiated will be different for initial - deployment and scaling. - -**Option 2: Base VNF with Incremental Growth Modules** - -a. Base module contains a complete initial VNF instance - -b. Incremental modules for incremental scaling units - - i. May contain VMs of multiple types in logical scaling combinations - - ii. May be separated by VM type for multi-dimensional scaling - -With no growth units, Option 2 is equivalent to the “One Heat Template -per VNF” model. - -Note that modularization of VNFs is not required. A single Heat -Orchestration Template (a base module) may still define a complete VNF, -which might be appropriate for smaller VNFs that do not have any scaling -options. - -Modularity Rules -^^^^^^^^^^^^^^^^^^^ - -There are some rules to follow when building modular VNF templates: - -1. All VNFs must have one Base VNF Module (template) that must be the - first one deployed. The base template: - - a. Must include all shared resources (e.g., private networks, server - groups, security groups) - - b. Must expose all shared resources (by UUID) as “outputs” in its - associated Heat template (i.e., ONAP Base Module Output - Parameters) - - c. May include initial set of VMs - - d. May be operational as a stand-alone “minimum” configuration of the - VNF - -2. VNFs may have one or more incremental modules which: - - a. Defines additional resources that can be added to an existing VNF - - b. Must be complete Heat templates - - i. i.e. not snippets to be incorporated into some larger template - - c. Should define logical growth-units or sub-components of an overall - VNF - - d. On creation, receives appropriate Base Module outputs as - parameters - - i. Provides access to all shared resources (by UUID) - - ii. must not be dependent on other Add-On VNF Modules - - e. Multiple instances of an incremental Module may be added to the - same VNF (e.g., incrementally grow a VNF by a fixed “add-on” - growth units) - -3. Each VNF Module (base or incremental) may have (optional) an - associated Cinder Volume Module (see Cinder Volume Templates) - - a. Volume modules must correspond 1:1 with a base module or - incremental module - - b. A Cinder volume may be embedded within the base module or - incremental module if persistence is not required - -4. Shared resource UUIDs are passed between the base module and - incremental modules via Heat Outputs Parameters (i.e., Base Module - Output Parameters) - - a. The output parameter name in the base must match the parameter - name in the add-on module - -VNF Modularity Examples -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -*Example: Base Module creates SecurityGroup* - -A VNF has a base module, named base.yaml, that defines a -OS::Neutron::SecurityGroup. The security group will be referenced by an -OS::Neutron::Port resource in an incremental module, named -INCREMENTAL\_MODULE.yaml. The base module defines a parameter in the out -section named dns\_sec\_grp\_id. dns\_sec\_grp\_id is defined as a -parameter in the incremental module. ONAP captures the UUID value of -dns\_sec\_grp\_id from the base module output statement and provides the -value to the incremental module. - -Note that the example below is not a complete Heat Orchestration -Template. The {network-role} has been defined as oam to represent an oam -network and the {vm-type} has been defined as dns. - -base\_MODULE.yaml - -.. code-block:: yaml - - parameters: - . . . - - resources: - DNS_SECURITY_GROUP: - type: OS::Neutron::SecurityGroup - properties: - description: vDNS security group - name: - str_replace: - template: VNF_NAME_sec_grp_DNS - params: - VMF_NAME: {get_param: vnf_name} - rules: [. . . . . - - . . . - - outputs: - dns_sec_grp_id: - description: UUID of DNS Resource SecurityGroup - value: { get_resource: DNS_SECURITY_GROUP } - - -INCREMENTAL\_MODULE.yaml - -.. code-block:: yaml - - parameters: - dns_sec_grp_id: - type: string - description: security group UUID - . . . - - resources: - dns_oam_0_port: - type: OS::Neutron::Port - properties: - name: - str_replace: - template: VNF_NAME_dns_oam_port - params: - VNF_NAME: {get_param: vnf_name} - network: { get_param: oam_net_name } - fixed_ips: [{ "ip_address": { get_param: dns_oam_ip_0 }}] - security_groups: [{ get_param: dns_sec_grp_id }] - - -*Examples: Base Module creates an internal network* - -A VNF has a base module, named base\_module.yaml, that creates an -internal network. An incremental module, named incremental\_module.yaml, -will create a VM that will connect to the internal network. The base -module defines a parameter in the out section named int\_oam\_net\_id. -int\_oam\_net\_id is defined as a parameter in the incremental module. -ONAP captures the UUID value of int\_oam\_net\_id from the base module -output statement and provides the value to the incremental module. - -Note that the example below is not a complete Heat Orchestration -Template. The {network-role} has been defined as oam to represent an oam -network and the {vm-type} has been defined as lb for load balancer. - -base.yaml - -.. code-block:: yaml - - heat_template_version: 2013-05-23 - - resources: - int_oam_network: - type: OS::Neutron::Network - properties: - name: {… } - . . . - outputs: - int_oam_net_id: - value: {get_resource: int_oam_network } - - -incremental.yaml - -.. code-block:: yaml - - heat_template_version: 2013-05-23 - - parameters: - int_oam_net_id: - type: string - description: ID of shared private network from Base template - lb_name_0: - type: string - description: name for the add-on VM instance - - Resources: - lb_server: - type: OS::Nova::Server - properties: - name: {get_param: lb_name_0} - networks: - - port: { get_resource: lb_port } - . . . - - lb_port: - type: OS::Neutron::Port - properties: - network_id: { get_param: int_oam_net_id } - ... - -VNF Devops ---------------------- - -This section includes guidelines for VNF providers to ensure that a Network -Cloud Service Provider’s operations personnel have a common and -consistent way to support VNFs and VNFCs. - -NCSPs may elect to support standard images to enable compliance with -security, audit, regulatory and other needs. As part of the overall VNF -software bundle, VNF suppliers using standard images would typically -provide the NCSP with an install package consistent with the default OS -package manager (e.g. aptitude for Ubuntu, yum for Redhat/CentOS). - -Section 5.a DevOps in *VNF Guidelines* describes -the DevOps guidelines for VNFs. - -DevOps Requirements - -* R-46960 NCSPs **MAY** operate a limited set of Guest OS and CPU - architectures and families, virtual machines, etc. -* R-23475 VNFCs **SHOULD** be agnostic to the details of the Network Cloud - (such as hardware, host OS, Hypervisor or container technology) and must run - on the Network Cloud with acknowledgement to the paradigm that the Network - Cloud will continue to rapidly evolve and the underlying components of - the platform will change regularly. -* R-33846 The VNF **MUST** install the NCSP required software on Guest OS - images when not using the NCSP provided Guest OS images. [1]_ -* R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [1]_ -* R-02997 The VNF **MUST** preserve their persistent data. Running VMs - will not be backed up in the Network Cloud infrastructure. -* R-29760 The VNFC **MUST** be installed on non-root file systems, - unless software is specifically included with the operating system - distribution of the guest image. -* R-20860 The VNF **MUST** be agnostic to the underlying infrastructure - (such as hardware, host OS, Hypervisor), any requirements should be - provided as specification to be fulfilled by any hardware. -* R-89800 The VNF **MUST NOT** require Hypervisor-level customization - from the cloud provider. -* R-86758 The VNF **SHOULD** provide an automated test suite to validate - every new version of the software on the target environment(s). The tests - should be of sufficient granularity to independently test various - representative VNF use cases throughout its lifecycle. Operations might - choose to invoke these tests either on a scheduled basis or on demand to - support various operations functions including test, turn-up and - troubleshooting. -* R-39650 The VNF **SHOULD** provide the ability to test incremental - growth of the VNF. -* R-14853 The VNF **MUST** respond to a "move traffic" [2]_ command - against a specific VNFC, moving all existing session elsewhere with - minimal disruption if a VNF provides a load balancing function across - multiple instances of its VNFCs. Note: Individual VNF performance - aspects (e.g., move duration or disruption scope) may require further - constraints. -* R-06327 The VNF **MUST** respond to a "drain VNFC" [2]_ command against - a specific VNFC, preventing new session from reaching the targeted VNFC, - with no disruption to active sessions on the impacted VNFC, if a VNF - provides a load balancing function across multiple instances of its VNFCs. - This is used to support scenarios such as proactive maintenance with no - user impact. -* R-64713 The VNF **SHOULD** support a software promotion methodology - from dev/test -> pre-prod -> production in software, development & - testing and operations. - -VNF Develop Steps --------------------------------- - -Aid to help the VNF provider to fasten the integration with the GVNFM, the -ONAP provides the VNF SDK tools, and the documents. In this charter, -the develop steps for VNF providers will be introduced. - -First, using the VNF SDK tools to design the VNF with TOSCA model and -output the VNF TOSCA package. The VNF package can be validated, and -tested. - -Second, the VNF provider should provide the VNF Rest API to integrate with -the GVNFM if needed. The VNF Rest API is aligned to the ETSI IFA -document. - -Third, the TOSCA model supports the HPA feature. - -Note: - -1. The scripts to extend capacity to satisfy some special requirements. - In the R2, the scripts is not implemented fully, and will be provided - in the next release. - -2. The monitoring and scale policy also be provide the next release. - - -.. [1] - Refer to NCSP’s Network Cloud specification - -.. [2] - Not currently supported in ONAP release 1 - diff --git a/docs/Chapter4/Design.rst b/docs/Chapter4/Design.rst new file mode 100644 index 0000000..35acd65 --- /dev/null +++ b/docs/Chapter4/Design.rst @@ -0,0 +1,196 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +VNF Design +---------- + +Services are composed of VNFs and common components and are designed to +be agnostic of the location to leverage capacity where it exists in the +Network Cloud. VNFs can be instantiated in any location that meets the +performance and latency requirements of the service. + +A key design principle for virtualizing services is decomposition of +network functions using NFV concepts into granular VNFs. This enables +instantiating and customizing only essential functions as needed for the +service, thereby making service delivery more nimble. It provides +flexibility of sizing and scaling and also provides flexibility with +packaging and deploying VNFs as needed for the service. It enables +grouping functions in a common cloud data center to minimize +inter-component latency. The VNFs should be designed with a goal of +being modular and reusable to enable using best-in-breed vendors. + +Section 5.a VNF Design in *VNF Guidelines* describes +the overall guidelines for designing VNFs from VNF Components (VNFCs). +Below are more detailed requirements for composing VNFs. + +VNF Design Requirements + + +.. req:: + :id: R-58421 + :target: VNF + :keyword: SHOULD + + The VNF **SHOULD** be decomposed into granular re-usable VNFCs. + +.. req:: + :id: R-82223 + :target: VNF + :keyword: MUST + + The VNF **MUST** be decomposed if the functions have + significantly different scaling characteristics (e.g., signaling + versus media functions, control versus data plane functions). + +.. req:: + :id: R-16496 + :target: VNF + :keyword: MUST + + The VNF **MUST** enable instantiating only the functionality that + is needed for the decomposed VNF (e.g., if transcoding is not needed it + should not be instantiated). + +.. req:: + :id: R-02360 + :target: VNF + :keyword: MUST + + The VNFC **MUST** be designed as a standalone, executable process. + +.. req:: + :id: R-34484 + :target: VNF + :keyword: SHOULD + + The VNF **SHOULD** create a single component VNF for VNFCs + that can be used by other VNFs. + +.. req:: + :id: R-23035 + :target: VNF + :keyword: MUST + + The VNF **MUST** be designed to scale horizontally (more + instances of a VNF or VNFC) and not vertically (moving the existing + instances to larger VMs or increasing the resources within a VM) + to achieve effective utilization of cloud resources. + +.. req:: + :id: R-30650 + :target: VNF + :keyword: MUST + + The VNF **MUST** utilize cloud provided infrastructure and + VNFs (e.g., virtualized Local Load Balancer) as part of the VNF so + that the cloud can manage and provide a consistent service resiliency + and methods across all VNF's. + +.. req:: + :id: R-12709 + :target: VNF + :keyword: SHOULD + + The VNFC **SHOULD** be independently deployed, configured, + upgraded, scaled, monitored, and administered by ONAP. + +.. req:: + :id: R-37692 + :target: VNF + :keyword: MUST + + The VNFC **MUST** provide API versioning to allow for + independent upgrades of VNFC. + +.. req:: + :id: R-86585 + :target: VNF + :keyword: SHOULD + + The VNFC **SHOULD** minimize the use of state within + a VNFC to facilitate the movement of traffic from one instance + to another. + +.. req:: + :id: R-65134 + :target: VNF + :keyword: SHOULD + + The VNF **SHOULD** maintain state in a geographically + redundant datastore that may, in fact, be its own VNFC. + +.. req:: + :id: R-75850 + :target: VNF + :keyword: SHOULD + + The VNF **SHOULD** decouple persistent data from the VNFC + and keep it in its own datastore that can be reached by all instances + of the VNFC requiring the data. + +.. req:: + :id: R-88199 + :target: VNF + :keyword: MUST + + The VNF **MUST** utilize a persistent datastore service that + can meet the data performance/latency requirements. (For example: + Datastore service could be a VNFC in VNF or a DBaaS in the Cloud + execution environment) + +.. req:: + :id: R-99656 + :target: VNF + :keyword: MUST + + The VNF **MUST** NOT terminate stable sessions if a VNFC + instance fails. + +.. req:: + :id: R-84473 + :target: VNF + :keyword: MUST + + The VNF **MUST** enable DPDK in the guest OS for VNF's requiring + high packets/sec performance. High packet throughput is defined as greater + than 500K packets/sec. + +.. req:: + :id: R-54430 + :target: VNF + :keyword: MUST + + The VNF **MUST** use the NCSP's supported library and compute + flavor that supports DPDK to optimize network efficiency if using DPDK. [1]_ + +.. req:: + :id: R-18864 + :target: VNF + :keyword: MUST NOT + + The VNF **MUST NOT** use technologies that bypass virtualization + layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary + to meet functional or performance requirements). + +.. req:: + :id: R-64768 + :target: VNF + :keyword: MUST + + The VNF **MUST** limit the size of application data packets + to no larger than 9000 bytes for SDN network-based tunneling when + guest data packets are transported between tunnel endpoints that + support guest logical networks. + +.. req:: + :id: R-74481 + :target: VNF + :keyword: MUST NOT + + The VNF **MUST NOT** require the use of a dynamic routing + protocol unless necessary to meet functional requirements. + +.. [1] + Refer to NCSP’s Network Cloud specification + diff --git a/docs/Chapter4/Develop-Steps.rst b/docs/Chapter4/Develop-Steps.rst new file mode 100644 index 0000000..30fe07e --- /dev/null +++ b/docs/Chapter4/Develop-Steps.rst @@ -0,0 +1,29 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +VNF Develop Steps +----------------- + +Aid to help the VNF provider to fasten the integration with the GVNFM, the +ONAP provides the VNF SDK tools, and the documents. In this charter, +the develop steps for VNF providers will be introduced. + +First, using the VNF SDK tools to design the VNF with TOSCA model and +output the VNF TOSCA package. The VNF package can be validated, and +tested. + +Second, the VNF provider should provide the VNF Rest API to integrate with +the GVNFM if needed. The VNF Rest API is aligned to the ETSI IFA +document. + +Third, the TOSCA model supports the HPA feature. + +Note: + +1. The scripts to extend capacity to satisfy some special requirements. + In the R2, the scripts is not implemented fully, and will be provided + in the next release. + +2. The monitoring and scale policy also be provide the next release. diff --git a/docs/Chapter4/Devops.rst b/docs/Chapter4/Devops.rst new file mode 100644 index 0000000..702db95 --- /dev/null +++ b/docs/Chapter4/Devops.rst @@ -0,0 +1,74 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +VNF Devops +--------------------- + +This section includes guidelines for VNF providers to ensure that a Network +Cloud Service Provider’s operations personnel have a common and +consistent way to support VNFs and VNFCs. + +NCSPs may elect to support standard images to enable compliance with +security, audit, regulatory and other needs. As part of the overall VNF +software bundle, VNF suppliers using standard images would typically +provide the NCSP with an install package consistent with the default OS +package manager (e.g. aptitude for Ubuntu, yum for Redhat/CentOS). + +Section 5.a DevOps in *VNF Guidelines* describes +the DevOps guidelines for VNFs. + +DevOps Requirements + +* R-46960 NCSPs **MAY** operate a limited set of Guest OS and CPU + architectures and families, virtual machines, etc. +* R-23475 VNFCs **SHOULD** be agnostic to the details of the Network Cloud + (such as hardware, host OS, Hypervisor or container technology) and must run + on the Network Cloud with acknowledgement to the paradigm that the Network + Cloud will continue to rapidly evolve and the underlying components of + the platform will change regularly. +* R-33846 The VNF **MUST** install the NCSP required software on Guest OS + images when not using the NCSP provided Guest OS images. [1]_ +* R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [1]_ +* R-02997 The VNF **MUST** preserve their persistent data. Running VMs + will not be backed up in the Network Cloud infrastructure. +* R-29760 The VNFC **MUST** be installed on non-root file systems, + unless software is specifically included with the operating system + distribution of the guest image. +* R-20860 The VNF **MUST** be agnostic to the underlying infrastructure + (such as hardware, host OS, Hypervisor), any requirements should be + provided as specification to be fulfilled by any hardware. +* R-89800 The VNF **MUST NOT** require Hypervisor-level customization + from the cloud provider. +* R-86758 The VNF **SHOULD** provide an automated test suite to validate + every new version of the software on the target environment(s). The tests + should be of sufficient granularity to independently test various + representative VNF use cases throughout its lifecycle. Operations might + choose to invoke these tests either on a scheduled basis or on demand to + support various operations functions including test, turn-up and + troubleshooting. +* R-39650 The VNF **SHOULD** provide the ability to test incremental + growth of the VNF. +* R-14853 The VNF **MUST** respond to a "move traffic" [2]_ command + against a specific VNFC, moving all existing session elsewhere with + minimal disruption if a VNF provides a load balancing function across + multiple instances of its VNFCs. Note: Individual VNF performance + aspects (e.g., move duration or disruption scope) may require further + constraints. +* R-06327 The VNF **MUST** respond to a "drain VNFC" [2]_ command against + a specific VNFC, preventing new session from reaching the targeted VNFC, + with no disruption to active sessions on the impacted VNFC, if a VNF + provides a load balancing function across multiple instances of its VNFCs. + This is used to support scenarios such as proactive maintenance with no + user impact. +* R-64713 The VNF **SHOULD** support a software promotion methodology + from dev/test -> pre-prod -> production in software, development & + testing and operations. + + +.. [1] + Refer to NCSP’s Network Cloud specification + +.. [2] + Not currently supported in ONAP release 1 + diff --git a/docs/Chapter4/Modularity.rst b/docs/Chapter4/Modularity.rst new file mode 100644 index 0000000..12024bd --- /dev/null +++ b/docs/Chapter4/Modularity.rst @@ -0,0 +1,352 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +VNF Modularity +-------------- + +ONAP Heat Orchestration Templates: Overview +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +ONAP supports a modular Heat Orchestration Template design pattern, +referred to as *VNF Modularity.* + +ONAP VNF Modularity Overview +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +With VNF Modularity, a single VNF may be composed from one or more Heat +Orchestration Templates, each of which represents a subset of the +overall VNF. These component parts are referred to as “\ *VNF +Modules*\ ”. During orchestration, these modules are deployed +incrementally to create the complete VNF. + +A modular Heat Orchestration Template can be either one of the following +types: + +1. Base Module + +2. Incremental Module + +3. Cinder Volume Module + +* R-37028 The VNF **MUST** be composed of one “base” module. +* R-41215 The VNF **MAY** have zero to many “incremental” modules. +* R-20974 The VNF **MUST** deploy the base module first, prior to + the incremental modules. + +ONAP also supports the concept of an optional, independently deployed +Cinder volume via a separate Heat Orchestration Templates, referred to +as a Cinder Volume Module. This allows the volume to persist after a +Virtual Machine (VM) (i.e., OS::Nova::Server) is deleted, allowing the +volume to be reused on another instance (e.g., during a failover +activity). + +* R-11200 The VNF **MUST** keep the scope of a Cinder volume module, + when it exists, to be 1:1 with the VNF Base Module or Incremental Module. + +* R-38474 The VNF **MUST** have a corresponding environment file for + a Base Module. +* R-81725 The VNF **MUST** have a corresponding environment file for + an Incremental Module. +* R-53433 The VNF **MUST** have a corresponding environment file for + a Cinder Volume Module. + +These concepts will be described in more detail throughout the document. +This overview is provided to set the stage and help clarify the concepts +that will be introduced. + + +ONAP VNF Modularity +^^^^^^^^^^^^^^^^^^^^^^ + +ONAP supports a modular Heat Orchestration Template design pattern, +referred to as *VNF Modularity.* With this approach, a single VNF may be +composed from one or more Heat Orchestration Templates, each of which +represents a subset of the overall VNF. These component parts are +referred to as “\ *VNF Modules*\ ”. During orchestration, these modules +are deployed incrementally to create the complete VNF. + +A modular Heat Orchestration Template can be either one of the following +types: + +1. Base Module + +2. Incremental Module + +3. Cinder Volume Module + +A VNF must be composed of one “base” module and may be composed of zero +to many “incremental” modules. The base module must be deployed first, +prior to the incremental modules. + +ONAP also supports the concept of an optional, independently deployed +Cinder volume via a separate Heat Orchestration Templates, referred to +as a Cinder Volume Module. This allows the volume to persist after a VM +(i.e., OS::Nova::Server) is deleted, allowing the volume to be reused on +another instance (e.g., during a failover activity). + +The scope of a Cinder volume module, when it exists, must be 1:1 with a +Base module or Incremental Module. + +A Base Module must have a corresponding environment file. + +An Incremental Module must have a corresponding environment file. + +A Cinder Volume Module must have a corresponding environment file. + +A VNF module (base, incremental, cinder) may support nested templates. + +A shared Heat Orchestration Template resource must be defined in the +base module. A shared resource is a resource that that will be +referenced by another resource that is defined in the Base Module and/or +one or more incremental modules. + +When the shared resource needs to be referenced by a resource in an +incremental module, the UUID of the shared resource must be exposed by +declaring an ONAP Base Module Output Parameter. + +Note that a Cinder volume is *not* a shared resource. A volume template +must correspond 1:1 with a base module or incremental module. + +An example of a shared resource is the resource +OS::Neutron::SecurityGroup. Security groups are sets of IP filter rules +that are applied to a VNF’s networking. The resource OS::Neutron::Port +has a property security\_groups which provides the security groups +associated with port. The value of parameter(s) associated with this +property must be the UUIDs of the resource(s) +OS::Neutron::SecurityGroup. + +*Note:* A Cinder volume is *not* considered a shared resource. A volume +template must correspond 1:1 with a base template or add-on module +template. + +Suggested Patterns for Modular VNFs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +There are numerous variations of VNF modularity. Below are two suggested +usage patterns. + +**Option 1: Modules per VNFC type** + +a. Base module contains only the shared resources. + +b. Group all VMs (e.g., VNFCs) of a given type (i.e. {vm-type}) into its + own incremental module. That is, the VNF has an incremental module + for each {vm-type}. + +c. For a given {vm-type} incremental module, the VNF may have + + i. One incremental module used for both initial turn up and re-used + for scaling. This approach is used when the number of VMs + instantiated will be the same for initial deployment and scaling. + + ii. Two incremental modules, where one is used for initial turn up + and one is used for scaling. This approach is used when the + number of VMs instantiated will be different for initial + deployment and scaling. + +**Option 2: Base VNF with Incremental Growth Modules** + +a. Base module contains a complete initial VNF instance + +b. Incremental modules for incremental scaling units + + i. May contain VMs of multiple types in logical scaling combinations + + ii. May be separated by VM type for multi-dimensional scaling + +With no growth units, Option 2 is equivalent to the “One Heat Template +per VNF” model. + +Note that modularization of VNFs is not required. A single Heat +Orchestration Template (a base module) may still define a complete VNF, +which might be appropriate for smaller VNFs that do not have any scaling +options. + +Modularity Rules +^^^^^^^^^^^^^^^^^^^ + +There are some rules to follow when building modular VNF templates: + +1. All VNFs must have one Base VNF Module (template) that must be the + first one deployed. The base template: + + a. Must include all shared resources (e.g., private networks, server + groups, security groups) + + b. Must expose all shared resources (by UUID) as “outputs” in its + associated Heat template (i.e., ONAP Base Module Output + Parameters) + + c. May include initial set of VMs + + d. May be operational as a stand-alone “minimum” configuration of the + VNF + +2. VNFs may have one or more incremental modules which: + + a. Defines additional resources that can be added to an existing VNF + + b. Must be complete Heat templates + + i. i.e. not snippets to be incorporated into some larger template + + c. Should define logical growth-units or sub-components of an overall + VNF + + d. On creation, receives appropriate Base Module outputs as + parameters + + i. Provides access to all shared resources (by UUID) + + ii. must not be dependent on other Add-On VNF Modules + + e. Multiple instances of an incremental Module may be added to the + same VNF (e.g., incrementally grow a VNF by a fixed “add-on” + growth units) + +3. Each VNF Module (base or incremental) may have (optional) an + associated Cinder Volume Module (see Cinder Volume Templates) + + a. Volume modules must correspond 1:1 with a base module or + incremental module + + b. A Cinder volume may be embedded within the base module or + incremental module if persistence is not required + +4. Shared resource UUIDs are passed between the base module and + incremental modules via Heat Outputs Parameters (i.e., Base Module + Output Parameters) + + a. The output parameter name in the base must match the parameter + name in the add-on module + +VNF Modularity Examples +^^^^^^^^^^^^^^^^^^^^^^^ + +*Example: Base Module creates SecurityGroup* + +A VNF has a base module, named base.yaml, that defines a +OS::Neutron::SecurityGroup. The security group will be referenced by an +OS::Neutron::Port resource in an incremental module, named +INCREMENTAL\_MODULE.yaml. The base module defines a parameter in the out +section named dns\_sec\_grp\_id. dns\_sec\_grp\_id is defined as a +parameter in the incremental module. ONAP captures the UUID value of +dns\_sec\_grp\_id from the base module output statement and provides the +value to the incremental module. + +Note that the example below is not a complete Heat Orchestration +Template. The {network-role} has been defined as oam to represent an oam +network and the {vm-type} has been defined as dns. + +base\_MODULE.yaml + +.. code-block:: yaml + + parameters: + . . . + + resources: + DNS_SECURITY_GROUP: + type: OS::Neutron::SecurityGroup + properties: + description: vDNS security group + name: + str_replace: + template: VNF_NAME_sec_grp_DNS + params: + VMF_NAME: {get_param: vnf_name} + rules: [. . . . . + + . . . + + outputs: + dns_sec_grp_id: + description: UUID of DNS Resource SecurityGroup + value: { get_resource: DNS_SECURITY_GROUP } + + +INCREMENTAL\_MODULE.yaml + +.. code-block:: yaml + + parameters: + dns_sec_grp_id: + type: string + description: security group UUID + . . . + + resources: + dns_oam_0_port: + type: OS::Neutron::Port + properties: + name: + str_replace: + template: VNF_NAME_dns_oam_port + params: + VNF_NAME: {get_param: vnf_name} + network: { get_param: oam_net_name } + fixed_ips: [{ "ip_address": { get_param: dns_oam_ip_0 }}] + security_groups: [{ get_param: dns_sec_grp_id }] + + +*Examples: Base Module creates an internal network* + +A VNF has a base module, named base\_module.yaml, that creates an +internal network. An incremental module, named incremental\_module.yaml, +will create a VM that will connect to the internal network. The base +module defines a parameter in the out section named int\_oam\_net\_id. +int\_oam\_net\_id is defined as a parameter in the incremental module. +ONAP captures the UUID value of int\_oam\_net\_id from the base module +output statement and provides the value to the incremental module. + +Note that the example below is not a complete Heat Orchestration +Template. The {network-role} has been defined as oam to represent an oam +network and the {vm-type} has been defined as lb for load balancer. + +base.yaml + +.. code-block:: yaml + + heat_template_version: 2013-05-23 + + resources: + int_oam_network: + type: OS::Neutron::Network + properties: + name: {… } + . . . + outputs: + int_oam_net_id: + value: {get_resource: int_oam_network } + + +incremental.yaml + +.. code-block:: yaml + + heat_template_version: 2013-05-23 + + parameters: + int_oam_net_id: + type: string + description: ID of shared private network from Base template + lb_name_0: + type: string + description: name for the add-on VM instance + + Resources: + lb_server: + type: OS::Nova::Server + properties: + name: {get_param: lb_name_0} + networks: + - port: { get_resource: lb_port } + . . . + + lb_port: + type: OS::Neutron::Port + properties: + network_id: { get_param: int_oam_net_id } + ... diff --git a/docs/Chapter4/Resiliency.rst b/docs/Chapter4/Resiliency.rst new file mode 100644 index 0000000..bf3e2e8 --- /dev/null +++ b/docs/Chapter4/Resiliency.rst @@ -0,0 +1,301 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +VNF Resiliency +------------------------- + +The VNF is responsible for meeting its resiliency goals and must factor +in expected availability of the targeted virtualization environment. +This is likely to be much lower than found in a traditional data center. +Resiliency is defined as the ability of the VNF to respond to error +conditions and continue to provide the service intended. A number of +software resiliency dimensions have been identified as areas that should +be addressed to increase resiliency. As VNFs are deployed into the +Network Cloud, resiliency must be designed into the VNF software to +provide high availability versus relying on the Network Cloud to achieve +that end. + +Section 5.a Resiliency in *VNF Guidelines* describes +the overall guidelines for designing VNFs to meet resiliency goals. +Below are more detailed resiliency requirements for VNFs. + +All Layer Redundancy +^^^^^^^^^^^^^^^^^^^^^^ + +Design the VNF to be resilient to the failures of the underlying +virtualized infrastructure (Network Cloud). VNF design considerations +would include techniques such as multiple vLANs, multiple local and +geographic instances, multiple local and geographic data replication, +and virtualized services such as Load Balancers. + + +All Layer Redundancy Requirements + +* R-52499 The VNF **MUST** meet their own resiliency goals and not rely + on the Network Cloud. +* R-42207 The VNF **MUST** design resiliency into a VNF such that the + resiliency deployment model (e.g., active-active) can be chosen at + run-time. +* R-03954 The VNF **MUST** survive any single points of failure within + the Network Cloud (e.g., virtual NIC, VM, disk failure). +* R-89010 The VNF **MUST** survive any single points of software failure + internal to the VNF (e.g., in memory structures, JMS message queues). +* R-67709 The VNF **MUST** be designed, built and packaged to enable + deployment across multiple fault zones (e.g., VNFCs deployed in + different servers, racks, OpenStack regions, geographies) so that + in the event of a planned/unplanned downtime of a fault zone, the + overall operation/throughput of the VNF is maintained. +* R-35291 The VNF **MUST** support the ability to failover a VNFC + automatically to other geographically redundant sites if not + deployed active-active to increase the overall resiliency of the VNF. +* R-36843 The VNF **MUST** support the ability of the VNFC to be deployable + in multi-zoned cloud sites to allow for site support in the event of cloud + zone failure or upgrades. +* R-00098 The VNF **MUST NOT** impact the ability of the VNF to provide + service/function due to a single container restart. +* R-79952 The VNF **SHOULD** support container snapshots if not for rebuild + and evacuate for rollback or back out mechanism. + +Minimize Cross Data-Center Traffic +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Avoid performance-sapping data center-to-data center replication delay +by applying techniques such as caching and persistent transaction paths +- Eliminate replication delay impact between data centers by using a +concept of stickiness (i.e., once a client is routed to data center "A", +the client will stay with Data center “A” until the entire session is +completed). + +Minimize Cross Data-Center Traffic Requirements + +* R-92935 The VNF **SHOULD** minimize the propagation of state information + across multiple data centers to avoid cross data center traffic. + +Application Resilient Error Handling +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Ensure an application communicating with a downstream peer is equipped +to intelligently handle all error conditions. Make sure code can handle +exceptions seamlessly - implement smart retry logic and implement +multi-point entry (multiple data centers) for back-end system +applications. + +Application Resilient Error Handling Requirements + +* R-26371 The VNF **MUST** detect communication failure for inter VNFC + instance and intra/inter VNF and re-establish communication + automatically to maintain the VNF without manual intervention to + provide service continuity. +* R-18725 The VNF **MUST** handle the restart of a single VNFC instance + without requiring all VNFC instances to be restarted. +* R-06668 The VNF **MUST** handle the start or restart of VNFC instances + in any order with each VNFC instance establishing or re-establishing + required connections or relationships with other VNFC instances and/or + VNFs required to perform the VNF function/role without requiring VNFC + instance(s) to be started/restarted in a particular order. +* R-80070 The VNF **MUST** handle errors and exceptions so that they do + not interrupt processing of incoming VNF requests to maintain service + continuity (where the error is not directly impacting the software + handling the incoming request). +* R-32695 The VNF **MUST** provide the ability to modify the number of + retries, the time between retries and the behavior/action taken after + the retries have been exhausted for exception handling to allow the + NCSP to control that behavior, where the interface and/or functional + specification allows for altering behaviour. +* R-48356 The VNF **MUST** fully exploit exception handling to the extent + that resources (e.g., threads and memory) are released when no longer + needed regardless of programming language. +* R-67918 The VNF **MUST** handle replication race conditions both locally + and geo-located in the event of a data base instance failure to maintain + service continuity. +* R-36792 The VNF **MUST** automatically retry/resubmit failed requests + made by the software to its downstream system to increase the success rate. +* R-70013 The VNF **MUST NOT** require any manual steps to get it ready for + service after a container rebuild. +* R-65515 The VNF **MUST** provide a mechanism and tool to start VNF + containers (VMs) without impacting service or service quality assuming + another VNF in same or other geographical location is processing service + requests. +* R-94978 The VNF **MUST** provide a mechanism and tool to perform a graceful + shutdown of all the containers (VMs) in the VNF without impacting service + or service quality assuming another VNF in same or other geographical + location can take over traffic and process service requests. + + +System Resource Optimization +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Ensure an application is using appropriate system resources for the task +at hand; for example, do not use network or IO operations inside +critical sections, which could end up blocking other threads or +processes or eating memory if they are unable to complete. Critical +sections should only contain memory operation, and should not contain +any network or IO operation. + + +System Resource Optimization Requirements + +* R-22059 The VNF **MUST NOT** execute long running tasks (e.g., IO, + database, network operations, service calls) in a critical section + of code, so as to minimize blocking of other operations and increase + concurrent throughput. +* R-63473 The VNF **MUST** automatically advertise newly scaled + components so there is no manual intervention required. +* R-74712 The VNF **MUST** utilize FQDNs (and not IP address) for + both Service Chaining and scaling. +* R-41159 The VNF **MUST** deliver any and all functionality from any + VNFC in the pool (where pooling is the most suitable solution). The + VNFC pool member should be transparent to the client. Upstream and + downstream clients should only recognize the function being performed, + not the member performing it. +* R-85959 The VNF **SHOULD** automatically enable/disable added/removed + sub-components or component so there is no manual intervention required. +* R-06885 The VNF **SHOULD** support the ability to scale down a VNFC pool + without jeopardizing active sessions. Ideally, an active session should + not be tied to any particular VNFC instance. +* R-12538 The VNF **SHOULD** support load balancing and discovery + mechanisms in resource pools containing VNFC instances. +* R-98989 The VNF **SHOULD** utilize resource pooling (threads, + connections, etc.) within the VNF application so that resources + are not being created and destroyed resulting in resource management + overhead. +* R-55345 The VNF **SHOULD** use techniques such as “lazy loading” when + initialization includes loading catalogues and/or lists which can grow + over time, so that the VNF startup time does not grow at a rate + proportional to that of the list. +* R-35532 The VNF **SHOULD** release and clear all shared assets (memory, + database operations, connections, locks, etc.) as soon as possible, + especially before long running sync and asynchronous operations, so as + to not prevent use of these assets by other entities. + + +Application Configuration Management +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Leverage configuration management audit capability to drive conformity +to develop gold configurations for technologies like Java, Python, etc. + +Application Configuration Management Requirements + +* R-77334 The VNF **MUST** allow configurations and configuration parameters + to be managed under version control to ensure consistent configuration + deployment, traceability and rollback. +* R-99766 The VNF **MUST** allow configurations and configuration parameters + to be managed under version control to ensure the ability to rollback to + a known valid configuration. +* R-73583 The VNF **MUST** allow changes of configuration parameters + to be consumed by the VNF without requiring the VNF or its sub-components + to be bounced so that the VNF availability is not effected. + + +Intelligent Transaction Distribution & Management +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Leverage Intelligent Load Balancing and redundant components (hardware +and modules) for all transactions, such that at any point in the +transaction: front end, middleware, back end -- a failure in any one +component does not result in a failure of the application or system; +i.e., transactions will continue to flow, albeit at a possibly reduced +capacity until the failed component restores itself. Create redundancy +in all layers (software and hardware) at local and remote data centers; +minimizing interdependencies of components (i.e. data replication, +deploying non-related elements in the same container). + +Intelligent Transaction Distribution & Management Requirements + +* R-21558 The VNF **SHOULD** use intelligent routing by having knowledge + of multiple downstream/upstream endpoints that are exposed to it, to + ensure there is no dependency on external services (such as load balancers) + to switch to alternate endpoints. +* R-08315 The VNF **SHOULD** use redundant connection pooling to connect + to any backend data source that can be switched between pools in an + automated/scripted fashion to ensure high availability of the connection + to the data source. +* R-27995 The VNF **SHOULD** include control loop mechanisms to notify + the consumer of the VNF of their exceeding SLA thresholds so the consumer + is able to control its load against the VNF. + +Deployment Optimization +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Reduce opportunity for failure, by human or by machine, through smarter +deployment practices and automation. This can include rolling code +deployments, additional testing strategies, and smarter deployment +automation (remove the human from the mix). + +Deployment Optimization Requirements + +* R-73364 The VNF **MUST** support at least two major versions of the + VNF software and/or sub-components to co-exist within production + environments at any time so that upgrades can be applied across + multiple systems in a staggered manner. +* R-02454 The VNF **MUST** support the existence of multiple major/minor + versions of the VNF software and/or sub-components and interfaces that + support both forward and backward compatibility to be transparent to + the Service Provider usage. +* R-57855 The VNF **MUST** support hitless staggered/rolling deployments + between its redundant instances to allow "soak-time/burn in/slow roll" + which can enable the support of low traffic loads to validate the + deployment prior to supporting full traffic loads. +* R-64445 The VNF **MUST** support the ability of a requestor of the + service to determine the version (and therefore capabilities) of the + service so that Network Cloud Service Provider can understand the + capabilities of the service. +* R-56793 The VNF **MUST** test for adherence to the defined performance + budgets at each layer, during each delivery cycle with delivered + results, so that the performance budget is measured and the code + is adjusted to meet performance budget. +* R-77667 The VNF **MUST** test for adherence to the defined performance + budget at each layer, during each delivery cycle so that the performance + budget is measured and feedback is provided where the performance budget + is not met. +* R-49308 The VNF **SHOULD** test for adherence to the defined resiliency + rating recommendation at each layer, during each delivery cycle with + delivered results, so that the resiliency rating is measured and the + code is adjusted to meet software resiliency requirements. +* R-16039 The VNF **SHOULD** test for adherence to the defined + resiliency rating recommendation at each layer, during each + delivery cycle so that the resiliency rating is measured and + feedback is provided where software resiliency requirements are + not met. + +Monitoring & Dashboard +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Promote dashboarding as a tool to monitor and support the general +operational health of a system. It is critical to the support of the +implementation of many resiliency patterns essential to the maintenance +of the system. It can help identify unusual conditions that might +indicate failure or the potential for failure. This would contribute to +improve Mean Time to Identify (MTTI), Mean Time to Repair (MTTR), and +post-incident diagnostics. + +Monitoring & Dashboard Requirements + +* R-34957 The VNF **MUST** provide a method of metrics gathering for each + layer's performance to identify/document variances in the allocations so + they can be addressed. +* R-49224 The VNF **MUST** provide unique traceability of a transaction + through its life cycle to ensure quick and efficient troubleshooting. +* R-52870 The VNF **MUST** provide a method of metrics gathering + and analysis to evaluate the resiliency of the software from both + a granular as well as a holistic standpoint. This includes, but is + not limited to thread utilization, errors, timeouts, and retries. +* R-92571 The VNF **MUST** provide operational instrumentation such as + logging, so as to facilitate quick resolution of issues with the VNF to + provide service continuity. +* R-48917 The VNF **MUST** monitor for and alert on (both sender and + receiver) errant, running longer than expected and missing file transfers, + so as to minimize the impact due to file transfer errors. +* R-28168 The VNF **SHOULD** use an appropriately configured logging + level that can be changed dynamically, so as to not cause performance + degradation of the VNF due to excessive logging. +* R-87352 The VNF **SHOULD** utilize Cloud health checks, when available + from the Network Cloud, from inside the application through APIs to check + the network connectivity, dropped packets rate, injection, and auto failover + to alternate sites if needed. +* R-16560 The VNF **SHOULD** conduct a resiliency impact assessment for all + inter/intra-connectivity points in the VNF to provide an overall resiliency + rating for the VNF to be incorporated into the software design and + development of the VNF. diff --git a/docs/Chapter4/Security.rst b/docs/Chapter4/Security.rst new file mode 100644 index 0000000..a0691ae --- /dev/null +++ b/docs/Chapter4/Security.rst @@ -0,0 +1,563 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +VNF Security +---------------------- + +The objective of this section is to provide the key security +requirements that need to be met by VNFs. The security requirements are +grouped into five areas as listed below. Other security areas will be +addressed in future updates. These security requirements are applicable +to all VNFs. Additional security requirements for specific types of VNFs +will be applicable and are outside the scope of these general +requirements. + +Section 5.a Security in *VNF Guidelines* outlines +the five broad security areas for VNFs that are detailed in the +following sections: + +- **VNF General Security**: This section addresses general security + requirements for the VNFs that the VNF provider will need to address. + +- **VNF Identity and Access Management**: This section addresses + security requirements with respect to Identity and Access Management + as these pertain to generic VNFs. + +- **VNF API Security**: This section addresses the generic security + requirements associated with APIs. These requirements are applicable + to those VNFs that use standard APIs for communication and data + exchange. + +- **VNF Security Analytics**: This section addresses the security + requirements associated with analytics for VNFs that deal with + monitoring, data collection and analysis. + +- **VNF Data Protection**: This section addresses the security + requirements associated with data protection. + +VNF General Security Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section provides details on the VNF general security requirements +on various security areas such as user access control, network security, +ACLs, infrastructure security, and vulnerability management. These +requirements cover topics associated with compliance, security patching, +logging/accounting, authentication, encryption, role-based access +control, least privilege access/authorization. The following security +requirements need to be met by the solution in a virtual environment: + +General Security Requirements + +Integration and operation within a robust security environment is necessary +and expected. The security architecture will include one or more of the +following: IDAM (Identity and Access Management) for all system and +applications access, Code scanning, network vulnerability scans, OS, +Database and application patching, malware detection and cleaning, +DDOS prevention, network security gateways (internal and external) +operating at various layers, host and application based tools for +security compliance validation, aggressive security patch application, +tightly controlled software distribution and change control processes +and other state of the art security solutions. The VNF is expected to +function reliably within such an environment and the developer is +expected to understand and accommodate such controls and can expected +to supply responsive interoperability support and testing throughout +the product’s lifecycle. + +* R-23740 The VNF **MUST** accommodate the security principle of + “least privilege” during development, implementation and operation. + The importance of “least privilege” cannot be overstated and must be + observed in all aspects of VNF development and not limited to security. + This is applicable to all sections of this document. +* R-61354 The VNF **MUST** implement access control list for OA&M + services (e.g., restricting access to certain ports or applications). +* R-85633 The VNF **MUST** implement Data Storage Encryption + (database/disk encryption) for Sensitive Personal Information (SPI) + and other subscriber identifiable data. Note: subscriber’s SPI/data + must be encrypted at rest, and other subscriber identifiable data + should be encrypted at rest. Other data protection requirements exist + and should be well understood by the developer. +* R-92207 The VNF **SHOULD** implement a mechanism for automated and + frequent "system configuration (automated provisioning / closed loop)" + auditing. +* R-23882 The VNF **SHOULD** be scanned using both network scanning + and application scanning security tools on all code, including underlying + OS and related configuration. Scan reports shall be provided. Remediation + roadmaps shall be made available for any findings. +* R-46986 The VNF **SHOULD** have source code scanned using scanning + tools (e.g., Fortify) and provide reports. +* R-55830 The VNF **MUST** distribute all production code from NCSP + internal sources only. No production code, libraries, OS images, etc. + shall be distributed from publically accessible depots. +* R-99771 The VNF **MUST** provide all code/configuration files in a + "Locked down" or hardened state or with documented recommendations for + such hardening. All unnecessary services will be disabled. VNF provider + default credentials, community strings and other such artifacts will be + removed or disclosed so that they can be modified or removed during + provisioning. +* R-19768 The VNF **SHOULD** support L3 VPNs that enable segregation of + traffic by application (dropping packets not belonging to the VPN) (i.e., + AVPN, IPSec VPN for Internet routes). +* R-33981 The VNF **SHOULD** interoperate with various access control + mechanisms for the Network Cloud execution environment (e.g., + Hypervisors, containers). +* R-40813 The VNF **SHOULD** support the use of virtual trusted platform + module, hypervisor security testing and standards scanning tools. +* R-56904 The VNF **MUST** interoperate with the ONAP (SDN) Controller so that + it can dynamically modify the firewall rules, ACL rules, QoS rules, virtual + routing and forwarding rules. +* R-26586 The VNF **SHOULD** support the ability to work with aliases + (e.g., gateways, proxies) to protect and encapsulate resources. +* R-49956 The VNF **MUST** pass all access to applications (Bearer, + signaling and OA&M) through various security tools and platforms from + ACLs, stateful firewalls and application layer gateways depending on + manner of deployment. The application is expected to function (and in + some cases, interwork) with these security tools. +* R-69649 The VNF **MUST** have all vulnerabilities patched as soon + as possible. Patching shall be controlled via change control process + with vulnerabilities disclosed along with mitigation recommendations. +* R-78010 The VNF **MUST** use the NCSP’s IDAM API for Identification, + authentication and access control of customer or VNF application users. +* R-42681 The VNF **MUST** use the NCSP’s IDAM API or comply with + the requirements if not using the NCSP’s IDAM API, for identification, + authentication and access control of OA&M and other system level + functions. +* R-68589 The VNF **MUST**, if not using the NCSP’s IDAM API, support + User-IDs and passwords to uniquely identify the user/application. VNF + needs to have appropriate connectors to the Identity, Authentication + and Authorization systems that enables access at OS, Database and + Application levels as appropriate. +* R-52085 The VNF **MUST**, if not using the NCSP’s IDAM API, provide + the ability to support Multi-Factor Authentication (e.g., 1st factor = + Software token on device (RSA SecureID); 2nd factor = User Name+Password, + etc.) for the users. +* R-98391 The VNF **MUST**, if not using the NCSP’s IDAM API, support + Role-Based Access Control to permit/limit the user/application to + performing specific activities. +* R-63217 The VNF **MUST**, if not using the NCSP’s IDAM API, support + logging via ONAP for a historical view of “who did what and when”. +* R-62498 The VNF **MUST**, if not using the NCSP’s IDAM API, encrypt + OA&M access (e.g., SSH, SFTP). +* R-79107 The VNF **MUST**, if not using the NCSP’s IDAM API, enforce + a configurable maximum number of Login attempts policy for the users. + VNF provider must comply with "terminate idle sessions" policy. + Interactive sessions must be terminated, or a secure, locking screensaver + must be activated requiring authentication, after a configurable period + of inactivity. The system-based inactivity timeout for the enterprise + identity and access management system must also be configurable. +* R-35144 The VNF **MUST**, if not using the NCSP’s IDAM API, comply + with the NCSP’s credential management policy. +* R-75041 The VNF **MUST**, if not using the NCSP’s IDAM API, expire + passwords at regular configurable intervals. +* R-46908 The VNF **MUST**, if not using the NCSP’s IDAM API, comply + with "password complexity" policy. When passwords are used, they shall + be complex and shall at least meet the following password construction + requirements: (1) be a minimum configurable number of characters in + length, (2) include 3 of the 4 following types of characters: + upper-case alphabetic, lower-case alphabetic, numeric, and special, + (3) not be the same as the UserID with which they are associated or + other common strings as specified by the environment, (4) not contain + repeating or sequential characters or numbers, (5) not to use special + characters that may have command functions, and (6) new passwords must + not contain sequences of three or more characters from the previous + password. +* R-39342 The VNF **MUST**, if not using the NCSP’s IDAM API, comply + with "password changes (includes default passwords)" policy. Products + will support password aging, syntax and other credential management + practices on a configurable basis. +* R-40521 The VNF **MUST**, if not using the NCSP’s IDAM API, support + use of common third party authentication and authorization tools such + as TACACS+, RADIUS. +* R-41994 The VNF **MUST**, if not using the NCSP’s IDAM API, comply + with "No Self-Signed Certificates" policy. Self-signed certificates + must be used for encryption only, using specified and approved + encryption protocols such as TLS 1.2 or higher or equivalent security + protocols such as IPSec, AES. +* R-23135 The VNF **MUST**, if not using the NCSP’s IDAM API, + authenticate system to system communications where one system + accesses the resources of another system, and must never conceal + individual accountability. + +VNF Identity and Access Management Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following security requirements for logging, identity, and access +management need to be met by the solution in a virtual environment: + + +Identity and Access Management Requirements + +* R-95105 The VNF **MUST** host connectors for access to the application + layer. +* R-45496 The VNF **MUST** host connectors for access to the OS + (Operating System) layer. +* R-05470 The VNF **MUST** host connectors for access to the database layer. +* R-99174 The VNF **MUST** comply with Individual Accountability + (each person must be assigned a unique ID) when persons or non-person + entities access VNFs. +* R-42874 The VNF **MUST** comply with Least Privilege (no more + privilege than required to perform job functions) when persons + or non-person entities access VNFs. +* R-71787 The VNF **MUST** comply with Segregation of Duties (access to a + single layer and no developer may access production without special + oversight) when persons or non-person entities access VNFs. +* R-86261 The VNF **MUST NOT** allow VNF provider access to VNFs remotely. +* R-49945 The VNF **MUST** authorize VNF provider access through a + client application API by the client application owner and the resource + owner of the VNF before provisioning authorization through Role Based + Access Control (RBAC), Attribute Based Access Control (ABAC), or other + policy based mechanism. +* R-31751 The VNF **MUST** subject VNF provider access to privilege + reconciliation tools to prevent access creep and ensure correct + enforcement of access policies. +* R-34552 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for OWASP Top 10. +* R-29301 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for Password Attacks. +* R-72243 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for Phishing / SMishing. +* R-58998 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for Malware (Key Logger). +* R-14025 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for Session Hijacking. +* R-31412 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for XSS / CSRF. +* R-51883 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for Replay. +* R-44032 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for Man in the Middle (MITM). +* R-58977 The VNF **MUST** provide or support the Identity and Access + Management (IDAM) based threat detection data for Eavesdropping. +* R-24825 The VNF **MUST** provide Context awareness data (device, + location, time, etc.) and be able to integrate with threat detection system. +* R-59391 The VNF provider **MUST**, where a VNF provider requires + the assumption of permissions, such as root or administrator, first + log in under their individual user login ID then switch to the other + higher level account; or where the individual user login is infeasible, + must login with an account with admin privileges in a way that + uniquely identifies the individual performing the function. +* R-85028 The VNF **MUST** authenticate system to system access and + do not conceal a VNF provider user’s individual accountability for + transactions. +* R-80335 The VNF **MUST** make visible a Warning Notice: A formal + statement of resource intent, i.e., a warning notice, upon initial + access to a VNF provider user who accesses private internal networks + or Company computer resources, e.g., upon initial logon to an internal + web site, system or application which requires authentication. +* R-73541 The VNF **MUST** use access controls for VNFs and their + supporting computing systems at all times to restrict access to + authorized personnel only, e.g., least privilege. These controls + could include the use of system configuration or access control + software. +* R-64503 The VNF **MUST** provide minimum privileges for initial + and default settings for new user accounts. +* R-86835 The VNF **MUST** set the default settings for user access + to sensitive commands and data to deny authorization. +* R-77157 The VNF **MUST** conform to approved request, workflow + authorization, and authorization provisioning requirements when + creating privileged users. +* R-81147 The VNF **MUST** have greater restrictions for access and + execution, such as up to 3 factors of authentication and restricted + authorization, for commands affecting network services, such as + commands relating to VNFs. +* R-49109 The VNF **MUST** encrypt TCP/IP--HTTPS (e.g., TLS v1.2) + transmission of data on internal and external networks. +* R-39562 The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs. +* R-15671 The VNF **MUST NOT** provide public or unrestricted access + to any data without the permission of the data owner. All data + classification and access controls must be followed. +* R-89753 The VNF **MUST NOT** install or use systems, tools or + utilities capable of capturing or logging data that was not created + by them or sent specifically to them in production, without + authorization of the VNF system owner. +* R-19082 The VNF **MUST NOT** run security testing tools and + programs, e.g., password cracker, port scanners, hacking tools + in production, without authorization of the VNF system owner. +* R-19790 The VNF **MUST NOT** include authentication credentials + in security audit logs, even if encrypted. +* R-85419 The VNF **SHOULD** use REST APIs exposed to Client + Applications for the implementation of OAuth 2.0 Authorization + Code Grant and Client Credentials Grant, as the standard interface + for a VNF. +* R-48080 The VNF **SHOULD** support SCEP (Simple Certificate + Enrollment Protocol). + + +VNF API Security Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section covers API security requirements when these are used by the +VNFs. Key security areas covered in API security are Access Control, +Authentication, Passwords, PKI Authentication Alarming, Anomaly +Detection, Lawful Intercept, Monitoring and Logging, Input Validation, +Cryptography, Business continuity, Biometric Authentication, +Identification, Confidentiality and Integrity, and Denial of Service. + +The solution in a virtual environment needs to meet the following API +security requirements: + + +API Requirements + +* R-37608 The VNF **MUST** provide a mechanism to restrict access based + on the attributes of the VNF and the attributes of the subject. +* R-43884 The VNF **MUST** integrate with external authentication + and authorization services (e.g., IDAM). +* R-25878 The VNF **MUST** use certificates issued from publicly + recognized Certificate Authorities (CA) for the authentication process + where PKI-based authentication is used. +* R-19804 The VNF **MUST** validate the CA signature on the certificate, + ensure that the date is within the validity period of the certificate, + check the Certificate Revocation List (CRL), and recognize the identity + represented by the certificate where PKI-based authentication is used. +* R-47204 The VNF **MUST** protect the confidentiality and integrity of + data at rest and in transit from unauthorized access and modification. +* R-33488 The VNF **MUST** protect against all denial of service + attacks, both volumetric and non-volumetric, or integrate with external + denial of service protection tools. +* R-21652 The VNF **MUST** implement the following input validation + control: Check the size (length) of all input. Do not permit an amount + of input so great that it would cause the VNF to fail. Where the input + may be a file, the VNF API must enforce a size limit. +* R-54930 The VNF **MUST** implement the following input validation + control: Do not permit input that contains content or characters + inappropriate to the input expected by the design. Inappropriate input, + such as SQL insertions, may cause the system to execute undesirable + and unauthorized transactions against the database or allow other + inappropriate access to the internal network. +* R-21210 The VNF **MUST** implement the following input validation + control: Validate that any input file has a correct and valid + Multipurpose Internet Mail Extensions (MIME) type. Input files + should be tested for spoofed MIME types. +* R-23772 The VNF **MUST** validate input at all layers implementing VNF APIs. +* R-87135 The VNF **MUST** comply with NIST standards and industry + best practices for all implementations of cryptography. +* R-02137 The VNF **MUST** implement all monitoring and logging as + described in the Security Analytics section. +* R-15659 The VNF **MUST** restrict changing the criticality level of + a system security alarm to administrator(s). +* R-19367 The VNF **MUST** monitor API invocation patterns to detect + anomalous access patterns that may represent fraudulent access or + other types of attacks, or integrate with tools that implement anomaly + and abuse detection. +* R-78066 The VNF **MUST** support requests for information from law + enforcement and government agencies. + + +VNF Security Analytics Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section covers VNF security analytics requirements that are mostly +applicable to security monitoring. The VNF Security Analytics cover the +collection and analysis of data following key areas of security +monitoring: + +- Anti-virus software + +- Logging + +- Data capture + +- Tasking + +- DPI + +- API based monitoring + +- Detection and notification + +- Resource exhaustion detection + +- Proactive and scalable monitoring + +- Mobility and guest VNF monitoring + +- Closed loop monitoring + +- Interfaces to management and orchestration + +- Malformed packet detections + +- Service chaining + +- Dynamic security control + +- Dynamic load balancing + +- Connection attempts to inactive ports (malicious port scanning) + +The following requirements of security monitoring need to be met by the +solution in a virtual environment. + +Security Analytics Requirements + +* R-48470 The VNF **MUST** support Real-time detection and + notification of security events. +* R-22286 The VNF **MUST** support Integration functionality via + API/Syslog/SNMP to other functional modules in the network (e.g., + PCRF, PCEF) that enable dynamic security control by blocking the + malicious traffic or malicious end users +* R-32636 The VNF **MUST** support API-based monitoring to take care of + the scenarios where the control interfaces are not exposed, or are + optimized and proprietary in nature. +* R-61648 The VNF **MUST** support event logging, formats, and delivery + tools to provide the required degree of event data to ONAP +* R-22367 The VNF **MUST** support detection of malformed packets due to + software misconfiguration or software vulnerability. +* R-31961 The VNF **MUST** support integrated DPI/monitoring functionality + as part of VNFs (e.g., PGW, MME). +* R-20912 The VNF **MUST** support alternative monitoring capabilities + when VNFs do not expose data or control traffic or use proprietary and + optimized protocols for inter VNF communication. +* R-73223 The VNF **MUST** support proactive monitoring to detect and + report the attacks on resources so that the VNFs and associated VMs can + be isolated, such as detection techniques for resource exhaustion, namely + OS resource attacks, CPU attacks, consumption of kernel memory, local + storage attacks. +* R-58370 The VNF **MUST** coexist and operate normally with commercial + anti-virus software which shall produce alarms every time when there is a + security incident. +* R-56920 The VNF **MUST** protect all security audit logs (including + API, OS and application-generated logs), security audit software, data, + and associated documentation from modification, or unauthorized viewing, + by standard OS access control mechanisms, by sending to a remote system, + or by encryption. +* R-54520 The VNF **MUST** log successful and unsuccessful login attempts. +* R-55478 The VNF **MUST** log logoffs. +* R-08598 The VNF **MUST** log successful and unsuccessful changes to + a privilege level. +* R-13344 The VNF **MUST** log starting and stopping of security + logging. +* R-07617 The VNF **MUST** log creating, removing, or changing the + inherent privilege level of users. +* R-94525 The VNF **MUST** log connections to a network listener of the + resource. +* R-31614 The VNF **MUST** log the field “event type” in the security + audit logs. +* R-97445 The VNF **MUST** log the field “date/time” in the security + audit logs. +* R-25547 The VNF **MUST** log the field “protocol” in the security audit logs. +* R-06413 The VNF **MUST** log the field “service or program used for + access” in the security audit logs. +* R-15325 The VNF **MUST** log the field “success/failure” in the + security audit logs. +* R-89474 The VNF **MUST** log the field “Login ID” in the security audit logs. +* R-04982 The VNF **MUST NOT** include an authentication credential, + e.g., password, in the security audit logs, even if encrypted. +* R-63330 The VNF **MUST** detect when the security audit log storage + medium is approaching capacity (configurable) and issue an alarm via + SMS or equivalent as to allow time for proper actions to be taken to + pre-empt loss of audit data. +* R-41252 The VNF **MUST** support the capability of online storage of + security audit logs. +* R-41825 The VNF **MUST** activate security alarms automatically when + the following event is detected: configurable number of consecutive + unsuccessful login attempts +* R-43332 The VNF **MUST** activate security alarms automatically when + the following event is detected: successful modification of critical + system or application files +* R-74958 The VNF **MUST** activate security alarms automatically when + the following event is detected: unsuccessful attempts to gain permissions + or assume the identity of another user +* R-15884 The VNF **MUST** include the field “date” in the Security alarms + (where applicable and technically feasible). +* R-23957 The VNF **MUST** include the field “time” in the Security alarms + (where applicable and technically feasible). +* R-71842 The VNF **MUST** include the field “service or program used for + access” in the Security alarms (where applicable and technically feasible). +* R-57617 The VNF **MUST** include the field “success/failure” in the + Security alarms (where applicable and technically feasible). +* R-99730 The VNF **MUST** include the field “Login ID” in the Security + alarms (where applicable and technically feasible). +* R-29705 The VNF **MUST** restrict changing the criticality level of a + system security alarm to administrator(s). +* R-13627 The VNF **MUST** monitor API invocation patterns to detect + anomalous access patterns that may represent fraudulent access or other + types of attacks, or integrate with tools that implement anomaly and + abuse detection. +* R-21819 The VNF **MUST** support requests for information from law + enforcement and government agencies. +* R-56786 The VNF **MUST** implement “Closed Loop” automatic implementation + (without human intervention) for Known Threats with detection rate in low + false positives. +* R-25094 The VNF **MUST** perform data capture for security functions. +* R-04492 The VNF **MUST** generate security audit logs that must be sent + to Security Analytics Tools for analysis. +* R-19219 The VNF **MUST** provide audit logs that include user ID, dates, + times for log-on and log-off, and terminal location at minimum. +* R-30932 The VNF **MUST** provide security audit logs including records + of successful and rejected system access data and other resource access + attempts. +* R-54816 The VNF **MUST** support the storage of security audit logs + for agreed period of time for forensic analysis. +* R-57271 The VNF **MUST** provide the capability of generating security + audit logs by interacting with the operating system (OS) as appropriate. +* R-84160 The VNF **MUST** have security logging for VNFs and their + OSs be active from initialization. Audit logging includes automatic + routines to maintain activity records and cleanup programs to ensure + the integrity of the audit/logging systems. + +VNF Data Protection Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section covers VNF data protection requirements that are mostly +applicable to security monitoring. + + +Data Protection Requirements + +* R-58964 The VNF **MUST** provide the capability to restrict read + and write access to data. +* R-99112 The VNF **MUST** provide the capability to restrict access + to data to specific users. +* R-83227 The VNF **MUST** Provide the capability to encrypt data in + transit on a physical or virtual network. +* R-32641 The VNF **MUST** provide the capability to encrypt data on + non-volatile memory. +* R-13151 The VNF **SHOULD** disable the paging of the data requiring + encryption, if possible, where the encryption of non-transient data is + required on a device for which the operating system performs paging to + virtual memory. If not possible to disable the paging of the data + requiring encryption, the virtual memory should be encrypted. +* R-93860 The VNF **MUST** provide the capability to integrate with an + external encryption service. +* R-73067 The VNF **MUST** use industry standard cryptographic algorithms + and standard modes of operations when implementing cryptography. +* R-22645 The VNF **SHOULD** use commercial algorithms only when there + are no applicable governmental standards for specific cryptographic + functions, e.g., public key cryptography, message digests. +* R-12467 The VNF **MUST NOT** use the SHA, DSS, MD5, SHA-1 and + Skipjack algorithms or other compromised encryption. +* R-02170 The VNF **MUST** use, whenever possible, standard implementations + of security applications, protocols, and format, e.g., S/MIME, TLS, SSH, + IPSec, X.509 digital certificates for cryptographic implementations. + These implementations must be purchased from reputable vendors and must + not be developed in-house. +* R-70933 The VNF **MUST** provide the ability to migrate to newer + versions of cryptographic algorithms and protocols with no impact. +* R-44723 The VNF **MUST** use symmetric keys of at least 112 bits in length. +* R-25401 The VNF **MUST** use asymmetric keys of at least 2048 bits in length. +* R-95864 The VNF **MUST** use commercial tools that comply with X.509 + standards and produce x.509 compliant keys for public/private key generation. +* R-12110 The VNF **MUST NOT** use keys generated or derived from + predictable functions or values, e.g., values considered predictable + include user identity information, time of day, stored/transmitted data. +* R-52060 The VNF **MUST** provide the capability to configure encryption + algorithms or devices so that they comply with the laws of the jurisdiction + in which there are plans to use data encryption. +* R-69610 The VNF **MUST** provide the capability of using certificates + issued from a Certificate Authority not provided by the VNF provider. +* R-83500 The VNF **MUST** provide the capability of allowing certificate + renewal and revocation. +* R-29977 The VNF **MUST** provide the capability of testing the validity + of a digital certificate by validating the CA signature on the certificate. +* R-24359 The VNF **MUST** provide the capability of testing the validity + of a digital certificate by validating the date the certificate is being + used is within the validity period for the certificate. +* R-39604 The VNF **MUST** provide the capability of testing the + validity of a digital certificate by checking the Certificate Revocation + List (CRL) for the certificates of that type to ensure that the + certificate has not been revoked. +* R-75343 The VNF **MUST** provide the capability of testing the + validity of a digital certificate by recognizing the identity represented + by the certificate — the "distinguished name". diff --git a/docs/Chapter4/index.rst b/docs/Chapter4/index.rst new file mode 100644 index 0000000..15fd8df --- /dev/null +++ b/docs/Chapter4/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +VNF Development Requirements +============================ + +.. toctree:: + :maxdepth: 2 + + Design + Resiliency + Security + Modularity + Devops + Develop-Steps diff --git a/docs/Chapter5.rst b/docs/Chapter5.rst deleted file mode 100644 index 8496360..0000000 --- a/docs/Chapter5.rst +++ /dev/null @@ -1,5391 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - - -VNF Modeling Requirements -========================= - -TOSCA YAML ----------- - - -Introduction -^^^^^^^^^^^^^^ - -This reference document is the VNF TOSCA Template Requirements for -ONAP, which provides recommendations and standards for building VNF -TOSCA templates compatible with ONAP initial implementations of -Network Cloud. It has the following features: - -1. VNF TOSCA template designer supports GUI and CLI. - -2. VNF TOSCA template is aligned to the newest TOSCA protocol, “Working - Draft 04-Revision 06”. - -3. VNF TOSCA template supports HPA features, such as NUMA, Hyper - Threading, SRIOV， etc. - -Intended Audience -^^^^^^^^^^^^^^^^^^ - -This document is intended for persons developing VNF TOSCA templates -that will be orchestrated by ONAP. - -Scope -^^^^^^^^^^^^^^^^ - -ONAP implementations of Network Cloud supports TOSCA Templates, also -referred to as TOSCA in this document. - -ONAP requires the TOSCA Templates to follow a specific format. This -document provides the mandatory, recommended, and optional requirements -associated with this format. - -Overview -^^^^^^^^^^^^^^^^ - -The document includes three charters to help the VNF providers to use the -VNF model design tools and understand the VNF package structure and VNF -TOSCA templates. - -In the ONAP, VNF Package and VNFD template can be designed by manually -or via model designer tools. VNF model designer tools can provide the -GUI and CLI tools for the VNF provider to develop the VNF Package and VNFD -template. - -The VNF package structure is align to the NFV TOSCA protocol, and -supports CSAR - -The VNFD and VNF package are all align to the NFV TOSCA protocol, which -supports multiple TOSCA template yaml files, and also supports -self-defined node or other extensions. - -NFV TOSCA Template -^^^^^^^^^^^^^^^^^^^^ - -TOSCA templates supported by ONAP must follow the requirements -enumerated in this section. - -TOSCA Introduction -^^^^^^^^^^^^^^^^^^^ - -TOSCA defines a Meta model for defining IT services. This Meta model -defines both the structure of a service as well as how to manage it. A -Topology Template (also referred to as the topology model of a service) -defines the structure of a service. Plans define the process models that -are used to create and terminate a service as well as to manage a -service during its whole lifetime. - -A Topology Template consists of a set of Node Templates and Relationship -Templates that together define the topology model of a service as a (not -necessarily connected) directed graph. A node in this graph is -represented by a *Node Template*. A Node Template specifies the -occurrence of a Node Type as a component of a service. A *Node Type* -defines the properties of such a component (via *Node Type Properties*) -and the operations (via *Interfaces*) available to manipulate the -component. Node Types are defined separately for reuse purposes and a -Node Template references a Node Type and adds usage constraints, such as -how many times the component can occur. - -|image1| - -Figure 1: Structural Elements of Service Template and their Relations - -TOSCA Modeling Principles & Data Model -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section describing TOSCA modeling principles and data model for -NFV, which shall be based on [TOSCA-1.0] and [TOSCA-Simple-Profile-YAML -V1.0], or new type based on ETSI NFV requirements, etc. - -VNF Descriptor Template -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The VNF Descriptor (VNFD) describes the topology of the VNF by means of -ETSI NFV IFA011 [IFA011] terms such as VDUs, Connection Points, Virtual -Links, External Connection Points, Scaling Aspects, Instantiation Levels -and Deployment Flavours. - -The VNFD (VNF Descriptor) is read by both the NFVO and the VNFM. It -represents the contract & interface of a VNF and ensures the -interoperability across the NFV functional blocks. - -The main parts of the VNFD are the following: - -- VNF topology: it is modeled in a cloud agnostic way using virtualized - containers and their connectivity. Virtual Deployment Units (VDU) - describe the capabilities of the virtualized containers, such as - virtual CPU, RAM, disks; their connectivity is modeled with VDU - Connection Point Descriptors (VduCpd), Virtual Link Descriptors (Vld) - and VNF External Connection Point Descriptors (VnfExternalCpd); - -- VNF deployment aspects: they are described in one or more deployment - flavours, including instantiation levels, supported LCM operations, - VNF LCM operation configuration parameters, placement constraints - (affinity / antiaffinity), minimum and maximum VDU instance numbers, - and scaling aspect for horizontal scaling. - -The following table defines the TOSCA Type “derived from” values that -SHALL be used when using the TOSCA Simple Profile for NFV version 1.0 -specification [TOSCA-Simple-Profile-NFV-v1.0] for NFV VNFD with aggreed -changes from ETSI SOL001 draft. - -+---------------------+------------------------------------+-----------------+ -| **ETSI NFV Element**| **TOSCA VNFD** | **Derived from**| -| | | | -| **[IFA011]** | **[TOSCA-Simple-Profile-NFV-v1.0]**| | -+=====================+====================================+=================+ -| VNF | tosca.nodes.nfv.VNF | tosca.nodes.Root| -+---------------------+------------------------------------+-----------------+ -| Cpd (Connection | tosca.nodes.nfv.Cp | tosca.nodes.Root| -| Point) | tosca.nodes.nfv.Cp | tosca.nodes.Root| -+---------------------+------------------------------------+-----------------+ -| VduCpd (internal | tosca.nodes.nfv.VduCp | tosca.nodes.\ | -| connection point) | | nfv.Cp | -+---------------------+------------------------------------+-----------------+ -| VnfVirtualLinkDesc | tosca.nodes.nfv.VnfVirtualLink | tosca.nodes.Root| -| (Virtual Link) | | | -+---------------------+------------------------------------+-----------------+ -| VDU Virtual Storage | tosca.nodes.nfv.VDU.VirtualStorage | tosca.nodes.Root| -+---------------------+------------------------------------+-----------------+ -| VDU Virtual Compute | tosca.nodes.nfv.VDU.Compute | tosca.nodes.Root| -+---------------------+------------------------------------+-----------------+ -| Software Image | | | -+---------------------+------------------------------------+-----------------+ -| Deployment Flavour | | | -+---------------------+------------------------------------+-----------------+ -| Scaling Aspect | | | -+---------------------+------------------------------------+-----------------+ -| Element Group | | | -+---------------------+------------------------------------+-----------------+ -| Instantiation | | | -| Level | | | -+---------------------+------------------------------------+-----------------+ - - -+--------------------------------------------------------------------+ -| +--------------------------------------------------------------+ | -| | tosca\_definitions\_version: tosca\_simple\_yaml\_1\_0 | | -| | | | -| | description: VNFD TOSCA file demo | | -| | | | -| | imports: | | -| | | | -| | - TOSCA\_definition\_nfv\_1\_0.yaml | | -| | | | -| | - TOSCA\_definition\_nfv\_ext\_1\_0.yaml | | -| | | | -| | | **node\_types: | | -| | tosca.nodes.nfv.VNF.vOpenNAT: | | -| | derived\_from:** tosca.nodes.nfv.VNF | | -| | | **requirements: | | -| | **- **sriov\_plane: | | -| | capability:** tosca.capabilities.nfv.VirtualLinkable | | -| | | **node:** tosca.nodes.nfv.VnfVirtualLinkDesc | | -| | | **relationship:** tosca.relationships.nfv.VirtualLinksTo | | -| +--------------------------------------------------------------+ | -+====================================================================+ -+--------------------------------------------------------------------+ - -HPA Requirements -^^^^^^^^^^^^^^^^^^ - -1. SR-IOV Passthrought - -Definitions of SRIOV\_Port are necessary if VDU supports SR-IOV. Here is -an example. - -+------------------------------------------------+ -| node\_templates: | -| | -| vdu\_vNat: | -| | -| SRIOV\_Port: | -| | -| attributes: | -| | -| tosca\_name: SRIOV\_Port | -| | -| properties: | -| | -| virtual\_network\_interface\_requirements: | -| | -| - name: sriov | -| | -| support\_mandatory: false | -| | -| description: sriov | -| | -| requirement: | -| | -| SRIOV: true | -| | -| role: root | -| | -| description: sriov port | -| | -| layer\_protocol: ipv4 | -| | -| requirements: | -| | -| - virtual\_binding: | -| | -| capability: virtual\_binding | -| | -| node: vdu\_vNat | -| | -| relationship: | -| | -| type: tosca.relationships.nfv.VirtualBindsTo | -| | -| - virtual\_link: | -| | -| node: tosca.nodes.Root | -| | -| type: tosca.nodes.nfv.VduCpd | -| | -| substitution\_mappings: | -| | -| requirements: | -| | -| sriov\_plane: | -| | -| - SRIOV\_Port | -| | -| - virtual\_link | -| | -| node\_type: tosca.nodes.nfv.VNF.vOpenNAT | -+------------------------------------------------+ - -2. Hugepages - -Definitions of mem\_page\_size as one property shall be added to -Properties and set the value to large if one VDU node supports -huagepages. Here is an example. - -+----------------------------------+ -| node\_templates: | -| | -| vdu\_vNat: | -| | -| Hugepages: | -| | -| attributes: | -| | -| tosca\_name: Huge\_pages\_demo | -| | -| properties: | -| | -| mem\_page\_size:large | -+==================================+ -+----------------------------------+ - -3. NUMA (CPU/Mem) - -Likewise, we shall add definitions of numa to -requested\_additional\_capabilities if we wand VUD nodes to support -NUMA. Here is an example. - -+-------------------------------------------------+ -| topology\_template: | -| | -| node\_templates: | -| | -| vdu\_vNat: | -| | -| capabilities: | -| | -| virtual\_compute: | -| | -| properties: | -| | -| virtual\_memory: | -| | -| numa\_enabled: true | -| | -| virtual\_mem\_size: 2 GB | -| | -| requested\_additional\_capabilities: | -| | -| numa: | -| | -| support\_mandatory: true | -| | -| requested\_additional\_capability\_name: numa | -| | -| target\_performance\_parameters: | -| | -| hw:numa\_nodes: "2" | -| | -| hw:numa\_cpus.0: "0,1" | -| | -| hw:numa\_mem.0: "1024" | -| | -| hw:numa\_cpus.1: "2,3,4,5" | -| | -| hw:numa\_mem.1: "1024" | -+-------------------------------------------------+ - -4. Hyper-Theading - -Definitions of Hyper-Theading are necessary as one of -requested\_additional\_capabilities of one VUD node if that node -supports Hyper-Theading. Here is an example. - -+-------------------------------------------------------------+ -| topology\_template: | -| | -| node\_templates: | -| | -| vdu\_vNat: | -| | -| capabilities: | -| | -| virtual\_compute: | -| | -| properties: | -| | -| virtual\_memory: | -| | -| numa\_enabled: true | -| | -| virtual\_mem\_size: 2 GB | -| | -| requested\_additional\_capabilities: | -| | -| hyper\_threading: | -| | -| support\_mandatory: true | -| | -| requested\_additional\_capability\_name: hyper\_threading | -| | -| target\_performance\_parameters: | -| | -| hw:cpu\_sockets : "2" | -| | -| hw:cpu\_threads : "2" | -| | -| hw:cpu\_cores : "2" | -| | -| hw:cpu\_threads\_policy: "isolate" | -+-------------------------------------------------------------+ - -5. OVS+DPDK - -Definitions of ovs\_dpdk are necessary as one of -requested\_additional\_capabilities of one VUD node if that node -supports dpdk. Here is an example. - -+------------------------------------------------------+ -| topology\_template: | -| | -| node\_templates: | -| | -| vdu\_vNat: | -| | -| capabilities: | -| | -| virtual\_compute: | -| | -| properties: | -| | -| virtual\_memory: | -| | -| numa\_enabled: true | -| | -| virtual\_mem\_size: 2 GB | -| | -| requested\_additional\_capabilities: | -| | -| ovs\_dpdk: | -| | -| support\_mandatory: true | -| | -| requested\_additional\_capability\_name: ovs\_dpdk | -| | -| target\_performance\_parameters: | -| | -| sw:ovs\_dpdk: "true" | -+------------------------------------------------------+ - -NFV TOSCA Type Definition -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -tosca.capabilites.nfv.VirtualCompute -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This capability is used with the properties specified in ETSI SOL001 draft. - -tosca.nodes.nfv.VDU.Compute -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The NFV Virtualization Deployment Unit (VDU) compute node type -represents a VDU entity which it describes the deployment and -operational behavior of a VNF component (VNFC), as defined by **[ETSI -NFV IFA011].** - -+-----------------------+-------------------------------+ -| Shorthand Name | VDU.Compute | -+=======================+===============================+ -| Type Qualified Name | tosca:VDU.Compute | -+-----------------------+-------------------------------+ -| Type URI | tosca.nodes.nfv.VDU.Compute | -+-----------------------+-------------------------------+ -| derived\_from | tosca.nodes.Compute | -+-----------------------+-------------------------------+ - - - -Attributes -++++++++++++ - -None - - -Capabilities -++++++++++++++ - -+------------+--------------------+------------+------------------------------+ -| Name | Type | Constraints| Description | -+============+====================+============+==============================+ -| virtual\ | tosca.\ | | Describes virtual compute | -| _compute | capabilities.nfv.\ | | resources capabilities. | -| | VirtualCompute | | | -+------------+--------------------+------------+------------------------------+ -| monitoring\| tosca.\ | None | Monitoring parameter, which | -| _parameter | capabilities.nfv.\ | | can be tracked for a VNFC | -| | Metric | | based on this VDU | -| | | | | -| | | | Examples include: | -| | | | memory-consumption, | -| | | | CPU-utilisation, | -| | | | bandwidth-consumption, VNFC | -| | | | downtime, etc. | -+------------+--------------------+------------+------------------------------+ -| Virtual\ | tosca.\ | | Defines ability of | -| _binding | capabilities.nfv.\ | | VirtualBindable | -| | VirtualBindable | | | -| | | | | -| | editor note: need | | | -| | to create a | | | -| | capability type | | | -+------------+--------------------+------------+------------------------------+ - -Definition -++++++++++++ - -+-----------------------------------------------------------------------------+ -| tosca.nodes.nfv.VDU.Compute: | -| | -| derived\_from: tosca.nodes.Compute | -| | -| properties: | -| | -| name: | -| | -| type: string | -| | -| required: true | -| | -| description: | -| | -| type: string | -| | -| required: true | -| | -| boot\_order: | -| | -| type: list # explicit index (boot index) not necessary, contrary to IFA011 | -| | -| entry\_schema: | -| | -| type: string | -| | -| required: false | -| | -| nfvi\_constraints: | -| | -| type: list | -| | -| entry\_schema: | -| | -| type: string | -| | -| required: false | -| | -| configurable\_properties: | -| | -| type: map | -| | -| entry\_schema: | -| | -| type: tosca.datatypes.nfv.VnfcConfigurableProperties | -| | -| required: true | -| | -| attributes: | -| | -| private\_address: | -| | -| status: deprecated | -| | -| public\_address: | -| | -| status: deprecated | -| | -| networks: | -| | -| status: deprecated | -| | -| ports: | -| | -| status: deprecated | -| | -| capabilities: | -| | -| virtual\_compute: | -| | -| type: tosca.capabilities.nfv.VirtualCompute | -| | -| virtual\_binding: | -| | -| type: tosca.capabilities.nfv.VirtualBindable | -| | -| #monitoring\_parameter: | -| | -| # modeled as ad hoc (named) capabilities in VDU node template | -| | -| # for example: | -| | -| #capabilities: | -| | -| # cpu\_load: tosca.capabilities.nfv.Metric | -| | -| # memory\_usage: tosca.capabilities.nfv.Metric | -| | -| host: #Editor note: FFS. How this capabilities should be used in NFV Profile| -| | -| type: `*tosca.capabilities.Container* <#DEFN_TYPE_CAPABILITIES_CONTAINER>`__| -| | -| valid\_source\_types: | -| [`*tosca.nodes.SoftwareComponent* <#DEFN_TYPE_NODES_SOFTWARE_COMPONENT>`__] | -| | -| occurrences: [0,UNBOUNDED] | -| | -| endpoint: | -| | -| occurrences: [0,0] | -| | -| os: | -| | -| occurrences: [0,0] | -| | -| scalable: | -| #Editor note: FFS. How this capabilities should be used in NFV Profile | -| | -| type: `*tosca.capabilities.Scalable* <#DEFN_TYPE_CAPABILITIES_SCALABLE>`__ | -| | -| binding: | -| | -| occurrences: [0,UNBOUND] | -| | -| requirements: | -| | -| - virtual\_storage: | -| | -| capability: tosca.capabilities.nfv.VirtualStorage | -| | -| relationship: tosca.relationships.nfv.VDU.AttachedTo | -| | -| node: tosca.nodes.nfv.VDU.VirtualStorage | -| | -| occurences: [ 0, UNBOUNDED ] | -| | -| - local\_storage: #For NFV Profile, this requirement is deprecated. | -| | -| occurrences: [0,0] | -| | -| artifacts: | -| | -| - sw\_image: | -| | -| file: | -| | -| type: tosca.artifacts.nfv.SwImage | -+-----------------------------------------------------------------------------+ - -Artifact -++++++++++ - -Note: currently not supported. - -+--------+---------+----------------+------------+------------------------+ -| Name | Required| Type | Constraints| Description | -+========+=========+================+============+========================+ -| SwImage| Yes | tosca.\ | | Describes the software | -| | | artifacts.nfv.\| | image which is directly| -| | | SwImage | | realizing this virtual | -| | | | | storage | -+--------+---------+----------------+------------+------------------------+ - - -|image2| - - - -tosca.nodes.nfv.VDU.VirtualStorage -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The NFV VirtualStorage node type represents a virtual storage entity -which it describes the deployment and operational behavior of a virtual -storage resources, as defined by **[ETSI NFV IFA011].** - -**[editor note]** open issue: should NFV profile use the current storage -model as described in YAML 1.1. Pending on Shitao proposal (see -NFVIFA(17)000110 discussion paper) - -**[editor note]** new relationship type as suggested in Matt -presentation. Slide 8. With specific rules of “valid\_target\_type” - -+---------------------------+--------------------------------------+ -| **Shorthand Name** | VirtualStorage | -+===========================+======================================+ -| **Type Qualified Name** | tosca: VirtualStorage | -+---------------------------+--------------------------------------+ -| **Type URI** | tosca.nodes.nfv.VDU.VirtualStorage | -+---------------------------+--------------------------------------+ -| **derived\_from** | tosca.nodes.Root | -+---------------------------+--------------------------------------+ - -tosca.artifacts.nfv.SwImage -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -+---------------------------+------------------------------------+ -| **Shorthand Name** | SwImage | -+===========================+====================================+ -| **Type Qualified Name** | tosca:SwImage | -+---------------------------+------------------------------------+ -| **Type URI** | tosca.artifacts.nfv.SwImage | -+---------------------------+------------------------------------+ -| **derived\_from** | tosca.artifacts.Deployment.Image | -+---------------------------+------------------------------------+ - -Properties -++++++++++++ - -+-----------------+---------+----------+------------+-------------------------+ -| Name | Required| Type | Constraints| Description | -+=================+=========+==========+============+=========================+ -| name | yes | string | | Name of this software | -| | | | | image | -+-----------------+---------+----------+------------+-------------------------+ -| version | yes | string | | Version of this software| -| | | | | image | -+-----------------+---------+----------+------------+-------------------------+ -| checksum | yes | string | | Checksum of the software| -| | | | | image file | -+-----------------+---------+----------+------------+-------------------------+ -| container\ | yes | string | | The container format | -| _format | | | | describes the container | -| | | | | file format in which | -| | | | | software image is | -| | | | | provided. | -+-----------------+---------+----------+------------+-------------------------+ -| disk\_format | yes | string | | The disk format of a | -| | | | | software image is the | -| | | | | format of the underlying| -| | | | | disk image | -+-----------------+---------+----------+------------+-------------------------+ -| min\_disk | yes | scalar-\ | | The minimal disk size | -| | | unit.size| | requirement for this | -| | | | | software image. | -+-----------------+---------+----------+------------+-------------------------+ -| min\_ram | no | scalar-\ | | The minimal RAM | -| | | unit.size| | requirement for this | -| | | | | software image. | -+-----------------+---------+----------+------------+-------------------------+ -| Size | yes | scalar-\ | | The size of this | -| | | unit.size| | software image | -+-----------------+---------+----------+------------+-------------------------+ -| sw\_image | yes | string | | A reference to the | -| | | | | actual software image | -| | | | | within VNF Package, or | -| | | | | url. | -+-----------------+---------+----------+------------+-------------------------+ -| operating\ | no | string | | Identifies the operating| -| _system | | | | system used in the | -| | | | | software image. | -+-----------------+---------+----------+------------+-------------------------+ -| supported\ | no | list | | Identifies the | -| _virtualization\| | | | virtualization | -| _enviroment | | | | environments (e.g. | -| | | | | hypervisor) compatible | -| | | | | with this software image| -+-----------------+---------+----------+------------+-------------------------+ - -Definition -+++++++++++ - -+-----------------------------------------------------+ -| tosca.artifacts.nfv.SwImage: | -| | -| derived\_from: tosca.artifacts.Deployment.Image | -| | -| properties or metadata: | -| | -| #id: | -| | -| # node name | -| | -| name: | -| | -| type: string | -| | -| required: true | -| | -| version: | -| | -| type: string | -| | -| required: true | -| | -| checksum: | -| | -| type: string | -| | -| required: true | -| | -| container\_format: | -| | -| type: string | -| | -| required: true | -| | -| disk\_format: | -| | -| type: string | -| | -| required: true | -| | -| min\_disk: | -| | -| type: scalar-unit.size # Number | -| | -| required: true | -| | -| min\_ram: | -| | -| type: scalar-unit.size # Number | -| | -| required: false | -| | -| size: | -| | -| type: scalar-unit.size # Number | -| | -| required: true | -| | -| sw\_image: | -| | -| type: string | -| | -| required: true | -| | -| operating\_system: | -| | -| type: string | -| | -| required: false | -| | -| supported\_virtualisation\_environments: | -| | -| type: list | -| | -| entry\_schema: | -| | -| type: string | -| | -| required: false | -+-----------------------------------------------------+ - -.. |image1| image:: Image1.png - :width: 5.76806in - :height: 4.67161in -.. |image2| image:: Image2.png - :width: 5.40486in - :height: 2.46042in - - -Heat -------------- - -General Guidelines -^^^^^^^^^^^^^^^^^^ -This section contains general Heat Orchestration Template guidelines. - -YAML Format -~~~~~~~~~~~ - -R-95303 A VNF's Heat Orchestration Template **MUST** be defined using valid YAML. - -YAML (YAML Ain't -Markup Language) is a human friendly data serialization standard for all -programming languages. See http://www.yaml.org/. - -Heat Orchestration Template Format -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -As stated above, Heat Orchestration templates must be defined in YAML. - -YAML rules include: - - - Tabs are not allowed, use spaces ONLY - - - You must indent your properties and lists with 1 or more spaces - - - All Resource IDs and resource property parameters are case-sensitive. (e.g., "ThIs", is not the same as "thiS") - -Heat Orchestration Template Structure -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Heat Orchestration template structure follows the following format, -as defined by OpenStack at -https://docs.openstack.org/developer/heat/template_guide/hot_spec.html - -.. code-block:: python - - heat_template_version: <date> - - description: - # a description of the template - - parameter_groups: - # a declaration of input parameter groups and order - - parameters: - # declaration of input parameters - - resources: - # declaration of template resources - - outputs: - # declaration of output parameters - - conditions: - # declaration of conditions - -heat_template_version -+++++++++++++++++++++ - -R-27078 A VNF's Heat Orchestration template **MUST** contain -the section "heat_template_version:". - -The section "heat_template_version:" must be set to a date -that is supported by the OpenStack environment. - -description -+++++++++++ - -R-39402 A VNF's Heat Orchestration Template **MUST** -contain the section "description:". - -parameter_groups -++++++++++++++++ - -A VNF Heat Orchestration template may -contain the section "parameter_groups:". - -parameters -++++++++++ - -R-35414 A VNF Heat Orchestration's template **MUST** -contain the section "parameters:". - - -.. code-block:: python - - parameters: - - <param name>: - - type: <string | number | json | comma_delimited_list | boolean> - - label: <human-readable name of the parameter> - - description: <description of the parameter> - - default: <default value for parameter> - - hidden: <true | false> - - constraints: - - <parameter constraints> - - immutable: <true | false> - -This section allows for -specifying input parameters that have to be provided when instantiating -the template. Each parameter is specified in a separate nested block -with the name of the parameters defined in the first line and additional -attributes (e.g., type, label) defined as nested elements. - -R-90279 A VNF Heat Orchestration's template's parameter **MUST** -be used in a resource with the exception of the parameters -for the OS::Nova::Server resource property availability_zone. - -R-91273 A VNF Heat Orchestration’s template’s parameter for -the OS::Nova::Server resource property availability_zone -**MAY NOT** be used in any OS::Nova::Resource. - -<param name> -____________ - -The name of the parameter. - -R-25877 A VNF's Heat Orchestration Template's parameter -name (i.e., <param name>) **MUST** contain only -alphanumeric characters and underscores ('_'). - -type -____ - -R-36772 A VNF’s Heat Orchestration Template’s parameter -**MUST** include the attribute “type:”. - -R-11441 A VNF’s Heat Orchestration Template’s parameter -type **MUST** be one of the following values: "string", -"number", "json", "comma_delimited_list" or "boolean". - -label -_____ - -R-32094 A VNF's Heat Orchestration Template parameter -declaration **MAY** contain the attribute "label:" - -description -___________ - -R-44001 A VNF's Heat Orchestration Template parameter -declaration **MUST** contain the attribute "description". - -Note that the parameter attribute “description:” is an -OpenStack optional attribute that provides a description -of the parameter. ONAP implementation requires this attribute. - -default -_______ - -R-90526 A VNF Heat Orchestration Template parameter -declaration **MUST** not contain the default attribute. - -R-26124 If a VNF Heat Orchestration Template parameter -requires a default value, it **MUST** be enumerated in the environment file. - -Note that the parameter attribute “default:” is an OpenStack -optional attribute that declares the default value of the -parameter. ONAP implementation prohibits the use of this attribute. - -hidden -______ - -R-32557 A VNF's Heat Orchestration Template parameter -declaration MAY contain the attribute "hidden:". - -The parameter attribute "hidden:" is an OpenStack optional -attribute that defines whether the parameters should be -hidden when a user requests information about a stack -created from the template. This attribute can be used -to hide passwords specified as parameters. - -constraints -___________ - -The parameter attribute "constraints:" is an OpenStack optional -attribute that defines a list of constraints to apply to the parameter. - -R-88863 A VNF's Heat Orchestration Template's parameter defined as -type "number" **MUST** have a parameter constraint of "range" or -"allowed_values" defined. - -R-40518 A VNF's Heat Orchestration Template’s parameter defined as -type "string" **MAY** have a parameter constraint defined. - -R-96227 A VNF's Heat Orchestration Template’s parameter defined as -type "json" **MAY** have a parameter constraint defined. - -R-79817 A VNF's Heat Orchestration Template’s parameter defined as -type "comma_delimited_list" **MAY** have a parameter constraint defined. - -R-06613 A VNF's Heat Orchestration Template’s parameter defined as -type "boolean" **MAY** have a parameter constraint defined. - -R-00011 A VNF's Heat Orchestration Template's Nested YAML files -parameter's **MUST NOT** have a parameter constraint defined. - -The constraints block of a parameter definition defines additional -validation constraints that apply to the value of the parameter. -The parameter values provided in the VNF Heat Orchestration Template -are validated against the constraints at instantiation time. -The stack creation fails if the parameter value doesn’t comply to the constraints. - -The constraints are defined as a list with the following syntax - -.. code-block:: python - - constraints: - - <constraint type>: <constraint definition> - - description: <constraint description> - -.. - -**<constraint type>** Provides the type of constraint to apply. -The list of OpenStack supported constraints can be found at -https://docs.openstack.org/heat/latest/template_guide/hot_spec.html . - -**<constraint definition>** provides the actual constraint. -The syntax and constraint is dependent of the <constraint type> used. - -**description** is an optional attribute that provides a description of the -constraint. The text is presented to the user when the value the user -defines violates the constraint. If omitted, a default validation -message is presented to the user. - -Below is a brief overview of the "range" and "allowed values" constraints. -For complete details on constraints, see -https://docs.openstack.org/heat/latest/template_guide/hot_spec.html#parameter-constraints - -**range** - -range: The range constraint applies to parameters of type: number. -It defines a lower and upper limit for the numeric value of the -parameter. The syntax of the range constraint is - -.. code-block:: python - - range: { min: <lower limit>, max: <upper limit> } - -.. - -It is possible to define a range constraint with only a lower -limit or an upper limit. - -**allowed_values** - -allowed_values: The allowed_values constraint applies to parameters of -type \"string\" or type \"number\". It specifies a set of possible -values for a parameter. At deployment time, the user-provided value -for the respective parameter must match one of the elements of the -list. The syntax of the allowed_values constraint is - -.. code-block:: python - - allowed_values: [ <value>, <value>, ... ] - - Alternatively, the following YAML list notation can be used - - allowed_values: - - - <value> - - - <value> - - - ... - -. . - -immutable -_________ - -R-22589 A VNF’s Heat Orchestration Template parameter declaration -**MAY** contain the attribute "immutable:". - -The parameter attribute \"immutable:\" is an OpenStack optional -attribute that defines whether the parameter is updatable. A Heat -Orchestration Template stack update fails if immutable is set to -true and the parameter value is changed. This attribute -\"immutable:\" defaults to false. - -resources -+++++++++ - -R-23664 A VNF's Heat Orchestration template **MUST** contain -the section "resources:". - -R-90152 A VNF's Heat Orchestration Template's "resources:" -section **MUST** contain the declaration of at least one resource. - -R-40551 A VNF's Heat Orchestration Template's Nested YAML files -**MAY** contain the section "resources:". - -Each resource is defined as a -separate block in the resources section with the following syntax. - -.. code-block:: python - - resources: - - <resource ID>: - - type: <resource type> - - properties: - - <property name>: <property value> - - metadata: - - <resource specific metadata> - - depends_on: <resource ID or list of ID> - - update_policy: <update policy> - - deletion_policy: <deletion policy> - - external_id: <external resource ID> - - condition: <condition name or expression or boolean> - - - -resource ID -___________ - -R-75141 A VNF's Heat Orchestration Template's resource name -(i.e., <resource ID>) **MUST** only contain alphanumeric -characters and underscores ('_'). - -R-16447 A VNF's <resource ID> **MUST** be unique across all -Heat Orchestration Templates and all HEAT Orchestration Template -Nested YAML files that are used to create the VNF. - -Note that a VNF can be composed of one or more Heat Orchestration Templates. - -Note that OpenStack requires the <resource ID> to be unique to the -Heat Orchestration Template and not unique across all Heat -Orchestration Templates the compose the VNF. - -type -____ - -The resource attribute \"type:\" is an OpenStack required -attribute that defines the resource type, such as -OS::Nova::Server or OS::Neutron::Port. - -The resource attribute \"type:\" may specify a VNF HEAT -Orchestration Template Nested YAML file. - -R-53952 A VNF’s Heat Orchestration Template’s Resource -**MUST NOT** reference a HTTP-based resource definitions. - -R-71699 A VNF’s Heat Orchestration Template’s Resource -**MUST NOT** reference a HTTP-based Nested YAML file. - -properties -__________ - -The resource attribute \"properties:\" is an OpenStack optional -attribute that provides a list of resource-specific properties. -The property value can be provided in place, or via a function -(e.g., `Intrinsic functions <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-intrinsic-functions>`__). - -R-10834 If a VNF Heat Orchestration Template resource attribute -"property:" uses a nested "get_param", one level of nesting is -supported and the nested "get_param" **MUST** reference an index - -metadata -________ - -The resource attribute \"metadata:\" is an OpenStack optional attribute. - -R-97199 A VNF's Heat Orchestration Template's OS::Nova::Server -resource **MUST** contain the attribute "metadata". - -Section 5.4 contains the OS::Nova::Server mandatory and optional metadata. - - -depends_on -__________ - -The resource attribute \"depends_on:\" is an OpenStack optional -attribute. -See `OpenStack documentation <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-resources-dependencies>`__ -for additional details. - -R-46968 VNF’s Heat Orchestration Template’s Resource **MAY** -declare the attribute “depends_on:”. - -update_policy -_____________ - -R-63137 VNF’s Heat Orchestration Template’s Resource **MAY** -declare the attribute “update_policy:”. - -deletion_policy -_______________ - -R-43740 A VNF’s Heat Orchestration Template’s Resource -**MAY** declare the attribute “deletion_policy:”. - -If specified, the \"deletion_policy:\" attribute for resources -allows values 'Delete', 'Retain', and 'Snapshot'. -Starting with heat_template_version 2016-10-14, lowercase -equivalents are also allowed. - -The default policy is to delete the physical resource when -deleting a resource from the stack. - -external_id -___________ - -R-78569 A VNF’s Heat Orchestration Template’s Resouce **MAY** -declare the attribute “external_id:”. - -This attribute allows for specifying the resource_id for an -existing external (to the stack) resource. External resources -cannot depend on other resources, but we allow other resources to -depend on external resource. This attribute is optional. -Note: when this is specified, properties will not be used for -building the resource and the resource is not managed by Heat. -This is not possible to update that attribute. Also, -resource won’t be deleted by heat when stack is deleted. - - -condition -_________ - -The resource attribute \"condition:\" is an OpenStack optional attribute. - -Support for the resource condition attribute was added -in the Newton release of OpenStack. - -outputs -+++++++ - -R-36982 A VNF’s Heat Orchestration template **MAY** contain the “outputs:” section. - -This section allows for specifying output parameters -available to users once the template has been instantiated. If the -section is specified, it will need to adhere to specific requirements. -See `ONAP Parameter Classifications Overview`_ and -`ONAP Output Parameter Names`_ for additional details. - -Environment File Format -~~~~~~~~~~~~~~~~~~~~~~~ - -The environment file is a yaml text file. -(https://docs.openstack.org/developer/heat/template_guide/environment.html) - -R-86285 The VNF Heat Orchestration Template **MUST** have a corresponding -environment file, even if no parameters are required to be enumerated. - -The use of an environment file in OpenStack is optional. -In ONAP, it is mandatory. - -R-03324 The VNF Heat Orchestration Template **MUST** contain the -"parameters" section in the -environment file - -R-68198 A VNF’s Heat Orchestration template’s Environment File’s -“parameters:” section **MAY** enumerate parameters. - -ONAP implementation requires the parameters section in the -environmental file to be declared. The parameters section -contains a list of key/value pairs. - -R-59930 A VNF’s Heat Orchestration template’s Environment -File’s **MAY** contain the “parameter_defaults:” section. - -The “parameter_defaults:” section contains default parameters -that are passed to all template resources. - -R-46096 A VNF’s Heat Orchestration template’s Environment File’s -**MAY** contain the “encrypted_parameters:” section. - -The “encrypted_parameters:” section contains a list of encrypted parameters. - -R-24893 A VNF’s Heat Orchestration template’s Environment File’s -**MAY** contain the “event_sinks:” section. - -The “event_sinks:” section contains the list of endpoints that would -receive stack events. - -R-42685 A VNF’s Heat Orchestration template’s Environment File’s -**MAY** contain the “parameter_merge_strategies:” section. - -The “parameter_merge_strategies:” section provides the merge strategies -for merging parameters and parameter defaults from the environment file. - -R-67231 A VNF’s Heat Orchestration template’s Environment File’s **MUST NOT** -contain the “resource_registry:” section. - -ONAP implementation does not support the Environment File resource_registry -section. The resource_registry section allows for the definition of custom resources. - - -SDC Treatment of Environment Files -++++++++++++++++++++++++++++++++++ - -Parameter values enumerated in the environment file are used by SDC as -the default value. However, the SDC user may use the SDC GUI to -overwrite the default values in the environment file. - -SDC generates a new environment file for distribution to MSO based on -the uploaded environment file and the user provided GUI updates. The -user uploaded environment file is discarded when the new file is -created. - -ONAP has requirements for what parameters must be enumerated in the -environment file and what parameter must not be enumerated in the -environment file. See `ONAP Parameter Classifications Overview`_ and -`ONAP Resource ID and Parameter Naming Convention`_ for more details. - -ONAP Heat Orchestration Templates: Overview -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -ONAP supports a modular Heat Orchestration Template design pattern, -referred to as *VNF Modularity.* - -ONAP VNF Modularity Overview -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -R-69663 A VNF **MAY** be composed from one or more Heat Orchestration -Templates, each of which represents a subset of the overall VNF. - -The Heat Orchestration Templates can be thought of a components or -modules of the VNF and are referred to as “\ *VNF Modules*\ ”. -During orchestration, these modules are -deployed incrementally to create the complete VNF. - -R-33132 A VNF’s Heat Orchestration Template **MAY** be 1.) Base Module -Heat Orchestration Template (also referred to as a Base Module), 2.) -Incremental Module Heat Orchestration Template (referred to as an Incremental -Module), or 3.) a Cinder Volume Module Heat Orchestration Template -(referred to as Cinder Volume Module). - -R-37028 The VNF **MUST** be composed of one “base” module. - -R-13196 A VNF **MAY** be composed of zero to many Incremental Modules - -R-20974 The VNF **MUST** deploy the base module first, prior to -the incremental modules. - -R-28980 A VNF’s incremental module **MAY** be used for initial VNF -deployment only. - -R-86926 A VNF’s incremental module **MAY** be used for scale out only. - -A VNF’s Incremental Module that is used for scale out is deployed -sometime after initial VNF deployment to add capacity. - -R-91497 A VNF’s incremental module **MAY** be used for both deployment -and scale out. - -R-68122 A VNF’s incremental module **MAY** be deployed more than once, -either during initial VNF deployment and/or scale out. - -R-46119 A VNF’s Heat Orchestration Template’s Resource OS::Heat::CinderVolume -**MAY** be defined in a Base Module. - -R-90748 A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume -**MAY** be defined in an Incremental Module. - -R-03251 A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume -**MAY** be defined in a Cinder Volume Module. - -ONAP also supports the concept of an optional, independently deployed Cinder -volume via a separate Heat Orchestration Templates, referred to as a Cinder -Volume Module. This allows the volume to persist after a Virtual Machine -(VM) (i.e., OS::Nova::Server) is deleted, allowing the volume to be reused -on another instance (e.g., during a failover activity). - -R-11200 The VNF **MUST** keep the scope of a Cinder volume module, when it -exists, to be 1:1 with the VNF Base Module or Incremental Module - -It is strongly recommended that Cinder Volumes be created in a Cinder Volume -Module. - -R-38474 The VNF **MUST** have a corresponding environment file for a -Base Module. - -R-81725 The VNF **MUST** have a corresponding environment file for an -Incremental Module. - -R-53433 The VNF **MUST** have a corresponding environment file for a -Cinder Volume Module. - -These concepts will be described in more detail throughout the document. -This overview is provided to set the stage and help clarify the concepts -that will be introduced. - -Nested Heat Orchestration Templates Overview -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -ONAP supports nested Heat Orchestration Templates per OpenStack -specifications. - -R-36582 A VNF’s Base Module **MAY** utilize nested heat. - -R-56721 A VNF’s Incremental Module **MAY** utilize nested heat. - -R-30395 A VNF’s Cinder Volume Module **MAY** utilize nested heat. - -Nested templates may be suitable for larger VNFs that contain many -repeated instances of the same VM type(s). A common usage pattern is to -create a nested template for each VM type along with its supporting -resources. The Heat Orchestration Template may then reference these -nested templates either statically (by repeated definition) or -dynamically (via OS::Heat::ResourceGroup). - -See `Nested Heat Templates`_ for additional details. - -ONAP Heat Orchestration Template Filenames -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In order to enable ONAP to understand the relationship between Heat -files, the following Heat file naming convention must be utilized. - -In the examples below, <text> represents any alphanumeric string that -must not contain any special characters and must not contain the word -“base”. - -R-87485 A VNF’s Heat Orchestration Template’s file extension **MUST** -be in the lower case format ‘.yaml’ or ‘.yml’. - -R-56438 A VNF’s Heat Orchestration Template’s Nested YAML file extension -**MUST** be in the lower case format ‘.yaml’ or ‘.yml’. - -R-74304 A VNF’s Heat Orchestration Template’s Environment file extension -**MUST** be in the lower case format ‘.env’. - -Base Modules -++++++++++++ - -R-81339 A VNF Heat Orchestration Template’s Base Module file name **MUST** -include ‘base’ in the filename and **MUST** match one of the following four -formats: 1.) ‘base_<text>.y[a]ml’, 2.) ‘<text>_base.y[a]ml’, 3.) -‘base.y[a]ml’, or 4.) ‘<text>_base_<text>’.y[a]ml; where ‘base’ is case -insensitive and where ‘<text>’ **MUST** contain only alphanumeric characters -and underscores ‘_’ and **MUST NOT** contain the case insensitive word ‘base’. - -R-91342 A VNF Heat Orchestration Template’s Base Module’s Environment File -**MUST** be named identical to the VNF Heat Orchestration Template’s Base -Module with ‘.y[a]ml’ replaced with ‘.env’. - -Incremental Modules -+++++++++++++++++++ - -R-87247 A VNF Heat Orchestration Template’s Incremental Module file name -**MUST** contain only alphanumeric characters and underscores ‘_’ and -**MUST NOT** contain the case insensitive word ‘base’. - -R-94509 A VNF Heat Orchestration Template’s Incremental Module’s Environment -File **MUST** be named identical to the VNF Heat Orchestration Template’s -Incremental Module with ‘.y[a]ml’ replaced with ‘.env’. - -To clearly identify the incremental module, it is recommended to use the -following naming options for modules: - - - module_<text>.y[a]ml - - - <text>_module.y[a]ml - - - module.y[a]ml - - - <text>_module_<text>.y[a]ml - -Cinder Volume Modules -+++++++++++++++++++++ - -R-82732 A VNF Heat Orchestration Template’s Cinder Volume Module **MUST** be -named identical to the base or incremental module it is supporting with -‘_volume appended’ - -R-31141 A VNF Heat Orchestration Template’s Cinder Volume Module’s Environment -File **MUST** be named identical to the VNF Heat Orchestration Template’s -Cinder Volume Module with .y[a]ml replaced with ‘.env’. - -Nested Heat file -++++++++++++++++ - -R-76057 A VNF Heat Orchestration Template’s Nested YAML file name **MUST** -contain only alphanumeric characters and underscores ‘_’ and **MUST NOT** -contain the case insensitive word ‘base’. - -Examples include - - - <text>.y[a]ml - - - nest_<text>.y[a]ml - - - <text>_nest.y[a]ml - - - nest.y[a]ml - - - <text>_nest_<text>.y[a]ml - -VNF Heat Orchestration Template's Nested YAML file does not have a -corresponding environment files, per OpenStack specifications. - -R-18224 The VNF Heat Orchestration Template **MUST** pass in as properties -all parameter values -associated with the nested heat file in the resource definition defined -in the parent heat template. - -Output Parameters -~~~~~~~~~~~~~~~~~ - -The output parameters are parameters defined in the output section of a -Heat Orchestration Template. The ONAP output parameters are subdivided -into three categories: - -1. ONAP Base Module Output Parameters - -2. ONAP Volume Module Output Parameters - -3. ONAP Predefined Output Parameters. - -ONAP Base Module Output Parameters -++++++++++++++++++++++++++++++++++++ - -ONAP Base Module Output Parameters are declared in the 'outputs:'' section of -the VNF's Heat Orchestration Template's Base Module. A Base Module Output -Parameter is available as an input parameter (i.e., declared in the -'parameters:'' section) to all Incremental Modules in the VNF. - -A Base Module Output Parameter may be used as an input parameter in any -incremental module in the VNF. Note that the parameter is not -available to other VNFs. - -R-52753 VNF’s Heat Orchestration Template’s Base Module’s output parameter’s -name and type **MUST** match the VNF’s Heat Orchestration Template’s -incremental Module’s name and type unless the output parameter is of type -‘comma_delimited_list’, then the corresponding input parameter **MUST** -be declared as type ‘json’. - -If the Output parameter has a comma_delimited_list value (e.g., a collection -of UUIDs from a Resource Group), then the corresponding input parameter -must be declared as type json and not a comma_delimited_list, which is -actually a string value with embedded commas. - -R-22608 When a VNF’s Heat Orchestration Template’s Base Module’s output -parameter is declared as an input parameter in an Incremental Module, -the parameter attribute ‘constraints:’ **MUST NOT** be declared. - -Additional details on ONAP Base Module Output Parameters are provided in -`ONAP Output Parameter Names`_ and ONAP VNF Modularity. - -ONAP Volume Module Output Parameters -++++++++++++++++++++++++++++++++++++ - -R-89913 A VNF’s Heat Orchestration Template’s Cinder Volume Module Output -Parameter(s) **MUST** include the UUID(s) of the Cinder Volumes created in -template, while other Output Parameters **MAY** be included. - -A VNF’s Heat Orchestration Template’s Cinder Volume Module Output Parameter(s) -are only available for the module (base or incremental) that the volume -template is associated with. - -R-07443 A VNF’s Heat Orchestration Templates’ Cinder Volume Module Output -Parameter’s name and type **MUST** match the input parameter name and type -in the corresponding Base Module or Incremental Module unless the Output -Parameter is of the type ‘comma_delimited_list’, then the corresponding input -parameter **MUST** be declared as type ‘json’. - -If the Output parameter has a comma_delimited_list value (e.g., a collection -of UUIDs from a Resource Group), then the corresponding input parameter must -be declared as type json and not a comma_delimited_list, which is actually a -string value with embedded commas. - -R-20547 When an ONAP Volume Module Output Parameter is declared as an input -parameter in a base or an incremental module Heat Orchestration Template, -parameter constraints **MUST NOT** be declared. - -Additional details on ONAP Base Module Output Parameters are provided in -`ONAP Output Parameter Names`_ and `Cinder Volume Templates`_. - -ONAP Predefined Output Parameters -+++++++++++++++++++++++++++++++++++ - -ONAP will look for a small set of pre-defined Heat output parameters to -capture resource attributes for inventory in ONAP. These output parameters -are optional and currently only two parameters are supported. These output -parameters are optional and are specified in `OAM Management IP Addresses`_. - -Support of heat stack update -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -ONAP does not support the use of heat stack-update command for scaling -(growth/de-growth). - -R-39349 A VNF Heat Orchestration Template **MUST NOT** be designed to -utilize the OpenStack ‘heat stack-update’ command for scaling -(growth/de-growth). - -R-43413 A VNF **MUST** utilize a modular Heat Orchestration Template -design to support scaling (growth/de-growth). - -Scope of a Heat Orchestration Template -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -R-59482 A VNF’s Heat Orchestration Template **MUST NOT** be VNF instance -specific or Cloud site specific - -R-56750 A VNF’s Heat Orchestration Template’s parameter values that are -constant across all deployments **MUST** be declared in a Heat Orchestration -Template Environment File. - -ONAP provides the instance specific parameter values to the Heat -Orchestration Template at orchestration time. - -R-01896 A VNF’s Heat Orchestration Template’s parameter values that are -constant across all deployments **MUST** be declared in a Heat Orchestration -Template Environment File. - -Networking -^^^^^^^^^^ - -ONAP defines two types of networks: External Networks and Internal Networks. - -External Networks -~~~~~~~~~~~~~~~~~ - -ONAP defines an external network in relation to the VNF and not with regard -to the Network Cloud site. External networks may also be referred to as -“inter-VNF” networks. An external network must connect VMs in a VNF to -VMs in another VNF or an external gateway or external router. - -An External Network may be a Neutron Network or a Contrail Network. - -R-16968 A VNF’s Heat Orchestration Templates **MUST NOT** include heat -resources to create external networks. - -External networks must be orchestrated separately, independent of the VNF. -This allows the network to be shared by multiple VNFs and managed -independently of VNFs. - -R-00606 A VNF **MAY** be connected to zero, one or more than one external -networks. - -R-57424 A VNF’s port connected to an external network **MUST** connect the -port to VMs in another VNF and/or an external gateway and/or external router. - -R-29865 A VNF’s port connected to an external network **MUST NOT** connect -the port to VMs in the same VNF. - -R-69014 When a VNF connects to an external network, a network role, referred -to as the ‘{network-role}’ **MUST** be assigned to the external network -for use in the VNF’s Heat Orchestration Template. - -R-05201 When a VNF connects to two or more external networks, each external -network **MUST** be assigned a unique ‘{network-role}’ in the context of -the VNF for use in the VNF’s Heat Orchestration Template. - -R-83015 A VNF’s ‘{network-role}’ assigned to an external network **MUST** -be different than the ‘{network-role}’ assigned to the VNF’s internal -networks, if internal networks exist. - -ONAP enforces a naming convention for parameters associated with -external networks. `ONAP Resource ID and Parameter Naming Convention`_ -provides additional details. - -Internal Networks -~~~~~~~~~~~~~~~~~ - -ONAP defines an internal network in relation to the VNF and not with -regard to the Network Cloud site. Internal networks may also be referred -to as “intra-VNF” networks or “private” networks. An internal network -only connects VMs in a single VNF; it must not connect to other VNFs -or an external gateway or router - -R-87096 A VNF **MAY** contain zero, one or more than one internal networks. - -R-35666 If a VNF has an internal network, the VNF Heat Orchestration -Template **MUST** include the heat resources to create the internal network. - -R-86972 A VNF **SHOULD** create the internal network in the VNF’s Heat -Orchestration Template Base Module. - -An Internal Network may be created using Neutron Heat Resources and/or -Contrail Heat Resources. - -R-52425 A VNF’s port connected to an internal network **MUST** connect -the port to VMs in the same VNF. - -R-46461 A VNF’s port connected to an internal network **MUST NOT** connect -the port to VMs in another VNF and/or an external gateway and/or -external router. - -R-68936 When a VNF creates an internal network, a network role, referred to -as the ‘{network-role}’ **MUST** be assigned to the internal network for -use in the VNF’s Heat Orchestration Template. - -R-32025 When a VNF creates two or more internal networks, each internal -network **MUST** be assigned a unique ‘{network-role}’ in the context of -the VNF for use in the VNF’s Heat Orchestration Template. - -R-69874 A VNF’s ‘{network-role}’ assigned to an internal network **MUST** -be different than the ‘{network-role}’ assigned to the VNF’s external -networks. - -R-34726 If a VNF’s port is connected to an internal network and the port -is created in the same Heat Orchestration Template as the internal network, -then the port resource **MUST** use a ‘get_resource’ to obtain -the network UUID. - -R-22688 If a VNF’s port is connected to an internal network and the -port is created in an Incremental Module and the internal network is created -in the Base Module then the UUID of the internal network **MUST** be exposed -as a parameter in the ‘outputs:’ section of the Base Module and the port -resource **MUST** use a ‘get_param’ to obtain the network UUID. - -ONAP does not programmatically enforce a naming convention for -parameters for internal network. However, a naming convention is -provided that must be followed. -`ONAP Resource ID and Parameter Naming Convention`_ -provides additional details. - -ONAP Resource ID and Parameter Naming Convention -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section provides the ONAP naming requirements for - -1. Resource IDs - -2. Resource Property Parameters - -{vm-type} -~~~~~~~~~ - -R-01455 When a VNF's Heat Orchestration Template creates a Virtual Machine (i.e., 'OS::Nova::Server'), -each 'class' of VMs **MUST** be assigned a VNF unique -'{vm-type}'; where 'class' defines VMs that **MUST** have the following -identical characteristics: - - 1.) OS::Nova::Server property flavor value - - 2.) OS::Nova::Server property image value - - 3.) Cinder Volume attachments - - Each VM in the 'class' **MUST** have the identical Cinder Volume - configuration - - 4.) Network attachments and IP address requirements - - Each VM in the 'class' **MUST** have the the identical number - of ports connecting to the identical networks and requiring the - identical IP address configuration. - -R-82481 A VNF's Heat Orchestration Template's Resource property -parameter that is -associated with a unique Virtual Machine type **MUST** -include '{vm-type}' as part of the parameter name with two -exceptions: - - 1.) The Resource OS::Nova::Server property availability_zone parameter - **MUST NOT** be prefixed with a common '{vm-type} identifier, - - 2.) The Resource OS::Nova::Server eight mandatory and optional metadata - parameters (vnf_name, vnf_id, vf_module_id, vf_module_name, vm_role, - vf_module_index, environment_context, workload_context) **MUST NOT** - be prefixed with a common '{vm-type}' identifier. - - -R-66729 A VNF’s Heat Orchestration Template’s Resource that is -associated with a unique Virtual Machine type **MUST** include -‘{vm-type}’ as part of the resource ID. - -R-98407 A VNF's Heat Orchestration Template's '{vm-type}' **MUST** contain -only alphanumeric characters and/or underscores '_' and -**MUST NOT** contain any of the following strings: '_int' or 'int\_' -or '\_int\_'. - -R-48067 A VNF's Heat Orchestration Template's {vm-type} **MUST NOT** be a -substring of {network-role}. - -It may cause the Pre-Amsterdam VNF Validation Program (i.e., -ICE Project) process to produce erroneous error messages. - -R-32394 A VNF’s Heat Orchestration Template’s use of ‘{vm-type}’ -in all Resource property parameter names **MUST** be the same case. - -R-46839 A VNF’s Heat Orchestration Template’s use of -‘{vm-type}’ in all Resource IDs **MUST** be the same case. - -R-36687 A VNF’s Heat Orchestration Template’s ‘{vm-type}’ case in -Resource property parameter names **SHOULD** match the case of -‘{vm-type}’ in Resource IDs and vice versa. - -{network-role} -~~~~~~~~~~~~~~ - -The assignment of a {network-role} is discussed in `Networking`_. - -R-21330 A VNF’s Heat Orchestration Template’s Resource property parameter -that is associated with external network **MUST** include the ‘{network-role}’’ as part of the parameter name - -R-11168 A VNF's Heat Orchestration Template's Resource ID that is -associated with an external network **MUST** include the -'{network-role}' as part of the resource ID. - -R-84322 A VNF's Heat Orchestration Template's Resource property -parameter that is associated with an internal network -**MUST** include 'int\_{network-role}' as part of the parameter -name, where 'int\_' is a hard coded string. - -R-96983 A VNF's Heat Orchestration Template's Resource ID that is -associated with an internal network **MUST** include -'int\_{network-role}' as part of the Resource ID, where -'int\_' is a hard coded string. - -R-26506 A VNF's Heat Orchestration Template's '{network-role}' -**MUST** contain only alphanumeric characters and/or -underscores '_' and **MUST NOT** contain any of the following -strings: '_int' or 'int\_' or '\_int\_'. - -R-00977 A VNF’s Heat Orchestration Template’s ‘{network-role}’ -**MUST NOT** be a substring of ‘{vm-type}’. - -For example, if a VNF has a ‘{vm-type}’ of ‘oam’ and a -‘{network-role}’ of ‘oam_protected’ would be a violation of the requirement. - -R-58424 A VNF’s Heat Orchestration Template’s use of ‘{network-role}’ -in all Resource property parameter names **MUST** be the same case - -R-21511 A VNF’s Heat Orchestration Template’s use of ‘{network-role}’ -in all Resource IDs **MUST** be the same case. - -R-86588 A VNF’s Heat Orchestration Template’s ‘{network-role}’ case -in Resource property parameter names **SHOULD** match the case -of ‘{network-role}’ in Resource IDs and vice versa. - -Resource IDs -~~~~~~~~~~~~ - -Requirement R-75141 states a VNF’s Heat Orchestration Template’s -resource name (i.e., <resource ID>) MUST only contain alphanumeric -characters and underscores (‘_’).* - -Requirement R-16447 states a VNF’s <resource ID> MUST be unique -across all Heat Orchestration Templates and all HEAT Orchestration -Template Nested YAML files that are used to create the VNF. - -As stated previously, OpenStack requires the <resource ID> to be unique -to the Heat Orchestration Template and not unique across all Heat -Orchestration Templates the compose the VNF. - -Heat Orchestration Template resources are described in `resources`_ - -R-54517 When a VNF’s Heat Orchestration Template’s resource is associated -with a single ‘{vm-type}’, the Resource ID **MUST** contain the ‘{vm-type}’. - -R-96482 When a VNF’s Heat Orchestration Template’s resource is associated -with a single external network, the Resource ID MUST contain the text -‘{network-role}’. - -R-98138 When a VNF’s Heat Orchestration Template’s resource is associated -with a single internal network, the Resource ID MUST contain the text -‘int\_{network-role}’. - -R-82115 When a VNF's Heat Orchestration Template's resource is associated -with a single '{vm-type}' and a single external network, the Resource -ID text **MUST** contain both the '{vm-type}' and the '{network-role}' - -- the '{vm-type}' **MUST** appear before the '{network-role}' and **MUST** - be separated by an underscore '_' - - - e.g., '{vm-type}_{network-role}', '{vm-type}_{index}_{network-role}' - -- note that an '{index}' value **MAY** separate the '{vm-type}' and the - '{network-role}' and when this occurs underscores **MUST** separate the - three values. - -R-82551 When a VNF's Heat Orchestration Template's resource is associated -with a single '{vm-type}' and a single internal network, the Resource ID -**MUST** contain both the '{vm-type}' and the 'int\_{network-role}' and - -- the '{vm-type}' **MUST** appear before the 'int\_{network-role}' and - **MUST** be separated by an underscore '_' - - - (e.g., '{vm-type}\_int\_{network-role}', '{vm-type}_{index}\_int\_{network-role}') - -- note that an '{index}' value **MAY** separate the '{vm-type}' and the - 'int\_{network-role}' and when this occurs underscores **MUST** separate - the three values. - -R-67793 When a VNF’s Heat Orchestration Template’s resource is associated -with more than one ‘{vm-type}’ and/or more than one internal and/or -external network, the Resource ID **MUST NOT** contain the ‘{vm-type}’ -and/or ‘{network-role}’/’int\_{network-role}’. It also should contain the -term ‘shared’ and/or contain text that identifies the VNF - -R-27970 When a VNF’s Heat Orchestration Template’s resource is associated -with more than one ‘{vm-type}’ and/or more than one internal and/or -external network, the Resource ID **MAY** contain the term ‘shared’ -and/or **MAY** contain text that identifies the VNF. - -R-11690 When a VNF’s Heat Orchestration Template’s Resource ID contains -an {index} value (e.g. multiple VMs of same {vm-type}), the ‘{index}’ -**MUST** start at zero and increment by one. - -The table below provides example OpenStack Heat resource ID for -resources only associated with one {vm-type} and/or one network. - -The Requirements column states if the Resource ID Format MUST be followed -or SHOULD be followed. Resource ID formats that are marked MUST must be -followed, no deviations are permitted. Resource ID formats that are marked -SHOULD should be followed. However, deviations are permissible to meet -the needs of the VNF’s Heat Orchestration Template. - -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| Resource Type | Resource ID Format | Requirements | Notes | -| | | | | -+==============================+=================================================================+====================================+=========================+ -| OS::Cinder::Volume | {vm-type}\_volume\_{index} | **SHOULD** | | -| | | | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Cinder::VolumeAttachment | {vm-type}\_volumeattachment\_{index} | **SHOULD** | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Heat::CloudConfig | {vm-type}_RCC | **SHOULD** | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Heat::MultipartMime | {vm-type}_RMM | **SHOULD** | | -| | | | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Heat::ResourceGroup | {vm-type}_RRG | **SHOULD** | | -| | | | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | | | | -| | | | | -| | | | Resource ID for the | -| | {vm-type}_{index}\_subint\_{network-role}_ | **MUST** for subinterface creation | OS::Heat::ResourceGroup | -| | port\_{index}_subinterfaces | | that creates | -| | | | subinterfaces | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Heat::SoftwareConfig | {vm-type}_RSC | **SHOULD** | | -| | | | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Neutron::Port | {vm-type}_{vm-type-index}_{network-role}\_port\_{port-index} | **MUST** | Resource ID for port | -| | | | connecting to an | -| | | | external network. The | -| | | | {vm-type-index} | -| | | | is the | -| | | | instance of the | -| | | | {vm_type}. The | -| | | | {port-index} | -| | | | is the | -| | | | instance of the | -| | | | “port” on the | -| | | | {vm-type}. There is | -| | | | no index after | -| | | | {network_role} since | -| | | | since {network-role} | -| | | | is unque to the VNF, | -| | | | there should | -| | | | only be one instance. | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | {vm-type}_{index}\_int\_{network-role}\_port\_{index} | | Resource ID for port | -| | | **MUST** | connecting to an | -| | | | internal network. The | -| | | | {index} that follows | -| | | | {vm-type} is the | -| | | | instance of the | -| | | | {vm_type}. The | -| | | | {index} that follows | -| | | | “port” is the | -| | | | instance of the | -| | | | “port” on the | -| | | | {vm-type}. There is | -| | | | no index after | -| | | | {network_role} since | -| | | | since {network-role} | -| | | | is unque to the AIC | -| | | | LCP; there should | -| | | | only be one instance. | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | Reserve_Port\_{vm-type}_{network-role}\_floating_ip\_{index} | | Resource ID for a | -| | | **MUST** | reserve port that is | -| | | | used for an | -| | | | allowed_address_pair. | -| | Reserve_Port\_{vm-type}_{network-role}\_floating_v6_ip\_{index} | | See Section 5.6.5.5 | -| | | | for additional | -| | | | details. | -| | | | | -| | | | There is no {index} | -| | | | that follows | -| | | | {vm-type} | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Neutron::SecurityGroup | {vm-type}_Sec_Grp | | Security Group | -| | | **SHOULD** | applicable to one | -| | | | {vm-type} and more | -| | | | than one network | -| | | | (internal and/or | -| | | | external) | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | {network-role}_Sec_Grp | | Security Group | -| | | **SHOULD** | applicable to more | -| | | | than one {vm-type} | -| | | | and one external | -| | | | network | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | int\_{network-role}_Sec_Grp | | Security Group | -| | | **SHOULD** | applicable to more | -| | | | than one {vm-type} | -| | | | and one internal | -| | | | network | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | {vm-type}_{network-role}_Sec_Grp | | Security Group | -| | | **SHOULD** | applicable to one | -| | | | {vm-type} and one | -| | | | external network | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | {vm-type}\_int\_{network-role}_Sec_Grp | | Security Group | -| | | **SHOULD** | applicable to one | -| | | | {vm-type} and one | -| | | | internal network | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | Shared_Sec_Grp | | Security Group | -| | | **SHOULD** | applicable to more | -| | | | than one {vm-type} | -| | | | and more than one | -| | | | network (internal | -| | | | and/or external) | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Neutron::Subnet | int\_{network-role}\_subnet\_{index} | | VNF Heat | -| | | **MUST** | Orchestration | -| | | | Templates can only | -| | | | create internal | -| | | | networks. | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Neutron::Net | int\_{network-role}\_network | | VNF Heat | -| | | **MUST** | Orchestration | -| | | | Templates can only | -| | | | create internal | -| | | | networks. There is no | -| | | | {index} because | -| | | | {nework-role} should | -| | | | be unique. | -| | | | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Nova::Keypair | {vm-type}\_keypair\_{index} | **SHOULD** | Key Pair applicable to | -| | | | one {vm-type} | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | {vnf-type}_keypair | **SHOULD** | Key Pair applicable | -| | | | to all {vm-type} in the | -| | | | VNF | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Nova::Server | {vm-type}\_server\_{index} | Mandatory | | -| | | | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Nova::ServerGroup | {vm-type}_RSG | **SHOULD** | Both formats are | -| | | | valid. | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | {vm-type}_Server_Grp | **SHOULD** | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| | {vm-type}_ServerGroup | **SHOULD** | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ -| OS::Swift::Container | {vm-type}_RSwiftC | **SHOULD** | | -+------------------------------+-----------------------------------------------------------------+------------------------------------+-------------------------+ - - - Table 2: Example OpenStack Heat Resource ID - -The table below provides Resource ID Formats for Contrail heat resources. - - The Resource ID formats that are marked mandatory must be followed. - No deviations are permitted. - - The Resource ID formats that are marked optional should be followed. - However, deviations in the Resource ID format that is shown is - permitted. - -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| Resource | Resource ID | Mandatory / | Notes | | -| Type | Format | Optional | | | -+=================+==========================================================================+=================+=================+===+ -| OS::ContrailV2: | {vm-type}_{index}_{network-role}\_vmi\_{index}\_IP\_{index} | **MUST** – | The {index} | | -| :InstanceIp | | IPv4 address on | that follows | | -| | | vmi external | {vm-type} is | | -| | | network | the instance of | | -| | | | the {vm_type}. | | -| | | | The {index} | | -| | | | that follows | | -| | | | “vmi” is the | | -| | | | instance of the | | -| | | | “vmi” on the | | -| | | | {vm-type}. | | -| | | | There is no | | -| | | | index after | | -| | | | {network_role} | | -| | | | since since | | -| | | | {network-role} | | -| | | | is unque. The | | -| | | | {index} that | | -| | | | follows the | | -| | | | “IP” is the | | -| | | | instance of the | | -| | | | “IP” on the | | -| | | | “vmi” | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| | {vm-type}_{index}_{network-role}\_vmi\_{index}\_v6\_IP\_{index} | **MUST** – | | | -| | | IPv6 address on | | | -| | | vmi external | | | -| | | network | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| | {vm-type}_{index}\_int\_{network-role}\_vmi\_{index}\_IP\_{index} | **MUST** – | | | -| | | IPv4 address on | | | -| | | vmi internal | | | -| | | network | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| | {vm-type}_{index}\_int\_{network-role}\_vmi\_{index}\_v6\_IP\_{index} | **MUST** – | | | -| | | IPv6 address on | | | -| | | vmi internal | | | -| | | network | | | -| | | | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| | {vm-type}_{index}\_subint\_{network-role}\_vmi\_{index}\_IP\_{index} | **MUST** – | | | -| | | IPv4 address on | | | -| | | sub-interface | | | -| | | vmi external | | | -| | | network | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| | {vm-type}_{index}\_subint\_{network-role}\_vmi\_{index}\_v6\_IP\_{index} | **MUST** – | | | -| | | IPv6 address on | | | -| | | sub-interface | | | -| | | vmi external | | | -| | | network | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| OS::ContrailV2: | {network-role}_RIRT | **MAY** | | | -| :InterfaceRoute | | | | | -| Table | | | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| OS::ContrailV2: | {network-role}_RNI | **MAY** | | | -| :NetworkIpam | | | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| OS::ContrailV2: | {vm-type}_RPT | **MAY** | | | -| :PortTuple | | | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| OS::ContrailV2: | {vm-type}\_RSHC\_{LEFT/RIGHT} | **MAY** | | | -| :ServiceHealthC | | | | | -| heck | | | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| OS::ContrailV2: | {vm-type}\_RST\_{index} | **MAY** | | | -| :ServiceTemplat | | | | | -| e | | | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| OS::ContrailV2: | {vm-type}\_{index}\_{network-role}\_vmi\_{index} | **MUST** - vmi | Resource ID for | | -| :VirtualMachine | | attached to an | virtual machine | | -| Interface | | external | interface (vmi) | | -| | | network | connecting to | | -| | | | an external | | -| | | | network. The | | -| | | | {index} that | | -| | | | follows | | -| | | | {vm-type} is | | -| | | | the instance of | | -| | | | the {vm_type}. | | -| | | | The {index} | | -| | | | that follows | | -| | | | “vmi” is the | | -| | | | instance of the | | -| | | | “vmi” on the | | -| | | | {vm-type}. | | -| | | | There is no | | -| | | | index after | | -| | | | {network_role} | | -| | | | since since | | -| | | | {network-role} | | -| | | | is unque to the | | -| | | | AIC LCP; there | | -| | | | should only be | | -| | | | one instance. | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| | {vm-type}_{index}\_int\_{network-role}\_vmi\_{index} | **MUST** - vmi | | | -| | | attached to an | | | -| | | internal | | | -| | | network | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| | {vm-type}_{index}\_subint\_{network-role}\_vmi\_{index} | **MUST** - vmi | | | -| | | attached to a | | | -| | | sub-interface | | | -| | | network | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| OS::ContrailV2: | int\_{network-role}\_RVN | **MAY** | VNF Heat | | -| :VirtualNetwork | | | Orchestration | | -| | | | Templates can | | -| | | | only create | | -| | | | internal | | -| | | | networks. There | | -| | | | is no {index} | | -| | | | because | | -| | | | {nework-role} | | -| | | | should be | | -| | | | unique. Both | | -| | | | formats are | | -| | | | valid. | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ -| | int\_{network-role}\_network | **MAY** | | | -| | | | | | -+-----------------+--------------------------------------------------------------------------+-----------------+-----------------+---+ - - Table 3: Example Contrail Heat resource ID - -There is a use case where the template filename is used as the type: as -shown in the example below. There is no suggested Resource ID naming -convention for this use case. - -Example: Template Filename used as the type: - -.. code-block:: python - - heat_template_version: 2015-04-30 - - resources: - <Resource ID>: - type: file.yaml - properties: - ... - -Resource: OS::Nova::Server - Parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The resource OS::Nova::Server manages the running virtual machine (VM) -instance within an OpenStack cloud. (See -https://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Nova::Server.) - -Four properties of this resource must follow the ONAP parameter naming -convention. The four properties are: - -1. image - -2. flavor - -3. name - -4. availability\_zone - -Requirement R-01455 defines how the ‘{vm-type]’ is defined. - -Requirement R-82481 defines how the ‘{vm-type} is used.’ - -The table below provides a summary. The sections that follow provides -the detailed requirements. - -.. csv-table:: **Table 4 OS::Nova::Server Resource Property Parameter Naming Convention** - :header: Property Name,Parameter Type,Parameter Name,Parameter Value Provided to Heat - :align: center - :widths: auto - - image, string, {vm-type}\_image\_name, Environment File - flavor, string, {vm-type}\_flavor\_name, Environment File - name, string, {vm-type}\_name\_{index}, ONAP - name, CDL, {vm-type}_names, ONAP - availability_zone, string, availability\_zone\_{index}, ONAP - -Property: image -+++++++++++++++ - -R-71152 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘image’ parameter **MUST** be declared as -type: ‘string’. - -R-58670 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘image’ parameter name **MUST** follow the -naming convention ‘{vm-type}_image_name’. - -R-91125 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘image’ parameter **MUST** be enumerated in -the Heat Orchestration Template’s Environment File and a value **MUST** be -assigned. - -R-57282 Each VNF’s Heat Orchestration Template’s ‘{vm-type}’ -**MUST** have a unique parameter name for the ‘OS::Nova::Server’ -property ‘image’ even if more than one {vm-type} shares the same image. - -*Example Parameter Definition* - -.. code-block:: yaml - - parameters: - {vm-type}_image_name: - type: string - description: {vm-type} server image - -Property: flavor -++++++++++++++++ - -R-50436 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘flavor’ parameter **MUST** be declared as -type: ‘string’. - -R-45188 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘flavor’ parameter name **MUST** follow the -naming convention ‘{vm-type}_flavor_name’. - -R-69431 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘flavor’ parameter **MUST** be enumerated in the -Heat Orchestration Template’s Environment File and a value **MUST** be -assigned. - -R-40499 Each VNF’s Heat Orchestration Template’s ‘{vm-type}’ **MUST** -have a unique parameter name for the ‘OS::Nova::Server’ property -‘flavor’ even if more than one {vm-type} shares the same flavor. - -*Example Parameter Definition* - -.. code-block:: yaml - - parameters: - {vm-type}_flavor_name: - type: string - description: {vm-type} flavor - -Property: Name -++++++++++++++ - -R-51430 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘name’ parameter **MUST** be declared as -either type ‘string’ or type ‘comma_delimited_list”. - -R-54171 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘name’ parameter is defined as a ‘string’, -the parameter name **MUST** follow the naming convention -‘{vm-type}\_name\_{index}’, where {index} is a numeric value that starts -at zero and increments by one. - -R-40899 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘name’ parameter is defined as a ‘string’, -a parameter **MUST** be declared for each ‘OS::Nova::Server’ resource -associated with the ‘{vm-type}’. - -R-87817 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘name’ parameter is defined as a -‘comma_delimited_list’, the parameter name **MUST** follow the naming -convention ‘{vm-type}_names’. - -R-85800 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘name’ parameter is defined as a -‘comma_delimited_list’, a parameter **MUST** be delcared once for all -‘OS::Nova::Server’ resources associated with the ‘{vm-type}’. - -R-22838 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘name’ parameter **MUST NOT** be enumerated -in the Heat Orchestration Template’s Environment File. - -If a VNF’s Heat Orchestration Template’s contains more than three -OS::Nova::Server resources of a given {vm-type}, the comma_delimited_list -form of the parameter name (i.e., ‘{vm-type}_names’) should be used to -minimize the number of unique parameters defined in the template. - - -*Example: Parameter Definition* - -.. code-block:: python - - parameters: - - {vm-type}_names: - type: comma_delimited_list - description: VM Names for {vm-type} VMs - - {vm-type}_name_{index}: - type: string - description: VM Name for {vm-type} VM {index} - -*Example: comma_delimited_list* - -In this example, the {vm-type} has been defined as “lb” for load balancer. - -.. code-block:: python - - parameters: - - lb_names: - type: comma_delimited_list - description: VM Names for lb VMs - - resources: - lb_server_0: - type: OS::Nova::Server - properties: - name: { get_param: [lb_names, 0] } - ... - - lb_server_1: - type: OS::Nova::Server - properties: - name: { get_param: [lb_names, 1] } - ... - -*Example: fixed-index* - -In this example, the {vm-type} has been defined as “lb” for load balancer. - -.. code-block:: python - - parameters: - - lb_name_0: - type: string - description: VM Name for lb VM 0 - - lb_name_1: - type: string - description: VM Name for lb VM 1 - - resources: - - lb_server_0: - type: OS::Nova::Server - properties: - name: { get_param: lb_name_0 } - ... - - lb_server_1: - type: OS::Nova::Server - properties: - name: { get_param: lb_name_1 } - ... - -Contrail Issue with Values for OS::Nova::Server Property Name -_____________________________________________________________ - -R-44271 The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property -'name' parameter value **SHOULD NOT** contain special characters -since the Contrail GUI has a limitation displaying special characters. - -However, if special characters must be used, the only special characters -supported are: - ---- \" ! $ ' (\ \ ) = ~ ^ | @ ` { } [ ] > , . _ - - -Property: availability\_zone -++++++++++++++++++++++++++++ - -R-98450 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘availability_zone’ parameter name -**MUST** follow the naming convention ‘availability\_zone\_{index}’ -where the ‘{index}’ **MUST** start at zero and increment by one. - -R-23311 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘availability_zone’ parameter **MUST** -be declared as type: ‘string’. - -The parameter must not be declared as type ‘comma_delimited_list’, -ONAP does not support it. - -R-59568 The VNF’s Heat Orchestration Template’s Resource -‘OS::Nova::Server’ property ‘availability_zone’ parameter **MUST NOT** -be enumerated in the Heat Orchestration Template’s Environment File. - -Example Parameter Definition - -.. code-block:: python - - parameters: - availability_zone_{index}: - type: string - description: availability zone {index} name - -Requirement R-90279 states that a VNF Heat Orchestration’s template’s -parameter MUST be used in a resource with the exception of the parameters -for the OS::Nova::Server resource property availability_zone. - -R-01359 A VNF’s Heat Orchstration Template that contains an -‘OS::Nova:Server’ Resource **MAY** define a parameter for the property -‘availability_zone’ that is not utilized in any ‘OS::Nova::Server’ -resources in the Heat Orchestration Template. - -Example -+++++++ - -The example below depicts part of a Heat Orchestration Template that -uses the four OS::Nova::Server properties discussed in this section. - -In the Heat Orchestration Template below, four Virtual -Machines (OS::Nova::Server) are created: two dns servers with -{vm-type} set to “dns” and two oam servers with {vm-type} set to “oam”. -Note that the parameter associated with the property name is a -comma_delimited_list for dns and a string for oam. - -.. code-block:: python - - parameters: - - dns_image_name: - type: string - description: dns server image - - dns_flavor_name: - type: string - description: dns server flavor - - dns_names: - type: comma_delimited_list - description: dns server names - - oam_image_name: - type: string - description: oam server image - - oam_flavor_name: - type: string - description: oam server flavor - - oam_name_0: - type: string - description: oam server name 0 - - oam_name_1: - type: string - description: oam server name 1 - - availability_zone_0: - type: string - description: availability zone ID or Name - - availability_zone_1: - type: string - description: availability zone ID or Name - - resources: - - dns_server_0: - type: OS::Nova::Server - properties: - name: { get_param: [ dns_names, 0 ] } - image: { get_param: dns_image_name } - flavor: { get_param: dns_flavor_name } - availability_zone: { get_param: availability_zone_0 } - - . . . - - dns_server_1: - type: OS::Nova::Server - properties: - name: { get_param: [ dns_names, 1 ] } - image: { get_param: dns_image_name } - flavor: { get_param: dns_flavor_name } - availability_zone: { get_param: availability_zone_1 } - - . . . - - oam_server_0: - type: OS::Nova::Server - properties: - name: { get_param: oam_name_0 } - image: { get_param: oam_image_name } - flavor: { get_param: oam_flavor_name } - availability_zone: { get_param: availability_zone_0 } - - . . . - - oam_server_1: - type: OS::Nova::Server - properties: - name: { get_param: oam_name_1 } - image: { get_param: oam_image_name } - flavor: { get_param: oam_flavor_name } - availability_zone: { get_param: availability_zone_1 } - - . . . - -Boot Options -++++++++++++ - -R-99798 A VNF’s Heat Orchestration Template’s Virtual Machine -(i.e., OS::Nova::Server Resource) **MAY** boot from an image or **MAY** -boot from a Cinder Volume. - -R-83706 When a VNF’s Heat Orchestration Template’s Virtual Machine -(i.e., ‘OS::Nova::Server’ Resource) boots from an image, the -‘OS::Nova::Server’ resource property ‘image’ **MUST** be used. - -The requirements associated with -the 'image' property are detailed in `Property: image`_ - -R-69588 When a VNF’s Heat Orchestration Template’s Virtual Machine -(i.e., ‘OS::Nova::Server’ Resource) boots from Cinder Volume, the -‘OS::Nova::Server’ resource property ‘block_device_mapping’ or -‘block_device_mapping_v2’ **MUST** be used. - -There are currently no heat guidelines -associated with these two properties: -'block_device_mapping' and 'block_device_mapping_v2'. - -Resource: OS::Nova::Server – Metadata Parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The OS::Nova::Server Resource property metadata is an optional -OpenStack property. -The table below summarizes the mandatory and optional metadata -supported by ONAP. - -The sections that follow provides the requirements associated with each -metadata parameter. - -.. csv-table:: **Table 5 OS::Nova::Server Mandatory and Optional Metadata** - :header: Metadata Parameter Name, Parameter Type, Required, Parameter Value Provided to Heat - :align: center - :widths: auto - - vnf_id, string, **MUST**, ONAP - vf_module_id, string, **MUST**, ONAP - vnf_name, string, **MUST**, ONAP - vf_module_name, string, **SHOULD**, ONAP - vm_role, string, **MAY**, YAML or Environment File - vf_module_index, string, **MAY**, ONAP - workload_context, string, **SHOULD**, ONAP - environment_context, string, **SHOULD**, ONAP - -vnf\_id -+++++++ - -The OS::Nova::Server Resource metadata map value parameter 'vnf_id' -is an ONAP generated UUID that identifies the VNF. The value -is provided by ONAP to the VNF's Heat Orchestration -Template at orchestration time. - -R-37437 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource **MUST** contain the metadata map value parameter ‘vnf_id’. - -R-07507 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_id’ **MUST** be declared -as type: ‘string’. - -R-55218 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_id’ **MUST NOT** have -parameter contraints defined. - -R-20856 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_id’ **MUST NOT** be -enumerated in the Heat Orchestration Template’s environment file. - -R-44491 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_id’ is passed into a -Nested YAML file, the parameter name ‘vnf_id’ **MUST NOT** change. - - -*Example 'vnf_id' Parameter Definition* - -.. code-block:: python - - parameters: - - vnf_id: - type: string - description: Unique ID for this VNF instance - -vf\_module\_id -++++++++++++++ - -The OS::Nova::Server Resource metadata map value parameter 'vf\_module\_id' -is an ONAP generated UUID that identifies the VF Module (e.g., Heat -Orchestration Template). The value -is provided by ONAP to the VNF's Heat Orchestration -Template at orchestration time. - -R-71493 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource **MUST** contain the metadata map value parameter -‘vf\_module\_id’. - -R-82134 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_id’ **MUST** -be declared as type: ‘string’. - -R-98374 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_id’ **MUST NOT** -have parameter contraints defined. - -R-72871 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_id’ **MUST NOT** -be enumerated in the Heat Orchestration Template’s environment file. - -R-86237 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf_module_id’ is passed -into a Nested YAML file, the parameter name ‘vf\_module\_id’ -**MUST NOT** change. - -*Example 'vf\_module\_id' Parameter Definition* - -.. code-block:: python - - parameters: - - vnf_module_id: - type: string - description: Unique ID for this VNF module instance - - -vnf\_name -+++++++++ - -The OS::Nova::Server Resource metadata map value parameter 'vnf_name' -is the ONAP generated alphanumeric name of the deployed VNF instance. -The value -is provided by ONAP to the VNF's Heat Orchestration -Template at orchestration time. -The parameter must be declared as type: string - -R-72483 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource **MUST** contain the metadata map value parameter -‘vnf_name’. - -R-62428 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_name’ **MUST** be -declared as type: ‘string’. - -R-44318 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_name’ **MUST NOT** have -parameter contraints defined. - -R-36542 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_name’ **MUST NOT** be -enumerated in the Heat Orchestration Template’s environment file. - -R-16576 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_name’ is passed into a -Nested YAML file, the parameter name ‘vnf_name’ **MUST NOT** change. - -*Example 'vnf_name' Parameter Definition* - -.. code-block:: python - - parameters: - - vnf_name: - type: string - description: Unique name for this VNF instance - -vf\_module\_name -++++++++++++++++ - -The OS::Nova::Server Resource metadata map value parameter 'vf_module_name' -is the deployment name of the heat stack created (e.g., <STACK_NAME>) from the -VNF's Heat Orchestration template -in the command 'Heat stack-create' -(e.g., 'Heat stack-create [-f <FILE>] [-e <FILE>] <STACK_NAME>'). -The 'vf_module_name' (e.g., <STACK_NAME> is specified as -part of the orchestration process. - -R-68023 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource **SHOULD** contain the metadata map value parameter -‘vf\_module\_name’. - -R-39067 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_name’ **MUST** -be declared as type: ‘string’. - -R-15480 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_name’ -**MUST NOT** have parameter contraints defined. - -R-80374 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_name’ -**MUST NOT** be enumerated in the Heat Orchestration Template’s -environment file. - -R-49177 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_name’ is passed -into a Nested YAML file, the parameter name ‘vf\_module\_name’ -**MUST NOT** change. - -*Example 'vf_module_name' Parameter Definition* - -.. code-block:: python - - parameters: - - vf_module_name: - type: string - description: Unique name for this VNF Module instance - -vm\_role -++++++++ - -The OS::Nova::Server Resource metadata map value parameter 'vm-role' -is a metadata tag that describes the role of the Virtual Machine. -The 'vm_role' is stored in ONAP's A&AI module and is -available for use by other ONAP components and/or north bound systems. - -R-85328 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource **MAY** contain the metadata map value parameter ‘vm_role’. - -R-95430 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vm_role’ **MUST** be -declared as type: ‘string’. - -R-67597 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vm_role’ **MUST NOT** have -parameter contraints defined. - -R-46823 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vnf_name’ **MUST** be -either - - - enumerated in the VNF’s Heat Orchestration - Template’s environment file. - - - hard coded in the VNF’s Heat Orchestration - Template’s OS::Nova::Resource metadata property. - -Defining the 'vm_role' as the '{vm-type}' is a recommended convention - -R-86476 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vm_role’ value **MUST only** -contain alphanumeric characters and underscores ‘_’. - -R-70757 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vm_role’ is passed into a -Nested YAML file, the parameter name ‘vm_role’ **MUST NOT** change. - - -*Example 'vm_role' Parameter Definition* - -.. code-block:: python - - parameters: - - vm_role: - type: string - description: Unique role for this VM - -*Example: 'vm-role' Definition: Hard Coded in -OS::Nova::Resource metadata property* - -.. code-block:: python - - resources: - - dns_server_0 - type: OS::Nova::Server - properties: - . . . . - metadata: - vm_role: dns - -*Example 'vm-role' Definition: Defined in Environment file -and retrieved via 'get_param'* - -.. code-block:: python - - resources: - - dns_server_0: - type: OS::Nova::Server - properties: - . . . . - metadata: - vm_role: { get_param: vm_role } - -Example vnf_id, vf_module_id, vnf_name, vf_module_name, vm_role -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -The example below depicts part of a Heat Orchestration Template -that uses the five of the OS::Nova::Server metadata parameter -discussed in this section. The {vm-type} has been defined as lb -for load balancer. - -.. code-block:: python - - parameters: - lb_name_0 - type: string - description: VM Name for lb VM 0 - vnf_name: - type: string - description: Unique name for this VNF instance - vnf_id: - type: string - description: Unique ID for this VNF instance - vf_module_name: - type: string - description: Unique name for this VNF Module instance - vf_module_id: - type: string - description: Unique ID for this VNF Module instance - vm_role: - type: string - description: Unique role for this VM - resources: - lb_server_0: - type: OS::Nova::Server - properties: - name: { get_param: lb_name_0 } - ... - metadata: - vnf_name: { get_param: vnf_name } - vnf_id: { get_param: vnf_id } - vf_module_name: { get_param: vf_module_name } - vf_module_id: { get_param: vf_module_id } - vm_role: lb - -vf\_module\_index -+++++++++++++++++ - -R-50816 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource **MAY** contain the metadata map value parameter -‘vf\_module\_index’. - -R-54340 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_index’ **MUST** be -declared as type: ‘number’. - -R-09811 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_index’ **MUST NOT** -have parameter contraints defined. - -R-37039 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_index’ **MUST NOT** -be enumerated in the Heat Orchestration Template’s environment file. - -R-22441 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_index’ is passed -into a Nested YAML file, the parameter name ‘vf\_module\_index’ -**MUST NOT** change. - -R-55306 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘vf\_module\_index’ **MUST NOT** be -used in a VNF’s Volume Template; it is not supported. - -The vf_module_index parameter indicates which instance of the module is being -deployed into the VNF. -This parameter may be used in cases where multiple instances of the same -incremental module may be instantiated for scaling purposes. The index -can be used in the Heat Orchestration Template for indexing into a -pseudo-constant array parameter when unique values are required for each -module instance, e.g., for fixed private IP addresses on VM types. - -The vf_module_index will start at 0 for the first instance of a module -type. Subsequent instances of the same module type will receive the -lowest unused index. This means that indexes will be reused if a module -is deleted and re-added. As an example, if three copies of a module are -deployed with vf_module_index values of 0, 1, and 2 then subsequently -the second one is deleted (index 1), and then re-added, index 1 will be -reused. - -*Example* - -In this example, the {vm-type} has been defined as oam_vm to represent -an OAM VM. An incremental heat module is used to deploy the OAM VM. The -OAM VM attaches to an internal control network which has a -{network-role} of ctrl. A maximum of four OAM VMs can be deployed. The -environment file contains the four IP addresses that each successive OAM -VM will be assigned. The vf_module_index is used as the index to -determine the IP assignment. - -Environment File - -.. code-block:: python - - parameters: - oam_vm_int_ctrl_ips: 10.10.10.1,10.10.10.2,10.10.10.3,10.10.10.4 - -YAML File - -.. code-block:: python - - parameters: - vf_module_index: - type: number - description: Unique index for this VNF Module instance - oam_vm_name_0: - type: string - description: VM Name for lb VM 0 - int_ctrl_net_id: - type: string - description: Neutron UUID for the internal control network - oam_vm_int_ctrl_ips: - type: comma_delimited_list - description: Fixed IP assignments for oam VMs on the internal control - network - resources: - oam_vm_server_0: - type: OS::Nova::Server - properties: - name: { get_param: oam_vm_name_0 } - networks: - - port: { get_resource: oam_vm_0_int_ctrl_port_0 } - . . . - metadata: - vf_module_index: { get_param: vf_module_index } - oam_vm_0_int_ctrl_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: int_ctrl_net_id } - fixed_ips: [ { “ip_address”: {get_param: [ oam_vm_int_ctrl_ips, { get_param, vf_module_index]}}}] - -workload_context -++++++++++++++++ - -R-47061 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource **SHOULD** contain the metadata map value parameter -‘workload_context’. - -R-74978 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘workload_context’ **MUST** be -declared as type: ‘string’. - -R-34055 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘workload_context’ **MUST NOT** -have parameter contraints defined. - -R-02691 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘workload_context’ **MUST NOT** -be enumerated in the Heat Orchestration Template’s environment file. - -R-75202 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘workload_context’ is passed -into a Nested YAML file, the parameter name ‘workload_context’ -**MUST NOT** change. - -The 'workload_context' parameter value will be chosen by the Service Model -Distribution context client in VID and will be supplied to the -Heat Orchestration Template by ONAP at orchestration time. - -*Example Parameter Definition* - -.. code-block:: python - - parameters: - workload_context: - type: string - description: Workload Context for this VNF instance - - -*Example OS::Nova::Server with metadata* - -.. code-block:: python - - resources: - . . . - - {vm-type}_server_{index}: - type: OS::Nova::Server - properties: - name: - flavor: - image: - ... - metadata: - vnf_name: { get_param: vnf_name } - vnf_id: { get_param: vnf_id } - vf_module_name: { get_param: vf_module_name } - vf_module_id: { get_param: vf_module_id } - workload_context: {get_param: workload_context} - -environment_context -+++++++++++++++++++ - -R-88536 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource **SHOULD** contain the metadata map value parameter -‘environment_context’. - -R-20308 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘environment_context’ **MUST** -be declared as type: ‘string’. - -R-56183 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘environment_context’ **MUST NOT** -have parameter contraints defined. - -R-13194 A VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘environment_context’ **MUST NOT** -be enumerated in the Heat Orchestration Template’s environment file. - -R-62954 If a VNF’s Heat Orchestration Template’s OS::Nova::Server -Resource metadata map value parameter ‘environment_context’ is -passed into a Nested YAML file, the parameter name -‘environment_context’ **MUST NOT** change. - -The 'environment_context' parameter value will be defined by the -service designer as part of the service model during the SDC -on-boarding process and will be supplied to the Heat Orchestration -Template by ONAP at orchestration time. - - -*Example Parameter Definition* - -.. code-block:: python - - parameters: - environment_context: - type: string - description: Environment Context for this VNF instance - - -*Example OS::Nova::Server with metadata* - -.. code-block:: python - - resources: - . . . - - {vm-type}_server_{index}: - type: OS::Nova::Server - properties: - name: - flavor: - image: - ... - metadata: - vnf_name: { get_param: vnf_name } - vnf_id: { get_param: vnf_id } - vf_module_name: { get_param: vf_module_name } - vf_module_id: { get_param: vf_module_id } - workload_context: {get_param: workload_context} - environment_context: {get_param: environment_context } - - -Resource: OS::Neutron::Port - Parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The resource OS::Neutron::Port is for managing Neutron ports (See -https://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Neutron::Port.) - -Introduction -++++++++++++ - -Four properties of the resource OS::Neutron::Port that must follow the -ONAP parameter naming convention. The four properties are: - -1. network -2. fixed_ips, ip_address -3. fixed_ips, subnet_id or fixed_ips, subnet - * Note that in many examples in this document fixed_ips, subnet_id is used. -4. allowed_address_pairs, ip_address - -Below is a generic example. Note that for some parameters -comma_delimited_list are supported in addition to String. - -.. code-block:: python - - resources: - - ... - - <resource ID>: - type: OS::Neutron::Port - properties: - allowed_address_pairs: [{"ip_address": String, "mac_address": String}, - {"ip_address": String, "mac_address": String}, ...] - fixed_ips: [{"ip_address": String, "subnet_id": String, "subnet": - String}, {"ip_address": String, "subnet_id": String, "subnet": String}, - ...] - network: String - -The parameters associated with these properties may reference an -external network or internal network. External networks and internal -networks are defined in `Networking`_. - -When the OS::Neutron::Port is attaching to an external network, all -property values are parameters that are retrieved via the intrinsic -function 'get_param'. - -When the OS::Neutron::Port is attaching to an internal network, a -property value maybe retrieved via the intrinsic -function 'get_param', 'get_resource', or 'get_attr'. - -This will be described in the forth coming sections. - -Items to Note -_____________ - -A network (internal or external) may contain one or or more subnets. - -A VNF can have one or more ports connected to the same network. - -A port can have one or more IP addresses assigned. - -The IP address assignments can be IPv4 addresses and/or IPv6 addresses. - -The IP addresses assignments for a unique external network **MUST** -be all Cloud Assigned addresses OR **MUST** be all ONAP -SDN-C assigned IP addresses. - -If the IP addresses are Cloud Assigned, all the IPv4 Addresses **MUST** -be from -the same subnet and all the IPv6 Addresses **MUST** be from the -same subnet. - -If the IP addresses are ONAP SDN-C assigned, -the IPv4 Addresses **MAY** -be from -different subnets and the IPv6 Addresses **MAY** be from different -subnets. - -If a VNF's Port is attached to an external network the IP addresses **MAY** -either be assigned by - 1. ONAP's SDN-Controller (SDN-C) - 2. Cloud Assigned by OpenStack’s DHCP Service - -If a VNF's Port is attached to an external network and the port's IP addresses -are assigned by ONAP's SDN-Controller, the 'OS::Neutron::Port' Resource's - * property 'fixed_ips' map property 'ip_address' **MUST** be used - * property 'fixed_ips' map property 'subnet'/'subnet_id' - **MUST NOT** be used - -If a VNF's Port is attached to an external network and the port's IP addresses -are Cloud Assigned by OpenStack’s DHCP Service, -the 'OS::Neutron::Port' Resource's - * property 'fixed_ips' map property 'ip_address' **MUST NOT** be used - * property fixed_ips' map property 'subnet'/'subnet_id' **MAY** be used - -If a VNF's Port is attached to an internal network and the port's IP addresses -are assigned by the VNF's Heat Orchestration Template -(i.e., enumerated in the Heat Orchestration Template's environment file), -the 'OS::Neutron::Port' Resource's - * property 'fixed_ips' map property 'ip_address' **MUST** be used - * property 'fixed_ips' map property 'subnet'/'subnet_id' - **MUST NOT** be used - -If a VNF's Port is attached to an internal network and the port's IP addresses -are Cloud Assigned by OpenStack’s DHCP Service, -the 'OS::Neutron::Port' Resource's - * property 'fixed_ips' map property 'ip_address' **MUST NOT** be used - * property 'fixed_ips' map property 'subnet'/'subnet_id' - **MAY** be used - -If a VNF's Heat Orchestration Template 'OS::Neutron::Port' Resource property -'fixed_ips' map property 'ip_address' is specified, then the -'fixed_ips' map property 'subnet'/'subnet_id' **MUST NOT** -be specified. - -If a VNF's Heat Orchestration Template 'OS::Neutron::Port' Resource property -'fixed_ips' map property 'subnet'/'subnet_id' is specified, then the -'fixed_ips' map property 'ip_address' **MUST NOT** -be specified. - -.. csv-table:: **Table 4 OS::Nova::Server Resource Property Parameter Naming Convention** - :header: Resource,Property,Parameter Type,Parameter Name,Parameter Value Provided to Heat - :align: center - :widths: auto - - OS::Nova::Server, image, string, {vm-type}_image_name, Environment File - -Property: network -+++++++++++++++++ - -The Resource 'OS::Neutron::Port' property 'network' determines what network -the port is attached to. - - -R-18008 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -property ‘network’ parameter **MUST** be declared as type: ‘string’. - -R-62983 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -is attaching to an external network, the ‘network’ parameter name **MUST** - -- follow the naming convention ‘{network-role}_net_id’ if the Neutron - network UUID value is used to reference the network -- follow the naming convention ‘{network-role}_net_name’ if the OpenStack - network name is used to reference the network. - -where ‘{network-role}’ is the network-role of the external network and -a ‘get_param’ **MUST** be used as the intrinsic function. - -R-86182 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -is attaching to an internal network, and the internal network is created in a different -Heat Orchestration Template than the ‘OS::Neutron::Port’, the ‘network’ -parameter name **MUST** - -- follow the naming convention ‘int\_{network-role}_net_id’ if the Neutron - network UUID value is used to reference the network -- follow the naming convention ‘int\_{network-role}_net_name’ if the - OpenStack network name in is used to reference the network. - -where ‘{network-role}’ is the network-role of the internal network and a ‘get_param’ **MUST** be used as the intrinsic function. - -In Requirement R-86182, the internal network is created in the VNF's -Base Module (Heat Orchestration Template) and the parameter name is -declared in the Base Module's outputs' section. -The output parameter name will be declared as a parameter in the -'parameters' section of the incremental module. - -R-93177 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -is attaching to an internal network, and the internal network is created in the same Heat -Orchestration Template than the ‘OS::Neutron::Port’, the ‘network’ -parameter name **MUST** obtain the UUID of the internal network by using -the intrinsic function ‘get_resource’ or ‘get_attr’ and referencing the -Resource ID of the internal network. - -R-29872 The VNF’s Heat Orchestration Template’s Resource ‘OS::Nova::Server’ -property ‘network’ parameter **MUST NOT** be enumerated in the Heat -Orchestration Template’s Environment File. - -The parameter values for external networks are provided by ONAP -to the VNF's Heat Orchestration Template at orchestration time. - -The parameter values for internal networks created in the VNF's Base Module -Heat Orchestration Template -are provided to the VNF's Incremental Module Heat Orchestration Template -at orchestration time. - -*Example Parameter Definition of External Networks* - -.. code-block:: python - - parameters: - - {network-role}_net_id: - type: string - description: Neutron UUID for the external {network-role} network - - {network-role}_net_name: - type: string - description: Neutron name for the external {network-role} network - - -*Example Parameter Definition of Internal Networks in an Incremental Module* - -.. code-block:: python - - parameters: - - int_{network-role}_net_id: - type: string - description: Neutron UUID for the internal int_{network-role} network - - int_{network-role}_net_name: - type: string - description: Neutron name for the internal int_{network-role} network - -Property: fixed_ips, Map Property: ip_address -+++++++++++++++++++++++++++++++++++++++++++++ - -The resource 'OS::Neutron::Port' property 'fixed_ips' -map property 'ip_address' -is used to assign one IPv4 or IPv6 -addresses to port. - -One 'OS::Neutron::Port' resource may assign one or more -IPv4 and/or IPv6 addresses. - -R-34037 The VNF’s Heat Orchestration Template’s resource ‘OS::Neutron::Port’ -property ‘fixed_ips’ map property ‘ip_address’ parameter **MUST** be declared as -either type ‘string’ or type ‘comma_delimited_list’. - -R-40971 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ is attaching to an external network, and an IPv4 address is -assigned using the property -‘fixed_ips’ map property ‘ip_address’ and the parameter type is defined -as a string, the parameter name **MUST** follow the naming -convention ‘{vm-type}_{network-role}\_ip\_{index}’, where - -- ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server -- ‘{network-role}’ is the {network-role} of the external network -- the value for {index} must start at zero (0) and increment by one - -R-39841 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -property ‘fixed_ips’ map property ‘ip_address’ parameter -‘{vm-type}_{network-role}\_ip\_{index}’ **MUST NOT** be enumerated in the -VNF’s Heat Orchestration Template’s Environment File. - -ONAP's SDN-Controller assigns the IP Address and ONAP provides -the value at orchestration to the Heat Orchestration Template. - -*Example External Network IPv4 Address string Parameter Definition* - -.. code-block:: python - - parameters: - - {vm-type}_{network-role}_ip_{index}: - type: string - description: Fixed IPv4 assignment for {vm-type} VM {index} on the{network-role} network - -R-04697 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -is attaching to an external network, and an IPv4 address is assigned using -the property ‘fixed_ips’ map property ‘ip_address’ and the parameter type -is defined as a comma_delimited_list, the parameter name **MUST** follow the -naming convention ‘{vm-type}_{network-role}_ips’, where - -- ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server -- ‘{network-role}’ is the {network-role} of the external network - -R-98905 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -property ‘fixed_ips’ map property ‘ip_address’ parameter -‘{vm-type}_{network-role}_ips’ **MUST NOT** be enumerated in the VNF’s -Heat Orchestration Template’s Environment File. - -ONAP's SDN-Controller assigns the IP Address and ONAP provides -the value at orchestration to the Heat Orchestration Template. - -*Example External Network IPv4 Address comma_delimited_list -Parameter Definition* - -.. code-block:: python - - parameters: - - {vm-type}_{network-role}_ips: - type: comma_delimited_list - description: Fixed IPv4 assignments for {vm-type} VMs on the {network-role} network - -R-71577 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ is attaching to an external network, and an IPv6 address -is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and -the parameter type is defined as a string, the parameter name **MUST** follow -the naming convention ‘{vm-type}_{network-role}\_v6\_ip\_{index}’, where - -- ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server -- ‘{network-role}’ is the {network-role} of the external network -- the value for {index} must start at zero (0) and increment by one - - -R-87123 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter ‘{vm-type}_{network-role}\_v6\_ip\_{index}’ **MUST NOT** be enumerated -in the VNF’s Heat Orchestration Template’s Environment File. - -ONAP's SDN-Controller assigns the IP Address and ONAP provides -the value at orchestration to the Heat Orchestration Template. - -*Example External Network IPv6 Address string Parameter Definition* - -.. code-block:: python - - parameters: - - {vm-type}_{network-role}_v6_ip_{index}: - type: string - description: Fixed IPv6 assignment for {vm-type} VM {index} on the {network-role} network - -R-23503 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ is attaching to an external network, and an IPv6 -address is assigned using the property ‘fixed_ips’ map property ‘ip_address’ -and the parameter type is defined as a comma_delimited_list, the parameter -name **MUST** follow the naming convention ‘{vm-type}_{network-role}_v6_ips’, where - -- ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server -- ‘{network-role}’ is the {network-role} of the external network - -R-93030 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter ‘{vm-type}_{network-role}_v6_ips’ **MUST NOT** be enumerated in the -VNF’s Heat Orchestration Template’s Environment File. - -ONAP's SDN-Controller assigns the IP Address and ECOMP provides -the value at orchestration to the Heat Orchestration Template. - -*Example External Network IPv6 Address comma_delimited_list Parameter -Definition* - -.. code-block:: python - - parameters: - - {vm-type}_{network-role}_v6_ips: - type: comma_delimited_list - description: Fixed IPv6 assignments for {vm-type} VMs on the {network-role} network - -R-78380 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ is attaching to an internal network, and an IPv4 address -is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and -the parameter type is defined as a string, the parameter name **MUST** follow -the naming convention ‘{vm-type}\_int\_{network-role}\_ip\_{index}’, where - -- ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server -- ‘{network-role}’ is the {network-role} of the internal network -- the value for {index} must start at zero (0) and increment by one - -R-28795 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter ‘{vm-type}\_int\_{network-role}\_ip\_{index}’ **MUST** be enumerated -in the VNF’s Heat Orchestration Template’s Environment File. - -The IP address is local to the VNF's internal network and is (re)used -in every VNF spin up, thus the constant value is declared in the VNF's -Heat Orchestration Template's Environment File. - -*Example Internal Network IPv4 Address string Parameter Definition* - -.. code-block:: python - - parameters: - - {vm-type}_int_{network-role}_ip_{index}: - type: string - description: Fixed IPv4 assignment for {vm-type} VM {index} on the int_{network-role} network - -R-85235 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ is attaching to an internal network, and an IPv4 -address is assigned using the property ‘fixed_ips’ map property ‘ip_address’ -and the parameter type is defined as a comma_delimited_list, the parameter -name **MUST** follow the naming convention ‘{vm-type}\_int\_{network-role}_ips’, where - -- ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server -- ‘{network-role}’ is the {network-role} of the internal network - -R-90206 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter ‘{vm-type}\_int\_{network-role}_int_ips’ **MUST** be enumerated in -the VNF’s Heat Orchestration Template’s Environment File. - -The IP address is local to the VNF's internal network and is (re)used -in every VNF spin up, thus the constant value is declared in the VNF's -Heat Orchestration Template's Environment File. - -.. code-block:: python - - parameters: - - {vm-type}_int_{network-role}_ips: - type: comma_delimited_list - description: Fixed IPv4 assignments for {vm-type} VMs on the int_{network-role} network - -R-27818 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ is attaching to an internal network, and an IPv6 address -is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and -the parameter type is defined as a string, the parameter name **MUST** follow -the naming convention ‘{vm-type}\_int\_{network-role}\_v6\_ip\_{index}’, where - -- ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server -- ‘{network-role}’ is the {network-role} of the internal network -- the value for {index} must start at zero (0) and increment by one - -R-97201 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter ‘{vm-type}\_int\_{network-role}\_v6\_ip\_{index}’ **MUST** be enumerated -in the VNF’s Heat Orchestration Template’s Environment File. - -The IP address is local to the VNF's internal network and is (re)used -in every VNF spin up, thus the constant value is declared in the VNF's -Heat Orchestration Template's Environment File. - -*Example Internal Network IPv6 Address string Parameter Definition* - -.. code-block:: python - - parameters: - - {vm-type}_int_{network-role}_v6_ip_{index}: - type: string - description: Fixed IPv6 assignment for {vm-type} VM {index} on the int_{network-role} network - -R-29765 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ is attaching to an internal network, and an IPv6 -address is assigned using the property ‘fixed_ips’ map property ‘ip_address’ -and the parameter type is defined as a comma_delimited_list, the parameter -name **MUST** follow the naming convention ‘{vm-type}\_int\_{network-role}_v6_ips’, where - -- ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server -- ‘{network-role}’ is the {network-role} of the internal network - -*Example Internal Network IPv6 Address comma_delimited_list Parameter -Definition* - -.. code-block:: python - - parameters: - - {vm-type}_int_{network-role}_v6_ips: - type: comma_delimited_list - description: Fixed IPv6 assignments for {vm-type} VMs on the int_{network-role} network - -R-98569 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter ‘{vm-type}\_int\_{network-role}_v6_ips’ **MUST** be enumerated in -the VNF’s Heat Orchestration Template’s Environment File. - -The IP address is local to the VNF's internal network and is (re)used -in every VNF spin up, thus the constant value is declared in the VNF's -Heat Orchestration Template's Environment File. - -R-62590 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter associated with an external network, i.e., - -- {vm-type}_{network-role}\_ip\_{index} -- {vm-type}_{network-role}\_ip\_v6\_{index} -- {vm-type}_{network-role}_ips -- {vm-type}_{network-role}_v6_ips - -**MUST NOT** be enumerated in the Heat Orchestration Template’s Environment File. -ONAP provides the IP address assignments at orchestration time. - -R-93496 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter associated with an internal network, i.e., - -- {vm-type}\_int\_{network-role}\_ip\_{index} -- {vm-type}\_int\_{network-role}\_ip\_v6\_{index} -- {vm-type}\_int\_{network-role}_ips -- {vm-type}\_int\_{network-role}_v6_ips - -**MUST** be enumerated in the Heat Orchestration Template’s Environment -File and IP addresses **MUST** be assigned. - -Summary Table -_____________ - -.. csv-table:: **Table # OS::Neutron::Port Property fixed_ips map property ip_address Parameter Naming Convention** - :header: Resource,Property,Map Property,Network Type,IP Address,Parameter Type,Parameter Name, Environment File - :align: center - :widths: auto - - OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, string, {vm-type}\_{network-role}\_ip\_{index}, NO - OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, comma\_delimited\_list, {vm-type}\_{network-role}\_ips, NO - OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, string, {vm-type}\_{network-role}\_v6\_ip\_{index}, NO - OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, comma\_delimited\_list, {vm-type}\_{network-role}\_v6\_ips, NO - OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, string, {vm-type}\_int\_{network-role}\_ip\_{index}, YES - OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, comma\_delimited\_list, {vm-type}\_int\_{network-role}\_ips, YES - OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, string, {vm-type}\_int\_{network-role}\_v6\_ip\_{index}, YES - OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, comma\_delimited\_list, {vm-type}\_int\_{network-role}\_v6\_ips, YES - - -Examples -________ - -*Example: comma_delimited_list parameters for IPv4 and IPv6 Address -Assignments to an external network* - -In this example, the '{network-role}' has been defined as 'oam' to represent -an oam network and the '{vm-type}' has been defined as 'db' for database. - -.. code-block:: python - - parameters: - oam_net_id: - type: string - description: Neutron UUID for a oam network - db_oam_ips: - type: comma_delimited_list - description: Fixed IPv4 assignments for db VMs on the oam network - db_oam_v6_ips: - type: comma_delimited_list - description: Fixed IPv6 assignments for db VMs on the oam network - resources: - db_0_oam_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [ db_oam_ips, 0 ]}}, { - “ip_address”: {get_param: [ db_oam_v6_ips, 0 ]}}] - db_1_oam_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: - - “ip_address”: {get_param: [ db_oam_ips, 1 ]} - - “ip_address”: {get_param: [ db_oam_v6_ips, 1 ]} - -*Example: string parameters for IPv4 and IPv6 Address Assignments to an -external network* - -In this example, the '{network-role}' has been defined as 'oam' to -represent an oam network and the '{vm-type}' has been defined as 'db' for -database. - -.. code-block:: python - - parameters: - oam_net_id: - type: string - description: Neutron UUID for an OAM network - db_oam_ip_0: - type: string - description: Fixed IPv4 assignment for db VM 0 on the OAM network - db_oam_ip_1: - type: string - description: Fixed IPv4 assignment for db VM 1 on the OAM network - db_oam_v6_ip_0: - type: string - description: Fixed IPv6 assignment for db VM 0 on the OAM network - db_oam_v6_ip_1: - type: string - description: Fixed IPv6 assignment for db VM 1 on the OAM network - resources: - db_0_oam_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: db_oam_ip_0}}, { “ip_address”: {get_param: db_oam_v6_ip_0 ]}}] - db_1_oam_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: - - “ip_address”: {get_param: db_oam_ip_1}}] - - “ip_address”: {get_param: db_oam_v6_ip_1}}] - - -*Example: comma_delimited_list parameters for IPv4 and IPv6 Address -Assignments to an internal network* - -In this example, the '{network-role}' has been defined as 'ctrl' to -represent an ctrl network internal to the vnf. -The '{vm-type}' has been defined as 'db' for -database. - -.. code-block:: python - - parameters: - int_ctrl_net_id: - type: string - description: Neutron UUID for the ctrl internal network - db_int_ctrl_ips: - type: comma_delimited_list - description: Fixed IPv4 assignments for db VMs on the ctrl internal - network - db_int_ctrl_v6_ips: - type: comma_delimited_list - description: Fixed IPv6 assignments for db VMs on the ctrl internal - network - resources: - db_0_int_ctrl_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: int_ctrl_net_id } - fixed_ips: [ { “ip_address”: {get_param: [ db_int_ctrl_ips, 0 ]}}, { - “ip_address”: {get_param: [ db_int_ctrl_v6_ips, 0 ]}}] - db_1_int_ctrl_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: int_ctrl_net_id } - fixed_ips: - - “ip_address”: {get_param: [ db_int_ctrl_ips, 1 ]} - - “ip_address”: {get_param: [ db_int_ctrl_v6_ips, 1 ]} - - -*Example: string parameters for IPv4 and IPv6 Address Assignments to an -internal network* - -In this example, the int\_{network-role} has been defined as -int_ctrl to represent a control network internal to the vnf. -The {vm-type} has been defined as db for database. - -.. code-block:: python - - parameters: - int_ctrl_net_id: - type: string - description: Neutron UUID for an OAM internal network - db_int_ctrl_ip_0: - type: string - description: Fixed IPv4 assignment for db VM on the oam_int network - db_int_ctrl_ip_1: - type: string - description: Fixed IPv4 assignment for db VM 1 on the oam_int network - db_int_ctrl_v6_ip_0: - type: string - description: Fixed IPv6 assignment for db VM 0 on the oam_int network - db_int_ctrl_v6_ip_1: - type: string - description: Fixed IPv6 assignment for db VM 1 on the oam_int network - resources: - db_0_int_ctrl_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: int_oam_int_net_id } - fixed_ips: [ { “ip_address”: {get_param: db_oam_int_ip_0}}, { - “ip_address”: {get_param: db_oam_int_v6_ip_0 ]}}] - db_1_int_ctrl_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: int_oam_int_net_id } - fixed_ips: - - “ip_address”: {get_param: db_oam_int_ip_1}}] - - “ip_address”: {get_param: db_oam_int_v6_ip_1}}] - - -Property: fixed\_ips, Map Property: subnet\_id -++++++++++++++++++++++++++++++++++++++++++++++ - -The resource 'OS::Neutron::Port' property 'fixed_ips' map -property 'subnet'/'subnet_id' is used when a -port is requesting an IP assignment via -OpenStack’s DHCP Service (i.e., Cloud Assigned). - -The IP address assignment will be made from the specified subnet. - -Specifying the subnet is not required; it is optional. - -If the network (external or internal) that the port is attaching -to only contains one subnet, specifying the subnet is -superfluous. The IP address will be assigned from the one existing -subnet. - -If the network (external or internal) that the port is attaching -to contains two or more subnets, specifying the subnet in the -'fixed_ips' map property 'subnet'/'subnet_id' determines which -subnet the IP address will be assigned from. - -If the network (external or internal) that the port is attaching -to contains two or more subnets, and the subnet is not is not -specified, OpenStack will randomly(?) determine which subnet -the IP address will be assigned from. - -The property fixed_ips is used to assign IPs to a port. The Map Property -subnet_id specifies the subnet the IP is assigned from. - -R-38236 The VNF’s Heat Orchestration Template’s resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property -‘subnet’/’subnet_id’ parameter **MUST** be declared type ‘string’. - -R-62802 When the VNF’s Heat Orchestration Template’s resource -‘OS::Neutron::Port’ is attaching to an external network, and an IPv4 -address is being Cloud Assigned by OpenStack’s DHCP Service and the -external network IPv4 subnet is to be specified using the property -‘fixed_ips’ map property ‘subnet’/’subnet_id’, the parameter **MUST** -follow the naming convention ‘{network-role}_subnet_id’, where -‘{network-role}’ is the network role of the network. - -R-83677 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property -subnet’/’subnet_id’ parameter ‘{network-role}_subnet_id’ -**MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s -Environment File. - -ONAP's SDN-Controller provides the network's subnet's UUID -value at orchestration to the Heat Orchestration Template. - -*Example Parameter Definition* - -.. code-block:: python - - parameters: - - {network-role}_subnet_id: - type: string - description: Neutron IPv4 subnet UUID for the {network-role} network - -R-15287 When the VNF’s Heat Orchestration Template’s resource -‘OS::Neutron::Port’ is attaching to an external network, and an IPv6 -address is being Cloud Assigned by OpenStack’s DHCP Service and the -external network IPv6 subnet is to be specified using the property -‘fixed_ips’ map property ‘subnet’/’subnet_id’, the parameter **MUST** -follow the naming convention ‘{network-role}_subnet_v6_id’, where -‘{network-role}’ is the network role of the network. - -R-80829 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property -subnet’/’subnet_id’ parameter ‘{network-role}_subnet_v6_id’ -**MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s -Environment File. - -ONAP's SDN-Controller provides the network's subnet's UUID -value at orchestration to the Heat Orchestration Template. - -*Example Parameter Definition* - -.. code-block:: python - - parameters: - - {network-role}_v6_subnet_id: - type: string - description: Neutron IPv6 subnet UUID for the {network-role} network - - -*Example: One Cloud Assigned IPv4 Address (DHCP) assigned to a network -that has two or more IPv4 subnets* - -In this example, the '{network-role}' has been defined as 'oam' to represent -an oam network and the '{vm-type}' has been defined as 'lb' for load -balancer. The Cloud Assigned IP Address uses the OpenStack DHCP service -to assign IP addresses. - -.. code-block:: python - - parameters: - oam_net_id: - type: string - description: Neutron UUID for the oam network - oam_subnet_id: - type: string - description: Neutron IPv4 subnet UUID for the oam network - resources: - lb_0_oam_port_0: - type: OS::Neutron::Port - parameters: - network: { get_param: oam_net_id } - fixed_ips: - - subnet_id: { get_param: oam_subnet_id } - -*Example: One Cloud Assigned IPv4 address and one Cloud Assigned IPv6 -address assigned to a network that has at least one IPv4 subnet and one -IPv6 subnet* - -In this example, the '{network-role}' has been defined as 'oam' to represent -an oam network and the '{vm-type}' has been defined as 'lb' for load -balancer. - -.. code-block:: python - - parameters: - oam_net_id: - type: string - description: Neutron UUID for the oam network - oam_subnet_id: - type: string - description: Neutron IPv4 subnet UUID for the oam network - oam_v6_subnet_id: - type: string - description: Neutron IPv6 subnet UUID for the oam network - resources: - lb_0_oam_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: - - subnet_id: { get_param: oam_subnet_id } - - subnet_id: { get_param: oam_v6_subnet_id } - -R-84123 When - -- the VNF’s Heat Orchestration Template’s resource ‘OS::Neutron::Port’ - in an Incremental Module is attaching to an internal network - that is created in the Base Module, AND -- an IPv4 address is being Cloud Assigned by OpenStack’s DHCP Service AND -- the internal network IPv4 subnet is to be specified using the - property ‘fixed_ips’ map property ‘subnet’/’subnet_id’, - -the parameter **MUST** follow the naming convention -‘int\_{network-role}_subnet_id’, where ‘{network-role}’ is the -network role of the internal network - -- Note that the parameter **MUST** be defined as an ‘output’ parameter in - the base module. - -R-69634 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property -subnet’/’subnet_id’ parameter ‘int\_{network-role}_subnet_id’ -**MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s -Environment File. - -The assumption is that internal networks are created in the base module. -The Neutron subnet network ID will be passed as an output parameter -(e.g., ECOMP Base Module Output Parameter) to the incremental modules. -In the incremental modules, the output parameter name will be defined as -input parameter. - -*Example Parameter Definition* - -.. code-block:: python - - parameters: - - int_{network-role}_subnet_id: - type: string - description: Neutron IPv4 subnet UUID for the int_{network-role} network - -R-76160 When - -- the VNF’s Heat Orchestration Template’s resource - ‘OS::Neutron::Port’ in an Incremental Module is attaching to an - internal network that is created in the Base Module, AND -- an IPv6 address is being Cloud Assigned by OpenStack’s DHCP Service AND -- the internal network IPv6 subnet is to be specified using the property - ‘fixed_ips’ map property ‘subnet’/’subnet_id’, - -the parameter **MUST** follow the naming convention -‘int\_{network-role}_v6_subnet_id’, where ‘{network-role}’ -is the network role of the internal network - -- Note that the parameter **MUST** be defined as an ‘output’ parameter in - the base module. - -R-22288 The VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ property ‘fixed_ips’ map property -‘subnet’/’subnet_id’ parameter ‘int\_{network-role}_v6_subnet_id’ -**MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s -Environment File. - -*Example Parameter Definition* - -.. code-block:: python - - parameters: - - int_{network-role}_v6_subnet_id: - type: string - description: Neutron subnet UUID for the int_{network-role} network - - -Property: allowed\_address\_pairs, Map Property: ip\_address -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -The property allowed\_address\_pairs in the resource OS::Neutron::Port -allows the user to specify a mac\_address and/or ip\_address that will -pass through a port regardless of subnet. This enables the use of -protocols such as VRRP, which floats an IP address between two instances -to enable fast data plane failover. The map property ip\_address -specifies the IP address. - -The allowed\_address\_pairs is an optional property. It is not required. - -An ONAP Heat Orchestration Template allows the assignment of one IPv4 -address allowed\_address\_pairs and/or one IPv6 address to a {vm-type} -and {network-role}/int\_{network-role} combination. - -An ONAP Heat Orchestration Template allows the assignment of one IPv6 -address allowed\_address\_pairs and/or one IPv6 address to a {vm-type} -and {network-role}/int\_{network-role} combination. - -Note that the management of these IP addresses (i.e. transferring -ownership between active and standby VMs) is the responsibility of the -application itself. - -Note that these parameters are **not** intended to represent Neutron -“Floating IP” resources, for which OpenStack manages a pool of public IP -addresses that are mapped to specific VM ports. In that case, the -individual VMs are not even aware of the public IPs, and all assignment -of public IPs to VMs is via OpenStack commands. ONAP does not support -Neutron-style Floating IPs. - -External Networks -_________________ - -R-61282 The VNF Heat Orchestration Template **MUST** -adhere to the following naming convention for the property -allowed\_address\_pairs and Map Property ip\_address parameter, -when the parameter is referencing an “external” network: - -- {vm-type}\_{network-role}\_floating\_ip for an IPv4 address - -- {vm-type}\_{network-role}\_floating\_v6\_ip for an IPv6 address - -The parameter must be declared as type: string - -The parameter must not be enumerated in the Heat environment file. - -*Example Parameter Definition* - -.. code-block:: yaml - - parameters: - - {vm-type}_{network-role}_floating_ip: - type: string - description: VIP for {vm-type} VMs on the {network-role} network - - {vm-type}_{network-role}_floating_v6_ip: - type: string - description: VIP for {vm-type} VMs on the {network-role} network - -*Example:* - -In this example, the {network-role} has been defined as oam to represent -an oam network and the {vm-type} has been defined as db for database. - -.. code-block:: yaml - - parameters: - oam_net_id: - type: string - description: Neutron UUID for the oam network - - db_oam_ips: - type: comma_delimited_list - description: Fixed IPs for db VMs on the oam network - - db_oam_floating_ip: - type: string - description: VIP IP for db VMs on the oam network - - resources: - db_0_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [db_oam_ips,0] }}] - allowed_address_pairs: [ { “ip_address”: {get_param: db_oam_floating_ip}}] - - db_1_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [db_oam_ips,1] }}] - allowed_address_pairs: [ { “ip_address”: {get_param: db_oam_floating_ip}}] - -Internal Networks -_________________ - -R-16805 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention -for the property allowed\_address\_pairs and Map Property ip\_address -parameter when the parameter is referencing an “internal” network. - -- {vm-type}\_int\_{network-role}\_floating\_ip for an IPv4 address - -- {vm-type}\_int\_{network-role}\_floating\_v6\_ip for an IPv6 address - -The parameter must be declared as type: string - -The parameter must be enumerated in the Heat environment file. - -*Example Parameter Definition* - -.. code-block:: yaml - - parameters: - - {vm-type}_int_{network-role}_floating_ip: - type: string - description: VIP for {vm-type} VMs on the int_{network-role} network - - {vm-type}_int_{network-role}_floating_v6_ip: - type: string - description: VIP for {vm-type} VMs on the int_{network-role} network - -Multiple allowed\_address\_pairs for a {vm-type} / {network-role} combination -__________________________________________________________________ - -The parameter {vm-type}\_{network-role}\_floating\_ip provides only one -allowed address pair IPv4 address per {vm-type} and {network-role} pair. - -The parameter {vm-type}\_{network-role}\_floating\_v6\_ip provides only -one allowed address pair IPv6 address per {vm-type} and {network-role} -pair. - -If there is a need for multiple allowed address pair IPs for a given -{vm-type} and {network-role} combination within a VNF, then the -parameter names defined for the property fixed\_ips and Map Property -ip\_address should be used with the allowed\_address\_pairs property. -The examples below illustrate this. - -*Example: A VNF has four load balancers. Each pair has a unique VIP.* - -In this example, there are two administrative VM pairs. Each pair has -one VIP. The {network-role} has been defined as oam to represent an oam -network and the {vm-type} has been defined as admin for an -administrative VM. - -Pair 1: Resources admin\_0\_port\_0 and admin\_1\_port\_0 share a unique -VIP, [admin\_oam\_ips,2] - -Pair 2: Resources admin\_2\_port\_0 and admin\_3\_port\_0 share a unique -VIP, [admin\_oam\_ips,5] - -.. code-block:: yaml - - parameters: - oam_net_id: - type: string - description: Neutron UUID for the oam network - admin_oam_ips: - type: comma_delimited_list - description: Fixed IP assignments for admin VMs on the oam network - - resources: - - admin_0_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [admin_oam_ips,0] }}] - allowed_address_pairs: [{ “ip_address”: {get_param: [admin_oam_ips,2] }}] - - admin_1_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [admin_oam_ips,1] }}] - allowed_address_pairs: [{ “ip_address”: {get_param: [admin_oam_ips,2] }}] - - admin_2_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [admin_oam_ips,3] }}] - allowed_address_pairs: [{ “ip_address”: {get_param: [admin_oam_ips,5] }}] - - admin_3_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [admin_oam_ips,4] }}] - allowed_address_pairs: [{ “ip_address”: {get_param: [admin_oam_ips,5] }}] - -*Example: A VNF has two load balancers. The pair of load balancers share -two VIPs.* - -In this example, there is one load balancer pairs. The pair has two -VIPs. The {network-role} has been defined as oam to represent an oam -network and the {vm-type} has been defined as lb for a load balancer VM. - -.. code-block:: yaml - - resources: - lb_0_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [lb_oam_ips,0] }}] - allowed_address_pairs: [{ "ip_address": {get_param: [lb_oam_ips,2]}, {get_param: [lb_oam_ips,3] }}] - - lb_1_port_0: - type: OS::Neutron::Port - properties: - network: { get_param: oam_net_id } - fixed_ips: [ { “ip_address”: {get_param: [lb_oam_ips,1] }}] - allowed_address_pairs: [{ "ip_address": {get_param: [lb_oam_ips,2]}, {get_param: [lb_oam_ips,3] }}] - -As a general rule, provide the fixed IPs for the VMs indexed first in -the CDL and then the VIPs as shown in the examples above. - -ONAP SDN-C Assignment of allowed\_address\_pair IP Addresses -__________________________________________________________________ - -The following items must be taken into consideration when designing Heat -Orchestration Templates that expect ONAP’s SDN-C to assign -allowed\_address\_pair IP addresses via automation. - -The VMs must be of the same {vm-type}. - -The VMs must be created in the same module (base or incremental). - -Resource Property “name” -~~~~~~~~~~~~~~~~~~~~~~~~ - -The parameter naming convention of the property name for the resource -OS::Nova::Server has been defined in -`Resource: OS::Nova::Server – Metadata Parameters`_. - -This section provides the requirements how the property name for non -OS::Nova::Server resources must be defined when the property is used. -Not all resources require the property name (e.g., it is optional) and -some resources do not support the property. - -R-85734 The VNF Heat Orchestration Template **MUST** use the intrinsic function str\_replace -in conjunction with the ONAP supplied metadata parameter -vnf\_name to generate a unique value, -when the property name for a non OS::Nova::Server resources is defined -in a Heat Orchestration Template. - -This prevents the enumeration of a -unique value for the property name in a per instance environment file. - -Note that - -- In most cases, only the use of the metadata value vnf\_name is - required to create a unique property name - -- the Heat Orchestration Template pseudo parameter 'OS::stack\_name’ - may also be used in the str\_replace construct to generate a unique - name when the vnf\_name does not provide uniqueness - -*Example: Property* name *for resource* OS::Neutron::SecurityGroup - -.. code-block:: yaml - - resources: - DNS_SECURITY_GROUP: - type: OS::Neutron::SecurityGroup - properties: - description: vDNS security group - name: - str_replace: - template: VNF_NAME_sec_grp_DNS - params: - VNF_NAME: {get_param: vnf_name} - rules: [. . . . . - ] - -*Example: Property name for resource* OS::Cinder::Volume - -.. code-block:: yaml - - resources: - DNS_Cinder_Volume: - type: OS::Cinder::Volume - properties: - description: Cinder Volume - name: - str_replace: - template: VNF_NAME_STACK_NAME_dns_volume - params: - VNF_NAME: {get_param: vnf_name} - STACK_NAME: { get_param: 'OS::stack_name' } - . . . . - -Contrail Issue with Values for the Property Name -++++++++++++++++++++++++++++++++++++++++++++++++ - -The Contrail GUI has a limitation displaying special characters. The -issue is documented in -https://bugs.launchpad.net/juniperopenstack/+bug/1590710. It is -recommended that special characters be avoided. However, if special -characters must be used, note that for the following resources: - -- Virtual Machine - -- Virtual Network - -- Port - -- Security Group - -- Policies - -- IPAM Creation - -the only special characters supported are: - -- “ ! $ ‘ ( ) = ~ ^ \| @ \` { } [ ] > , . \_ - -ONAP Output Parameter Names -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -ONAP defines three types of Output Parameters as detailed in -`Output Parameters`_. - -ONAP Base Module Output Parameters: -+++++++++++++++++++++++++++++++++++ - -ONAP Base Module Output Parameters do not have an explicit naming -convention. The parameter name must contain {vm-type} and {network-role} -when appropriate. - -ONAP Volume Template Output Parameters: -+++++++++++++++++++++++++++++++++++++++ - -ONAP Base Module Output Parameters do not have an explicit naming -convention. The parameter name must contain {vm-type} when appropriate. - -Predefined Output Parameters -++++++++++++++++++++++++++++ - -ONAP currently defines one predefined output parameter the OAM -Management IP Addresses. - -OAM Management IP Addresses -___________________________ - -A VNF may have a management interface for application controllers to -interact with and configure the VNF. Typically, this will be via a -specific VM that performs a VNF administration function. The IP address -of this interface must be captured and inventoried by ONAP. The IP -address might be a VIP if the VNF contains an HA pair of management VMs, -or may be a single IP address assigned to one VM. - -The Heat template may define either (or both) of the following Output -parameters to identify the management IP address. - -- oam\_management\_v4\_address - -- oam\_management\_v6\_address - -*Notes*: - -- The use of this output parameters are optional. - -- The Management IP Address should be defined only once per VNF, so it - must only appear in one Module template - -- If a fixed IP for the admin VM is passed as an input parameter, it - may be echoed in the output parameters. In this case, a IPv4 and/or - IPv6 parameter must be defined in the parameter section of the YAML - Heat template. The parameter maybe named oam\_management\_v4\_address - and/or oam\_management\_v6\_address or may be named differently. - -- If the IP for the admin VM is obtained via DHCP, it may be obtained - from the resource attributes. In this case, - oam\_management\_v4\_address and/or oam\_management\_v6\_address must - not be defined in the parameter section of the YAML Heat template. - -*Example: SDN-C Assigned IP Address echoed as* -oam\_management\_v4\_address - -.. code-block:: yaml - - parameters: - admin_oam_ip_0: - type: string - description: Fixed IPv4 assignment for admin VM 0 on the OAM network - . . . - - resources: - admin_oam_net_0_port: - type: OS::Neutron::Port - properties: - name: - str_replace: - template: VNF_NAME_admin_oam_net_0_port - params: - VNF_NAME: {get_param: vnf_name} - network: { get_param: oam_net_id } - fixed_ips: [{ "ip_address": { get_param: admin_oam_ip_0 }}] - security_groups: [{ get_param: security_group }] - - admin_server: - type: OS::Nova::Server - properties: - name: { get_param: admin_names } - image: { get_param: admin_image_name } - flavor: { get_param: admin_flavor_name } - availability_zone: { get_param: availability_zone_0 } - networks: - - port: { get_resource: admin_oam_net_0_port } - metadata: - vnf_id: { get_param: vnf_id } - vf_module_id: { get_param: vf_module_id } - vnf_name: {get_param: vnf_name } - Outputs: - oam_management_v4_address: - value: {get_param: admin_oam_ip_0 } - -*Example: Cloud Assigned IP Address output as* -oam\_management\_v4\_address - -.. code-block:: yaml - - parameters: - . . . - resources: - admin_oam_net_0_port: - type: OS::Neutron::Port - properties: - name: - str_replace: - template: VNF_NAME_admin_oam_net_0_port - params: - VNF_NAME: {get_param: vnf_name} - network: { get_param: oam_net_id } - security_groups: [{ get_param: security_group }] - - admin_server: - type: OS::Nova::Server - properties: - name: { get_param: admin_names } - image: { get_param: admin_image_name } - flavor: { get_param: admin_flavor_name } - availability_zone: { get_param: availability_zone_0 } - networks: - - port: { get_resource: admin_oam_net_0_port } - metadata: - vnf_id: { get_param: vnf_id } - vf_module_id: { get_param: vf_module_id } - vnf_name: {get_param: vnf_name } - - Outputs: - oam_management_v4_address: - value: {get_attr: [admin_server, networks, {get_param: oam_net_id}, 0] } - -Contrail Resource Parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -ONAP requires the parameter names of certain Contrail Resources to -follow specific naming conventions. This section provides these -requirements. - -Contrail Network Parameters -+++++++++++++++++++++++++++ - -Contrail based resources may require references to a Contrail network -using the network FQDN. - -External Networks -_________________ - -When the parameter associated with the Contrail Network is referencing -an “external” network, the parameter must adhere to the following naming -convention in the Heat Orchestration Template - -- {network-role}\_net\_fqdn - -The parameter must be declared as type: string - -The parameter must not be enumerated in the Heat environment file. - -*Example: Parameter declaration* - -.. code-block:: yaml - - parameters: - {network-role}_net_fqdn: - type: string - description: Contrail FQDN for the {network-role} network - -*Example: Contrail Resource OS::ContrailV2::VirtualMachineInterface -Reference to a Network FQDN.* - -In this example, the {network-role} has been defined as oam to represent -an oam network and the {vm-type} has been defined as fw for firewall. -The Contrail resource OS::ContrailV2::VirtualMachineInterface property -virtual\_network\_refs references a contrail network FQDN. - -.. code-block:: yaml - - FW_OAM_VMI: - type: OS::ContrailV2::VirtualMachineInterface - properties: - name: - str_replace: - template: VM_NAME_virtual_machine_interface_1 - params: - VM_NAME: { get_param: fw_name_0 } - virtual_machine_interface_properties: - virtual_machine_interface_properties_service_interface_type: { get_param: oam_protected_interface_type } - virtual_network_refs: - - get_param: oam_net_fqdn - security_group_refs: - - get_param: fw_sec_grp_id - -Interface Route Table Prefixes for Contrail InterfaceRoute Table -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -The parameter associated with the resource -OS::ContrailV2::InterfaceRouteTable property -interface\_route\_table\_routes, map property -interface\_route\_table\_routes\_route\_prefix is an ONAP Orchestration -Parameter. - -The parameters must be named {vm-type}\_{network-role}\_route\_prefixes -in the Heat Orchestration Template. - -The parameter must be declared as type: json - -The parameter supports IP addresses in the format: - -1. Host IP Address (e.g., 10.10.10.10) - -2. CIDR Notation format (e.g., 10.0.0.0/28) - -The parameter must not be enumerated in the Heat environment file. - -*Example Parameter Definition* - -.. code-block:: yaml - - parameters: - {vm-type}_{network-role}_route_prefixes: - type: json - description: JSON list of Contrail Interface Route Table route prefixes - -*Example:* - -.. code-block:: yaml - - parameters: - vnf_name: - type: string - description: Unique name for this VF instance - fw_int_fw_route_prefixes: - type: json - description: prefix for the ServiceInstance InterfaceRouteTable - int_fw_dns_trusted_interface_type: - type: string - description: service_interface_type for ServiceInstance - - <resource name>: - type: OS::ContrailV2::InterfaceRouteTable - depends_on: [*resource name of* *OS::ContrailV2::ServiceInstance*] - properties: - name: - str_replace: - template: VNF_NAME_interface_route_table - params: - VNF_NAME: { get_param: vnf_name } - interface_route_table_routes: - interface_route_table_routes_route: { get_param: fw_int_fw_route_prefixes } - service_instance_refs: - - get_resource: < *resource name of* *OS::ContrailV2::ServiceInstance* > - service_instance_refs_data: - - service_instance_refs_data_interface_type: { get_param: int_fw_interface_type } - -Parameter Names in Contrail Resources -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Contrail Heat resource properties will use, when appropriate, the same -naming convention as OpenStack Heat resources. For example, the resource -OS::ContrailV2::InstanceIp has two properties that the parameter naming -convention is identical to properties in OS::Neutron::Port. - -*Example: Contrail Resource OS::ContrailV2::InstanceIp, Property -instance\_ip\_address* - -The property instance\_ip\_address uses the same parameter naming -convention as the property fixed\_ips and Map Property ip\_address in -OS::Neutron::Port. The resource is assigning an ONAP SDN-C Assigned IP -Address. The {network-role} has been defined as oam\_protected to -represent an oam protected network and the {vm-type} has been defined as -fw for firewall. - -.. code-block:: yaml - - CMD_FW_OAM_PROTECTED_RII: - type: OS::ContrailV2::InstanceIp - depends_on: - - FW_OAM_PROTECTED_RVMI - properties: - virtual_machine_interface_refs: - - get_resource: FW_OAM_PROTECTED_RVMI - virtual_network_refs: - - get_param: oam_protected_net_fqdn - instance_ip_address: { get_param: [fw_oam_protected_ips, get_param: index ] } - -*Example: Contrail Resource OS::ContrailV2::InstanceIp, Property -subnet\_uuid* - -The property instance\_ip\_address uses the same parameter naming -convention as the property fixed\_ips and Map Property subnet\_id in -OS::Neutron::Port. The resource is assigning a Cloud Assigned IP -Address. The {network-role} has been defined as “oam\_protected” to -represent an oam protected network and the {vm-type} has been defined as -“fw” for firewall. - -.. code-block:: yaml - - CMD_FW_SGI_PROTECTED_RII: - type: OS::ContrailV2::InstanceIp - depends_on: - - FW_OAM_PROTECTED_RVMI - properties: - virtual_machine_interface_refs: - - get_resource: FW_OAM_PROTECTED_RVMI - virtual_network_refs: - - get_param: oam_protected_net_fqdn - subnet_uuid: { get_param: oam_protected_subnet_id } - -Cinder Volume Templates -^^^^^^^^^^^^^^^^^^^^^^^^ - -ONAP supports the independent deployment of a Cinder volume via separate -Heat Orchestration Templates, the Cinder Volume module. This allows the -volume to persist after VNF deletion so that they can be reused on -another instance (e.g., during a failover activity). - -A Base Module or Incremental Module may have a corresponding volume -module. Use of separate volume modules is optional. A Cinder volume may -be embedded within the Base Module or Incremental Module if persistence -is not required. - -R-47788 The VNF Heat Orchestration Template **MUST** have a 1:1 scope of a cinder volume module, -when it exists, with the Base Module or Incremental Module - -A single volume module must create only the volumes -required by a single Incremental module or Base module. - -The following rules apply to independent volume Heat templates: - -- Cinder volumes must be created in a separate Heat Orchestration - Template from the Base Module or Incremental Module. - -- A single Cinder volume module must include all Cinder volumes - needed by the Base/Incremental module. - -- R-79531 The VNF Heat Orchestration Template **MUST** define “outputs” in the volume - template for each Cinder volume resource universally unique - identifier (UUID) (i.e. ONAP Volume Template Output Parameters). - -- The VNF Incremental Module or Base Module must define input - parameters that match each Volume output parameter (i.e., ONAP Volume - Template Output Parameters). - - - ONAP will supply the volume template outputs automatically to the - bases/incremental template input parameters. - -- Volume modules may utilize nested Heat templates. - -*Examples: Volume Template* - -A VNF has a Cinder volume module, named incremental\_volume.yaml, that -creates an independent Cinder volume for a VM in the module -incremental.yaml. The incremental\_volume.yaml defines a parameter in -the output section, lb\_volume\_id\_0 which is the UUID of the cinder -volume. lb\_volume\_id\_0 is defined as a parameter in incremental.yaml. -ONAP captures the UUID value of lb\_volume\_id\_0 from the volume module -output statement and provides the value to the incremental module. - -Note that the example below is not a complete Heat Orchestration -Template. The {vm-type} has been defined as “lb” for load balancer - -incremental\_volume.yaml - -.. code-block:: yaml - - parameters: - vnf_name: - type: string - lb_volume_size_0: - type: number - ... - - resources: - dns_volume_0: - type: OS::Cinder::Volume - properties: - name: - str_replace: - template: VNF_NAME_volume_0 - params: - VNF_NAME: { get_param: vnf_name } - size: {get_param: dns_volume_size_0} - ... - - outputs: - lb_volume_id_0: - value: {get_resource: dns_volume_0} - ... - - -incremental.yaml - -.. code-block:: yaml - - parameters: - lb_name_0: - type: string - lb_volume_id_0: - type: string - ... - - resources: - lb_0: - type: OS::Nova::Server - properties: - name: {get_param: dns_name_0} - networks: - ... - - lb_0_volume_attach: - type: OS::Cinder::VolumeAttachment - properties: - instance_uuid: { get_resource: lb_0 } - volume_id: { get_param: lb_volume_id_0 } - -ONAP Support of Environment Files -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The use of an environment file in OpenStack is optional. In ONAP, it is -mandatory. - -R-86285 The VNF Heat Orchestration Template **MUST** have a -corresponding environment file, even if no parameters are required to be -enumerated. - -(Note that ONAP, the open source version of ONAP, does not -programmatically enforce the use of an environment file.) - -R-67205 The VNF Heat Orchestration Template **MUST** have a corresponding -environment file for a Base Module. - -R-35727 The VNF Heat Orchestration Template **MUST** have a -corresponding environment file for an Incremental module. - -R-22656 The VNF Heat Orchestration Template **MUST** have a corresponding environment file -for a Cinder Volume Module. - -A nested heat template must not have an environment file; OpenStack does -not support it. - -The environment file must contain parameter values for the ONAP -Orchestration Constants and VNF Orchestration Constants. These -parameters are identical across all instances of a VNF type, and -expected to change infrequently. The ONAP Orchestration Constants are -associated with OS::Nova::Server image and flavor properties (See -`Property: image`_ and `Property: flavor`_). Examples of VNF -Orchestration Constants are the networking parameters associated -with an internal network (e.g., private IP ranges) and Cinder -volume sizes. - -The environment file must not contain parameter values for parameters -that are instance specific (ONAP Orchestration Parameters, VNF -Orchestration Parameters). These parameters are supplied to the Heat by -ONAP at orchestration time. - -SDC Treatment of Environment Files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Parameter values enumerated in the environment file are used by SDC as -the default value. However, the SDC user may use the SDC GUI to -overwrite the default values in the environment file. - -SDC generates a new environment file for distribution to MSO based on -the uploaded environment file and the user provided GUI updates. The -user uploaded environment file is discarded when the new file is -created. Note that if the user did not change any values via GUI -updates, the SDC generated environment file will contain the same values -as the uploaded file. - -Use of Environment Files when using OpenStack “heat stack-create” CLI -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When ONAP is instantiating the Heat Orchestration Template, certain -parameter must not be enumerated in the environment file. This document -provides the details of what parameters should not be enumerated. - -If the Heat Orchestration Template is to be instantiated from the -OpenStack Command Line Interface (CLI) using the command “heat -stack-create”, all parameters must be enumerated in the environment -file. - -Heat Template Constructs -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Nested Heat Templates -~~~~~~~~~~~~~~~~~~~~~ - -ONAP supports nested Heat templates per the OpenStack specifications. -Nested templates may be suitable for larger VNFs that contain many -repeated instances of the same VM type(s). A common usage pattern is to -create a nested template for each {vm-type} along with its supporting -resources. The VNF module may then reference these component templates -either statically by repeated definition or dynamically by using the -resource OS::Heat::ResourceGroup. - -Nested Heat Template Requirements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -ONAP supports nested Heat Orchestration Templates. A Base Module, -Incremental Module, and Cinder Volume Module may use nested heat. - -A Heat Orchestration Template may reference the nested heat statically -by repeated definition. - -A Heat Orchestration Template may reference the nested heat dynamically -using the resource OS::Heat::ResourceGroup. - -A Heat Orchestration template must have no more than three levels of -nesting. ONAP supports a maximum of three levels. - -Nested heat templates must be referenced by file name. The use of -resource\_registry in the environment file is not supported and must not -be used. - -R-89868 The VNF Heat Orchestration Template **MUST** have unique file names within the scope -of the VNF for a nested heat yaml file. - -R-52530 The VNF Heat Orchestration Template **MUST NOT** use a directory hierarchy for -nested templates. All templates must be in a single, flat directory -(per VNF). - -A nested heat template may be used by any module within a given VNF. - -Note that: - -- Constrains must not be defined for any parameter enumerated in a - nested heat template. - -- R-11041 The VNF Heat Orchestration Template **MUST** have the resource calling the - nested yaml file pass in as properties all parameters defined - in nested yaml file. - -- R-61183 The VNF Heat Orchestration Template **MUST NOT** change the parameter names, when OS::Nova::Server metadata parameters are past into a nested heat - template. - -- With nested templates, outputs are required to expose any resource - properties of the child templates to the parent template. Those would - not explicitly be declared as parameters but simply referenced as - get\_attribute targets against the “parent” resource. - -Nested Heat Template Example: Static -++++++++++++++++++++++++++++++++++++++ - -incremental.yaml - -.. code-block:: yaml - - Resources: - dns_server_0: - type: nested.yaml - properties: - dns_image_name: { get_param: dns_image_name } - dns_flavor_name: { get_param: dns_flavor_name } - availability_zone: { get_param: availability_zone_0 } - security_group: { get_param: DNS_shared_sec_grp_id } - oam_net_id: { get_param: oam_protected_net_id } - dns_oam_ip: { get_param: dns_oam_ip_0 } - dns_name: { get_param: dns_name_0 } - vnf_name: { get_param: vnf_name } - vnf_id: { get_param: vnf_id } - vf_module_id: {get_param: vf_module_id} - - dns_server_1: - type: nested.yaml - properties: - dns_image_name: { get_param: dns_image_name } - dns_flavor_name: { get_param: dns_flavor_name } - availability_zone: { get_param: availability_zone_1 } - security_group: { get_param: DNS_shared_sec_grp_id } - oam_net_id: { get_param: oam_protected_net_id } - dns_oam_ip: { get_param: dns_oam_ip_1 } - dns_name: { get_param: dns_name_1 } - vnf_name: { get_param: vnf_name } - vnf_id: { get_param: vnf_id } - vf_module_id: {get_param: vf_module_id} - -nested.yaml - -.. code-block:: yaml - - dns_oam_0_port: - type: OS::Neutron::Port - properties: - name: - str_replace: - template: VNF_NAME_dns_oam_port - params: - VNF_NAME: {get_param: vnf_name} - network: { get_param: oam_net_id } - fixed_ips: [{ "ip_address": { get_param: dns_oam_ip }}] - security_groups: [{ get_param: security_group }] - - dns_servers: - type: OS::Nova::Server - properties: - name: { get_param: dns_names } - image: { get_param: dns_image_name } - flavor: { get_param: dns_flavor_name } - availability_zone: { get_param: availability_zone } - networks: - - port: { get_resource: dns_oam_0_port } - metadata: - vnf_id: { get_param: vnf_id } - vf_module_id: { get_param: vf_module_id } - vnf_name {get_param: vnf_name } - -Use of Heat ResourceGroup -+++++++++++++++++++++++++ - -The OS::Heat::ResourceGroup is a useful Heat element for creating -multiple instances of a given resource or collection of resources. -Typically, it is used with a nested Heat template, to create, for -example, a set of identical OS::Nova::Server resources plus their -related OS::Neutron::Port resources via a single resource in a master -template. - -ResourceGroup may be used in ONAP to simplify the structure of a Heat -template that creates multiple instances of the same VM type. - -However, there are important caveats to be aware of: - -ResourceGroup does not deal with structured parameters -(comma-delimited-list and json) as one might typically expect. In -particular, when using a list-based parameter, where each list element -corresponds to one instance of the ResourceGroup, it is not possible to -use the intrinsic “loop variable” %index% in the ResourceGroup -definition. - -For instance, the following is **not** valid Heat for ResourceGroup: - -.. code-block:: yaml - - type: OS::Heat::ResourceGroup - resource_def: - type: my_nested_vm_template.yaml - properties: - name: {get_param: [vm_name_list, %index%]} - -Although this appears to use the nth entry of the vm\_name\_list list -for the nth element of the ResourceGroup, it will in fact result in a -Heat exception. When parameters are provided as a list (one for each -element of a ResourceGroup), you must pass the complete parameter to the -nested template along with the current index as separate parameters. - -Below is an example of an **acceptable** Heat Syntax for a -ResourceGroup: - -.. code-block:: yaml - - type: OS::Heat::ResourceGroup - resource_def: - type: my_nested_vm_template.yaml - properties: - names: {get_param: vm_name_list} - index: %index% - -You can then reference within the nested template as: - -{ get\_param: [names, {get\_param: index} ] } - -ResourceGroup Property count -____________________________ - -ONAP requires that the OS::Heat::ResourceGroup property count be defined -(even if the value is one) and that the value must be enumerated in the -environment file. This is required for ONAP to build the TOSCA model for -the VNF. - -.. code-block:: yaml - - type: OS::Heat::ResourceGroup - properties: - count: { get_param: count } - index_var: index - resource_def: - type: my_nested_vm_template.yaml - properties: - names: {get_param: vm_name_list} - index: index - -Availability Zone and ResourceGroups -____________________________________ - -The resource OS::Heat::ResourceGroup and the property availability\_zone -has been an “issue” with a few VNFs since ONAP only supports -availability\_zone as a string parameter and not a -comma\_delimited\_list. This makes it difficult to use a ResourceGroup -to create Virtual Machines in more than one availability zone. - -There are numerous solutions to this issue. Below are two suggested -usage patterns. - -**Option 1:** create a CDL in the OS::Heat::ResourceGroup. In the -resource type: OS::Heat::ResourceGroup, create a comma\_delimited\_list -availability\_zones by using the intrinsic function list\_join. - -.. code-block:: yaml - - <resource name>: - type: OS::Heat::ResourceGroup - properties: - count: { get_param: node_count } - index_var: index - resource_def: - type: nested.yaml - properties: - index: index - avaialability_zones: { list_join: [',', [ { get_param: availability_zone_0 }, { get_param: availability_zone_1 } ] ] } - -In the nested heat - -.. code-block:: yaml - - parameters: - avaialability_zones: - type: comma_delimited_list - description: - - resources: - servers: - type: OS::Nova::Server - properties: - name: { get_param: [ dns_names, get_param: index ] } - image: { get_param: dns_image_name } - flavor: { get_param: dns_flavor_name } - availability_zone: { get_param: [ avaialability_zones, get_param: index ] } - - -**Option 2:** Create a resource group per availability zone. A separate -OS::Heat::ResourceGroup is created for each availability zone. - -External References -~~~~~~~~~~~~~~~~~~~ - -Heat templates *should not* reference any HTTP-based resource -definitions, any HTTP-based nested configurations, or any HTTP-based -environment files. - -- During orchestration, ONAP *should not* retrieve any such resources - from external/untrusted/unknown sources. - -- VNF images should not contain such references in user-data or other - configuration/operational scripts that are specified via Heat or - encoded into the VNF image itself. - -*Note:* HTTP-based references are acceptable if the HTTP-based reference -is accessing information with the VM private/internal network. - -Heat Files Support (get\_file) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Heat Templates may contain the inclusion of text files into Heat -templates via the Heat get\_file directive. This may be used, for -example, to define a common “user-data” script, or to inject files into -a VM on startup via the “personality” property. - -Support for Heat Files is subject to the following limitations: - -R-76718 The VNF Heat Orchestration Template **MUST** reference the get\_files targets in -Heat templates by file name, and the corresponding files should be -delivered to ONAP along with the Heat templates. - -R-41888 The VNE Heat **MUST NOT** use URL-based file retrieval. - -R-62177 The VNF Heat Orchestration Template **MUST** have unique file names for the included -files within the scope of the VNF. - -R-87848 The VNF Heat Orchestration Template **MUST** have all included files in a single, flat -directory per VNF. ONAP does not support a directory hierarchy. - -- Included files may be used by all Modules within a given VNF. - -- get\_file directives may be used in both non-nested and nested - templates - -Key Pairs -~~~~~~~~~ - -When Nova Servers are created via Heat templates, they may be passed a -“keypair” which provides an ssh key to the ‘root’ login on the newly -created VM. This is often done so that an initial root key/password does -not need to be hard-coded into the image. - -Key pairs are unusual in OpenStack, because they are the one resource -that is owned by an OpenStack User as opposed to being owned by an -OpenStack Tenant. As a result, they are usable only by the User that -created the keypair. This causes a problem when a Heat template attempts -to reference a keypair by name, because it assumes that the keypair was -previously created by a specific ONAP user ID. - -When a keypair is assigned to a server, the SSH public-key is -provisioned on the VMs at instantiation time. They keypair itself is not -referenced further by the VM (i.e. if the keypair is updated with a new -public key, it would only apply to subsequent VMs created with that -keypair). - -Due to this behavior, the recommended usage of keypairs is in a more -generic manner which does not require the pre-requisite creation of a -keypair. The Heat should be structured in such a way as to: - -- Pass a public key as a parameter value instead of a keypair name - -- Create a new keypair within The VNF Heat Orchestration Template (in the base - module) for use within that VNF - -By following this approach, the end result is the same as pre-creating -the keypair using the public key – i.e., that public key will be -provisioned in the new VM. However, this recommended approach also makes -sure that a known public key is supplied (instead of having OpenStack -generate a public/private pair to be saved and tracked outside of ONAP). -It also removes any access/ownership issues over the created keypair. - -The public keys may be enumerated as a VNF Orchestration Constant in the -environment file (since it is public, it is not a secret key), or passed -at run-time as instance-specific parameters. ONAP will never -automatically assign a public/private key pair. - -*Example (create keypair with an existing ssh public-key for {vm-type} -of lb (for load balancer)):* - -.. code-block:: yaml - - parameters: - vnf_name: - type: string - lb_ssh_public_key: - type: string - - resources: - my_keypair: - type: OS::Nova::Keypair - properties: - name: - str_replace: - template: VNF_NAME_key_pair - params: - VNF_NAME: { get_param: vnf_name } - public_key: {get_param: lb_ssh_public_key} - save_private_key: false - -Security Groups -~~~~~~~~~~~~~~~ - -OpenStack allows a tenant to create Security groups and define rules -within the security groups. - -Security groups, with their rules, may either be created in the Heat -Orchestration Template or they can be pre-created in OpenStack and -referenced within the Heat template via parameter(s). There can be a -different approach for security groups assigned to ports on internal -(intra-VNF) networks or external networks (inter-VNF). Furthermore, -there can be a common security group across all VMs for a specific -network or it can vary by VM (i.e., {vm-type}) and network type (i.e., -{network-role}). - -Anti-Affinity and Affinity Rules -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Anti-affinity or affinity rules are supported using normal OpenStack -OS::Nova::ServerGroup resources. Separate ServerGroups are typically -created for each VM type to prevent them from residing on the same host, -but they can be applied to multiple VM types to extend the -affinity/anti-affinity across related VM types as well. - -*Example:* - -In this example, the {network-role} has been defined as oam to represent -an oam network and the {vm-type} have been defined as lb for load -balancer and db for database. - -.. code-block:: yaml - - resources: - db_server_group: - type: OS::Nova::ServerGroup - properties: - name: - str_replace: - params: - $vnf_name: {get_param: vnf_name} - template: $vnf_name-server_group1 - policies: - - anti-affinity - - lb_server_group: - type: OS::Nova::ServerGroup - properties: - name: - str_replace: - params: - $vnf_name: {get_param: vnf_name} - template: $vnf_name-server_group2 - policies: - - affinity - - db_0: - type: OS::Nova::Server - properties: - ... - scheduler_hints: - group: {get_resource: db_server_group} - - db_1: - type: OS::Nova::Server - properties: - ... - scheduler_hints: - group: {get_resource: db_server_group} - - lb_0: - type: OS::Nova::Server - properties: - ... - scheduler_hints: - group: {get_resource: lb_server_group} - -Resource Data Synchronization -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For cases where synchronization is required in the orchestration of Heat -resources, two approaches are recommended: - -- Standard Heat depends\_on property for resources - - - Assures that one resource completes before the dependent resource - is orchestrated. - - - Definition of completeness to OpenStack may not be sufficient - (e.g., a VM is considered complete by OpenStack when it is ready - to be booted, not when the application is up and running). - -- Use of Heat Notifications - - - Create OS::Heat::WaitCondition and OS::Heat::WaitConditionHandle - resources. - - - Pre-requisite resources issue *wc\_notify* commands in user\_data. - - - Dependent resource define depends\_on in the - OS::Heat::WaitCondition resource. - -*Example: “depends\_on” case* - -In this example, the {network-role} has been defined as oam to represent -an oam network and the {vm-type} has been defined as oam to represent an -oam server. - -.. code-block:: yaml - - resources: - oam_server_01: - type: OS::Nova::Server - properties: - name: {get_param: [oam_ names, 0]} - image: {get_param: oam_image_name} - flavor: {get_param: oam_flavor_name} - availability_zone: {get_param: availability_zone_0} - networks: - - port: {get_resource: oam01_port_0} - - port: {get_resource: oam01_port_1} - user_data: - scheduler_hints: {group: {get_resource: oam_servergroup}} - user_data_format: RAW - - oam_01_port_0: - type: OS::Neutron::Port - properties: - network: {get_resource: oam_net_name} - fixed_ips: [{"ip_address": {get_param: [oam_oam_net_ips, 1]}}] - security_groups: [{get_resource: oam_security_group}] - - oam_01_port_1: - type: OS::Neutron::Port - properties: - network: {get_param: oam_net_name} - fixed_ips: [{"ip_address": {get_param: [oam_oam_net_ips, 2]}}] - security_groups: [{get_resource: oam_security_group}] - - oam_01_vol_attachment: - type: OS::Cinder::VolumeAttachment - depends_on: oam_server_01 - properties: - volume_id: {get_param: oam_vol_1} - mountpoint: /dev/vdb - instance_uuid: {get_resource: oam_server_01} - -High Availability -^^^^^^^^^^^^^^^^^ - -VNF/VM parameters may include availability zone IDs for VNFs that -require high availability. - -The Heat must comply with the following requirements to specific -availability zone IDs: - -- The Heat template should spread Nova and Cinder resources across the - availability zones as desired - -Post Orchestration & VNF Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Heat templates should contain a minimum amount of post-orchestration -configuration data. For instance, *do not* embed complex user-data -scripts in the template with large numbers of configuration parameters -to the Heat template. - -- VNFs may provide configuration APIs for use after VNF creation. Such - APIs will be invoked via application and/or SDN controllers. - -*Note:* It is important to follow this convention to the extent possible -even in the short-term as of the long-term direction. - -VNFM Driver Development Steps ------------------------------------------------------------ - -Refer to the ONAP documentation for VNF Provider instructions on integrating -vendor-specific VNFM adaptors with VF-C. The VNF driver development steps are -highlighted below. - -1. Use the VNF SDK tools to design the VNF with TOSCA models to output -the VNF TOSCA package. Using the VNF SDK tools, the VNF package can be -validated and tested. - -2. The VNF Provider supplies a vendor-specific VNFM driver in ONAP, which -is a microservice providing a translation interface from VF-C to -the vendor-specific VNFM. The interface definitions of vendor-specific -VNFM adaptors are supplied by the VNF Providers themselves. - -Creating Vendor-Specific VNFM Adaptor Microservices ------------------------------------------------------------------------------------------------- - -VNFs can be managed by vendor-specific VNFMs. To add a vendor-specific -VNFM to ONAP, a vendor-specific VNFM adaptor is added to ONAP implementing -the interface of the vendor-specific VNFM. - -A vendor-specific VNFM adaptor is a microservice with a unique name and -an appointed port. When started up, the vendor-specific VNFM adaptor -microservice is automatically registered to the Microservices Bus (MSB). -The following RESTful example describes the scenario of registering a -vendor-specific VNFM adaptor to MSB: - -.. code-block:: java - - POST /api/microservices/v1/services - { - "serviceName": "catalog", - "version": "v1", - "url": "/api/catalog/v1", - "protocol": "REST", - "visualRange": "1", - "nodes": [ - { - "ip": "10.74.56.36", - "port": "8988", - "ttl": 0 - } - ] - } diff --git a/docs/Chapter5/Creating-Vendor-Specific-VNFM-Adaptor-Microservices.rst b/docs/Chapter5/Creating-Vendor-Specific-VNFM-Adaptor-Microservices.rst new file mode 100644 index 0000000..d8b2c5e --- /dev/null +++ b/docs/Chapter5/Creating-Vendor-Specific-VNFM-Adaptor-Microservices.rst @@ -0,0 +1,34 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Creating Vendor-Specific VNFM Adaptor Microservices +--------------------------------------------------- + +VNFs can be managed by vendor-specific VNFMs. To add a vendor-specific +VNFM to ONAP, a vendor-specific VNFM adaptor is added to ONAP implementing +the interface of the vendor-specific VNFM. + +A vendor-specific VNFM adaptor is a microservice with a unique name and +an appointed port. When started up, the vendor-specific VNFM adaptor +microservice is automatically registered to the Microservices Bus (MSB). +The following RESTful example describes the scenario of registering a +vendor-specific VNFM adaptor to MSB: + +.. code-block:: java + + POST /api/microservices/v1/services + { + "serviceName": "catalog", + "version": "v1", + "url": "/api/catalog/v1", + "protocol": "REST", + "visualRange": "1", + "nodes": [ + { + "ip": "10.74.56.36", + "port": "8988", + "ttl": 0 + } + ] + } diff --git a/docs/Chapter5/Heat.rst b/docs/Chapter5/Heat.rst new file mode 100644 index 0000000..fb9cf33 --- /dev/null +++ b/docs/Chapter5/Heat.rst @@ -0,0 +1,6243 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Heat +---- + +General Guidelines +^^^^^^^^^^^^^^^^^^ +This section contains general Heat Orchestration Template guidelines. + +YAML Format +~~~~~~~~~~~ + +R-95303 A VNF's Heat Orchestration Template **MUST** be defined +using valid YAML. + +YAML (YAML Ain't +Markup Language) is a human friendly data serialization standard for all +programming languages. See http://www.yaml.org/. + +Heat Orchestration Template Format +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +As stated above, Heat Orchestration templates must be defined in YAML. + +YAML rules include: + + - Tabs are not allowed, use spaces ONLY + + - You must indent your properties and lists with 1 or more spaces + + - All Resource IDs and resource property parameters are + case-sensitive. (e.g., "ThIs", is not the same as "thiS") + +Heat Orchestration Template Structure +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Heat Orchestration template structure follows the following format, +as defined by OpenStack at +https://docs.openstack.org/developer/heat/template_guide/hot_spec.html + +.. code-block:: yaml + + heat_template_version: <date> + + description: + # a description of the template + + parameter_groups: + # a declaration of input parameter groups and order + + parameters: + # declaration of input parameters + + resources: + # declaration of template resources + + outputs: + # declaration of output parameters + + conditions: + # declaration of conditions + +heat_template_version ++++++++++++++++++++++ + +R-27078 A VNF's Heat Orchestration template **MUST** contain +the section "heat_template_version:". + +The section "heat_template_version:" must be set to a date +that is supported by the OpenStack environment. + +description ++++++++++++ + +R-39402 A VNF's Heat Orchestration Template **MUST** +contain the section "description:". + +parameter_groups +++++++++++++++++ + +A VNF Heat Orchestration template may +contain the section "parameter_groups:". + +parameters +++++++++++ + +R-35414 A VNF Heat Orchestration's template **MUST** +contain the section "parameters:". + + +.. code-block:: yaml + + parameters: + + <param name>: + + type: <string | number | json | comma_delimited_list | boolean> + + label: <human-readable name of the parameter> + + description: <description of the parameter> + + default: <default value for parameter> + + hidden: <true | false> + + constraints: + + <parameter constraints> + + immutable: <true | false> + +This section allows for +specifying input parameters that have to be provided when instantiating +the template. Each parameter is specified in a separate nested block +with the name of the parameters defined in the first line and additional +attributes (e.g., type, label) defined as nested elements. + +R-90279 A VNF's Heat Orchestration template's parameter **MUST** +be used in a resource with the exception of the parameters +for the OS::Nova::Server resource property availability_zone. + +R-91273 A VNF's Heat Orchestration template's parameter for +the OS::Nova::Server resource property availability_zone +**MAY NOT** be used in any OS::Nova::Resource. + +That is, the parameter associated with the property 'availability_zone' +maybe declared but not used in a resource. + +<param name> +____________ + +The name of the parameter. + +R-25877 A VNF's Heat Orchestration Template's parameter +name (i.e., <param name>) **MUST** contain only +alphanumeric characters and underscores ('_'). + +type +____ + +R-36772 A VNF's Heat Orchestration Template's parameter +**MUST** include the attribute "type:". + +R-11441 A VNF's Heat Orchestration Template's parameter +type **MUST** be one of the following values: "string", +"number", "json", "comma_delimited_list" or "boolean". + +label +_____ + +R-32094 A VNF's Heat Orchestration Template parameter +declaration **MAY** contain the attribute "label:" + +description +___________ + +R-44001 A VNF's Heat Orchestration Template parameter +declaration **MUST** contain the attribute "description". + +Note that the parameter attribute "description:" is an +OpenStack optional attribute that provides a description +of the parameter. ONAP implementation requires this attribute. + +default +_______ + +R-90526 A VNF Heat Orchestration Template parameter +declaration **MUST** not contain the default attribute. + +R-26124 If a VNF Heat Orchestration Template parameter +requires a default value, it **MUST** be enumerated in the environment file. + +Note that the parameter attribute "default:" is an OpenStack +optional attribute that declares the default value of the +parameter. ONAP implementation prohibits the use of this attribute. + +hidden +______ + +R-32557 A VNF's Heat Orchestration Template parameter +declaration MAY contain the attribute "hidden:". + +The parameter attribute "hidden:" is an OpenStack optional +attribute that defines whether the parameters should be +hidden when a user requests information about a stack +created from the template. This attribute can be used +to hide passwords specified as parameters. + +constraints +___________ + +The parameter attribute "constraints:" is an OpenStack optional +attribute that defines a list of constraints to apply to the parameter. + +R-88863 A VNF's Heat Orchestration Template's parameter defined as +type "number" **MUST** have a parameter constraint of "range" or +"allowed_values" defined. + +R-40518 A VNF's Heat Orchestration Template's parameter defined as +type "string" **MAY** have a parameter constraint defined. + +R-96227 A VNF's Heat Orchestration Template's parameter defined as +type "json" **MAY** have a parameter constraint defined. + +R-79817 A VNF's Heat Orchestration Template's parameter defined as +type "comma_delimited_list" **MAY** have a parameter constraint defined. + +R-06613 A VNF's Heat Orchestration Template's parameter defined as +type "boolean" **MAY** have a parameter constraint defined. + +R-00011 A VNF's Heat Orchestration Template's Nested YAML files +parameter's **MUST NOT** have a parameter constraint defined. + +The constraints block of a parameter definition defines additional +validation constraints that apply to the value of the parameter. +The parameter values provided in the VNF Heat Orchestration Template +are validated against the constraints at instantiation time. +The stack creation fails if the parameter value doesn't comply to +the constraints. + +The constraints are defined as a list with the following syntax + +.. code-block:: yaml + + constraints: + + <constraint type>: <constraint definition> + + description: <constraint description> + +.. + +**<constraint type>** Provides the type of constraint to apply. +The list of OpenStack supported constraints can be found at +https://docs.openstack.org/heat/latest/template_guide/hot_spec.html . + +**<constraint definition>** provides the actual constraint. +The syntax and constraint is dependent of the <constraint type> used. + +**description** is an optional attribute that provides a description of the +constraint. The text is presented to the user when the value the user +defines violates the constraint. If omitted, a default validation +message is presented to the user. + +Below is a brief overview of the "range" and "allowed values" constraints. +For complete details on constraints, see +https://docs.openstack.org/heat/latest/template_guide/hot_spec.html#parameter-constraints + +**range** + +range: The range constraint applies to parameters of type: number. +It defines a lower and upper limit for the numeric value of the +parameter. The syntax of the range constraint is + +.. code-block:: yaml + + range: { min: <lower limit>, max: <upper limit> } + +.. + +It is possible to define a range constraint with only a lower +limit or an upper limit. + +**allowed_values** + +allowed_values: The allowed_values constraint applies to parameters of +type \"string\" or type \"number\". It specifies a set of possible +values for a parameter. At deployment time, the user-provided value +for the respective parameter must match one of the elements of the +list. The syntax of the allowed_values constraint is + +.. code-block:: yaml + + allowed_values: [ <value>, <value>, ... ] + + Alternatively, the following YAML list notation can be used + + allowed_values: + + - <value> + + - <value> + + - ... + +. . + +immutable +_________ + +R-22589 A VNF's Heat Orchestration Template parameter declaration +**MAY** contain the attribute "immutable:". + +The parameter attribute \"immutable:\" is an OpenStack optional +attribute that defines whether the parameter is updatable. A Heat +Orchestration Template stack update fails if immutable is set to +true and the parameter value is changed. This attribute +\"immutable:\" defaults to false. + +resources ++++++++++ + +R-23664 A VNF's Heat Orchestration template **MUST** contain +the section "resources:". + +R-90152 A VNF's Heat Orchestration Template's "resources:" +section **MUST** contain the declaration of at least one resource. + +R-40551 A VNF's Heat Orchestration Template's Nested YAML files +**MAY** contain the section "resources:". + +Each resource is defined as a +separate block in the resources section with the following syntax. + +.. code-block:: yaml + + resources: + + <resource ID>: + + type: <resource type> + + properties: + + <property name>: <property value> + + metadata: + + <resource specific metadata> + + depends_on: <resource ID or list of ID> + + update_policy: <update policy> + + deletion_policy: <deletion policy> + + external_id: <external resource ID> + + condition: <condition name or expression or boolean> + + + +resource ID +___________ + +R-75141 A VNF's Heat Orchestration Template's resource name +(i.e., <resource ID>) **MUST** only contain alphanumeric +characters and underscores ('_'). + +R-16447 A VNF's <resource ID> **MUST** be unique across all +Heat Orchestration Templates and all HEAT Orchestration Template +Nested YAML files that are used to create the VNF. + +Note that a VNF can be composed of one or more Heat Orchestration Templates. + +Note that OpenStack requires the <resource ID> to be unique to the +Heat Orchestration Template and not unique across all Heat +Orchestration Templates the compose the VNF. + +type +____ + +The resource attribute \"type:\" is an OpenStack required +attribute that defines the resource type, such as +OS::Nova::Server or OS::Neutron::Port. + +The resource attribute \"type:\" may specify a VNF HEAT +Orchestration Template Nested YAML file. + +R-53952 A VNF's Heat Orchestration Template's Resource +**MUST NOT** reference a HTTP-based resource definitions. + +R-71699 A VNF's Heat Orchestration Template's Resource +**MUST NOT** reference a HTTP-based Nested YAML file. + +properties +__________ + +The resource attribute \"properties:\" is an OpenStack optional +attribute that provides a list of resource-specific properties. +The property value can be provided in place, or via a function +(e.g., `Intrinsic functions <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-intrinsic-functions>`__). + +R-10834 If a VNF Heat Orchestration Template resource attribute +"property:" uses a nested "get_param", one level of nesting is +supported and the nested "get_param" **MUST** reference an index + +metadata +________ + +The resource attribute \"metadata:\" is an OpenStack optional attribute. + +R-97199 A VNF's Heat Orchestration Template's OS::Nova::Server +resource **MUST** contain the attribute "metadata". + +Section 5.4 contains the OS::Nova::Server mandatory and optional metadata. + + +depends_on +__________ + +The resource attribute \"depends_on:\" is an OpenStack optional +attribute. +See `OpenStack documentation <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-resources-dependencies>`__ +for additional details. + +R-46968 VNF's Heat Orchestration Template's Resource **MAY** +declare the attribute "depends_on:". + +update_policy +_____________ + +R-63137 VNF's Heat Orchestration Template's Resource **MAY** +declare the attribute "update_policy:". + +deletion_policy +_______________ + +R-43740 A VNF's Heat Orchestration Template's Resource +**MAY** declare the attribute "deletion_policy:". + +If specified, the \"deletion_policy:\" attribute for resources +allows values 'Delete', 'Retain', and 'Snapshot'. +Starting with heat_template_version 2016-10-14, lowercase +equivalents are also allowed. + +The default policy is to delete the physical resource when +deleting a resource from the stack. + +external_id +___________ + +R-78569 A VNF's Heat Orchestration Template's Resouce **MAY** +declare the attribute "external_id:". + +This attribute allows for specifying the resource_id for an +existing external (to the stack) resource. External resources +cannot depend on other resources, but we allow other resources to +depend on external resource. This attribute is optional. +Note: when this is specified, properties will not be used for +building the resource and the resource is not managed by Heat. +This is not possible to update that attribute. Also, +resource won't be deleted by heat when stack is deleted. + + +condition +_________ + +The resource attribute \"condition:\" is an OpenStack optional attribute. + +Support for the resource condition attribute was added +in the Newton release of OpenStack. + +outputs ++++++++ + +R-36982 A VNF's Heat Orchestration template **MAY** +contain the "outputs:" section. + +This section allows for specifying output parameters +available to users once the template has been instantiated. If the +section is specified, it will need to adhere to specific requirements. +See `ONAP Parameter Classifications Overview`_ and +`ONAP Output Parameter Names`_ for additional details. + +Environment File Format +~~~~~~~~~~~~~~~~~~~~~~~ + +The environment file is a yaml text file. +(https://docs.openstack.org/developer/heat/template_guide/environment.html) + +R-86285 The VNF Heat Orchestration Template **MUST** have a corresponding +environment file, even if no parameters are required to be enumerated. + +The use of an environment file in OpenStack is optional. +In ONAP, it is mandatory. + +R-03324 The VNF Heat Orchestration Template **MUST** contain the +"parameters" section in the +environment file + +R-68198 A VNF's Heat Orchestration template's Environment File's +"parameters:" section **MAY** enumerate parameters. + +ONAP implementation requires the parameters section in the +environmental file to be declared. The parameters section +contains a list of key/value pairs. + +R-59930 A VNF's Heat Orchestration template's Environment +File's **MAY** contain the "parameter_defaults:" section. + +The "parameter_defaults:" section contains default parameters +that are passed to all template resources. + +R-46096 A VNF's Heat Orchestration template's Environment File's +**MAY** contain the "encrypted_parameters:" section. + +The "encrypted_parameters:" section contains a list of encrypted parameters. + +R-24893 A VNF's Heat Orchestration template's Environment File's +**MAY** contain the "event_sinks:" section. + +The "event_sinks:" section contains the list of endpoints that would +receive stack events. + +R-42685 A VNF's Heat Orchestration template's Environment File's +**MAY** contain the "parameter_merge_strategies:" section. + +The "parameter_merge_strategies:" section provides the merge strategies +for merging parameters and parameter defaults from the environment file. + +R-67231 A VNF's Heat Orchestration template's Environment File's **MUST NOT** +contain the "resource_registry:" section. + +ONAP implementation does not support the Environment File +resource_registry section. The resource_registry section +allows for the definition of custom resources. + + +SDC Treatment of Environment Files +++++++++++++++++++++++++++++++++++ + +Parameter values enumerated in the environment file are used by SDC as +the default value. However, the SDC user may use the SDC GUI to +overwrite the default values in the environment file. + +SDC generates a new environment file for distribution to MSO based on +the uploaded environment file and the user provided GUI updates. The +user uploaded environment file is discarded when the new file is +created. + +ONAP has requirements for what parameters must be enumerated in the +environment file and what parameter must not be enumerated in the +environment file. See `ONAP Parameter Classifications Overview`_ and +`ONAP Resource ID and Parameter Naming Convention`_ for more details. + +ONAP Heat Orchestration Templates: Overview +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +ONAP supports a modular Heat Orchestration Template design pattern, +referred to as *VNF Modularity.* + +ONAP VNF Modularity Overview +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +R-69663 A VNF **MAY** be composed from one or more Heat Orchestration +Templates, each of which represents a subset of the overall VNF. + +The Heat Orchestration Templates can be thought of a components or +modules of the VNF and are referred to as "\ *VNF Modules*\ ". +During orchestration, these modules are +deployed incrementally to create the complete VNF. + +R-33132 A VNF's Heat Orchestration Template **MAY** be + + * a Base Module Heat Orchestration Template + (also referred to as a Base Module) + * an Incremental Module Heat Orchestration Template + (referred to as an Incremental Module) + * a Cinder Volume Module Heat Orchestration Template + (referred to as Cinder Volume Module). + +R-37028 The VNF **MUST** be composed of one "base" module. + +R-13196 A VNF **MAY** be composed of zero to many Incremental Modules + +R-20974 The VNF **MUST** deploy the base module first, prior to +the incremental modules. + +R-28980 A VNF's incremental module **MAY** be used for initial VNF +deployment only. + +R-86926 A VNF's incremental module **MAY** be used for scale out only. + +A VNF's Incremental Module that is used for scale out is deployed +sometime after initial VNF deployment to add capacity. + +R-91497 A VNF's incremental module **MAY** be used for both deployment +and scale out. + +R-68122 A VNF's incremental module **MAY** be deployed more than once, +either during initial VNF deployment and/or scale out. + +R-46119 A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume +**MAY** be defined in a Base Module. + +R-90748 A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume +**MAY** be defined in an Incremental Module. + +R-03251 A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume +**MAY** be defined in a Cinder Volume Module. + +ONAP also supports the concept of an optional, independently deployed Cinder +volume via a separate Heat Orchestration Templates, referred to as a Cinder +Volume Module. This allows the volume to persist after a Virtual Machine +(VM) (i.e., OS::Nova::Server) is deleted, allowing the volume to be reused +on another instance (e.g., during a failover activity). + +R-11200 The VNF **MUST** keep the scope of a Cinder volume module, when it +exists, to be 1:1 with the VNF Base Module or Incremental Module. + +It is strongly recommended that Cinder Volumes be created in a Cinder Volume +Module. + +R-38474 The VNF **MUST** have a corresponding environment file for a +Base Module. + +R-81725 The VNF **MUST** have a corresponding environment file for an +Incremental Module. + +R-53433 The VNF **MUST** have a corresponding environment file for a +Cinder Volume Module. + +These concepts will be described in more detail throughout the document. +This overview is provided to set the stage and help clarify the concepts +that will be introduced. + +Nested Heat Orchestration Templates Overview +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ONAP supports nested Heat Orchestration Templates per OpenStack +specifications. + +R-36582 A VNF's Base Module **MAY** utilize nested heat. + +R-56721 A VNF's Incremental Module **MAY** utilize nested heat. + +R-30395 A VNF's Cinder Volume Module **MAY** utilize nested heat. + +Nested templates may be suitable for larger VNFs that contain many +repeated instances of the same VM type(s). A common usage pattern is to +create a nested template for each VM type along with its supporting +resources. The Heat Orchestration Template may then reference these +nested templates either statically (by repeated definition) or +dynamically (via OS::Heat::ResourceGroup). + +See `Nested Heat Templates`_ for additional details. + +ONAP Heat Orchestration Template Filenames +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In order to enable ONAP to understand the relationship between Heat +files, the following Heat file naming convention must be utilized. + +In the examples below, <text> represents any alphanumeric string that +must not contain any special characters and must not contain the word +"base". + +R-87485 A VNF's Heat Orchestration Template's file extension **MUST** +be in the lower case format '.yaml' or '.yml'. + +R-56438 A VNF's Heat Orchestration Template's Nested YAML file extension +**MUST** be in the lower case format '.yaml' or '.yml'. + +R-74304 A VNF's Heat Orchestration Template's Environment file extension +**MUST** be in the lower case format '.env'. + +R-99646 A VNF's YAML files (i.e, Heat Orchestration Template files and +Nested files) **MUST** have a unique name in the scope of the VNF. + + +Base Modules +++++++++++++ + +R-81339 A VNF Heat Orchestration Template's Base Module file name **MUST** +include 'base' in the filename and **MUST** match one of the following four +formats: + + * 'base_<text>.y[a]ml' + * '<text>_base.y[a]ml' + * 'base.y[a]ml' + * '<text>_base_<text>'.y[a]ml + +where 'base' is case insensitive and where '<text>' +**MUST** contain only alphanumeric characters +and underscores '_' and **MUST NOT** contain the case +insensitive word 'base'. + +R-91342 A VNF Heat Orchestration Template's Base Module's Environment File +**MUST** be named identical to the VNF Heat Orchestration Template's Base +Module with '.y[a]ml' replaced with '.env'. + +Incremental Modules ++++++++++++++++++++ + +R-87247 A VNF Heat Orchestration Template's Incremental Module file name +**MUST** contain only alphanumeric characters and underscores '_' and +**MUST NOT** contain the case insensitive word 'base'. + +R-94509 A VNF Heat Orchestration Template's Incremental Module's Environment +File **MUST** be named identical to the VNF Heat Orchestration Template's +Incremental Module with '.y[a]ml' replaced with '.env'. + +To clearly identify the incremental module, it is recommended to use the +following naming options for modules: + + - module_<text>.y[a]ml + + - <text>_module.y[a]ml + + - module.y[a]ml + + - <text>_module_<text>.y[a]ml + +Cinder Volume Modules ++++++++++++++++++++++ + +R-82732 A VNF Heat Orchestration Template's Cinder Volume Module **MUST** be +named identical to the base or incremental module it is supporting with +'_volume appended' + +R-31141 A VNF Heat Orchestration Template's Cinder Volume Module's Environment +File **MUST** be named identical to the VNF Heat Orchestration Template's +Cinder Volume Module with .y[a]ml replaced with '.env'. + +Nested Heat file +++++++++++++++++ + +R-76057 A VNF Heat Orchestration Template's Nested YAML file name **MUST** +contain only alphanumeric characters and underscores '_' and **MUST NOT** +contain the case insensitive word 'base'. + +R-70276 A VNF HEAT's Orchestration Nested Template's YAML file +name **MUST NOT** be in the format '{vm-type}.y[a]ml' where +'{vm-type}' is defined in the Heat Orchestration Template. + +Examples include + + - <text>.y[a]ml + + - nest_<text>.y[a]ml + + - <text>_nest.y[a]ml + + - nest.y[a]ml + + - <text>_nest_<text>.y[a]ml + +VNF Heat Orchestration Template's Nested YAML file does not have a +corresponding environment files, per OpenStack specifications. + +Output Parameters +~~~~~~~~~~~~~~~~~ + +The output parameters are parameters defined in the output section of a +Heat Orchestration Template. The ONAP output parameters are subdivided +into three categories: + +1. ONAP Base Module Output Parameters + +2. ONAP Volume Module Output Parameters + +3. ONAP Predefined Output Parameters. + +ONAP Base Module Output Parameters +++++++++++++++++++++++++++++++++++++ + +ONAP Base Module Output Parameters are declared in the 'outputs:'' section of +the VNF's Heat Orchestration Template's Base Module. A Base Module Output +Parameter is available as an input parameter (i.e., declared in the +'parameters:'' section) to all Incremental Modules in the VNF. + +A Base Module Output Parameter may be used as an input parameter in any +incremental module in the VNF. Note that the parameter is not +available to other VNFs. + +R-52753 VNF's Heat Orchestration Template's Base Module's output parameter's +name and type **MUST** match the VNF's Heat Orchestration Template's +incremental Module's name and type unless the output parameter is of type +'comma_delimited_list', then the corresponding input parameter **MUST** +be declared as type 'json'. + +If the Output parameter has a comma_delimited_list value (e.g., a collection +of UUIDs from a Resource Group), then the corresponding input parameter +must be declared as type json and not a comma_delimited_list, which is +actually a string value with embedded commas. + +R-22608 When a VNF's Heat Orchestration Template's Base Module's output +parameter is declared as an input parameter in an Incremental Module, +the parameter attribute 'constraints:' **MUST NOT** be declared. + +Additional details on ONAP Base Module Output Parameters are provided in +`ONAP Output Parameter Names`_ and ONAP VNF Modularity. + +ONAP Volume Module Output Parameters +++++++++++++++++++++++++++++++++++++ + +R-89913 A VNF's Heat Orchestration Template's Cinder Volume Module Output +Parameter(s) **MUST** include the UUID(s) of the Cinder Volumes created in +template, while other Output Parameters **MAY** be included. + +A VNF's Heat Orchestration Template's Cinder Volume Module Output Parameter(s) +are only available for the module (base or incremental) that the volume +template is associated with. + +R-07443 A VNF's Heat Orchestration Templates' Cinder Volume Module Output +Parameter's name and type **MUST** match the input parameter name and type +in the corresponding Base Module or Incremental Module unless the Output +Parameter is of the type 'comma\_delimited\_list', then the corresponding input +parameter **MUST** be declared as type 'json'. + +If the Output parameter has a comma_delimited_list value (e.g., a collection +of UUIDs from a Resource Group), then the corresponding input parameter must +be declared as type json and not a comma\_delimited\_list, which is actually a +string value with embedded commas. + +R-20547 When an ONAP Volume Module Output Parameter is declared as an input +parameter in a base or an incremental module Heat Orchestration Template, +parameter constraints **MUST NOT** be declared. + +Additional details on ONAP Base Module Output Parameters are provided in +`ONAP Output Parameter Names`_ and `Cinder Volume Templates`_. + +ONAP Predefined Output Parameters ++++++++++++++++++++++++++++++++++++ + +ONAP will look for a small set of pre-defined Heat output parameters to +capture resource attributes for inventory in ONAP. These output parameters +are optional and currently only two parameters are supported. These output +parameters are optional and are specified in `OAM Management IP Addresses`_. + +Support of heat stack update +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ONAP does not support the use of heat stack-update command for scaling +(growth/de-growth). + +R-39349 A VNF Heat Orchestration Template **MUST NOT** be designed to +utilize the OpenStack 'heat stack-update' command for scaling +(growth/de-growth). + +R-43413 A VNF **MUST** utilize a modular Heat Orchestration Template +design to support scaling (growth/de-growth). + +Scope of a Heat Orchestration Template +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +R-59482 A VNF's Heat Orchestration Template **MUST NOT** be VNF instance +specific or Cloud site specific + +ONAP provides the instance specific parameter values to the Heat +Orchestration Template at orchestration time. + +R-01896 A VNF's Heat Orchestration Template's parameter values that are +constant across all deployments **MUST** be declared in a Heat Orchestration +Template Environment File. + +Networking +^^^^^^^^^^ + +ONAP defines two types of networks: External Networks and Internal Networks. + +External Networks +~~~~~~~~~~~~~~~~~ + +ONAP defines an external network in relation to the VNF and not with regard +to the Network Cloud site. External networks may also be referred to as +"inter-VNF" networks. An external network must connect VMs in a VNF to +VMs in another VNF or an external gateway or external router. + +An External Network may be a Neutron Network or a Contrail Network. + +R-16968 A VNF's Heat Orchestration Templates **MUST NOT** include heat +resources to create external networks. + +External networks must be orchestrated separately, independent of the VNF. +This allows the network to be shared by multiple VNFs and managed +independently of VNFs. + +R-00606 A VNF **MAY** be connected to zero, one or more than one external +networks. + +R-57424 A VNF's port connected to an external network **MUST** +use the port for the purpose of reaching VMs in another VNF +and/or an external gateway and/or external router. A VNF's port +connected to an external network **MAY** use the port for +the purpose of reaching VMs in the same VNF. + +R-29865 When a VNF connects to an external network, a network role, +referred to as the '{network-role}' **MUST** be assigned to the +external network for use in the VNF's Heat Orchestration Template. + +R-69014 When a VNF connects to an external network, a network role, referred +to as the '{network-role}' **MUST** be assigned to the external network +for use in the VNF's Heat Orchestration Template. + +R-05201 When a VNF connects to two or more external networks, each external +network **MUST** be assigned a unique '{network-role}' in the context of +the VNF for use in the VNF's Heat Orchestration Template. + +R-83015 A VNF's '{network-role}' assigned to an external network **MUST** +be different than the '{network-role}' assigned to the VNF's internal +networks, if internal networks exist. + +R-99794 An external network **MUST** have one subnet. An external network +**MAY** have more than one subnet. + +Note that this document refers to **'{network-role}'** which in reality +is the **'{network-role-tag}'**. The value of the +'{network-role}' / '{network-role-tag}' +is determined by the designer of the VNF's Heat Orchestration Template and +there is no requirement for '{network-role}' / '{network-role-tag}' +uniqueness across Heat Orchestration Templates for +different VNFs. + +When an external network is created by ONAP, the network is assigned a +'{network-role}'. The '{network-role}' of the network is not required to +match the '{network-role}' of the VNF Heat Orchestration Template. + +For example, the VNF Heat Orchestration Template can assign a '{network-role}' +of 'oam' to a network which attaches to an external network with a +'{network-role}' of 'oam_protected_1' . + +When the Heat Orchestration Template is on-boarded into ONAP + * each '{network-role}' value in the Heat Orchestration Template + is mapped to the '{network-role-tag}' in the ONAP + data structure. + * each OS::Neutron::Port is associated with the external network it is + connecting to, thus creating the VNF Heat Orchestration Template + '{network-role}' / '{network-role-tag}' to external network '{network-role}' + mapping. + +ONAP enforces a naming convention for parameters associated with +external networks. `ONAP Resource ID and Parameter Naming Convention`_ +provides additional details. + +Internal Networks +~~~~~~~~~~~~~~~~~ + +ONAP defines an internal network in relation to the VNF and not with +regard to the Network Cloud site. Internal networks may also be referred +to as "intra-VNF" networks or "private" networks. An internal network +only connects VMs in a single VNF; it must not connect to other VNFs +or an external gateway or router + +R-87096 A VNF **MAY** contain zero, one or more than one internal networks. + +R-35666 If a VNF has an internal network, the VNF Heat Orchestration +Template **MUST** include the heat resources to create the internal network. + +R-86972 A VNF **SHOULD** create the internal network in the VNF's Heat +Orchestration Template Base Module. + +An Internal Network may be created using Neutron Heat Resources and/or +Contrail Heat Resources. + +R-52425 A VNF's port connected to an internal network **MUST** connect +the port to VMs in the same VNF. + +R-46461 A VNF's port connected to an internal network **MUST NOT** connect +the port to VMs in another VNF and/or an external gateway and/or +external router. + +R-68936 When a VNF creates an internal network, a network role, referred to +as the '{network-role}' **MUST** be assigned to the internal network for +use in the VNF's Heat Orchestration Template. + +R-32025 When a VNF creates two or more internal networks, each internal +network **MUST** be assigned a unique '{network-role}' in the context of +the VNF for use in the VNF's Heat Orchestration Template. + +R-69874 A VNF's '{network-role}' assigned to an internal network **MUST** +be different than the '{network-role}' assigned to the VNF's external +networks. + +R-16241 A VNF's internal network **MUST** have one subnet. +A VNF's internal network **MAY** have more than one subnet. + +R-34726 If a VNF's port is connected to an internal network and the port +is created in the same Heat Orchestration Template as the internal network, +then the port resource **MUST** use a 'get_resource' to obtain +the network UUID. + +R-22688 If a VNF's port is connected to an internal network and the +port is created in an Incremental Module and the internal network is created +in the Base Module then the UUID of the internal network **MUST** be exposed +as a parameter in the 'outputs:' section of the Base Module and the port +resource **MUST** use a 'get_param' to obtain the network UUID. + +ONAP does not programmatically enforce a naming convention for +parameters for internal network. However, a naming convention is +provided that must be followed. +`ONAP Resource ID and Parameter Naming Convention`_ +provides additional details. + +ONAP Resource ID and Parameter Naming Convention +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section provides the ONAP naming requirements for + +1. Resource IDs + +2. Resource Property Parameters + +{vm-type} +~~~~~~~~~ + +R-01455 When a VNF's Heat Orchestration Template creates a +Virtual Machine (i.e., 'OS::Nova::Server'), each 'class' of VMs +**MUST** be assigned a VNF unique '{vm-type}'; where 'class' +defines VMs that **MUST** have the following identical characteristics: + + 1.) OS::Nova::Server property flavor value + + 2.) OS::Nova::Server property image value + + 3.) Cinder Volume attachments + - Each VM in the 'class' **MUST** have the identical Cinder Volume + configuration + + 4.) Network attachments and IP address requirements + - Each VM in the 'class' **MUST** have the the identical number + of ports connecting to the identical networks and requiring the + identical IP address configuration. + +R-82481 A VNF's Heat Orchestration Template's Resource property +parameter that is +associated with a unique Virtual Machine type **MUST** +include '{vm-type}' as part of the parameter name with two +exceptions: + + 1.) The Resource OS::Nova::Server property availability_zone parameter + **MUST NOT** be prefixed with a common '{vm-type} identifier, + + 2.) The Resource OS::Nova::Server eight mandatory and optional metadata + parameters (vnf_name, vnf_id, vf_module_id, vf_module_name, vm_role, + vf_module_index, environment_context, workload_context) **MUST NOT** + be prefixed with a common '{vm-type}' identifier. + + +R-66729 A VNF's Heat Orchestration Template's Resource that is +associated with a unique Virtual Machine type **MUST** include +'{vm-type}' as part of the resource ID. + +R-98407 A VNF's Heat Orchestration Template's '{vm-type}' **MUST** contain +only alphanumeric characters and/or underscores '_' and +**MUST NOT** contain any of the following strings: '\_int' or 'int\_' +or '\_int\_'. + +R-48067 A VNF's Heat Orchestration Template's {vm-type} **MUST NOT** be a +substring of {network-role}. + +It may cause the VNF Validation Program validation-scripts project +to produce erroneous error messages. + +R-32394 A VNF's Heat Orchestration Template's use of '{vm-type}' +in all Resource property parameter names **MUST** be the same case. + +R-46839 A VNF's Heat Orchestration Template's use of +'{vm-type}' in all Resource IDs **MUST** be the same case. + +R-36687 A VNF's Heat Orchestration Template's '{vm-type}' case in +Resource property parameter names **SHOULD** match the case of +'{vm-type}' in Resource IDs and vice versa. + +{network-role} +~~~~~~~~~~~~~~ + +The assignment of a {network-role} is discussed in `Networking`_. + +R-21330 A VNF's Heat Orchestration Template's Resource property +parameter that is associated with external network **MUST** +include the '{network-role}' as part of the parameter name + +R-11168 A VNF's Heat Orchestration Template's Resource ID that is +associated with an external network **MUST** include the +'{network-role}' as part of the resource ID. + +R-84322 A VNF's Heat Orchestration Template's Resource property +parameter that is associated with an internal network +**MUST** include 'int\_{network-role}' as part of the parameter +name, where 'int\_' is a hard coded string. + +R-96983 A VNF's Heat Orchestration Template's Resource ID that is +associated with an internal network **MUST** include +'int\_{network-role}' as part of the Resource ID, where +'int\_' is a hard coded string. + +R-26506 A VNF's Heat Orchestration Template's '{network-role}' +**MUST** contain only alphanumeric characters and/or +underscores '_' and **MUST NOT** contain any of the following +strings: '\_int' or 'int\_' or '\_int\_'. + +R-00977 A VNF's Heat Orchestration Template's '{network-role}' +**MUST NOT** be a substring of '{vm-type}'. + +For example, if a VNF has a '{vm-type}' of 'oam' and a +'{network-role}' of 'oam\_protected' would be a violation of the requirement. + +R-58424 A VNF's Heat Orchestration Template's use of '{network-role}' +in all Resource property parameter names **MUST** be the same case + +R-21511 A VNF's Heat Orchestration Template's use of '{network-role}' +in all Resource IDs **MUST** be the same case. + +R-86588 A VNF's Heat Orchestration Template's '{network-role}' case +in Resource property parameter names **SHOULD** match the case +of '{network-role}' in Resource IDs and vice versa. + +Resource IDs +~~~~~~~~~~~~ + +Requirement R-75141 states a VNF's Heat Orchestration Template's +resource name (i.e., <resource ID>) MUST only contain alphanumeric +characters and underscores ('_').* + +Requirement R-16447 states a VNF's <resource ID> MUST be unique +across all Heat Orchestration Templates and all HEAT Orchestration +Template Nested YAML files that are used to create the VNF. + +As stated previously, OpenStack requires the <resource ID> to be unique +to the Heat Orchestration Template and not unique across all Heat +Orchestration Templates the compose the VNF. + +Heat Orchestration Template resources are described in `resources`_ + +R-54517 When a VNF's Heat Orchestration Template's resource is associated +with a single '{vm-type}', the Resource ID **MUST** contain the '{vm-type}'. + +R-96482 When a VNF's Heat Orchestration Template's resource is associated +with a single external network, the Resource ID MUST contain the text +'{network-role}'. + +R-98138 When a VNF's Heat Orchestration Template's resource is associated +with a single internal network, the Resource ID MUST contain the text +'int\_{network-role}'. + +R-82115 When a VNF's Heat Orchestration Template's resource is associated +with a single '{vm-type}' and a single external network, the Resource +ID text **MUST** contain both the '{vm-type}' and the '{network-role}' + +- the '{vm-type}' **MUST** appear before the '{network-role}' and **MUST** + be separated by an underscore '_' + + - e.g., '{vm-type}\_{network-role}', '{vm-type}\_{index}\_{network-role}' + +- note that an '{index}' value **MAY** separate the '{vm-type}' and the + '{network-role}' and when this occurs underscores **MUST** separate the + three values. + +Note that an '{index}' value may separate the '{vm-type}' and the +'{network-role}'. An underscore must separate the three values +(e.g., {vm-type}_{index}_{network-role}). + +R-82551 When a VNF's Heat Orchestration Template's resource is associated +with a single '{vm-type}' and a single internal network, the Resource ID +**MUST** contain both the '{vm-type}' and the 'int\_{network-role}' and + +- the '{vm-type}' **MUST** appear before the 'int\_{network-role}' and + **MUST** be separated by an underscore '_' + + - (e.g., '{vm-type}\_int\_{network-role}', + '{vm-type}_{index}\_int\_{network-role}') + +- note that an '{index}' value **MAY** separate the '{vm-type}' and the + 'int\_{network-role}' and when this occurs underscores **MUST** separate + the three values. + +Note that an '{index}' value may separate the '{vm-type}' and the +'int_{network-role}'. An underscore will separate the three values +(e.g., {vm-type}_{index}_int_{network-role}). + +R-67793 When a VNF's Heat Orchestration Template's resource is associated +with more than one '{vm-type}' and/or more than one internal and/or +external network, the Resource ID **MUST NOT** contain the '{vm-type}' +and/or '{network-role}'/'int\_{network-role}'. It also should contain the +term 'shared' and/or contain text that identifies the VNF. + +R-27970 When a VNF's Heat Orchestration Template's resource is associated +with more than one '{vm-type}' and/or more than one internal and/or +external network, the Resource ID **MAY** contain the term 'shared' +and/or **MAY** contain text that identifies the VNF. + +R-11690 When a VNF's Heat Orchestration Template's Resource ID contains +an {index} value (e.g. multiple VMs of same {vm-type}), the '{index}' +**MUST** start at zero and increment by one. + +OpenStack Heat Resources Resource ID Naming Convention +++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Some OpenStack Heat Resources Resource IDs +have mandatory or suggested naming conventions. They are provided +in the following sections. + +OS::Cinder::Volume +__________________ + +R-87004 A VNF's Heat Orchestration Template's Resource +OS::Cinder::Volume Resource ID **SHOULD** use the naming convention + + * {vm-type}\_volume\_{index} + +where + + * {vm-type} is the vm-type + * {index} starts at zero and increments by one + +OS::Cinder::VolumeAttachment +____________________________ + +R-86497 A VNF's Heat Orchestration Template's Resource +OS::Cinder::VolumeAttachment Resource ID **SHOULD** use the naming convention + + * {vm-type}\_volume\_attachment_{index} + +where + + * {vm-type} is the vm-type + * {index} starts at zero and increments by one + +OS::Heat::CloudConfig +_____________________ + +R-04747 A VNF's Heat Orchestration Template's Resource +'OS::Heat::CloudConfig' Resource ID **MUST** contain the '{vm-type}'. + +R-20319 A VNF's Heat Orchestration Template's Resource 'OS::Heat::CloudConfig' +Resource ID **MAY** use the naming convention + + * {vm-type}\_RCC + +where + + * {vm-type} is the vm-type + * 'RCC' signifies that it is the Resource Cloud Config + +OS::Heat::MultipartMime +_______________________ + +R-30804 A VNF's Heat Orchestration Template's Resource +'OS::Heat::MultipartMime' Resource ID **MUST** contain the '{vm-type}'. + +R-18202 A VNF's Heat Orchestration Template's Resource +'OS::Heat::MultipartMime' Resource ID **MAY** use the naming convention + + * {vm-type}\_RMM + +where + + * {vm-type} is the vm-type + * 'RMM' signifies that it is the Resource Multipart Mime + +OS::Heat::ResourceGroup +_______________________ + +There is only a mandatory naming convention for a 'OS::Heat::ResourceGroup' +that is is creating sub-interfaces. + +R-64197 A VNF's Heat Orchestration Template's Resource +OS::Heat::ResourceGroup Resource ID that creates sub-interfaces **MUST** +use the naming convention + + * {vm-type}\_{vm-type_index}\_subint_{network-role}\_port_\ + {port-index}\_subinterfaces + +where + + * {vm-type} is the vm-type + * {vm-type_index} is the instance of the {vm-type} + * {network-role} is the network-role of the networks + that the sub-interfaces attach to + * {port-index} is the instance of the the port on the vm-type + attached to the network of {network-role} + +OS::Heat::SoftwareConfig +________________________ + +R-08975 A VNF's Heat Orchestration Template's Resource +'OS::Heat::SoftwareConfig' Resource ID **MUST** contain the '{vm-type}'. + +R-03656 A VNF's Heat Orchestration Template's Resource +'OS::Heat::SoftwareConfig' Resource ID **MAY** use the naming convention + + * {vm-type}\_RSC + +where + + * {vm-type} is the vm-type + * 'RSC' signifies that it is the Resource Software Config + +OS::Neutron::Net +________________ + +R-25720 A VNF's Heat Orchestration Template's Resource +OS::Neutron::Net Resource ID **MUST** use the naming convention + + * int\_{network-role}\_network + +VNF Heat Orchestration Templates can only create internal networks. +There is no {index} after {network-role} because {network-role} +**MUST** be unique in the scope of the VNF's +Heat Orchestration Template. + +OS::Neutron::Port +_________________ + +R-20453 A VNF's Heat Orchestration Template's Resource +OS::Neutron::Port that is attaching to an external network Resource ID +**MUST** use the naming convention + + * {vm-type}\_{vm-type_index}\_{network-role}\_port\_{port-index} + +where + + * {vm-type} is the vm-type + * {vm-type_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port is attached to + * {port-index} is the instance of the the port on the vm-type + attached to the network of {network-role} + +R-26351 A VNF's Heat Orchestration Template's Resource +OS::Neutron::Port that is attaching to an internal network Resource ID +**MUST** use the naming convention + + * {vm-type}\_{vm-type_index}\_int\_{network-role}\_port\_{port-index} + +where + + * {vm-type} is the vm-type + * {vm-type_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port is attached to + * {port-index} is the instance of the the port on the vm-type + attached to the network of {network-role} + +R-27469 A VNF's Heat Orchestration Template's Resource +OS::Neutron::Port that is creating a *Reserve Port* with an IPv4 address +Resource ID **MUST** use the naming convention + + * reserve\_port\_{vm-type}\_{network-role}\_floating\_ip\_{index} + +where + + * {vm-type} is the vm-type + * {network-role} is the network-role of the network + that the port is attached to + * {index} is the instance of the IPv4 *Reserve Port* + for the vm-type attached to the network of {network-role} + +R-68520 A VNF's Heat Orchestration Template's Resource OS::Neutron::Port +that is creating a *Reserve Port* with an IPv6 address Resource ID +**MUST** use the naming convention + + * reserve\_port\_{vm-type}\_{network-role}\_floating + \_v6\_ip\_{index} + +where + + * {vm-type} is the vm-type + * {network-role} is the network-role of the network + that the port is attached to + * {index} is the instance of the IPv6 *Reserve Port* + for the vm-type attached to the network of {network-role} + +OS::Neutron::SecurityGroup +__________________________ + +R-08775 A VNF's Heat Orchestration Template's Resource +OS::Neutron::SecurityGroup that is applicable to one {vm-type} and +more than one network (internal and/or external) Resource ID +**SHOULD** use the naming convention + + * {vm-type}\_security\_group + +where + + * {vm-type} is the vm-type + +R-03595 A VNF's Heat Orchestration Template's Resource +OS::Neutron::SecurityGroup that is applicable to more than +one {vm-type} and one external network Resource ID **SHOULD** +use the naming convention + + * {network-role}\_security\_group + +where + + * {network-role} is the network-role + +R-73213 A VNF's Heat Orchestration Template's Resource +OS::Neutron::SecurityGroup that is applicable to more than +one {vm-type} and one internal network Resource ID **SHOULD** +use the naming convention + + * int\_{network-role}\_security\_group + +where + + * {network-role} is the network-role + +R-17334 A VNF's Heat Orchestration Template's Resource +OS::Neutron::SecurityGroup that is applicable to one {vm-type} +and one external network Resource ID **SHOULD** use the naming convention + + * {vm-type}\_{network-role}\_security\_group + +where + + * {vm-type} is the vm-type + * {network-role} is the network-role + +R-14198 A VNF's Heat Orchestration Template's Resource +OS::Neutron::SecurityGroup that is applicable to one {vm-type} +and one internal network Resource ID **SHOULD** use the naming convention + + * {vm-type}\_int\_{network-role}\_security\_group + +where + + * {vm-type} is the vm-type + * {network-role} is the network-role + +R-30005 A VNF's Heat Orchestration Template's Resource +OS::Neutron::SecurityGroup that is applicable to more than one +{vm-type} and more than one network (internal and/or external) +Resource ID **MAY** use the naming convention + + * shared_security_group + +or + + * {vnf-type}\_security\_group + +where + + * {vnf-type} describes the VNF + + +OS::Neutron::Subnet +___________________ + +R-59434 A VNF's Heat Orchestration Template's Resource +OS::Neutron::Subnet Resource ID **SHOULD** use the naming convention + + * int\_{network-role}\_subnet\_{index} + +where + + * {network-role} is the network-role + * {index} is the {index} of the subnet of the network + +OS::Nova::Keypair +_________________ + +R-24997 A VNF's Heat Orchestration Template's Resource +OS::Nova::Keypair applies to one {vm-type} Resource ID **SHOULD** +use the naming convention + + * {vm-type}\_keypair\_{index} + +where + + * {network-role} is the network-role + * {index} is the {index} of the keypair + +R-65516 A VNF's Heat Orchestration Template's Resource OS::Nova::Keypair +applies to all Virtual Machines in the the VNF, the Resource ID **SHOULD** +use the naming convention + + * {vnf-type}\_keypair + +where + + * {vnf-type} describes the VNF + + +OS::Nova::Server +________________ + +R-29751 A VNF's Heat Orchestration Template's Resource OS::Nova::Server +Resource ID **MUST** use the naming convention + + * {vm-type}\_server\_{index} + +where + + * {vm-type} is the vm-type + * {index} is the index + + +OS::Nova::ServerGroup +_____________________ + +R-15189 A VNF's Heat Orchestration Template's Resource OS::Nova::ServerGroup +Resource ID **MAY** use the naming convention + + * {vm-type}\_RSG + +or + + * {vm-type}\_Server\_Grp + +or + + * {vm-type}\_ServerGroup + +or + + * {vm-type}\_servergroup + + +Contrail Heat Resources Resource ID Naming Convention ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Some Contrail Heat Resources Resource IDs +have mandatory or suggested naming conventions. They are provided +in the following sections. + + +OS::ContrailV2::InstanceIp +__________________________ + +R-53310 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::InstanceIp' that is configuring an IPv4 Address +on a port attached to an external network Resource ID **MUST** +use the naming convention + + * {vm-type}\_{vm-type\_index}\_{network-role}\_vmi + \_{vmi\_index}\_IP\_{index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port is attached to + * {vmi_index} is the instance of the the virtual machine interface + (e.g., port) on the vm-type + attached to the network of {network-role} + * 'IP' signifies that an IPv4 address is being configured + * {index} is the index of the IPv4 address + +R-46128 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::InstanceIp' that is configuring an +IPv6 Address on a port attached to an external network +Resource ID **MUST** use the naming convention + + * {vm-type}\_{vm-type\_index}\_{network-role}\_vmi + \_{vmi\_index}\_v6\_IP\_{index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port is attached to + * {vmi\_index} is the instance of the the virtual machine interface + (e.g., port) on the vm-type + attached to the network of {network-role} + * 'v6\_IP' signifies that an IPv6 address is being configured + * {index} is the index of the IPv6 address + +R-62187 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::InstanceIp' that is configuring an +IPv4 Address on a port attached to an internal network +Resource ID **MUST** use the naming convention + + * {vm-type}\_{vm-type\_index}\_int\_{network-role} + \_vmi\_{vmi\_index}\_IP\_{index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port is attached to + * {vmi_index} is the instance of the the virtual machine interface + (e.g., port) on the vm-type + attached to the network of {network-role} + * 'IP' signifies that an IPv4 address is being configured + * {index} is the index of the IPv4 address + +R-87563 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::InstanceIp' that is configuring an +IPv6 Address on a port attached to an internal network +Resource ID **MUST** use the naming convention + + * {vm-type}\_{vm-type\_index}\_int\_{network-role} + \_vmi\_{vmi\_index}\_v6\_IP\_{index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port is attached to + * {vmi\_index} is the instance of the the virtual machine + interface (e.g., port) on the vm-type + attached to the network of {network-role} + * 'v6\_IP' signifies that an IPv6 address is being configured + * {index} is the index of the IPv6 address + +R-20947 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::InstanceIp' that is configuring an IPv4 Address +on a sub-interface port attached to a sub-interface network +Resource ID **MUST** use the naming convention + + * {vm-type}\_{vm-type\_index}\_subint\_{network-role} + \_vmi\_{vmi\_index}\_IP\_{index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port is attached to + * {vmi\_index} is the instance of the the virtual machine + interface (e.g., port) on the vm-type + attached to the network of {network-role} + * 'IP' signifies that an IPv4 address is being configured + * {index} is the index of the IPv4 address + +R-88540 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::InstanceIp' that is configuring an IPv6 Address +on a sub-interface port attached to a sub-interface network +Resource ID **MUST** use the naming convention + + * {vm-type}\_{vm-type\_index}\_subint\_{network-role} + \_vmi\_{vmi\_index}\_v6\_IP\_{index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port is attached to + * {vmi\_index} is the instance of the the virtual machine interface + (e.g., port) on the vm-type + attached to the network of {network-role} + * 'v6\_IP' signifies that an IPv6 address is being configured + * {index} is the index of the IPv6 address + +OS::ContrailV2::InterfaceRouteTable +___________________________________ + +R-81214 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::InterfaceRouteTable' Resource ID **MUST** +contain the '{network-role}'. + +R-28189 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::InterfaceRouteTable' Resource ID **MAY** +use the naming convention + + * {network-role}\_RIRT + +where + + * {network-role} is the network-role + * 'RIRT' signifies that it is the Resource Interface Route Table + + +OS::ContrailV2::NetworkIpam +___________________________ + +R-30753 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::NetworkIpam' Resource ID **MUST** +contain the '{network-role}'. + +R-81979 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::NetworkIpam' Resource ID **MAY** +use the naming convention + + * {network-role}\_RNI + +where + + * {network-role} is the network-role + * 'RNI' signifies that it is the Resource Network IPAM + +OS::ContrailV2::PortTuple +_________________________ + +R-20065 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::PortTuple' Resource ID **MUST** +contain the '{vm-type}'. + +R-84457 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::PortTuple' Resource ID **MAY** +use the naming convention + + * {vm-type}\_RPT + +where + + * {vm-type} is the vm-type + * 'RPT' signifies that it is the Resource Port Tuple + + +OS::ContrailV2::ServiceHealthCheck +__________________________________ + +R-76014 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::ServiceHealthCheck' Resource ID **MUST** +contain the '{vm-type}'. + +R-65618 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::ServiceHealthCheck' Resource ID +**MAY** use the naming convention + + * {vm-type}\_RSHC\_{LEFT|RIGHT} + +where + + * {vm-type} is the vm-type + * 'RSHC' signifies that it is the Resource Service Health Check + * 'LEFT' is used if the Service Health Check is on the left interface + * 'RIGHT' is used if the Service Health Check is on the right interface + + +OS::ContrailV2::ServiceTemplate +_______________________________ + + +R-16437 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::ServiceTemplate' Resource ID **MUST** +contain the '{vm-type}'. + +R-14447 A VNF's Heat Orchestration Template's Resource +'OS::ContrailV2::ServiceTemplate' Resource ID **MAY** +use the naming convention + + * {vm-type}\_RST\_{index} + +where + + * {vm-type} is the vm-type + * 'RST' signifies that it is the Resource Service Template + * '{index}' is is the index + +OS::ContrailV2::VirtualMachineInterface +_______________________________________ + +R-96253 A VNF's Heat Orchestration Template's Resource +OS::ContrailV2::VirtualMachineInterface that is attaching +to an external network Resource ID **MUST** +use the naming convention + + * {vm-type}\_{vm-type\_index}\_{network-role} + \_vmi\_{vmi\_index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port (i.e. virtual machine interface) is attached to + * {vmi\_index} is the instance of the the vmi on the vm-type + attached to the network of {network-role} + +R-50468 A VNF's Heat Orchestration Template's Resource +OS::ContrailV2::VirtualMachineInterface that is attaching +to an internal network Resource ID **MUST** use the naming convention + + * {vm-type}\_{vm-type\_index}\_int\_{network-role}\_vmi\_{vmi\_index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port (i.e. virtual machine interface) is attached to + * {vmi\_index} is the instance of the the vmi on the vm-type + attached to the network of {network-role} + +R-54458 A VNF's Heat Orchestration Template's Resource +OS::ContrailV2::VirtualMachineInterface that is attaching to +a sub-interface network Resource ID **MUST** use the naming convention + + * {vm-type}\_{vm-type\_index}\_subint\_{network-role}\_vmi\_{vmi\_index} + +where + + * {vm-type} is the vm-type + * {vm-type\_index} is the instance of the {vm-type} + * {network-role} is the network-role of the network + that the port (i.e. virtual machine interface) is attached to + * {vmi\_index} is the instance of the the vmi on the vm-type + attached to the network of {network-role} + +OS::ContrailV2::VirtualNetwork +______________________________ + +R-99110 A VNF's Heat Orchestration Template's Resource +OS::ContrailV2::VirtualNetwork Resource ID **MUST** +use the naming convention + + * 'int\_{network-role}\_network' + +or + + * 'int\_{network-role}\_RVN' where RVN represents Resource Virtual Network + +VNF Heat Orchestration Templates can only create internal networks. +There is no {index} after {network-role} because {network-role} +**MUST** be unique in the scope of the VNF's +Heat Orchestration Template. + +Note that the first option is preferred. + +Resource: OS::Nova::Server - Parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The resource OS::Nova::Server manages the running virtual machine (VM) +instance within an OpenStack cloud. (See +https://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Nova::Server.) + +The following four properties of the OS::Nova::Server must follow +the ONAP parameter naming convention. The four properties are: + +1. image + +2. flavor + +3. name + +4. availability\_zone + +Requirement R-01455 defines how the '{vm-type}' is defined. + +Requirement R-82481 defines how the '{vm-type}' is used. + +The table below provides a summary. The sections that follow provides +the detailed requirements. + +.. csv-table:: **Table 4 OS::Nova::Server Resource Property Parameter Naming Convention** + :header: Property Name,Parameter Type,Parameter Name,Parameter Value Provided to Heat + :align: center + :widths: auto + + OS::Nova::Server, image, string, {vm-type}\_image\_name, Environment File + OS::Nova::Server, flavor, string, {vm-type}\_flavor\_name, Environment File + OS::Nova::Server, name, string, {vm-type}\_name\_{index}, ONAP + OS::Nova::Server, name, CDL, {vm-type}\_names, ONAP + OS::Nova::Server, availability\_zone, string, availability\_zone\_{index}, ONAP + +Property: image ++++++++++++++++ + +R-71152 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'image' parameter **MUST** be declared as +type: 'string'. + +R-58670 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'image' parameter name **MUST** follow the +naming convention '{vm-type}\_image\_name'. + +R-91125 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'image' parameter **MUST** be enumerated in +the Heat Orchestration Template's Environment File and a value **MUST** be +assigned. + +R-57282 Each VNF's Heat Orchestration Template's '{vm-type}' +**MUST** have a unique parameter name for the 'OS::Nova::Server' +property 'image' even if more than one {vm-type} shares the same image. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + {vm-type}_image_name: + type: string + description: {vm-type} server image + +Property: flavor +++++++++++++++++ + +R-50436 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'flavor' parameter **MUST** be declared as +type: 'string'. + +R-45188 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'flavor' parameter name **MUST** follow the +naming convention '{vm-type}\_flavor\_name'. + +R-69431 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'flavor' parameter **MUST** be enumerated in the +Heat Orchestration Template's Environment File and a value **MUST** be +assigned. + +R-40499 Each VNF's Heat Orchestration Template's '{vm-type}' **MUST** +have a unique parameter name for the 'OS::Nova::Server' property +'flavor' even if more than one {vm-type} shares the same flavor. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + {vm-type}_flavor_name: + type: string + description: {vm-type} flavor + +Property: Name +++++++++++++++ + +R-51430 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'name' parameter **MUST** be declared as +either type 'string' or type 'comma\_delimited\_list". + +R-54171 When the VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'name' parameter is defined as a 'string', +the parameter name **MUST** follow the naming convention +'{vm-type}\_name\_{index}', where {index} is a numeric value that starts +at zero and increments by one. + +R-40899 When the VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'name' parameter is defined as a 'string', +a parameter **MUST** be declared for each 'OS::Nova::Server' resource +associated with the '{vm-type}'. + +R-87817 When the VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'name' parameter is defined as a +'comma\_delimited\_list', the parameter name **MUST** follow the naming +convention '{vm-type}\_names'. + +R-85800 When the VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'name' parameter is defined as a +'comma\_delimited\_list', a parameter **MUST** be delcared once for all +'OS::Nova::Server' resources associated with the '{vm-type}'. + +R-22838 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'name' parameter **MUST NOT** be enumerated +in the Heat Orchestration Template's Environment File. + +If a VNF's Heat Orchestration Template's contains more than three +OS::Nova::Server resources of a given {vm-type}, the comma\_delimited\_list +form of the parameter name (i.e., '{vm-type}\_names') should be used to +minimize the number of unique parameters defined in the template. + + +*Example: Parameter Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_names: + type: comma_delimited_list + description: VM Names for {vm-type} VMs + + {vm-type}_name_{index}: + type: string + description: VM Name for {vm-type} VM {index} + +*Example: comma\_delimited\_list* + +In this example, the {vm-type} has been defined as "lb" for load balancer. + +.. code-block:: yaml + + parameters: + + lb_names: + type: comma_delimited_list + description: VM Names for lb VMs + + resources: + lb_server_0: + type: OS::Nova::Server + properties: + name: { get_param: [lb_names, 0] } + ... + + lb_server_1: + type: OS::Nova::Server + properties: + name: { get_param: [lb_names, 1] } + ... + +*Example: fixed-index* + +In this example, the {vm-type} has been defined as "lb" for load balancer. + +.. code-block:: yaml + + parameters: + + lb_name_0: + type: string + description: VM Name for lb VM 0 + + lb_name_1: + type: string + description: VM Name for lb VM 1 + + resources: + + lb_server_0: + type: OS::Nova::Server + properties: + name: { get_param: lb_name_0 } + ... + + lb_server_1: + type: OS::Nova::Server + properties: + name: { get_param: lb_name_1 } + ... + +Contrail Issue with Values for OS::Nova::Server Property Name +_____________________________________________________________ + +R-44271 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'name' parameter value **SHOULD NOT** +contain special characters since the Contrail GUI has a limitation +displaying special characters. + +However, if special characters must be used, the only special characters +supported are: + +--- \" ! $ ' (\ \ ) = ~ ^ | @ ` { } [ ] > , . _ + + +Property: availability\_zone +++++++++++++++++++++++++++++ + +R-98450 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'availability\_zone' parameter name +**MUST** follow the naming convention 'availability\_zone\_{index}' +where the '{index}' **MUST** start at zero and increment by one. + +R-23311 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'availability\_zone' parameter **MUST** +be declared as type: 'string'. + +The parameter must not be declared as type 'comma\_delimited\_list', +ONAP does not support it. + +R-59568 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'availability_zone' parameter **MUST NOT** +be enumerated in the Heat Orchestration Template's Environment File. + +Example Parameter Definition + +.. code-block:: yaml + + parameters: + availability_zone_{index}: + type: string + description: availability zone {index} name + +Requirement R-90279 states that a VNF Heat Orchestration's template's +parameter MUST be used in a resource with the exception of the parameters +for the OS::Nova::Server resource property availability_zone. + +R-01359 A VNF's Heat Orchstration Template that contains an +'OS::Nova:Server' Resource **MAY** define a parameter for the property +'availability_zone' that is not utilized in any 'OS::Nova::Server' +resources in the Heat Orchestration Template. + +Example ++++++++ + +The example below depicts part of a Heat Orchestration Template that +uses the four OS::Nova::Server properties discussed in this section. + +In the Heat Orchestration Template below, four Virtual +Machines (OS::Nova::Server) are created: two dns servers with +{vm-type} set to "dns" and two oam servers with {vm-type} set to "oam". +Note that the parameter associated with the property name is a +comma_delimited_list for dns and a string for oam. + +.. code-block:: yaml + + parameters: + + dns_image_name: + type: string + description: dns server image + + dns_flavor_name: + type: string + description: dns server flavor + + dns_names: + type: comma_delimited_list + description: dns server names + + oam_image_name: + type: string + description: oam server image + + oam_flavor_name: + type: string + description: oam server flavor + + oam_name_0: + type: string + description: oam server name 0 + + oam_name_1: + type: string + description: oam server name 1 + + availability_zone_0: + type: string + description: availability zone ID or Name + + availability_zone_1: + type: string + description: availability zone ID or Name + + resources: + + dns_server_0: + type: OS::Nova::Server + properties: + name: { get_param: [ dns_names, 0 ] } + image: { get_param: dns_image_name } + flavor: { get_param: dns_flavor_name } + availability_zone: { get_param: availability_zone_0 } + + . . . + + dns_server_1: + type: OS::Nova::Server + properties: + name: { get_param: [ dns_names, 1 ] } + image: { get_param: dns_image_name } + flavor: { get_param: dns_flavor_name } + availability_zone: { get_param: availability_zone_1 } + + . . . + + oam_server_0: + type: OS::Nova::Server + properties: + name: { get_param: oam_name_0 } + image: { get_param: oam_image_name } + flavor: { get_param: oam_flavor_name } + availability_zone: { get_param: availability_zone_0 } + + . . . + + oam_server_1: + type: OS::Nova::Server + properties: + name: { get_param: oam_name_1 } + image: { get_param: oam_image_name } + flavor: { get_param: oam_flavor_name } + availability_zone: { get_param: availability_zone_1 } + + . . . + +Boot Options +++++++++++++ + +R-99798 A VNF's Heat Orchestration Template's Virtual Machine +(i.e., OS::Nova::Server Resource) **MAY** boot from an image or **MAY** +boot from a Cinder Volume. + +R-83706 When a VNF's Heat Orchestration Template's Virtual Machine +(i.e., 'OS::Nova::Server' Resource) boots from an image, the +'OS::Nova::Server' resource property 'image' **MUST** be used. + +The requirements associated with +the 'image' property are detailed in `Property: image`_ + +R-69588 When a VNF's Heat Orchestration Template's Virtual Machine +(i.e., 'OS::Nova::Server' Resource) boots from Cinder Volume, the +'OS::Nova::Server' resource property 'block_device_mapping' or +'block_device_mapping_v2' **MUST** be used. + +There are currently no heat guidelines +associated with these two properties: +'block_device_mapping' and 'block_device_mapping_v2'. + +Resource: OS::Nova::Server – Metadata Parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The OS::Nova::Server Resource property metadata is an optional +OpenStack property. +The table below summarizes the mandatory and optional metadata +supported by ONAP. + +The sections that follow provides the requirements associated with each +metadata parameter. + +.. csv-table:: **Table 5 OS::Nova::Server Mandatory and Optional Metadata** + :header: Metadata Parameter Name, Parameter Type, Required, Parameter Value Provided to Heat + :align: center + :widths: auto + + vnf_id, string, **MUST**, ONAP + vf_module_id, string, **MUST**, ONAP + vnf_name, string, **MUST**, ONAP + vf_module_name, string, **SHOULD**, ONAP + vm_role, string, **MAY**, YAML or Environment File + vf_module_index, string, **MAY**, ONAP + workload_context, string, **SHOULD**, ONAP + environment_context, string, **SHOULD**, ONAP + +vnf\_id ++++++++ + +The OS::Nova::Server Resource metadata map value parameter 'vnf_id' +is an ONAP generated UUID that identifies the VNF. The value +is provided by ONAP to the VNF's Heat Orchestration +Template at orchestration time. + +R-37437 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource **MUST** contain the metadata map value parameter 'vnf_id'. + +R-07507 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf_id' **MUST** be declared +as type: 'string'. + +R-55218 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf_id' **MUST NOT** have +parameter contraints defined. + +R-20856 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf_id' **MUST NOT** be +enumerated in the Heat Orchestration Template's environment file. + +R-44491 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf_id' is passed into a +Nested YAML file, the parameter name 'vnf_id' **MUST NOT** change. + + +*Example 'vnf_id' Parameter Definition* + +.. code-block:: yaml + + parameters: + + vnf_id: + type: string + description: Unique ID for this VNF instance + +vf\_module\_id +++++++++++++++ + +The OS::Nova::Server Resource metadata map value parameter 'vf\_module\_id' +is an ONAP generated UUID that identifies the VF Module (e.g., Heat +Orchestration Template). The value +is provided by ONAP to the VNF's Heat Orchestration +Template at orchestration time. + +R-71493 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource **MUST** contain the metadata map value parameter +'vf\_module\_id'. + +R-82134 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_id' **MUST** +be declared as type: 'string'. + +R-98374 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_id' **MUST NOT** +have parameter contraints defined. + +R-72871 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_id' **MUST NOT** +be enumerated in the Heat Orchestration Template's environment file. + +R-86237 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_id' is passed +into a Nested YAML file, the parameter name 'vf\_module\_id' +**MUST NOT** change. + +*Example 'vf\_module\_id' Parameter Definition* + +.. code-block:: yaml + + parameters: + + vnf_module_id: + type: string + description: Unique ID for this VNF module instance + + +vnf\_name ++++++++++ + +The OS::Nova::Server Resource metadata map value parameter 'vnf_name' +is the ONAP generated alphanumeric name of the deployed VNF instance. +The value +is provided by ONAP to the VNF's Heat Orchestration +Template at orchestration time. +The parameter must be declared as type: string + +R-72483 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource **MUST** contain the metadata map value parameter +'vnf\_name'. + +R-62428 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf_name' **MUST** be +declared as type: 'string'. + +R-44318 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf\_name' **MUST NOT** have +parameter contraints defined. + +R-36542 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf\_name' **MUST NOT** be +enumerated in the Heat Orchestration Template's environment file. + +R-16576 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf\_name' is passed into a +Nested YAML file, the parameter name 'vnf\_name' **MUST NOT** change. + +*Example 'vnf\_name' Parameter Definition* + +.. code-block:: yaml + + parameters: + + vnf_name: + type: string + description: Unique name for this VNF instance + +vf\_module\_name +++++++++++++++++ + +The OS::Nova::Server Resource metadata map value parameter 'vf_module_name' +is the deployment name of the heat stack created (e.g., <STACK_NAME>) from the +VNF's Heat Orchestration template +in the command 'Heat stack-create' +(e.g., 'Heat stack-create [-f <FILE>] [-e <FILE>] <STACK_NAME>'). +The 'vf_module_name' (e.g., <STACK_NAME> is specified as +part of the orchestration process. + +R-68023 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource **SHOULD** contain the metadata map value parameter +'vf\_module\_name'. + +R-39067 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_name' **MUST** +be declared as type: 'string'. + +R-15480 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_name' +**MUST NOT** have parameter contraints defined. + +R-80374 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_name' +**MUST NOT** be enumerated in the Heat Orchestration Template's +environment file. + +R-49177 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_name' is passed +into a Nested YAML file, the parameter name 'vf\_module\_name' +**MUST NOT** change. + +*Example 'vf_module_name' Parameter Definition* + +.. code-block:: yaml + + parameters: + + vf_module_name: + type: string + description: Unique name for this VNF Module instance + +vm\_role +++++++++ + +The OS::Nova::Server Resource metadata map value parameter 'vm-role' +is a metadata tag that describes the role of the Virtual Machine. +The 'vm\_role' is stored in ONAP's A&AI module and is +available for use by other ONAP components and/or north bound systems. + +R-85328 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource **MAY** contain the metadata map value parameter 'vm\_role'. + +R-95430 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vm\_role' **MUST** be +declared as type: 'string'. + +R-67597 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vm\_role' **MUST NOT** have +parameter contraints defined. + +R-46823 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vnf\_name' **MUST** be +either + + - enumerated in the VNF's Heat Orchestration + Template's environment file. + + - hard coded in the VNF's Heat Orchestration + Template's OS::Nova::Resource metadata property. + +Defining the 'vm_role' as the '{vm-type}' is a recommended convention + +R-86476 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vm\_role' value **MUST only** +contain alphanumeric characters and underscores '_'. + +R-70757 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vm\_role' is passed into a +Nested YAML file, the parameter name 'vm\_role' **MUST NOT** change. + + +*Example 'vm\_role' Parameter Definition* + +.. code-block:: yaml + + parameters: + + vm_role: + type: string + description: Unique role for this VM + +*Example: 'vm-role' Definition: Hard Coded in +OS::Nova::Resource metadata property* + +.. code-block:: yaml + + resources: + + dns_server_0 + type: OS::Nova::Server + properties: + . . . . + metadata: + vm_role: dns + +*Example 'vm-role' Definition: Defined in Environment file +and retrieved via 'get_param'* + +.. code-block:: yaml + + resources: + + dns_server_0: + type: OS::Nova::Server + properties: + . . . . + metadata: + vm_role: { get_param: vm_role } + +Example vnf_id, vf_module_id, vnf_name, vf_module_name, vm_role ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The example below depicts part of a Heat Orchestration Template +that uses the five of the OS::Nova::Server metadata parameter +discussed in this section. The {vm-type} has been defined as lb +for load balancer. + +.. code-block:: yaml + + parameters: + lb_name_0 + type: string + description: VM Name for lb VM 0 + vnf_name: + type: string + description: Unique name for this VNF instance + vnf_id: + type: string + description: Unique ID for this VNF instance + vf_module_name: + type: string + description: Unique name for this VNF Module instance + vf_module_id: + type: string + description: Unique ID for this VNF Module instance + vm_role: + type: string + description: Unique role for this VM + resources: + lb_server_0: + type: OS::Nova::Server + properties: + name: { get_param: lb_name_0 } + ... + metadata: + vnf_name: { get_param: vnf_name } + vnf_id: { get_param: vnf_id } + vf_module_name: { get_param: vf_module_name } + vf_module_id: { get_param: vf_module_id } + vm_role: lb + +vf\_module\_index ++++++++++++++++++ + +R-50816 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource **MAY** contain the metadata map value parameter +'vf\_module\_index'. + +R-54340 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_index' **MUST** be +declared as type: 'number'. + +R-09811 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_index' **MUST NOT** +have parameter contraints defined. + +R-37039 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_index' **MUST NOT** +be enumerated in the Heat Orchestration Template's environment file. + +R-22441 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_index' is passed +into a Nested YAML file, the parameter name 'vf\_module\_index' +**MUST NOT** change. + +R-55306 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'vf\_module\_index' **MUST NOT** be +used in a VNF's Volume Template; it is not supported. + +The vf\_module_index parameter indicates which instance of the module is being +deployed into the VNF. +This parameter may be used in cases where multiple instances of the same +incremental module may be instantiated for scaling purposes. The index +can be used in the Heat Orchestration Template for indexing into a +pseudo-constant array parameter when unique values are required for each +module instance, e.g., for fixed private IP addresses on VM types. + +The vf\_module\_index will start at 0 for the first instance of a module +type. Subsequent instances of the same module type will receive the +lowest unused index. This means that indexes will be reused if a module +is deleted and re-added. As an example, if three copies of a module are +deployed with vf\_module\_index values of 0, 1, and 2 then subsequently +the second one is deleted (index 1), and then re-added, index 1 will be +reused. + +*Example* + +In this example, the {vm-type} has been defined as oam\_vm to represent +an OAM VM. An incremental heat module is used to deploy the OAM VM. The +OAM VM attaches to an internal control network which has a +{network-role} of ctrl. A maximum of four OAM VMs can be deployed. The +environment file contains the four IP addresses that each successive OAM +VM will be assigned. The vf\_module\_index is used as the index to +determine the IP assignment. + +Environment File + +.. code-block:: yaml + + parameters: + oam_vm_int_ctrl_ips: 10.10.10.1,10.10.10.2,10.10.10.3,10.10.10.4 + +YAML File + +.. code-block:: yaml + + parameters: + vf_module_index: + type: number + description: Unique index for this VNF Module instance + oam_vm_name_0: + type: string + description: VM Name for lb VM 0 + int_ctrl_net_id: + type: string + description: Neutron UUID for the internal control network + oam_vm_int_ctrl_ips: + type: comma_delimited_list + description: Fixed IP assignments for oam VMs on the internal control + network + resources: + oam_vm_server_0: + type: OS::Nova::Server + properties: + name: { get_param: oam_vm_name_0 } + networks: + - port: { get_resource: oam_vm_0_int_ctrl_port_0 } + . . . + metadata: + vf_module_index: { get_param: vf_module_index } + oam_vm_0_int_ctrl_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: int_ctrl_net_id } + fixed_ips: [ { "ip_address": {get_param: [ oam_vm_int_ctrl_ips, { get_param, vf_module_index]}}}] + +workload\_context +++++++++++++++++++ + +R-47061 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource **SHOULD** contain the metadata map value parameter +'workload\_context'. + +R-74978 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'workload\_context' **MUST** be +declared as type: 'string'. + +R-34055 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'workload\_context' **MUST NOT** +have parameter contraints defined. + +R-02691 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'workload\_context' **MUST NOT** +be enumerated in the Heat Orchestration Template's environment file. + +R-75202 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'workload\_context' is passed +into a Nested YAML file, the parameter name 'workload\_context' +**MUST NOT** change. + +The 'workload\_context' parameter value will be chosen by the Service Model +Distribution context client in VID and will be supplied to the +Heat Orchestration Template by ONAP at orchestration time. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + workload_context: + type: string + description: Workload Context for this VNF instance + + +*Example OS::Nova::Server with metadata* + +.. code-block:: yaml + + resources: + . . . + + {vm-type}_server_{index}: + type: OS::Nova::Server + properties: + name: + flavor: + image: + ... + metadata: + vnf_name: { get_param: vnf_name } + vnf_id: { get_param: vnf_id } + vf_module_name: { get_param: vf_module_name } + vf_module_id: { get_param: vf_module_id } + workload_context: {get_param: workload_context} + +environment\_context +++++++++++++++++++++++ + +R-88536 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource **SHOULD** contain the metadata map value parameter +'environment\_context'. + +R-20308 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'environment\_context' **MUST** +be declared as type: 'string'. + +R-56183 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'environment\_context' **MUST NOT** +have parameter contraints defined. + +R-13194 A VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'environment\_context' **MUST NOT** +be enumerated in the Heat Orchestration Template's environment file. + +R-62954 If a VNF's Heat Orchestration Template's OS::Nova::Server +Resource metadata map value parameter 'environment\_context' is +passed into a Nested YAML file, the parameter name +'environment\_context' **MUST NOT** change. + +The 'environment\_context' parameter value will be defined by the +service designer as part of the service model during the SDC +on-boarding process and will be supplied to the Heat Orchestration +Template by ONAP at orchestration time. + + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + environment_context: + type: string + description: Environment Context for this VNF instance + + +*Example OS::Nova::Server with metadata* + +.. code-block:: yaml + + resources: + . . . + + {vm-type}_server_{index}: + type: OS::Nova::Server + properties: + name: + flavor: + image: + ... + metadata: + vnf_name: { get_param: vnf_name } + vnf_id: { get_param: vnf_id } + vf_module_name: { get_param: vf_module_name } + vf_module_id: { get_param: vf_module_id } + workload_context: {get_param: workload_context} + environment_context: {get_param: environment_context } + + +Resource: OS::Neutron::Port - Parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The resource OS::Neutron::Port is for managing Neutron ports (See +https://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Neutron::Port.) + +Introduction +++++++++++++ + +Four properties of the resource OS::Neutron::Port that must follow the +ONAP parameter naming convention. The four properties are: + +1. network +2. fixed_ips, ip_address +3. fixed_ips, subnet_id or fixed_ips, subnet + + * Note that in many examples in this document fixed_ips, subnet_id is used. + +4. allowed_address_pairs, ip_address + +Below is a generic example. Note that for some parameters +comma_delimited_list are supported in addition to String. + +.. code-block:: yaml + + resources: + + ... + + <resource ID>: + type: OS::Neutron::Port + properties: + allowed_address_pairs: [{"ip_address": String, "mac_address": String}, + {"ip_address": String, "mac_address": String}, ...] + fixed_ips: [{"ip_address": String, "subnet_id": String, "subnet": + String}, {"ip_address": String, "subnet_id": String, "subnet": String}, + ...] + network: String + +The values associated with these properties may reference an external +network or internal network. External networks and internal +networks are defined in `Networking`_. + +When the OS::Neutron::Port is attaching to an external network, all +property values are parameters that are retrieved via the intrinsic +function 'get_param'. + +When the OS::Neutron::Port is attaching to an internal network, a +property value maybe retrieved via the intrinsic +function 'get_param', 'get_resource', or 'get_attr'. + +This will be described in the forth coming sections. + +Items to Note +_____________ + +R-93272 A VNF **MAY** have one or more ports connected to a unique +external network. All VNF ports connected +to the unique external network **MUST** have Cloud Assigned IP Addresses +or **MUST** have ONAP SDN-C assigned IP addresses. + +R-13841 A VNF **MAY** have one or more ports connected to a unique +internal network. All VNF ports connected +to the unique internal network **MUST** have Cloud Assigned IP Addresses +or **MUST** have statically assigned IP addresses. + +R-07577 If the VNF's ports connected to a unique network (internal or external) +and the port's IP addresses are Cloud Assigned IP Addresses, +all the IPv4 Addresses **MUST** be from +the same subnet and all the IPv6 Addresses **MUST** be from the +same subnet. + +R-45602 If a VNF's Port is attached to a network (internal or external) +and the port's IP addresses are Cloud Assigned by OpenStack's DHCP +Service, the 'OS::Neutron::Port' Resource's + + * property 'fixed_ips' map property 'ip_address' **MUST NOT** be used + * property 'fixed_ips' map property 'subnet'/'subnet_id' **MAY** be used + +R-63956 If the VNF's ports connected to a unique external network +and the port's IP addresses are ONAP SDN-C assigned IP Addresses, +the IPv4 Addresses **MAY** be from +different subnets and the IPv6 Addresses **MAY** be from different +subnets. + +R-48880 If a VNF's Port is attached to an external network and the port's +IP addresses are assigned by ONAP's SDN-Controller, +the 'OS::Neutron::Port' Resource's + + * property 'fixed_ips' map property 'ip_address' **MUST** be used + * property 'fixed_ips' map property 'subnet'/'subnet_id' **MUST NOT** + be used + +R-18001 If the VNF's ports connected to a unique internal network +and the port's IP addresses are statically assigned IP Addresses, +the IPv4 Addresses **MAY** be from +different subnets and the IPv6 Addresses **MAY** be from different +subnets. + +R-70964 If a VNF's Port is attached to an internal network and the port's +IP addresses are statically assigned by the VNF's Heat Orchestration\ +Template (i.e., enumerated in the Heat Orchestration Template's +environment file), the 'OS::Neutron::Port' Resource's + + * property 'fixed_ips' map property 'ip_address' **MUST** be used + * property 'fixed_ips' map property 'subnet'/'subnet_id' + **MUST NOT** be used + + +Property: network ++++++++++++++++++ + +The Resource 'OS::Neutron::Port' property 'network' determines what network +the port is attached to. + + +R-18008 The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port' +property 'network' parameter **MUST** be declared as type: 'string'. + +R-62983 When the VNF's Heat Orchestration Template's +Resource 'OS::Neutron::Port' is attaching to an external network, +the 'network' parameter name **MUST** + +- follow the naming convention '{network-role}_net_id' if the Neutron + network UUID value is used to reference the network +- follow the naming convention '{network-role}_net_name' if the OpenStack + network name is used to reference the network. + +where '{network-role}' is the network-role of the external network and +a 'get_param' **MUST** be used as the intrinsic function. + +R-86182 When the VNF's Heat Orchestration Template's +Resource 'OS::Neutron::Port' is attaching to an internal network, +and the internal network is created in a different +Heat Orchestration Template than the 'OS::Neutron::Port', the 'network' +parameter name **MUST** + +- follow the naming convention 'int\_{network-role}_net_id' if the Neutron + network UUID value is used to reference the network +- follow the naming convention 'int\_{network-role}_net_name' if the + OpenStack network name in is used to reference the network. + +where '{network-role}' is the network-role of the internal network +and a 'get_param' **MUST** be used as the intrinsic function. + +In Requirement R-86182, the internal network is created in the VNF's +Base Module (Heat Orchestration Template) and the parameter name is +declared in the Base Module's outputs' section. +The output parameter name will be declared as a parameter in the +'parameters' section of the incremental module. + +R-93177 When the VNF's Heat Orchestration Template's +Resource 'OS::Neutron::Port' is attaching to an internal +network, and the internal network is created in the same Heat +Orchestration Template than the 'OS::Neutron::Port', the 'network' +parameter name **MUST** obtain the UUID of the internal network +by using the intrinsic function 'get_resource' or 'get_attr' +and referencing the Resource ID of the internal network. + +R-29872 The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' +property 'network' parameter **MUST NOT** be enumerated in the Heat +Orchestration Template's Environment File. + +The parameter values for external networks are provided by ONAP +to the VNF's Heat Orchestration Template at orchestration time. + +The parameter values for internal networks created in the VNF's Base Module +Heat Orchestration Template +are provided to the VNF's Incremental Module Heat Orchestration Template +at orchestration time. + +*Example Parameter Definition of External Networks* + +.. code-block:: yaml + + parameters: + + {network-role}_net_id: + type: string + description: Neutron UUID for the external {network-role} network + + {network-role}_net_name: + type: string + description: Neutron name for the external {network-role} network + + +*Example Parameter Definition of Internal Networks in an Incremental Module* + +.. code-block:: yaml + + parameters: + + int_{network-role}_net_id: + type: string + description: Neutron UUID for the internal int_{network-role} network + + int_{network-role}_net_name: + type: string + description: Neutron name for the internal int_{network-role} network + +Property: fixed_ips, Map Property: ip_address ++++++++++++++++++++++++++++++++++++++++++++++ + +The resource 'OS::Neutron::Port' property 'fixed_ips' +map property 'ip_address' +is used to assign one IPv4 or IPv6 +addresses to port. + +One 'OS::Neutron::Port' resource may assign one or more +IPv4 and/or IPv6 addresses. + +R-34037 The VNF's Heat Orchestration Template's resource 'OS::Neutron::Port' +property 'fixed_ips' map property 'ip_address' parameter **MUST** +be declared as either type 'string' or type 'comma_delimited_list'. + +R-40971 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an external network, and an IPv4 address is +assigned using the property +'fixed_ips' map property 'ip_address' and the parameter type is defined +as a string, the parameter name **MUST** follow the naming +convention + + * '{vm-type}_{network-role}\_ip\_{index}' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the external network + * the value for {index} must start at zero (0) and increment by one + +R-39841 The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port' +property 'fixed_ips' map property 'ip_address' parameter +'{vm-type}_{network-role}\_ip\_{index}' **MUST NOT** be enumerated in the +VNF's Heat Orchestration Template's Environment File. + +ONAP's SDN-Controller assigns the IP Address and ONAP provides +the value at orchestration to the Heat Orchestration Template. + +*Example External Network IPv4 Address string Parameter Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_{network-role}_ip_{index}: + type: string + description: Fixed IPv4 assignment for {vm-type} VM {index} on the{network-role} network + +R-04697 When the VNF's Heat Orchestration Template's +Resource 'OS::Neutron::Port' is attaching to an external +network, and an IPv4 address is assigned using the property +'fixed_ips' map property 'ip_address' and the parameter type +is defined as a comma_delimited_list, the parameter name **MUST** +follow the naming convention + + * '{vm-type}_{network-role}_ips', + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the external network + +R-98905 The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port' +property 'fixed_ips' map property 'ip_address' parameter +'{vm-type}_{network-role}_ips' **MUST NOT** be enumerated in the VNF's +Heat Orchestration Template's Environment File. + +ONAP's SDN-Controller assigns the IP Address and ONAP provides +the value at orchestration to the Heat Orchestration Template. + +*Example External Network IPv4 Address comma_delimited_list +Parameter Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_{network-role}_ips: + type: comma_delimited_list + description: Fixed IPv4 assignments for {vm-type} VMs on the {network-role} network + +R-71577 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an external network, and an IPv6 address +is assigned using the property 'fixed_ips' map property 'ip_address' and +the parameter type is defined as a string, the parameter name **MUST** follow +the naming convention + + * '{vm-type}_{network-role}\_v6\_ip\_{index}' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the external network + * the value for {index} must start at zero (0) and increment by one + + +R-87123 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address' +parameter '{vm-type}_{network-role}\_v6\_ip\_{index}' +**MUST NOT** be enumerated in the VNF's Heat Orchestration +Template's Environment File. + +ONAP's SDN-Controller assigns the IP Address and ONAP provides +the value at orchestration to the Heat Orchestration Template. + +*Example External Network IPv6 Address string Parameter Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_{network-role}_v6_ip_{index}: + type: string + description: Fixed IPv6 assignment for {vm-type} VM {index} on the {network-role} network + +R-23503 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an external network, and an IPv6 +address is assigned using the property 'fixed_ips' map property 'ip_address' +and the parameter type is defined as a comma_delimited_list, the parameter +name **MUST** follow the naming convention + + * '{vm-type}_{network-role}_v6_ips' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the external network + +R-93030 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address' +parameter '{vm-type}_{network-role}_v6_ips' **MUST NOT** be enumerated in the +VNF's Heat Orchestration Template's Environment File. + +ONAP's SDN-Controller assigns the IP Address and ONAP provides +the value at orchestration to the Heat Orchestration Template. + +*Example External Network IPv6 Address comma_delimited_list Parameter +Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_{network-role}_v6_ips: + type: comma_delimited_list + description: Fixed IPv6 assignments for {vm-type} VMs on the {network-role} network + +R-78380 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an internal network, and an IPv4 address +is assigned using the property 'fixed_ips' map property 'ip_address' and +the parameter type is defined as a string, the parameter name **MUST** follow +the naming convention + + * '{vm-type}\_int\_{network-role}\_ip\_{index}' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the internal network + * the value for {index} must start at zero (0) and increment by one + +R-28795 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address' +parameter '{vm-type}\_int\_{network-role}\_ip\_{index}' **MUST** be enumerated +in the VNF's Heat Orchestration Template's Environment File. + +The IP address is local to the VNF's internal network and is (re)used +in every VNF spin up, thus the constant value is declared in the VNF's +Heat Orchestration Template's Environment File. + +*Example Internal Network IPv4 Address string Parameter Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_int_{network-role}_ip_{index}: + type: string + description: Fixed IPv4 assignment for {vm-type} VM {index} on the int_{network-role} network + +R-85235 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an internal network, and an IPv4 +address is assigned using the property 'fixed_ips' map property 'ip_address' +and the parameter type is defined as a comma_delimited_list, the parameter +name **MUST** follow the naming convention + + * '{vm-type}\_int\_{network-role}_ips' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the internal network + +R-90206 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address' +parameter '{vm-type}\_int\_{network-role}_int_ips' **MUST** be enumerated in +the VNF's Heat Orchestration Template's Environment File. + +The IP address is local to the VNF's internal network and is (re)used +in every VNF spin up, thus the constant value is declared in the VNF's +Heat Orchestration Template's Environment File. + +.. code-block:: yaml + + parameters: + + {vm-type}_int_{network-role}_ips: + type: comma_delimited_list + description: Fixed IPv4 assignments for {vm-type} VMs on the int_{network-role} network + +R-27818 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an internal network, and an IPv6 address +is assigned using the property 'fixed_ips' map property 'ip_address' and +the parameter type is defined as a string, the parameter name **MUST** follow +the naming convention + + * '{vm-type}\_int\_{network-role}\_v6\_ip\_{index}' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the internal network + * the value for {index} must start at zero (0) and increment by one + +R-97201 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address' +parameter '{vm-type}\_int\_{network-role}\_v6\_ip\_{index}' +**MUST** be enumerated in the VNF's Heat Orchestration +Template's Environment File. + +The IP address is local to the VNF's internal network and is (re)used +in every VNF spin up, thus the constant value is declared in the VNF's +Heat Orchestration Template's Environment File. + +*Example Internal Network IPv6 Address string Parameter Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_int_{network-role}_v6_ip_{index}: + type: string + description: Fixed IPv6 assignment for {vm-type} VM {index} on the int_{network-role} network + +R-29765 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an internal network, and an IPv6 +address is assigned using the property 'fixed_ips' map property 'ip_address' +and the parameter type is defined as a comma_delimited_list, the parameter +name **MUST** follow the naming convention + + * '{vm-type}\_int\_{network-role}_v6_ips' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the internal network + +*Example Internal Network IPv6 Address comma_delimited_list Parameter +Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_int_{network-role}_v6_ips: + type: comma_delimited_list + description: Fixed IPv6 assignments for {vm-type} VMs on the int_{network-role} network + +R-98569 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address' +parameter '{vm-type}\_int\_{network-role}_v6_ips' **MUST** be enumerated in +the VNF's Heat Orchestration Template's Environment File. + +The IP address is local to the VNF's internal network and is (re)used +in every VNF spin up, thus the constant value is declared in the VNF's +Heat Orchestration Template's Environment File. + +R-62590 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address' +parameter associated with an external network, i.e., + +- {vm-type}_{network-role}\_ip\_{index} +- {vm-type}_{network-role}\_ip\_v6\_{index} +- {vm-type}_{network-role}_ips +- {vm-type}_{network-role}_v6_ips + +**MUST NOT** be enumerated in the Heat Orchestration Template's +Environment File. ONAP provides the IP address assignments at +orchestration time. + +R-93496 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address' +parameter associated with an internal network, i.e., + +- {vm-type}\_int\_{network-role}\_ip\_{index} +- {vm-type}\_int\_{network-role}\_ip\_v6\_{index} +- {vm-type}\_int\_{network-role}_ips +- {vm-type}\_int\_{network-role}_v6_ips + +**MUST** be enumerated in the Heat Orchestration Template's Environment +File and IP addresses **MUST** be assigned. + +Summary Table +_____________ + +.. csv-table:: **Table # OS::Neutron::Port Property fixed_ips map property ip_address Parameter Naming Convention** + :header: Resource,Property,Map Property,Network Type,IP Address,Parameter Type,Parameter Name, Environment File + :align: center + :widths: auto + + OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, string, {vm-type}\_{network-role}\_ip\_{index}, NO + OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, comma\_delimited\_list, {vm-type}\_{network-role}\_ips, NO + OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, string, {vm-type}\_{network-role}\_v6\_ip\_{index}, NO + OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, comma\_delimited\_list, {vm-type}\_{network-role}\_v6\_ips, NO + OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, string, {vm-type}\_int\_{network-role}\_ip\_{index}, YES + OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, comma\_delimited\_list, {vm-type}\_int\_{network-role}\_ips, YES + OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, string, {vm-type}\_int\_{network-role}\_v6\_ip\_{index}, YES + OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, comma\_delimited\_list, {vm-type}\_int\_{network-role}\_v6\_ips, YES + + +Examples +________ + +*Example: comma_delimited_list parameters for IPv4 and IPv6 Address +Assignments to an external network* + +In this example, the '{network-role}' has been defined as 'oam' to represent +an oam network and the '{vm-type}' has been defined as 'db' for database. + +.. code-block:: yaml + + parameters: + oam_net_id: + type: string + description: Neutron UUID for a oam network + db_oam_ips: + type: comma_delimited_list + description: Fixed IPv4 assignments for db VMs on the oam network + db_oam_v6_ips: + type: comma_delimited_list + description: Fixed IPv6 assignments for db VMs on the oam network + resources: + db_0_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [ db_oam_ips, 0 ]}}, { + "ip_address": {get_param: [ db_oam_v6_ips, 0 ]}}] + db_1_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: + - "ip_address": {get_param: [ db_oam_ips, 1 ]} + - "ip_address": {get_param: [ db_oam_v6_ips, 1 ]} + +*Example: string parameters for IPv4 and IPv6 Address Assignments to an +external network* + +In this example, the '{network-role}' has been defined as 'oam' to +represent an oam network and the '{vm-type}' has been defined as 'db' for +database. + +.. code-block:: yaml + + parameters: + oam_net_id: + type: string + description: Neutron UUID for an OAM network + db_oam_ip_0: + type: string + description: Fixed IPv4 assignment for db VM 0 on the OAM network + db_oam_ip_1: + type: string + description: Fixed IPv4 assignment for db VM 1 on the OAM network + db_oam_v6_ip_0: + type: string + description: Fixed IPv6 assignment for db VM 0 on the OAM network + db_oam_v6_ip_1: + type: string + description: Fixed IPv6 assignment for db VM 1 on the OAM network + resources: + db_0_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: db_oam_ip_0}}, { "ip_address": {get_param: db_oam_v6_ip_0 ]}}] + db_1_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: + - "ip_address": {get_param: db_oam_ip_1}}] + - "ip_address": {get_param: db_oam_v6_ip_1}}] + + +*Example: comma_delimited_list parameters for IPv4 and IPv6 Address +Assignments to an internal network* + +In this example, the '{network-role}' has been defined as 'ctrl' to +represent an ctrl network internal to the vnf. +The '{vm-type}' has been defined as 'db' for +database. + +.. code-block:: yaml + + parameters: + int_ctrl_net_id: + type: string + description: Neutron UUID for the ctrl internal network + db_int_ctrl_ips: + type: comma_delimited_list + description: Fixed IPv4 assignments for db VMs on the ctrl internal + network + db_int_ctrl_v6_ips: + type: comma_delimited_list + description: Fixed IPv6 assignments for db VMs on the ctrl internal + network + resources: + db_0_int_ctrl_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: int_ctrl_net_id } + fixed_ips: [ { "ip_address": {get_param: [ db_int_ctrl_ips, 0 ]}}, { + "ip_address": {get_param: [ db_int_ctrl_v6_ips, 0 ]}}] + db_1_int_ctrl_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: int_ctrl_net_id } + fixed_ips: + - "ip_address": {get_param: [ db_int_ctrl_ips, 1 ]} + - "ip_address": {get_param: [ db_int_ctrl_v6_ips, 1 ]} + + +*Example: string parameters for IPv4 and IPv6 Address Assignments to an +internal network* + +In this example, the int\_{network-role} has been defined as +int_ctrl to represent a control network internal to the vnf. +The {vm-type} has been defined as db for database. + +.. code-block:: yaml + + parameters: + int_ctrl_net_id: + type: string + description: Neutron UUID for an OAM internal network + db_int_ctrl_ip_0: + type: string + description: Fixed IPv4 assignment for db VM on the oam_int network + db_int_ctrl_ip_1: + type: string + description: Fixed IPv4 assignment for db VM 1 on the oam_int network + db_int_ctrl_v6_ip_0: + type: string + description: Fixed IPv6 assignment for db VM 0 on the oam_int network + db_int_ctrl_v6_ip_1: + type: string + description: Fixed IPv6 assignment for db VM 1 on the oam_int network + resources: + db_0_int_ctrl_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: int_oam_int_net_id } + fixed_ips: [ { "ip_address": {get_param: db_oam_int_ip_0}}, { + "ip_address": {get_param: db_oam_int_v6_ip_0 ]}}] + db_1_int_ctrl_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: int_oam_int_net_id } + fixed_ips: + - "ip_address": {get_param: db_oam_int_ip_1}}] + - "ip_address": {get_param: db_oam_int_v6_ip_1}}] + + +Property: fixed\_ips, Map Property: subnet\_id +++++++++++++++++++++++++++++++++++++++++++++++ + +The resource 'OS::Neutron::Port' property 'fixed_ips' map +property 'subnet'/'subnet_id' is used when a +port is requesting an IP assignment via +OpenStack's DHCP Service (i.e., Cloud Assigned). + +The IP address assignment will be made from the specified subnet. + +Specifying the subnet is not required; it is optional. + +If the network (external or internal) that the port is attaching +to only contains one subnet, specifying the subnet is +superfluous. The IP address will be assigned from the one existing +subnet. + +If the network (external or internal) that the port is attaching +to contains two or more subnets, specifying the subnet in the +'fixed_ips' map property 'subnet'/'subnet_id' determines which +subnet the IP address will be assigned from. + +If the network (external or internal) that the port is attaching +to contains two or more subnets, and the subnet is not is not +specified, OpenStack will randomly(?) determine which subnet +the IP address will be assigned from. + +The property fixed_ips is used to assign IPs to a port. The Map Property +subnet_id specifies the subnet the IP is assigned from. + +R-38236 The VNF's Heat Orchestration Template's resource +'OS::Neutron::Port' property 'fixed_ips' map property +'subnet'/'subnet_id' parameter **MUST** be declared type 'string'. + +R-62802 When the VNF's Heat Orchestration Template's resource +'OS::Neutron::Port' is attaching to an external network, and an IPv4 +address is being Cloud Assigned by OpenStack's DHCP Service and the +external network IPv4 subnet is to be specified using the property +'fixed_ips' map property 'subnet'/'subnet_id', the parameter **MUST** +follow the naming convention + + * '{network-role}_subnet_id' + +where + + * '{network-role}' is the network role of the network. + +R-83677 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property +subnet'/'subnet_id' parameter '{network-role}_subnet_id' +**MUST NOT** be enumerated in the VNF's Heat Orchestration Template's +Environment File. + +ONAP's SDN-Controller provides the network's subnet's UUID +value at orchestration to the Heat Orchestration Template. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + + {network-role}_subnet_id: + type: string + description: Neutron IPv4 subnet UUID for the {network-role} network + +R-15287 When the VNF's Heat Orchestration Template's resource +'OS::Neutron::Port' is attaching to an external network, and an IPv6 +address is being Cloud Assigned by OpenStack's DHCP Service and the +external network IPv6 subnet is to be specified using the property +'fixed_ips' map property 'subnet'/'subnet_id', the parameter **MUST** +follow the naming convention + + * '{network-role}_subnet_v6_id' + +where + + * '{network-role}' is the network role of the network. + +R-80829 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property +subnet'/'subnet_id' parameter '{network-role}_subnet_v6_id' +**MUST NOT** be enumerated in the VNF's Heat Orchestration Template's +Environment File. + +ONAP's SDN-Controller provides the network's subnet's UUID +value at orchestration to the Heat Orchestration Template. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + + {network-role}_v6_subnet_id: + type: string + description: Neutron IPv6 subnet UUID for the {network-role} network + + +*Example: One Cloud Assigned IPv4 Address (DHCP) assigned to a network +that has two or more IPv4 subnets* + +In this example, the '{network-role}' has been defined as 'oam' to represent +an oam network and the '{vm-type}' has been defined as 'lb' for load +balancer. The Cloud Assigned IP Address uses the OpenStack DHCP service +to assign IP addresses. + +.. code-block:: yaml + + parameters: + oam_net_id: + type: string + description: Neutron UUID for the oam network + oam_subnet_id: + type: string + description: Neutron IPv4 subnet UUID for the oam network + resources: + lb_0_oam_port_0: + type: OS::Neutron::Port + parameters: + network: { get_param: oam_net_id } + fixed_ips: + - subnet_id: { get_param: oam_subnet_id } + +*Example: One Cloud Assigned IPv4 address and one Cloud Assigned IPv6 +address assigned to a network that has at least one IPv4 subnet and one +IPv6 subnet* + +In this example, the '{network-role}' has been defined as 'oam' to represent +an oam network and the '{vm-type}' has been defined as 'lb' for load +balancer. + +.. code-block:: yaml + + parameters: + oam_net_id: + type: string + description: Neutron UUID for the oam network + oam_subnet_id: + type: string + description: Neutron IPv4 subnet UUID for the oam network + oam_v6_subnet_id: + type: string + description: Neutron IPv6 subnet UUID for the oam network + resources: + lb_0_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: + - subnet_id: { get_param: oam_subnet_id } + - subnet_id: { get_param: oam_v6_subnet_id } + +R-84123 When + +- the VNF's Heat Orchestration Template's resource 'OS::Neutron::Port' + in an Incremental Module is attaching to an internal network + that is created in the Base Module, AND +- an IPv4 address is being Cloud Assigned by OpenStack's DHCP Service AND +- the internal network IPv4 subnet is to be specified using the + property 'fixed_ips' map property 'subnet'/'subnet_id', + +the parameter **MUST** follow the naming convention + * 'int\_{network-role}_subnet_id' +where + * '{network-role}' is the network role of the internal network + +- Note that the parameter **MUST** be defined as an 'output' parameter in + the base module. + +R-69634 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property +subnet'/'subnet_id' parameter 'int\_{network-role}_subnet_id' +**MUST NOT** be enumerated in the VNF's Heat Orchestration Template's +Environment File. + +The assumption is that internal networks are created in the base module. +The Neutron subnet network ID will be passed as an output parameter +(e.g., ONAP Base Module Output Parameter) to the incremental modules. +In the incremental modules, the output parameter name will be defined as +input parameter. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + + int_{network-role}_subnet_id: + type: string + description: Neutron IPv4 subnet UUID for the int_{network-role} network + +R-76160 When + +- the VNF's Heat Orchestration Template's resource + 'OS::Neutron::Port' in an Incremental Module is attaching to an + internal network that is created in the Base Module, AND +- an IPv6 address is being Cloud Assigned by OpenStack's DHCP Service AND +- the internal network IPv6 subnet is to be specified using the property + 'fixed_ips' map property 'subnet'/'subnet_id', + +the parameter **MUST** follow the naming convention + * 'int\_{network-role}_v6_subnet_id' +where + * '{network-role}' is the network role of the internal network + +- Note that the parameter **MUST** be defined as an 'output' parameter in + the base module. + +R-22288 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'fixed_ips' map property +'subnet'/'subnet_id' parameter 'int\_{network-role}_v6_subnet_id' +**MUST NOT** be enumerated in the VNF's Heat Orchestration Template's +Environment File. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + + int_{network-role}_v6_subnet_id: + type: string + description: Neutron subnet UUID for the int_{network-role} network + + +Property: allowed\_address\_pairs, Map Property: ip\_address ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The property 'allowed_address_pairs' in the resource 'OS::Neutron::Port' +allows the user to specify a mac_address and/or ip_address that will +pass through a port regardless of subnet. This enables the use of +protocols, such as VRRP, which allow for a Virtual IP (VIP) address +to be shared among two or more ports, with one designated as the master +and the others as backups. In case the master fails, +the Virtual IP address is mapped to a backup's IP address and +the backup becomes the master. + +Note that the management of the VIP IP addresses (i.e. transferring +ownership between active and standby VMs) is the responsibility of +the VNF application. + +R-62300 If a VNF has two or more ports that require a Virtual IP Address (VIP), +a VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port' property +'allowed_address_pairs' map property 'ip_address' parameter **MUST** be used. + +The 'allowed_address_pairs' is an optional property. It is not required. + +ONAP automation supports the assignment of VIP addresses +for external networks. ONAP support the assignment of one IPv4 VIP address +and/or one IPv6 VIP address to a set of ports associated with a +'{vm-type}' and '{network-role}'. + +If a VNF requires more than one IPv4 VIP address +and/or more than one IPv6 VIP address to a set of ports associated with a +'{vm-type}' and '{network-role}', there are "manual" work-around +procedures that can be utilized. + +VIP Assignment, External Networks, Supported by Automation +__________________________________________________________ + + +R-91810 If a VNF requires ONAP to assign a Virtual IP (VIP) Address to +ports connected an external network, the port +**MUST NOT** have more than one IPv4 VIP address. + +R-41956 If a VNF requires ONAP to assign a Virtual IP (VIP) Address to +ports connected an external network, the port +**MUST NOT** have more than one IPv6 VIP address. + +R-10754 If a VNF has two or more ports that +attach to an external network that require a Virtual IP Address (VIP), +and the VNF requires ONAP automation to assign the IP address, +all the Virtual Machines using the VIP address **MUST** +be instantiated in the same Base Module Heat Orchestration Template +or in the same Incremental Module Heat Orchestration Template. + + +R-98748 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'allowed_address_pairs' +map property 'ip_address' parameter +**MUST** be declared as type 'string'. + + +R-41492 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an external network, +and an IPv4 Virtual IP (VIP) +address is assigned via ONAP automation +using the property 'allowed_address_pairs' +map property 'ip_address' and +the parameter name **MUST** follow the +naming convention + + * '{vm-type}_{network-role}_floating_ip' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the external network + +And the parameter **MUST** be declared as type 'string'. + +R-83412 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'allowed_address_pairs' +map property 'ip_address' parameter +'{vm-type}_{network-role}_floating_ip' +**MUST NOT** be enumerated in the +VNF's Heat Orchestration Template's Environment File. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_{network-role}_floating_ip: + type: string + description: IPv4 VIP for {vm-type} VMs on the {network-role} network + + + +R-35735 When the VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' is attaching to an external network, +and an IPv6 Virtual IP (VIP) +address is assigned via ONAP automation +using the property 'allowed_address_pairs' +map property 'ip_address', +the parameter name **MUST** follow the +naming convention + + * '{vm-type}_{network-role}_v6_floating_ip' + +where + + * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server + * '{network-role}' is the {network-role} of the external network + +And the parameter **MUST** be declared as type 'string'. + + + +R-83418 The VNF's Heat Orchestration Template's Resource +'OS::Neutron::Port' property 'allowed_address_pairs' +map property 'ip_address' parameter +'{vm-type}_{network-role}_floating_v6_ip' +**MUST NOT** be enumerated in the +VNF's Heat Orchestration Template's Environment File. + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + + {vm-type}_{network-role}_floating_v6_ip: + type: string + description: VIP for {vm-type} VMs on the {network-role} network + +Note that these parameters are **not** intended to represent an OpenStack +"Floating IP", for which OpenStack manages a pool of public IP +addresses that are mapped to specific VM ports. In that case, the +individual VMs are not even aware of the public IPs, and all assignment +of public IPs to VMs is via OpenStack commands. ONAP does not support +Neutron-style Floating IPs. That is, ONAP does not support the +resources 'OS::Neutron::FloatingIP' +and 'OS::Neutron::FloatingIPAssociation'. + +R-05257 A VNF's Heat Orchestration Template's **MUST NOT** +contain the Resource 'OS::Neutron::FloatingIP'. + +R-76449 A VNF's Heat Orchestration Template's **MUST NOT** +contain the Resource 'OS::Neutron::FloatingIPAssociation'. + +The Floating IP functions as a NAT. They are allocated within +Openstack, and always "terminate" within the Openstack infrastructure. +When Openstack receives packets on a Floating IP, the packets will +be forwarded to the +Port that has been mapped to the Floating IP, using the private address of the +port. The VM never sees or knows about the Openstack Floating IP. +The process to use is: + + - User allocates a floating IP from the Openstack pool. + - User 'attaches' that floating IP to one of the VM ports. + +If there is a high-availability VNF that wants to "float" the IP to a +different VM, it requires a Neutron command to request Openstack to 'attach' +the floating IP to a different VM port. +The pool of such addresses is managed by Openstack infrastructure. +Users cannot create new ones, they can only choose from those in the pool. +The pool is typically global (i.e. any user/tenant can grab them). + +Allowed address pairs are for more typical Linux-level "virtual IPs". +They are additional IP addresses that are advertised by some port on the VM, +in addition to the primary private IP address. Typically in a +high-availability VNF, an additional IP is assigned and will float between +VMs (e.g., via some health-check app that will plumb the IP on one or other +VM). In order for this to work, the actual packets must be addressed to that +IP address (and the allowed_ip_address list will let it pass through +to the VM). This generally requires provider network access +(i.e. direct access to a data center network for the VMs), such that these +IPs can pass through all of the virtual routers. +Contrail also provides the enhanced networking that allows routing of such +additional IPs. + +Floating IPs are not used in ONAP due to the NAT-ting nature of the IPs, +the inability to reserve such IPs for specific use, the need to manage them +via Openstack commands (i.e. a HA VNF would require direct access to +Openstack to 'float' such an IP from one VM to another). + +*Example:* + +In this example, the {network-role} has been defined as oam to represent +an oam network and the {vm-type} has been defined as db for database. + +.. code-block:: yaml + + parameters: + oam_net_id: + type: string + description: Neutron UUID for the oam network + db_oam_ips: + type: comma_delimited_list + description: Fixed IPs for db VMs on the oam network + db_oam_floating_ip: + type: string + description: VIP IP for db VMs on the oam network + resources: + db_0_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [db_oam_ips,0] }}] + allowed_address_pairs: [ { "ip_address": {get_param: + db_oam_floating_ip}}] + db_1_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [db_oam_ips,1] }}] + allowed_address_pairs: [ { "ip_address": {get_param: + db_oam_floating_ip}}] + + +VIP Assignment, External Networks, Additional Options +_____________________________________________________ + +The parameter {'vm-type}_{network-role}_floating_ip' allows for only one +allowed address pair IPv4 address per '{vm-type}' and '{network-role}' +combination. + +The parameter '{vm-type}_{network-role}_floating_v6_ip' allows for only one +allowed address pair IPv6 address per '{vm-type}' and '{network-role}' +combination. + +If there is a need for multiple allowed address pair IPs for a given +{vm-type} and {network-role} combination within a VNF, there are two +options. + +**Option One** + +If there is a need for multiple allowed address pair IPs for a given +'{vm-type}' and '{network-role}' combination within a VNF, then the +parameter names defined for the Property 'fixed_ips' Map Property +'ip_address' should be used or the Property 'allowed_address_pairs' +Map Property 'ip_address'. The +parameter names are provided in the table below. + +.. csv-table:: **Table 5 OS::Neutron::Port Property allowed_address_pairs map property ip_address Parameter Naming Convention** + :header: IP Address,Parameter Type,Parameter Name + :align: center + :widths: auto + + IPv4, string, {vm-type}_{network-role}_ip_{index} + IPv4, comma_delimited_list, {vm-type}_{network-role}_ips + IPv6, string, {vm-type}_{network-role}_v6_ip_{index} + IPv6, comma_delimited_list, {vm-type}_{network-role}_v6_ips + +The examples below illustrate this concept. + +*Example: A VNF has four load balancers. Each pair has a unique VIP.* + +In this example, there are two administrative VM pairs. Each pair has +one VIP. The {network-role} has been defined as oam to represent an oam +network and the {vm-type} has been defined as admin for an +administrative VM. + +Pair 1: Resources admin_0_port_0 and admin_1_port_0 share a unique VIP, +[admin_oam_ips,2] + +Pair 2: Resources admin_2_port_0 and admin_3_port_0 share a unique VIP, +[admin_oam_ips,5] + +.. code-block:: yaml + + parameters: + oam_net_id: + type: string + description: Neutron UUID for the oam network + admin_oam_ips: + type: comma_delimited_list + description: Fixed IP assignments for admin VMs on the oam network + + resources: + admin_0_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [admin_oam_ips,0] }}] + allowed_address_pairs: [{ "ip_address": {get_param: [admin_oam_ips,2] + }}] + admin_1_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [admin_oam_ips,1] }}] + allowed_address_pairs: [{ "ip_address": {get_param: [admin_oam_ips,2] + }}] + admin_2_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [admin_oam_ips,3] }}] + allowed_address_pairs: [{ "ip_address": {get_param: [admin_oam_ips,5] + }}] + admin_3_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [admin_oam_ips,4] }}] + allowed_address_pairs: [{ "ip_address": {get_param: [admin_oam_ips,5] + }}] + +*Example: A VNF has two load balancers. The pair of load balancers share +two VIPs.* + +In this example, there is one load balancer pairs. The pair has two +VIPs. The {network-role} has been defined as oam to represent an oam +network and the {vm-type} has been defined as lb for a load balancer VM. + +.. code-block:: yaml + + resources: + lb_0_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [lb_oam_ips,0] }}] + allowed_address_pairs: [{ "ip_address": {get_param: [lb_oam_ips,2] }, + {get_param: [lb_oam_ips,3] }}] + lb_1_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: oam_net_id } + fixed_ips: [ { "ip_address": {get_param: [lb_oam_ips,1] }}] + allowed_address_pairs: [{ "ip_address": {get_param: [lb_oam_ips,2] }, + {get_param: [lb_oam_ips,3] }}] + +As a general rule, provide the fixed IPs for the VMs indexed first in +the CDL and then the VIPs as shown in the examples above. + +**Option Two** + +If there is a need for multiple allowed address pair IPs for a given +'{vm-type}' and '{network-role}' combination within a VNF, then the +parameter names defined for the table below can be used. + +**Resource OS::Neutron::Port** + +Table 6: Multiple allowed_address_pairs Option 2A + +.. csv-table:: **Table 6 OS::Neutron::Port Property allowed_address_pairs map property ip_address Parameter Naming Convention** + :header: IP Address,Parameter Type,Parameter Name + :align: center + :widths: auto + + IPv4, string, {vm-type}_{network-role}_vip_{index} + IPv4, comma_delimited_list, {vm-type}_{network-role}_vips + IPv6, string, {vm-type}_{network-role}_v6_vip_{index} + IPv6, comma_delimited_list, {vm-type}_{network-role}_v6_vips + + +If there is a need for multiple allowed address pair IPs for a given +'{vm-type}' and '{network-role}' combination within a VNF and the need to +differentiate the VIPs for different traffic types (e.g., 911 VIP, +fail-over VIP), then the parameter names defined for the table below can +be used. + +**Resource OS::Neutron::Port** + +Table 7: Multiple allowed_address_pairs Option 2B + +.. csv-table:: **Table 7 OS::Neutron::Port Property allowed_address_pairs map property ip_address Parameter Naming Convention** + :header: IP Address,Parameter Type,Parameter Name + :align: center + :widths: auto + + IPv4, string, {vm-type}_{network-role}_{vip_type}_vip + IPv4, comma_delimited_list, {vm-type}_{network-role}_{vip_type}_vips + IPv6, string, {vm-type}_{network-role}_{vip_type}_v6_vip + IPv6, comma_delimited_list, {vm-type}_{network-role}_{vip_type}_v6_vips + +Internal Networks +_________________ + +ONAP defines an internal network in relation to +the VNF and not with regard to the Network Cloud site. Internal +networks may also be referred to as "intra-VNF" networks or "private" +networks. An internal network only connects VMs in a single VNF. It +must not connect to other VNFs or an external (to the cloud) gateway or an +external (to the cloud) router. + +ONAP internal networks should be created in the base module. + +As previously mentioned, +ports that connect to an internal network are assigned IP addresses +via one of two methods + + * Method 1: Cloud assigned by OpenStack's DHCP Service + * Method 2: Statically assigned. That is, predetermined by the VNF designer + and are specified in the VNF's Heat Orchestration Template's + Environment File + +If Cloud assigned IP addressing is being used, output statements +are created in the base module. + +If static assigned IP addressing is being used, the IP addresses +are defined in the environment file. + + + * {vm-type}_int_{network-role}_floating_ip + * {vm-type}_int_{network-role}_floating_v6_ip + + * {vm-type}_int_{network-role}_vip_{index} + * {vm-type}_int_{network-role}_vips + * {vm-type}_int_{network-role}_v6_vip_{index} + * {vm-type}_int_{network-role}_v6_vips + + + * {vm-type}_int_{network-role}_{vip_type}_vip + * {vm-type}_int_{network-role}_{vip_type}_vips + * {vm-type}_int_{network-role}_{vip_type}_v6_vip + * {vm-type}_int_{network-role}_{vip_type}_v6_vips + + + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + {vm-type}_int_{network-role}_floating_ip: + type: string + description: VIP for {vm-type} VMs on the int_{network-role} network + + {vm-type}_int_{network-role}_floating_v6_ip: + type: string + description: VIP for {vm-type} VMs on the int_{network-role} network + + + + +allowed_address_pair IP Addresses Required in more than one module +__________________________________________________________________ + +If the IP address {vm-type}_{network-role}_floating_ip and/or +{vm-type}_{network-role}_floating_v6_ip must be used in more than module in the +VNF, the parameter values must be defined as output values in the base +module with output names: {vm-type}_{network-role}_shared_vip or +{vm-type}_{network-role}_v6_shared_vip + +.. code-block:: yaml + + outputs: + {vm-type}_{network-role}_shared_vip: + description: + value: { get_param: {vm-type}_{network-role}_floating_ip } + + {vm-type}_{network-role}_v6_shared_vip: + description: + value: { get_param: {vm-type}_{network-role}_v6_floating_ip } + +The output parameters must be defined as input parameter in the +incremental modules that require the IP addresses. When defining the +allowed_address_pairs: in the OS::Neutron::Port, it should be as +follows: + +.. code-block:: yaml + + allowed_address_pairs: [ { "ip_address": {get_param: + {vm-type}_{network-role}_shared_vip }}, { "ip_address": {get_param: + {vm-type}_{network-role}_v6_shared_vip }}] + +Reserve Port Concept +____________________ + +A "Reserve Port" is an OS::Neutron::Port that fixed_ips, ip_address +property is assigned one or more IP addresses that are used as Virtual +IP (VIP) Addresses (i.e., allowed_address_pairs) on other ports. + +A "Reserve Port" is never attached to a Virtual Machine +(OS::Nova::Server). The reserve port ensures that the intended +allowed_address_pair IP address is not inadvertently assigned as a +fixed_ips to a OS::Neutron::Port that is attached OS::Nova::Server and +thus causing routing issues. + +A VNF may have one or more "Reserve Ports". A reserve port maybe created +in the base module or an incremental module. If created in the base +module, parameters may be defined in the outputs: section of the base +template so the IP Address assigned to the reserve port maybe assigned +to the allowed_address_pair property of an OS::Neutron::Port in one or +more incremental modules. + +The parameter name of the IP address used in the "Reserve Port" depends +on the allowed_address_pair "option" utilized by the VNF. + +When creating a Reserve Port, if only one allowed_address_pair is configured +on a port, then the parameter name depends upon the IP addresses type +(IPv4 or IPv6) and network type (internal or external). +The valid parameter names are: + + * {vm-type}_{network-role}_floating_ip + * {vm-type}_{network-role}_floating_v6_ip + * {vm-type}_int_{network-role}_floating_ip + * {vm-type}_int_{network-role}_floating_v6_ip + +When creating a Reserve Port, if more than one (e.g., multiple) +allowed_address_pair is configured on a port, then the parameter name depends +upon the IP addresses type (IPv4 or IPv6) and network type +(internal or external) and the option being used. The valid parameter +names are: + + * {vm-type}_{network-role}_ip_{index} + * {vm-type}_{network-role}_ips + * {vm-type}_{network-role}_v6_ip_{index} + * {vm-type}_{network-role}_v6_ips + * {vm-type}_{network-role}_vip_{index} + * {vm-type}_{network-role}_vips + * {vm-type}_{network-role}_v6_vip_{index} + * {vm-type}_{network-role}_v6_vips + * {vm-type}_{network-role}_{vip-type}_vip + * {vm-type}_{network-role}_v6_{vip-type}_vip + * {vm-type}_{network-role}_{vip-type}_vips + * {vm-type}_{network-role}_v6_{vip-type}_vips + +*Example IPv4 Reserve Port Definition: one allowed_address_pair +configured on a port* + +.. code-block:: yaml + + Reserve_Port_{vm-type}_{network-role}_floating_ip_{index}: + type: OS::Neutron::Port + properties: + network: { get_param: {network-role}_net_id } + fixed_ips: + - ip_address : { get_param: {vm-type}_{network-role}_floating_ip } + +*Example IPv6 Reserve Port Definition: one allowed_address_pair +configured on a port* + +.. code-block:: yaml + + Reserve_Port_{vm-type}_{network-role}_floating_v6_ip_{index}: + type: OS::Neutron::Port + properties: + network: { get_param: {network-role}_net_id } + fixed_ips: + - ip_address : { get_param: {vm-type}_{network-role}_floating_v6_ip } + + +Resource Property "name" +~~~~~~~~~~~~~~~~~~~~~~~~ + +The parameter naming convention of the property name for the resource +OS::Nova::Server has been defined in +`Resource: OS::Nova::Server – Metadata Parameters`_. + +This section provides the requirements how the property name for non +OS::Nova::Server resources must be defined when the property is used. +Not all resources require the property name (e.g., it is optional) and +some resources do not support the property. + +R-85734 If a VNF's Heat Orchestration Template contains the property 'name' +for a non 'OS::Nova::Server' resource, the intrinsic function +'str_replace' **MUST** be used in conjunction with the ONAP +supplied metadata parameter 'vnf_name' to generate a unique value. + +This prevents the enumeration of a +unique value for the property name in a per instance environment file. + +R-99812 A value for VNF's Heat Orchestration Template's property 'name' +for a non 'OS::Nova::Server' resource **MUST NOT** be declared +in the VNF's Heat Orchestration Template's Environment File. + +In most cases the use of the metadata value 'vnf_name' is required to create a +unique property name. If this will not provide a unique value, +additional options include: + + - Using the Heat Orchestration Template pseudo parameter + 'OS::stack_name' in the str_replace construct + - Resources created in a nested heat file invoked by an + 'OS::Heat::ResourceGroup' can use the 'index' to construct a unique name + +R-32408 If a VNF's Heat Orchestration Template property 'name' +for a non 'OS::Nova::Server' resource uses the intrinsic function +'str_replace' in conjunction with the ONAP +supplied metadata parameter 'vnf_name' and does not create +a unique value, additional data **MUST** be used in the +'str_replace' to create a unique value, such as 'OS::stack_name' +and/or the 'OS::Heat::ResourceGroup' 'index'. + +*Example: Property 'name' for resource 'OS::Neutron::SecurityGroup'* + +.. code-block:: yaml + + resources: + DNS_SECURITY_GROUP: + type: OS::Neutron::SecurityGroup + properties: + description: vDNS security group + name: + str_replace: + template: VNF_NAME_sec_grp_DNS + params: + VNF_NAME: {get_param: vnf_name} + rules: [. . . . .] + +*Example: Property 'name' for resource 'OS::Cinder::Volume'* + +.. code-block:: yaml + + resources: + dns_volume_0: + type: OS::Cinder::Volume + properties: + description: Cinder Volume + name: + str_replace: + template: VNF_NAME_STACK_NAME_dns_volume + params: + VNF_NAME: {get_param: vnf_name} + STACK_NAME: { get_param: 'OS::stack_name' } + . . . . + +*Example: Property 'name' for resource 'OS::Cinder::Volume' invoked by a +'OS::Heat::ResourceGroup'* + +.. code-block:: yaml + + resources: + dns_volume_0: + type: OS::Cinder::Volume + properties: + description: Cinder Volume + name: + str_replace: + template: VNF_NAME_STACK_NAME_dns_volume_INDEX + params: + VNF_NAME: { get_param: vnf_name } + STACK_NAME: { get_param: 'OS::stack_name' } + INDEX: { get_param: index } + . . . . + +Contrail Issue with Values for the Property Name +++++++++++++++++++++++++++++++++++++++++++++++++ + +R-84517 The Contrail GUI has a limitation displaying special characters. +The issue is documented in +https://bugs.launchpad.net/juniperopenstack/+bug/1590710. +It is recommended that special **SHOULD** characters be avoided. +However, if special characters must be used, note that for +the following resources: + + * Virtual Machine + * Virtual Network + * Port + * Security Group + * Policies + * IPAM Creation + +the only special characters supported +are - \" ! $\ \ ' ( ) = ~ ^ | @ ` { } [ ] > , . _" + +ONAP Output Parameter Names +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ONAP defines three types of Output Parameters as detailed in +`Output Parameters`_. + +ONAP Base Module Output Parameters: ++++++++++++++++++++++++++++++++++++ + +ONAP Base Module Output Parameters do not have an explicit naming +convention. + +R-97726 A VNF's Heat Orchestration Template's Base Module Output +Parameter names **MUST** contain {vm-type} and/or {network-role} +when appropriate. + +ONAP Volume Template Output Parameters: ++++++++++++++++++++++++++++++++++++++++ + +R-88524 A VNF's Heat Orchestration Template's Volume Template +Output Parameter names **MUST** contain {vm-type} when appropriate. + +Predefined Output Parameters +++++++++++++++++++++++++++++ + +ONAP currently defines one predefined output parameter the OAM +Management IP Addresses. + +OAM Management IP Addresses +___________________________ + +A VNF may have a management interface for application controllers to +interact with and configure the VNF. Typically, this will be via a +specific VM that performs a VNF administration function. The IP address +of this interface must be captured and inventoried by ONAP. The IP +address might be a VIP if the VNF contains an HA pair of management VMs, +or may be a single IP address assigned to one VM. + +R-47874 A VNF **MAY** have + + * Only an IPv4 OAM Management IP Address + * Only an IPv6 OAM Management IP Address + * Both a IPv4 and IPv6 OAM Management IP Addresses + +R-18683 If a VNF has one IPv4 OAM Management IP Address and the +IP Address needs to be inventoried in ONAP's A&AI +database, an output parameter **MUST** be declared in only one of the +VNF's Heat Orchestration Templates and the parameter **MUST** be named +'oam_management_v4_address'. + +R-94669 If a VNF has one IPv6 OAM Management IP Address and the +IP Address needs to be inventoried in ONAP's A&AI +database, an output parameter **MUST** be declared in only one of the +VNF's Heat Orchestration Templates and the parameter **MUST** be named +'oam_management_v6_address'. + +The OAM Management IP Address maybe assigned either via + * ONAP SDN-C + * DHCP + +R-56287 If the VNF's OAM Management IP Address is assigned by ONAP SDN-C and +assigned in the VNF's Heat Orchestration Template's via a heat resource +'OS::Neutron::Port' property 'fixed_ips' map property +'ip_adress' parameter (e.g., '{vm-type}_{network-role}_ip_{index}', +'{vm-type}_{network-role}_v6_ip_{index}') +and the OAM IP Address is required to be inventoried in ONAP AAI, +then the parameter **MUST** be echoed in an output statement. + +.. code-block:: yaml + + outputs: + oam_management_v4_address: + value: {get_param: {vm-type}_{network-role}_ip_{index} } + oam_management_v6_address: + value: {get_param: {vm-type}_{network-role}_v6_ip_{index} } + +*Example: ONAP SDN-C Assigned IP Address echoed as +oam_management_v4_address* + +.. code-block:: yaml + + parameters: + admin_oam_ip_0: + type: string + description: Fixed IPv4 assignment for admin VM 0 on the OAM network + . . . + resources: + admin_0_oam_port_0: + type: OS::Neutron::Port + properties: + name: + str_replace: + template: VNF_NAME_admin_oam_port_0 + params: + VNF_NAME: {get_param: vnf_name} + network: { get_param: oam_net_id } + fixed_ips: [{ "ip_address": { get_param: admin_oam_ip_0 }}] + security_groups: [{ get_param: security_group }] + admin_server_0: + type: OS::Nova::Server + properties: + name: { get_param: admin_names } + image: { get_param: admin_image_name } + flavor: { get_param: admin_flavor_name } + availability_zone: { get_param: availability_zone_0 } + networks: + - port: { get_resource: admin_0_oam_net_port_0 } + metadata: + vnf_id: { get_param: vnf_id } + vf_module_id: { get_param: vf_module_id } + vnf_name: {get_param: vnf_name } + outputs: + oam_management_v4_address: + value: {get_param: admin_oam_ip_0 } + + +R-48987 If the VNF's OAM Management IP Address is Cloud assigned and +and the OAM IP Address is required to be inventoried in ONAP AAI, +then the parameter **MUST** be obtained by the resource 'OS::Neutron::Port' +attribute 'ip_address'. + +.. code-block:: yaml + + outputs: + oam_management_v4_address: + value: {get_attr: [ {OS::Neutron Port Resource ID}, fixed_ips, 0, ip_address] } + +*Example: Cloud Assigned IP Address output as oam_management_v4_address* + +.. code-block:: yaml + + parameters: + . . . + resources: + admin_0_oam_port_0: + type: OS::Neutron::Port + properties: + name: + str_replace: + template: VNF_NAME_admin_oam_0_port + params: + VNF_NAME: {get_param: vnf_name} + network: { get_param: oam_net_id } + security_groups: [{ get_param: security_group }] + admin_server_0: + type: OS::Nova::Server + properties: + name: { get_param: admin_name_0 } + image: { get_param: admin_image_name } + flavor: { get_param: admin_flavor_name } + availability_zone: { get_param: availability_zone_0 } + networks: + - port: { get_resource: admin_0_oam_port_0 } + metadata: + vnf_id: { get_param: vnf_id } + vf_module_id: { get_param: vf_module_id } + vnf_name: {get_param: vnf_name } + outputs: + oam_management_v4_address: + value: {get_attr: [admin_0_oam_port_0, fixed_ips, 0, ip_address] } + +Contrail Resource Parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ONAP requires the parameter names of certain Contrail Resources to +follow specific naming conventions. This section provides these +requirements. + +Contrail Network Parameters ++++++++++++++++++++++++++++ + +Contrail based resources may require references to a Contrail network +using the network FQDN. + +External Networks +_________________ + +R-02164 When a VNF's Heat Orchestration Template's Contrail resource +has a property that +references an external network that requires the network's +Fully Qualified Domain Name (FQDN), the property parameter + + * **MUST** follow the format '{network-role}_net_fqdn' + * **MUST** be declared as type 'string' + * **MUST NOT** be enumerated in the NF's Heat Orchestration Template's + Environment File + +R-73228 A VNF's Heat Orchestration Template's parameter +'{network-role}_net_fqdn' +**MUST** be declared as type 'string'. + +R-92193 A VNF's Heat Orchestration Template's parameter +'{network-role}_net_fqdn' +**MUST NOT** be enumerated in the VNF's Heat Orchestration Template's +Environment File. + +*Example: Parameter declaration* + +.. code-block:: yaml + + parameters: + {network-role}_net_fqdn: + type: string + description: Contrail FQDN for the {network-role} network + +*Example: Contrail Resource OS::ContrailV2::VirtualMachineInterface +Reference to a Network FQDN.* + +In this example, the {network-role} has been defined as oam to represent +an oam network and the {vm-type} has been defined as fw for firewall. +The Contrail resource OS::ContrailV2::VirtualMachineInterface property +virtual_network_refs references a contrail network FQDN. + +.. code-block:: yaml + + fw_0_oam_vmi_0: + type: OS::ContrailV2::VirtualMachineInterface + properties: + name: + str_replace: + template: VM_NAME_virtual_machine_interface_1 + params: + VM_NAME: { get_param: fw_name_0 } + virtual_machine_interface_properties: + virtual_machine_interface_properties_service_interface_type: { + get_param: oam_protected_interface_type } + virtual_network_refs: + - get_param: oam_net_fqdn + security_group_refs: + - get_param: fw_sec_grp_id + + +Interface Route Table Prefixes for Contrail InterfaceRoute Table +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +R-28222 If a VNF's Heat Orchestration Template +'OS::ContrailV2::InterfaceRouteTable' resource +'interface_route_table_routes' property +'interface_route_table_routes_route' map property parameter name +**MUST** follow the format + + * {vm-type}_{network-role}_route_prefixes + +R-19756 If a VNF's Heat Orchestration Template +OS::ContrailV2::InterfaceRouteTable resource +'interface_route_table_routes' property +'interface_route_table_routes_route' map property parameter +'{vm-type}_{network-role}_route_prefixes' +**MUST** be defined as type 'json'. + +R-76682 If a VNF's Heat Orchestration Template +OS::ContrailV2::InterfaceRouteTable resource +'interface_route_table_routes' property +'interface_route_table_routes_route' map property parameter +'{vm-type}_{network-role}_route_prefixes' +**MUST NOT** be enumerated in the VNF's Heat Orchestration Template's +Environment File. + +The parameter '{vm-type}_{network-role}_route_prefixes' +supports IP addresses in the format: + +1. Host IP Address (e.g., 10.10.10.10) + +2. CIDR Notation format (e.g., 10.0.0.0/28) + + +*Example Parameter Definition* + +.. code-block:: yaml + + parameters: + {vm-type}_{network-role}_route_prefixes: + type: json + description: JSON list of Contrail Interface Route Table route prefixes + +*Example:* + +.. code-block:: yaml + + parameters: + vnf_name: + type: string + description: Unique name for this VF instance + fw_oam_route_prefixes: + type: json + description: prefix for the ServiceInstance InterfaceRouteTable + int_fw_dns_trusted_interface_type: + type: string + description: service_interface_type for ServiceInstance + + resources: + <resource name>: + type: OS::ContrailV2::InterfaceRouteTable + depends_on: [resource name of OS::ContrailV2::ServiceInstance] + properties: + name: + str_replace: + template: VNF_NAME_interface_route_table + params: + VNF_NAME: { get_param: vnf_name } + interface_route_table_routes: + interface_route_table_routes_route: { get_param: fw_oam_route_prefixes } + service_instance_refs: + - get_resource: <resource name of OS::ContrailV2::ServiceInstance> + service_instance_refs_data: + - service_instance_refs_data_interface_type: { get_param: oam_interface_type } + +Resource OS::ContrailV2::InstanceIp ++++++++++++++++++++++++++++++++++++ + +The Contrail resource OS::ContrailV2::InstanceIp has two properties +that parameters **MUST** follow an explicit naming convention. The +properties are 'instance_ip_address' and 'subnet_uuid'. + +*Example OS::ContrailV2::InstanceIp Resource* + +.. code-block:: yaml + + <resource ID>: + type: OS::ContrailV2::InstanceIp + properties: + name: { get_param: name } + fq_name: { get_param: fq_name } + display_name: { get_param: display_name } + secondary_ip_tracking_ip: + { + secondary_ip_tracking_ip_ip_prefix: { get_param: secondary_ip_tracking_ip_ip_prefix }, + secondary_ip_tracking_ip_ip_prefix_len: { get_param: secondary_ip_tracking_ip_ip_prefix_len }, + } + instance_ip_address: { get_param: instance_ip_address } + instance_ip_mode: { get_param: instance_ip_mode } + subnet_uuid: { get_param: subnet_uuid } + instance_ip_family: { get_param: instance_ip_family } + annotations: + { + annotations_key_value_pair: + [{ + annotations_key_value_pair_key: { get_param: annotations_key_value_pair_key }, + annotations_key_value_pair_value: { get_param: annotations_key_value_pair_value }, + }], + } + instance_ip_local_ip: { get_param: instance_ip_local_ip } + instance_ip_secondary: { get_param: instance_ip_secondary } + physical_router_refs: [{ get_param: physical_router_refs }] + virtual_machine_interface_refs: [{ get_param: virtual_machine_interface_refs }] + virtual_network_refs: [{ get_param: virtual_network_refs }] + +Resource OS::ContrailV2::InstanceIp Property instance_ip_address +________________________________________________________________ + +A VNF's Heat Orchestration Templates resource 'OS::ContrailV2::InstanceIp' +property 'instance_ip_address' parameter +**MUST** follow the same requirements +that apply to the resource 'OS::Neutron' property 'fixed_ips' map +property 'ip_address' parameter. + + +*Example: Contrail Resource OS::ContrailV2::InstanceIp, Property +instance_ip_address* + +The property instance_ip_address uses the same parameter naming +convention as the property fixed_ips and Map Property ip_address in +OS::Neutron::Port. The resource is assigning an ONAP SDN-C Assigned IP +Address. The {network-role} has been defined as oam_protected to +represent an oam protected network and the {vm-type} has been defined as +fw for firewall. + +.. code-block:: yaml + + fw_0_oam_protected_vmi_0_IP_0: + type: OS::ContrailV2::InstanceIp + depends_on: + - fw_0_oam_protected_vmi_0 + properties: + virtual_machine_interface_refs: + - get_resource: fw_0_oam_protected_vmi_0 + virtual_network_refs: + - get_param: oam_protected_net_fqdn + instance_ip_address: { get_param: [fw_oam_protected_ips, get_param: index ] } + +Resource OS::ContrailV2::InstanceIp Property subnet_uuid +________________________________________________________________ + +A VNF's Heat Orchestration Templates resource 'OS::ContrailV2::InstanceIp' +property 'subnet_uuid' parameter +**MUST** follow the same requirements +that apply to the resource 'OS::Neutron' property 'fixed_ips' map +property 'subnet'/'subnet_id' parameter. + +*Example: Contrail Resource OS::ContrailV2::InstanceIp, Property +subnet_uuid* + +The property instance_ip_address uses the same parameter naming +convention as the property fixed_ips and Map Property subnet_id in +OS::Neutron::Port. The resource is assigning a Cloud Assigned IP +Address. The {network-role} has been defined as "oam_protected" to +represent an oam protected network and the {vm-type} has been defined as +"fw" for firewall. + +.. code-block:: yaml + + fw_0_oam_protected_vmi_0_IP_0: + type: OS::ContrailV2::InstanceIp + depends_on: + - fw_0_oam_protected_vmi_0 + properties: + virtual_machine_interface_refs: + - get_resource: fw_0_oam_protected_vmi_0 + virtual_network_refs: + - get_param: oam_protected_net_fqdn + subnet_uuid: { get_param: oam_protected_subnet_id } + +OS::ContrailV2::VirtualMachineInterface Property +virtual_machine_interface_allowed_address_pairs +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + + +A VNF's Heat Orchestration Templates resource +'OS::ContrailV2::VirtualMachineInterface' map property, +virtual_machine_interface_allowed_address_pairs, +virtual_machine_interface_allowed_address_pairs_allowed_address_pair, +virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip, +virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix +parameter **MUST** follow the same requirements that apply to the +resource 'OS::Neutron::Port' property +'allowed_address_pairs', map property 'ip_address' parameter. + +*Example OS::ContrailV2::VirtualMachineInterface* + +.. code-block:: yaml + + <resource ID>: + type: OS::ContrailV2::VirtualMachineInterface + properties: + name: { get_param: name } + fq_name: { get_param: fq_name } + ecmp_hashing_include_fields: + { + ecmp_hashing_include_fields_hashing_configured: { get_param: ecmp_hashing_include_fields_hashing_configured }, + ecmp_hashing_include_fields_source_ip: { get_param: ecmp_hashing_include_fields_source_ip }, + ecmp_hashing_include_fields_destination_ip: { get_param: ecmp_hashing_include_fields_destination_ip }, + ecmp_hashing_include_fields_ip_protocol: { get_param: ecmp_hashing_include_fields_ip_protocol }, + ecmp_hashing_include_fields_source_port: { get_param: ecmp_hashing_include_fields_source_port }, + ecmp_hashing_include_fields_destination_port: { get_param: ecmp_hashing_include_fields_destination_port }, + } + virtual_machine_interface_host_routes: + { + virtual_machine_interface_host_routes_route: + [{ + virtual_machine_interface_host_routes_route_prefix: { get_param: virtual_machine_interface_host_routes_route_prefix }, + virtual_machine_interface_host_routes_route_next_hop: { get_param: virtual_machine_interface_host_routes_route_next_hop }, + virtual_machine_interface_host_routes_route_next_hop_type: { get_param: virtual_machine_interface_host_routes_route_next_hop_type }, + virtual_machine_interface_host_routes_route_community_attributes: + { + virtual_machine_interface_host_routes_route_community_attributes_community_attribute: [{ get_param: virtual_machine_interface_host_routes_route_community_attributes_community_attribute }], + }, + }], + } + virtual_machine_interface_mac_addresses: + { + virtual_machine_interface_mac_addresses_mac_address: [{ get_param: virtual_machine_interface_mac_addresses_mac_address }], + } + virtual_machine_interface_dhcp_option_list: + { + virtual_machine_interface_dhcp_option_list_dhcp_option: + [{ + virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_name: { get_param: virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_name }, + virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_value: { get_param: virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_value }, + virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_value_bytes: { get_param: virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_value_bytes }, + }], + } + virtual_machine_interface_bindings: + { + virtual_machine_interface_bindings_key_value_pair: + [{ + virtual_machine_interface_bindings_key_value_pair_key: { get_param: virtual_machine_interface_bindings_key_value_pair_key }, + virtual_machine_interface_bindings_key_value_pair_value: { get_param: virtual_machine_interface_bindings_key_value_pair_value }, + }], + } + virtual_machine_interface_disable_policy: { get_param: virtual_machine_interface_disable_policy } + virtual_machine_interface_allowed_address_pairs: + { + virtual_machine_interface_allowed_address_pairs_allowed_address_pair: + [{ + virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip: + { + virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix: { get_param: virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix }, + virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix_len: { get_param: virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix_len }, + }, + virtual_machine_interface_allowed_address_pairs_allowed_address_pair_mac: { get_param: virtual_machine_interface_allowed_address_pairs_allowed_address_pair_mac }, + virtual_machine_interface_allowed_address_pairs_allowed_address_pair_address_mode: { get_param: virtual_machine_interface_allowed_address_pairs_allowed_address_pair_address_mode }, + }], + } + annotations: + { + annotations_key_value_pair: + [{ + annotations_key_value_pair_key: { get_param: annotations_key_value_pair_key }, + annotations_key_value_pair_value: { get_param: annotations_key_value_pair_value }, + }], + } + virtual_machine_interface_fat_flow_protocols: + { + virtual_machine_interface_fat_flow_protocols_fat_flow_protocol: + [{ + virtual_machine_interface_fat_flow_protocols_fat_flow_protocol_protocol: { get_param: virtual_machine_interface_fat_flow_protocols_fat_flow_protocol_protocol }, + virtual_machine_interface_fat_flow_protocols_fat_flow_protocol_port: { get_param: virtual_machine_interface_fat_flow_protocols_fat_flow_protocol_port }, + }], + } + virtual_machine_interface_device_owner: { get_param: virtual_machine_interface_device_owner } + port_security_enabled: { get_param: port_security_enabled } + virtual_machine_interface_properties: + { + virtual_machine_interface_properties_service_interface_type: { get_param: virtual_machine_interface_properties_service_interface_type }, + virtual_machine_interface_properties_interface_mirror: + { + virtual_machine_interface_properties_interface_mirror_traffic_direction: { get_param: virtual_machine_interface_properties_interface_mirror_traffic_direction }, + virtual_machine_interface_properties_interface_mirror_mirror_to: + { + virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_name: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_name }, + virtual_machine_interface_properties_interface_mirror_mirror_to_encapsulation: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_encapsulation }, + virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_ip_address: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_ip_address }, + virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_mac_address: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_mac_address }, + virtual_machine_interface_properties_interface_mirror_mirror_to_routing_instance: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_routing_instance }, + virtual_machine_interface_properties_interface_mirror_mirror_to_udp_port: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_udp_port }, + virtual_machine_interface_properties_interface_mirror_mirror_to_juniper_header: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_juniper_header }, + virtual_machine_interface_properties_interface_mirror_mirror_to_nh_mode: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_nh_mode }, + virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header: + { + virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vtep_dst_ip_address: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vtep_dst_ip_address }, + virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vtep_dst_mac_address: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vtep_dst_mac_address }, + virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vni: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vni }, + }, + }, + }, + virtual_machine_interface_properties_local_preference: { get_param: virtual_machine_interface_properties_local_preference }, + virtual_machine_interface_properties_sub_interface_vlan_tag: { get_param: virtual_machine_interface_properties_sub_interface_vlan_tag }, + } + display_name: { get_param: display_name } + service_health_check_refs: [{ get_param: service_health_check_refs }] + routing_instance_refs: [{ get_param: routing_instance_refs }] + routing_instance_refs_data: + [{ + routing_instance_refs_data_direction: { get_param: routing_instance_refs_data_direction }, + routing_instance_refs_data_vlan_tag: { get_param: routing_instance_refs_data_vlan_tag }, + routing_instance_refs_data_src_mac: { get_param: routing_instance_refs_data_src_mac }, + routing_instance_refs_data_dst_mac: { get_param: routing_instance_refs_data_dst_mac }, + routing_instance_refs_data_mpls_label: { get_param: routing_instance_refs_data_mpls_label }, + routing_instance_refs_data_service_chain_address: { get_param: routing_instance_refs_data_service_chain_address }, + routing_instance_refs_data_ipv6_service_chain_address: { get_param: routing_instance_refs_data_ipv6_service_chain_address }, + routing_instance_refs_data_protocol: { get_param: routing_instance_refs_data_protocol }, + }] + security_group_refs: [{ get_param: security_group_refs }] + physical_interface_refs: [{ get_param: physical_interface_refs }] + port_tuple_refs: [{ get_param: port_tuple_refs }] + interface_route_table_refs: [{ get_param: interface_route_table_refs }] + virtual_machine_interface_refs: [{ get_param: virtual_machine_interface_refs }] + virtual_network_refs: [{ get_param: virtual_network_refs }] + virtual_machine_refs: [{ get_param: virtual_machine_refs }] + qos_config_refs: [{ get_param: qos_config_refs }] + virtual_machine: { get_param: virtual_machine } + project: { get_param: project } + + + +Suggested Naming Convention for Common Parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Many VNFs use the parameters in the table below are used in user_data. +The table below provides a suggested naming convention for these common +parameters. + +Netmask ++++++++ + +.. csv-table:: **Table 8: Suggested Naming Convention for Common Parameters: Netmask** + :header: Parameter Name,Parameter Type,Notes + :align: center + :widths: auto + + {network-role}_subnet_<index>_netmask, string, + int_<network-role>_subnet_<index>_netmask, string, + {network-role}_v6_subnet_<index>_netmask , string, + int_{network-role}_v6_subnet_<index>_netmask, string, + +CIDR +++++ + +.. csv-table:: **Table 9: Suggested Naming Convention for Common Parameters: CIDR** + :header: Parameter Name,Parameter Type,Notes + :align: center + :widths: auto + + <network-role>_subnet_<index>_cidr, string, + int_<network-role>_subnet_<index>_cidr, string, + <network-role>_v6_subnet_<index>_cidr, string, + int_<network-role>_v6_subnet_<index>_cidr, string, + +Default Gateway ++++++++++++++++ + +.. csv-table:: **Table 10: Suggested Naming Convention for Common Parameters: Default Gateway** + :header: Parameter Name,Parameter Type,Notes + :align: center + :widths: auto + + {network-role}_subnet_<index>_default_gateway, string, + {network-role}_v6_subnet_<index>_default_gateway, string, + +DCAE Collector IP Address ++++++++++++++++++++++++++ + +.. csv-table:: **Table 11: Suggested Naming Convention for Common Parameters: DCAE Collector Address** + :header: Parameter Name,Parameter Type,Notes + :align: center + :widths: auto + + dcae_collector_ip_<index>, string, + dcae_collector_v6_ip_<index>, string, + +NTP Server IP Address ++++++++++++++++++++++ + +.. csv-table:: **Table 12: Suggested Naming Convention for Common Parameters: NTP Server IP Address** + :header: Parameter Name,Parameter Type,Notes + :align: center + :widths: auto + + ntp_ip_<index>, string, + ntp_v6_ip_<index>, string, + +DNS +++++++++ + +.. csv-table:: **Table 13: Suggested Naming Convention for Common Parameters: DCAE Collector Address** + :header: Parameter Name,Parameter Type,Notes + :align: center + :widths: auto + + dns_{network-role}_ip_<index>, string, + dns_{network-role}_v6_ip_<index>, string, + +Security Group +++++++++++++++ + +.. csv-table:: **Table 14: Suggested Naming Convention for Common Parameters: Security Group** + :header: Parameter Name,Parameter Type,Notes + :align: center + :widths: auto + + {vm-type}_security_group, string, Security Group applicable to one {vm-type} and more than one network (internal and/or external) + {network-role}_security_group, string, Security Group applicable to more than one {vm-type} and one external network + int_{network-role}_security_group, string, Security Group applicable to more than one {vm-type} and one internal network + {vm-type}_{network-role}_security_group, string, Security Group applicable to one {vm-type} and one external network + {vm-type}_int_{network-role}_security_group, string, Security Group applicable to one {vm-type} and one internal network + shared_security_group, string, Security Group applicable to more than one {vm-type} and more than one network (internal and/or external) + +ONAP VNF Modularity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +ONAP supports a modular Heat Orchestration Template design pattern, +referred to as *VNF Modularity.* With this approach, a single VNF **MAY** be +composed from one or more Heat Orchestration Templates, each of which +represents a subset of the overall VNF. These component parts are +referred to as *VNF Modules*. During orchestration, these modules +are deployed incrementally to create the complete VNF. + +A stated in R-33132, a VNF's Heat Orchestration Template **MAY** be + 1.) Base Module Heat Orchestration Template (also referred to as a + Base Module), + 2.) Incremental Module Heat Orchestration Template (referred to as + an Incremental Module), or + 3.) a Cinder Volume Module Heat Orchestration Template (referred to as + Cinder Volume Module). + +As stated in R-20974, at orchestration time, the VNF's Base Module **MUST** +be deployed first, prior to any incremental modules. + +As stated in R-28980, R-86926, and R-91497, a +VNF's incremental module **MAY** be used for + + * initial VNF deployment only + * scale out only + * both deployment and scale out + +As stated in R-68122, a VNF's incremental module **MAY** be deployed +more than once, either during initial VNF deployment and/or scale out + +As stated in R-37028 and R-13196, a VNF **MUST** be composed +of one Base Module and *MAY** be composed of zero to many Incremental +Modules. + +ONAP also supports the concept of an optional, independently deployed +Cinder volume via a separate Heat Orchestration Templates, referred to +as a Cinder Volume Module. This allows the volume to persist after a VM +(i.e., OS::Nova::Server) is deleted, allowing the volume to be reused on +another instance (e.g., during a fail over activity). + +The scope of a Cinder volume module, when it exists, must be 1:1 with a +Base module or Incremental Module. + +A VNF module (base, incremental, cinder) **MAY** support nested templates. + +A shared Heat Resource is a resource that **MAY** be used by +other Heat Resources either in the Base Module or an +Incremental Module. + + +R-61001 A shared Heat Orchestration Template resource must be defined +in the base module. A shared resource is a resource that that will +be referenced by another resource that is defined in the Base Module +and/or one or more incremental modules. When the shared resource needs +to be referenced by a resource in an incremental module, the UUID of +the shared resource **MUST** be exposed by declaring an ONAP Base +Module Output Parameter. + +When the shared resource needs to be referenced by a resource in an +incremental module, the UUID of the shared resource must be exposed by +declaring an ONAP Base Module Output Parameter. + +An example of a shared resource is the resource +OS::Neutron::SecurityGroup. Security groups are sets of IP filter rules +that are applied to a VNF’s networking. The resource OS::Neutron::Port +has a property security_groups which provides the security groups +associated with port. The value of parameter(s) associated with this +property must be the UUIDs of the resource(s) +OS::Neutron::SecurityGroup. + +*Note:* A Cinder volume is not considered a shared resource. A volume +template must correspond 1:1 with a base template or add-on module +template. + +Suggested Patterns for Modular VNFs +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There are numerous variations of VNF modularity. Below are two suggested +usage patterns. + +**Option 1: Incremental Modules per VNFC type** + +a. Base module contains only the shared resources. + +b. Group all VMs (e.g., VNFCs) of a given type (i.e. {vm-type}) into its + own incremental module. That is, the VNF has an incremental module + for each {vm-type}. + +c. For a given {vm-type} incremental module, the VNF may have + + i. One incremental module used for both initial turn up and re-used + for scaling. This approach is used when the number of VMs + instantiated will be the same for initial deployment and scaling. + + ii. Two incremental modules, where one is used for initial turn up + and one is used for scaling. This approach is used when the + number of VMs instantiated will be different for initial + deployment and scaling. + +**Option 2: Base VNF with Incremental Growth Modules** + +a. Base module contains a complete initial VNF instance + +b. Incremental modules for incremental scaling units + + i. May contain VMs of multiple types in logical scaling combinations + + ii. May be separated by VM type for multi-dimensional scaling + +With no growth units, Option 2 is equivalent to the "One Heat Template +per VNF" model. + +Note that modularization of VNFs is not required. A single Heat +Orchestration Template (a base module) may still define a complete VNF, +which might be appropriate for smaller VNFs that do not have any scaling +options. + +Modularity Rules +~~~~~~~~~~~~~~~~~~~~~ + +There are some rules to follow when building modular VNF templates: + +1. All VNFs must have one Base VNF Module (template) that must be the + first one deployed. The base template: + + a. Must include all shared resources (e.g., private networks, server + groups, security groups) + + b. Must expose all shared resources (by UUID) as "outputs" in its + associated Heat template (i.e., ONAP Base Module Output + Parameters) + + c. May include initial set of VMs + + d. May be operational as a stand-alone "minimum" configuration of the + VNF + +2. VNFs may have one or more incremental modules which: + + a. Defines additional resources that can be added to an existing VNF + + b. Must be complete Heat templates + + i. i.e. not snippets to be incorporated into some larger template + + c. Should define logical growth-units or sub-components of an overall + VNF + + d. On creation, receives appropriate Base Module outputs as + parameters + + i. Provides access to all shared resources (by UUID) + + ii. *VNFs may have one or more incremental modules which must not be + dependent on other Add-On VNF Modules* + + e. Multiple instances of an incremental Module may be added to the + same VNF (e.g., incrementally grow a VNF by a fixed "add-on" + growth units) + +3. Each VNF Module (base or incremental) may have (optional) an + associated Cinder Volume Module (see Cinder Volumes) + + a. Volume modules must correspond 1:1 with a base module or + incremental module + + b. A Cinder volume may be embedded within the base module or + incremental module if persistence is not required + +4. Shared resource UUIDs are passed between the base module and + incremental modules via Heat Outputs Parameters (i.e., Base Module + Output Parameters) + + a. The output parameter name in the base must match the parameter + name in the add-on module + +VNF Modularity Examples +~~~~~~~~~~~~~~~~~~~~~~~~~ + +*Example: Base Module creates SecurityGroup* + +A VNF has a base module, named base.yaml, that defines a +OS::Neutron::SecurityGroup. The security group will be referenced by an +OS::Neutron::Port resource in an incremental module, named +INCREMENTAL_MODULE.yaml. The base module defines a parameter in the +outputs:section named dns_sec_grp_id. dns_sec_grp_id is defined as a +parameter in the incremental module. ONAP captures the UUID value of +dns_sec_grp_id from the base module output statement and provides the +value to the incremental module. + +Note that the example below is not a complete Heat Orchestration +Template. The {network-role} has been defined as oam to represent an oam +network and the {vm-type} has been defined as dns. + +base_MODULE.yaml + +.. code-block:: yaml + + parameters: + . . . + resources: + DNS_SECURITY_GROUP: + type: OS::Neutron::SecurityGroup + properties: + description: vDNS security group + name: + str_replace: + template: VNF_NAME_sec_grp_DNS + params: + VMF_NAME: {get_param: vnf_name} + rules: [. . . . . + ] + . . . + outputs: + dns_sec_grp_id: + description: UUID of DNS Resource SecurityGroup + value: { get_resource: DNS_SECURITY_GROUP } + +INCREMENTAL_MODULE.yaml + +.. code-block:: yaml + + parameters: + dns_sec_grp_id: + type: string + description: security group UUID + . . . + + resources: + dns_0_oam_0_port: + type: OS::Neutron::Port + properties: + name: + str_replace: + template: VNF_NAME_dns_oam_port + params: + VNF_NAME: {get_param: vnf_name} + network: { get_param: oam_net_name } + fixed_ips: [{ "ip_address": { get_param: dns_oam_ip_0 }}] + security_groups: [{ get_param: dns_sec_grp_id }] + +*Examples: Base Module creates an internal network* + +A VNF has a base module, named base_module.yaml, that creates an +internal network. An incremental module, named incremental_module.yaml, +will create a VM that will connect to the internal network. The base +module defines a parameter in the out section named int_oam_net_id. +int_oam_net_id is defined as a parameter in the incremental module. +ONAP captures the UUID value of int_oam_net_id from the base module +output statement and provides the value to the incremental module. + +Note that the example below is not a complete Heat Orchestration +Template. The {network-role} has been defined as oam to represent an oam +network and the {vm-type} has been defined as lb for load balancer. + +base.yaml + +.. code-block:: yaml + + heat_template_version: 2013-05-23 + + resources: + int_oam_network: + type: OS::Neutron::Network + properties: + name: {… } + . . . + + outputs: + int_oam_net_id: + value: {get_resource: int_oam_network } + +incremental.yaml + +.. code-block:: yaml + + heat_template_version: 2013-05-23 + + parameters: + int_oam_net_id: + type: string + description: ID of shared private network from Base template + lb_name_0: + type: string + description: name for the add-on VM instance + + resources: + lb_server_0: + type: OS::Nova::Server + properties: + name: {get_param: lb_name_0} + networks: + - port: { get_resource: get_resource: lb_0_int_oam_port_0 } + . . . + lb_0_int_oam_port_0: + type: OS::Neutron::Port + properties: + network: { get_param: int_oam_net_id } + ... + + +Cinder Volumes +^^^^^^^^^^^^^^^^^^^^^^^^ + +Cinder Volumes are created with the heat resource OS::Cinder::Volume. + +As stated in R-46119, R-90748, R-03251, a VNF's Heat Orchestration +Template's Resource OS::Heat::CinderVolume **MAY** be defined in a +Base Module, Incremental Module, or Cinder Volume Module. + +ONAP supports the independent deployment of a Cinder volume via separate +Heat Orchestration Templates, the Cinder Volume module. This allows the +volume to persist after VNF deletion so that they can be reused on +another instance (e.g., during a failover activity). + +A Base Module or Incremental Module may have a corresponding volume +module. Use of separate volume modules is optional. A Cinder volume may +be embedded within the Base Module or Incremental Module if persistence +is not required. + +If a VNF Base Module or Incremental Module has an independent volume +module, the scope of volume templates must be 1:1 with Base module or +Incremental module. A single volume module must create only the volumes +required by a single Incremental module or Base module. + +R-47788 The VNF Heat Orchestration Template **MUST** have a 1:1 +scope of a cinder volume module, when it exists, with the +Base Module or Incremental Module. + +As stated in R-11200, a VNF's Cinder Volume Module, when it exists, +**MUST** be 1:1 with a Base module or Incremental module. That is, +A single volume module must create only the volumes required by a +single Incremental module or Base module. + +As stated in R-30395, a VNF's Cinder Volume Module **MAY** utilize +nested heat. + +As stated in R-89913, a VNF's Heat Orchestration Template's Cinder Volume +Module Output Parameter(s) **MUST** include the +UUID(s) of the Cinder Volumes created in template, +while others **MAY** be included. + +As stated in R-07443, a VNF's Heat Orchestration Templates' Cinder Volume +Module Output Parameter's name and type **MUST** match the input parameter +name and type in the corresponding Base Module or Incremental Module unless +the Output Parameter is of the type 'comma_delimited_list', +then the corresponding input parameter **MUST** be declared as type 'json'. + +A single volume module must create only the volumes +required by a single Incremental module or Base module. + +The following rules apply to independent volume Heat templates: + +- R-79531 The VNF Heat Orchestration Template **MUST** define + "outputs" in the volume template for each Cinder volume + resource universally unique identifier (UUID) (i.e. ONAP + Volume Template Output Parameters). + +- The VNF Incremental Module or Base Module must define input + parameters that match each Volume output parameter (i.e., ONAP Volume + Template Output Parameters). + + - ONAP will supply the volume template outputs automatically to the + bases/incremental template input parameters. + +- Volume modules may utilize nested Heat templates. + +Optional Property availability_zone +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +R-25190 A VNF's Heat Orchestration Template's Resource 'OS::Cinder::Volume' +**SHOULD NOT** declare the property 'availability_zone'. + +If the property is used, the value **MUST** +be enumerated in the environment file and must be set to nova', which +is the default. There are no requirements on the parameter naming +convention with the exception that the naming convention **MUST NOT** be the +same as the 'OS::Nova::Server' property 'availability_zone' (i.e., +'availability_zone_{index}'). + +Optional Property volume_type +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +OpenStack supports multiple volume types. If the OS::Cinder::Volume optional +property volume_type is not specified, the OpenStack default volume type is +used. If a specific volume type is required, the property is used and +the value **MUST** be enumerated in the environment file. There are no +requirements on the parameter naming convention + +Cinder Volume Examples +~~~~~~~~~~~~~~~~~~~~~~~~~ + +*Examples: Volume Template* + +A VNF has a Cinder volume module, named incremental\_volume.yaml, that +creates an independent Cinder volume for a VM in the module +incremental.yaml. The incremental\_volume.yaml defines a parameter in +the output section, lb\_volume\_id\_0 which is the UUID of the cinder +volume. lb\_volume\_id\_0 is defined as a parameter in incremental.yaml. +ONAP captures the UUID value of lb\_volume\_id\_0 from the volume module +output statement and provides the value to the incremental module. + +Note that the example below is not a complete Heat Orchestration +Template. The {vm-type} has been defined as "lb" for load balancer + +incremental\_volume.yaml + +.. code-block:: yaml + + parameters: + vnf_name: + type: string + lb_volume_size_0: + type: number + ... + + resources: + dns_volume_0: + type: OS::Cinder::Volume + properties: + name: + str_replace: + template: VNF_NAME_volume_0 + params: + VNF_NAME: { get_param: vnf_name } + size: {get_param: dns_volume_size_0} + ... + + outputs: + lb_volume_id_0: + value: {get_resource: dns_volume_0} + ... + + +incremental.yaml + +.. code-block:: yaml + + parameters: + lb_name_0: + type: string + lb_volume_id_0: + type: string + ... + + resources: + lb_0: + type: OS::Nova::Server + properties: + name: {get_param: dns_name_0} + networks: + ... + + lb_0_volume_attach: + type: OS::Cinder::VolumeAttachment + properties: + instance_uuid: { get_resource: lb_0 } + volume_id: { get_param: lb_volume_id_0 } + +ONAP Support of Environment Files +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The use of an environment file in OpenStack is optional. In ONAP, it is +mandatory. A Heat Orchestration Template uploaded to ONAP must have a +corresponding environment file, even if no parameters are required to +be enumerated. + +(Note that ONAP does not programmatically enforce the use of +an environment file.) + +R-67205 The VNF Heat Orchestration Template **MUST** have a corresponding +environment file for a Base Module. + +R-35727 The VNF Heat Orchestration Template **MUST** have a +corresponding environment file for an Incremental module. + +R-22656 The VNF Heat Orchestration Template **MUST** have a +corresponding environment file for a Cinder Volume Module. + +A nested heat template must not have an environment file; OpenStack does +not support it. + +The environment file must contain parameter values for the ONAP +Orchestration Constants and VNF Orchestration Constants. These +parameters are identical across all instances of a VNF type, and +expected to change infrequently. The ONAP Orchestration Constants are +associated with OS::Nova::Server image and flavor properties (See +`Property: image`_ and `Property: flavor`_). Examples of VNF +Orchestration Constants are the networking parameters associated +with an internal network (e.g., private IP ranges) and Cinder +volume sizes. + +The environment file must not contain parameter values for parameters +that are instance specific (ONAP Orchestration Parameters, VNF +Orchestration Parameters). These parameters are supplied to the Heat by +ONAP at orchestration time. + +SDC Treatment of Environment Files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Parameter values enumerated in the environment file are used by SDC as +the default value. However, the SDC user may use the SDC GUI to +overwrite the default values in the environment file. + +SDC generates a new environment file for distribution to SO based on +the uploaded environment file and the user provided GUI updates. The +user uploaded environment file is discarded when the new file is +created. Note that if the user did not change any values via GUI +updates, the SDC generated environment file will contain the same values +as the uploaded file. + +Use of Environment Files when using OpenStack "heat stack-create" CLI +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When ONAP is instantiating the Heat Orchestration Template, certain +parameter must not be enumerated in the environment file. This document +provides the details of what parameters should not be enumerated. + +If the Heat Orchestration Template is to be instantiated from the +OpenStack Command Line Interface (CLI) using the command "heat +stack-create", all parameters must be enumerated in the environment +file. + +Heat Template Constructs +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Nested Heat Templates +~~~~~~~~~~~~~~~~~~~~~ + +ONAP supports nested Heat templates per the OpenStack specifications. +Nested templates may be suitable for larger VNFs that contain many +repeated instances of the same VM type(s). A common usage pattern is to +create a nested template for each {vm-type} along with its supporting +resources. The VNF module may then reference these component templates +either statically by repeated definition or dynamically by using the +resource OS::Heat::ResourceGroup. + +Nested Heat Template Requirements +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ONAP supports nested Heat Orchestration Templates. A Base Module, +Incremental Module, and Cinder Volume Module may use nested heat. + +R-00228 A VNF's Heat Orchestration Template **MAY** +reference the nested heat statically by repeated definition. + +R-01101 A VNF's Heat Orchestration Template **MAY** +reference the nested heat dynamically using the resource +'OS::Heat::ResourceGroup'. + +R-60011 A VNF's Heat Orchestration Template **MUST** have no more than +two levels of nesting. + +R-70112 A VNF's Heat Orchestration Template **MUST** +reference a Nested YAML file by name. +The use of 'resource_registry' in the VNF's Heat Orchestration +Templates Environment File **MUST NOT** be used. + +Two levels of nesting is defined as follows: A base module, incremental +module, or cinder volume module references a nested heat file either +statically or by using the resource 'OS::Heat::ResourceGroup'. +This file is the first level of nesting. +If first level file then references a nested file, that file is +the second level of nesting. + +R-89868 The VNF Heat Orchestration Template **MUST** have unique +file names within the scope of the VNF for a nested heat yaml file. + +R-52530 A VNF's Heat Orchestration Template's Nested YAML file +**MUST** be in the same directory hierarchy as the VNF's Heat +Orchestration Templates. + +R-90022 A VNF's Nested YAML file **MAY** be invoked more than +once by a VNF's Heat Orchestration Template. + +R-04344 A VNF's Nested YAML file **MAY** be invoked by more than one of +a VNF's Heat Orchestration Templates (when the VNF is composed of two +or more Heat Orchestration Templates). + +Note that: + +- R-11041 All parameters defined in a VNFs Nested YAML file + **MUST** be passed in as properties of the resource calling + the nested yaml file. + +- As stated in requirement R-00011, a VNF's Heat Orchestration + Template's Nested YAML file's parameter's **MUST NOT** have + a parameter constraint defined. + +- As stated in Requirement R-44491, if a VNF's Heat Orchestration + Template's OS::Nova::Server Resource metadata map value parameter + 'vnf\_id' is passed into a Nested YAML + file, the parameter name 'vnf\_id' **MUST NOT** change. + +- As stated in Requirement R-86237, if a VNF's Heat Orchestration + Template's OS::Nova::Server Resource metadata map value parameter + 'vf\_module\_id' is passed into a Nested YAML + file, the parameter name 'vf\_module\_id' **MUST NOT** change. + +- As stated in Requirement R-16576, if a VNF's Heat Orchestration + Template's OS::Nova::Server Resource metadata map value parameter + 'vnf\_name' is passed into a Nested YAML + file, the parameter name 'vnf\_name' **MUST NOT** change. + +- As stated in Requirement R-49177, if a VNF's Heat Orchestration + Template's OS::Nova::Server Resource metadata map value parameter + 'vf\_module\_name' is passed into a Nested YAML + file, the parameter name 'vf\_module\_name' **MUST NOT** change. + +- As stated in Requirement R-70757, if a VNF's Heat Orchestration + Template's OS::Nova::Server Resource metadata map value parameter + 'vm\_role' is passed into a Nested YAML + file, the parameter name 'vm\_role' **MUST NOT** change. + +- As stated in Requirement R-22441, if a VNF's Heat Orchestration + Template's OS::Nova::Server Resource metadata map value parameter + 'vf\_module\_index' is passed into a Nested YAML + file, the parameter name 'vf\_module\_index' **MUST NOT** change. + +- As stated in Requirement R-75202, if a VNF's Heat Orchestration + Template's OS::Nova::Server Resource metadata map value parameter + 'workload\_context' is passed into a Nested YAML + file, the parameter name 'workload\_context' **MUST NOT** change. + +- As stated in Requirement R-62954, if a VNF's Heat Orchestration + Template's OS::Nova::Server Resource metadata map value parameter + 'environment\_context' is passed into a Nested YAML + file, the parameter name 'environment\_context' **MUST NOT** change. + +- With nested templates, outputs are required to expose any resource + properties of the child templates to the parent template. Those would + not explicitly be declared as parameters but simply referenced as + get\_attribute targets against the "parent" resource. + +- A parameter declared in the outputs: section of a nested template can + be accessed from the parent template as an attribute (i.e., via + get\_attr) of the "pseudo resource" whose type is in the nested + template. In the case of a OS::Heat::ResourceGroup, an output will be + an attribute of the OS::Heat::ResourceGroup itself, and will be an + array from the perspective of the parent template. + +Nested Heat Template Example: Static +++++++++++++++++++++++++++++++++++++++ + +incremental.yaml + +.. code-block:: yaml + + Resources: + dns_server_0: + type: nested.yaml + properties: + dns_image_name: { get_param: dns_image_name } + dns_flavor_name: { get_param: dns_flavor_name } + availability_zone: { get_param: availability_zone_0 } + security_group: { get_param: DNS_shared_sec_grp_id } + oam_net_id: { get_param: oam_protected_net_id } + dns_oam_ip: { get_param: dns_oam_ip_0 } + dns_name: { get_param: dns_name_0 } + vnf_name: { get_param: vnf_name } + vnf_id: { get_param: vnf_id } + vf_module_id: {get_param: vf_module_id} + + dns_server_1: + type: nested.yaml + properties: + dns_image_name: { get_param: dns_image_name } + dns_flavor_name: { get_param: dns_flavor_name } + availability_zone: { get_param: availability_zone_1 } + security_group: { get_param: DNS_shared_sec_grp_id } + oam_net_id: { get_param: oam_protected_net_id } + dns_oam_ip: { get_param: dns_oam_ip_1 } + dns_name: { get_param: dns_name_1 } + vnf_name: { get_param: vnf_name } + vnf_id: { get_param: vnf_id } + vf_module_id: {get_param: vf_module_id} + +nested.yaml + +.. code-block:: yaml + + dns_oam_0_port: + type: OS::Neutron::Port + properties: + name: + str_replace: + template: VNF_NAME_dns_oam_port + params: + VNF_NAME: {get_param: vnf_name} + network: { get_param: oam_net_id } + fixed_ips: [{ "ip_address": { get_param: dns_oam_ip }}] + security_groups: [{ get_param: security_group }] + + dns_servers: + type: OS::Nova::Server + properties: + name: { get_param: dns_names } + image: { get_param: dns_image_name } + flavor: { get_param: dns_flavor_name } + availability_zone: { get_param: availability_zone } + networks: + - port: { get_resource: dns_oam_0_port } + metadata: + vnf_id: { get_param: vnf_id } + vf_module_id: { get_param: vf_module_id } + vnf_name {get_param: vnf_name } + +Use of Heat ResourceGroup ++++++++++++++++++++++++++ + +The OS::Heat::ResourceGroup is a useful Heat element for creating +multiple instances of a given resource or collection of resources. +Typically, it is used with a nested Heat template, to create, for +example, a set of identical OS::Nova::Server resources plus their +related OS::Neutron::Port resources via a single resource in a master +template. + +OS::Heat::ResourceGroup may be used to simplify the structure of a Heat +template that creates multiple instances of the same VM type. + +However, there are important caveats to be aware of: + +OS::Heat::ResourceGroup does not deal with structured parameters +(comma-delimited-list and json) as one might typically expect. In +particular, when using a list-based parameter, where each list element +corresponds to one instance of the ResourceGroup, it is not possible to +use the intrinsic "loop variable" %index% in the OS::Heat::ResourceGroup +definition. + +For instance, the following is **not** valid Heat for +OS::Heat::ResourceGroup: + +.. code-block:: yaml + + type: OS::Heat::ResourceGroup + resource_def: + type: my_nested_vm_template.yaml + properties: + name: {get_param: [vm_name_list, %index%]} + +Although this appears to use the nth entry of the vm_name_list list for +the nth element of the OS::Heat::ResourceGroup, it will in fact result +in a Heat exception. When parameters are provided as a list (one for +each element of a OS::Heat::ResourceGroup), you must pass the complete +parameter to the nested template along with the current index as +separate parameters. + +Below is an example of an **acceptable** Heat Syntax for a +ResourceGroup: + +.. code-block:: yaml + + type: OS::Heat::ResourceGroup + resource_def: + type: my_nested_vm_template.yaml + properties: + names: {get_param: vm_name_list} + index: %index% + +You can then reference within the nested template as: + +{ get\_param: [names, {get\_param: index} ] } + +OS::Heat::ResourceGroup Property count +________________________________________ + +R-50011 A VNF's Heat Orchestration Template's 'OS::Heat::ResourceGroup' +property 'count' **MUST** be enumerated in the VNF's +Heat Orchestration Template's Environment File and **MUST** be +assigned a value. + +This is required for ONAP to build the TOSCA model for the VNF. + +.. code-block:: yaml + + type: OS::Heat::ResourceGroup + properties: + count: { get_param: count } + index_var: index + resource_def: + type: my_nested_vm_template.yaml + properties: + names: {get_param: vm_name_list} + index: index + +Availability Zone and ResourceGroups +____________________________________ + +The resource OS::Heat::ResourceGroup and the property availability\_zone +has been an "issue" with a few VNFs since ONAP only supports +availability\_zone as a string parameter and not a +comma\_delimited\_list. This makes it difficult to use a +OS::Heat::ResourceGroup to create Virtual Machines in more +than one availability zone. + +There are numerous solutions to this issue. Below are two suggested +usage patterns. + +**Option 1:** create a CDL in the OS::Heat::ResourceGroup. In the +resource type: OS::Heat::ResourceGroup, create a comma\_delimited\_list +availability\_zones by using the intrinsic function list\_join. + +.. code-block:: yaml + + <resource name>: + type: OS::Heat::ResourceGroup + properties: + count: { get_param: node_count } + index_var: index + resource_def: + type: nested.yaml + properties: + index: index + avaialability_zones: { list_join: [',', [ { get_param: availability_zone_0 }, { get_param: availability_zone_1 } ] ] } + +In the nested heat + +.. code-block:: yaml + + parameters: + avaialability_zones: + type: comma_delimited_list + description: + + resources: + servers: + type: OS::Nova::Server + properties: + name: { get_param: [ dns_names, get_param: index ] } + image: { get_param: dns_image_name } + flavor: { get_param: dns_flavor_name } + availability_zone: { get_param: [ avaialability_zones, get_param: index ] } + +**Option 2:** Create a CDL by passing the availability zone parameter +into a nested heat template. An example is provided below. + +base.yaml + +.. code-block:: yaml + + availability_zone_list: + type: az_list_generate.yaml + properties: + availability_zone_0: { get_param: availability_zone_0 } + availability_zone_1: { get_param: availability_zone_1 } + + create_virtual_machines: + type: OS::Heat::ResourceGroup + properties: + count: { get_param: count } + index_var: $INDEX + resource_def: + type: nest_file.yaml + properties: + index: $INDEX + availability_zone_0 : { get_attr: [availability_zone_list, general_zones ] } + . . . + +az_list_generate.yaml + +.. code-block:: yaml + + parameters: + availability_zone_0: + type: string + description: availability zone 0 + + availability_zone_1: + type: string + description: availability zone 1 + + outputs: + + general_zones: + value: [ + { get_param: availability_zone_0 }, + { get_param: availability_zone_1 }, + { get_param: availability_zone_0 }, + { get_param: availability_zone_1 }, + { get_param: availability_zone_0 }, + { get_param: availability_zone_1 }, + ] + + +Nested Heat Template Example: OS::Heat::ResourceGroup +_________________________________________________________ + +In this example, ocgapp\_volume.yml creates volumes using a +OS::Heat::ResourceGroup that uses nested heat by calling +ocgapp_nested_volume.yml. ocgapp\_volume.yml has an outputs: parameter +ocgapp\_volume\_ids which is declared a input parameter of type: json in +ocgapp\_volume.yml. + + +This is an example of requirement R-07443, where +a VNF's Heat Orchestration Templates' Cinder Volume Module Output +Parameter's name and type **MUST** match the input parameter name and type +in the corresponding Base Module or Incremental Module unless the Output +Parameter is of the type 'comma\_delimited\_list', then the corresponding +input parameter **MUST** be declared as type 'json'. + +ocgapp\_volume.yml + +.. code-block:: yaml + + heat_template_version: 2014-10-16 + + description: Template for the volumes + + parameters: + vnf_name: + type: string + label: OCG VNF Name + description: OCG VNF Name + ocgapp_volume_size_0: + type: number + label: Cinder volume 1 size + description: the size of the Cinder volume + constraints: + - range: { min: 100, max: 400 } + ocgapp_volume_type_0: + type: string + label: app vm 1 volume type + description: the name of the target volume backend for the first OCG APP + volume_count: + type: number + label: volume count + description: number of volumes needed + + resources: + ocgapp_volume_resource_group: + type: OS::Heat::ResourceGroup + properties: + count: {get_param: volume_count} + index_var: index + resource_def: + type: ocgapp_nested_volume.yml + properties: + index: index + size: {get_param: ocgapp_volume_size_0} + volume_type: {get_param: ocgapp_volume_type_0} + vnf_name: {get_param: vnf_name} + + outputs: + ocgapp_volume_ids: + description: ocgapp volume ids + value: {get_attr: [ocgapp_volume_resource_group, ocgapp_volume_id_0]} + +ocgapp_nested_volume.yml + +.. code-block:: yaml + + heat_template_version: 2014-10-16 + + description: nested heat + + parameters: + index: + type: number + label: Volume Index + description: number of volumes to spin up + size: + type: number + label: Volume Size + description: size of the cinder volumes + volume_type: + type: string + label: Volume Type + description: type of cinder volumes + vnf_name: + type: string + label: VNF Name + description: vnf name + + resources: + ocgapp_volume_0: + type: OS::Cinder::Volume + properties: + size: {get_param: size} + volume_type: {get_param: volume_type} + name: + str_replace: + template: VF_NAME_STACK_NAME_INDEX + params: + VF_NAME: { get_param: vnf_name } + STACK_NAME: { get_param: 'OS::stack_name' } + INDEX: {get_param: index} + + outputs: + ocgapp_volume_id_0: + description: the ocgapp volume uuid + value: {get_resource: ocgapp_volume_0} + +The heat template below is a partial heat template, + +ocgapp.yml + +.. code-block:: yaml + + heat_template_version: 2014-10-16 + + #file version 1.0 + description: OCG Apps template + + parameters: + ocgapp_volume_ids: + type: json + description: Unique IDs for volumes + + resources: + ocgapp_server_0: + type: OS::Nova::Server + properties: + . . . . + ocgapp_server_1: + type: OS::Nova::Server + properties: + . . . . + ocgapp_volume_attachment_0: + type: OS::Cinder::VolumeAttachment + properties: + volume_id: {get_param: [ocgapp_volume_ids, 0]} + instance_uuid: {get_resource: ocgapp_server_0} + ocgapp_volume_attachment_1: + type: OS::Cinder::VolumeAttachment + properties: + volume_id: {get_param: [ocgapp_volume_ids, 1]} + instance_uuid: {get_resource: ocgapp_server_1} + +External References +~~~~~~~~~~~~~~~~~~~ + +Heat templates *should not* reference any HTTP-based resource +definitions, any HTTP-based nested configurations, or any HTTP-based +environment files. + +- During orchestration, ONAP *should not* retrieve any such resources + from external/untrusted/unknown sources. + +- VNF images should not contain such references in user-data or other + configuration/operational scripts that are specified via Heat or + encoded into the VNF image itself. + +*Note:* HTTP-based references are acceptable if the HTTP-based reference +is accessing information with the VM private/internal network. + +Note that Namespaces in XML (defined at +http://www.w3.org/TR/2009/REC-xml-names-20091208/) are allowed if the +Heat Orchestration Template is describing and storing software +configuration information. An XML namespace is identified by a URI +reference. A Uniform Resource Identifier (URI) is a string of characters +which identifies an Internet Resource. The most common URI is the +Uniform Resource Locator (URL) which identifies an Internet domain +address. Another, not so common type of URI is the Universal Resource +Name (URN). The namespace URI is not used by XML the parser to look up +information. The purpose of using an URI is to give the namespace a +unique name. + +Heat Files Support (get\_file) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Heat Templates may contain the inclusion of text files into Heat +templates via the Heat get\_file directive. This may be used, for +example, to define a common "user-data" script, or to inject files into +a VM on startup via the "personality" property. + +Support for Heat Files is subject to the following limitations: + +R-76718 If a VNF's Heat Orchestration Template uses the intrinsic function +'get\_file', the 'get\_file' target **MUST** be referenced in +the Heat Orchestration Template by file name. + +The 'get\_file' target files are on-boarded to SDC in the same package +that contains the VNF's complete Heat Orchestration Template. + +R-41888 A VNF's Heat Orchestration Template intrinsic function +'get\_file' **MUST NOT** utilize URL-based file retrieval. + +R-62177 When using the intrinsic function get_file, the included files +**MUST** have unique file names within the scope of the VNF. + +R-87848 A VNF's Heat Orchestration Template's 'get\_file' target files +**MUST** be in the same directory hierarchy as the VNF's Heat +Orchestration Templates. + +ONAP does not support a hierarchical structure. A VNF's YAML files +must be in a single, flat directory. + +R-05050 A VNF's Heat Orchestration Templates intrinsic function +'get\_file' <content key> **MAY** be used: + + * more than once in a VNF's Heat Orchestration Template + * in two or more of a VNF's Heat Orchestration Templates + * in a VNF's Heat Orchestration Templates nested YAML file + +Key Pairs +~~~~~~~~~ + +When Nova Servers are created via Heat templates, they may be passed a +"keypair" which provides an ssh key to the 'root' login on the newly +created VM. This is often done so that an initial root key/password does +not need to be hard-coded into the image. + +Key pairs are unusual in OpenStack, because they are the one resource +that is owned by an OpenStack User as opposed to being owned by an +OpenStack Tenant. As a result, they are usable only by the User that +created the keypair. This causes a problem when a Heat template attempts +to reference a keypair by name, because it assumes that the keypair was +previously created by a specific ONAP user ID. + +When a keypair is assigned to a server, the SSH public-key is +provisioned on the VMs at instantiation time. They keypair itself is not +referenced further by the VM (i.e. if the keypair is updated with a new +public key, it would only apply to subsequent VMs created with that +keypair). + +Due to this behavior, the recommended usage of keypairs is in a more +generic manner which does not require the pre-requisite creation of a +keypair. The Heat should be structured in such a way as to: + +- Pass a public key as a parameter value instead of a keypair name + +- Create a new keypair within The VNF Heat Orchestration Template (in the + base module) based on an existing public key for use within that VNF + +By following this approach, the end result is the same as pre-creating +the keypair using the public key – i.e., that public key will be +provisioned in the new VM. However, this recommended approach also makes +sure that a known public key is supplied (instead of having OpenStack +generate a public/private pair to be saved and tracked outside of ONAP). +It also removes any access/ownership issues over the created keypair. + +The public keys may be enumerated as a VNF Orchestration Constant in the +environment file (since it is public, it is not a secret key), or passed +at run-time as instance-specific parameters. ONAP will never +automatically assign a public/private key pair. + +*Example (create keypair with an existing ssh public-key for {vm-type} +of lb (for load balancer)):* + +.. code-block:: yaml + + parameters: + vnf_name: + type: string + lb_ssh_public_key: + type: string + + resources: + my_keypair: + type: OS::Nova::Keypair + properties: + name: + str_replace: + template: VNF_NAME_key_pair + params: + VNF_NAME: { get_param: vnf_name } + public_key: {get_param: lb_ssh_public_key} + save_private_key: false + +Security Groups +~~~~~~~~~~~~~~~ + +OpenStack allows a tenant to create Security groups and define rules +within the security groups. + +Security groups, with their rules, may either be created in the Heat +Orchestration Template or they can be pre-created in OpenStack and +referenced within the Heat template via parameter(s). There can be a +different approach for security groups assigned to ports on internal +(intra-VNF) networks or external networks (inter-VNF). Furthermore, +there can be a common security group across all VMs for a specific +network or it can vary by VM (i.e., {vm-type}) and network type (i.e., +{network-role}). + +Anti-Affinity and Affinity Rules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Anti-affinity or affinity rules are supported using normal OpenStack +OS::Nova::ServerGroup resources. Separate ServerGroups are typically +created for each VM type to prevent them from residing on the same host, +but they can be applied to multiple VM types to extend the +affinity/anti-affinity across related VM types as well. + +*Example:* + +In this example, the {network-role} has been defined as oam to represent +an oam network and the {vm-type} have been defined as lb for load +balancer and db for database. + +.. code-block:: yaml + + resources: + db_server_group: + type: OS::Nova::ServerGroup + properties: + name: + str_replace: + params: + $vnf_name: {get_param: vnf_name} + template: $vnf_name-server_group1 + policies: + - anti-affinity + + lb_server_group: + type: OS::Nova::ServerGroup + properties: + name: + str_replace: + params: + $vnf_name: {get_param: vnf_name} + template: $vnf_name-server_group2 + policies: + - affinity + + db_0: + type: OS::Nova::Server + properties: + ... + scheduler_hints: + group: {get_resource: db_server_group} + + db_1: + type: OS::Nova::Server + properties: + ... + scheduler_hints: + group: {get_resource: db_server_group} + + lb_0: + type: OS::Nova::Server + properties: + ... + scheduler_hints: + group: {get_resource: lb_server_group} + +Resource Data Synchronization +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +For cases where synchronization is required in the orchestration of Heat +resources, two approaches are recommended: + +- Standard Heat depends\_on property for resources + + - Assures that one resource completes before the dependent resource + is orchestrated. + + - Definition of completeness to OpenStack may not be sufficient + (e.g., a VM is considered complete by OpenStack when it is ready + to be booted, not when the application is up and running). + +- Use of Heat Notifications + + - Create OS::Heat::WaitCondition and OS::Heat::WaitConditionHandle + resources. + + - Pre-requisite resources issue *wc\_notify* commands in user\_data. + + - Dependent resource define depends\_on in the + OS::Heat::WaitCondition resource. + +*Example: "depends\_on" case* + +In this example, the {network-role} has been defined as oam to represent +an oam network and the {vm-type} has been defined as oam to represent an +oam server. + +.. code-block:: yaml + + resources: + oam_server_01: + type: OS::Nova::Server + properties: + name: {get_param: [oam_ names, 0]} + image: {get_param: oam_image_name} + flavor: {get_param: oam_flavor_name} + availability_zone: {get_param: availability_zone_0} + networks: + - port: {get_resource: oam01_port_0} + - port: {get_resource: oam01_port_1} + user_data: + scheduler_hints: {group: {get_resource: oam_servergroup}} + user_data_format: RAW + + oam_01_port_0: + type: OS::Neutron::Port + properties: + network: {get_resource: oam_net_name} + fixed_ips: [{"ip_address": {get_param: [oam_oam_net_ips, 1]}}] + security_groups: [{get_resource: oam_security_group}] + + oam_01_port_1: + type: OS::Neutron::Port + properties: + network: {get_param: oam_net_name} + fixed_ips: [{"ip_address": {get_param: [oam_oam_net_ips, 2]}}] + security_groups: [{get_resource: oam_security_group}] + + oam_01_vol_attachment: + type: OS::Cinder::VolumeAttachment + depends_on: oam_server_01 + properties: + volume_id: {get_param: oam_vol_1} + mountpoint: /dev/vdb + instance_uuid: {get_resource: oam_server_01} + +High Availability +^^^^^^^^^^^^^^^^^ + +VNF/VM parameters may include availability zone IDs for VNFs that +require high availability. + +The Heat must comply with the following requirements to specific +availability zone IDs: + +- The Heat template should spread Nova resources across the + availability zones as desired + +Post Orchestration & VNF Configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Heat templates should contain a minimum amount of post-orchestration +configuration data. For instance, *do not* embed complex user-data +scripts in the template with large numbers of configuration parameters +to the Heat template. + +- VNFs may provide configuration APIs for use after VNF creation. Such + APIs will be invoked via application and/or SDN controllers. + +*Note:* It is important to follow this convention to the extent possible +even in the short-term as of the long-term direction. + diff --git a/docs/Chapter5/Tosca.rst b/docs/Chapter5/Tosca.rst new file mode 100644 index 0000000..3dbc2f3 --- /dev/null +++ b/docs/Chapter5/Tosca.rst @@ -0,0 +1,813 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +TOSCA YAML +---------- + + +Introduction +^^^^^^^^^^^^ + +This reference document is the VNF TOSCA Template Requirements for +ONAP, which provides recommendations and standards for building VNF +TOSCA templates compatible with ONAP initial implementations of +Network Cloud. It has the following features: + +1. VNF TOSCA template designer supports GUI and CLI. + +2. VNF TOSCA template is aligned to the newest TOSCA protocol, “Working + Draft 04-Revision 06”. + +3. VNF TOSCA template supports HPA features, such as NUMA, Hyper + Threading, SRIOV， etc. + +Intended Audience +^^^^^^^^^^^^^^^^^^ + +This document is intended for persons developing VNF TOSCA templates +that will be orchestrated by ONAP. + +Scope +^^^^^^^^^^^^^^^^ + +ONAP implementations of Network Cloud supports TOSCA Templates, also +referred to as TOSCA in this document. + +ONAP requires the TOSCA Templates to follow a specific format. This +document provides the mandatory, recommended, and optional requirements +associated with this format. + +Overview +^^^^^^^^^^^^^^^^ + +The document includes three charters to help the VNF providers to use the +VNF model design tools and understand the VNF package structure and VNF +TOSCA templates. + +In the ONAP, VNF Package and VNFD template can be designed by manually +or via model designer tools. VNF model designer tools can provide the +GUI and CLI tools for the VNF provider to develop the VNF Package and VNFD +template. + +The VNF package structure is align to the NFV TOSCA protocol, and +supports CSAR + +The VNFD and VNF package are all align to the NFV TOSCA protocol, which +supports multiple TOSCA template yaml files, and also supports +self-defined node or other extensions. + +NFV TOSCA Template +^^^^^^^^^^^^^^^^^^^^ + +TOSCA templates supported by ONAP must follow the requirements +enumerated in this section. + +TOSCA Introduction +^^^^^^^^^^^^^^^^^^^ + +TOSCA defines a Meta model for defining IT services. This Meta model +defines both the structure of a service as well as how to manage it. A +Topology Template (also referred to as the topology model of a service) +defines the structure of a service. Plans define the process models that +are used to create and terminate a service as well as to manage a +service during its whole lifetime. + +A Topology Template consists of a set of Node Templates and Relationship +Templates that together define the topology model of a service as a (not +necessarily connected) directed graph. A node in this graph is +represented by a *Node Template*. A Node Template specifies the +occurrence of a Node Type as a component of a service. A *Node Type* +defines the properties of such a component (via *Node Type Properties*) +and the operations (via *Interfaces*) available to manipulate the +component. Node Types are defined separately for reuse purposes and a +Node Template references a Node Type and adds usage constraints, such as +how many times the component can occur. + +|image1| + +Figure 1: Structural Elements of Service Template and their Relations + +TOSCA Modeling Principles & Data Model +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section describing TOSCA modeling principles and data model for +NFV, which shall be based on [TOSCA-1.0] and [TOSCA-Simple-Profile-YAML +V1.0], or new type based on ETSI NFV requirements, etc. + +VNF Descriptor Template +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The VNF Descriptor (VNFD) describes the topology of the VNF by means of +ETSI NFV IFA011 [IFA011] terms such as VDUs, Connection Points, Virtual +Links, External Connection Points, Scaling Aspects, Instantiation Levels +and Deployment Flavours. + +The VNFD (VNF Descriptor) is read by both the NFVO and the VNFM. It +represents the contract & interface of a VNF and ensures the +interoperability across the NFV functional blocks. + +The main parts of the VNFD are the following: + +- VNF topology: it is modeled in a cloud agnostic way using virtualized + containers and their connectivity. Virtual Deployment Units (VDU) + describe the capabilities of the virtualized containers, such as + virtual CPU, RAM, disks; their connectivity is modeled with VDU + Connection Point Descriptors (VduCpd), Virtual Link Descriptors (Vld) + and VNF External Connection Point Descriptors (VnfExternalCpd); + +- VNF deployment aspects: they are described in one or more deployment + flavours, including instantiation levels, supported LCM operations, + VNF LCM operation configuration parameters, placement constraints + (affinity / antiaffinity), minimum and maximum VDU instance numbers, + and scaling aspect for horizontal scaling. + +The following table defines the TOSCA Type “derived from” values that +SHALL be used when using the TOSCA Simple Profile for NFV version 1.0 +specification [TOSCA-Simple-Profile-NFV-v1.0] for NFV VNFD with aggreed +changes from ETSI SOL001 draft. + ++---------------------+------------------------------------+-----------------+ +| **ETSI NFV Element**| **TOSCA VNFD** | **Derived from**| +| | | | +| **[IFA011]** | **[TOSCA-Simple-Profile-NFV-v1.0]**| | ++=====================+====================================+=================+ +| VNF | tosca.nodes.nfv.VNF | tosca.nodes.Root| ++---------------------+------------------------------------+-----------------+ +| Cpd (Connection | tosca.nodes.nfv.Cp | tosca.nodes.Root| +| Point) | tosca.nodes.nfv.Cp | tosca.nodes.Root| ++---------------------+------------------------------------+-----------------+ +| VduCpd (internal | tosca.nodes.nfv.VduCp | tosca.nodes.\ | +| connection point) | | nfv.Cp | ++---------------------+------------------------------------+-----------------+ +| VnfVirtualLinkDesc | tosca.nodes.nfv.VnfVirtualLink | tosca.nodes.Root| +| (Virtual Link) | | | ++---------------------+------------------------------------+-----------------+ +| VDU Virtual Storage | tosca.nodes.nfv.VDU.VirtualStorage | tosca.nodes.Root| ++---------------------+------------------------------------+-----------------+ +| VDU Virtual Compute | tosca.nodes.nfv.VDU.Compute | tosca.nodes.Root| ++---------------------+------------------------------------+-----------------+ +| Software Image | | | ++---------------------+------------------------------------+-----------------+ +| Deployment Flavour | | | ++---------------------+------------------------------------+-----------------+ +| Scaling Aspect | | | ++---------------------+------------------------------------+-----------------+ +| Element Group | | | ++---------------------+------------------------------------+-----------------+ +| Instantiation | | | +| Level | | | ++---------------------+------------------------------------+-----------------+ + + ++--------------------------------------------------------------------+ +| +--------------------------------------------------------------+ | +| | tosca\_definitions\_version: tosca\_simple\_yaml\_1\_0 | | +| | | | +| | description: VNFD TOSCA file demo | | +| | | | +| | imports: | | +| | | | +| | - TOSCA\_definition\_nfv\_1\_0.yaml | | +| | | | +| | - TOSCA\_definition\_nfv\_ext\_1\_0.yaml | | +| | | | +| | | **node\_types: | | +| | tosca.nodes.nfv.VNF.vOpenNAT: | | +| | derived\_from:** tosca.nodes.nfv.VNF | | +| | | **requirements: | | +| | **- **sriov\_plane: | | +| | capability:** tosca.capabilities.nfv.VirtualLinkable | | +| | | **node:** tosca.nodes.nfv.VnfVirtualLinkDesc | | +| | | **relationship:** tosca.relationships.nfv.VirtualLinksTo | | +| +--------------------------------------------------------------+ | ++====================================================================+ ++--------------------------------------------------------------------+ + +HPA Requirements +^^^^^^^^^^^^^^^^^^ + +1. SR-IOV Passthrought + +Definitions of SRIOV\_Port are necessary if VDU supports SR-IOV. Here is +an example. + ++------------------------------------------------+ +| node\_templates: | +| | +| vdu\_vNat: | +| | +| SRIOV\_Port: | +| | +| attributes: | +| | +| tosca\_name: SRIOV\_Port | +| | +| properties: | +| | +| virtual\_network\_interface\_requirements: | +| | +| - name: sriov | +| | +| support\_mandatory: false | +| | +| description: sriov | +| | +| requirement: | +| | +| SRIOV: true | +| | +| role: root | +| | +| description: sriov port | +| | +| layer\_protocol: ipv4 | +| | +| requirements: | +| | +| - virtual\_binding: | +| | +| capability: virtual\_binding | +| | +| node: vdu\_vNat | +| | +| relationship: | +| | +| type: tosca.relationships.nfv.VirtualBindsTo | +| | +| - virtual\_link: | +| | +| node: tosca.nodes.Root | +| | +| type: tosca.nodes.nfv.VduCpd | +| | +| substitution\_mappings: | +| | +| requirements: | +| | +| sriov\_plane: | +| | +| - SRIOV\_Port | +| | +| - virtual\_link | +| | +| node\_type: tosca.nodes.nfv.VNF.vOpenNAT | ++------------------------------------------------+ + +2. Hugepages + +Definitions of mem\_page\_size as one property shall be added to +Properties and set the value to large if one VDU node supports +huagepages. Here is an example. + ++----------------------------------+ +| node\_templates: | +| | +| vdu\_vNat: | +| | +| Hugepages: | +| | +| attributes: | +| | +| tosca\_name: Huge\_pages\_demo | +| | +| properties: | +| | +| mem\_page\_size:large | ++==================================+ ++----------------------------------+ + +3. NUMA (CPU/Mem) + +Likewise, we shall add definitions of numa to +requested\_additional\_capabilities if we wand VUD nodes to support +NUMA. Here is an example. + ++-------------------------------------------------+ +| topology\_template: | +| | +| node\_templates: | +| | +| vdu\_vNat: | +| | +| capabilities: | +| | +| virtual\_compute: | +| | +| properties: | +| | +| virtual\_memory: | +| | +| numa\_enabled: true | +| | +| virtual\_mem\_size: 2 GB | +| | +| requested\_additional\_capabilities: | +| | +| numa: | +| | +| support\_mandatory: true | +| | +| requested\_additional\_capability\_name: numa | +| | +| target\_performance\_parameters: | +| | +| hw:numa\_nodes: "2" | +| | +| hw:numa\_cpus.0: "0,1" | +| | +| hw:numa\_mem.0: "1024" | +| | +| hw:numa\_cpus.1: "2,3,4,5" | +| | +| hw:numa\_mem.1: "1024" | ++-------------------------------------------------+ + +4. Hyper-Theading + +Definitions of Hyper-Theading are necessary as one of +requested\_additional\_capabilities of one VUD node if that node +supports Hyper-Theading. Here is an example. + ++-------------------------------------------------------------+ +| topology\_template: | +| | +| node\_templates: | +| | +| vdu\_vNat: | +| | +| capabilities: | +| | +| virtual\_compute: | +| | +| properties: | +| | +| virtual\_memory: | +| | +| numa\_enabled: true | +| | +| virtual\_mem\_size: 2 GB | +| | +| requested\_additional\_capabilities: | +| | +| hyper\_threading: | +| | +| support\_mandatory: true | +| | +| requested\_additional\_capability\_name: hyper\_threading | +| | +| target\_performance\_parameters: | +| | +| hw:cpu\_sockets : "2" | +| | +| hw:cpu\_threads : "2" | +| | +| hw:cpu\_cores : "2" | +| | +| hw:cpu\_threads\_policy: "isolate" | ++-------------------------------------------------------------+ + +5. OVS+DPDK + +Definitions of ovs\_dpdk are necessary as one of +requested\_additional\_capabilities of one VUD node if that node +supports dpdk. Here is an example. + ++------------------------------------------------------+ +| topology\_template: | +| | +| node\_templates: | +| | +| vdu\_vNat: | +| | +| capabilities: | +| | +| virtual\_compute: | +| | +| properties: | +| | +| virtual\_memory: | +| | +| numa\_enabled: true | +| | +| virtual\_mem\_size: 2 GB | +| | +| requested\_additional\_capabilities: | +| | +| ovs\_dpdk: | +| | +| support\_mandatory: true | +| | +| requested\_additional\_capability\_name: ovs\_dpdk | +| | +| target\_performance\_parameters: | +| | +| sw:ovs\_dpdk: "true" | ++------------------------------------------------------+ + +NFV TOSCA Type Definition +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +tosca.capabilites.nfv.VirtualCompute +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This capability is used with the properties specified in ETSI SOL001 draft. + +tosca.nodes.nfv.VDU.Compute +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The NFV Virtualization Deployment Unit (VDU) compute node type +represents a VDU entity which it describes the deployment and +operational behavior of a VNF component (VNFC), as defined by **[ETSI +NFV IFA011].** + ++-----------------------+-------------------------------+ +| Shorthand Name | VDU.Compute | ++=======================+===============================+ +| Type Qualified Name | tosca:VDU.Compute | ++-----------------------+-------------------------------+ +| Type URI | tosca.nodes.nfv.VDU.Compute | ++-----------------------+-------------------------------+ +| derived\_from | tosca.nodes.Compute | ++-----------------------+-------------------------------+ + + + +Attributes +++++++++++++ + +None + + +Capabilities +++++++++++++++ + ++------------+--------------------+------------+------------------------------+ +| Name | Type | Constraints| Description | ++============+====================+============+==============================+ +| virtual\ | tosca.\ | | Describes virtual compute | +| _compute | capabilities.nfv.\ | | resources capabilities. | +| | VirtualCompute | | | ++------------+--------------------+------------+------------------------------+ +| monitoring\| tosca.\ | None | Monitoring parameter, which | +| _parameter | capabilities.nfv.\ | | can be tracked for a VNFC | +| | Metric | | based on this VDU | +| | | | | +| | | | Examples include: | +| | | | memory-consumption, | +| | | | CPU-utilisation, | +| | | | bandwidth-consumption, VNFC | +| | | | downtime, etc. | ++------------+--------------------+------------+------------------------------+ +| Virtual\ | tosca.\ | | Defines ability of | +| _binding | capabilities.nfv.\ | | VirtualBindable | +| | VirtualBindable | | | +| | | | | +| | editor note: need | | | +| | to create a | | | +| | capability type | | | ++------------+--------------------+------------+------------------------------+ + +Definition +++++++++++++ + ++-----------------------------------------------------------------------------+ +| tosca.nodes.nfv.VDU.Compute: | +| | +| derived\_from: tosca.nodes.Compute | +| | +| properties: | +| | +| name: | +| | +| type: string | +| | +| required: true | +| | +| description: | +| | +| type: string | +| | +| required: true | +| | +| boot\_order: | +| | +| type: list # explicit index (boot index) not necessary, contrary to IFA011 | +| | +| entry\_schema: | +| | +| type: string | +| | +| required: false | +| | +| nfvi\_constraints: | +| | +| type: list | +| | +| entry\_schema: | +| | +| type: string | +| | +| required: false | +| | +| configurable\_properties: | +| | +| type: map | +| | +| entry\_schema: | +| | +| type: tosca.datatypes.nfv.VnfcConfigurableProperties | +| | +| required: true | +| | +| attributes: | +| | +| private\_address: | +| | +| status: deprecated | +| | +| public\_address: | +| | +| status: deprecated | +| | +| networks: | +| | +| status: deprecated | +| | +| ports: | +| | +| status: deprecated | +| | +| capabilities: | +| | +| virtual\_compute: | +| | +| type: tosca.capabilities.nfv.VirtualCompute | +| | +| virtual\_binding: | +| | +| type: tosca.capabilities.nfv.VirtualBindable | +| | +| #monitoring\_parameter: | +| | +| # modeled as ad hoc (named) capabilities in VDU node template | +| | +| # for example: | +| | +| #capabilities: | +| | +| # cpu\_load: tosca.capabilities.nfv.Metric | +| | +| # memory\_usage: tosca.capabilities.nfv.Metric | +| | +| host: #Editor note: FFS. How this capabilities should be used in NFV Profile| +| | +| type: `*tosca.capabilities.Container* <#DEFN_TYPE_CAPABILITIES_CONTAINER>`__| +| | +| valid\_source\_types: | +| [`*tosca.nodes.SoftwareComponent* <#DEFN_TYPE_NODES_SOFTWARE_COMPONENT>`__] | +| | +| occurrences: [0,UNBOUNDED] | +| | +| endpoint: | +| | +| occurrences: [0,0] | +| | +| os: | +| | +| occurrences: [0,0] | +| | +| scalable: | +| #Editor note: FFS. How this capabilities should be used in NFV Profile | +| | +| type: `*tosca.capabilities.Scalable* <#DEFN_TYPE_CAPABILITIES_SCALABLE>`__ | +| | +| binding: | +| | +| occurrences: [0,UNBOUND] | +| | +| requirements: | +| | +| - virtual\_storage: | +| | +| capability: tosca.capabilities.nfv.VirtualStorage | +| | +| relationship: tosca.relationships.nfv.VDU.AttachedTo | +| | +| node: tosca.nodes.nfv.VDU.VirtualStorage | +| | +| occurences: [ 0, UNBOUNDED ] | +| | +| - local\_storage: #For NFV Profile, this requirement is deprecated. | +| | +| occurrences: [0,0] | +| | +| artifacts: | +| | +| - sw\_image: | +| | +| file: | +| | +| type: tosca.artifacts.nfv.SwImage | ++-----------------------------------------------------------------------------+ + +Artifact +++++++++++ + +Note: currently not supported. + ++--------+---------+----------------+------------+------------------------+ +| Name | Required| Type | Constraints| Description | ++========+=========+================+============+========================+ +| SwImage| Yes | tosca.\ | | Describes the software | +| | | artifacts.nfv.\| | image which is directly| +| | | SwImage | | realizing this virtual | +| | | | | storage | ++--------+---------+----------------+------------+------------------------+ + + +|image2| + + + +tosca.nodes.nfv.VDU.VirtualStorage +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The NFV VirtualStorage node type represents a virtual storage entity +which it describes the deployment and operational behavior of a virtual +storage resources, as defined by **[ETSI NFV IFA011].** + +**[editor note]** open issue: should NFV profile use the current storage +model as described in YAML 1.1. Pending on Shitao proposal (see +NFVIFA(17)000110 discussion paper) + +**[editor note]** new relationship type as suggested in Matt +presentation. Slide 8. With specific rules of “valid\_target\_type” + ++---------------------------+--------------------------------------+ +| **Shorthand Name** | VirtualStorage | ++===========================+======================================+ +| **Type Qualified Name** | tosca: VirtualStorage | ++---------------------------+--------------------------------------+ +| **Type URI** | tosca.nodes.nfv.VDU.VirtualStorage | ++---------------------------+--------------------------------------+ +| **derived\_from** | tosca.nodes.Root | ++---------------------------+--------------------------------------+ + +tosca.artifacts.nfv.SwImage +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ++---------------------------+------------------------------------+ +| **Shorthand Name** | SwImage | ++===========================+====================================+ +| **Type Qualified Name** | tosca:SwImage | ++---------------------------+------------------------------------+ +| **Type URI** | tosca.artifacts.nfv.SwImage | ++---------------------------+------------------------------------+ +| **derived\_from** | tosca.artifacts.Deployment.Image | ++---------------------------+------------------------------------+ + +Properties +++++++++++++ + ++-----------------+---------+----------+------------+-------------------------+ +| Name | Required| Type | Constraints| Description | ++=================+=========+==========+============+=========================+ +| name | yes | string | | Name of this software | +| | | | | image | ++-----------------+---------+----------+------------+-------------------------+ +| version | yes | string | | Version of this software| +| | | | | image | ++-----------------+---------+----------+------------+-------------------------+ +| checksum | yes | string | | Checksum of the software| +| | | | | image file | ++-----------------+---------+----------+------------+-------------------------+ +| container\ | yes | string | | The container format | +| _format | | | | describes the container | +| | | | | file format in which | +| | | | | software image is | +| | | | | provided. | ++-----------------+---------+----------+------------+-------------------------+ +| disk\_format | yes | string | | The disk format of a | +| | | | | software image is the | +| | | | | format of the underlying| +| | | | | disk image | ++-----------------+---------+----------+------------+-------------------------+ +| min\_disk | yes | scalar-\ | | The minimal disk size | +| | | unit.size| | requirement for this | +| | | | | software image. | ++-----------------+---------+----------+------------+-------------------------+ +| min\_ram | no | scalar-\ | | The minimal RAM | +| | | unit.size| | requirement for this | +| | | | | software image. | ++-----------------+---------+----------+------------+-------------------------+ +| Size | yes | scalar-\ | | The size of this | +| | | unit.size| | software image | ++-----------------+---------+----------+------------+-------------------------+ +| sw\_image | yes | string | | A reference to the | +| | | | | actual software image | +| | | | | within VNF Package, or | +| | | | | url. | ++-----------------+---------+----------+------------+-------------------------+ +| operating\ | no | string | | Identifies the operating| +| _system | | | | system used in the | +| | | | | software image. | ++-----------------+---------+----------+------------+-------------------------+ +| supported\ | no | list | | Identifies the | +| _virtualization\| | | | virtualization | +| _enviroment | | | | environments (e.g. | +| | | | | hypervisor) compatible | +| | | | | with this software image| ++-----------------+---------+----------+------------+-------------------------+ + +Definition ++++++++++++ + ++-----------------------------------------------------+ +| tosca.artifacts.nfv.SwImage: | +| | +| derived\_from: tosca.artifacts.Deployment.Image | +| | +| properties or metadata: | +| | +| #id: | +| | +| # node name | +| | +| name: | +| | +| type: string | +| | +| required: true | +| | +| version: | +| | +| type: string | +| | +| required: true | +| | +| checksum: | +| | +| type: string | +| | +| required: true | +| | +| container\_format: | +| | +| type: string | +| | +| required: true | +| | +| disk\_format: | +| | +| type: string | +| | +| required: true | +| | +| min\_disk: | +| | +| type: scalar-unit.size # Number | +| | +| required: true | +| | +| min\_ram: | +| | +| type: scalar-unit.size # Number | +| | +| required: false | +| | +| size: | +| | +| type: scalar-unit.size # Number | +| | +| required: true | +| | +| sw\_image: | +| | +| type: string | +| | +| required: true | +| | +| operating\_system: | +| | +| type: string | +| | +| required: false | +| | +| supported\_virtualisation\_environments: | +| | +| type: list | +| | +| entry\_schema: | +| | +| type: string | +| | +| required: false | ++-----------------------------------------------------+ + +.. |image1| image:: Image1.png + :width: 5.76806in + :height: 4.67161in +.. |image2| image:: Image2.png + :width: 5.40486in + :height: 2.46042in diff --git a/docs/Chapter5/VNFM-Driver-Development-Steps.rst b/docs/Chapter5/VNFM-Driver-Development-Steps.rst new file mode 100644 index 0000000..ac06e9c --- /dev/null +++ b/docs/Chapter5/VNFM-Driver-Development-Steps.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +VNFM Driver Development Steps +----------------------------- + +Refer to the ONAP documentation for VNF Provider instructions on integrating +vendor-specific VNFM adaptors with VF-C. The VNF driver development steps are +highlighted below. + +1. Use the VNF SDK tools to design the VNF with TOSCA models to output +the VNF TOSCA package. Using the VNF SDK tools, the VNF package can be +validated and tested. + +2. The VNF Provider supplies a vendor-specific VNFM driver in ONAP, which +is a microservice providing a translation interface from VF-C to +the vendor-specific VNFM. The interface definitions of vendor-specific +VNFM adaptors are supplied by the VNF Providers themselves. diff --git a/docs/Chapter5/index.rst b/docs/Chapter5/index.rst new file mode 100644 index 0000000..e5babb5 --- /dev/null +++ b/docs/Chapter5/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +VNF Modeling Requirements +========================= + +.. toctree:: + :maxdepth: 2 + + Tosca + Heat + VNFM-Driver-Development-Steps + Creating-Vendor-Specific-VNFM-Adaptor-Microservices diff --git a/docs/Chapter6.rst b/docs/Chapter6/index.rst index 381306d..f393135 100644 --- a/docs/Chapter6.rst +++ b/docs/Chapter6/index.rst @@ -2,7 +2,6 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. - Infrastructure Requirements =========================== diff --git a/docs/Chapter7.rst b/docs/Chapter7/Configuration-Management.rst index 3b53f23..075c005 100644 --- a/docs/Chapter7.rst +++ b/docs/Chapter7/Configuration-Management.rst @@ -2,322 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -ONAP Management Requirements -============================ - -The ONAP platform is the part of the larger Network Function -Virtualization/Software Defined Network (NFV/SDN) ecosystem that -is responsible for the efficient control, operation and management -of Virtual Network Function (VNF) capabilities and functions. It -specifies standardized abstractions and interfaces that enable -efficient interoperation of the NVF/SDN ecosystem components. It -enables product/service independent capabilities for design, creation -and runtime lifecycle management (includes all aspects of installation, -change management, assurance, and retirement) of resources in NFV/SDN -environment (see ECOMP white paper ). These capabilities are provided -using two major architectural frameworks: (1) a Design Time Framework -to design, define and program the platform (uniform onboarding), and -(2) a Runtime Execution Framework to execute the logic programmed in -the design environment (uniform delivery and runtime lifecycle -management). The platform delivers an integrated information model -based on the VNF package to express the characteristics and behavior -of these resources in the Design Time Framework. The information model -is utilized by Runtime Execution Framework to manage the runtime -lifecycle of the VNFs. The management processes are orchestrated -across various modules of ONAP to instantiate, configure, scale, -monitor, and reconfigure the VNFs using a set of standard APIs -provided by the VNF developers. - -Although the guidelines and requirements specified in this document -were originally driven by the need to standardize and automate the -management of the virtualized environments (with VNFs) operated by -Service Providers, we believe that most of the requirements are equally -applicable to the operation of the physical network functions (PNFs), -those network functions provided by traditional physical network -elements (e.g. whitebox switches) or customized peripherals (e.g. a -video rendering engine for augmented reality). The primary area of -difference will be in how the network function is orchestrated into -place – VNFs can be much more dynamically created & placed by ONAP -to support varying geographic, availability and scalability needs, -whereas the PNFs have to be deployed a priori in specific locations -based on planning and engineering – their availability and scalability -will be determined by the capabilities offered by the PNFs. - -**PNF** is a vendor-provided Network Function(s) implemented using a -bundled set of hardware and software while VNFs utilize cloud resources -to provide Network Functions through virtualized software modules. PNF -can be supplied by a vendor as a Black BOX (provides no knowledge of its -internal characteristics, logic, and software design/architecture) or as -a White Box (provides detailed knowledge and access of its internal -components and logic) or as a Grey Box (provides limited knowledge and -access to its internal components). - -* Requirements that equally apply to both VNFs and PNFs are defined as - "The xNF MUST/SHOULD/..." -* Requirements that only apply to VNFs are defined as "The VNF MUST/SHOULD/..." -* Requirements that only apply to PNFs are defined as "The PNF MUST/SHOULD/..." - - -Service Design ------------------------------------- - -This section, Service Design, has been left intentionally blank. It -is out-of-scope for the VNF Requirements project for the Amsterdam -release and no numbered requirements are expected. Content may be -added in future updates of this document. - -VNF On-boarding and package management ------------------------------------------------------------------------------ - -Design Definition -^^^^^^^^^^^^^^^^^^ - -The ONAP Design Time Framework provides the ability to design NFV -resources including VNFs, Services, and products. The VNF provider must -provide VNF packages that include a rich set of recipes, management and -functional interfaces, policies, configuration parameters, and -infrastructure requirements that can be utilized by the ONAP Design -module to onboard and catalog these resources. Initially this -information may be provided in documents, but in the near future a -method will be developed to automate as much of the transfer of data as -possible to satisfy its long term requirements. - -The current VNF Package Requirement is based on a subset of the -Requirements contained in the ETSI Document: ETSI GS NFV-MAN 001 v1.1.1 -and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization -(NFV), Management and Orchestration, VNF Packaging Specification. - -Resource Description -^^^^^^^^^^^^^^^^^^^^^^ - -* R-77707 The xNF provider **MUST** include a Manifest File that - contains a list of all the components in the xNF package. -* R-66070 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. -* R-69565 The xNF Package **MUST** include documentation describing xNF - Management APIs, which must include information and tools for ONAP to - deploy and configure (initially and ongoing) the xNF application(s) - (e.g., NETCONF APIs) which includes a description of configurable - parameters for the xNF and whether the parameters can be configured - after xNF instantiation. -* R-00156 The xNF Package **MUST** include documentation describing xNF - Management APIs, which must include information and tools for ONAP - to monitor the health of the xNF (conditions that require healing - and/or scaling responses). -* R-00068 The xNF Package **MUST** include documentation which 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. -* R-12678 The xNF Package **MUST** include documentation which includes a - description of runtime lifecycle events and related actions (e.g., - control responses, tests) which can be performed for the xNF. -* R-84366 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. -* R-36280 The xNF provider **MUST** provide documentation describing - xNF Functional Capabilities that are utilized to operationalize the - xNF and compose complex services. -* R-98617 The xNF provider **MUST** provide information regarding any - dependency (e.g., affinity, anti-affinity) with other xNFs and resources. - -Resource Configuration -^^^^^^^^^^^^^^^^^^^^^^^ - -* R-89571 The xNF **MUST** support and provide artifacts for configuration - management using at least one of the following technologies; - a) Netconf/YANG, b) Chef, or c) Ansible. - - Note: The requirements for Netconf/YANG, Chef, and Ansible protocols - are provided separately and must be supported only if the corresponding - protocol option is provided by the xNF providor. - -Configuration Management via NETCONF/YANG -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* R-30278 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. - -Configuration Management via Chef -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* R-13390 The xNF provider **MUST** provide cookbooks to be loaded - on the appropriate Chef Server. -* R-18525 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 Tables A1 and A2 in the Appendix. - - Note: Chef support in ONAP is not currently available and planned for 4Q 2017. - -Configuration Management via Ansible -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* R-75608 The xNF provider **MUST** provide playbooks to be loaded - on the appropriate Ansible Server. -* R-16777 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 Table B1 in the Appendix. - -* R-46567 The xNF Package **MUST** include configuration scripts - for boot sequence and configuration. -* R-16065 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). - -Resource Control Loop -^^^^^^^^^^^^^^^^^^^^^^^ - -* R-22888 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. -* R-01556 The xNF Package **MUST** include documentation describing the - fault, performance, capacity events/alarms and other event records - that are made available by the xNF. -* R-16875 The xNF Package **MUST** include documentation which 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. -* R-35960 The xNF Package **MUST** include documentation which must include - all events, severity level (e.g., informational, warning, error) and - descriptions including causes/fixes if applicable for the event. -* R-42018 The xNF Package **MUST** include documentation which must include - all events (fault, measurement for xNF Scaling, Syslogs, State Change - and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <http://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html#a-glossary>`__ ) and for the overall xNF. -* R-27711 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. -* R-01478 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. -* R-73560 The xNF Package **MUST** include documentation about monitoring - parameters/counters exposed for virtual resource management and xNF - application management. -* R-90632 The xNF Package **MUST** include documentation about KPIs and - metrics that need to be collected at each VM for capacity planning - and performance management purposes. -* R-86235 The xNF Package **MUST** include documentation about the monitoring - parameters that 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. -* R-33904 The xNF Package **MUST** include documentation for each KPI, provide - lower and upper limits. -* R-53598 The xNF Package **MUST** include documentation to, when relevant, - provide a threshold crossing alert point for each KPI and describe the - significance of the threshold crossing. -* R-69877 The xNF Package **MUST** include documentation for each KPI, - identify the suggested actions that need to be performed when a - threshold crossing alert event is recorded. -* R-22680 The xNF Package **MUST** include documentation that describes - any requirements for the monitoring component of tools for Network - Cloud automation and management to provide these records to components - of the xNF. -* R-33694 The xNF Package **MUST** include documentation to when applicable, - provide calculators needed to convert raw data into appropriate reporting - artifacts. -* R-56815 The xNF Package **MUST** include documentation describing - supported xNF scaling capabilities and capacity limits (e.g., number - of users, bandwidth, throughput, concurrent calls). -* R-48596 The xNF Package **MUST** include documentation describing - the characteristics for the xNF reliability and high availability. -* R-74763 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 <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__) - -Compute, Network, and Storage Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* R-35851 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. -* R-97102 The VNF Package **MUST** include VM requirements via a Heat - template that provides the necessary data for VM specifications - for all VNF components - for hypervisor, CPU, memory, storage. -* R-20204 The VNF Package **MUST** include VM requirements via a Heat - template that provides the necessary data for network connections, - interface connections, internal and external to VNF. -* R-44896 The VNF Package **MUST** include VM requirements via a Heat - template that provides the necessary data for high availability - redundancy model. -* R-55802 The VNF Package **MUST** include VM requirements via a Heat - template that provides the necessary data for scaling/growth VM - specifications. - - Note: Must comply with the *Heat requirements in 5.b*. - -* R-26881 The xNF provider **MUST** provide the binaries and images - needed to instantiate the xNF (xNF and VNFC images). -* R-96634 The xNF provider **MUST** describe scaling capabilities - to manage scaling characteristics of the xNF. - - -Testing -^^^^^^^^^^ - -* R-43958 The xNF Package **MUST** include documentation describing - the tests that were conducted by the xNF providor and the test results. -* R-04298 The xNF provider **MUST** provide their testing scripts to - support testing. -* R-58775 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. - -Licensing Requirements -^^^^^^^^^^^^^^^^^^^^^^^ - -* R-85653 The xNF **MUST** provide metrics (e.g., number of sessions, - number of subscribers, number of seats, etc.) to ONAP for tracking - every license. -* R-44125 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. -* R-40827 The xNF provider **MUST** enumerate all of the open - source licenses their xNF(s) incorporate. -* R-97293 The xNF provider **MUST NOT** require audits of - Service Provider’s business. -* R-44569 The xNF provider **MUST NOT** require additional - infrastructure such as a xNF provider license server for xNF provider - functions and metrics. -* R-13613 The VNF **MUST** provide clear measurements for licensing - purposes to allow automated scale up/down by the management system. -* R-27511 The VNF provider **MUST** provide the ability to scale - up a VNF provider supplied product during growth and scale down a - VNF provider supplied product during decline without “real-time” - restrictions based upon VNF provider permissions. -* R-85991 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. -* R-47849 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 - Tables C1 to C8 in the Appendix. Note: License metadata support in - ONAP is not currently available and planned for 1Q 2018. - Configuration Management ---------------------------------------------------- +------------------------ Controller Interactions With VNF ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -486,17 +172,17 @@ must be supported. * R-56218 The VNF **MUST** support ONAP Controller’s Migrate command that moves container (VM) from a live Physical Server / Compute Node to another live Physical Server / Compute Node. - + NOTE: Container migrations MUST be transparent to the VNF and no more intrusive than a stop, followed by some down time for the migration to be performed from one Compute Node / Physical Server to another, followed -by a start of the same VM with same configuration on the new Compute +by a start of the same VM with same configuration on the new Compute Node / Physical Server. - + * R-38001 The VNF MUST support ONAP Controller’s **Rebuild** command. * R-76901 VNF MUST support a container rebuild mechanism based on existing image (e.g. Glance image in Openstack environment) or a snapshot. - + HealthCheck and Failure Related Commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1304,546 +990,6 @@ Table 8. ONAP Controller APIs and NETCONF Commands | | | |results. | +-------------+--------------------+--------------------+--------------------+ -Monitoring & Management --------------------------------------------------- - -This section addresses data collection and event processing -functionality that is directly dependent on the interfaces -provided by the VNFs’ 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. - -The target direction for VNF interfaces is to employ APIs that are -implemented utilizing standardized messaging and modeling protocols -over standardized transports. Migrating to a virtualized environment -presents a tremendous opportunity to eliminate the need for proprietary -interfaces for VNF provider equipment while removing the traditional -boundaries between Network Management Systems and Element Management -Systems. Additionally, VNFs provide the ability to instrument the -networking applications by creating event records to test and monitor -end-to-end data flow through the network, similar to what physical or -virtual probes provide without the need to insert probes at various -points in the network. The VNF providers must be able to provide the -aforementioned set of required data directly to the ONAP collection -layer using standardized interfaces. - -Data Model for Event Records -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section describes the data model for the collection of telemetry -data from VNFs by Service Providers (SPs) to manage VNF health and -runtime lifecycle. This data model is referred to as the VNF Event -Streaming (VES) specifications. 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 specify additional -records. For example, OPNFV has a VES project that is looking to specify -records for OpenStack’s internal telemetry to manage Application (VNFs), -physical and virtual infrastructure (compute, storage, network devices), -and virtual infrastructure managers (cloud controllers, SDN controllers). -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 Data Model consists of: - -- Common Header Record: This data structure precedes each of the - Technology Independent and Technology Specific records sections of - the data model. - -- Technology Independent Records: This version of the document - specifies the model for Fault, Heartbeat, State Change, Syslog, - Threshold Crossing Alerts, and VNF Scaling* (short for - measurementForVfScalingFields – actual name used in JSON - specification) records. In the future, these may be extended to - support other types of technology independent records. Each of - these records allows additional fields (name/ value pairs) for - extensibility. The VNF provider can use these VNF 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 VNF - providers can use these VNF-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| - -Figure 1. Data Model for Event Records - -Event Records - Data Structure Description -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The data structure for event records consists of: - -- a Common Event Header block; - -- zero or more technology independent domain blocks; and - - - e.g., Fault domain, State Change domain, Syslog domain, etc. - -- zero or more technology specific domain blocks. - - - e.g., Mobile Flow domain, Signaling domain, Voice Quality domain, - etc. - -Common Event Header -~~~~~~~~~~~~~~~~~~~~~ - -The common header that precedes any of the domain-specific records contains -information identifying the type of record to follow, information about -the sender and other identifying characteristics related to timestamp, -sequence number, etc. - -Technology Independent Records – Fault Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Fault Record, describing a condition in the Fault domain, contains -information about the fault such as the entity under fault, the -severity, resulting status, etc. - -Technology Independent Records – Heartbeat Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Heartbeat Record provides an optional structure for communicating -information about heartbeat or watchdog signaling events. It can -contain information about service intervals, status information etc. -as required by the heartbeat implementation. - -Note: Heartbeat records would only have the Common Event Header block. -An optional heartbeat domain is available if required by the heartbeat -implementation. - -Technology Independent Records – State Change Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The State Change Record provides a structure for communicating information -about data flow through the VNF. It can contain information about state -change related to physical device that is reported by VNF. As an example, -when cards or port name of the entity that has changed state. - -Technology Independent Records – Syslog Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Syslog Record provides a structure for communicating any type of -information that may be logged by the VNF. It can contain information -about system internal events, status, errors, etc. - -Technology Independent Records – Threshold Crossing Alert Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Threshold Crossing Alert (TCA) Record provides a structure for -communicating information about threshold crossing alerts. It can -contain alert definitions and types, actions, events, timestamps -and physical or logical details. - -Technology Independent Records - VNF Scaling Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The VNF Scaling\* (short for measurementForVfScalingFields – -actual name used in JSON specification) Record contains information -about VNF and VNF resource structure and its condition to help in -the management of the resources for purposes of elastic scaling. - -Technology Independent Records – otherFields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The otherFields Record defines fields for events belonging to the -otherFields domain of the Technology Independent domain enumeration. -This record provides a mechanism to convey a complex set of fields -(possibly nested or opaque) and is purely intended to address -miscellaneous needs such as addressing time-to-market considerations -or other proof-of-concept evaluations. Hence, use of this record -type is discouraged and should be minimized. - -Technology Specific Records – Mobile Flow Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Mobile Flow Record provides a structure for communicating -information about data flow through the VNF. It can contain -information about connectivity and data flows between serving -elements for mobile service, such as between LTE reference points, etc. - -Technology Specific Records – Signaling Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Signaling Record provides a structure for communicating information -about signaling messages, parameters and signaling state. It can -contain information about data flows for signaling and controlling -multimedia communication sessions such as voice and video calls. - -Technology Specific Records – Voice Quality Fields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The Voice Quality Record provides a structure for communicating information -about voice quality statistics including media connection information, -such as transmitted octet and packet counts, packet loss, packet delay -variation, round-trip delay, QoS parameters and codec selection. - -Technology Specific Records – Future Domains -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The futureDomains Record is a placeholder for additional technology -specific areas of interest that will be defined and described -in the future documents. - -Data Structure Specification of the Event Record -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -For additional information on the event record formats of the data -structures mentioned above, please refer to `VES Event -Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__. - -Transports and Protocols Supporting Resource Interfaces -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Delivery of data from VNFs to ONAP must use the common transport -mechanisms and protocols for all VNFs as defined in this document. -Transport mechanisms and protocols have been selected to enable both -high volume and moderate volume datasets, as well as asynchronous and -synchronous communications over secure connections. The specified -encoding provides self-documenting content, so data fields can be -changed as needs evolve, while minimizing changes to data delivery. - -The term ‘Event Record’ is used throughout this document to represent -various forms of telemetry or instrumentation made available by the -VNF including, faults, status events, various other types of VNF -measurements and logs. Headers received by themselves must be used -as heartbeat indicators. Common structures and delivery protocols for -other types of data will be given in future versions of this document -as we get more insight into data volumes and required processing. - -In the following sections, we provide options for encoding, serialization -and data delivery. Agreements between Service Providers and VNF providers -shall determine which encoding, serialization and delivery method to use -for particular data sets. The selected methods must be agreed to prior to -the on-boarding of the VNF into ONAP design studio. - -VNF Telemetry using VES/JSON Model -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The preferred model for data delivery from a VNF to ONAP DCAE is -the JSON driven model as depicted in Figure 2. - -|image1| - -Figure 2. VES/JSON Driven Model - -VNF providers will provide a YAML artifact to the Service Provider -that describes: - -* standard VES/JSON model information elements (key/values) that - the VNF provides -* any additional non-standard (custom) VES/JSON model information - elements (key/values) that the VNF provides - -Using the semantics and syntax supported by YAML, VNF providers -will indicate specific conditions that may arise, and recommend -actions that should be taken at specific thresholds, or if specific -conditions repeat within a specified time interval. - -Based on the VNF provider's recommendations, the Service Provider may -create additional YAML artifacts (using ONAP design Studio), which -finalizes Service Provider engineering rules for the processing of -the VNF events. The Service Provider may alter the threshold levels -recommended by the VNF providor, and may modify and more clearly -specify actions that should be taken when specified conditions arise. -The Service Provider-created version of the YAML artifact will be -distributed to ONAP applications by the Design framework. - -VNF Telemetry using YANG Model -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In addition to the JSON driven model described above, a YANG -driven model can also be supported, as depicted in Figure 3. - -|image2| - -Figure 3. YANG Driven Model - -VNF providers will provide to the Service Provider the following -YANG model artifacts: - -* common IETF YANG modules that support the VNF -* native (VNF provider-supplied) YANG modules that support the VNF -* open (OpenConfig) YANG modules and the following - configuration-related information, including: - - * telemetry configuration and operational state data; such as: - - * sensor paths - * subscription bindings - * path destinations - * delivery frequency - * transport mechanisms - * data encodings - -* a YAML artifact that provides all necessary mapping relationships - between YANG model data types to VES/JSON information elements -* YANG helper or decoder functions that automate the conversion between - YANG model data types to VES/JSON information elements -* OPTIONAL: YANG Telemetry modules in JSON format per RFC 7951 - -Using the semantics and syntax supported by YANG, VNF providers -will indicate specific conditions that may arise, and recommend -actions that should be taken at specific thresholds, or if specific -conditions repeat within a specified time interval. - -Based on the VNF provider's recommendations, the Service Provider may -create additional YAML artifacts (using ONAP design Studio), which -finalizes Service Provider engineering rules for the processing of the -VNF events. The Service Provider may alter the threshold levels recommended -by the VNF provider, and may modify and more clearly specify actions that -should be taken when specified conditions arise. The Service -Provided-created version of the YAML will be distributed to ONAP -applications by the Design framework. - -Note: While supporting the YANG model described above, we are still -leveraging the VES JSON based model in DCAE. The purpose of the -diagram above is to illustrate the concept only and not to imply a -specific implementation. - -VNF Telemetry using Google Protocol Buffers -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In addition to the data delivery models described above, support for -delivery of VNF telemetry using Google Protocol Buffers (GPB) can -also be supported, as depicted in Figure 4. - -VNF providers will provide to the Service Provider the additional -following artifacts to support the delivery of VNF telemetry to DCAE -via the open-source gRPC mechanism using Google's Protocol Buffers: - -* the YANG model artifacts described in support of the - "VNF Telemetry using YANG Model" -* valid definition file(s) for all GPB / KV-GPB encoded messages -* valid definition file(s) for all gRPC services -* gRPC method parameters and return types specified as Protocol - Buffers messages - -|image3| - -Figure 4. Protocol Buffers Driven Model - -Note: if Google Protocol Buffers are employed for delivery of VNF -telemetry, Key-Value Google Protocol Buffers (KV-GPB) is the -preferred serialization method. Details of specifications and -versioning corresponding to a release can be found at: -`VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__. - -Note: While supporting the VNF telemetry delivery approach described above, -we are still leveraging the VES JSON based model in DCAE. The purpose of -the diagram above is to illustrate the concept only and not to imply a -specific implementation. - -Monitoring & Management Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -VNF telemetry via standardized interface -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* R-51910 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. - -Encoding and Serialization -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Content delivered from VNFs to ONAP is to be encoded and serialized using JSON: - -JSON -~~~~~~~~~~~~~~~~~~ - -* R-19624 The xNF **MUST** encode and serialize content delivered to - ONAP using JSON (RFC 7159) plain text format. High-volume data - is to be encoded and serialized using `Avro <http://avro.apache.org/>`_, where the Avro [5]_ data format are described using JSON. - - Note: - - - 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. - -In addition to the preferred method (JSON), content can be delivered -from xNFs to ONAP can be encoded and serialized using Google Protocol -Buffers (GPB). - -KV-GPB/GPB -~~~~~~~~~~~~~~~~~~ - -Telemetry data delivered using Google Protocol Buffers v3 (proto3) -can be serialized in one of the following methods: - -* Key-value Google Protocol Buffers (KV-GPB) is also known as - self-describing GPB: - - * keys are strings that correspond to the path of the system - resources for the VNF being monitored. - * values correspond to integers or strings that identify the - operational state of the VNF resource, such a statistics counters - and the state of a VNF resource. - -* VNF providers must supply valid KV-GPB definition file(s) to allow - for the decoding of all KV-GPB encoded telemetry messages. - -* Native Google Protocol Buffers (GPB) is also known as compact GPB: - - * keys are represented as integers pointing to the system resources for - the VNF being monitored. - * values correspond to integers or strings that identify the operational - state of the VNF resource, such a statistics counters and the state - of a VNF resource. - -* Google Protocol Buffers (GPB) requires metadata in the form of .proto - files. VNF providers must supply the necessary GPB .proto files such that - GPB telemetry messages can be encoded and decoded. - -* In the future, we may consider support for other types of - encoding & serialization methods based on industry demand. - - -Reporting Frequency -~~~~~~~~~~~~~~~~~~~~~ - -* R-98191 The xNF **MUST** vary the frequency that asynchronous data - is delivered based on the content and how data may be aggregated or - grouped together. - - Note: - - - 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. - -Addressing and Delivery Protocol -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -ONAP destinations can be addressed by URLs for RESTful data PUT. Future -data sets may also be addressed by host name and port number for TCP -streaming, or by host name and landing zone directory for SFTP transfer -of bulk files. - -* R-88482 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. -* R-84879 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. -* R-81777 The xNF **MUST** be configured with initial address(es) to use - at deployment time. Subsequently, address(es) may be changed through - ONAP-defined policies delivered from ONAP to the xNF using PUTs to a - RESTful API, in the same manner that other controls over data reporting - will be controlled by policy. -* R-08312 The xNF **MAY** use another option which is expected to include REST - delivery of binary encoded data sets. -* R-79412 The xNF **MAY** use another option which is expected to include 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. -* R-01033 The xNF **MAY** use another option which is expected to include 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. - (Preferred is to reorganize the data into more frequent or more focused data - sets, and deliver these by REST or TCP as appropriate.) -* R-63229 The xNF **MAY** use another option which is expected to include REST - for synchronous data, using RESTCONF (e.g., for xNF state polling). -* R-03070 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. - -Asynchronous and Synchronous Data Delivery -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* R-06924 The xNF **MUST** deliver asynchronous data as data becomes - available, or according to the configured frequency. -* R-73285 The xNF **MUST** must encode, address and deliver the data - as described in the previous paragraphs. -* R-42140 The xNF **MUST** respond to data requests from ONAP as soon - as those requests are received, as a synchronous response. -* R-34660 The xNF **MUST** use the RESTCONF/NETCONF framework used by - the ONAP configuration subsystem for synchronous communication. -* R-86586 The xNF **MUST** use the YANG configuration models and RESTCONF - [RFC8040] (https://tools.ietf.org/html/rfc8040). -* R-11240 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. -* R-70266 The xNF **MUST** respond to an ONAP request to deliver the - current data for any of the record types defined in - `Event Records - Data Structure Description`_ by returning the requested - record, populated with the current field values. (Currently the defined - record types include fault fields, mobile flow fields, measurements for - xNF scaling fields, and syslog fields. Other record types will be added - in the future as they become standardized and are made available.) -* R-46290 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. -* R-43327 The xNF **SHOULD** use `Modeling JSON text with YANG - <https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be - translated to and from JSON{RFC7951]. YANG configuration and content can - be represented via JSON, consistent with Avro, as described in “Encoding - and Serialization” section. - -Security -~~~~~~~~~~ - -* R-42366 The xNF **MUST** support secure connections and transports such as - Transport Layer Security (TLS) protocol - [`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to - the best current practices outlined in - `RFC7525 <https://tools.ietf.org/html/rfc7525>`_. -* R-44290 The xNF **MUST** control access to ONAP and to xNFs, and creation - of connections, through secure credentials, log-on and exchange mechanisms. -* R-47597 The xNF **MUST** carry data in motion only over secure connections. -* R-68165 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. - - .. [1] https://github.com/mbj4668/pyang @@ -1858,18 +1004,10 @@ Security .. [4] Multiple ONAP actions may map to one playbook. -.. [5] - This option is not currently supported in ONAP and it is currently - under consideration. - -.. [6] - https://wiki.opnfv.org/display/PROJ/VNF+Event+Stream - .. |image0| image:: Data_Model_For_Event_Records.png :width: 7in :height: 8in - .. |image1| image:: VES_JSON_Driven_Model.png :width: 5in :height: 3in diff --git a/docs/Chapter7/Monitoring-And-Management.rst b/docs/Chapter7/Monitoring-And-Management.rst new file mode 100644 index 0000000..a54671f --- /dev/null +++ b/docs/Chapter7/Monitoring-And-Management.rst @@ -0,0 +1,563 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Monitoring & Management +----------------------- + +This section addresses data collection and event processing +functionality that is directly dependent on the interfaces +provided by the VNFs’ 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. + +The target direction for VNF interfaces is to employ APIs that are +implemented utilizing standardized messaging and modeling protocols +over standardized transports. Migrating to a virtualized environment +presents a tremendous opportunity to eliminate the need for proprietary +interfaces for VNF provider equipment while removing the traditional +boundaries between Network Management Systems and Element Management +Systems. Additionally, VNFs provide the ability to instrument the +networking applications by creating event records to test and monitor +end-to-end data flow through the network, similar to what physical or +virtual probes provide without the need to insert probes at various +points in the network. The VNF providers must be able to provide the +aforementioned set of required data directly to the ONAP collection +layer using standardized interfaces. + +Data Model for Event Records +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section describes the data model for the collection of telemetry +data from VNFs by Service Providers (SPs) to manage VNF health and +runtime lifecycle. This data model is referred to as the VNF Event +Streaming (VES) specifications. 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 specify additional +records. For example, OPNFV has a VES project that is looking to specify +records for OpenStack’s internal telemetry to manage Application (VNFs), +physical and virtual infrastructure (compute, storage, network devices), +and virtual infrastructure managers (cloud controllers, SDN controllers). +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 Data Model consists of: + +- Common Header Record: This data structure precedes each of the + Technology Independent and Technology Specific records sections of + the data model. + +- Technology Independent Records: This version of the document + specifies the model for Fault, Heartbeat, State Change, Syslog, + Threshold Crossing Alerts, and VNF Scaling* (short for + measurementForVfScalingFields – actual name used in JSON + specification) records. In the future, these may be extended to + support other types of technology independent records. Each of + these records allows additional fields (name/ value pairs) for + extensibility. The VNF provider can use these VNF 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 VNF + providers can use these VNF-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| + +Figure 1. Data Model for Event Records + +Event Records - Data Structure Description +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The data structure for event records consists of: + +- a Common Event Header block; + +- zero or more technology independent domain blocks; and + + - e.g., Fault domain, State Change domain, Syslog domain, etc. + +- zero or more technology specific domain blocks. + + - e.g., Mobile Flow domain, Signaling domain, Voice Quality domain, + etc. + +Common Event Header +~~~~~~~~~~~~~~~~~~~~~ + +The common header that precedes any of the domain-specific records contains +information identifying the type of record to follow, information about +the sender and other identifying characteristics related to timestamp, +sequence number, etc. + +Technology Independent Records – Fault Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Fault Record, describing a condition in the Fault domain, contains +information about the fault such as the entity under fault, the +severity, resulting status, etc. + +Technology Independent Records – Heartbeat Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Heartbeat Record provides an optional structure for communicating +information about heartbeat or watchdog signaling events. It can +contain information about service intervals, status information etc. +as required by the heartbeat implementation. + +Note: Heartbeat records would only have the Common Event Header block. +An optional heartbeat domain is available if required by the heartbeat +implementation. + +Technology Independent Records – State Change Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The State Change Record provides a structure for communicating information +about data flow through the VNF. It can contain information about state +change related to physical device that is reported by VNF. As an example, +when cards or port name of the entity that has changed state. + +Technology Independent Records – Syslog Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Syslog Record provides a structure for communicating any type of +information that may be logged by the VNF. It can contain information +about system internal events, status, errors, etc. + +Technology Independent Records – Threshold Crossing Alert Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Threshold Crossing Alert (TCA) Record provides a structure for +communicating information about threshold crossing alerts. It can +contain alert definitions and types, actions, events, timestamps +and physical or logical details. + +Technology Independent Records - VNF Scaling Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The VNF Scaling\* (short for measurementForVfScalingFields – +actual name used in JSON specification) Record contains information +about VNF and VNF resource structure and its condition to help in +the management of the resources for purposes of elastic scaling. + +Technology Independent Records – otherFields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The otherFields Record defines fields for events belonging to the +otherFields domain of the Technology Independent domain enumeration. +This record provides a mechanism to convey a complex set of fields +(possibly nested or opaque) and is purely intended to address +miscellaneous needs such as addressing time-to-market considerations +or other proof-of-concept evaluations. Hence, use of this record +type is discouraged and should be minimized. + +Technology Specific Records – Mobile Flow Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Mobile Flow Record provides a structure for communicating +information about data flow through the VNF. It can contain +information about connectivity and data flows between serving +elements for mobile service, such as between LTE reference points, etc. + +Technology Specific Records – Signaling Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Signaling Record provides a structure for communicating information +about signaling messages, parameters and signaling state. It can +contain information about data flows for signaling and controlling +multimedia communication sessions such as voice and video calls. + +Technology Specific Records – Voice Quality Fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The Voice Quality Record provides a structure for communicating information +about voice quality statistics including media connection information, +such as transmitted octet and packet counts, packet loss, packet delay +variation, round-trip delay, QoS parameters and codec selection. + +Technology Specific Records – Future Domains +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The futureDomains Record is a placeholder for additional technology +specific areas of interest that will be defined and described +in the future documents. + +Data Structure Specification of the Event Record +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +For additional information on the event record formats of the data +structures mentioned above, please refer to `VES Event +Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__. + +Transports and Protocols Supporting Resource Interfaces +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Delivery of data from VNFs to ONAP must use the common transport +mechanisms and protocols for all VNFs as defined in this document. +Transport mechanisms and protocols have been selected to enable both +high volume and moderate volume datasets, as well as asynchronous and +synchronous communications over secure connections. The specified +encoding provides self-documenting content, so data fields can be +changed as needs evolve, while minimizing changes to data delivery. + +The term ‘Event Record’ is used throughout this document to represent +various forms of telemetry or instrumentation made available by the +VNF including, faults, status events, various other types of VNF +measurements and logs. Headers received by themselves must be used +as heartbeat indicators. Common structures and delivery protocols for +other types of data will be given in future versions of this document +as we get more insight into data volumes and required processing. + +In the following sections, we provide options for encoding, serialization +and data delivery. Agreements between Service Providers and VNF providers +shall determine which encoding, serialization and delivery method to use +for particular data sets. The selected methods must be agreed to prior to +the on-boarding of the VNF into ONAP design studio. + +VNF Telemetry using VES/JSON Model +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The preferred model for data delivery from a VNF to ONAP DCAE is +the JSON driven model as depicted in Figure 2. + +|image1| + +Figure 2. VES/JSON Driven Model + +VNF providers will provide a YAML artifact to the Service Provider +that describes: + +* standard VES/JSON model information elements (key/values) that + the VNF provides +* any additional non-standard (custom) VES/JSON model information + elements (key/values) that the VNF provides + +Using the semantics and syntax supported by YAML, VNF providers +will indicate specific conditions that may arise, and recommend +actions that should be taken at specific thresholds, or if specific +conditions repeat within a specified time interval. + +Based on the VNF provider's recommendations, the Service Provider may +create additional YAML artifacts (using ONAP design Studio), which +finalizes Service Provider engineering rules for the processing of +the VNF events. The Service Provider may alter the threshold levels +recommended by the VNF providor, and may modify and more clearly +specify actions that should be taken when specified conditions arise. +The Service Provider-created version of the YAML artifact will be +distributed to ONAP applications by the Design framework. + +VNF Telemetry using YANG Model +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In addition to the JSON driven model described above, a YANG +driven model can also be supported, as depicted in Figure 3. + +|image2| + +Figure 3. YANG Driven Model + +VNF providers will provide to the Service Provider the following +YANG model artifacts: + +* common IETF YANG modules that support the VNF +* native (VNF provider-supplied) YANG modules that support the VNF +* open (OpenConfig) YANG modules and the following + configuration-related information, including: + + * telemetry configuration and operational state data; such as: + + * sensor paths + * subscription bindings + * path destinations + * delivery frequency + * transport mechanisms + * data encodings + +* a YAML artifact that provides all necessary mapping relationships + between YANG model data types to VES/JSON information elements +* YANG helper or decoder functions that automate the conversion between + YANG model data types to VES/JSON information elements +* OPTIONAL: YANG Telemetry modules in JSON format per RFC 7951 + +Using the semantics and syntax supported by YANG, VNF providers +will indicate specific conditions that may arise, and recommend +actions that should be taken at specific thresholds, or if specific +conditions repeat within a specified time interval. + +Based on the VNF provider's recommendations, the Service Provider may +create additional YAML artifacts (using ONAP design Studio), which +finalizes Service Provider engineering rules for the processing of the +VNF events. The Service Provider may alter the threshold levels recommended +by the VNF provider, and may modify and more clearly specify actions that +should be taken when specified conditions arise. The Service +Provided-created version of the YAML will be distributed to ONAP +applications by the Design framework. + +Note: While supporting the YANG model described above, we are still +leveraging the VES JSON based model in DCAE. The purpose of the +diagram above is to illustrate the concept only and not to imply a +specific implementation. + +VNF Telemetry using Google Protocol Buffers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In addition to the data delivery models described above, support for +delivery of VNF telemetry using Google Protocol Buffers (GPB) can +also be supported, as depicted in Figure 4. + +VNF providers will provide to the Service Provider the additional +following artifacts to support the delivery of VNF telemetry to DCAE +via the open-source gRPC mechanism using Google's Protocol Buffers: + +* the YANG model artifacts described in support of the + "VNF Telemetry using YANG Model" +* valid definition file(s) for all GPB / KV-GPB encoded messages +* valid definition file(s) for all gRPC services +* gRPC method parameters and return types specified as Protocol + Buffers messages + +|image3| + +Figure 4. Protocol Buffers Driven Model + +Note: if Google Protocol Buffers are employed for delivery of VNF +telemetry, Key-Value Google Protocol Buffers (KV-GPB) is the +preferred serialization method. Details of specifications and +versioning corresponding to a release can be found at: +`VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__. + +Note: While supporting the VNF telemetry delivery approach described above, +we are still leveraging the VES JSON based model in DCAE. The purpose of +the diagram above is to illustrate the concept only and not to imply a +specific implementation. + +Monitoring & Management Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +VNF telemetry via standardized interface +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* R-51910 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. + +Encoding and Serialization +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Content delivered from VNFs to ONAP is to be encoded and serialized using JSON: + +JSON +~~~~~~~~~~~~~~~~~~ + +* R-19624 The xNF **MUST** encode and serialize content delivered to + ONAP using JSON (RFC 7159) plain text format. High-volume data + is to be encoded and serialized using `Avro <http://avro.apache.org/>`_, where the Avro [1]_ data format are described using JSON. + + Note: + + - 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. + +In addition to the preferred method (JSON), content can be delivered +from xNFs to ONAP can be encoded and serialized using Google Protocol +Buffers (GPB). + +KV-GPB/GPB +~~~~~~~~~~~~~~~~~~ + +Telemetry data delivered using Google Protocol Buffers v3 (proto3) +can be serialized in one of the following methods: + +* Key-value Google Protocol Buffers (KV-GPB) is also known as + self-describing GPB: + + * keys are strings that correspond to the path of the system + resources for the VNF being monitored. + * values correspond to integers or strings that identify the + operational state of the VNF resource, such a statistics counters + and the state of a VNF resource. + +* VNF providers must supply valid KV-GPB definition file(s) to allow + for the decoding of all KV-GPB encoded telemetry messages. + +* Native Google Protocol Buffers (GPB) is also known as compact GPB: + + * keys are represented as integers pointing to the system resources for + the VNF being monitored. + * values correspond to integers or strings that identify the operational + state of the VNF resource, such a statistics counters and the state + of a VNF resource. + +* Google Protocol Buffers (GPB) requires metadata in the form of .proto + files. VNF providers must supply the necessary GPB .proto files such that + GPB telemetry messages can be encoded and decoded. + +* In the future, we may consider support for other types of + encoding & serialization methods based on industry demand. + + +Reporting Frequency +~~~~~~~~~~~~~~~~~~~~~ + +* R-98191 The xNF **MUST** vary the frequency that asynchronous data + is delivered based on the content and how data may be aggregated or + grouped together. + + Note: + + - 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. + +Addressing and Delivery Protocol +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ONAP destinations can be addressed by URLs for RESTful data PUT. Future +data sets may also be addressed by host name and port number for TCP +streaming, or by host name and landing zone directory for SFTP transfer +of bulk files. + +* R-88482 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. +* R-84879 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. +* R-81777 The xNF **MUST** be configured with initial address(es) to use + at deployment time. Subsequently, address(es) may be changed through + ONAP-defined policies delivered from ONAP to the xNF using PUTs to a + RESTful API, in the same manner that other controls over data reporting + will be controlled by policy. +* R-08312 The xNF **MAY** use another option which is expected to include REST + delivery of binary encoded data sets. +* R-79412 The xNF **MAY** use another option which is expected to include 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. +* R-01033 The xNF **MAY** use another option which is expected to include 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. + (Preferred is to reorganize the data into more frequent or more focused data + sets, and deliver these by REST or TCP as appropriate.) +* R-63229 The xNF **MAY** use another option which is expected to include REST + for synchronous data, using RESTCONF (e.g., for xNF state polling). +* R-03070 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. + +Asynchronous and Synchronous Data Delivery +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* R-06924 The xNF **MUST** deliver asynchronous data as data becomes + available, or according to the configured frequency. +* R-73285 The xNF **MUST** must encode, address and deliver the data + as described in the previous paragraphs. +* R-42140 The xNF **MUST** respond to data requests from ONAP as soon + as those requests are received, as a synchronous response. +* R-34660 The xNF **MUST** use the RESTCONF/NETCONF framework used by + the ONAP configuration subsystem for synchronous communication. +* R-86586 The xNF **MUST** use the YANG configuration models and RESTCONF + [RFC8040] (https://tools.ietf.org/html/rfc8040). +* R-11240 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. +* R-70266 The xNF **MUST** respond to an ONAP request to deliver the + current data for any of the record types defined in + `Event Records - Data Structure Description`_ by returning the requested + record, populated with the current field values. (Currently the defined + record types include fault fields, mobile flow fields, measurements for + xNF scaling fields, and syslog fields. Other record types will be added + in the future as they become standardized and are made available.) +* R-46290 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. +* R-43327 The xNF **SHOULD** use `Modeling JSON text with YANG + <https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be + translated to and from JSON{RFC7951]. YANG configuration and content can + be represented via JSON, consistent with Avro, as described in “Encoding + and Serialization” section. + +Security +~~~~~~~~~~ + +* R-42366 The xNF **MUST** support secure connections and transports such as + Transport Layer Security (TLS) protocol + [`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to + the best current practices outlined in + `RFC7525 <https://tools.ietf.org/html/rfc7525>`_. +* R-44290 The xNF **MUST** control access to ONAP and to xNFs, and creation + of connections, through secure credentials, log-on and exchange mechanisms. +* R-47597 The xNF **MUST** carry data in motion only over secure connections. +* R-68165 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. + +.. [1] + This option is not currently supported in ONAP and it is currently + under consideration. + +.. |image0| image:: Data_Model_For_Event_Records.png + :width: 7in + :height: 8in + +.. |image1| image:: VES_JSON_Driven_Model.png + :width: 5in + :height: 3in + +.. |image2| image:: YANG_Driven_Model.png + :width: 5in + :height: 3in + +.. |image3| image:: Protocol_Buffers_Driven_Model.png + :width: 4.74in + :height: 3.3in + diff --git a/docs/Chapter7/Service-Design.rst b/docs/Chapter7/Service-Design.rst new file mode 100644 index 0000000..472badc --- /dev/null +++ b/docs/Chapter7/Service-Design.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +Service Design +-------------- + +This section, Service Design, has been left intentionally blank. It +is out-of-scope for the VNF Requirements project for the Amsterdam +release and no numbered requirements are expected. Content may be +added in future updates of this document. diff --git a/docs/Chapter7/VNF-On-boarding-and-package-management.rst b/docs/Chapter7/VNF-On-boarding-and-package-management.rst new file mode 100644 index 0000000..7628aaa --- /dev/null +++ b/docs/Chapter7/VNF-On-boarding-and-package-management.rst @@ -0,0 +1,272 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +VNF On-boarding and package management +-------------------------------------- + +Design Definition +^^^^^^^^^^^^^^^^^^ + +The ONAP Design Time Framework provides the ability to design NFV +resources including VNFs, Services, and products. The VNF provider must +provide VNF packages that include a rich set of recipes, management and +functional interfaces, policies, configuration parameters, and +infrastructure requirements that can be utilized by the ONAP Design +module to onboard and catalog these resources. Initially this +information may be provided in documents, but in the near future a +method will be developed to automate as much of the transfer of data as +possible to satisfy its long term requirements. + +The current VNF Package Requirement is based on a subset of the +Requirements contained in the ETSI Document: ETSI GS NFV-MAN 001 v1.1.1 +and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization +(NFV), Management and Orchestration, VNF Packaging Specification. + +Resource Description +^^^^^^^^^^^^^^^^^^^^^^ + +* R-77707 The xNF provider **MUST** include a Manifest File that + contains a list of all the components in the xNF package. +* R-66070 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. +* R-69565 The xNF Package **MUST** include documentation describing xNF + Management APIs, which must include information and tools for ONAP to + deploy and configure (initially and ongoing) the xNF application(s) + (e.g., NETCONF APIs) which includes a description of configurable + parameters for the xNF and whether the parameters can be configured + after xNF instantiation. +* R-00156 The xNF Package **MUST** include documentation describing xNF + Management APIs, which must include information and tools for ONAP + to monitor the health of the xNF (conditions that require healing + and/or scaling responses). +* R-00068 The xNF Package **MUST** include documentation which 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. +* R-12678 The xNF Package **MUST** include documentation which includes a + description of runtime lifecycle events and related actions (e.g., + control responses, tests) which can be performed for the xNF. +* R-84366 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. +* R-36280 The xNF provider **MUST** provide documentation describing + xNF Functional Capabilities that are utilized to operationalize the + xNF and compose complex services. +* R-98617 The xNF provider **MUST** provide information regarding any + dependency (e.g., affinity, anti-affinity) with other xNFs and resources. + +Resource Configuration +^^^^^^^^^^^^^^^^^^^^^^^ + +* R-89571 The xNF **MUST** support and provide artifacts for configuration + management using at least one of the following technologies; + a) Netconf/YANG, b) Chef, or c) Ansible. + + Note: The requirements for Netconf/YANG, Chef, and Ansible protocols + are provided separately and must be supported only if the corresponding + protocol option is provided by the xNF providor. + +Configuration Management via NETCONF/YANG +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* R-30278 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. + +Configuration Management via Chef +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* R-13390 The xNF provider **MUST** provide cookbooks to be loaded + on the appropriate Chef Server. +* R-18525 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 Tables A1 + and A2 in the Appendix. + + Note: Chef support in ONAP is not currently available and planned for 4Q 2017. + +Configuration Management via Ansible +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* R-75608 The xNF provider **MUST** provide playbooks to be loaded + on the appropriate Ansible Server. +* R-16777 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 Table B1 + in the Appendix. + +* R-46567 The xNF Package **MUST** include configuration scripts + for boot sequence and configuration. +* R-16065 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). + +Resource Control Loop +^^^^^^^^^^^^^^^^^^^^^^^ + +* R-22888 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. +* R-01556 The xNF Package **MUST** include documentation describing the + fault, performance, capacity events/alarms and other event records + that are made available by the xNF. +* R-16875 The xNF Package **MUST** include documentation which 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. +* R-35960 The xNF Package **MUST** include documentation which must include + all events, severity level (e.g., informational, warning, error) and + descriptions including causes/fixes if applicable for the event. +* R-42018 The xNF Package **MUST** include documentation which must include + all events (fault, measurement for xNF Scaling, Syslogs, State Change + and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <http://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html#a-glossary>`__ ) and for the overall xNF. +* R-27711 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. +* R-01478 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. +* R-73560 The xNF Package **MUST** include documentation about monitoring + parameters/counters exposed for virtual resource management and xNF + application management. +* R-90632 The xNF Package **MUST** include documentation about KPIs and + metrics that need to be collected at each VM for capacity planning + and performance management purposes. +* R-86235 The xNF Package **MUST** include documentation about the monitoring + parameters that 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. +* R-33904 The xNF Package **MUST** include documentation for each KPI, provide + lower and upper limits. +* R-53598 The xNF Package **MUST** include documentation to, when relevant, + provide a threshold crossing alert point for each KPI and describe the + significance of the threshold crossing. +* R-69877 The xNF Package **MUST** include documentation for each KPI, + identify the suggested actions that need to be performed when a + threshold crossing alert event is recorded. +* R-22680 The xNF Package **MUST** include documentation that describes + any requirements for the monitoring component of tools for Network + Cloud automation and management to provide these records to components + of the xNF. +* R-33694 The xNF Package **MUST** include documentation to when applicable, + provide calculators needed to convert raw data into appropriate reporting + artifacts. +* R-56815 The xNF Package **MUST** include documentation describing + supported xNF scaling capabilities and capacity limits (e.g., number + of users, bandwidth, throughput, concurrent calls). +* R-48596 The xNF Package **MUST** include documentation describing + the characteristics for the xNF reliability and high availability. +* R-74763 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 <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__) + +Compute, Network, and Storage Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* R-35851 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. +* R-97102 The VNF Package **MUST** include VM requirements via a Heat + template that provides the necessary data for VM specifications + for all VNF components - for hypervisor, CPU, memory, storage. +* R-20204 The VNF Package **MUST** include VM requirements via a Heat + template that provides the necessary data for network connections, + interface connections, internal and external to VNF. +* R-44896 The VNF Package **MUST** include VM requirements via a Heat + template that provides the necessary data for high availability + redundancy model. +* R-55802 The VNF Package **MUST** include VM requirements via a Heat + template that provides the necessary data for scaling/growth VM + specifications. + + Note: Must comply with the *Heat requirements in 5.b*. + +* R-26881 The xNF provider **MUST** provide the binaries and images + needed to instantiate the xNF (xNF and VNFC images). +* R-96634 The xNF provider **MUST** describe scaling capabilities + to manage scaling characteristics of the xNF. + + +Testing +^^^^^^^^^^ + +* R-43958 The xNF Package **MUST** include documentation describing + the tests that were conducted by the xNF providor and the test results. +* R-04298 The xNF provider **MUST** provide their testing scripts to + support testing. +* R-58775 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. + +Licensing Requirements +^^^^^^^^^^^^^^^^^^^^^^^ + +* R-85653 The xNF **MUST** provide metrics (e.g., number of sessions, + number of subscribers, number of seats, etc.) to ONAP for tracking + every license. +* R-44125 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. +* R-40827 The xNF provider **MUST** enumerate all of the open + source licenses their xNF(s) incorporate. +* R-97293 The xNF provider **MUST NOT** require audits of + Service Provider’s business. +* R-44569 The xNF provider **MUST NOT** require additional + infrastructure such as a xNF provider license server for xNF provider + functions and metrics. +* R-13613 The VNF **MUST** provide clear measurements for licensing + purposes to allow automated scale up/down by the management system. +* R-27511 The VNF provider **MUST** provide the ability to scale + up a VNF provider supplied product during growth and scale down a + VNF provider supplied product during decline without “real-time” + restrictions based upon VNF provider permissions. +* R-85991 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. +* R-47849 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 + Tables C1 to C8 in the Appendix. Note: License metadata support in + ONAP is not currently available and planned for 1Q 2018. + +.. |image0| image:: Data_Model_For_Event_Records.png + :width: 7in + :height: 8in + +.. |image1| image:: VES_JSON_Driven_Model.png + :width: 5in + :height: 3in + +.. |image2| image:: YANG_Driven_Model.png + :width: 5in + :height: 3in + +.. |image3| image:: Protocol_Buffers_Driven_Model.png + :width: 4.74in + :height: 3.3in + diff --git a/docs/Chapter7/index.rst b/docs/Chapter7/index.rst new file mode 100644 index 0000000..e5c1462 --- /dev/null +++ b/docs/Chapter7/index.rst @@ -0,0 +1,67 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +ONAP Management Requirements +============================ + +.. toctree:: + :maxdepth: 2 + + Service-Design + VNF-On-boarding-and-package-management + Configuration-Management + Monitoring-And-Management + + +The ONAP platform is the part of the larger Network Function +Virtualization/Software Defined Network (NFV/SDN) ecosystem that +is responsible for the efficient control, operation and management +of Virtual Network Function (VNF) capabilities and functions. It +specifies standardized abstractions and interfaces that enable +efficient interoperation of the NVF/SDN ecosystem components. It +enables product/service independent capabilities for design, creation +and runtime lifecycle management (includes all aspects of installation, +change management, assurance, and retirement) of resources in NFV/SDN +environment (see ECOMP white paper ). These capabilities are provided +using two major architectural frameworks: (1) a Design Time Framework +to design, define and program the platform (uniform onboarding), and +(2) a Runtime Execution Framework to execute the logic programmed in +the design environment (uniform delivery and runtime lifecycle +management). The platform delivers an integrated information model +based on the VNF package to express the characteristics and behavior +of these resources in the Design Time Framework. The information model +is utilized by Runtime Execution Framework to manage the runtime +lifecycle of the VNFs. The management processes are orchestrated +across various modules of ONAP to instantiate, configure, scale, +monitor, and reconfigure the VNFs using a set of standard APIs +provided by the VNF developers. + +Although the guidelines and requirements specified in this document +were originally driven by the need to standardize and automate the +management of the virtualized environments (with VNFs) operated by +Service Providers, we believe that most of the requirements are equally +applicable to the operation of the physical network functions (PNFs), +those network functions provided by traditional physical network +elements (e.g. whitebox switches) or customized peripherals (e.g. a +video rendering engine for augmented reality). The primary area of +difference will be in how the network function is orchestrated into +place – VNFs can be much more dynamically created & placed by ONAP +to support varying geographic, availability and scalability needs, +whereas the PNFs have to be deployed a priori in specific locations +based on planning and engineering – their availability and scalability +will be determined by the capabilities offered by the PNFs. + +**PNF** is a vendor-provided Network Function(s) implemented using a +bundled set of hardware and software while VNFs utilize cloud resources +to provide Network Functions through virtualized software modules. PNF +can be supplied by a vendor as a Black BOX (provides no knowledge of its +internal characteristics, logic, and software design/architecture) or as +a White Box (provides detailed knowledge and access of its internal +components and logic) or as a Grey Box (provides limited knowledge and +access to its internal components). + +* Requirements that equally apply to both VNFs and PNFs are defined as + "The xNF MUST/SHOULD/..." +* Requirements that only apply to VNFs are defined as "The VNF MUST/SHOULD/..." +* Requirements that only apply to PNFs are defined as "The PNF MUST/SHOULD/..." diff --git a/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst b/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst new file mode 100644 index 0000000..4eb8131 --- /dev/null +++ b/docs/Chapter8/Ansible-JSON-Key-Value-Description.rst @@ -0,0 +1,111 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Ansible JSON Key Value Description +------------------------------------------------------------- + +The following provides the key value pairs that must be contained in the +JSON file supporting Ansible action. + +Table B1. Ansible JSON File key value description +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++---------------+----------------------+---------+----------------------------+ +| **Field Name**| **Description** | **Type**| **Comment** | ++===============+======================+=========+============================+ +| PlaybookName | VNF providor must |Mandatory|Currently following | +| | list name of the | |Ansible standard | +| | playbook relative | |naming, where main | +| | path used to | |playbook is always | +| | execute the VNF | |named site.yml, and | +| | action. | |directory name where | +| | | |this main playbook resides, | +| | | |is named after the | +| | | |command/action playbook | +| | | |performs, in lower case, | +| | | |example, configure. | ++---------------+----------------------+---------+----------------------------+ +| Action | Name of VNF action. | Optional| | ++---------------+----------------------+---------+----------------------------+ +| EnvParameters | A JSON dictionary | Optional|Depends on the VNF action. | +| | which should list key| | | +| | value pairs to be | |Attribute names (variable | +| | passed to the Ansible| |names) passed to Ansible | +| | playbook. These | |shall follow Ansible valid | +| | values would | |variable names: “Variable | +| | correspond to | |names should be letters, | +| | instance specific | |numbers, and underscores. | +| | parameters that a | |Variables should always | +| | playbook may need to | |start with a letter.” | +| | execute an action. | | | ++---------------+----------------------+---------+----------------------------+ +| NodeList |Ansible inventory | Optional|If not provided, pre-loaded | +| |hosts file with | |(VNF) inventory hosts | +| |VNF groups and | |file must exist in the | +| |respective IP | |Ansible Server otherwise | +| |addresses or DNS | |request fails. | +| |supported FQDNs | | | +| |that the playbook must| | | +| |be executed against. | | | ++---------------+----------------------+---------+----------------------------+ +| FileParameters| A JSON dictionary | Optional| Depends on the VNF action | +| | where keys are | | and playbook design. | +| | filenames and values | | | +| | are contents of | | | +| | files. The Ansible | | | +| | Server will utilize | | | +| | this feature to | | | +| | generate files with | | | +| | keys as filenames and| | | +| | values as content. | | | +| | This attribute can be| | | +| | used to generate | | | +| | files that a playbook| | | +| | may require as part | | | +| | of execution. | | | ++---------------+----------------------+---------+----------------------------+ +| Timeout | Time (in seconds) | Optional| | +| | that a playbook is | | | +| | expected to take to | | | +| | finish execution for | | | +| | the VNF. If playbook | | | +| | execution time | | | +| | exceeds this value, | | | +| | Ansible Server will | | | +| | terminate the | | | +| | playbook process. | | | ++---------------+----------------------+---------+----------------------------+ + +Ansible JSON file example: + +{ + + “Action”:”Configure”, + + "PlaybookName": "<VNFCode>/<Version>/ansible/configure/site.yml", + + "NodeList": ["test1.vnf\_b.onap.com", “test2.vnf\_b.onap.com”], + + "Timeout": 60, + + "EnvParameters": {"Retry": 3, "Wait": 5, “ConfigFile”:”config.txt”}, + + “FileParameters”:{“config.txt”:”db\_ip=10.1.1.1, sip\_timer=10000”} + +} + +In the above example, the Ansible Server will: + +a. Process the “FileParameters” dictionary and generate a file named + ‘config.txt’ with contents set to the value of the ‘config.txt’ key. + +b. Execute the playbook named ‘<VNFCode>/<Version>/ansible/configure/site.yml’ + on nodes with FQDNs test1.vnf\_b.onap.com and test2.vnf\_b.onap.com + respectively while providing the following key value pairs to the playbook: + Retry=3, Wait=5, ConfigFile=config.txt + + +c. If execution time of the playbook exceeds 60 secs (across all hosts), + it will be terminated. + diff --git a/docs/Chapter8/Ansible-Playbook-Examples.rst b/docs/Chapter8/Ansible-Playbook-Examples.rst new file mode 100644 index 0000000..4be9944 --- /dev/null +++ b/docs/Chapter8/Ansible-Playbook-Examples.rst @@ -0,0 +1,706 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Ansible Playbook Examples +----------------------------------------------- + +The following sections contain examples of Ansible playbooks +which follow the guidelines. + +Guidelines for Playbooks to properly integrate with APPC +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +NOTE: To support concurrent requests to multiple VNF instances of same +or different type, VNF hosts and other files with VNF specific default +values are kept or created in separate directories. + +Example of an Ansible command (after pwd) to run playbook again +vfdb9904v VNF instance: + +.. code-block:: none + + $ pwd + /storage/vfdb/V16.1/ansible/configure + $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v" + + NOTE: To preserve Ansible inventory/group_vars capability, that makes + group_vars contents global variables available to all playbooks, when they + reside in the inventory directory, guidelines are being updated to name the + VNF inventory hosts file as (a flat file) <VNFName>hosts, stored in the + inventory directory, not a subdirectory under inventory. In the above + example: vfdb9904vhosts (removed / VNF name and hosts vfdb9904/vhosts) + +Example of corresponding APPC API Call from ONAP – Ansible Server +Specifications: + +An example of a curl request simulating a Rest API POST requesting execution +of configure Playbook (using playbook relative path): + +.. code-block:: none + + curl -u APIUser:APIPassword -H "Content-type:application/json" -X POST + -d '{"Id": "8412", "PlaybookName": "vfdb/V5.x.x/ansible/configure/site.yml", + "Timeout":"600", "EnvParameters": { "vnf_instance": "vfdb9904v" }}' + http://ansible.server.com:5000/Dispatch + +Rest API GET request to obtain response/results for prior request +(same Id as POST request above): + +.. code-block:: none + + curl -u APIUser:APIPassword -H 'Content-type: application/json' -X GET + 'http://ansible.server.com:5000/Dispatch/?Id=8412&Type=GetResult' + +Comments: + +- An ID number is assigned to each request. This ID number is used to + track request down to completion and provide status to APPC when + requested. + +- Playbook Name relative path provided in the request as PlaybookName + +- Ansible Server Rest API is aware of playbook’s root directory which may + vary from instance to instance or Ansible Server cluster to cluster. + +Ansible Playbooks will use the VNF instance name (passed using +--extra-vars "vnf\_instance=vfdb9904v") to identify other default values +to run the playbook(s) against the target VNF instance. Same example as +above: + +.. code-block:: none + + $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v" + +Each Ansible Server or cluster is assigned its own identification to be used +to authenticate to VNF VMs using Ansible Server or cluster specific set of +SSH keys that may be rotated regularly. Here hosts file, no longer referencing +file with SSH key credentials, to run ansible-playbook listed in this example +above (IP addresses were scrubbed): + +.. code-block:: none + + $ more ../inventory/vfdb9904v/hosts + [host] + localhost ansible_connection=local + + [oam] + 1xx.2yy.zzz.109 + 1xx.2yy.zzz.110 + + [rdb] + 1xx.2yy.zzz.105 + 1xx.2yy.zzz.106 + +NOTE: APPC requests to run Playbooks/Cookbooks are specific to a VNF, +but could be more limited to one VM or one type of VM by the request +parameters. Actions that may impact a site (LCP), a service, or an +entire platform must be orchestrated by MSO in order to execute requests +via APPC which then invoke VNF level playbooks. Playbooks that impact +more than a single VNF are not the current focus of these guidelines. + +Since last release of these guidelines, based on recent learnings, +moving VNF Type global variables under inventory/group_vars files, this +way variables and respective values are available to all playbooks without +being explicitly referenced though an include statement. Also creating +templates that are VNF Type specific, but moving away from static files +that are VNF instance specific, working to obtain VNF instance specific +from other sources, inventory database, etc. + +And here the scrubbed default arguments for this VNF instance(originated +from previously re-factored playbooks now being phased out): + +.. code-block:: none + + vnf_instance=vfdb9904v + + $ more ../vars/vfdb9904v/default_args.yml + vm_config_oam_vnfc_name: vfdb9904vm001oam001 + vm_config_oam_hostname: vfdb9904vm001 + vm_config_oam_provider_ip_address: 1xx.2yy.zzz.109 + … + +IMPORTANT: The APPC and default file attribute name for +vm\_config\_oam\_vnfc\_name, as an example, is derived from vm\_config +array structure (list) in the CSAR package ENV file, with dots replaced +by underscore: + +.. code-block:: none + + vm_config: + + oam: {vnfc_name: {{ vm_config_oam_vnfc_name }}, hostname: {{ + vm_config_oam_hostname }}, provider_ip_address: {{ + vm_config_oam_provider_ip_address } + }, + … + +Parameters like VNF names, VNFC names, OA&M IP addresses, after +February, 2018 ONAP release, will be extracted from A&AI by APPC and +then passed down to Ansible Server, as part of APPC request through REST +API. In the meantime, VNF instance specific required values, will +be stored on VNF instance directory, default arguments file and will be +used as defaults. For parameterized playbooks attribute-value pairs +passed down by APPC to Ansible Server always take precedence over +template or VNF instance specific defaults stored in defaults file(s). + +.. code-block:: none + + $ pwd + /storage/vfdb/latest/ansible + Again, originated from previously re-factored playbooks now being phased out: + + $ more vars/vfdb9904v/default_args.yml + + vm_config_oam1_vnfc_name: vfdb9904vm001oam001 + vm_config_oam1_hostname: vfdb9904vm001 + vm_config_oam1_provider_ip_address: 1xx.2yy.zzz.109 + + vm_config_oam2_vnfc_name: vfdb9904vm002oam001 + vm_config_oam2_hostname: vfdb9904vm002 + vm_config_oam2_provider_ip_address: 1xx.2yy.zzz.110 + + vm_config_rdb1_vnfc_name: vfdb9904vm003rdb001 + vm_config_rdb1_hostname: vfdb9904vm003 + vm_config_rdb1_provider_ip_address: 1xx.2yy.zzz.105 + + vm_config_rdb2_vnfc_name: vfdb9904vm004rdb001 + vm_config_rdb2_hostname: vfdb9904vm004 + vm_config_rdb2_provider_ip_address: 1xx.2yy.zzz.106 + + vm_config_rdb3_vnfc_name: vfdb9904vm005rdb001 + vm_config_rdb3_hostname: vfdb9904vm005 + vm_config_rdb3_provider_ip_address: 1xx.2yy.zzz.xxx + + vm_config_rdb4_vnfc_name: vfdb9904vm006rdb001 + vm_config_rdb4_hostname: vfdb9904vm006 + vm_config_rdb4_provider_ip_address: 1xx.2yy.zzz.yyy + +One of the first tasks on the Ansible Playbooks is to combine the VNF +type generic template, derived from ENV files in CSAR or other files, +with these default values stored on the Ansible Server, together with +the overriding parameters passed down from APPC, to create the VNF +instance specific set of attribute-value pairs to be used for the run, in +INI format. Here is an excerpt from such a file that should look +somewhat similar to ENV files: + +.. code-block:: none + + $ more tmp/vfdb9904v/all.yml + + deployment_prefix: vfdb9904v + … + timezone: Etc/UTC + … + template_version: '2014-10-16' + stack_name: vfdb9904v + c3dbtype: OAM + stackName: vfdb9904v + juno_base: true + … + +# logins list contain 'login name', 'login group', 'login password' + +.. code-block:: none + + logins: + - { name: 'm99999', group: 'm99999', password: 'abcdefgha' } + - { name: 'gsuser', group: 'gsuser', password: ' abcdefgha' } + - { name: 'peruser', group: 'peruser', password: ' abcdefgha' } + - { name: 'dbuser', group: 'dbuser', password: ' abcdefgha' } + +NOTE: Arguments passed by APPC to Ansible Server to run a playbook take +precedence over any defaults stored in Ansible Server. + +Ansible Playbooks – Notes On Artifacts Required to Run Playbooks +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Inventory hosts file: should be VNF instance specific. + +Default variables: should be VNF instance specific. + +NOTE: Some playbooks may rely on inventory directory contents to target +the collection of VNFs in the Services Platform supported through +Ansible. + +Playbooks and paths to referenced files: Playbooks shall not use +absolute paths in include or import entries (variables or playbooks) or +other types of references. + +For this to work properly, when running playbooks, the directory where +the main playbook resides shall be the current directory. + +Playbook imports, when used, shall use paths relative to the main +playbook directory. + +Root directory named ansible - Any files provided with playbooks, +included, imported, or referenced by playbooks, shall reside under the ansible +playbooks (root) directory, containing all playbook subdirectories, or +below that ansible root directory, in other subdirectories to support +on-boarding and portability of VNF collection of playbooks and related +artifacts. + +Designing for a shared environment, concurrently running playbooks, +targeting multiple VNF instances – inventory hosts file: + +To avoid inventory hosts file overwrites or collisions between multiple +concurrently running VNF instance requests, chosen approach is for each +VNF instance hosts file, to be stored under the Ansible Server Playbooks +root directory, under the inventory subdirectory, and under a directory +for each VNF instance, named after the VNF instance, as follows: + +ansible/inventory/<VNF\_instance\_name>/hosts + +Example of inventory hosts file path, relative to ansible playbooks root +directory (playbooks\_dir): ansible/inventory/vnfx0001v/hosts + +**Designing for a shared environment, concurrently running multiple playbooks, +targeting multiple VNF instances – default argument variables for +specific VNF instances:** + +Files containing attribute name value pairs (variable name and default +values), referenced/included by playbooks – Files containing VNF +instance specific default values – in a later APPC release, some or all +the default attribute value pairs contained in the defaults file, may be +passed down by APPC, to the Ansible Server, overriding these defaults: + +VNF instance specific files +referenced/included by playbooks, containing default values, example, +default\_args.yml, shall be stored under a directory with VNF instance +name on the path. + +Example: + +ansible/vars/<VNF\_instance\_name>/default\_args.yml + +Example of include statement: + +- include_vars: ../vars/{{ vnf_instance }}/default_args.yml + +Again, this was originated from previously re-factored playbooks, now being +phased out, to move away from having to create VNF instance specific files +with VNF instance default variables. Moving to extract these values from +inventory databases and provide them to Ansible Server as part of the APPC +request, but may be used in a transition from having everything stored in the +Ansible Server to APPC extracting and providing VNF instance specific +attribute-value pairs to the Ansible Server as part of the request. + +Files containing attribute name value pairs (variable name and default +values), referenced/included by playbooks – created dynamically by +playbooks: + +To avoid +overwrites or collisions of multiple concurrently running VNF instance +requests, files created dynamically by playbooks, based on VNF generic +templates, combined with default values and arguments passed down by +APPC (as part of the request), shall be stored under a directory with +VNF instance name on the path. + +Example: + +tmp/<VNF\_instance\_name>/all.yml + +Files containing site specific (Openstack location non-instance +specific) attribute name value pairs, like NTP server and DNS server’s +IP addresses and other parameters, referenced/included by playbooks, not +VNF specific – Could/should be stored under inventory/group_vars directory, +in a subdirectory named after the string used to identify the site (nyc1, +lax2,…). + +Examples: + +ansible/inventory/group_vars/<Site> + +ansible/inventory/group_vars/nyc1 + +ansible/inventory/group_vars/lax2 + + +\ **Ansible Server Design - Directory Structure** + +To help understanding the contents of this section, here are few basic +definitions: + +**VNF type a.k.a VNF Function Code** - Based on current Services +Platform naming convention, each Virtual Network Function is assigned a +4 character string (example vfdb), these are 4 characters in +the VNF instance name, followed by (4) numbers, ending in a "v", but the +naming convention is evolving. VNF instance name in +some cases corresponds to the stack name for the VNF when VNF instance +is built based on a single module, single stack. Example of VNF instance +name: vfdb9904v. All VNF performing this function, running the same +software, coming from the same VNF provider will have the same 4 +characters in the VNF instance name, in this example, vfdb. + +NOTE: New naming convention includes a prefix indicating geographical +location where VNF is instantiated. + +VNF type, determined through these 4 characters, is also known as VNF +Function Code and is assigned by inventory team. All Services Platform +VNF Function Codes can be found in inventory database and/or A&AI as +well as Services Platform Network Design Documents. + +Version – As in VNF software version is the release of the software +running on the VNF for which the playbooks were developed. VNF +configuration steps may change from release to release and this +<Version> in the path will allow the Ansible Server to host playbooks +associated with each software release. And run the playbooks that match +the software release running on each VNF instance. APPC initially will +not support playbook versioning only latest playbook is supported or a hard +coded version that later should become a variable to allow multiple +actively in use playbook versions according to VNF release. + +Playbook Function - Is a name associated with a life cycle management +task(s) performed by the playbook(s) stored in this directory. It should +clearly identify the type of action(s) performed by the main playbook +and possibly other playbooks stored in this same directory. Ideally, +playbook function would match APPC corresponding command or function that +is performed by the main playbook in this directory. Following Ansible naming +standards main playbook is usually named site.yml. There can be other +playbooks on the same directory that use a subset of the roles used by the +main playbook site.yml. Examples of Playbook Function directory names: + +- configure – Contains post-instantiation (bulk) configuration + playbooks, roles,… + +- healthcheck – Contains VNF health check playbook(s), roles,… + +- stop – Contains VNF application stop (stopApplication) playbook(s), + roles,… + +- start – Contains VNF application start (startApplication) playbook(s), + roles,… + +Directory structure to allow hosting multiple version sets of playbooks, +for the same VNF type, to be hosted in the runtime environment on the +Ansible Servers. Generic directory structure: + +Ansible Playbooks – Function directory and main playbook: + +.. code-block:: none + + <VNF type>/<Version>/ansible/<Playbook Function>/site.yml + +Example – Post-instantiation (bulk) configuration –APPC Function - +Configure: + +.. code-block:: none + + <VNF type>/<Version>/ansible/configure/site.yml + +Example – Post-instantiation (bulk) configuration –APPC Function +– Configure – VNF software version 16.1: + +.. code-block:: none + + vfdb/V16.1/ansible/configure/site.yml + +Example – Health-check –APPC Function - HealthCheck: + +.. code-block:: none + + <VNF type>/<Version>/ansible/healthcheck/site.yml + +OR (Function directory name does not need to match APPC function name) + +.. code-block:: none + + <VNF type>/<Version>/ansible/check/site.yml + +Ansible Directories for other artifacts – VNF inventory hosts file - +Required: + +.. code-block:: none + + <VNF type>/<Version>/ansible/inventory/<VNF instance name>hosts + +Ansible Directories for other artifacts – VNF instance specific default +arguments – Optional: + +.. code-block:: none + + <VNF type>/<Version>/ansible/group_vars/<VNF instance name> + +NOTE: This requirement is expected to be deprecated all or in part in the +future, for automated actions, once APPC can pass down all VNF specific +arguments for each action. Requirement remains while manual actions are +to be supported. Other automated inventory management mechanisms may be +considered in the future, Ansible supports many automated inventory +management mechanisms/tools/solutions. + +Ansible Directories for other artifacts – VNF (special) groups – +Optional: + +.. code-block:: none + + <VNF type>/<Version>/ansible/inventory/group_vars/<VNF instance name> + +NOTE: Default groups will be created based on VNFC type, 3 characters, +on VNFC name. Example: “oam”, “rdb”, “dbs”, “man”, “iox”, “app”,… + +Ansible Directories for other artifacts – VNF (special) other files – +Optional – Example – License file: + +.. code-block:: none + + <VNF type>/<Version>/ansible/<Other directory(s)> + +CAUTION: On referenced files used/required by playbooks. + +- To avoid missing files, during on-boarding or uploading of Ansible + Playbooks and related artifacts, all permanent files (not generated + by playbooks as part of execution), required to run any playbook, + shall reside under the ansible root directory or below on other + subdirectories. + +- Any references to files, on includes or other playbook entries, shall + use relative paths. + +- This is the ansible (root) directory referenced on this + note (Ansible Server mount point not included): + +.. code-block:: none + + <VNF type>/<Version>/ansible/ + +There will be a soft link to the latest set of Ansible Playbooks for +each VNF type. + +VNF type directories use A&AI inventory VNF function code. Ansible +Playbooks will be stored on a Cinder Volume mounted on the Ansible +Servers as /storage. Example: + +/storage/vfdb/latest/ansible – This soft link point to the latest set of +playbooks (or the only set) + +/storage/vfdb/V16.1/ansible – Root directory for database VNF Ansible +Playbooks for release 16.1 + +CAUTION: To support this directory structure as the repository to store +Ansible Playbooks run by APPC, APPC API in the Ansible Server side needs +to be configured to run playbooks from directory, not MySQL database. + +Ansible Server HTTP will be configured to support APPC REST API requests +to run playbooks as needed, against specific VNF instances, or specific +VM(s) as specified in the request. + +ONAP APPC REST API to Ansible Server is documented separately and can be +found under ONAP (onap.org). + +**Ansible Server – On-boarding Ansible Playbooks** + +Once playbooks are developed following the guidelines listed in prior +section(s), playbooks need to be on-boarded onto Ansible Server(s). In +the future, they’ll be on-boarded and distributed through ONAP, at least +that is the proposed plan, but for now they need to be uploaded +manually. There is work in progress to use a Git as the playbook +repository to store and track playbooks by version, version control. + +These are the basic steps to on-board playbooks manually onto the +Ansible Server. + +1. Upload CSAR, zip, or tar file containing VNF playbooks and related + artifacts. + +2. Create full directory (using –p option below) to store Ansible + Playbooks and other artifacts under /storage (or other configured) + file system. + + a. Includes VNF type using VNF function code 4 characters under + /storage. + + b. Includes VNF “Version” directory as part of the path to store + playbooks for this VNF version. + + c. Include generic ansible root directory. Creating full directory + path as an example: + +.. code-block:: none + + $ mkdir –p /storage/vfdb/V16.1/ansible**/** + +3. Make this directory (VNF ansible root directory) current directory + for next few steps: + +.. code-block:: none + + cd /storage/vfdb/V16.1/ansible/ + +4. Extract Ansible Playbooks and other Ansible artifacts associated with + the playbooks onto the ansible directory. Command depends on the type + of file uploaded, examples would be: + +.. code-block:: none + + tar xvf .. + unzip … + bunzip .. + +5. Create VNF inventory hosts file with all VMs and + OA&M IP addresses for all VNF instances with known OA&M IP addresses + for respective VMs, example: + +.. code-block:: none + + $ mkdir inventory + + $ touch inventory/vfdb9904vhosts + + $ cat inventory/vfdb9904vhosts + + [host] + localhost ansible\_connection=local + + [oam] + 1xx.2yy.zzz.109 + 1xx.2yy.zzz.110 + + [rdb] + 1xx.2yy.zzz.105 + 1xx.2yy.zzz.106 + +6. (Optional, being deprecated) Create directory to hold default +arguments for each VNF instance, +example: + +.. code-block:: none + + $ mkdir –p vars/vfdb9904v + $ touch vars/vfdb9904v/default\_args.yml + $ cat vars/vfdb9904v/default\_args.yml + vm\_config\_oam1\_vnfc\_name: vfdb9904vm001oam001 + vm\_config\_oam1\_hostname: vfdb9904vm001 + vm\_config\_oam1\_provider\_ip\_address: 1xx.2yy.zzz.109 + + vm\_config\_oam2\_vnfc\_name: vfdb9904vm002oam001 + vm\_config\_oam2\_hostname: vfdb9904vm002 + vm\_config\_oam2\_provider\_ip\_address: 1xx.2yy.zzz.110 + + vm\_config\_rdb1\_vnfc\_name: vfdb9904vm003rdb001 + vm\_config\_rdb1\_hostname: vfdb9904vm003 + vm\_config\_rdb1\_provider\_ip\_address: 1xx.2yy.zzz.105 + + vm\_config\_rdb2\_vnfc\_name: vfdb9904vm004rdb001 + vm\_config\_rdb2\_hostname: vfdb9904vm004 + vm\_config\_rdb2\_provider\_ip\_address: 1xx.2yy.zzz.106 + + vm\_config\_rdb3\_vnfc\_name: vfdb9904vm005rdb001 + vm\_config\_rdb3\_hostname: vfdb9904vm005 + vm\_config\_rdb3\_provider\_ip\_address: 1xx.2yy.zzz.xxx + + vm\_config\_rdb4\_vnfc\_name: vfdb9904vm006rdb001 + vm\_config\_rdb4\_hostname: vfdb9904vm006 + vm\_config\_rdb4\_provider\_ip\_address: 1xx.2yy.zzz.yyy + +NOTE: Please note names in this file shall use underscore “\_” not dots +“.” or dashes “-“. + +7. Perform some basic playbook validation running with “--check” option, + running dummy playbooks or other. + +NOTE: Each Ansible Server or cluster of Ansible Server will have its own +credentials to authenticate to VNF VMs. Ansible Server SSH public key(s) +have to be loaded onto VNF VMs during instantiation or other way before +Ansible Server can access VNF VMs and run playbooks. HOT templates used +by heat to instantiate VNFs to be configured by these Ansible Servers running +playbooks shall include the same SSH public key and load them onto VNF VM(s) +as part of instantiation. + +Other non-vendor specific playbook tasks need to be incorporated in overall +post-instantiation configuration playbook. Alternative is for company +developed playbooks to be uploaded and executed, after VNF vendor provided +playbooks are run. + +**A couple of playbooks used for proof-of-concept testing as examples:** + +UpgradePreCheck: + +.. code-block:: none + + $ pwd + /storage/comx/V5.3.1.3/ansible/upgradeprecheck + + $ more site.yml + --- + + - import_playbook: ../common/create_vars.yml + - import_playbook: ../common/create_hosts.yml + + - name: upgrade software pre check + hosts: oam,dbs,cpm + gather_facts: no + become: true + become_method: sudo + become_user: root + max_fail_percentage: 0 + any_errors_fatal: True + roles: + - precheck + tags: precheck + + $ more roles/precheck/tasks/main.yml + --- + + - include_vars: /tmp/{{ vnf_instance }}/all.yml + + - name: get software version installed on vnf + shell: grep "^SW_VERSION =" /vendor/software/config/param_common.cfg | grep -c "{{ existing_software_version }}" + register: version_line + ignore_errors: yes + + - name: send msg when matches expected version + debug: msg="*** OK *** VNF software release matches (old) release to be upgraded." + verbosity=1 + when: version_line.stdout.find('1') != -1 + + # send warning message and failure when release is not a match + - fail: + msg="*** WARNING *** VNF software release does not match expected (pre-upgrade) release." + when: (version_line | failed) or version_line.stdout.find('1') == -1 + + +UpgradePostCheck: + +.. code-block:: none + + $ pwd + /storage/comx/V5.3.1.3/ansible/upgradepostcheck + + $ more site.yml + --- + + - import_playbook: ../common/create_vars.yml + - import_playbook: ../common/create_hosts.yml + + - name: upgrade software post check + hosts: oam,dbs,cpm + gather_facts: no + become: true + become_method: sudo + become_user: root + max_fail_percentage: 0 + any_errors_fatal: True + roles: + - postcheck + tags: postcheck + + $ more roles/postcheck/tasks/main.yml + --- + + - include_vars: /tmp/{{ vnf_instance }}/all.yml + + - name: get post upgrade software version installed on vnf + shell: grep "^SW_VERSION =" /vendor/software/config/param_common.cfg | grep -c "{{ new_software_version }}" + register: version_line + ignore_errors: yes + + - name: send msg when matches expected version + debug: msg="*** OK *** VNF software release matches new release." + verbosity=1 + when: version_line.stdout.find('1') != -1 + + # send warning message and failure when release is not a match + - fail: + msg="*** WARNING *** VNF software release does not match expected new (post-upgrade) release." + when: (version_line | failed) or version_line.stdout.find('1') == -1 + diff --git a/docs/Chapter8/Chef-JSON-Key-Value-Description.rst b/docs/Chapter8/Chef-JSON-Key-Value-Description.rst new file mode 100644 index 0000000..7144159 --- /dev/null +++ b/docs/Chapter8/Chef-JSON-Key-Value-Description.rst @@ -0,0 +1,178 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Chef JSON Key Value Description +------------------------------------- + +The following provides the key value pairs that must be contained in the +JSON file supporting Chef action. + +Table A1. Chef JSON File key value description +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++----------------+--------------------------+---------+----------------------+ +| **Field Name** | **Description** | **Type**| **Comment** | ++================+==========================+=========+======================+ +| Environment | A JSON dictionary | Optional|Depends on VNF action.| +| | representing a Chef | | | +| | Environment object. If | | | +| | the VNF action requires | | | +| | loading or modifying Chef| | | +| | environment attributes | | | +| | associated with the VNF, | | | +| | all the relevant | | | +| | information must be | | | +| | provided in this JSON | | | +| | dictionary in a structure| | | +| | that conforms to a Chef | | | +| | Environment Object. | | | ++----------------+--------------------------+---------+----------------------+ +| Node | A JSON dictionary |Mandatory| | +| | representing a Chef Node | | | +| | Object. | | | +| | | | | +| | The Node JSON dictionary | | | +| | must include the run list| | | +| | to be triggered for the | | | +| | desired VNF action by the| | | +| | push job. It should also | | | +| | include any attributes | | | +| | that need to be | | | +| | configured on the Node | | | +| | Object as part of the VNF| | | +| | action. | | | ++----------------+--------------------------+---------+----------------------+ +| NodeList | Array of FQDNs that |Mandatory| | +| | correspond to the | | | +| | endpoints (VMs) of a VNF | | | +| | registered with the Chef | | | +| | Server that need to | | | +| | trigger a chef-client run| | | +| | as part of the desired | | | +| | VNF action. | | | ++----------------+--------------------------+---------+----------------------+ +| PushJobFlag | This field indicates |Mandatory| If set to “True”, | +| | whether the VNF action | | ONAP will request a | +| | requires a push Job. Push| | push job. Ignored | +| | job object will be | | otherwise. | +| | created by ONAP if | | | +| | required. | | | ++----------------+--------------------------+---------+----------------------+ +| CallbackCapable| This field indicates if | Optional| If Chef cookbook is | +| | the chef-client run | | callback capable, VNF| +| | invoked by push job | | owner is required to | +| | corresponding to the VNF | | set it to “True”. | +| | action is capable of | | Ignored otherwise. | +| | posting results on a | | | +| | callback URL. | | | ++----------------+--------------------------+---------+----------------------+ +| GetOutputFlag | Flag which indicates |Mandatory| ONAP will retrieve | +| | whether ONAP should | | output from | +| | retrieve output generated| | NodeObject attributes| +| | in a chef-client run from| | [‘PushJobOutput’] for| +| | Node object attribute | | all nodes in NodeList| +| | node[‘PushJobOutput’] for| | if set to “True”. | +| | this VNF action (e.g., in| | Ignored otherwise. | +| | Audit). | | | ++----------------+--------------------------+---------+----------------------+ + +Chef Template example: + +.. code-block:: chef + + “Environment”:{ + "name": "HAR", + "description": "VNF Chef environment for HAR", + "json\_class": "Chef::Environment", + "chef\_type": "environment", + "default\_attributes": { }, + "override\_attributes": { + “Retry\_Time”:”50”, + “MemCache”: “1024”, + “Database\_IP”:”10.10.1.5” + }, + } + } + “Node”: { + “name” : “signal.network.com “ + "chef\_type": "node", + "json\_class": "Chef::Node", + "attributes": { + “IPAddress1”: “192.168.1.2”, + “IPAddress2”:”135.16.162.5”, + “MyRole”:”BE” + }, + "override": {}, + "default": {}, + “normal”:{}, + “automatic”:{}, + “chef\_environment” : “\_default” + "run\_list": [ "configure\_signal" ] + }, + “NodeList”:[“node1.vnf\_a.onap.com”, “node2.vnf\_a.onap.com”], + “PushJobFlag”: “True” + “CallbackCapable”:True + “GetOutputFlag” : “False” + } + +The example JSON file provided by the VNF provider for each VNF action will be +turned into a template by ONAP, that can be updated with instance +specific values at run-time. + +Some points worth noting regarding the JSON fields: + +a. The JSON file must be created for each action for each VNF. + +b. If a VNF action involves multiple endpoints (VMs) of a VNF, ONAP will + replicate the “Node” JSON dictionary in the template and post it to + each FQDN (i.e., endpoint) in the NodeList after setting the “name” + field in the Node object to be the respective FQDN [1]_. Hence, it + is required that all end points (VMs) of a VNF involved in a VNF + action support the same set of Node Object attributes. + +The following table describes the JSON dictionary to post in Callback. + +Table A2. JSON Dictionary to Post in Callback +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++--------------+----------------------------+---------+-----------------------+ +| **Key** | **Description** | **Type**| **Comment** | ++==============+============================+=========+=======================+ +| RequestId | A unique string associated |Mandatory| | +| | with the original request | | | +| | by ONAP. This key-value | | | +| | pair will be provided by | | | +| | ONAP in the environment of | | | +| | the push job request and | | | +| | must be returned as part of| | | +| | the POST message. | | | ++--------------+----------------------------+---------+-----------------------+ +| StatusCode | An integer that must be set|Mandatory| | +| | to 200 if chef-client run | | | +| | on the node finished | | | +| | successfully 500 otherwise.| | | ++--------------+----------------------------+---------+-----------------------+ +| StatusMessage| A string which must be set |Mandatory| | +| | to ‘SUCCESS’ if StatusCode | | | +| | was 200 | | | +| | | | | +| | Appropriate error message | | | +| | otherwise. | | | ++--------------+----------------------------+---------+-----------------------+ +| Name | A string which corresponds |Mandatory| | +| | to the name of the node | | | +| | where push job is run. It | | | +| | is required that the value | | | +| | be retrieved from the node | | | +| | object attributes (where it| | | +| | is always defined). | | | ++--------------+----------------------------+---------+-----------------------+ +| PushJobOutput| Any output from the |Optional | Depends on VNF action.| +| | chef-client run that needs | | If empty, it must not | +| | to be returned to ONAP. | | be included. | ++--------------+----------------------------+---------+-----------------------+ + +.. [1] + The “name” field is a mandatory field in a valid Chef Node Object + JSON dictionary. diff --git a/docs/Chapter8.rst b/docs/Chapter8/Requirement-List.rst index 952c263..41c9ea2 100644 --- a/docs/Chapter8.rst +++ b/docs/Chapter8/Requirement-List.rst @@ -2,884 +2,6 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -Appendix -======== - -Chef JSON Key Value Description -------------------------------------- - -The following provides the key value pairs that must be contained in the -JSON file supporting Chef action. - -Table A1. Chef JSON File key value description -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+----------------+--------------------------+---------+----------------------+ -| **Field Name** | **Description** | **Type**| **Comment** | -+================+==========================+=========+======================+ -| Environment | A JSON dictionary | Optional|Depends on VNF action.| -| | representing a Chef | | | -| | Environment object. If | | | -| | the VNF action requires | | | -| | loading or modifying Chef| | | -| | environment attributes | | | -| | associated with the VNF, | | | -| | all the relevant | | | -| | information must be | | | -| | provided in this JSON | | | -| | dictionary in a structure| | | -| | that conforms to a Chef | | | -| | Environment Object. | | | -+----------------+--------------------------+---------+----------------------+ -| Node | A JSON dictionary |Mandatory| | -| | representing a Chef Node | | | -| | Object. | | | -| | | | | -| | The Node JSON dictionary | | | -| | must include the run list| | | -| | to be triggered for the | | | -| | desired VNF action by the| | | -| | push job. It should also | | | -| | include any attributes | | | -| | that need to be | | | -| | configured on the Node | | | -| | Object as part of the VNF| | | -| | action. | | | -+----------------+--------------------------+---------+----------------------+ -| NodeList | Array of FQDNs that |Mandatory| | -| | correspond to the | | | -| | endpoints (VMs) of a VNF | | | -| | registered with the Chef | | | -| | Server that need to | | | -| | trigger a chef-client run| | | -| | as part of the desired | | | -| | VNF action. | | | -+----------------+--------------------------+---------+----------------------+ -| PushJobFlag | This field indicates |Mandatory| If set to “True”, | -| | whether the VNF action | | ONAP will request a | -| | requires a push Job. Push| | push job. Ignored | -| | job object will be | | otherwise. | -| | created by ONAP if | | | -| | required. | | | -+----------------+--------------------------+---------+----------------------+ -| CallbackCapable| This field indicates if | Optional| If Chef cookbook is | -| | the chef-client run | | callback capable, VNF| -| | invoked by push job | | owner is required to | -| | corresponding to the VNF | | set it to “True”. | -| | action is capable of | | Ignored otherwise. | -| | posting results on a | | | -| | callback URL. | | | -+----------------+--------------------------+---------+----------------------+ -| GetOutputFlag | Flag which indicates |Mandatory| ONAP will retrieve | -| | whether ONAP should | | output from | -| | retrieve output generated| | NodeObject attributes| -| | in a chef-client run from| | [‘PushJobOutput’] for| -| | Node object attribute | | all nodes in NodeList| -| | node[‘PushJobOutput’] for| | if set to “True”. | -| | this VNF action (e.g., in| | Ignored otherwise. | -| | Audit). | | | -+----------------+--------------------------+---------+----------------------+ - -Chef Template example: - -.. code-block:: chef - - “Environment”:{ - "name": "HAR", - "description": "VNF Chef environment for HAR", - "json\_class": "Chef::Environment", - "chef\_type": "environment", - "default\_attributes": { }, - "override\_attributes": { - “Retry\_Time”:”50”, - “MemCache”: “1024”, - “Database\_IP”:”10.10.1.5” - }, - } - } - “Node”: { - “name” : “signal.network.com “ - "chef\_type": "node", - "json\_class": "Chef::Node", - "attributes": { - “IPAddress1”: “192.168.1.2”, - “IPAddress2”:”135.16.162.5”, - “MyRole”:”BE” - }, - "override": {}, - "default": {}, - “normal”:{}, - “automatic”:{}, - “chef\_environment” : “\_default” - "run\_list": [ "configure\_signal" ] - }, - “NodeList”:[“node1.vnf\_a.onap.com”, “node2.vnf\_a.onap.com”], - “PushJobFlag”: “True” - “CallbackCapable”:True - “GetOutputFlag” : “False” - } - -The example JSON file provided by the VNF provider for each VNF action will be -turned into a template by ONAP, that can be updated with instance -specific values at run-time. - -Some points worth noting regarding the JSON fields: - -a. The JSON file must be created for each action for each VNF. - -b. If a VNF action involves multiple endpoints (VMs) of a VNF, ONAP will - replicate the “Node” JSON dictionary in the template and post it to - each FQDN (i.e., endpoint) in the NodeList after setting the “name” - field in the Node object to be the respective FQDN [1]_. Hence, it - is required that all end points (VMs) of a VNF involved in a VNF - action support the same set of Node Object attributes. - -The following table describes the JSON dictionary to post in Callback. - -Table A2. JSON Dictionary to Post in Callback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+--------------+----------------------------+---------+-----------------------+ -| **Key** | **Description** | **Type**| **Comment** | -+==============+============================+=========+=======================+ -| RequestId | A unique string associated |Mandatory| | -| | with the original request | | | -| | by ONAP. This key-value | | | -| | pair will be provided by | | | -| | ONAP in the environment of | | | -| | the push job request and | | | -| | must be returned as part of| | | -| | the POST message. | | | -+--------------+----------------------------+---------+-----------------------+ -| StatusCode | An integer that must be set|Mandatory| | -| | to 200 if chef-client run | | | -| | on the node finished | | | -| | successfully 500 otherwise.| | | -+--------------+----------------------------+---------+-----------------------+ -| StatusMessage| A string which must be set |Mandatory| | -| | to ‘SUCCESS’ if StatusCode | | | -| | was 200 | | | -| | | | | -| | Appropriate error message | | | -| | otherwise. | | | -+--------------+----------------------------+---------+-----------------------+ -| Name | A string which corresponds |Mandatory| | -| | to the name of the node | | | -| | where push job is run. It | | | -| | is required that the value | | | -| | be retrieved from the node | | | -| | object attributes (where it| | | -| | is always defined). | | | -+--------------+----------------------------+---------+-----------------------+ -| PushJobOutput| Any output from the |Optional | Depends on VNF action.| -| | chef-client run that needs | | If empty, it must not | -| | to be returned to ONAP. | | be included. | -+--------------+----------------------------+---------+-----------------------+ - -Ansible JSON Key Value Description -------------------------------------------------------------- - -The following provides the key value pairs that must be contained in the -JSON file supporting Ansible action. - -Table B1. Ansible JSON File key value description -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+---------------+----------------------+---------+----------------------------+ -| **Field Name**| **Description** | **Type**| **Comment** | -+===============+======================+=========+============================+ -| PlaybookName | VNF providor must |Mandatory|Currently following | -| | list name of the | |Ansible standard | -| | playbook relative | |naming, where main | -| | path used to | |playbook is always | -| | execute the VNF | |named site.yml, and | -| | action. | |directory name where | -| | | |this main playbook resides, | -| | | |is named after the | -| | | |command/action playbook | -| | | |performs, in lower case, | -| | | |example, configure. | -+---------------+----------------------+---------+----------------------------+ -| Action | Name of VNF action. | Optional| | -+---------------+----------------------+---------+----------------------------+ -| EnvParameters | A JSON dictionary | Optional|Depends on the VNF action. | -| | which should list key| | | -| | value pairs to be | |Attribute names (variable | -| | passed to the Ansible| |names) passed to Ansible | -| | playbook. These | |shall follow Ansible valid | -| | values would | |variable names: “Variable | -| | correspond to | |names should be letters, | -| | instance specific | |numbers, and underscores. | -| | parameters that a | |Variables should always | -| | playbook may need to | |start with a letter.” | -| | execute an action. | | | -+---------------+----------------------+---------+----------------------------+ -| NodeList |Ansible inventory | Optional|If not provided, pre-loaded | -| |hosts file with | |(VNF) inventory hosts | -| |VNF groups and | |file must exist in the | -| |respective IP | |Ansible Server otherwise | -| |addresses or DNS | |request fails. | -| |supported FQDNs | | | -| |that the playbook must| | | -| |be executed against. | | | -+---------------+----------------------+---------+----------------------------+ -| FileParameters| A JSON dictionary | Optional| Depends on the VNF action | -| | where keys are | | and playbook design. | -| | filenames and values | | | -| | are contents of | | | -| | files. The Ansible | | | -| | Server will utilize | | | -| | this feature to | | | -| | generate files with | | | -| | keys as filenames and| | | -| | values as content. | | | -| | This attribute can be| | | -| | used to generate | | | -| | files that a playbook| | | -| | may require as part | | | -| | of execution. | | | -+---------------+----------------------+---------+----------------------------+ -| Timeout | Time (in seconds) | Optional| | -| | that a playbook is | | | -| | expected to take to | | | -| | finish execution for | | | -| | the VNF. If playbook | | | -| | execution time | | | -| | exceeds this value, | | | -| | Ansible Server will | | | -| | terminate the | | | -| | playbook process. | | | -+---------------+----------------------+---------+----------------------------+ - -Ansible JSON file example: - -{ - - “Action”:”Configure”, - - "PlaybookName": "<VNFCode>/<Version>/ansible/configure/site.yml", - - "NodeList": ["test1.vnf\_b.onap.com", “test2.vnf\_b.onap.com”], - - "Timeout": 60, - - "EnvParameters": {"Retry": 3, "Wait": 5, “ConfigFile”:”config.txt”}, - - “FileParameters”:{“config.txt”:”db\_ip=10.1.1.1, sip\_timer=10000”} - -} - -In the above example, the Ansible Server will: - -a. Process the “FileParameters” dictionary and generate a file named - ‘config.txt’ with contents set to the value of the ‘config.txt’ key. - -b. Execute the playbook named ‘<VNFCode>/<Version>/ansible/configure/site.yml’ - on nodes with FQDNs test1.vnf\_b.onap.com and test2.vnf\_b.onap.com - respectively while providing the following key value pairs to the playbook: - Retry=3, Wait=5, ConfigFile=config.txt - - -c. If execution time of the playbook exceeds 60 secs (across all hosts), - it will be terminated. - -VNF License Information Guidelines ------------------------------------------------------------- - -This Appendix describes the metadata to be supplied for VNF licenses. - -1. General Information - -Table C1 defines the required and optional fields for licenses. - -Table C1. Required Fields for General Information -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+---------------+-----------------------------------+--------------+----------+ -| **Field Name**| **Description** | **Data Type**| **Type** | -+===============+===================================+==============+==========+ -| VNF Provider | The name of the VNF provider. | String | Mandatory| -| Name | | | | -+---------------+-----------------------------------+--------------+----------+ -| VNF Provider | The name of the product to which | String | Mandatory| -| Product | this agreement applies. | | | -| | | | | -| | Note: a contract/agreement may | | | -| | apply to more than one VNF | | | -| | provider product. In that case, | | | -| | provide the metadata for each | | | -| | product separately. | | | -+---------------+-----------------------------------+--------------+----------+ -| VNF Provider | A general description of VNF | String | Optional | -| Product | provider software product. | | | -| Description | | | | -+---------------+-----------------------------------+--------------+----------+ -| Export Control| ECCNs are 5-character | String | Mandatory| -| Classification| alpha-numeric designations used on| | | -| Number (ECCN) | the Commerce Control List (CCL) to| | | -| | identify dual-use items for export| | | -| | control purposes. An ECCN | | | -| | categorizes items based on the | | | -| | nature of the product, i.e. type | | | -| | of commodity, software, or | | | -| | technology and its respective | | | -| | technical parameters. | | | -+---------------+-----------------------------------+--------------+----------+ -| Reporting | A list of any reporting | List of | Optional | -| Requirements | requirements on the usage of the | strings | | -| | software product. | | | -+---------------+-----------------------------------+--------------+----------+ - -1. Entitlements - -Entitlements describe software license use rights. The use rights may be -quantified by various metrics: # users, # software instances, # units. -The use rights may be limited by various criteria: location (physical or -logical), type of customer, type of device, time, etc. - -One or more entitlements can be defined; each one consists of the -following fields: - -Table C2. Required Fields for Entitlements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+---------------+-----------------------------------+-------------+-----------+ -| **Field Name**| **Description** |**Data Type**| **Type** | -+===============+===================================+=============+===========+ -| VNF Provider | Identifier for the entitlement as | String | Mandatory | -| Part Number / | described by the VNF provider in | | | -| Manufacture | their price list / catalog / | | | -| Reference | contract. | | | -| Number | | | | -+---------------+-----------------------------------+-------------+-----------+ -| Description | Verbiage that describes the | String | Optional | -| | entitlement | | | -+---------------+-----------------------------------+-------------+-----------+ -| Entitlement | Each entitlement defined must be | String | Mandatory | -| Identifier | identified by a unique value (e.g.| | | -| | numbered 1, 2, 3….) | | | -+---------------+-----------------------------------+-------------+-----------+ -| Minimum Order | The minimum number of entitlements| Number | Mandatory | -| Requirement | that need to be purchased. | | | -| | For example, the entitlements must| | | -| | be purchased in a block of 100. If| | | -| | no minimum is required, the value | | | -| | will be zero. | | | -+---------------+-----------------------------------+-------------+-----------+ -| Unique | A list of any reporting | List of | Optional | -| Reporting | requirements on the usage of the | Strings | | -| Requirements | software product. (e.g.: quarterly| | | -| | usage reports are required) | | | -+---------------+-----------------------------------+-------------+-----------+ -| License Type | Type of license applicable to the | String | Mandatory | -| | software product. (e.g.: | | | -| | fixed-term, perpetual, trial, | | | -| | subscription.) | | | -+---------------+-----------------------------------+-------------+-----------+ -| License | Valid values: | String |Conditional| -| Duration | | | | -| | **year**, **quarter**, **month**, | | | -| | **day**. | | | -| | | | | -| | Not applicable when license type | | | -| | is Perpetual. | | | -+---------------+-----------------------------------+-------------+-----------+ -| License | Number of years, quarters, months,| Number |Conditional| -| Duration | or days for which the license is | | | -| Quantification| valid. | | | -| | | | | -| | Not applicable when license type | | | -| | is Perpetual. | | | -+---------------+-----------------------------------+-------------+-----------+ -| Limits | see section C.4 for possible | List | Optional | -| | values | | | -+---------------+-----------------------------------+-------------+-----------+ - -1. License Keys - -This section defines information on any License Keys associated with the -Software Product. A license key is a data string (or a file) providing a -means to authorize the use of software. License key does not provide -entitlement information. - -License Keys are not required. Optionally, one or more license keys can -be defined; each one consists of the following fields: - -Table C3. Required Fields for License Keys -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+---------------+-----------------------------------+--------------+----------+ -| **Field Name**| **Description** | **Data Type**| **Type** | -+===============+===================================+==============+==========+ -| Description | Verbiage that describes the | String | Mandatory| -| | license key | | | -+---------------+-----------------------------------+--------------+----------+ -| License Key | Each license key defined must be | String | Mandatory| -| Identifier | identified by a unique value | | | -| | (e.g., numbered 1, 2, 3….) | | | -+---------------+-----------------------------------+--------------+----------+ -| Key Function | Lifecycle stage (e.g., | String | Optional | -| | Instantiation or Activation) at | | | -| | which the license key is applied | | | -| | to the software. | | | -+---------------+-----------------------------------+--------------+----------+ -| License Key | Valid values: | String | Mandatory| -| Type | | | | -| | **Universal, Unique** | | | -| | | | | -| | **Universal** - a single license | | | -| | key value that may be used with | | | -| | any number of instances of the | | | -| | software. | | | -| | | | | -| | **Unique**- a unique license key | | | -| | value is required for each | | | -| | instance of the software. | | | -+---------------+-----------------------------------+--------------+----------+ -| Limits | see section C.4 for possible | List | Optional | -| | values | | | -+---------------+-----------------------------------+--------------+----------+ - -1. Entitlement and License Key Limits - -Limitations on the use of software entitlements and license keys may be -based on factors such as: features enabled in the product, the allowed -capacity of the product, number of installations, etc... The limits may -generally be categorized as: - -- where (location) - -- when (time) - -- how (usages) - -- who/what (entity) - -- amount (how much) - -Multiple limits may be applicable for an entitlement or license key. -Each limit may further be described by limit behavior, duration, -quantification, aggregation, aggregation interval, start date, end date, -and threshold. - -When the limit is associated with a quantity, the quantity is relative -to an instance of the entitlement or license key. For example: - -- Each entitlement grants the right to 50 concurrent users. If 10 - entitlements are purchased, the total number of concurrent users - permitted would be 500. In this example, the limit category is - **amount**, the limit type is **users**, and the limit - **quantification** is **50.** - - Each license key may be installed on 3 devices. If 5 license keys are - acquired, the total number of devices allowed would be 15. In this - example, the limit category is **usages**, the limit type is - **device**, and the limit **quantification** is **3.** - -1. Location - -Locations may be logical or physical location (e.g., site, country). For -example: - -- use is allowed in Canada - -Table C4. Required Fields for Location -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------+--------------------------------+--------------+----------+ -| **Field Name** | **Description** | **Data Type**| **Type** | -+==================+================================+==============+==========+ -| Limit Identifier | Each limit defined for an | String | Mandatory| -| | entitlement or license key must| | | -| | be identified by a unique value| | | -| | (e.g., numbered 1,2,3…) | | | -+------------------+--------------------------------+--------------+----------+ -| Limit Description| Verbiage describing the limit. | String | Mandatory| -+------------------+--------------------------------+--------------+----------+ -| Limit Behavior | Description of the actions | String | Mandatory| -| | taken when the limit boundaries| | | -| | are reached. | | | -+------------------+--------------------------------+--------------+----------+ -| Limit Category | Valid value: **location** | String | Mandatory| -+------------------+--------------------------------+--------------+----------+ -| Limit Type | Valid values: **city, county, | String | Mandatory| -| | state, country, region, MSA, | | | -| | BTA, CLLI** | | | -+------------------+--------------------------------+--------------+----------+ -| Limit List | List of locations where the VNF| List of | Mandatory| -| | provider Product can be used or| String | | -| | needs to be restricted from use| | | -+------------------+--------------------------------+--------------+----------+ -| Limit Set Type | Indicates if the list is an | String | Mandatory| -| | inclusion or exclusion. | | | -| | | | | -| | Valid Values: | | | -| | | | | -| | **Allowed** | | | -| | | | | -| | **Not allowed** | | | -+------------------+--------------------------------+--------------+----------+ -| Limit | The quantity (amount) the limit| Number | Optional | -| Quantification | expresses. | | | -+------------------+--------------------------------+--------------+----------+ - -1. Time - -Limit on the length of time the software may be used. For example: - -- license key valid for 1 year from activation - -- entitlement valid from 15 May 2018 thru 30 June 2020 - -Table C5. Required Fields for Time -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------+-------------------------------+--------------+-----------+ -| **Field Name** | **Description** | **Data Type**| **Type** | -+==================+===============================+==============+===========+ -| Limit Identifier | Each limit defined for an | String | Mandatory | -| | entitlement or license key | | | -| | must be identified by a unique| | | -| | value (e.g., numbered) | | | -+------------------+-------------------------------+--------------+-----------+ -| Limit Description| Verbiage describing the limit.| String | Mandatory | -+------------------+-------------------------------+--------------+-----------+ -| Limit Behavior | Description of the actions | String | Mandatory | -| | taken when the limit | | | -| | boundaries are reached. | | | -| | | | | -| | The limit behavior may also | | | -| | describe when a time limit | | | -| | takes effect. (e.g., key is | | | -| | valid for 1 year from date of | | | -| | purchase). | | | -+------------------+-------------------------------+--------------+-----------+ -| Limit Category | Valid value: **time** | String | Mandatory | -+------------------+-------------------------------+--------------+-----------+ -| Limit Type | Valid values: | String | Mandatory | -| | **duration, date** | | | -+------------------+-------------------------------+--------------+-----------+ -| Limit List | List of times for which the | List of | Mandatory | -| | VNF Provider Product can be | String | | -| | used or needs to be restricted| | | -| | from use | | | -+------------------+-------------------------------+--------------+-----------+ -| Duration Units | Required when limit type is | String |Conditional| -| | duration. Valid values: | | | -| | **perpetual, year, quarter, | | | -| | month, day, minute, second, | | | -| | millisecond** | | | -+------------------+-------------------------------+--------------+-----------+ -| Limit | The quantity (amount) the | Number | Optional | -| Quantification | limit expresses. | | | -+------------------+-------------------------------+--------------+-----------+ -| Start Date | Required when limit type is | Date | Optional | -| | date. | | | -+------------------+-------------------------------+--------------+-----------+ -| End Date | May be used when limit type is| Date | Optional | -| | date. | | | -+------------------+-------------------------------+--------------+-----------+ - -1. Usage - -Limits based on how the software is used. For example: - -- use is limited to a specific sub-set of the features/capabilities the - software supports - -- use is limited to a certain environment (e.g., test, development, - production…) - -- use is limited by processor (vm, cpu, core) - -- use is limited by software release - -Table C6. Required Fields for Usage -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------+-------------------------------+---------------+----------+ -| **Field Name** | **Description** | **Data Type** | **Type** | -+==================+===============================+===============+==========+ -| Limit Identifier | Each limit defined for an | String | Mandatory| -| | entitlement or license key | | | -| | must be identified by a unique| | | -| | value (e.g., numbered) | | | -+------------------+-------------------------------+---------------+----------+ -| Limit Description| Verbiage describing the limit.| String | Mandatory| -+------------------+-------------------------------+---------------+----------+ -| Limit Behavior | Description of the actions | String | Mandatory| -| | taken when the limit | | | -| | boundaries are reached. | | | -+------------------+-------------------------------+---------------+----------+ -| Limit Category | Valid value: **usages** | String | Mandatory| -+------------------+-------------------------------+---------------+----------+ -| Limit Type | Valid values: **feature, | String | Mandatory| -| | environment, processor, | | | -| | version** | | | -+------------------+-------------------------------+---------------+----------+ -| Limit List | List of usage limits (e.g., | List of String| Mandatory| -| | test, development, vm, core, | | | -| | R1.2.1, R1.3.5…) | | | -+------------------+-------------------------------+---------------+----------+ -| Limit Set Type | Indicates if the list is an | String | Mandatory| -| | inclusion or exclusion. | | | -| | | | | -| | Valid Values: | | | -| | | | | -| | **Allowed** | | | -| | | | | -| | **Not allowed** | | | -+------------------+-------------------------------+---------------+----------+ -| Limit | The quantity (amount) the | Number | Optional | -| Quantification | limit expresses. | | | -+------------------+-------------------------------+---------------+----------+ - -1. Entity - -Limit on the entity (product line, organization, customer) allowed to -make use of the software. For example: - -- allowed to be used in support of wireless products - -- allowed to be used only for government entities - -Table C7. Required Fields for Entity -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------+--------------------------------+--------------+----------+ -| **Field Name** | **Description** |**Data Type** | **Type** | -+==================+================================+==============+==========+ -| Limit Identifier | Each limit defined for an | String | Mandatory| -| | entitlement or license key must| | | -| | be identified by a unique value| | | -| | (e.g., numbered) | | | -+------------------+--------------------------------+--------------+----------+ -| Limit Description| Verbiage describing the limit. | String | Mandatory| -+------------------+--------------------------------+--------------+----------+ -| Limit Behavior | Description of the actions | String | Mandatory| -| | taken when the limit boundaries| | | -| | are reached. | | | -+------------------+--------------------------------+--------------+----------+ -| Limit Category | Valid value: **entity** | String | Mandatory| -+------------------+--------------------------------+--------------+----------+ -| Limit Type | Valid values: **product line, | String | Mandatory| -| | organization, internal | | | -| | customer, external customer** | | | -+------------------+--------------------------------+--------------+----------+ -| Limit List | List of entities for which the |List of String| Mandatory| -| | VNF Provider Product can be | | | -| | used or needs to be restricted | | | -| | from use | | | -+------------------+--------------------------------+--------------+----------+ -| Limit Set Type | Indicates if the list is an | String | Mandatory| -| | inclusion or exclusion. | | | -| | | | | -| | Valid Values: | | | -| | | | | -| | **Allowed** | | | -| | | | | -| | **Not allowed** | | | -+------------------+--------------------------------+--------------+----------+ -| Limit | The quantity (amount) the limit| Number | Optional | -| Quantification | expresses. | | | -+------------------+--------------------------------+--------------+----------+ - -1. Amount - -These limits describe terms relative to utilization of the functions of -the software (for example, number of named users permitted, throughput, -or capacity). Limits of this type may also be relative to utilization of -other resources (for example, a limit for firewall software is not based -on use of the firewall software, but on the number of network -subscribers). - -The metadata describing this type of limit includes the unit of measure -(e.g., # users, # sessions, # MB, # TB, etc.), the quantity of units, -any aggregation function (e.g., peak or average users), and aggregation -interval (day, month, quarter, year, etc.). - -Table C8. Required Fields for Amount -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------+---------------------------------+-------------+----------+ -| **Field Name** | **Description** |**Data Type**| **Type** | -+==================+=================================+=============+==========+ -| Limit Identifier | Each limit defined for an | String | Mandatory| -| | entitlement or license key must | | | -| | be identified by a unique value | | | -| | (e.g., numbered) | | | -+------------------+---------------------------------+-------------+----------+ -| Limit Description| Verbiage describing the limit. | String | Mandatory| -+------------------+---------------------------------+-------------+----------+ -| Limit Behavior | Description of the actions taken| String | Mandatory| -| | when the limit boundaries are | | | -| | reached. | | | -+------------------+---------------------------------+-------------+----------+ -| Limit Category | Valid value: **amount** | String | Mandatory| -+------------------+---------------------------------+-------------+----------+ -| Limit Type | Valid values: **trunk, user, | String | Mandatory| -| | subscriber, session, token, | | | -| | transactions, seats, KB, MB, TB,| | | -| | GB** | | | -+------------------+---------------------------------+-------------+----------+ -| Type of | Is the limit relative to | String | Mandatory| -| Utilization | utilization of the functions of | | | -| | the software or relative to | | | -| | utilization of other resources? | | | -| | | | | -| | Valid values: | | | -| | | | | -| | - **software functions** | | | -| | | | | -| | - **other resources** | | | -+------------------+---------------------------------+-------------+----------+ -| Limit | The quantity (amount) the limit | Number | Optional | -| Quantification | expresses. | | | -+------------------+---------------------------------+-------------+----------+ -| Aggregation | Valid values: **peak, average** | String | Optional | -| Function | | | | -+------------------+---------------------------------+-------------+----------+ -| Aggregation | Time period over which the | String | Optional | -| Interval | aggregation is done (e.g., | | | -| | average sessions per quarter). | | | -| | Required when an Aggregation | | | -| | Function is specified. | | | -| | | | | -| | Valid values: **day, month, | | | -| | quarter, year, minute, second, | | | -| | millisecond** | | | -+------------------+---------------------------------+-------------+----------+ -| Aggregation | Is the limit quantity applicable| String | Optional | -| Scope | to a single entitlement or | | | -| | license key (each separately)? | | | -| | Or may the limit quantity be | | | -| | combined with others of the same| | | -| | type (resulting in limit amount | | | -| | that is the sum of all the | | | -| | purchased entitlements or | | | -| | license keys)? | | | -| | | | | -| | Valid values: | | | -| | | | | -| | - **single** | | | -| | | | | -| | - **combined** | | | -+------------------+---------------------------------+-------------+----------+ -| Type of User | Describes the types of users of | String | Optional | -| | the functionality offered by the| | | -| | software (e.g., authorized, | | | -| | named). This field is included | | | -| | when Limit Type is user. | | | -+------------------+---------------------------------+-------------+----------+ - -TOSCA model ------------------------------ - -Table D1. ONAP Resource DM TOSCA/YAML constructs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Standard TOSCA/YAML definitions agreed by VNF SDK Modeling team to be used by -VNF vendors to create a standard VNF descriptor. - -All definitions are summarized in the table below based on the agreed ONAP -Resource DM TOSCA/YAML constructs for Beijing. Their syntax is specified in -ETSI GS NFV-SOL001 stable draft for VNF-D. - -+------------+------------------------------+---------------------------------+ -| Requirement| Resource IM Info Elements | TOSCA Constructs as per SOL001 | -| Number | | | -+============+==============================+=================================+ -| R-02454 | VNFD.vnfSoftwareVersion | For VDU.Compute - | -| | | tosca.artifacts.nfv.SwImage | -| | | | -| | SwImageDesc.Version | For Virtual Storage - | -| | | tosca.artifacts.Deployment.Image| -+------------+------------------------------+---------------------------------+ -| R-03070 | vnfExtCpd's with virtual | tosca.nodes.nfv.VnfExtCp with a | -| | NetworkInterfaceRequirements | property tosca.datatypes.nfv.\ | -| | (vNIC) | VirtualNetworkInterface\ | -| | | Requirements | -+------------+------------------------------+---------------------------------+ -| R-09467 | VDU.Compute descriptor | tosca.nodes.nfv.Vdu.Compute | -+------------+------------------------------+---------------------------------+ -| R-16065 | VDU.Compute. Configurable | tosca.datatypes.nfv.Vnfc | -| | Properties | ConfigurableProperties | -+------------+------------------------------+---------------------------------+ -| R-30654 | VNFD.lifeCycleManagement | Interface construct tosca.\ | -| | Script - IFA011 LifeCycle\ | interfaces.nfv.vnf.lifecycle.Nfv| -| | ManagementScript | with a list of standard LCM | -| | | operations | -+------------+------------------------------+---------------------------------+ -| R-35851 | CPD: VduCp, VnfExtCp, | tosca.nodes.nfv.VduCp, tosca.\ | -| | VnfVirtualLinkDesc, QoS | nodes.nfv.VnfVirtualLink, | -| | Monitoring info element - | tosca.nodes.nfv.VnfExtCp | -| | TBD | | -+------------+------------------------------+---------------------------------+ -| R-41215 | VNFD/VDU Profile and scaling | tosca.datatypes.nfv.VduProfile | -| | aspect | and tosca.datatypes.nfv.\ | -| | | ScalingAspect | -+------------+------------------------------+---------------------------------+ -| R-66070 | VNFD meta data | tosca.datatypes.nfv. | -| | | VnfInfoModifiableAttributes - | -| | | metadata? | -+------------+------------------------------+---------------------------------+ -| R-96634 | VNFD.configurableProperties | tosca.datatypes.nfv.Vnf\ | -| | describing scaling | ConfigurableProperties, | -| | characteristics. VNFD.\ | tosca.datatypes.nfv.ScaleInfo | -| | autoscale defines the rules | | -| | for scaling based on specific| | -| | VNF indications | | -+------------+------------------------------+---------------------------------+ -| ? | VDU Virtual Storage | tosca.nodes.nfv.Vdu.\ | -| | | VirtualStorage | -+------------+------------------------------+---------------------------------+ -| R-01478 | Monitoring Info Element (TBD)| tosca.capabilities.nfv.Metric - | -| | - SOL001 per VNF/VDU/VLink | type for monitoring | -| R-01556 | memory-consumption, | | -| | CPU-utilization, | monitoring_parameter of above | -| | bandwidth-consumption, VNFC | type per VNF/VDU/VLink | -| | downtime, etc. | | -+------------+------------------------------+---------------------------------+ - - -Table D2. TOSCA CSAR structure -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section defines the requirements around the CSAR structure. - -The table below describes the numbered requirements for CSAR structure as -agreed with SDC. The format of the CSAR is specified in SOL004. - -+------------+-------------------------------------+--------------------------+ -| Requirement| Description | CSAR artifact directory | -| Number | | | -+============+=====================================+==========================+ -| R-26881 | The VNF provider MUST provide the | ROOT\\Artifacts\ | -| | binaries and images needed to | \\VNF_Image.bin | -| | instantiate the VNF (VNF and VNFC | | -| | images). | | -+------------+-------------------------------------+--------------------------+ -| R-30654 | VNFD.lifeCycleManagementScript that | ROOT\\Artifacts\ | -| | includes a list of events and | \\Informational\ | -| | corresponding management scripts | \\Install.csh | -| | performed for the VNF - SOL001 | | -+------------+-------------------------------------+--------------------------+ -| R-35851 | All VNF topology related definitions| ROOT\\Definitions\ | -| | in yaml files VNFD/Main Service | \\VNFC.yaml | -| | template at the ROOT | | -| | | ROOT\ | -| | | \\MainService\ | -| | | \\Template.yaml | -+------------+-------------------------------------+--------------------------+ -| R-40827 | CSAR License directory - SOL004 | ROOT\\Licenses\ | -| | | \\License_term.txt | -+------------+-------------------------------------+--------------------------+ -| R-77707 | CSAR Manifest file - SOL004 | ROOT\ | -| | | \\MainServiceTemplate.mf | -+------------+-------------------------------------+--------------------------+ - - Requirement List -------------------------------- @@ -944,7 +66,7 @@ high packets/sec performance. High packet throughput is defined as greater than 500K packets/sec. R-54430 The VNF **MUST** use the NCSP’s supported library and compute -flavor that supports DPDK to optimize network efficiency if using DPDK. [5]_ +flavor that supports DPDK to optimize network efficiency if using DPDK. [4]_ R-18864 The VNF **MUST** NOT use technologies that bypass virtualization layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary @@ -1783,9 +905,9 @@ Cloud will continue to rapidly evolve and the underlying components of the platform will change regularly. R-33846 The VNF **MUST** install the NCSP required software on Guest OS -images when not using the NCSP provided Guest OS images. [5]_ +images when not using the NCSP provided Guest OS images. [4]_ -R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [5]_ +R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [4]_ R-02997 The VNF **MUST** preserve their persistent data. Running VMs will not be backed up in the Network Cloud infrastructure. @@ -1812,14 +934,14 @@ troubleshooting. R-39650 The VNF **SHOULD** provide the ability to test incremental growth of the VNF. -R-14853 The VNF **MUST** respond to a "move traffic" [2]_ command +R-14853 The VNF **MUST** respond to a "move traffic" [1]_ command against a specific VNFC, moving all existing session elsewhere with minimal disruption if a VNF provides a load balancing function across multiple instances of its VNFCs. Note: Individual VNF performance aspects (e.g., move duration or disruption scope) may require further constraints. -R-06327 The VNF **MUST** respond to a "drain VNFC" [2]_ command against +R-06327 The VNF **MUST** respond to a "drain VNFC" [1]_ command against a specific VNFC, preventing new session from reaching the targeted VNFC, with no disruption to active sessions on the impacted VNFC, if a VNF provides a load balancing function across multiple instances of its VNFCs. @@ -1836,7 +958,8 @@ testing and operations. Heat ~~~~ -R-95303 A VNF's Heat Orchestration Template **MUST** be defined using valid YAML. +R-95303 A VNF's Heat Orchestration Template **MUST** +be defined using valid YAML. R-27078 A VNF's Heat Orchestration template **MUST** contain the section "heat_template_version:". @@ -1945,7 +1068,8 @@ R-43740 A VNF’s Heat Orchestration Template’s Resource R-78569 A VNF’s Heat Orchestration Template’s Resouce **MAY** declare the attribute “external_id:”. -R-36982 A VNF’s Heat Orchestration template **MAY** contain the “outputs:” section. +R-36982 A VNF’s Heat Orchestration template **MAY** contain the +“outputs:” section. R-86285 The VNF Heat Orchestration Template **MUST** have a corresponding environment file, even if no parameters are required to be enumerated. @@ -2007,7 +1131,7 @@ R-90748 A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume R-03251 A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume **MAY** be defined in a Cinder Volume Module. -* R-11200 The VNF **MUST** keep the scope of a Cinder volume module, +R-11200 The VNF **MUST** keep the scope of a Cinder volume module, when it exists, to be 1:1 with the VNF Base Module or Incremental Module. R-11200 The VNF **MUST** keep the scope of a Cinder volume module, when it @@ -2168,16 +1292,16 @@ in the Base Module then the UUID of the internal network **MUST** be exposed as a parameter in the ‘outputs:’ section of the Base Module and the port resource **MUST** use a ‘get_param’ to obtain the network UUID. -R-01455 When a VNF's Heat Orchestration Template creates a Virtual Machine (i.e., 'OS::Nova::Server'), +R-01455 When a VNF's Heat Orchestration Template creates a +Virtual Machine (i.e., 'OS::Nova::Server'), each 'class' of VMs **MUST** be assigned a VNF unique '{vm-type}'; where 'class' defines VMs that **MUST** have the following identical characteristics: -R-82481 A VNF's Heat Orchestration Template's Resource property -parameter that is -associated with a unique Virtual Machine type **MUST** -include '{vm-type}' as part of the parameter name with two -exceptions: +R-82481 A VNF's Heat Orchestration Template's Resource +property parameter that is associated with a unique Virtual +Machine type **MUST** include '{vm-type}' as part of the +parameter name with two exceptions: R-66729 A VNF’s Heat Orchestration Template’s Resource that is associated with a unique Virtual Machine type **MUST** include @@ -2202,7 +1326,8 @@ Resource property parameter names **SHOULD** match the case of ‘{vm-type}’ in Resource IDs and vice versa. R-21330 A VNF’s Heat Orchestration Template’s Resource property parameter -that is associated with external network **MUST** include the ‘{network-role}’’ as part of the parameter name +that is associated with external network **MUST** include the +‘{network-role}’’ as part of the parameter name R-11168 A VNF's Heat Orchestration Template's Resource ID that is associated with an external network **MUST** include the @@ -2267,7 +1392,8 @@ with a single '{vm-type}' and a single internal network, the Resource ID - the '{vm-type}' **MUST** appear before the 'int\_{network-role}' and **MUST** be separated by an underscore '_' - - (e.g., '{vm-type}\_int\_{network-role}', '{vm-type}_{index}\_int\_{network-role}') + - (e.g., '{vm-type}\_int\_{network-role}', + '{vm-type}_{index}\_int\_{network-role}') - note that an '{index}' value **MAY** separate the '{vm-type}' and the 'int\_{network-role}' and when this occurs underscores **MUST** separate @@ -2351,9 +1477,10 @@ R-22838 The VNF’s Heat Orchestration Template’s Resource ‘OS::Nova::Server’ property ‘name’ parameter **MUST NOT** be enumerated in the Heat Orchestration Template’s Environment File. -R-44271 The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property -'name' parameter value **SHOULD NOT** contain special characters -since the Contrail GUI has a limitation displaying special characters. +R-44271 The VNF's Heat Orchestration Template's Resource +'OS::Nova::Server' property 'name' parameter value **SHOULD NOT** +contain special characters since the Contrail GUI has a limitation +displaying special characters. R-98450 The VNF’s Heat Orchestration Template’s Resource ‘OS::Nova::Server’ property ‘availability_zone’ parameter name @@ -2567,8 +1694,9 @@ passed into a Nested YAML file, the parameter name R-18008 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ property ‘network’ parameter **MUST** be declared as type: ‘string’. -R-62983 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -is attaching to an external network, the ‘network’ parameter name **MUST** +R-62983 When the VNF’s Heat Orchestration Template’s +Resource ‘OS::Neutron::Port’ is attaching to an external +network, the ‘network’ parameter name **MUST** - follow the naming convention ‘{network-role}_net_id’ if the Neutron network UUID value is used to reference the network @@ -2578,20 +1706,23 @@ is attaching to an external network, the ‘network’ parameter name **MUST** where ‘{network-role}’ is the network-role of the external network and a ‘get_param’ **MUST** be used as the intrinsic function. -R-86182 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -is attaching to an internal network, and the internal network is created in a different -Heat Orchestration Template than the ‘OS::Neutron::Port’, the ‘network’ -parameter name **MUST** +R-86182 When the VNF’s Heat Orchestration Template’s +Resource ‘OS::Neutron::Port’ is attaching to an internal +network, and the internal network is created in a different +Heat Orchestration Template than the ‘OS::Neutron::Port’, the +‘network’ parameter name **MUST** - follow the naming convention ‘int\_{network-role}_net_id’ if the Neutron network UUID value is used to reference the network - follow the naming convention ‘int\_{network-role}_net_name’ if the OpenStack network name in is used to reference the network. -where ‘{network-role}’ is the network-role of the internal network and a ‘get_param’ **MUST** be used as the intrinsic function. +where ‘{network-role}’ is the network-role of the internal network +and a ‘get_param’ **MUST** be used as the intrinsic function. -R-93177 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -is attaching to an internal network, and the internal network is created in the same Heat +R-93177 When the VNF’s Heat Orchestration Template’s Resource +‘OS::Neutron::Port’ is attaching to an internal network, and +the internal network is created in the same Heat Orchestration Template than the ‘OS::Neutron::Port’, the ‘network’ parameter name **MUST** obtain the UUID of the internal network by using the intrinsic function ‘get_resource’ or ‘get_attr’ and referencing the @@ -2602,12 +1733,12 @@ property ‘network’ parameter **MUST NOT** be enumerated in the Heat Orchestration Template’s Environment File. R-34037 The VNF’s Heat Orchestration Template’s resource ‘OS::Neutron::Port’ -property ‘fixed_ips’ map property ‘ip_address’ parameter **MUST** be declared as -either type ‘string’ or type ‘comma_delimited_list’. +property ‘fixed_ips’ map property ‘ip_address’ parameter **MUST** be +declared as either type ‘string’ or type ‘comma_delimited_list’. R-40971 When the VNF’s Heat Orchestration Template’s Resource -‘OS::Neutron::Port’ is attaching to an external network, and an IPv4 address is -assigned using the property +‘OS::Neutron::Port’ is attaching to an external network, and an +IPv4 address is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and the parameter type is defined as a string, the parameter name **MUST** follow the naming convention ‘{vm-type}_{network-role}\_ip\_{index}’, where @@ -2621,11 +1752,12 @@ property ‘fixed_ips’ map property ‘ip_address’ parameter ‘{vm-type}_{network-role}\_ip\_{index}’ **MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s Environment File. -R-04697 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ -is attaching to an external network, and an IPv4 address is assigned using -the property ‘fixed_ips’ map property ‘ip_address’ and the parameter type -is defined as a comma_delimited_list, the parameter name **MUST** follow the -naming convention ‘{vm-type}_{network-role}_ips’, where +R-04697 When the VNF’s Heat Orchestration Template’s +Resource ‘OS::Neutron::Port’ is attaching to an external +network, and an IPv4 address is assigned using the property +‘fixed_ips’ map property ‘ip_address’ and the parameter type +is defined as a comma_delimited_list, the parameter name **MUST** +follow the naming convention ‘{vm-type}_{network-role}_ips’, where - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server - ‘{network-role}’ is the {network-role} of the external network @@ -2647,14 +1779,16 @@ the naming convention ‘{vm-type}_{network-role}\_v6\_ip\_{index}’, where R-87123 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter ‘{vm-type}_{network-role}\_v6\_ip\_{index}’ **MUST NOT** be enumerated -in the VNF’s Heat Orchestration Template’s Environment File. +parameter ‘{vm-type}_{network-role}\_v6\_ip\_{index}’ +**MUST NOT** be enumerated in the VNF’s Heat Orchestration +Template’s Environment File. R-23503 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ is attaching to an external network, and an IPv6 address is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and the parameter type is defined as a comma_delimited_list, the parameter -name **MUST** follow the naming convention ‘{vm-type}_{network-role}_v6_ips’, where +name **MUST** follow the naming convention +‘{vm-type}_{network-role}_v6_ips’, where - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server - ‘{network-role}’ is the {network-role} of the external network @@ -2683,7 +1817,8 @@ R-85235 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ is attaching to an internal network, and an IPv4 address is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and the parameter type is defined as a comma_delimited_list, the parameter -name **MUST** follow the naming convention ‘{vm-type}\_int\_{network-role}_ips’, where +name **MUST** follow the naming convention +‘{vm-type}\_int\_{network-role}_ips’, where - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server - ‘{network-role}’ is the {network-role} of the internal network @@ -2705,14 +1840,16 @@ the naming convention ‘{vm-type}\_int\_{network-role}\_v6\_ip\_{index}’, whe R-97201 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ -parameter ‘{vm-type}\_int\_{network-role}\_v6\_ip\_{index}’ **MUST** be enumerated -in the VNF’s Heat Orchestration Template’s Environment File. +parameter ‘{vm-type}\_int\_{network-role}\_v6\_ip\_{index}’ +**MUST** be enumerated in the VNF’s Heat Orchestration Template’s +Environment File. R-29765 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ is attaching to an internal network, and an IPv6 address is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and the parameter type is defined as a comma_delimited_list, the parameter -name **MUST** follow the naming convention ‘{vm-type}\_int\_{network-role}_v6_ips’, where +name **MUST** follow the naming convention +‘{vm-type}\_int\_{network-role}_v6_ips’, where - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server - ‘{network-role}’ is the {network-role} of the internal network @@ -2726,10 +1863,27 @@ R-62590 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ parameter associated with an external network, i.e., +- {vm-type}_{network-role}\_ip\_{index} +- {vm-type}_{network-role}\_ip\_v6\_{index} +- {vm-type}_{network-role}_ips +- {vm-type}_{network-role}_v6_ips + +**MUST NOT** be enumerated in the Heat Orchestration Template’s +Environment File. ONAP provides the IP address assignments at +orchestration time. + R-93496 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’ parameter associated with an internal network, i.e., +- {vm-type}\_int\_{network-role}\_ip\_{index} +- {vm-type}\_int\_{network-role}\_ip\_v6\_{index} +- {vm-type}\_int\_{network-role}_ips +- {vm-type}\_int\_{network-role}_v6_ips + +**MUST** be enumerated in the Heat Orchestration Template’s Environment +File and IP addresses **MUST** be assigned. + R-38236 The VNF’s Heat Orchestration Template’s resource ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘subnet’/’subnet_id’ parameter **MUST** be declared type ‘string’. @@ -2815,18 +1969,20 @@ when the parameter is referencing an “external” network: - {vm-type}\_{network-role}\_floating\_v6\_ip for an IPv6 address -R-16805 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention -for the property allowed\_address\_pairs and Map Property ip\_address -parameter when the parameter is referencing an “internal” network. +R-16805 The VNF Heat Orchestration Template **MUST** adhere to the +following naming convention for the property allowed\_address\_pairs +and Map Property ip\_address parameter when the parameter is +referencing an “internal” network. -R-85734 The VNF Heat Orchestration Template **MUST** use the intrinsic function str\_replace -in conjunction with the ONAP supplied metadata parameter -vnf\_name to generate a unique value, +R-85734 The VNF Heat Orchestration Template **MUST** use the +intrinsic function str\_replace in conjunction with the ONAP +supplied metadata parameter vnf\_name to generate a unique value, when the property name for a non OS::Nova::Server resources is defined in a Heat Orchestration Template. -R-47788 The VNF Heat Orchestration Template **MUST** have a 1:1 scope of a cinder volume module, -when it exists, with the Base Module or Incremental Module +R-47788 The VNF Heat Orchestration Template **MUST** have a 1:1 +scope of a cinder volume module, when it exists, with the Base +Module or Incremental Module R-86285 The VNF Heat Orchestration Template **MUST** have a corresponding environment file, even if no parameters are required to be enumerated. @@ -2841,24 +1997,24 @@ environment file for a Base Module. R-35727 The VNF Heat Orchestration Template **MUST** have a corresponding environment file for an Incremental module. -R-22656 The VNF Heat Orchestration Template **MUST** have a corresponding environment file -for a Cinder Volume Module. +R-22656 The VNF Heat Orchestration Template **MUST** have a +corresponding environment file for a Cinder Volume Module. -R-89868 The VNF Heat Orchestration Template **MUST** have unique file names within the scope -of the VNF for a nested heat yaml file. +R-89868 The VNF Heat Orchestration Template **MUST** have unique +file names within the scope of the VNF for a nested heat yaml file. -R-52530 The VNF Heat Orchestration Template **MUST NOT** use a directory hierarchy for -nested templates. All templates must be in a single, flat directory -(per VNF). +R-52530 The VNF Heat Orchestration Template **MUST NOT** use a +directory hierarchy for nested templates. All templates must be +in a single, flat directory (per VNF). -R-76718 The VNF Heat Orchestration Template **MUST** reference the get\_files targets in -Heat templates by file name, and the corresponding files should be -delivered to ONAP along with the Heat templates. +R-76718 The VNF Heat Orchestration Template **MUST** reference the +get\_files targets in Heat templates by file name, and the corresponding +files should be delivered to ONAP along with the Heat templates. R-41888 The VNE Heat **MUST NOT** use URL-based file retrieval. -R-62177 The VNF Heat Orchestration Template **MUST** have unique file names for the included -files within the scope of the VNF. +R-62177 The VNF Heat Orchestration Template **MUST** have unique +file names for the included files within the scope of the VNF. **ONAP Management Requirements** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -2925,7 +2081,8 @@ on the appropriate Chef Server. R-18525 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 Tables A1 and A2 in the Appendix. +its usage. The fields and their description are defined in Tables A1 +and A2 in the Appendix. R-75608 The xNF provider **MUST** provide playbooks to be loaded on the appropriate Ansible Server. @@ -2933,7 +2090,8 @@ on the appropriate Ansible Server. R-16777 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 Table B1 in the Appendix. +its usage. The fields and their description are defined in Table B1 in +the Appendix. R-46567 The xNF Package **MUST** include configuration scripts for boot sequence and configuration. @@ -3099,8 +2257,8 @@ 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 -Tables C1 to C8 in the Appendix. Note: License metadata support in - ONAP is not currently available and planned for 1Q 2018. +Tables C1 to C8 in the Appendix. Note: License metadata support in +ONAP is not currently available and planned for 1Q 2018. Configuration Management ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -3151,7 +2309,7 @@ R-11790 The VNF **MUST** support ONAP Controller’s R-56218 The VNF **MUST** support ONAP Controller’s Migrate command that moves container (VM) from a live Physical Server / Compute Node to another live Physical Server / Compute Node. - + R-38001 The VNF MUST support ONAP Controller’s **Rebuild** command. R-76901 VNF MUST support a container rebuild mechanism based on existing @@ -3337,7 +2495,7 @@ R-60656 The xNF **MUST** support sub tree filtering. R-80898 The xNF **MUST** support heartbeat via a <get> with null filter. R-25238 The xNF PACKAGE **MUST** validated YANG code using the open -source pyang [3]_ program using the following commands: +source pyang [2]_ program using the following commands: R-63953 The xNF **MUST** have the echo command return a zero value otherwise the validation has failed @@ -3476,7 +2634,7 @@ Server regardless of whether the Callback succeeded or not. R-32217 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]_. +for invocation of playbooks against these end points [3]_. R-54373 The xNF **MUST** have Python >= 2.6 on the endpoint VM(s) of a xNF on which an Ansible playbook will be executed. @@ -3505,7 +2663,7 @@ R-40293 The xNF **MUST** make available playbooks that conform to the ONAP requirement. R-49396 The xNF **MUST** support each ONAP (APPC) xNF action by invocation -of **one** playbook [7]_. The playbook will be responsible +of **one** playbook [6]_. The playbook will be responsible for executing all necessary tasks (as well as calling other playbooks) to complete the request. @@ -3561,7 +2719,7 @@ model, format and mechanisms described in this section. R-19624 The xNF **MUST** encode and serialize content delivered to ONAP using JSON (RFC 7159) plain text format. High-volume data is to be encoded and serialized using `Avro <http://avro.apache.org/>`_, -where the Avro [6]_ data format are described using JSON. +where the Avro [5]_ data format are described using JSON. Note: @@ -3707,731 +2865,24 @@ Information (SPI) or certain proprietary data, in addition to applying the regular procedures for securing access and delivery. -Ansible Playbook Examples ------------------------------------------------ - -The following sections contain examples of Ansible playbooks -which follow the guidelines. - -Guidelines for Playbooks to properly integrate with APPC -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -NOTE: To support concurrent requests to multiple VNF instances of same -or different type, VNF hosts and other files with VNF specific default -values are kept or created in separate directories. - -Example of an Ansible command (after pwd) to run playbook again -vfdb9904v VNF instance: - -.. code-block:: none - - $ pwd - /storage/vfdb/V16.1/ansible/configure - $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v" - - NOTE: To preserve Ansible inventory/group_vars capability, that makes - group_vars contents global variables available to all playbooks, when they - reside in the inventory directory, guidelines are being updated to name the - VNF inventory hosts file as (a flat file) <VNFName>hosts, stored in the - inventory directory, not a subdirectory under inventory. In the above - example: vfdb9904vhosts (removed / VNF name and hosts vfdb9904/vhosts) - -Example of corresponding APPC API Call from ONAP – Ansible Server -Specifications: - -An example of a curl request simulating a Rest API POST requesting execution -of configure Playbook (using playbook relative path): - -.. code-block:: none - - curl -u APIUser:APIPassword -H "Content-type:application/json" -X POST - -d '{"Id": "8412", "PlaybookName": "vfdb/V5.x.x/ansible/configure/site.yml", - "Timeout":"600", "EnvParameters": { "vnf_instance": "vfdb9904v" }}' - http://ansible.server.com:5000/Dispatch - -Rest API GET request to obtain response/results for prior request -(same Id as POST request above): - -.. code-block:: none - - curl -u APIUser:APIPassword -H 'Content-type: application/json' -X GET - 'http://ansible.server.com:5000/Dispatch/?Id=8412&Type=GetResult' - -Comments: - -- An ID number is assigned to each request. This ID number is used to - track request down to completion and provide status to APPC when - requested. - -- Playbook Name relative path provided in the request as PlaybookName - -- Ansible Server Rest API is aware of playbook’s root directory which may - vary from instance to instance or Ansible Server cluster to cluster. - -Ansible Playbooks will use the VNF instance name (passed using ---extra-vars "vnf\_instance=vfdb9904v") to identify other default values -to run the playbook(s) against the target VNF instance. Same example as -above: - -.. code-block:: none - - $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v" - -Each Ansible Server or cluster is assigned its own identification to be used -to authenticate to VNF VMs using Ansible Server or cluster specific set of -SSH keys that may be rotated regularly. Here hosts file, no longer referencing -file with SSH key credentials, to run ansible-playbook listed in this example -above (IP addresses were scrubbed): - -.. code-block:: none - - $ more ../inventory/vfdb9904v/hosts - [host] - localhost ansible_connection=local - - [oam] - 1xx.2yy.zzz.109 - 1xx.2yy.zzz.110 - - [rdb] - 1xx.2yy.zzz.105 - 1xx.2yy.zzz.106 - -NOTE: APPC requests to run Playbooks/Cookbooks are specific to a VNF, -but could be more limited to one VM or one type of VM by the request -parameters. Actions that may impact a site (LCP), a service, or an -entire platform must be orchestrated by MSO in order to execute requests -via APPC which then invoke VNF level playbooks. Playbooks that impact -more than a single VNF are not the current focus of these guidelines. - -Since last release of these guidelines, based on recent learnings, -moving VNF Type global variables under inventory/group_vars files, this -way variables and respective values are available to all playbooks without -being explicitly referenced though an include statement. Also creating -templates that are VNF Type specific, but moving away from static files -that are VNF instance specific, working to obtain VNF instance specific -from other sources, inventory database, etc. - -And here the scrubbed default arguments for this VNF instance(originated -from previously re-factored playbooks now being phased out): - -.. code-block:: none - - vnf_instance=vfdb9904v - - $ more ../vars/vfdb9904v/default_args.yml - vm_config_oam_vnfc_name: vfdb9904vm001oam001 - vm_config_oam_hostname: vfdb9904vm001 - vm_config_oam_provider_ip_address: 1xx.2yy.zzz.109 - … - -IMPORTANT: The APPC and default file attribute name for -vm\_config\_oam\_vnfc\_name, as an example, is derived from vm\_config -array structure (list) in the CSAR package ENV file, with dots replaced -by underscore: - -.. code-block:: none - - vm_config: - - oam: {vnfc_name: {{ vm_config_oam_vnfc_name }}, hostname: {{ - vm_config_oam_hostname }}, provider_ip_address: {{ - vm_config_oam_provider_ip_address } - }, - … - -Parameters like VNF names, VNFC names, OA&M IP addresses, after -February, 2018 ONAP release, will be extracted from A&AI by APPC and -then passed down to Ansible Server, as part of APPC request through REST -API. In the meantime, VNF instance specific required values, will -be stored on VNF instance directory, default arguments file and will be -used as defaults. For parameterized playbooks attribute-value pairs -passed down by APPC to Ansible Server always take precedence over -template or VNF instance specific defaults stored in defaults file(s). - -.. code-block:: none - - $ pwd - /storage/vfdb/latest/ansible - Again, originated from previously re-factored playbooks now being phased out: - - $ more vars/vfdb9904v/default_args.yml - - vm_config_oam1_vnfc_name: vfdb9904vm001oam001 - vm_config_oam1_hostname: vfdb9904vm001 - vm_config_oam1_provider_ip_address: 1xx.2yy.zzz.109 - - vm_config_oam2_vnfc_name: vfdb9904vm002oam001 - vm_config_oam2_hostname: vfdb9904vm002 - vm_config_oam2_provider_ip_address: 1xx.2yy.zzz.110 - - vm_config_rdb1_vnfc_name: vfdb9904vm003rdb001 - vm_config_rdb1_hostname: vfdb9904vm003 - vm_config_rdb1_provider_ip_address: 1xx.2yy.zzz.105 - - vm_config_rdb2_vnfc_name: vfdb9904vm004rdb001 - vm_config_rdb2_hostname: vfdb9904vm004 - vm_config_rdb2_provider_ip_address: 1xx.2yy.zzz.106 - - vm_config_rdb3_vnfc_name: vfdb9904vm005rdb001 - vm_config_rdb3_hostname: vfdb9904vm005 - vm_config_rdb3_provider_ip_address: 1xx.2yy.zzz.xxx - - vm_config_rdb4_vnfc_name: vfdb9904vm006rdb001 - vm_config_rdb4_hostname: vfdb9904vm006 - vm_config_rdb4_provider_ip_address: 1xx.2yy.zzz.yyy - -One of the first tasks on the Ansible Playbooks is to combine the VNF -type generic template, derived from ENV files in CSAR or other files, -with these default values stored on the Ansible Server, together with -the overriding parameters passed down from APPC, to create the VNF -instance specific set of attribute-value pairs to be used for the run, in -INI format. Here is an excerpt from such a file that should look -somewhat similar to ENV files: - -.. code-block:: none - - $ more tmp/vfdb9904v/all.yml - - deployment_prefix: vfdb9904v - … - timezone: Etc/UTC - … - template_version: '2014-10-16' - stack_name: vfdb9904v - c3dbtype: OAM - stackName: vfdb9904v - juno_base: true - … - -# logins list contain 'login name', 'login group', 'login password' - -.. code-block:: none - - logins: - - { name: 'm99999', group: 'm99999', password: 'abcdefgha' } - - { name: 'gsuser', group: 'gsuser', password: ' abcdefgha' } - - { name: 'peruser', group: 'peruser', password: ' abcdefgha' } - - { name: 'dbuser', group: 'dbuser', password: ' abcdefgha' } - -NOTE: Arguments passed by APPC to Ansible Server to run a playbook take -precedence over any defaults stored in Ansible Server. - -Ansible Playbooks – Notes On Artifacts Required to Run Playbooks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Inventory hosts file: should be VNF instance specific. - -Default variables: should be VNF instance specific. - -NOTE: Some playbooks may rely on inventory directory contents to target -the collection of VNFs in the Services Platform supported through -Ansible. - -Playbooks and paths to referenced files: Playbooks shall not use -absolute paths in include or import entries (variables or playbooks) or -other types of references. - -For this to work properly, when running playbooks, the directory where -the main playbook resides shall be the current directory. - -Playbook imports, when used, shall use paths relative to the main -playbook directory. - -Root directory named ansible - Any files provided with playbooks, -included, imported, or referenced by playbooks, shall reside under the ansible -playbooks (root) directory, containing all playbook subdirectories, or -below that ansible root directory, in other subdirectories to support -on-boarding and portability of VNF collection of playbooks and related -artifacts. - -Designing for a shared environment, concurrently running playbooks, -targeting multiple VNF instances – inventory hosts file: - -To avoid inventory hosts file overwrites or collisions between multiple -concurrently running VNF instance requests, chosen approach is for each -VNF instance hosts file, to be stored under the Ansible Server Playbooks -root directory, under the inventory subdirectory, and under a directory -for each VNF instance, named after the VNF instance, as follows: - -ansible/inventory/<VNF\_instance\_name>/hosts - -Example of inventory hosts file path, relative to ansible playbooks root -directory (playbooks\_dir): ansible/inventory/vnfx0001v/hosts - -**Designing for a shared environment, concurrently running multiple playbooks, -targeting multiple VNF instances – default argument variables for -specific VNF instances:** - -Files containing attribute name value pairs (variable name and default -values), referenced/included by playbooks – Files containing VNF -instance specific default values – in a later APPC release, some or all -the default attribute value pairs contained in the defaults file, may be -passed down by APPC, to the Ansible Server, overriding these defaults: - -VNF instance specific files -referenced/included by playbooks, containing default values, example, -default\_args.yml, shall be stored under a directory with VNF instance -name on the path. - -Example: - -ansible/vars/<VNF\_instance\_name>/default\_args.yml - -Example of include statement: - -- include_vars: ../vars/{{ vnf_instance }}/default_args.yml - -Again, this was originated from previously re-factored playbooks, now being -phased out, to move away from having to create VNF instance specific files -with VNF instance default variables. Moving to extract these values from -inventory databases and provide them to Ansible Server as part of the APPC -request, but may be used in a transition from having everything stored in the -Ansible Server to APPC extracting and providing VNF instance specific -attribute-value pairs to the Ansible Server as part of the request. - -Files containing attribute name value pairs (variable name and default -values), referenced/included by playbooks – created dynamically by -playbooks: - -To avoid -overwrites or collisions of multiple concurrently running VNF instance -requests, files created dynamically by playbooks, based on VNF generic -templates, combined with default values and arguments passed down by -APPC (as part of the request), shall be stored under a directory with -VNF instance name on the path. - -Example: - -tmp/<VNF\_instance\_name>/all.yml - -Files containing site specific (Openstack location non-instance -specific) attribute name value pairs, like NTP server and DNS server’s -IP addresses and other parameters, referenced/included by playbooks, not -VNF specific – Could/should be stored under inventory/group_vars directory, -in a subdirectory named after the string used to identify the site (nyc1, -lax2,…). - -Examples: - -ansible/inventory/group_vars/<Site> - -ansible/inventory/group_vars/nyc1 - -ansible/inventory/group_vars/lax2 - - -\ **Ansible Server Design - Directory Structure** - -To help understanding the contents of this section, here are few basic -definitions: - -**VNF type a.k.a VNF Function Code** - Based on current Services -Platform naming convention, each Virtual Network Function is assigned a -4 character string (example vfdb), these are 4 characters in -the VNF instance name, followed by (4) numbers, ending in a "v", but the -naming convention is evolving. VNF instance name in -some cases corresponds to the stack name for the VNF when VNF instance -is built based on a single module, single stack. Example of VNF instance -name: vfdb9904v. All VNF performing this function, running the same -software, coming from the same VNF provider will have the same 4 -characters in the VNF instance name, in this example, vfdb. - -NOTE: New naming convention includes a prefix indicating geographical -location where VNF is instantiated. - -VNF type, determined through these 4 characters, is also known as VNF -Function Code and is assigned by inventory team. All Services Platform -VNF Function Codes can be found in inventory database and/or A&AI as -well as Services Platform Network Design Documents. - -Version – As in VNF software version is the release of the software -running on the VNF for which the playbooks were developed. VNF -configuration steps may change from release to release and this -<Version> in the path will allow the Ansible Server to host playbooks -associated with each software release. And run the playbooks that match -the software release running on each VNF instance. APPC initially will -not support playbook versioning only latest playbook is supported or a hard -coded version that later should become a variable to allow multiple -actively in use playbook versions according to VNF release. - -Playbook Function - Is a name associated with a life cycle management -task(s) performed by the playbook(s) stored in this directory. It should -clearly identify the type of action(s) performed by the main playbook -and possibly other playbooks stored in this same directory. Ideally, -playbook function would match APPC corresponding command or function that -is performed by the main playbook in this directory. Following Ansible naming -standards main playbook is usually named site.yml. There can be other -playbooks on the same directory that use a subset of the roles used by the -main playbook site.yml. Examples of Playbook Function directory names: - -- configure – Contains post-instantiation (bulk) configuration - playbooks, roles,… - -- healthcheck – Contains VNF health check playbook(s), roles,… - -- stop – Contains VNF application stop (stopApplication) playbook(s), - roles,… - -- start – Contains VNF application start (startApplication) playbook(s), - roles,… - -Directory structure to allow hosting multiple version sets of playbooks, -for the same VNF type, to be hosted in the runtime environment on the -Ansible Servers. Generic directory structure: - -Ansible Playbooks – Function directory and main playbook: - -.. code-block:: none - - <VNF type>/<Version>/ansible/<Playbook Function>/site.yml - -Example – Post-instantiation (bulk) configuration –APPC Function - -Configure: - -.. code-block:: none - - <VNF type>/<Version>/ansible/configure/site.yml - -Example – Post-instantiation (bulk) configuration –APPC Function -– Configure – VNF software version 16.1: - -.. code-block:: none - - vfdb/V16.1/ansible/configure/site.yml - -Example – Health-check –APPC Function - HealthCheck: - -.. code-block:: none - - <VNF type>/<Version>/ansible/healthcheck/site.yml - -OR (Function directory name does not need to match APPC function name) - -.. code-block:: none - - <VNF type>/<Version>/ansible/check/site.yml - -Ansible Directories for other artifacts – VNF inventory hosts file - -Required: - -.. code-block:: none - - <VNF type>/<Version>/ansible/inventory/<VNF instance name>hosts - -Ansible Directories for other artifacts – VNF instance specific default -arguments – Optional: - -.. code-block:: none - - <VNF type>/<Version>/ansible/group_vars/<VNF instance name> - -NOTE: This requirement is expected to be deprecated all or in part in the -future, for automated actions, once APPC can pass down all VNF specific -arguments for each action. Requirement remains while manual actions are -to be supported. Other automated inventory management mechanisms may be -considered in the future, Ansible supports many automated inventory -management mechanisms/tools/solutions. - -Ansible Directories for other artifacts – VNF (special) groups – -Optional: - -.. code-block:: none - - <VNF type>/<Version>/ansible/inventory/group_vars/<VNF instance name> - -NOTE: Default groups will be created based on VNFC type, 3 characters, -on VNFC name. Example: “oam”, “rdb”, “dbs”, “man”, “iox”, “app”,… - -Ansible Directories for other artifacts – VNF (special) other files – -Optional – Example – License file: - -.. code-block:: none - - <VNF type>/<Version>/ansible/<Other directory(s)> - -CAUTION: On referenced files used/required by playbooks. - -- To avoid missing files, during on-boarding or uploading of Ansible - Playbooks and related artifacts, all permanent files (not generated - by playbooks as part of execution), required to run any playbook, - shall reside under the ansible root directory or below on other - subdirectories. - -- Any references to files, on includes or other playbook entries, shall - use relative paths. - -- This is the ansible (root) directory referenced on this - note (Ansible Server mount point not included): - -.. code-block:: none - - <VNF type>/<Version>/ansible/ - -There will be a soft link to the latest set of Ansible Playbooks for -each VNF type. - -VNF type directories use A&AI inventory VNF function code. Ansible -Playbooks will be stored on a Cinder Volume mounted on the Ansible -Servers as /storage. Example: - -/storage/vfdb/latest/ansible – This soft link point to the latest set of -playbooks (or the only set) - -/storage/vfdb/V16.1/ansible – Root directory for database VNF Ansible -Playbooks for release 16.1 - -CAUTION: To support this directory structure as the repository to store -Ansible Playbooks run by APPC, APPC API in the Ansible Server side needs -to be configured to run playbooks from directory, not MySQL database. - -Ansible Server HTTP will be configured to support APPC REST API requests -to run playbooks as needed, against specific VNF instances, or specific -VM(s) as specified in the request. - -ONAP APPC REST API to Ansible Server is documented separately and can be -found under ONAP (onap.org). - -**Ansible Server – On-boarding Ansible Playbooks** - -Once playbooks are developed following the guidelines listed in prior -section(s), playbooks need to be on-boarded onto Ansible Server(s). In -the future, they’ll be on-boarded and distributed through ONAP, at least -that is the proposed plan, but for now they need to be uploaded -manually. There is work in progress to use a Git as the playbook -repository to store and track playbooks by version, version control. - -These are the basic steps to on-board playbooks manually onto the -Ansible Server. - -1. Upload CSAR, zip, or tar file containing VNF playbooks and related - artifacts. - -2. Create full directory (using –p option below) to store Ansible - Playbooks and other artifacts under /storage (or other configured) - file system. - - a. Includes VNF type using VNF function code 4 characters under - /storage. - - b. Includes VNF “Version” directory as part of the path to store - playbooks for this VNF version. - - c. Include generic ansible root directory. Creating full directory - path as an example: - -.. code-block:: none - - $ mkdir –p /storage/vfdb/V16.1/ansible**/** - -3. Make this directory (VNF ansible root directory) current directory - for next few steps: - -.. code-block:: none - - cd /storage/vfdb/V16.1/ansible/ - -4. Extract Ansible Playbooks and other Ansible artifacts associated with - the playbooks onto the ansible directory. Command depends on the type - of file uploaded, examples would be: - -.. code-block:: none - - tar xvf .. - unzip … - bunzip .. - -5. Create VNF inventory hosts file with all VMs and - OA&M IP addresses for all VNF instances with known OA&M IP addresses - for respective VMs, example: - -.. code-block:: none - - $ mkdir inventory - - $ touch inventory/vfdb9904vhosts - - $ cat inventory/vfdb9904vhosts - - [host] - localhost ansible\_connection=local - - [oam] - 1xx.2yy.zzz.109 - 1xx.2yy.zzz.110 - - [rdb] - 1xx.2yy.zzz.105 - 1xx.2yy.zzz.106 - -6. (Optional, being deprecated) Create directory to hold default -arguments for each VNF instance, -example: - -.. code-block:: none - - $ mkdir –p vars/vfdb9904v - $ touch vars/vfdb9904v/default\_args.yml - $ cat vars/vfdb9904v/default\_args.yml - vm\_config\_oam1\_vnfc\_name: vfdb9904vm001oam001 - vm\_config\_oam1\_hostname: vfdb9904vm001 - vm\_config\_oam1\_provider\_ip\_address: 1xx.2yy.zzz.109 - - vm\_config\_oam2\_vnfc\_name: vfdb9904vm002oam001 - vm\_config\_oam2\_hostname: vfdb9904vm002 - vm\_config\_oam2\_provider\_ip\_address: 1xx.2yy.zzz.110 - - vm\_config\_rdb1\_vnfc\_name: vfdb9904vm003rdb001 - vm\_config\_rdb1\_hostname: vfdb9904vm003 - vm\_config\_rdb1\_provider\_ip\_address: 1xx.2yy.zzz.105 - - vm\_config\_rdb2\_vnfc\_name: vfdb9904vm004rdb001 - vm\_config\_rdb2\_hostname: vfdb9904vm004 - vm\_config\_rdb2\_provider\_ip\_address: 1xx.2yy.zzz.106 - - vm\_config\_rdb3\_vnfc\_name: vfdb9904vm005rdb001 - vm\_config\_rdb3\_hostname: vfdb9904vm005 - vm\_config\_rdb3\_provider\_ip\_address: 1xx.2yy.zzz.xxx - - vm\_config\_rdb4\_vnfc\_name: vfdb9904vm006rdb001 - vm\_config\_rdb4\_hostname: vfdb9904vm006 - vm\_config\_rdb4\_provider\_ip\_address: 1xx.2yy.zzz.yyy - -NOTE: Please note names in this file shall use underscore “\_” not dots -“.” or dashes “-“. - -7. Perform some basic playbook validation running with “--check” option, - running dummy playbooks or other. - -NOTE: Each Ansible Server or cluster of Ansible Server will have its own -credentials to authenticate to VNF VMs. Ansible Server SSH public key(s) -have to be loaded onto VNF VMs during instantiation or other way before -Ansible Server can access VNF VMs and run playbooks. HOT templates used -by heat to instantiate VNFs to be configured by these Ansible Servers running -playbooks shall include the same SSH public key and load them onto VNF VM(s) -as part of instantiation. - -Other non-vendor specific playbook tasks need to be incorporated in overall -post-instantiation configuration playbook. Alternative is for company -developed playbooks to be uploaded and executed, after VNF vendor provided -playbooks are run. - -**A couple of playbooks used for proof-of-concept testing as examples:** - -UpgradePreCheck: - -.. code-block:: none - - $ pwd - /storage/comx/V5.3.1.3/ansible/upgradeprecheck - - $ more site.yml - --- - - - import_playbook: ../common/create_vars.yml - - import_playbook: ../common/create_hosts.yml - - - name: upgrade software pre check - hosts: oam,dbs,cpm - gather_facts: no - become: true - become_method: sudo - become_user: root - max_fail_percentage: 0 - any_errors_fatal: True - roles: - - precheck - tags: precheck - - $ more roles/precheck/tasks/main.yml - --- - - - include_vars: /tmp/{{ vnf_instance }}/all.yml - - - name: get software version installed on vnf - shell: grep "^SW_VERSION =" /vendor/software/config/param_common.cfg | grep -c "{{ existing_software_version }}" - register: version_line - ignore_errors: yes - - - name: send msg when matches expected version - debug: msg="*** OK *** VNF software release matches (old) release to be upgraded." - verbosity=1 - when: version_line.stdout.find('1') != -1 - - # send warning message and failure when release is not a match - - fail: - msg="*** WARNING *** VNF software release does not match expected (pre-upgrade) release." - when: (version_line | failed) or version_line.stdout.find('1') == -1 - - -UpgradePostCheck: - -.. code-block:: none - - $ pwd - /storage/comx/V5.3.1.3/ansible/upgradepostcheck - - $ more site.yml - --- - - - import_playbook: ../common/create_vars.yml - - import_playbook: ../common/create_hosts.yml - - - name: upgrade software post check - hosts: oam,dbs,cpm - gather_facts: no - become: true - become_method: sudo - become_user: root - max_fail_percentage: 0 - any_errors_fatal: True - roles: - - postcheck - tags: postcheck - - $ more roles/postcheck/tasks/main.yml - --- - - - include_vars: /tmp/{{ vnf_instance }}/all.yml - - - name: get post upgrade software version installed on vnf - shell: grep "^SW_VERSION =" /vendor/software/config/param_common.cfg | grep -c "{{ new_software_version }}" - register: version_line - ignore_errors: yes - - - name: send msg when matches expected version - debug: msg="*** OK *** VNF software release matches new release." - verbosity=1 - when: version_line.stdout.find('1') != -1 - - # send warning message and failure when release is not a match - - fail: - msg="*** WARNING *** VNF software release does not match expected new (post-upgrade) release." - when: (version_line | failed) or version_line.stdout.find('1') == -1 - - .. [1] - The “name” field is a mandatory field in a valid Chef Node Object - JSON dictionary. - -.. [2] Not currently supported in ONAP release 1 -.. [3] +.. [2] https://github.com/mbj4668/pyang -.. [4] +.. [3] Upstream elements must provide the appropriate FQDN in the request to ONAP for the desired action. -.. [5] +.. [4] Refer to NCSP’s Network Cloud specification -.. [6] +.. [5] This option is not currently supported in ONAP and it is currently under consideration. -.. [7] +.. [6] Multiple ONAP actions may map to one playbook. diff --git a/docs/Chapter8/TOSCA-model.rst b/docs/Chapter8/TOSCA-model.rst new file mode 100644 index 0000000..6cdad72 --- /dev/null +++ b/docs/Chapter8/TOSCA-model.rst @@ -0,0 +1,111 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +TOSCA model +----------- + +Table D1. ONAP Resource DM TOSCA/YAML constructs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Standard TOSCA/YAML definitions agreed by VNF SDK Modeling team to be used by +VNF vendors to create a standard VNF descriptor. + +All definitions are summarized in the table below based on the agreed ONAP +Resource DM TOSCA/YAML constructs for Beijing. Their syntax is specified in +ETSI GS NFV-SOL001 stable draft for VNF-D. + ++------------+------------------------------+---------------------------------+ +| Requirement| Resource IM Info Elements | TOSCA Constructs as per SOL001 | +| Number | | | ++============+==============================+=================================+ +| R-02454 | VNFD.vnfSoftwareVersion | For VDU.Compute - | +| | | tosca.artifacts.nfv.SwImage | +| | | | +| | SwImageDesc.Version | For Virtual Storage - | +| | | tosca.artifacts.Deployment.Image| ++------------+------------------------------+---------------------------------+ +| R-03070 | vnfExtCpd's with virtual | tosca.nodes.nfv.VnfExtCp with a | +| | NetworkInterfaceRequirements | property tosca.datatypes.nfv.\ | +| | (vNIC) | VirtualNetworkInterface\ | +| | | Requirements | ++------------+------------------------------+---------------------------------+ +| R-09467 | VDU.Compute descriptor | tosca.nodes.nfv.Vdu.Compute | ++------------+------------------------------+---------------------------------+ +| R-16065 | VDU.Compute. Configurable | tosca.datatypes.nfv.Vnfc | +| | Properties | ConfigurableProperties | ++------------+------------------------------+---------------------------------+ +| R-30654 | VNFD.lifeCycleManagement | Interface construct tosca.\ | +| | Script - IFA011 LifeCycle\ | interfaces.nfv.vnf.lifecycle.Nfv| +| | ManagementScript | with a list of standard LCM | +| | | operations | ++------------+------------------------------+---------------------------------+ +| R-35851 | CPD: VduCp, VnfExtCp, | tosca.nodes.nfv.VduCp, tosca.\ | +| | VnfVirtualLinkDesc, QoS | nodes.nfv.VnfVirtualLink, | +| | Monitoring info element - | tosca.nodes.nfv.VnfExtCp | +| | TBD | | ++------------+------------------------------+---------------------------------+ +| R-41215 | VNFD/VDU Profile and scaling | tosca.datatypes.nfv.VduProfile | +| | aspect | and tosca.datatypes.nfv.\ | +| | | ScalingAspect | ++------------+------------------------------+---------------------------------+ +| R-66070 | VNFD meta data | tosca.datatypes.nfv. | +| | | VnfInfoModifiableAttributes - | +| | | metadata? | ++------------+------------------------------+---------------------------------+ +| R-96634 | VNFD.configurableProperties | tosca.datatypes.nfv.Vnf\ | +| | describing scaling | ConfigurableProperties, | +| | characteristics. VNFD.\ | tosca.datatypes.nfv.ScaleInfo | +| | autoscale defines the rules | | +| | for scaling based on specific| | +| | VNF indications | | ++------------+------------------------------+---------------------------------+ +| ? | VDU Virtual Storage | tosca.nodes.nfv.Vdu.\ | +| | | VirtualStorage | ++------------+------------------------------+---------------------------------+ +| R-01478 | Monitoring Info Element (TBD)| tosca.capabilities.nfv.Metric - | +| | - SOL001 per VNF/VDU/VLink | type for monitoring | +| R-01556 | memory-consumption, | | +| | CPU-utilization, | monitoring_parameter of above | +| | bandwidth-consumption, VNFC | type per VNF/VDU/VLink | +| | downtime, etc. | | ++------------+------------------------------+---------------------------------+ + + +Table D2. TOSCA CSAR structure +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This section defines the requirements around the CSAR structure. + +The table below describes the numbered requirements for CSAR structure as +agreed with SDC. The format of the CSAR is specified in SOL004. + ++------------+-------------------------------------+--------------------------+ +| Requirement| Description | CSAR artifact directory | +| Number | | | ++============+=====================================+==========================+ +| R-26881 | The VNF provider MUST provide the | ROOT\\Artifacts\ | +| | binaries and images needed to | \\VNF_Image.bin | +| | instantiate the VNF (VNF and VNFC | | +| | images). | | ++------------+-------------------------------------+--------------------------+ +| R-30654 | VNFD.lifeCycleManagementScript that | ROOT\\Artifacts\ | +| | includes a list of events and | \\Informational\ | +| | corresponding management scripts | \\Install.csh | +| | performed for the VNF - SOL001 | | ++------------+-------------------------------------+--------------------------+ +| R-35851 | All VNF topology related definitions| ROOT\\Definitions\ | +| | in yaml files VNFD/Main Service | \\VNFC.yaml | +| | template at the ROOT | | +| | | ROOT\ | +| | | \\MainService\ | +| | | \\Template.yaml | ++------------+-------------------------------------+--------------------------+ +| R-40827 | CSAR License directory - SOL004 | ROOT\\Licenses\ | +| | | \\License_term.txt | ++------------+-------------------------------------+--------------------------+ +| R-77707 | CSAR Manifest file - SOL004 | ROOT\ | +| | | \\MainServiceTemplate.mf | ++------------+-------------------------------------+--------------------------+ + + diff --git a/docs/Chapter8/VNF-License-Information-Guidelines.rst b/docs/Chapter8/VNF-License-Information-Guidelines.rst new file mode 100644 index 0000000..d571173 --- /dev/null +++ b/docs/Chapter8/VNF-License-Information-Guidelines.rst @@ -0,0 +1,493 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +VNF License Information Guidelines +---------------------------------- + +This Appendix describes the metadata to be supplied for VNF licenses. + +1. General Information + +Table C1 defines the required and optional fields for licenses. + +Table C1. Required Fields for General Information +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++---------------+-----------------------------------+--------------+----------+ +| **Field Name**| **Description** | **Data Type**| **Type** | ++===============+===================================+==============+==========+ +| VNF Provider | The name of the VNF provider. | String | Mandatory| +| Name | | | | ++---------------+-----------------------------------+--------------+----------+ +| VNF Provider | The name of the product to which | String | Mandatory| +| Product | this agreement applies. | | | +| | | | | +| | Note: a contract/agreement may | | | +| | apply to more than one VNF | | | +| | provider product. In that case, | | | +| | provide the metadata for each | | | +| | product separately. | | | ++---------------+-----------------------------------+--------------+----------+ +| VNF Provider | A general description of VNF | String | Optional | +| Product | provider software product. | | | +| Description | | | | ++---------------+-----------------------------------+--------------+----------+ +| Export Control| ECCNs are 5-character | String | Mandatory| +| Classification| alpha-numeric designations used on| | | +| Number (ECCN) | the Commerce Control List (CCL) to| | | +| | identify dual-use items for export| | | +| | control purposes. An ECCN | | | +| | categorizes items based on the | | | +| | nature of the product, i.e. type | | | +| | of commodity, software, or | | | +| | technology and its respective | | | +| | technical parameters. | | | ++---------------+-----------------------------------+--------------+----------+ +| Reporting | A list of any reporting | List of | Optional | +| Requirements | requirements on the usage of the | strings | | +| | software product. | | | ++---------------+-----------------------------------+--------------+----------+ + +1. Entitlements + +Entitlements describe software license use rights. The use rights may be +quantified by various metrics: # users, # software instances, # units. +The use rights may be limited by various criteria: location (physical or +logical), type of customer, type of device, time, etc. + +One or more entitlements can be defined; each one consists of the +following fields: + +Table C2. Required Fields for Entitlements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++---------------+-----------------------------------+-------------+-----------+ +| **Field Name**| **Description** |**Data Type**| **Type** | ++===============+===================================+=============+===========+ +| VNF Provider | Identifier for the entitlement as | String | Mandatory | +| Part Number / | described by the VNF provider in | | | +| Manufacture | their price list / catalog / | | | +| Reference | contract. | | | +| Number | | | | ++---------------+-----------------------------------+-------------+-----------+ +| Description | Verbiage that describes the | String | Optional | +| | entitlement | | | ++---------------+-----------------------------------+-------------+-----------+ +| Entitlement | Each entitlement defined must be | String | Mandatory | +| Identifier | identified by a unique value (e.g.| | | +| | numbered 1, 2, 3….) | | | ++---------------+-----------------------------------+-------------+-----------+ +| Minimum Order | The minimum number of entitlements| Number | Mandatory | +| Requirement | that need to be purchased. | | | +| | For example, the entitlements must| | | +| | be purchased in a block of 100. If| | | +| | no minimum is required, the value | | | +| | will be zero. | | | ++---------------+-----------------------------------+-------------+-----------+ +| Unique | A list of any reporting | List of | Optional | +| Reporting | requirements on the usage of the | Strings | | +| Requirements | software product. (e.g.: quarterly| | | +| | usage reports are required) | | | ++---------------+-----------------------------------+-------------+-----------+ +| License Type | Type of license applicable to the | String | Mandatory | +| | software product. (e.g.: | | | +| | fixed-term, perpetual, trial, | | | +| | subscription.) | | | ++---------------+-----------------------------------+-------------+-----------+ +| License | Valid values: | String |Conditional| +| Duration | | | | +| | **year**, **quarter**, **month**, | | | +| | **day**. | | | +| | | | | +| | Not applicable when license type | | | +| | is Perpetual. | | | ++---------------+-----------------------------------+-------------+-----------+ +| License | Number of years, quarters, months,| Number |Conditional| +| Duration | or days for which the license is | | | +| Quantification| valid. | | | +| | | | | +| | Not applicable when license type | | | +| | is Perpetual. | | | ++---------------+-----------------------------------+-------------+-----------+ +| Limits | see section C.4 for possible | List | Optional | +| | values | | | ++---------------+-----------------------------------+-------------+-----------+ + +1. License Keys + +This section defines information on any License Keys associated with the +Software Product. A license key is a data string (or a file) providing a +means to authorize the use of software. License key does not provide +entitlement information. + +License Keys are not required. Optionally, one or more license keys can +be defined; each one consists of the following fields: + +Table C3. Required Fields for License Keys +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++---------------+-----------------------------------+--------------+----------+ +| **Field Name**| **Description** | **Data Type**| **Type** | ++===============+===================================+==============+==========+ +| Description | Verbiage that describes the | String | Mandatory| +| | license key | | | ++---------------+-----------------------------------+--------------+----------+ +| License Key | Each license key defined must be | String | Mandatory| +| Identifier | identified by a unique value | | | +| | (e.g., numbered 1, 2, 3….) | | | ++---------------+-----------------------------------+--------------+----------+ +| Key Function | Lifecycle stage (e.g., | String | Optional | +| | Instantiation or Activation) at | | | +| | which the license key is applied | | | +| | to the software. | | | ++---------------+-----------------------------------+--------------+----------+ +| License Key | Valid values: | String | Mandatory| +| Type | | | | +| | **Universal, Unique** | | | +| | | | | +| | **Universal** - a single license | | | +| | key value that may be used with | | | +| | any number of instances of the | | | +| | software. | | | +| | | | | +| | **Unique**- a unique license key | | | +| | value is required for each | | | +| | instance of the software. | | | ++---------------+-----------------------------------+--------------+----------+ +| Limits | see section C.4 for possible | List | Optional | +| | values | | | ++---------------+-----------------------------------+--------------+----------+ + +1. Entitlement and License Key Limits + +Limitations on the use of software entitlements and license keys may be +based on factors such as: features enabled in the product, the allowed +capacity of the product, number of installations, etc... The limits may +generally be categorized as: + +- where (location) + +- when (time) + +- how (usages) + +- who/what (entity) + +- amount (how much) + +Multiple limits may be applicable for an entitlement or license key. +Each limit may further be described by limit behavior, duration, +quantification, aggregation, aggregation interval, start date, end date, +and threshold. + +When the limit is associated with a quantity, the quantity is relative +to an instance of the entitlement or license key. For example: + +- Each entitlement grants the right to 50 concurrent users. If 10 + entitlements are purchased, the total number of concurrent users + permitted would be 500. In this example, the limit category is + **amount**, the limit type is **users**, and the limit + **quantification** is **50.** + + Each license key may be installed on 3 devices. If 5 license keys are + acquired, the total number of devices allowed would be 15. In this + example, the limit category is **usages**, the limit type is + **device**, and the limit **quantification** is **3.** + +1. Location + +Locations may be logical or physical location (e.g., site, country). For +example: + +- use is allowed in Canada + +Table C4. Required Fields for Location +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++------------------+--------------------------------+--------------+----------+ +| **Field Name** | **Description** | **Data Type**| **Type** | ++==================+================================+==============+==========+ +| Limit Identifier | Each limit defined for an | String | Mandatory| +| | entitlement or license key must| | | +| | be identified by a unique value| | | +| | (e.g., numbered 1,2,3…) | | | ++------------------+--------------------------------+--------------+----------+ +| Limit Description| Verbiage describing the limit. | String | Mandatory| ++------------------+--------------------------------+--------------+----------+ +| Limit Behavior | Description of the actions | String | Mandatory| +| | taken when the limit boundaries| | | +| | are reached. | | | ++------------------+--------------------------------+--------------+----------+ +| Limit Category | Valid value: **location** | String | Mandatory| ++------------------+--------------------------------+--------------+----------+ +| Limit Type | Valid values: **city, county, | String | Mandatory| +| | state, country, region, MSA, | | | +| | BTA, CLLI** | | | ++------------------+--------------------------------+--------------+----------+ +| Limit List | List of locations where the VNF| List of | Mandatory| +| | provider Product can be used or| String | | +| | needs to be restricted from use| | | ++------------------+--------------------------------+--------------+----------+ +| Limit Set Type | Indicates if the list is an | String | Mandatory| +| | inclusion or exclusion. | | | +| | | | | +| | Valid Values: | | | +| | | | | +| | **Allowed** | | | +| | | | | +| | **Not allowed** | | | ++------------------+--------------------------------+--------------+----------+ +| Limit | The quantity (amount) the limit| Number | Optional | +| Quantification | expresses. | | | ++------------------+--------------------------------+--------------+----------+ + +1. Time + +Limit on the length of time the software may be used. For example: + +- license key valid for 1 year from activation + +- entitlement valid from 15 May 2018 thru 30 June 2020 + +Table C5. Required Fields for Time +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++------------------+-------------------------------+--------------+-----------+ +| **Field Name** | **Description** | **Data Type**| **Type** | ++==================+===============================+==============+===========+ +| Limit Identifier | Each limit defined for an | String | Mandatory | +| | entitlement or license key | | | +| | must be identified by a unique| | | +| | value (e.g., numbered) | | | ++------------------+-------------------------------+--------------+-----------+ +| Limit Description| Verbiage describing the limit.| String | Mandatory | ++------------------+-------------------------------+--------------+-----------+ +| Limit Behavior | Description of the actions | String | Mandatory | +| | taken when the limit | | | +| | boundaries are reached. | | | +| | | | | +| | The limit behavior may also | | | +| | describe when a time limit | | | +| | takes effect. (e.g., key is | | | +| | valid for 1 year from date of | | | +| | purchase). | | | ++------------------+-------------------------------+--------------+-----------+ +| Limit Category | Valid value: **time** | String | Mandatory | ++------------------+-------------------------------+--------------+-----------+ +| Limit Type | Valid values: | String | Mandatory | +| | **duration, date** | | | ++------------------+-------------------------------+--------------+-----------+ +| Limit List | List of times for which the | List of | Mandatory | +| | VNF Provider Product can be | String | | +| | used or needs to be restricted| | | +| | from use | | | ++------------------+-------------------------------+--------------+-----------+ +| Duration Units | Required when limit type is | String |Conditional| +| | duration. Valid values: | | | +| | **perpetual, year, quarter, | | | +| | month, day, minute, second, | | | +| | millisecond** | | | ++------------------+-------------------------------+--------------+-----------+ +| Limit | The quantity (amount) the | Number | Optional | +| Quantification | limit expresses. | | | ++------------------+-------------------------------+--------------+-----------+ +| Start Date | Required when limit type is | Date | Optional | +| | date. | | | ++------------------+-------------------------------+--------------+-----------+ +| End Date | May be used when limit type is| Date | Optional | +| | date. | | | ++------------------+-------------------------------+--------------+-----------+ + +1. Usage + +Limits based on how the software is used. For example: + +- use is limited to a specific sub-set of the features/capabilities the + software supports + +- use is limited to a certain environment (e.g., test, development, + production…) + +- use is limited by processor (vm, cpu, core) + +- use is limited by software release + +Table C6. Required Fields for Usage +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++------------------+-------------------------------+---------------+----------+ +| **Field Name** | **Description** | **Data Type** | **Type** | ++==================+===============================+===============+==========+ +| Limit Identifier | Each limit defined for an | String | Mandatory| +| | entitlement or license key | | | +| | must be identified by a unique| | | +| | value (e.g., numbered) | | | ++------------------+-------------------------------+---------------+----------+ +| Limit Description| Verbiage describing the limit.| String | Mandatory| ++------------------+-------------------------------+---------------+----------+ +| Limit Behavior | Description of the actions | String | Mandatory| +| | taken when the limit | | | +| | boundaries are reached. | | | ++------------------+-------------------------------+---------------+----------+ +| Limit Category | Valid value: **usages** | String | Mandatory| ++------------------+-------------------------------+---------------+----------+ +| Limit Type | Valid values: **feature, | String | Mandatory| +| | environment, processor, | | | +| | version** | | | ++------------------+-------------------------------+---------------+----------+ +| Limit List | List of usage limits (e.g., | List of String| Mandatory| +| | test, development, vm, core, | | | +| | R1.2.1, R1.3.5…) | | | ++------------------+-------------------------------+---------------+----------+ +| Limit Set Type | Indicates if the list is an | String | Mandatory| +| | inclusion or exclusion. | | | +| | | | | +| | Valid Values: | | | +| | | | | +| | **Allowed** | | | +| | | | | +| | **Not allowed** | | | ++------------------+-------------------------------+---------------+----------+ +| Limit | The quantity (amount) the | Number | Optional | +| Quantification | limit expresses. | | | ++------------------+-------------------------------+---------------+----------+ + +1. Entity + +Limit on the entity (product line, organization, customer) allowed to +make use of the software. For example: + +- allowed to be used in support of wireless products + +- allowed to be used only for government entities + +Table C7. Required Fields for Entity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++------------------+--------------------------------+--------------+----------+ +| **Field Name** | **Description** |**Data Type** | **Type** | ++==================+================================+==============+==========+ +| Limit Identifier | Each limit defined for an | String | Mandatory| +| | entitlement or license key must| | | +| | be identified by a unique value| | | +| | (e.g., numbered) | | | ++------------------+--------------------------------+--------------+----------+ +| Limit Description| Verbiage describing the limit. | String | Mandatory| ++------------------+--------------------------------+--------------+----------+ +| Limit Behavior | Description of the actions | String | Mandatory| +| | taken when the limit boundaries| | | +| | are reached. | | | ++------------------+--------------------------------+--------------+----------+ +| Limit Category | Valid value: **entity** | String | Mandatory| ++------------------+--------------------------------+--------------+----------+ +| Limit Type | Valid values: **product line, | String | Mandatory| +| | organization, internal | | | +| | customer, external customer** | | | ++------------------+--------------------------------+--------------+----------+ +| Limit List | List of entities for which the |List of String| Mandatory| +| | VNF Provider Product can be | | | +| | used or needs to be restricted | | | +| | from use | | | ++------------------+--------------------------------+--------------+----------+ +| Limit Set Type | Indicates if the list is an | String | Mandatory| +| | inclusion or exclusion. | | | +| | | | | +| | Valid Values: | | | +| | | | | +| | **Allowed** | | | +| | | | | +| | **Not allowed** | | | ++------------------+--------------------------------+--------------+----------+ +| Limit | The quantity (amount) the limit| Number | Optional | +| Quantification | expresses. | | | ++------------------+--------------------------------+--------------+----------+ + +1. Amount + +These limits describe terms relative to utilization of the functions of +the software (for example, number of named users permitted, throughput, +or capacity). Limits of this type may also be relative to utilization of +other resources (for example, a limit for firewall software is not based +on use of the firewall software, but on the number of network +subscribers). + +The metadata describing this type of limit includes the unit of measure +(e.g., # users, # sessions, # MB, # TB, etc.), the quantity of units, +any aggregation function (e.g., peak or average users), and aggregation +interval (day, month, quarter, year, etc.). + +Table C8. Required Fields for Amount +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++------------------+---------------------------------+-------------+----------+ +| **Field Name** | **Description** |**Data Type**| **Type** | ++==================+=================================+=============+==========+ +| Limit Identifier | Each limit defined for an | String | Mandatory| +| | entitlement or license key must | | | +| | be identified by a unique value | | | +| | (e.g., numbered) | | | ++------------------+---------------------------------+-------------+----------+ +| Limit Description| Verbiage describing the limit. | String | Mandatory| ++------------------+---------------------------------+-------------+----------+ +| Limit Behavior | Description of the actions taken| String | Mandatory| +| | when the limit boundaries are | | | +| | reached. | | | ++------------------+---------------------------------+-------------+----------+ +| Limit Category | Valid value: **amount** | String | Mandatory| ++------------------+---------------------------------+-------------+----------+ +| Limit Type | Valid values: **trunk, user, | String | Mandatory| +| | subscriber, session, token, | | | +| | transactions, seats, KB, MB, TB,| | | +| | GB** | | | ++------------------+---------------------------------+-------------+----------+ +| Type of | Is the limit relative to | String | Mandatory| +| Utilization | utilization of the functions of | | | +| | the software or relative to | | | +| | utilization of other resources? | | | +| | | | | +| | Valid values: | | | +| | | | | +| | - **software functions** | | | +| | | | | +| | - **other resources** | | | ++------------------+---------------------------------+-------------+----------+ +| Limit | The quantity (amount) the limit | Number | Optional | +| Quantification | expresses. | | | ++------------------+---------------------------------+-------------+----------+ +| Aggregation | Valid values: **peak, average** | String | Optional | +| Function | | | | ++------------------+---------------------------------+-------------+----------+ +| Aggregation | Time period over which the | String | Optional | +| Interval | aggregation is done (e.g., | | | +| | average sessions per quarter). | | | +| | Required when an Aggregation | | | +| | Function is specified. | | | +| | | | | +| | Valid values: **day, month, | | | +| | quarter, year, minute, second, | | | +| | millisecond** | | | ++------------------+---------------------------------+-------------+----------+ +| Aggregation | Is the limit quantity applicable| String | Optional | +| Scope | to a single entitlement or | | | +| | license key (each separately)? | | | +| | Or may the limit quantity be | | | +| | combined with others of the same| | | +| | type (resulting in limit amount | | | +| | that is the sum of all the | | | +| | purchased entitlements or | | | +| | license keys)? | | | +| | | | | +| | Valid values: | | | +| | | | | +| | - **single** | | | +| | | | | +| | - **combined** | | | ++------------------+---------------------------------+-------------+----------+ +| Type of User | Describes the types of users of | String | Optional | +| | the functionality offered by the| | | +| | software (e.g., authorized, | | | +| | named). This field is included | | | +| | when Limit Type is user. | | | ++------------------+---------------------------------+-------------+----------+ + diff --git a/docs/Chapter8/index.rst b/docs/Chapter8/index.rst new file mode 100644 index 0000000..503dc8c --- /dev/null +++ b/docs/Chapter8/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +Appendix +======== + +.. toctree:: + :maxdepth: 2 + + Chef-JSON-Key-Value-Description + Ansible-JSON-Key-Value-Description + VNF-License-Information-Guidelines + TOSCA-model + Requirement-List + Ansible-Playbook-Examples diff --git a/docs/index.rst b/docs/index.rst index 7268448..297a762 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,11 +10,11 @@ VNF Requirements Documentation :maxdepth: 2 :numbered: - Chapter1 - Chapter2 - Chapter3 - Chapter4 - Chapter5 - Chapter6 - Chapter7 - Chapter8 + Chapter1/index + Chapter2/index + Chapter3/index + Chapter4/index + Chapter5/index + Chapter6/index + Chapter7/index + Chapter8/index diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 7083146..a537d44 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -63,7 +63,7 @@ Version: 2.0.0 - More information on the new header structure is available on `Headers <https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure>`_ **Other** - NA + NA Version: 1.0.0 -------------- @@ -106,8 +106,9 @@ Version: 1.0.0 - Initial release - none **Other** - NA + NA =========== -End of Release Notes
\ No newline at end of file +End of Release Notes + |