diff options
Diffstat (limited to 'docs/guides/onap-developer')
28 files changed, 793 insertions, 618 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 7cf6be7d1..9a8970eca 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -39,6 +39,7 @@ Platform Components * :ref:`SDNC - SDN Controller<onap-sdnc-oam:offeredapis>` * :ref:`SO - Service Orchestration<onap-so:offeredapis>` * :ref:`VFC - Virtual Function Controller<onap-vfc-nfvo-lcm:master_index>` +* :ref:`CDS - Controller Design Studio<onap-ccsdk-cds:offeredapis>` Common Services --------------- diff --git a/docs/guides/onap-developer/architecture/blueprint-enr.rst b/docs/guides/onap-developer/architecture/blueprint-enr.rst deleted file mode 100644 index a3018a195..000000000 --- a/docs/guides/onap-developer/architecture/blueprint-enr.rst +++ /dev/null @@ -1,100 +0,0 @@ -ONAP Blueprint Enrichment -------------------------- - -The ONAP Beijing release includes four functional enhancements in the -areas of manually triggered scaling, change management, and hardware -platform awareness (HPA). These features required significant community -collaboration as they impact multiple ONAP projects. These features are -applicable to any use case; however, to showcase them in a concrete -manner, they have been incorporated into VoLTE and vCPE blueprints. - -Manually Triggered Scaling -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Scale-out and scale-in are two primary benefits of NFV. Scaling can be -triggered manually (e.g., by a user or OSS/BSS) or automatically via a -policy-driven closed loop. An automatic trigger allows real-time action -without human intervention, reducing costs and improving customer -experience. A manual trigger, on the other hand, is useful to schedule -capacity in anticipation of events such as holiday shopping. An ideal -scaling operation can scale granularly at a virtual function level (VF), -automate VF configuration tasks and manage the load-balancer that may be -in front of the VF instances. In addition to run-time, this capability -also affects service design, as VNF descriptors need to be granular up -to the VF level. - -The Beijing release provides the initial support for these capabilities. -The community has implemented manually triggered scale-out and scale-in -in combination with a specific VNF manager (sVNFM) and demonstrated this -with the VoLTE blueprint. An operator uses the Usecase UI (UUI) project -to trigger a scaleing operation. UUI communicates with the Service -Orchestrator (SO). SO uses the VF-C controller, which in turn instructs -a vendor-provided sVNFM to implement the scale-out action. - -We have also demonstrated a manual process to Scale Out VNFs that use -the Virtual Infrastructure Deployment (VID), the Service Orchestrator -(SO) and the Application Controller (APPC) as a generic VNF Manager. -Currently, the process is for the operator to trigger the Scale Out -action using VID, which will request SO to spin up a new component of -the VNF. Then SO is building the ConfigScaleOut request and sending to -APPC over DMaaP, where APPC picks it up and executes the configuration -scale out action on the requested VNF. - -Change Management -~~~~~~~~~~~~~~~~~ - -NFV will bring with it an era of continuous, incremental changes instead -of periodic step-function software upgrades, in addition to a constant -stream of both PNF and VNF updates and configuration changes. To -automatically deliver these to existing network services, the ONAP -community is creating framework to implement change management -functionality that is independent of any particular network service or -use case. Ideally, change management provides a consistent interface and -mechanisms to manage complex dependencies, different upgrade mechanisms -(in-place vs. scale-out and replace), A/B testing, conflict checking, -pre- and post-change testing, change scheduling, rollbacks, and traffic -draining, redirection and load-balancing. These capabilities impact both -design-time and run-time environments. - -Over the next several releases, the community will enhance change -management capabilities in ONAP, culminating with a full CI/CD flow. -These capabilities can be applied to any use case; however, specifically -for the Beijing release, the vCPE blueprint has been enriched to execute -a predefined workflow to upgrade the virtual gateway VNF by using -Ansible. An operator invokes an upgrade operation through the VID -interface. VID drives SO, which initiates a sequence of steps such as -VNF lock, pre-check, software upgrade, post-check and unlock. Since -virtual gateway is an L3 VNF, the specific operations are carried out by -the SDN-C controller in terms of running the pre-check, post-check and -upgrade through Ansible playbooks. - -Hardware Platform Awareness (HPA) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Many VNFs have specific hardware requirements to achieve their -performance and security goals. These hardware requirements may range -from basic requirements such as number of cores, memory size, and -ephemeral disk size to advanced requirements such as CPU policy (e.g. -dedicate, shared), NUMA, hugepages (size and number), accelerated -vSwitch (e.g DPDK), crypto/compression acceleration, SRIOV-NIC, TPM, SGX -and so on. The Beijing release provides three HPA-related capabilities: - -1. Specification of the VNF hardware platform requirements as a set of - policies. - -2. Discovery of hardware and other platform features supported by cloud - regions. - -3. Selection of the right cloud region and NFV infrastructure flavor by - matching VNF HPA requirements with the discovered platform - capabilities. - -While this functionality is independent of any particular use case, in -the Beijing release, the vCPE use case has been enriched with HPA. An -operator can specify engineering rules for performance sensitive VNFs -through a set of policies. During run-time, SO relies on the ONAP -Optimization Framework (OOF) to enforce these policies via a -placement/scheduling decision. OOF determines the right compute node -flavors for the VNF by querying the above-defined policies. Once a -homing decision is conveyed to SO, SO executes the appropriate workflow -via the appropriate controller. diff --git a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png b/docs/guides/onap-developer/architecture/media/ONAP-architecture.png Binary files differindex 5f12d955a..a390fae79 100644 --- a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png +++ b/docs/guides/onap-developer/architecture/media/ONAP-architecture.png diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst index 92db75887..d94e42890 100644 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ b/docs/guides/onap-developer/architecture/onap-architecture.rst @@ -8,6 +8,12 @@ Introduction ============ +ONAP is a comprehensive platform for orchestration, management, and automation +of network and edge computing services for network operators, cloud providers, +and enterprises. Real-time, policy-driven orchestration and automation of +physical, virtual, and cloud native network functions enables rapid automation +of new services and complete lifecycle management critical for 5G and +next-generation networks. The ONAP project addresses the rising need for a common automation platform for telecommunication, cable, and cloud service providers—and their solution @@ -21,22 +27,22 @@ in some cases, upgrading on-premises customer equipment. Many are seeking to exploit SDN and NFV to improve service velocity, simplify equipment interoperability and integration, and to reduce overall CapEx and OpEx costs. In addition, the current, highly fragmented management landscape makes it -difficult to monitor and guarantee service-level agreements (SLAs). These -challenges are still very real now as ONAP creates its fourth release. +difficult to monitor and guarantee service-level agreements (SLAs). ONAP is addressing these challenges by developing global and massive scale -(multi-site and multi-VIM) automation capabilities for both physical and -virtual network elements. It facilitates service agility by supporting data -models for rapid service and resource deployment and providing a common set of -northbound REST APIs that are open and interoperable, and by supporting +(multi-site and multi-VIM) automation capabilities for physical, virtual, and +cloud native network elements. It facilitates service agility by supporting +data models for rapid service and resource deployment and providing a common +set of northbound REST APIs that are open and interoperable, and by supporting model-driven interfaces to the networks. ONAP’s modular and layered nature improves interoperability and simplifies integration, allowing it to support -multiple VNF environments by integrating with multiple VIMs, VNFMs, -SDN Controllers, as well as legacy equipment (PNF). ONAP’s consolidated xNF -requirements publication enables commercial development of ONAP-compliant xNFs. -This approach allows network and cloud operators to optimize their physical -and virtual infrastructure for cost and performance; at the same time, ONAP’s -use of standard models reduces integration and deployment costs of +multiple VNF environments by integrating with multiple VIMs, VNFMs, SDN +Controllers, as well as legacy equipment (PNF). The Service Design & Creation +(SDC) project also offers seamless orchestration of CNFs. ONAP’s consolidated +xNF requirements publication enables commercial development of ONAP-compliant +xNFs. This approach allows network and cloud operators to optimize their +physical and virtual infrastructure for cost and performance; at the same time, +ONAP’s use of standard models reduces integration and deployment costs of heterogeneous equipment. All this is achieved while minimizing management fragmentation. @@ -47,16 +53,14 @@ that supports real-time response to actionable events. In order to design, engineer, plan, bill and assure these dynamic services, there are three major requirements: -- A robust design framework that allows the specification of the service in - all aspects – modeling the resources and relationships that make up the - service, specifying the policy rules that guide the service behavior, - specifying the applications, analytics and closed control loop events needed - for the elastic management of the service - -- An orchestration and control framework (Service Orchestrator and Controllers - ) that is recipe/ policy-driven to provide an automated instantiation of the +- A robust design framework that allows the specification of the service in all + aspects – modeling the resources and relationships that make up the service, + specifying the policy rules that guide the service behavior, specifying the + applications, analytics and closed control loop events needed for the elastic + management of the service +- An orchestration and control framework (Service Orchestrator and Controllers) + that is recipe/ policy-driven to provide an automated instantiation of the service when needed and managing service demands in an elastic manner - - An analytic framework that closely monitors the service behavior during the service lifecycle based on the specified design, analytics and policies to enable response as required from the control framework, to deal with @@ -66,24 +70,25 @@ requirements: To achieve this, ONAP decouples the details of specific services and supporting technologies from the common information models, core orchestration platform, and generic management engines (for discovery, provisioning, assurance etc.). + Furthermore, it marries the speed and style of a DevOps/NetOps approach with -the formal models and processes operators require to introduce new services -and technologies. It leverages cloud-native technologies including Kubernetes -to manage and rapidly deploy the ONAP platform and related components. This is -in stark contrast to traditional OSS/Management software platform -architectures, which hardcoded services and technologies, and required lengthy -software development and integration cycles to incorporate changes. +the formal models and processes operators require to introduce new services and +technologies. It leverages cloud-native technologies including Kubernetes to +manage and rapidly deploy the ONAP platform and related components. This is in +stark contrast to traditional OSS/Management software platform architectures, +which hardcoded services and technologies, and required lengthy software +development and integration cycles to incorporate changes. The ONAP Platform enables service/resource independent capabilities for design, creation and lifecycle management, in accordance with the following foundational principles: - Ability to dynamically introduce full service lifecycle orchestration (design - ,provisioning and operation) and service API for new services and + , provisioning and operation) and service API for new services and technologies without the need for new platform software releases or without affecting operations for the existing services -- Carrier-grade scalability including horizontal scaling (linear scale-out) and - distribution to support a large number of services and large networks +- Scalability and distribution to support a large number of services and large + networks - Metadata-driven and policy-driven architecture to ensure flexible and automated ways in which capabilities are used and delivered - The architecture shall enable sourcing best-in-class components @@ -113,20 +118,18 @@ which highlights the role of a few key components: designing required services. #. External API provides northbound interoperability for the ONAP Platform and Multi-VIM/Cloud provides cloud interoperability for the ONAP workloads. -#. OOM provides the ability to manage cloud-native installation and - deployments to Kubernetes-managed cloud environments. -#. ONAP Shared Services provides shared capabilities for ONAP modules. MUSIC - allows ONAP to scale to multi-site environments to support global scale - infrastructure requirements. The ONAP Optimization Framework (OOF) provides - a declarative, policy-driven approach for creating and running optimization - applications like Homing/Placement, and Change Management Scheduling - Optimization. Logging provides centralized logging capabilities, Audit - (POMBA) provides capabilities to understand orchestration actions. +#. OOM provides the ability to manage cloud-native installation and deployments + to Kubernetes-managed cloud environments. +#. ONAP Shared Services provides shared capabilities for ONAP modules. The ONAP + Optimization Framework (OOF) provides a declarative, policy-driven approach + for creating and running optimization applications like Homing/Placement, + and Change Management Scheduling Optimization. #. ONAP shared utilities provide utilities for the support of the ONAP components. #. Information Model and framework utilities continue to evolve to harmonize the topology, workflow, and policy models from a number of SDOs including - ETSI NFV MANO, TM Forum SID, ONF Core, OASIS TOSCA, IETF, and MEF. + ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF, + and MEF. |image2| @@ -140,11 +143,11 @@ sophisticated initial deployment as well as post- deployment management. The ONAP deployment methodology needs to be flexible enough to suit the different scenarios and purposes for various operator environments. Users may also want to select a portion of the ONAP components to integrate into their -own systems. And the platform needs to be highly reliable, scalable, secure and -easy to manage. To achieve all these goals, ONAP is designed as a +own systems. And the platform needs to be highly reliable, scalable, secure +and easy to manage. To achieve all these goals, ONAP is designed as a microservices-based system, with all components released as Docker containers following best practice building rules to optimize their image size. To reduce -the ONAP footprint, a first effort to use shared data base have been initiated +the ONAP footprint, a first effort to use a shared database has been initiated with a Cassandra and mariadb-galera clusters. The ONAP Operations Manager (OOM) is responsible for orchestrating the @@ -171,15 +174,15 @@ container management system and Consul to provide the following functionality: OOM supports a wide variety of cloud infrastructures to suit your individual requirements. -Microservices Bus (MSB) provides fundamental microservices supports including +Microservices Bus (MSB) provides fundamental microservices support including service registration/ discovery, external API gateway, internal API gateway, client software development kit (SDK), and Swagger SDK. When integrating with OOM, MSB has a Kube2MSB registrar which can grasp services information from k8s metafile and automatically register the services for ONAP components. In the spirit of leveraging the microservice capabilities, further steps -towards increased modularity have been taken. Service -Orchestrator (SO) and the controllers have increased its level of modularity. +towards increased modularity have been taken. Service Orchestrator (SO) and the +controllers have increased its level of modularity. Portal ====== @@ -187,46 +190,48 @@ ONAP delivers a single, consistent user experience to both design time and runtime environments, based on the user’s role. Role changes are configured within a single ONAP instance. -This user experience is managed by the ONAP Portal, which provides access to -design, analytics and operational control/administration functions via a -shared, role-based menu or dashboard. The portal architecture provides -web-based capabilities such as application onboarding and management, -centralized access management through the Authentication and Authorization -Framework (AAF), and dashboards, as well as hosted application widgets. +This user experience is managed by the ONAP +Portal, which provides access to design, analytics and operational control/ +administration functions via a shared, role-based menu or dashboard. The portal +architecture provides web-based capabilities such as application onboarding and +management, centralized access management through the Authentication and +Authorization Framework (AAF), and dashboards, as well as hosted application +widgets. The portal provides an SDK to enable multiple development teams to adhere to consistent UI development requirements by taking advantage of built-in capabilities (Services/ API/ UI controls), tools and technologies. ONAP also provides a Command Line Interface (CLI) for operators who require it (e.g., to -integrate with their scripting environment). ONAP SDKs enable -operations/security, third parties (e.g., vendors and consultants), and other -experts to continually define/redefine new collection, analytics, and policies -(including recipes for corrective/remedial action) using the ONAP Design -Framework Portal. +integrate with their scripting environment). ONAP SDKs enable operations/ +security, third parties (e.g., vendors and consultants), and other experts to +continually define/redefine new collection, analytics, and policies (including +recipes for corrective/remedial action) using the ONAP Design Framework Portal. Design Time Framework ===================== -The design time framework is a comprehensive development environment with -tools, techniques, and repositories for defining/ describing resources, -services, and products. +The design time framework is a comprehensive development environment with tools +, techniques, and repositories for defining/ describing resources, services, +and products. The design time framework facilitates reuse of models, further improving efficiency as more and more models become available. Resources, services, -products, and their management and control functions can all be modeled using -a common set of specifications and policies (e.g., rule sets) for controlling +products, and their management and control functions can all be modeled using a +common set of specifications and policies (e.g., rule sets) for controlling behavior and process execution. Process specifications automatically sequence instantiation, delivery and lifecycle management for resources, services, products and the ONAP platform components themselves. Certain process -specifications (i.e., ‘recipes’) and policies are geographically distributed -to optimize performance and maximize autonomous behavior in federated cloud +specifications (i.e., ‘recipes’) and policies are geographically distributed to +optimize performance and maximize autonomous behavior in federated cloud environments. Service Design and Creation (SDC) provides tools, techniques, and repositories to define/simulate/certify system assets as well as their associated processes -and policies. Each asset is categorized into one of four asset groups: -Resource, Services, Products, or Offers. SDC also supports TOSCA1.3 List type -definition which provides the ability to design complicated -service descriptor. +and policies. Each asset is categorized into one of four asset groups: Resource +, Services, Products, or Offers. SDC supports the onboarding of Network +Services packages (ETSI SOL 0007 ), CNF packages (Helm), VNF packages (Heat or +ETSI SOL004) and PNF packages (ETSI SOL004). SDC also includes some +capabilities to model 5G network slicing using the standard properties (Slice +Profile, Service Template). The SDC environment supports diverse users via common services and utilities. Using the design studio, product and service designers onboard/extend/retire @@ -240,9 +245,9 @@ packaging and validation tools in the VNF Supplier API and Software Development Kit (VNF SDK) and VNF Validation Program (VVP) components. Vendors can integrate these tools in their CI/CD environments to package VNFs and upload them to the validation engine. Once tested, the VNFs can be onboarded through -SDC. In addition, the testing capability of VNFSDK is being utilized at the -LFN Compliance Verification Program to work towards ensuring a highly -consistent approach to VNF verification. +SDC. In addition, the testing capability of VNFSDK is being utilized at the LFN +Compliance Verification Program to work towards ensuring a highly consistent +approach to VNF verification. The Policy Creation component deals with policies; these are rules, conditions, requirements, constraints, attributes, or needs that must be provided, @@ -254,20 +259,18 @@ of the evaluated policies appropriate to the conditions). Policy allows rapid modification through easily updating rules, thus updating technical behaviors of components in which those policies are used, without -requiring rewrites of their software code. Policy permits simpler management -/ control of complex mechanisms via abstraction. +requiring rewrites of their software code. Policy permits simpler +management / control of complex mechanisms via abstraction. Runtime Framework ================= The runtime execution framework executes the rules and policies and other models distributed by the design and creation environment. -This allows for the distribution of models and policy among -various ONAP modules such as the Service Orchestrator (SO), Controllers, -Data Collection, Analytics and Events (DCAE), Active and Available Inventory -(A&AI). These components use common services that -support logging, access control, Multi-Site State Coordination (MUSIC), which -allow the platform to register and manage state across multi-site deployments. +This allows for the distribution of models and policy among various ONAP +modules such as the Service Orchestrator (SO), Controllers, Data Collection, +Analytics and Events (DCAE), Active and Available Inventory (A&AI). These +components use common services that support access control. Orchestration ------------- @@ -275,11 +278,9 @@ The Service Orchestrator (SO) component executes the specified processes by automating sequences of activities, tasks, rules and policies needed for on-demand creation, modification or removal of network, application or infrastructure services and resources, this includes VNFs, CNFs and PNFs. -The SO provides orchestration at a very high level, with an end-to-end view of -the infrastructure, network, and applications. - -One is BroadBand Service (BBS), the second one is Cross Domain and Cross Layer -VPN (CCVPN). +The SO provides orchestration at a very high level, with an end-to-end view +of the infrastructure, network, and applications. Examples of this include +BroadBand Service (BBS) and Cross Domain and Cross Layer VPN (CCVPN). Virtual Infrastructure Deployment (VID) --------------------------------------- @@ -299,15 +300,14 @@ constraints including capacity, location, platform capabilities, and other service specific constraints. ONAP Multi-VIM/Cloud (MC) and several other ONAP components such as Policy, SO, -A&AI etc. play an important role in enabling “Policy-driven -Performance/Security-Aware Adaptive Workload Placement/ Scheduling” across -cloud sites through OOF-HAS. OOF-HAS uses Hardware Platform Awareness (HPA), -cloud agnostic Intent capabilities, and real-time capacity checks provided by -ONAP MC to determine the optimal VIM/Cloud instances, which can deliver the -required performance SLAs, for workload (VNF etc.) placement and scheduling -(Homing). Operators now realize the true value of virtualization through fine -grained optimization of cloud resources while delivering performance and -security SLAs. +A&AI etc. play an important role in enabling “Policy-driven Performance/ +Security-Aware Adaptive Workload Placement/ Scheduling” across cloud sites +through OOF-HAS. OOF-HAS uses Hardware Platform Awareness (HPA), cloud agnostic +Intent capabilities, and real-time capacity checks provided by ONAP MC to +determine the optimal VIM/Cloud instances, which can deliver the required +performance SLAs, for workload (VNF etc.) placement and scheduling (Homing). +Operators now realize the true value of virtualization through fine grained +optimization of cloud resources while delivering performance and security SLAs. Controllers ----------- @@ -324,6 +324,19 @@ the associated physical COTS server infrastructure. VF-C provides a generic VNFM capability but also integrates with external VNFMs and VIMs as part of an NFV MANO stack. +The Controller Design Studio (CDS) community in ONAP has contributed a +framework to automate the resolution of resources for instantiation and any +config provisioning operation, such as day0, day1 or day2 configuration. The +essential function of CDS is to create and populate a controller blueprint, +create a configuration file from this Controller blueprint, and associate at +design time this configuration file (configlet) to a PNF/VNF/CNF during the +design phase. CDS removes dependence on code releases and the delays they cause +and puts the control of services into the hands of the service providers. Users +can change a model and its parameters with great flexibility to fetch data from +external systems (e.g. IPAM) that is required in real deployments. This makes +service providers more responsive to their customers and able to deliver +products that more closely match the needs of those customers. + Inventory --------- Active and Available Inventory (A&AI) provides real-time views of a system’s @@ -351,25 +364,28 @@ design capabilities in SDC, simplifying the design process. Multi Cloud Adaptation ---------------------- Multi-VIM/Cloud provides and infrastructure adaptation layer for VIMs/Clouds -in exposing advanced hardware platform awareness and cloud agnostic intent -capabilities, besides standard capabilities, which are used by OOF and other -components for enhanced cloud selection and SO/VF-C for cloud agnostic workload -deployment. +and K8s clusters in exposing advanced hardware platform awareness and cloud +agnostic intent capabilities, besides standard capabilities, which are used by +OOF and other components for enhanced cloud selection and SO/VF-C for cloud +agnostic workload deployment. The K8s plugin is in charge to deploy the CNF on +the Kubernetes clusters using Kubernetes API. Closed Control Loop Automation ============================== Closed loop control is provided by cooperation among a number of design-time and run-time elements. The Runtime loop starts with data collectors from Data -Collection, Analytics and Events (DCAE). ONAP includes the following -collectors: VES for events, HV-VES for high-volume events, SNMP for SNMP traps, -File Collector to receive files, and Restconf Collector to collect the -notifications. After data collection/verification phase, data are moved through -the loop of micro-services like Homes for event detection, Policy for -determining actions, and finally, controllers and orchestrators to implement -actions CLAMP is used to monitor the loops themselves. DCAE also supports -(Platform for Network Data Analytics) PNDA analytics capabilities. CLAMP, -Policy and DCAE all have design time aspects to support the creation of the -loops. +Collection, Analytics and Events (DCAE). ONAP includes the following collectors +: VES (VNF Event Streaming) for events, HV-VES for high-volume events, SNMP +for SNMP traps, File Collector to receive files, and RESTCONF Collector to +collect the notifications. After data collection/verification phase, data are +moved through the loop of micro-services like Homes for event detection, Policy +for determining actions, and finally, controllers and orchestrators to +implement actions CLAMP is used to monitor the loops themselves. DCAE also +includes a number of specialized micro-services to support some use-cases such +as the Slice Analysis or SON-Handler. Some dedicated event processor modules +transform collected data (SNMP, 3GPP XML, RESTCONF) to VES format and push the +various data onto data lake. CLAMP, Policy and DCAE all have design time +aspects to support the creation of the loops. We refer to this automation pattern as “closed control loop automation” in that it provides the necessary automation to proactively respond to network and @@ -383,10 +399,6 @@ Collectively, they provide FCAPS (Fault Configuration Accounting Performance Security) functionality. DCAE collects performance, usage, and configuration data; provides computation of analytics; aids in troubleshooting; and publishes events, data and analytics (e.g., to policy, orchestration, and the data lake). -Another component, “Holmes”, connects to DCAE and provides alarm correlation -for ONAP, new data collection capabilities with High Volume VES, and bulk -performance management support. - Working with the Policy Framework and CLAMP, these components detect problems in the network and identify the appropriate remediation. In some cases, the action will be automatic, and they will notify Service Orchestrator or one of @@ -418,7 +430,6 @@ ONAP Modeling ============= ONAP provides models to assist with service design, the development of ONAP service components, and with the improvement of standards interoperability. - Models are an essential part for the design time and runtime framework development. The ONAP modeling project leverages the experience of member companies, standard organizations and other open source projects to produce @@ -434,7 +445,6 @@ The modeling project includes the ETSI catalog component, which provides the parser functionalities, as well as additional package management functionalities. - Industry Alignment ================== ONAP support and collaboration with other standards and open source communities @@ -447,20 +457,16 @@ is evident in the architecture. - Further collaboration includes 5G/ORAN & 3GPP Harmonization, Acumos DCAE Integration, and CNCF Telecom User Group (TUG). -Read this whitepaper for more information: The Progress of ONAP: Harmonizing -Open Source and Standards. +Read this whitepaper for more information: +`The Progress of ONAP: Harmonizing Open Source and Standards <https://www.onap.org/wp-content/uploads/sites/20/2019/04/ONAP_HarmonizingOpenSourceStandards_032719.pdf>`_ ONAP Blueprints =============== ONAP can support an unlimited number of use cases, within reason. However, to provide concrete examples of how to use ONAP to solve real-world problems, the -community has created a set of blueprints. In addition to helping users -rapidly adopt the ONAP platform through end-to-end solutions, these blueprints -also help the community prioritize their work. With the ONAP Frankfurt release, -we introduced a new blueprint in the area of optical transport networking -called Multi-Domain Optical Network Service (MDONS). Prior blueprints were -vCPE, VoLTE, vFW/vDNS, 5G, and CCVPN. 5G and CCVPN underwent feature -enhancements during the Frankfurt release. +community has created a set of blueprints. In addition to helping users rapidly +adopt the ONAP platform through end-to-end solutions, these blueprints also +help the community prioritize their work. 5G Blueprint ------------ @@ -493,11 +499,11 @@ case. Virtual CPE (vCPE) .................. -Currently, services offered to a subscriber are restricted to what is -designed into the broadband residential gateway. In the blueprint, the customer -has a slimmed down physical CPE (pCPE) attached to a traditional broadband -network such as DSL, DOCSIS, or PON (Figure 5). A tunnel is established to a -data center hosting various VNFs providing a much larger set of services to the +Currently, services offered to a subscriber are restricted to what is designed +into the broadband residential gateway. In the blueprint, the customer has a +slimmed down physical CPE (pCPE) attached to a traditional broadband network +such as DSL, DOCSIS, or PON (Figure 5). A tunnel is established to a data +center hosting various VNFs providing a much larger set of services to the subscriber at a significantly lower cost to the operator. In this blueprint, ONAP supports complex orchestration and management of open source VNFs and both virtual and underlay connectivity. @@ -511,15 +517,14 @@ to learn more. Broadband Service (BBS) ....................... -This blueprint provides multi-gigabit residential -internet connectivity services based on PON (Passive Optical Network) access -technology. A key element of this blueprint is to show automatic -re-registration of an ONT (Optical Network Terminal) once the subscriber moves -(nomadic ONT) as well as service subscription plan changes. This blueprint uses -ONAP for the design, deployment, lifecycle management, and service assurance of -broadband services. It further shows how ONAP can orchestrate services across -different locations (e.g. Central Office, Core) and technology domains (e.g. -Access, Edge). +This blueprint provides multi-gigabit residential internet connectivity +services based on PON (Passive Optical Network) access technology. A key +element of this blueprint is to show automatic re-registration of an ONT +(Optical Network Terminal) once the subscriber moves (nomadic ONT) as well as +service subscription plan changes. This blueprint uses ONAP for the design, +deployment, lifecycle management, and service assurance of broadband services. +It further shows how ONAP can orchestrate services across different locations +(e.g. Central Office, Core) and technology domains (e.g. Access, Edge). |image6| @@ -531,17 +536,18 @@ to learn more. Voice over LTE (VoLTE) Blueprint -------------------------------- This blueprint uses ONAP to orchestrate a Voice over LTE service. The VoLTE -blueprint incorporates commercial VNFs to create and manage the underlying vEPC -and vIMS services by interworking with vendor-specific components, including -VNFMs, EMSs, VIMs and SDN controllers, across Edge Data Centers and a Core Data -Center. ONAP supports the VoLTE use case with several key components: SO, VF-C, -SDN-C, and Multi-VIM/ Cloud. In this blueprint, SO is responsible for VoLTE -end-to-end service orchestration working in collaboration with VF-C and SDN-C. -SDN-C establishes network connectivity, then the VF-C component completes the -Network Services and VNF lifecycle management (including service initiation, -termination and manual scaling) and FCAPS (fault, configuration, accounting, -performance, security) management. This blueprint also shows advanced -functionality such as scaling and change management. +blueprint incorporates commercial VNFs to create and manage the underlying +vEPC and vIMS services by interworking with vendor-specific components, +including VNFMs, EMSs, VIMs and SDN controllers, across Edge Data Centers and +a Core Data Center. ONAP supports the VoLTE use case with several key +components: SO, VF-C, SDN-C, and Multi-VIM/ Cloud. In this blueprint, SO is +responsible for VoLTE end-to-end service orchestration working in collaboration +with VF-C and SDN-C. SDN-C establishes network connectivity, then the VF-C +component completes the Network Services and VNF lifecycle management +(including service initiation, termination and manual scaling) and FCAPS +(fault, configuration, accounting, performance, security) management. This +blueprint also shows advanced functionality such as scaling and change +management. |image7| @@ -550,14 +556,13 @@ functionality such as scaling and change management. Read the `VoLTE Blueprint <https://www.onap.org/wp-content/uploads/sites/20/2018/11/ONAP_CaseSolution_VoLTE_112918FNL.pdf>`_ to learn more. - Optical Transport Networking (OTN) ---------------------------------- Two ONAP blueprints (CCVPN and MDONS) address the OTN use case. CCVPN addresses Layers 2 and 3, while MDONS addresses Layers 0 and 1. CCVPN (Cross Domain and Cross Layer VPN) Blueprint --------------------------------------------------- +.................................................. CSPs, such as CMCC and Vodafone, see a strong demand for high-bandwidth, flat, high-speed OTN (Optical Transport Networks) across carrier networks. They also want to provide a high-speed, flexible and intelligent service for high-value @@ -578,17 +583,15 @@ completes the Network Services and VNF lifecycle management. ONAP peering across CSPs uses an east-west API which is being aligned with the MEF Interlude API. The key innovations in this use case are physical network discovery and modeling, cross-domain orchestration across multiple physical networks, cross -operator end-to-end service provisioning, close-loop reroute for -cross-domain service, dynamic changes (branch sites, VNFs) and intelligent -service optimization (including AI/ML). The Frankfurt release adds support for -end-to-end E-LINE services over optical transport network (OTN) -network-to-network interface (NNI). +operator end-to-end service provisioning, close-loop reroute for cross-domain +service, dynamic changes (branch sites, VNFs) and intelligent service +optimization (including AI/ML). Read the `CCVPN Blueprint <https://www.onap.org/wp-content/uploads/sites/20/2019/07/ONAP_CaseSolution_CCVPN_062519.pdf>`_ to learn more. MDONS (Multi-Domain Optical Network Service) Blueprint ------------------------------------------------------- +...................................................... While CCVPN addresses the automation of networking layers 2 and 3, it does not address layers 0 and 1. Automating these layers is equally important because providing an end-to-end service to their customers often requires a manual and @@ -613,64 +616,64 @@ vLoadBalancer. The blueprint exercises most aspects of ONAP, showing VNF onboarding, network service creation, service deployment and closed-loop automation. The key components involved are SDC, CLAMP, SO, APP-C, DCAE and Policy. In the recent releases, the vFW blueprint has been demonstrated by -using a mix of a CNF and VNF and entirely using CNFs. +using a mix of a CNF and VNF and entirely using CNFs. Verified end to end tests ========================= Use cases --------- -Various use cases have been tested for the Release. Detailed information can -be found in :ref:`Verified Use Cases<onap-integration:docs_usecases>`. - -- vFirewall with closed loop -- vFirewall/vDNS with HPA -- vFirewall In-Place Software Upgrade with Traffic Distribution -- vFirewall CNF With CDS -- Scale Out -- CCVPN-E LINE over OTN NNI -- CCVPN - MDONS -- BBS (Broadband Service) -- vFirewall CNF with multicloud k8s plugin -- EdgeXFoundry CNF with multicloud k8s plugin -- vCPE with Tosca -- E2E Automation vLB with CDS +Various use cases have been tested for the Release. Use case examples are +listed below. See detailed information on use cases, functional requirements, +and automated use cases can be found here: +:ref:`Verified Use Cases<onap-integration:docs_usecases_release>`. + +- E2E Network Slicing +- 5G OOF (ONAP Optimization Framework) SON (Self-Organized Network) +- CCVPN-Transport Slicing +- MDONS (Multi-Domain Optical Network Service) Functional requirements ----------------------- -Various functional requirements have been tested for the Release. Detailed -information can be found in -:ref:`Verified Use Cases<onap-integration:docs_usecases>`. - -- PNF Software Upgrade using direct Netconf Yang interface with PNF -- PNF Software Upgrade with EM with Ansible -- PNF Software Upgrade with EM with Netconf -- VSP Compliance and Validation Check within SDC -- Enable PNF software version at onboarding -- xNF communication security enhancements -- ETSI Alignment SO plugin to support SOL003 to connect to an external VNFM -- Integration of CDS as an Actor -- 3rd Party Operational Domain Manager -- Configuration & persistency -- 5G functional requirements - - - 5G Realtime PM and High Volume Stream Data Collection - - 5G PNF Plug and Play - - 5G Bulk PM - - 5G OOF and PCI - - 5G NRM Network Resource Model (Configuration management) - - 5G NETCONF configuration - - 5G PNF Pre-Onboarding & Onboarding - - 5G OOF SON - - 5G E2E Network Slicing - - 5G ORAN A1 Adapter (SDNR) +Various functional requirements have been tested for the Release. Detailed +information can be found in the +:ref:`Verified Use Cases<onap-integration:docs_usecases_release>`. + +- xNF Integration + + - ONAP CNF orchestration - Enhancements + - PNF PreOnboarding + - PNF Plug & Play + +- Lifecycle Management + + - Policy Based Filtering + - Bulk PM / PM Data Control Extension + - Support xNF Software Upgrade in association to schema updates + - Configuration & Persistency Service + +- Security + + - CMPv2 Enhancements + +- Standard alignment + + - ETSI-Alignment for Guilin + - ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES + - Extend ORAN A1 Adapter and add A1 Policy Management + +- NFV testing Automatic Platform + + - Support for Test Result Auto Analysis & Certification + - Support for Test Task Auto Execution + - Support for Test Environment Auto Deploy + - Support for Test Topology Auto Design Conclusion ========== -The ONAP platform provides a comprehensive platform for real-time, -policy-driven orchestration and automation of physical and virtual network -functions that will enable software, network, IT and cloud providers and -developers to rapidly automate new services and support complete lifecycle -management. +The ONAP platform provides a comprehensive platform for real-time, policy- +driven orchestration and automation of physical and virtual network functions +that will enable software, network, IT and cloud providers and developers to +rapidly automate new services and support complete lifecycle management. By unifying member resources, ONAP will accelerate the development of a vibrant ecosystem around a globally shared architecture and implementation for network diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 14c9a85f8..f0136dc5e 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -48,10 +48,8 @@ AAF - Application Authorization Framework * - Document - Description - * - :ref:`AAF<onap-aaf-authz:master_index>` + * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_ - AAF Architecture, APIs and Guides - * - :ref:`Secret Management Service<onap-aaf-sms:master_index>` - - Secret Management Service Architecture and API AAI - Active and Available Inventory ------------------------------------ @@ -64,14 +62,12 @@ AAI - Active and Available Inventory - Description * - :ref:`AAI<onap-aai-aai-common:master_index>` - AAI Architecture, APIs and Guides - * - :ref:`ESR<onap-aai-esr-gui:master_index>` - - External System Registry GUI Documentation (to be removed ?) - * - :ref:`ESR<onap-aai-esr-server:master_index>` - - External System Registry Server Documentation (to be removed ?) - * - :ref:`AAI Inventory UI<onap-aai-sparky-be:master_index>` - - Sparky - AAI Inventory UI Documentation (to be removed ?) - * - :ref:`AAI Event Client<onap-aai-event-client:master_index>` - - AAI Event Client Documentation (to be removed ?) + * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_ + - External System Registry GUI Documentation + * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_ + - External System Registry Server Documentation + * - (in Maintenance) :ref:`AAI UI<onap-aai-sparky-be:master_index>` + - Sparky - AAI Inventory UI Documentation APPC - Application Controller ----------------------------- @@ -82,9 +78,9 @@ APPC - Application Controller * - Document - Description - * - :ref:`APPC<onap-appc:master_index>` + * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_ - APPC Architecture, APIs and Guides - * - :ref:`APPC Deployment<onap-appc-deployment:master_index>` + * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_ - APPC Deployment Documentation CCSDK - Common Controller Software Development Kit @@ -98,12 +94,6 @@ CCSDK - Common Controller Software Development Kit - Description * - :ref:`Distribution<onap-ccsdk-distribution:master_index>` - TOSCA Orchestration Plugin, Directed Graph Support - * - :ref:`Dashboard<onap-ccsdk-dashboard:master_index>` - - Common Controller Dashboard (To be removed ?) - * - :ref:`Platform Plugins<onap-ccsdk-platform-plugins:master_index>` - - Platform Plugins (To be removed ?) - * - :ref:`APPS<onap-ccsdk-apps:master_index>` - - Apps optside ODL (To be removed ?) CDS - Controller Design Studio ------------------------------ @@ -164,8 +154,6 @@ DMAAP - Data Management as a Platform - Description * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>` - Bus Controller Documentation - * - :ref:`Bus Controller API<onap-dmaap-dbcapi:master_index>` - - Bus Controller API Documentation * - :ref:`Data Router<onap-dmaap-datarouter:master_index>` - Data Router Documentation * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>` @@ -206,8 +194,8 @@ LOGGING - Centralized Logging * - Document - Description - * - :ref:`Logging<onap-logging-analytics:master_index>` - - ONAP Centralized Logging Documentation (to be deleted ?) + * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_ + - ONAP Centralized Logging Documentation MSB - Microservices Bus ----------------------- @@ -242,10 +230,10 @@ MUSIC - ONAP Multi-Site Integration * - Document - Description - * - :ref:`MUSIC<onap-music:master_index>` - - MUSIC Architecture and Guides (To be deleted ?) - * - :ref:`Distributed KV Store<onap-music:master_index>` - - MUSIC Distribute KV Store Documents (To be deleted ?) + * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_ + - MUSIC Architecture and Guides + * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_ + - MUSIC Distribute KV Store Documents OOF - Optimization Framework ---------------------------- @@ -274,7 +262,7 @@ OOM - ONAP Operations Manager - Description * - :ref:`OOM<onap-oom:master_index>` - ONAP Operations Manager Documentation - * - :ref:`OOM Certification Service<onap-oom-certservice:master_index>` + * - :ref:`OOM Certification Service<onap-oom-platform-cert-service:master_index>` - ONAP CMPv2 certification support ORAN - Open-RAN Support in ONAP @@ -334,7 +322,7 @@ SDNC - Software Defined Network Controller * - Document - Description - * - :ref:`SDCN<onap-sdnc-oam:master_index>` + * - :ref:`SDNC<onap-sdnc-oam:master_index>` - SDNC Architecture, APIs and Guides SDNR - Software Defined Network Controller for Radio @@ -346,7 +334,7 @@ SDNR - Software Defined Network Controller for Radio * - Document - Description - * - :ref:`SDNR<onap-ccsdk-features:master_index>` + * - :ref:`SDN-R<onap-ccsdk-features:master_index>` - SDN-R Documentation (part of CCSDK) SO - Service Orchestration @@ -360,8 +348,6 @@ SO - Service Orchestration - Description * - :ref:`SO<onap-so:master_index>` - Service Orchestration Architecture, APIs and Guides - * - :ref:`SO Libraries<onap-so-libs:master_index>` - - Service Orchestration Build (To be deleted ?) UUI - Use Case User Interface ----------------------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst b/docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst index 56449beb2..edbf1e219 100644 --- a/docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst +++ b/docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst @@ -7,8 +7,8 @@ Converting to RST ================= -RST format is used for documentation. Other file formats can be converted to RST -with pandoc. +RST format is used for documentation. Other file formats can be converted to +RST with pandoc. .. caution:: @@ -40,53 +40,53 @@ you'd like to convert: :code:`-f` tells pandoc the input format. It should be one of the following: -+--------------------+---------------------------------------------------------------+ -| Format | Description | -+====================+===============================================================+ -|commonmark | Markdown variant | -+--------------------+---------------------------------------------------------------+ -|docbook | XML-based markup | -+--------------------+---------------------------------------------------------------+ -|docx | Microsoft Word | -+--------------------+---------------------------------------------------------------+ -|epub | Ebook format | -+--------------------+---------------------------------------------------------------+ -|haddock | Doc format produced by tool used on Haskell code | -+--------------------+---------------------------------------------------------------+ -|html | HTML | -+--------------------+---------------------------------------------------------------+ -|json | JSON pandoc AST | -+--------------------+---------------------------------------------------------------+ -|latex | Older typesetting syntax | -+--------------------+---------------------------------------------------------------+ -|markdown | Simple formatting syntax meant to produce HTML | -+--------------------+---------------------------------------------------------------+ -|markdown_github | Github flavored markdown | -+--------------------+---------------------------------------------------------------+ -|markdown_mmd | Multi-markdown flavored markdown | -+--------------------+---------------------------------------------------------------+ -|markdown_phpextra | PHP flavored markdown | -+--------------------+---------------------------------------------------------------+ -|markdown_strict | Markdown with no added pandoc features | -+--------------------+---------------------------------------------------------------+ -|mediawiki | Popular wiki language | -+--------------------+---------------------------------------------------------------+ -|native | Pandoc native Haskell | -+--------------------+---------------------------------------------------------------+ -|odt | Open document text (used by LibreOffice) | -+--------------------+---------------------------------------------------------------+ -|opml | Outline processor markup language | -+--------------------+---------------------------------------------------------------+ -|org | Org mode for Emacs | -+--------------------+---------------------------------------------------------------+ -|rst | reStructuredText | -+--------------------+---------------------------------------------------------------+ -|t2t | Wiki-like formatting syntax | -+--------------------+---------------------------------------------------------------+ -|textile | A formatting syntax similar to RST and markdown | -+--------------------+---------------------------------------------------------------+ -|twiki | Popular wiki formatting syntax | -+--------------------+---------------------------------------------------------------+ ++--------------------+----------------------------------------------------+ +| Format | Description | ++====================+====================================================+ +|commonmark | Markdown variant | ++--------------------+----------------------------------------------------+ +|docbook | XML-based markup | ++--------------------+----------------------------------------------------+ +|docx | Microsoft Word | ++--------------------+----------------------------------------------------+ +|epub | Ebook format | ++--------------------+----------------------------------------------------+ +|haddock | Doc format produced by tool used on Haskell code | ++--------------------+----------------------------------------------------+ +|html | HTML | ++--------------------+----------------------------------------------------+ +|json | JSON pandoc AST | ++--------------------+----------------------------------------------------+ +|latex | Older typesetting syntax | ++--------------------+----------------------------------------------------+ +|markdown | Simple formatting syntax meant to produce HTML | ++--------------------+----------------------------------------------------+ +|markdown_github | Github flavored markdown | ++--------------------+----------------------------------------------------+ +|markdown_mmd | Multi-markdown flavored markdown | ++--------------------+----------------------------------------------------+ +|markdown_phpextra | PHP flavored markdown | ++--------------------+----------------------------------------------------+ +|markdown_strict | Markdown with no added pandoc features | ++--------------------+----------------------------------------------------+ +|mediawiki | Popular wiki language | ++--------------------+----------------------------------------------------+ +|native | Pandoc native Haskell | ++--------------------+----------------------------------------------------+ +|odt | Open document text (used by LibreOffice) | ++--------------------+----------------------------------------------------+ +|opml | Outline processor markup language | ++--------------------+----------------------------------------------------+ +|org | Org mode for Emacs | ++--------------------+----------------------------------------------------+ +|rst | reStructuredText | ++--------------------+----------------------------------------------------+ +|t2t | Wiki-like formatting syntax | ++--------------------+----------------------------------------------------+ +|textile | A formatting syntax similar to RST and markdown | ++--------------------+----------------------------------------------------+ +|twiki | Popular wiki formatting syntax | ++--------------------+----------------------------------------------------+ Fixing the converted document ----------------------------- @@ -106,5 +106,5 @@ Previewing edits Web-based ~~~~~~~~~ -`rst.ninjs.org <http://rst.ninjs.org>`_ has an excellent RST previewing -tool that highlights RST errors with line numbers. +`Online Sphinx editor <https://livesphinx.herokuapp.com/>`_ is a RST previewing +tool. diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst index 787b8c17c..2e7e47acf 100644 --- a/docs/guides/onap-developer/how-to-use-docs/index.rst +++ b/docs/guides/onap-developer/how-to-use-docs/index.rst @@ -8,10 +8,11 @@ Creating Documentation :maxdepth: 2 introduction - setting-up-environment setting-up + setting-up-environment style-guide api-swagger-guide + templates converting-to-rst addendum diff --git a/docs/guides/onap-developer/how-to-use-docs/introduction.rst b/docs/guides/onap-developer/how-to-use-docs/introduction.rst index ceb2eb0e6..250313fc4 100644 --- a/docs/guides/onap-developer/how-to-use-docs/introduction.rst +++ b/docs/guides/onap-developer/how-to-use-docs/introduction.rst @@ -108,81 +108,77 @@ reference parts of source for documentation from other project repositories. Other ONAP projects will provide content that is referenced from this structure. -:: - -docs -├── guides -│ ├── active-projects -│ ├── onap-developer -│ │ ├── apiref -│ │ ├── architecture -│ │ │ └── media -│ │ ├── developing -│ │ ├── how-to-use-docs -│ │ ├── tutorials -│ │ └── use-cases -│ ├── onap-operator -│ │ ├── cloud_site -│ │ │ ├── aws -│ │ │ ├── azure -│ │ │ ├── k8s -│ │ │ ├── openstack -│ │ │ └── vmware -│ │ ├── onap-portal-admin -│ │ │ └── attachments -│ │ └── settingup -│ ├── onap-provider -│ ├── onap-user -│ │ ├── configure -│ │ │ ├── change_config -│ │ │ ├── pnf_connect -│ │ │ └── vnf_connect -│ │ ├── design -│ │ │ ├── control-loop -│ │ │ │ └── media -│ │ │ ├── media -│ │ │ ├── parameter_resolution -│ │ │ │ └── ubuntu_example -│ │ │ │ ├── cba-after-enrichment -│ │ │ │ │ ├── Definitions -│ │ │ │ │ ├── Templates -│ │ │ │ │ └── TOSCA-Metadata -│ │ │ │ ├── cba-before-enrichment -│ │ │ │ │ ├── Definitions -│ │ │ │ │ ├── Templates -│ │ │ │ │ └── TOSCA-Metadata -│ │ │ │ └── ubuntuCDS_heat -│ │ │ ├── pre-onboarding -│ │ │ │ └── media -│ │ │ ├── resource-onboarding -│ │ │ │ └── media -│ │ │ ├── service-design -│ │ │ │ └── media -│ │ │ ├── service-distribution -│ │ │ │ └── media -│ │ │ └── vfcreation -│ │ │ └── media -│ │ ├── instantiate -│ │ │ ├── instantiation -│ │ │ │ ├── nbi -│ │ │ │ ├── pnf_instance -│ │ │ │ ├── service_instance -│ │ │ │ ├── so1 -│ │ │ │ ├── so2 -│ │ │ │ ├── uui -│ │ │ │ ├── vid -│ │ │ │ ├── virtual_link_instance -│ │ │ │ └── vnf_instance -│ │ │ └── pre_instantiation -│ │ └── onap-portal-user -│ │ └── attachments -│ └── overview -│ └── media -├── release -├── templates -│ ├── collections -│ └── sections -└── use-cases +.. code-block:: + + docs + ├── guides + │ ├── onap-developer + │ │ ├── apiref + │ │ ├── architecture + │ │ │ └── media + │ │ ├── developing + │ │ └── how-to-use-docs + | | | ├── templates + │ | | | ├── collections + │ | | | └── sections + │ ├── onap-operator + │ │ ├── cloud_site + │ │ │ ├── aws + │ │ │ ├── azure + │ │ │ ├── k8s + │ │ │ ├── openstack + │ │ │ └── vmware + │ │ ├── onap-portal-admin + │ │ │ └── attachments + │ │ └── settingup + │ ├── onap-provider + │ ├── onap-user + │ │ ├── configure + │ │ │ ├── change_config + │ │ │ ├── pnf_connect + │ │ │ └── vnf_connect + │ │ ├── design + │ │ │ ├── control-loop + │ │ │ │ └── media + │ │ │ ├── media + │ │ │ ├── parameter_resolution + │ │ │ │ └── ubuntu_example + │ │ │ │ ├── cba-after-enrichment + │ │ │ │ │ ├── Definitions + │ │ │ │ │ ├── Templates + │ │ │ │ │ └── TOSCA-Metadata + │ │ │ │ ├── cba-before-enrichment + │ │ │ │ │ ├── Definitions + │ │ │ │ │ ├── Templates + │ │ │ │ │ └── TOSCA-Metadata + │ │ │ │ └── ubuntuCDS_heat + │ │ │ ├── pre-onboarding + │ │ │ │ └── media + │ │ │ ├── resource-onboarding + │ │ │ │ └── media + │ │ │ ├── service-design + │ │ │ │ └── media + │ │ │ ├── service-distribution + │ │ │ │ └── media + │ │ │ └── vfcreation + │ │ │ └── media + │ │ ├── instantiate + │ │ │ ├── instantiation + │ │ │ │ ├── nbi + │ │ │ │ ├── pnf_instance + │ │ │ │ ├── service_instance + │ │ │ │ ├── so1 + │ │ │ │ ├── so2 + │ │ │ │ ├── uui + │ │ │ │ ├── vid + │ │ │ │ ├── virtual_link_instance + │ │ │ │ └── vnf_instance + │ │ │ └── pre_instantiation + │ │ └── onap-portal-user + │ │ └── attachments + │ └── overview + │ └── media + └── release Source Files diff --git a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst index cafa4790a..509e7aff1 100644 --- a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst +++ b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst @@ -332,59 +332,12 @@ for a particular type of project, repository, guide, reference manual, etc. For example, a collection for a platform component, an SDK, etc. You can: browse the template *collections* and *sections* below; -show source to look at the Restructured Text and Sphinx directives used; -copy the source either from a browser window or by downloading the -file in raw form from -the `gerrit doc repository <https://gerrit.onap.org/r/gitweb?p=doc.git;a=tree;f=docs/templates;/>`_ and -then add them to your repository docs folder and index.rst. - +show source to look at the Restructured Text and Sphinx directives used. Sections ++++++++ - -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|Sections |Description | -+======================================================================================================================+======================================================================================================================================================================================================+ -|`Administration <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/administration.rst>`_ | This section is used to describe a software component from the perspective of on-going operation including regular processes and actions that are taken to configure and manage the component. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Architecture <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/architecture.rst>`_ | This section is used to describe a software component from a high level view of capability, common usage scenarios, and interactions with other components required in the usage scenarios. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Build <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/build.rst>`_ | This section is used to describe how a software component is built from source into something ready for use either in a run-time environment or to build other components. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Configuration <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/configuration.rst>`_ | This section is used to describe the options a software component offers for configuration. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Consumed APIs <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/consumedapis.rst>`_ | This section is used to reference APIs that a software component depends on and uses from other sources. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Delivery <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/delivery.rst>`_ | This section is used to describe a software component packaging. For a run-time component this might be executable images, containers, etc. For an SDK this might be libraries. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Design <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/design.rst>`_ | This section is used to describe the internal design structure of a software component. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Human interfaces <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/humaninterfaces.rst>`_ |This section is used to describe a software component's command line and graphical user interfaces. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Installation <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/installation.rst>`_ | This section is used to describe how a software component is acquired and installed. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Logging <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/logging.rst>`_ | This section is used to describe the informational or diagnostic messages emitted from a software component and the methods or collecting them. | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Offered APIs <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/offeredapis.rst>`_ | This section is used to describe the external interfaces offered by a software component | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`Release notes <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/release-notes.rst>`_ | The release note needs to be updated for each ONAP release | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -|`VNF reference <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/sections/vnf-reference.rst>`_ | This section is used to describe Virtual Network Function software | -| | | -+----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Section examples are available here: :ref:`Templates<templates>` Collections +++++++++++ @@ -410,13 +363,7 @@ content that can be used as is or easily converted, and use of Sphinx directives/extensions to automatically generate restructured text from other source you already have. -+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ -|Collections |Description | -+==============================================================================================================================+============================================================+ -|`Platform component <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/collections/platform-component.rst>`_ | This collection is used to describe a platform component. | -+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ -|`SDK <https://gerrit.onap.org/r/gitweb?p=doc.git;a=blob;f=docs/templates/collections/sdk.rst>`_ | This collection is used to describe an SDK. | -+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+ +Collection examples are available here: :ref:`Templates<templates>` Links and References -------------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst index dcd1552bf..17dee9fda 100644 --- a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst @@ -43,8 +43,8 @@ Abbreviations and acronyms + Examples: an MSO component, a LAN, an L3-VPN -ONAP terms -^^^^^^^^^^ +ONAP terminology +^^^^^^^^^^^^^^^^ - AA&I vs AAI: AAI should be used. - APP-C vs APPC: APPC should be used. diff --git a/docs/guides/onap-developer/how-to-use-docs/templates.rst b/docs/guides/onap-developer/how-to-use-docs/templates.rst new file mode 100644 index 000000000..42dd6ac22 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2020 ONAP community + +.. _templates: + +Templates +========= + +This section provides templates for the projects + +Sections +-------- + +.. toctree:: + :maxdepth: 1 + + templates/collections/platform-component.rst + templates/collections/sdk.rst + +Release notes +------------- +.. toctree:: + :maxdepth: 1 + + templates/sections/release-notes.rst diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst b/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst new file mode 100644 index 000000000..3cde22948 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst @@ -0,0 +1,23 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Platform Component +================== + +.. Add or remove sections below as appropriate for the platform component. + +.. toctree:: + :maxdepth: 1 + + ../sections/architecture.rst + ../sections/offeredapis.rst + ../sections/consumedapis.rst + ../sections/delivery.rst + ../sections/design.rst + ../sections/logging.rst + ../sections/installation.rst + ../sections/configuration.rst + ../sections/administration.rst + ../sections/humaninterfaces.rst + ../sections/release-notes.rst diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst b/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst new file mode 100644 index 000000000..83fbbe2ee --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.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 + +SDK +=== + +.. Add or remove sections below as appropriate for the SDK + +.. toctree:: + :maxdepth: 1 + + ../sections/architecture.rst + ../sections/offeredapis.rst + ../sections/delivery.rst + ../sections/logging.rst + ../sections/build.rst + ../sections/release-notes.rst diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst new file mode 100644 index 000000000..94a740718 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Administration +============== + + +.. note:: + * This section is used to describe a software component from the perspective of on-going + operation including regular processes and actions that are taken to configure and manage + the component. + + * This section is typically: provided for platform-component or applications; and + referenced in user guides + + * This note must be removed after content has been added. + + +Processes +--------- + + +Actions +------- diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst new file mode 100644 index 000000000..8daa0d3bc --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Architecture +============ + +.. note:: + * This section is used to describe a software component from a high level + view of capability, common usage scenarios, and interactions with other + components required in the usage scenarios. + + * The architecture section is typically: provided in a platform-component + and sdk collections; and referenced from developer and user guides. + + * This note must be removed after content has been added. + + +Capabilities +------------ + + +Usage Scenarios +--------------- + + +Interactions +------------ diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst new file mode 100644 index 000000000..99a061c24 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst @@ -0,0 +1,23 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Build +===== + +.. note:: + * This section is used to describe how a software component is built from source + into something ready for use either in a run-time environment or to build other + components. + + * This section is typically provided for a platform-component, application, and sdk; and + referenced in developer guides. + + * This note must be removed after content has been added. + + +Environment +----------- + + +Steps +----- diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst new file mode 100644 index 000000000..085f9c667 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +============= + +.. note:: + * This section is used to describe the options a software component offers for configuration. + + * Configuration is typically: provided for platform-component and sdk projects; + and referenced in developer and user guides. + + * This note must be removed after content has been added. + + + +Example ... + +You can provide the following in ``basic.conf`` + +``host=ADDRESS`` + The address of the host + +``port=PORT`` + The port used for signaling + + Optional. Default: ``8080`` diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst new file mode 100644 index 000000000..c2af4c20e --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Consumed APIs +============= + +.. note:: + * This section is used to reference APIs that a software component depends on + and uses from other sources. + + * Consumed APIs should be a specific link to the offered APIs from another component + or external source. + + * This note must be removed after content has been added. + + diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst new file mode 100644 index 000000000..f3f083a73 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst @@ -0,0 +1,44 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Delivery +======== + +.. note:: + * This section is used to describe a software component packaging. + For a run-time component this might be executable images, containers, etc. + For an SDK this might be libraries. + + * This section is typically provided for a platform-component and sdk; + and referenced in developer and user guides + + * This note must be removed after content has been added. + +Example use of a block diagram. + +.. blockdiag:: + + + blockdiag layers { + orientation = portrait + a -> m; + b -> n; + c -> x; + m -> y; + m -> z; + group l1 { + color = blue; + x; y; z; + } + group l2 { + color = yellow; + m; n; + } + group l3 { + color = orange; + a; b; c; + } + + } + + diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst new file mode 100644 index 000000000..f173a2fb5 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Design +====== + +.. note:: + * This section is used to describe the internal design structure of a software component. + + * This section is typically provided: for a platform-component and sdk; and + referenced in developer guides. + + * This note must be removed after content has been added. diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst new file mode 100644 index 000000000..429284608 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.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 + +Human Interfaces +================ + +.. note:: + * This section is used to describe a software component's command line and graphical + user interfaces. + + * This section is typically: provided for a platform-component and application; and + referenced from user guides. + + * This note must be removed after content has been added. + + + diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst new file mode 100644 index 000000000..be64a63bb --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Installation +============ + +.. note:: + * This section is used to describe how a software component is acquired and installed. + + * This section is typically: provided for a platform-component and application; and + referenced in user guides. + + * This note must be removed after content has been added. + +Environment +----------- + + +Steps +----- diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst new file mode 100644 index 000000000..39eabfba7 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst @@ -0,0 +1,22 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Logging +======= + +.. note:: + * This section is used to describe the informational or diagnostic messages emitted from + a software component and the methods or collecting them. + + * This section is typically: provided for a platform-component and sdk; and + referenced in developer and user guides + + * This note must be removed after content has been added. + + +Where to Access Information +--------------------------- + + +Error / Warning Messages +------------------------ diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst new file mode 100644 index 000000000..23504c1da --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Offered APIs +============ + +.. note:: + * This section is used to describe the external interfaces offered by a software component + + * This section is typically: provided for a platform-component and sdk; and + referenced in developer guides and api reference manuals. + + * This note must be removed after content has been added. + diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst new file mode 100644 index 000000000..11f38fed9 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst @@ -0,0 +1,127 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 + International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) ONAP Project and its contributors +.. _release_notes: + +*********************** +<project> Release Notes +*********************** + +.. note:: + * The release note needs to be updated for each ONAP release + * Except the section "Release data" all other sections are optional and should be + applied where applicable + * Only the current release is to be documented in this document + * This note needs to be removed before publishing the final result + +Abstract +======== + +This document provides the release notes for the ``<releasename>`` release. + +Summary +======= + +<Give a high level description of your project with regards to this +specific release> + + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | <project name> | +| | | ++--------------------------------------+--------------------------------------+ +| **Docker images** | make sure you include all docker | +| | images including the | +| | release version | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | <release name followed by version> | +| | | ++--------------------------------------+--------------------------------------+ + + +New features +------------ + +<Describe new features or other new additions> + +**Bug fixes** + +- `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining + what this defect is addressing. + +**Known Issues** + +- `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two to three sentences + explaining what this issue is. + +Deliverables +------------ + +Software Deliverables +~~~~~~~~~~~~~~~~~~~~~ + + +Documentation Deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +------------------ + +Any known system limitations. + + +Known Vulnerabilities +--------------------- + +Results of know vulnerabilities analysis in used modules. + + +Workarounds +----------- + +Any known workarounds. + + +Security Notes +-------------- + +**Fixed Security Issues** + +List of security issues fixed in this release including CVEs and OJSI +tickets. + +**Known Security Issues** + +List of new security issues that are left unfixed in this release including +CVEs and OJSI tickets. + + +Test Results +============ +List or refer to any project specific results + + +References +========== + +For more information on the ONAP ``<release name>`` release, please see: + +#. `ONAP Home Page`_ +#. `ONAP Documentation`_ +#. `ONAP Release Downloads`_ +#. `ONAP Wiki Page`_ + + +.. _`ONAP Home Page`: https://www.onap.org +.. _`ONAP Wiki Page`: https://wiki.onap.org +.. _`ONAP Documentation`: https://docs.onap.org +.. _`ONAP Release Downloads`: https://git.onap.org diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst deleted file mode 100644 index a181644bc..000000000 --- a/docs/guides/onap-developer/tutorials/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. - -Tutorials -========= - -.. note:: - This is an empty document as placeholder for future tutorials. - - diff --git a/docs/guides/onap-developer/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst deleted file mode 100644 index d9dc0d202..000000000 --- a/docs/guides/onap-developer/use-cases/index.rst +++ /dev/null @@ -1,15 +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. - -Use Cases -========= - -Example uses case descriptions and sequence diagrams illustrating -interactions between platform components. - -.. toctree:: - :maxdepth: 1 - - vfw.rst - volte.rst diff --git a/docs/guides/onap-developer/use-cases/vfw.rst b/docs/guides/onap-developer/use-cases/vfw.rst deleted file mode 100644 index 2f83102a9..000000000 --- a/docs/guides/onap-developer/use-cases/vfw.rst +++ /dev/null @@ -1,74 +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. - -vFirewall Use Case -================== - -Description ------------ - -Onboarding ----------- - - -.. uml:: - - @startuml - title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services - ONAP_User -> SDC : vFW_vDNS resource onboarding (HEAT) - note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\ - ONAP_User -> SDC : vFW_vDNS service onboarding - ONAP_User -> SDC : vFW_vDNS distribution - ||| - SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - @enduml - -Instantiation -------------- - -.. uml:: - - @startuml - title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services - participant ONAP_User - participant Robot - Participant SDC - Participant VID - Participant SO - ONAP_User -> AAI : populate cloud inventory - note left of AAI: manual via curl or POSTMAN - ||| - ONAP_User -> VID : vFW_vDNS deployment - VID -> SDC : Lookup VNF artifacts - VID -> AAI : Lookup cloud locations, subscriber - VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules) - SO -> AAI : inventory update - VID -> SO : vFW_vDNS VNF Instantiation\n(base modules) - note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice - SO -> AAI : inventory update - ONAP_User -> SDNC : VNF API Preload VNF/VF data - VID -> SO : vFW_vDNS VF Instantiation\n(base modules) - SO -> AAI : inventory update - SO -> SDNC : Generic VNF API\n(assign) - SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters - Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or - CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation - Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation - Hypervisor -> CloudAPI : complete - CloudAPI -> Multi_VIM : complete - Multi_VIM -> SO : complete - note right : SO may poll for completion - SO -> SDNC: Generic VNF API\n(activated) - note left : on failure from Openstack SO issues rollback to SDNC - SDNC -> AAI : L3 Network resource update - SO -> VID : complete - note right : VID will poll for completion - ONAP_User -> Robot : run Heat Bridge - Robot -> CloudAPI : retrieve cloud data - Robot -> AAI : Update with cloud data - ||| - @enduml - |
