diff options
Diffstat (limited to 'docs/guides/onap-user')
123 files changed, 0 insertions, 5620 deletions
diff --git a/docs/guides/onap-user/design/control-loop-design-steps/cl_design_instructions.rst b/docs/guides/onap-user/design/control-loop-design-steps/cl_design_instructions.rst deleted file mode 100644 index e7d513048..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/cl_design_instructions.rst +++ /dev/null @@ -1,78 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright © 2017-2020 Aarna Networks, Inc. - -Instructions for Designing a Control Loop -========================================= - -This document provides step by step instructions on how to design a Control Loop starting from service creation, adding the required DCAE artifacts, policy and VF in the composition phase of SDC and finally distributing it to the CLAMP for further process. - -In order to distribute the DCAE microservice blueprints we need to create a dummy service. The DCAE blueprint will be added as an artifact to the VF inside the service during service composition time. - -Here we are using TCA (Threshold Checking Application) DCAE microservice as an example application to upload for designing the control loop. - -Follow the below steps for creating and distributing the service - -1. Login as DESIGNER (cs0008) and create the service - -.. note:: - The service name should not contain any spaces. The DCAE policy fails to fetch the service from PDP if the name has a space. For example ‘dcae1’ will work and ‘dcae 1’ will not. - -|image1| - -2. Add any VNF (ex: vfw_pg) that was already created during the SDC design phase. - -In the composition canvas drag and drop a resource of type VF from the abstract section in the Elements section (left hand side panel) - -|image2| - -3. Download the required DCAE MS blueprint to be attached to the service - -Use the sample TCA blueprint located here: -https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-tcagen2-clampnode.yaml - -.. note:: - - Check if the version of the plugin used in the blueprint is different from existing, then update the blueprint import to match. - - To check the version run this: `cfy plugins list | grep k8splugin` - -4. Now upload the Control Loop Artifact. The procedure to upload the artifact is - - - Click on the VF, as in the picture below the ‘vsp_pg 0’ is selected. - - Click on ‘DEPLOYMENT ARTIFACTS’ and then click on “Add Artifact”. - - |image3| - - - Fill the details and in the type select DCAE_INVENTORY_BLUEPRINT, then click on Done as in the picture shown below. - - |image4| - -5. After uploading the DCAE artifact to the SDC Service, attach the policy model to the Service. From the left drop down, select TCA policy under Policies, and click on the Add policy. - -|image5| - -6. Click on Checkin on top right corner then click OK - -|image6| - -7. Search and select the same service from CATALOG and click on Certify on top right corner - -|image7| - -8. Click Distribute to distribute the service, then click on Distribution in the left hand side panel and monitor until the distribution is complete. We should see artifacts deployed in CLAMP and Policy engine, as can be seen in the picture below - -|image8| - -9. At this point we can open the CLAMP GUI and verify that the DCAE microservice design template is in place as shown below. - -|image9| - - -.. |image1| image:: media/image1.png -.. |image2| image:: media/image2.png -.. |image3| image:: media/image3.png -.. |image4| image:: media/image4.png -.. |image5| image:: media/image5.png -.. |image6| image:: media/image6.png -.. |image7| image:: media/image7.png -.. |image8| image:: media/image8.png -.. |image9| image:: media/image9.png diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image1.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image1.png Binary files differdeleted file mode 100644 index e2c0595d9..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image1.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image2.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image2.png Binary files differdeleted file mode 100644 index 58827b12c..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image2.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image3.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image3.png Binary files differdeleted file mode 100644 index 76d3147a8..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image3.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image4.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image4.png Binary files differdeleted file mode 100644 index 797b961e0..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image4.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image5.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image5.png Binary files differdeleted file mode 100644 index c0b5dc668..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image5.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image6.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image6.png Binary files differdeleted file mode 100644 index 9cc9373d2..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image6.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image7.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image7.png Binary files differdeleted file mode 100644 index 5f974d776..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image7.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image8.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image8.png Binary files differdeleted file mode 100644 index bb314752b..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image8.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop-design-steps/media/image9.png b/docs/guides/onap-user/design/control-loop-design-steps/media/image9.png Binary files differdeleted file mode 100644 index 59125ec08..000000000 --- a/docs/guides/onap-user/design/control-loop-design-steps/media/image9.png +++ /dev/null diff --git a/docs/guides/onap-user/design/control-loop/index.rst b/docs/guides/onap-user/design/control-loop/index.rst deleted file mode 100644 index 462069673..000000000 --- a/docs/guides/onap-user/design/control-loop/index.rst +++ /dev/null @@ -1,273 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -Control Loop Design -=================== -**Goal:** Create and distribute closed-loop models for automating: - * recovery of faults reported by traps or alarms - * capacity management as performance thresholds are crossed - -**Tool:** SDC/DCAE-DS/CLAMP - -**SDC user role:** Designer - -Closed loops use feedback to control and optimize their behavior. -A closed loop can proactively respond to network and service conditions -without human intervention. - -There are different phases to the Closed Loop (CL) design: - - #. Design a closed loop template and associate it to a Service, - the template represents the theoretical flow of the CL. (DCAE-DS/SDC) - - #. generate a deployment artifact that can be ingested by the DCAE, - today it is a "cloudify" blueprint. - - #. Distribute the control loop to CLAMP and DCAE, the csar is distributed - to CLAMP, the blueprint is distributed to both CLAMP and DCAE. (SDC) - #. Submit the closed loop, meaning provision Policy/DCAE with - closed loop data. (CLAMP) - #. Deploy the closed loop, it initiates the deployment of the micro - service on DCAE side (CLAMP) - -*Release 1 (Amsterdam)* includes control loop template designer in Clamp UI. - -*Release 2 (Bejing)* does not include the control loop template designer -in Clamp UI, this is implemented in DCAE-DS. - -**Steps** - - * `Design a Model`_ - * `Configure Collector`_ - * `Configure Alarm Detector`_ - * `Configure Data Analytics Function`_ - * `Configure Policy`_ - * `Distribute the Model`_ - * `Open Loop Design`_ - -Design a Model --------------- - -.. note:: - When required, contact the DCAE Group (see `Mailing Lists <https://wiki.onap.org/display/DW/Mailing+Lists>`_) to - confirm that a blueprint for the Service has been generated and - is available on DCAE. - -**Prerequisites:** Create and test a VF - -#TODO ADD A LINK TO VF Creation and Testing user-guides-service-design? - - #. Create and name a new model - #. Associate a Service with the model - #. Based on the service, provide values for its attributes - #. Select the Resource-VF and Resource-VFC to associate with the model - #. Select one or more locations in the cloud where the - closed loop will be deployed - #. Here is a view of a hypothetical visual design tool - showing loop modeling components: - - |image0| - - #. Use the tool to select and connect components, - thus defining the structure of the model - #. Configure each of the components of the model - - #. `Configure Collector`_ - #. `Configure Alarm Detector`_ - #. `Configure Data Analytics Function`_ - #. `Configure Policy`_ - -Configure Collector -------------------- - -**Prerequisites:** `Design a Model`_. - -Using the modeling tool, assign a message topic to which this -component will subscribe. - -Configure Alarm Detector ------------------------- - -**Prerequisites:** `Design a Model`_. - -Using the modeling tool, configure the fields described in this table: - -+------------+----------------------------+-------------------------------+ -| Field | Values | Description | -+============+============================+===============================+ -| Topic | * DCAE-CL-EVENT | DMAAP message topic to | -| Publishes | * OPEN-DCAE-HIGHLANDPARK- | which the component | -| | EVENT-OUTPUT | subscribes. | -+------------+----------------------------+-------------------------------+ -| Alarm | (Multiple values) | Populated from vendor-provided| -| Condition | | list of alarm names. Stored in| -| | | SDC and retrieved by the | -| | | modeling tool. Alarms differ | -| | | per VNF. | -+------------+----------------------------+-------------------------------+ -| Event | (Multiple values) | Categories of alarms for a VNF| -| Source Type| | .Differs per VNF. | -+------------+----------------------------+-------------------------------+ -| Event | * NORMAL | Severity level of the alarm | -| Severity | * not-NORMAL | that caused the rule to match.| -| | * WARNING | All conditions are exact | -| | * MINOR | matches, except for not-Normal| -| | * MAYOR | , which matches anything | -| | * CRITICAL | except NORMAL. | -+------------+----------------------------+-------------------------------+ - - -Configure Data Analytics Function ---------------------------------- - -**Prerequisites:** `Design a Model`_. - - #. In the model, click the *StringMatch*. - #. Click the *Properties* icon. - #. Configure fields as required (see table). - #. Click *Close*. - -+------------+----------------------------+-------------------------------+ -| Field | Values | Description | -+============+============================+===============================+ -| Topic | * DCAE-CL-EVENT | DMAAP message topic to | -| Publishes | | which the component subscribes| -+------------+----------------------------+-------------------------------+ -| AAI Fields | (Multiple values) | Additional VM-related fields | -| Matching | | that downstream elements such | -+------------+ | as Policy and APPC can use to | -| AAI Field | | take action on the signature. | -| Send | | | -| (Select | | | -| Multiple) | | | -+------------+----------------------------+-------------------------------+ -| Resource- | Integer | Group of string matching rules| -| Group | | that are to be treated | -| | | together. For example, a | -| | | resource group could contain | -| | | two different traps that must | -| | | be received to produce a | -| | | signature, as well as the | -| | | abatement match. | -+------------+----------------------------+-------------------------------+ -| Alarm | (Multiple values) | Populated from vendor-provided| -| Condition | | list of alarm names. Stored in| -| | | SDC and retrieved by the | -| | | modeling tool. Alarms differ | -| | | per VNF. | -+------------+----------------------------+-------------------------------+ -| Event | * NORMAL | Severity level of the alarm | -| Severity | * not-NORMAL | that caused the rule to match.| -| | * WARNING | All conditions are exact | -| | * MINOR | matches, except for not-Normal| -| | * MAYOR | , which matches anything | -| | * CRITICAL | except NORMAL. | -+------------+----------------------------+-------------------------------+ -| Event | (Multiple values) | Categories of alarms for a | -| Source Type| | VNF. Differs per VNF. | -+------------+----------------------------+-------------------------------+ -| Time | Integer | Interval during which multiple| -| Window | | traps must be received in | -| | | order to produce a single | -| | | signature. This value has no | -| | | meaning if only one onset rule| -| | | exists. A value of 0 means an | -| | | unlimited time window. | -+------------+----------------------------+-------------------------------+ -| Age | Integer | Traps older than this limit | -| Limit | | are deemed too stale to be | -| | | meaningful and are not | -| | | processed. | -+------------+----------------------------+-------------------------------+ -| Create CL | * Initial | *Initial:* start a closed | -| Event ID | * Close | loop with a new request ID | -| | | | -| | | *Close:* end an existing | -| | | closed loop (Close) | -+------------+----------------------------+-------------------------------+ -| Create CL | * OnSet | *OnSet:* start a closed loop | -| Event ID | * Abatement | when a condition starts. | -| Output | | Triggered with a new | -| Event Name | | request_id and signature flag | -| | | of *Initial* | -| | | | -| | | *Abatement:* end a closed loop| -| | | when a condition is corrected.| -| | | Triggered with signature flag | -| | | of *Close*. | -+------------+----------------------------+-------------------------------+ - - -Configure Policy ----------------- - -Use this task to configure the operational policy of the closed loop. - -**Prerequisites:** `Design a Model`_. - -Model configuration involves setting the values in this table, -for each of the Rebuild and Migrate recipies in the model. - -+------------+----------------------------+-------------------------------+ -| Field | Values | Description | -+============+============================+===============================+ -| Overall | Integer | Maximum overall time that can | -| Time Limit | | be spent on attempting all | -| | | actions. | -+------------+----------------------------+-------------------------------+ -| Receipe | * Restart | The automated action to be | -| | * Rebuild | triggered on the VM by the | -| | * Migrate | closed loop. | -+------------+----------------------------+-------------------------------+ -| Max Retries| Positive Integer | Number of times this action | -| | | should be attempted before | -| | | failing on MaxRetriesExceeded.| -+------------+----------------------------+-------------------------------+ -| Retry Time | Positive Integer | Maximum amount of time to take| -| Limit | | performing retries before | -| | | failing on TimeLimitExceeded. | -+------------+----------------------------+-------------------------------+ -| Parent | (Selection | Recipe that precedes this one | -| Policy | | in the chain of operations. | -| | | If this is the first action in| -| | | the chain, this field is not | -| | | set. | -+------------+----------------------------+-------------------------------+ -| Parent | * Failure: | Types of results from the | -| Policy | MaxRetriesExceeded | previous action on the chain | -| Conditions | * Failure: | that would cause a transition | -| | TimeLimitExceeded | to this action. | -| | * Failure: Exception | | -| | * Failure: Other | | -| | * Success | | -+------------+----------------------------+-------------------------------+ - - -Distribute the Model --------------------- - -**Prerequisites:** `Design a Model`_. - -In this step, the user distributes the models to the DCAE and -Policy subsystems of ONAP. - -After a model is uploaded to a VNF, the status icon of the VNF changes -to from "Design" to "Activated" in the ONAP Portal GUI. - -Open Loop Design ----------------- - -Create and distribute open control loops for managing VF faults and -performance after instantiation. - -With open loop control systems, the action(s) taken by the Policy do -not affect the output of the system. - -For information about creating policy using the Policy Designer, - -#TODO ADD A LINK TO VF Creation and Testing user-guides-service-design? - - -.. |image0| image:: media/DesignModel.png - diff --git a/docs/guides/onap-user/design/control-loop/media/DesignModel.png b/docs/guides/onap-user/design/control-loop/media/DesignModel.png Binary files differdeleted file mode 100644 index a7cac4f88..000000000 --- a/docs/guides/onap-user/design/control-loop/media/DesignModel.png +++ /dev/null diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst deleted file mode 100644 index b42d02224..000000000 --- a/docs/guides/onap-user/design/index.rst +++ /dev/null @@ -1,113 +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. - -.. _doc_guide_user_des: - -Design Service -============== - -The goal of the design process is to create all artifacts (models) -that are required to instantiate and manage resources, services, -and products on the ONAP platform. - -Design progresses logically through a series of phases. Each phase: - -* is organized into steps that are completed in sequence - -* generates artifacts that are used in other phases of design - -* is performed by multiple Design components - -The following figure show the different phases and tools involved in -Onboarding, Design and Distribution process. - -|image1| - -**The "Core" Design Process includes the following steps:** - -**Pre-Onboarding** - A VNF/PNF/CNF Provider delivers its descriptor, model and - artefacts (e.g. HEAT template, Helm Chart), which will be validated - and packaged for onboarding to ONAP - -**(Resource)-Onboarding** - In the SDC a License Model is created, the VNF/PNF/CNF package imported - and a Vendor Software Product (VSP) is created - -**VF Creation and Testing** - A V(N)F, PNF or CR Model is created (a) import of a VSP or VFC - (b) manual creation and import of artefacts created via external - tools like the Controller Design Studio (CDS), responsible for the - Controller Blueprint Design - The created VF Model will be used in a Service Model - -**Service Design** - A Service Model is created as a composition of resources - (e.g. V(N)Fs, PNFs,...), Policies, Workflows,... - The created Service Model will be certified and handed over to - the Service Distribution process - -**Service Distribution** - The Service Provider will distribute the Service Model to the - Runtime Service Catalog - -**The optional/additional Design steps are:** - -**VNF parameter assignment templating** - The objective is to automate the resolution of resources for instantiation - and any config provisioning operation, such as day0, day1 or day2 - configuration. - The Controller Blueprint archive (CBA) is a fully model-driven, - intent based package needed to design self service - provisioning and configuration management automation. - ONAP CDS (Controller Design Studio) is the controller that will process - the Controller Blueprint archive (CBA) at run-time. - -**Policy Design** - These are rules, conditions, requirements, constraints, attributes, - or needs that must be provided, maintained, and/or enforced. - At a lower level, Policy involves machine-readable rules enabling - actions to be taken based on triggers or requests. ONAP Policy framework - provides some policy models that are implemented and pre-loaded when - installing ONAP. - -**Workflow Design** - The purpose of the Workflow Designer is to enable designers to define or - modify workflows to support Service/Resource change management scenarios - executed by the Service Orchestrator. - -**DCAE Onboard/Design** - This phase includes the Onboarding of DCAE Microservices and their - Policy Models, the Service Assurance Design and Distribution to Policy - and CLAMP for Closed Loop Automation Management. - The DCAE Onboard/Design component contains an own Design Catalog, which is - not yet integrated with the SDC Design Catalog to exchange models and - artefacts. - -The following sections focus on the different Design steps: - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - Pre-Onboarding <./pre-onboarding/index.rst> - Resource-Onboarding <./resource-onboarding/index.rst> - VF Creation and Testing <./vfcreation/index.rst> - Service Design <./service-design/index.rst> - Service Distribution <./service-distribution/index.rst> - VNF Parameter Resolution Design <./parameter_resolution/index.rst> - Control Loop Design <./control-loop/index.rst> - Instructions for Control Loop Design <./control-loop-design-steps/cl_design_instructions.rst> - -The following section provide links to the projects: - -- :ref:`Policy Design<onap-policy-parent:design-label>` -- :ref:`Workflow Design<onap-sdc:workflow>` -- :ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>` -- :ref:`Control Loop Automation Management<onap-policy-parent:clamp-label>` - -.. |image1| image:: media/Design-Overview.png - - - diff --git a/docs/guides/onap-user/design/media/Design-Overview.png b/docs/guides/onap-user/design/media/Design-Overview.png Binary files differdeleted file mode 100644 index 5e722d26d..000000000 --- a/docs/guides/onap-user/design/media/Design-Overview.png +++ /dev/null diff --git a/docs/guides/onap-user/design/media/Design-Overview.pptx b/docs/guides/onap-user/design/media/Design-Overview.pptx Binary files differdeleted file mode 100644 index 8ae0ace73..000000000 --- a/docs/guides/onap-user/design/media/Design-Overview.pptx +++ /dev/null diff --git a/docs/guides/onap-user/design/media/capabilities.png b/docs/guides/onap-user/design/media/capabilities.png Binary files differdeleted file mode 100755 index 447a3c65f..000000000 --- a/docs/guides/onap-user/design/media/capabilities.png +++ /dev/null diff --git a/docs/guides/onap-user/design/media/cba.png b/docs/guides/onap-user/design/media/cba.png Binary files differdeleted file mode 100755 index eda765050..000000000 --- a/docs/guides/onap-user/design/media/cba.png +++ /dev/null diff --git a/docs/guides/onap-user/design/media/cds-blueprint.png b/docs/guides/onap-user/design/media/cds-blueprint.png Binary files differdeleted file mode 100755 index f7d988f64..000000000 --- a/docs/guides/onap-user/design/media/cds-blueprint.png +++ /dev/null diff --git a/docs/guides/onap-user/design/media/mapping.png b/docs/guides/onap-user/design/media/mapping.png Binary files differdeleted file mode 100755 index ed1403557..000000000 --- a/docs/guides/onap-user/design/media/mapping.png +++ /dev/null diff --git a/docs/guides/onap-user/design/media/sdc.png b/docs/guides/onap-user/design/media/sdc.png Binary files differdeleted file mode 100755 index 5e553cda9..000000000 --- a/docs/guides/onap-user/design/media/sdc.png +++ /dev/null diff --git a/docs/guides/onap-user/design/parameter_resolution/index.rst b/docs/guides/onap-user/design/parameter_resolution/index.rst deleted file mode 100644 index 72754d63a..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/index.rst +++ /dev/null @@ -1,741 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_des_param_assign: - -VNF Parameter resolution templating -=================================== - -Overview --------- - -When instantiating a Service composed of connectivity, PNF, -VNF or CNF there is the need to set the parameter values for the -created instances. - -For example, it may be necessary to provide a VNF management @ip -Address or a VNF instance name. Those parameters can be necessary -to create cloud resources or to configure the VNF at application level. - -In the first releases of ONAP the operator needed to provide these parameters -as preload data via datasheet or API call before instantiating each -PNF/VNF/CNF. -This was an error-prone manual step that interferes with an automated and -scalable service instantiation. -As part of the ONAP CDS component introduction -in Casablanca release, the user, that wants to instantiate a new VNF/CNF, -does not need to get and provide those data. - -Of course the “user” may be a human but may be also an application that uses -the “instantiation” API on ONAP NBI or ONAP SO. - -ONAP CDS component is then in charge of resolving those parameters -automatically. - -The detailed CDS documentation can be found here: :ref:`cds_main-doc` - -It offers automated solution out of the box by delivering network intent -declarative package during design time phase that automated the provisioning -and/or network configuration network intent. - -At instantiation time, CDS controller will find (assign) the values -according some “recipies” described in a "Controller Blueprint Archive”: -a collection of files that CDS controller will use to proceed -parameter resolution. - -Thanks to CDS, at instantiation time, the user, that wants to instantiate -a new VNF, does not need to get and provide those data himself. -Of course the “user” may be a human but may be also -an application that uses the “instantiation” API on ONAP NBI or ONAP SO. - -Less effort for the “user”, but more effort for the “designer” -that needs to pre-defined all necessary recipies -during design time. - -The purpose of the following text is to describe various files and content -that are necessary to the CDS controller to resolve any parameters. - -To illustrate the subject, let's take an example: a service composed of -an "ubuntu" VNF. That service will be called "ubuntuCDS" in ONAP SDC -for that example. - -That VNF will be based on a simple ubuntu image. That VF will be called -ubuntuCDS in ONAP SDC for that example. - -WARNING: all operations need to be adapted to your context -(platform, service, identifiers...) - -Pre-requisite -------------- - -There are two problems with ONAP ElAlto release: - -**wrong Directed Graphs** - -In ONAP Elalto, a problem was detected about Directed Graphs: JIRA_SDNC_949_ - -The workaround is to upload/replace the following two Directed Graph in SDNC -(via DG Builder UI for example). - -VNF topology assign: DG_VNF_ASSIGN_. - -VF-Module topology assign: DG_VFMODULE_ASSIGN_. - - -**wrong URL in CDS-UI pod** - -CDS-UI pod needs to communicate with CDS BluePrint processor to perform -"enrichment", "publish", "deploy" operations. - -The URL is not correct in the OOM file used to deploy CDS UI. - -If you have permission, you can change the url via: - -:: - - kubectl edit deployment -n onap {{cds ui pod id}} - -API_BLUEPRINT_CONTROLLER_HTTP_BASE_URL parameter must have the following value - -:: - - http://cds-blueprints-processor-http:8080/api/v1 - - -Those problems should be corrected in next ONAP release. - -Design process --------------- - - * `Step 1: identify the parameters needed for instantiation`_ - * `Step 2: identify the parameters needed for post-instantiation`_ - * `Step 3: identify the resolution method for each parameter`_ - * `Step 4: add new data definition in CDS resource dictionary`_ - * `Step 5: write template files`_ - * `Step 6: write mapping files`_ - * `Step 7: write scripts`_ - * `Step 8: write the "blueprint" file`_ - * `Step 9: build the "Controller Blueprint Archive” (cba)`_ - * `Step 10: attached the cba to a service definition`_ - * `Step 11: distribute the service`_ - * `Step 12: instantiate the service and check`_ - - -Step 1: identify the parameters needed for instantiation --------------------------------------------------------- - -To instantiate an "ubuntu" VNF, a Heat Template can be used. Several -parameters are defined in that template: vnf_name, image_name, -management @ip... - -This Heat Template is a first place to identify the parameters that need -to be resolved. - -Our example: - -:: - - parameters: - # Metadata required by ONAP - vnf_id: ubuntuCDS-VNF - vf_module_id: ubuntuCDS-VF-module - vnf_name: ubuntuCDS-VNF-name - - # Server parameters, naming required by ONAP - ubuntuCDS_image_name: ubuntu-18 - ubuntuCDS_flavor_name: onap.small - ubuntuCDS_pub_key: ssh-rsa AAAAB3VHCx...vVL8l1BrX3BY0R8D imported-openssh-key - ubuntuCDS_name_0: ubuntuCDS - - # Network parameters, naming required by ONAP - admin_plane_net_name: admin - -Step 2: identify the parameters needed for post-instantiation -------------------------------------------------------------- - -Post-instantiation activity will occur after the VNF is instantiated. - -Typically, it can be adding a first firewall rule in a firewall VNF. - -In the ubuntuCDS example, there is no such parameter. - - -Step 3: identify the resolution method for each parameter ---------------------------------------------------------- - -Here after the decision/solution that the designer may take: - -**vnf_name** will be resolved via an input that will be provided -in the instantiation request. - -**ubuntuCDS_image_name** will be resolved via an input that will be provided -in the instantiation request. - -**ubuntuCDS_flavor_name** will be resolved via an input that will be provided -in the instantiation request. - -**ubuntuCDS_pub_key** will be resolved via an input that will be provided -in the instantiation request. - -**admin_plane_net_name** will be resolved via an input that will be provided -in the instantiation request. - -Service Designer needs also to know that some parameters will be -automatically resolved by ONAP SO and/or ONAP SDNC. - -- service-instance-id -- vnf-id -- vf_module_id - -For each resolution method, Service Designer needs to identify all -necessary parameters that must be provided to the resoluton method -in order to obtain the resolution. - -Also, Service Designer needs to know that ONAP will instantiate -a service, a list of VNF that are composing the service and, for each VNF, -a "VF-module" will be instantiated. - - -Step 4: add new data definition in CDS resource dictionary ----------------------------------------------------------- - -In CDS, there is a database that will contain all resource Definitions -in order to be able to re-use those resources from one service to an other. - -Service Designer needs to check about existing resource definitions -in the dictionary. - -By default, some resources are pre-loaded when installing ONAP platform. - -Preloaded resources (parameter definition): Resources_. - -Be careful: the content of the resource dictionary is not the same from -one ONAP release to an other. - -If Service Designer sees that there is an existing parameter -that corresponds to the need, he has the possibility to re-use it -in the mapping file(s), but maybe with a different name. - -For example, "image_name" is already defined in the resource dictionary but, -it is named "freeRadius_image_name" in the Heat files. - -For the ubuntuCDS example, there is no need to add any entry in the -data_dictionary - -"curls" requests example to declare a new resource -:download:`Here <ubuntu_example/curls_resource_dictionary.txt>` - -Step 5: write template files ----------------------------- - -In this Ubuntu example, Designer needs to create 2 "templates" files. -Naming of those files is important. For VNF, prefix name must be equal to the -VF name in ONAP SDC. For the VFmodule, prefix name must be equal to the name -of the Heat template. - -- VNF level :download:`VNF_template_file <ubuntu_example/cba-before-enrichment\ - /Templates/ubuntuCDS-template.vtl>` -- VF-module level :download:`VFmodule_template_file <ubuntu_example/cba-before\ - -enrichment/Templates/base_ubuntuCDS-template.vtl>` - -CDS makes use of "velocity template" or "Jinja template" files. - -This way, CDS is able to generate the desired datastructure -with resolved values, that will then be sent to the target system: - -- openstack when instantiating the Heat stack -- instantiated VNF when doing some post-instantiation operation - -There are two sections in each velocity file: - -- "resource-accumulator-resolved-data": a list of all parameters -- "capability-data": a list of "capabilities" to process and resolve - a parameter - -A capability can be an other way to resolve a parameter, -using a directed graph. - -A capability may also be an action to be performed such as modifying -a data in ONAP AAI. - -ONAP SDNC provides those "capabilities": - -- generate-name -- vlan-tag-assign -- netbox-ip-assign -- aai-vnf-put -- ... - -There is an SDNC Directed Graph associated to each of those "capability". - -Service Designer needs to know about those capabilities with their -input/output, in order to re-use them. Especially, Service Designer needs -to know inputs because those inputs need to be part of the templates. - -In case Service Designer wants to use a new capability, a solution is -to create a Directed Graph and update the self-serve-vnf-assign and/or -self-serve-vf-module-assign Directed Graph by adding a new -entry in the list of capabilities (node: set ss.capability.execution-order[]) - -The "aai-vfmodule-put" capability is important to be part of a vf-module -template because it will be used to put the vf-module-name in AAI -and ONAP SO will use that value to name the heat stack. - -|image3| - - -About the name/value of each parameter, Service Designer needs to understand -how various information will map between the various files needed by CDS. - -|image5| - -And be very careful with "_" or "-" - -Step 6: write mapping files ---------------------------- - -Along with each velocity template, Designer needs to create a -"mapping" file. - -This is the place where the Designer explains, for each parameter: - -- value source: the system or database that will provide the value -- default value - -At VNF instantiation step, values are often coming from input (in the request -sent by the user, in the "instanceParams" section of the vnf). - -At VF module instantion step, values can come form input also in the request -sent by the user, in the "instanceParams" section of the vf-module) - -Resolved data are always stored in SDNC database (MDSAL) - -Note1: if service designer wants to re-use for vf-module a -parameter/value from VNF "userParams" section, -then the source will be from "SDNC" in the vf-module mapping file. - -Note2: service-instance-id, vnf-id and vf_module_id are parameters considered -as "input" from CDS point of view but in reality they are resolved by ONAP SO -with ONAP AAI. Thus, those parameters are not "input" from ONAP SO -point of view: service designer has not need to provide those parameters in -service instantiation request (step 12). - -For the ubuntu example, there are then 2 mapping files. -File names are important and must be aligned with vtl template names. - -- VNF level :download:`VNF_mapping_file <ubuntu_example/cba-before-enrichment\ - /Templates/ubuntuCDS-mapping.json>` -- VFmodule level :download:`VFmodule_mapping_file <ubuntu_example/cba-before-\ - enrichment/Templates/base_ubuntuCDS-mapping.json>` - -Step 7: write scripts ---------------------- - -Sometimes, it will be necessary to use some scripts (python, kotlin, -ansible...) to process some post-configuration operation. - -Those scripts needs to be part of the "Controller Blueprint Archive” (cba). - -No such script for the ubuntuCDS example. - - -Step 8: write the "blueprint" file --------------------------------------- - -The "designer" will then create a "blueprint". - -It is a JSON file and for the ubuntuCDS usecase, it is called -ubuntuCDS.json. -Name must be aligned with VF name in ONAP SDC. - -This file will be the main entry point for CDS blueprint processor. -This processor will use that file to understand what need to -be processed and how to process it. - -The content of that file is composed of several sections conforming to TOSCA -specifications. - -|image1| - -For the ubuntu example :download:`CDS blueprint <ubuntu_example/cba-before-\ -enrichment/Definitions/ubuntuCDS.json>` before enrichment. - -This example is the minimum that is required to simply instantiate a -VNF. - -Some extension can then be added in order to define additional -operations. - -Step 9: build the "Controller Blueprint Archive” (cba) ------------------------------------------------------- - -Having created velocity templates, mapping files and a first -CDS blueprint version, -it is now simple to create the "Controller Blueprint Archive” (cba). - -This is a "zip-like" archive file that will have the following structure -and content ("environment", "scripts" and "plans" are optional): - -|image2| - -For the ubuntu example :download:`cba archive <ubuntu_example/cba-before-\ -enrichment/cba-before-enrichment.zip>` before enrichment. - -To complete that cba, an "enrichment" operation is needed. - -Service Designer can use two methods: - -- using CDS User Interface -- using CDS rest API - -Service Designer needs to send the cba to CDS-UI pod and requests -the enrichment, then save and then download. - -Result will be that the cba will now contains several new files in "Definition" -folder of the cba. - -The "blueprint" file will also be completed. - -The "enriched" cba is now ready to be onboarded in ONAP SDC along with -a service definition. - -For the ubuntu example :download:`cba archive <ubuntu_example/cba-after\ --enrichment/cba-ubuntuCDS-enriched.zip>` after enrichment. - -Step 10: attached the cba to a service definition -------------------------------------------------- - -In SDC, when defining a VF, Designer will attach the cba archive -to the VF definition, using the "deployment artifact" section. - -Having define all necessary VF, Service Designer will create a SERVICE in SDC. - -Service Designer will compose the SERVICE with appropriate VF(s) and will have -to modify PROPERTIES in the "properties assignement" section. - -Service Designer needs to provide values for sdnc_artifact_name, -sdnc_model_name and sdnc_model_verion. - -This will tell SO which blueprint to use for the service model that is being -instantiate - -SDC sdnc_artifact_name = CBA blueprint json filename, e.g. “ubuntuCDS”, -we will see below that we will have vnf-mapping.json and vnf-template.vtl -templates in the blueprint. - -SDC sdnc_model_name = CBA Metadata template_name, e.g. “ubuntuCDS”, -we can see in the below screenshot the metadata section showing template name. - -SDC sdnc_model_verion = CBA Metadata template_version, e.g. “1.0.0”, -we can see in the below screenshot the metadata section showing -template version. - -|image4| - -Step 11: distribute the service -------------------------------- - -In SDC, when distributing the service, the CDS controller will be -informed that a new cba archive is available. - -CDS controller will then collect the cba archive. - -Step 12: instantiate the service and check ------------------------------------------- - -Here is an example of an ONAP SO api request to -instantiate the ubuntu service. - -This request is used to instantiate a service using the "Macro" mode. - -Do not try to use that example as-is: you need to adapt all values to your -platform/service model. - -In this example, the request contains several "inputs" at VNF level and -several "inputs" at VF-module level. - -All various "id" and "version" are some copy/paste information that -Service Designer has the possibility to find in the TOSCA service -template created in ONAP SDC. - -This request will instantiate a "service", a "VNF" and a "VF-module". -That "service" instance is attached to the customer named "JohnDoe" with -service subscription named "ubuntCDS" -(supposed already declared in your ONAP AAI). - -In case the instantiation fails, a roolback is performed (parameter -"suppressRollback" = false) - -For that example, no "homing" and the "cloud" tenant is explicitely -provided (supposed already declared in your ONAP AAI) - -:: - - curl -X POST \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \ - -H 'Content-Type: application/json' \ - -H 'X-ONAP-PartnerName: NBI' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "subscriberInfo": { - "globalSubscriberId": "JohnDoe" - }, - "requestInfo": { - "suppressRollback": false, - "productFamilyId": "Useless_But_Mandatory", - "requestorId": "adt", - "instanceName": "My_ubuntuCDS_service_instance_001", - "source": "VID" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "RegionOne", - "tenantId": "71cf9d931d9e4b8e9fcca50d97c1cf96", - "cloudOwner": "ONAP" - }, - "requestParameters": { - "subscriptionServiceType": "ubuntuCDS", - "userParams": [ - { - "Homing_Solution": "none" - }, - { - "service": { - "instanceParams": [], - "instanceName": "My_ubuntuCDS_service_instance_001", - "resources": { - "vnfs": [ - { - "modelInfo": { - "modelName": "ubuntuCDS", - "modelVersionId": "c6a5534e-76d5-4128-97bf-ad3b72208d53", - "modelInvariantUuid": "ed3064e7-62c0-494c-bb9b-4f56d1ad157e", - "modelVersion": "1.0", - "modelCustomizationId": "6a32fb56-191e-4d11-a0cc-44b779aba4fc", - "modelInstanceName": "ubuntuCDS 0" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "RegionOne", - "tenantId": "71cf9d931d9e4b8e9fcca50d97c1cf96" - }, - "platform": { - "platformName": "Useless_But_Mandatory" - }, - "productFamilyId": "Useless_But_Mandatory", - "instanceName": "My_VNF_ubuntuCDS_instance_001", - "instanceParams": [ - { - "vnf_name": "My_VNF_ubuntuCDS_instance_001" - } - ], - "vfModules": [ - { - "modelInfo": { - "modelName": "Ubuntucds..base_ubuntuCDS..module-0", - "modelVersionId": "3025cd36-b170-4667-abb1-2bae1f297844", - "modelInvariantUuid": "0101f9e0-7beb-4b58-92c7-ba3324b5a54d", - "modelVersion": "1", - "modelCustomizationId": "9bca4d4b-e27c-4652-a61e-b1b4ebca503d" - }, - "instanceName": "My_vfModule_ubuntuCDS_instance_001", - "instanceParams": [ - { - "vnf_name": "My_VNF_ubuntuCDS_instance_001", - "vf_module_name": "My_vfModule_ubuntuCDS_instance_001", - "ubuntuCDS_pub_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDY15cdBmIs2XOpe4EiFCsaY6bmUmK/GysMoLl4UG51JCfJwvwoWCoA+6mDIbymZxhxq9IGxilp/yTA6WQ9s/5pBag1cUMJmFuda9PjOkXl04jgqh5tR6I+GZ97AvCg93KAECis5ubSqw1xOCj4utfEUtPoF1OuzqM/lE5mY4N6VKXn+fT7pCD6cifBEs6JHhVNvs5OLLp/tO8Pa3kKYQOdyS0xc3rh+t2lrzvKUSWGZbX+dLiFiEpjsUL3tDqzkEMNUn4pdv69OJuzWHCxRWPfdrY9Wg0j3mJesP29EBht+w+EC9/kBKq+1VKdmsXUXAcjEvjovVL8l1BrX3BY0R8D imported-openssh-key", - "ubuntuCDS_image_name": "ubuntu-18.04-daily", - "ubuntuCDS_flavor_name": "onap.small", - "ubuntuCDS_name_0": "ubuntuCDS-VM-001", - "admin_plane_net_name": "admin" - } - ] - } - ] - } - ] - }, - "modelInfo": { - "modelVersion": "1.0", - "modelVersionId": "10369444-1e06-4d5d-974b-362bcfd19533", - "modelInvariantId": "32e00b49-eff8-443b-82a8-b75fbb6e3867", - "modelName": "ubuntuCDS", - "modelType": "service" - } - } - } - ], - "aLaCarte": false, - "usePreload": false - }, - "owningEntity": { - "owningEntityId": "Useless_But_Mandatory", - "owningEntityName": "Useless_But_Mandatory" - }, - "modelInfo": { - "modelVersion": "1.0", - "modelVersionId": "10369444-1e06-4d5d-974b-362bcfd19533", - "modelInvariantId": "32e00b49-eff8-443b-82a8-b75fbb6e3867", - "modelName": "ubuntuCDS", - "modelType": "service" - } - } - }' - -In response, ONAP SO will immediately provide a requestId and a service -instance id. - -The instantiation will take some time. It will be necessary -to perform a "GET" on the request to check the result. - -:: - - curl -X GET \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/orchestrationRequests/v7/{{requestID}} \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: get_aai_subscr' \ - -H 'cache-control: no-cache' - - -To delete the service instance, just add the service_instance_id in the URL and -send a DELETE operation. - - -:: - - curl -X DELETE \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances/{{service_instance_Id}} \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \ - -H 'Content-Type: application/json' \ - -H 'X-ONAP-PartnerName: NBI' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "subscriberInfo": { - "globalSubscriberId": "JohnDoe" - }, - "requestInfo": { - "suppressRollback": false, - "productFamilyId": "Useless_But_Mandatory", - "requestorId": "adt", - "instanceName": "My_ubuntuCDS_service_instance_001", - "source": "VID" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "RegionOne", - "tenantId": "71cf9d931d9e4b8e9fcca50d97c1cf96", - "cloudOwner": "ONAP" - }, - "requestParameters": { - "subscriptionServiceType": "ubuntuCDS", - "userParams": [ - { - "Homing_Solution": "none" - }, - { - "service": { - "instanceParams": [], - "instanceName": "My_ubuntuCDS_service_instance_001", - "resources": { - "vnfs": [ - { - "modelInfo": { - "modelName": "ubuntuCDS", - "modelVersionId": "c6a5534e-76d5-4128-97bf-ad3b72208d53", - "modelInvariantUuid": "ed3064e7-62c0-494c-bb9b-4f56d1ad157e", - "modelVersion": "1.0", - "modelCustomizationId": "6a32fb56-191e-4d11-a0cc-44b779aba4fc", - "modelInstanceName": "ubuntuCDS 0" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "RegionOne", - "tenantId": "71cf9d931d9e4b8e9fcca50d97c1cf96" - }, - "platform": { - "platformName": "Useless_But_Mandatory" - }, - "productFamilyId": "Useless_But_Mandatory", - "instanceName": "My_VNF_ubuntuCDS_instance_001", - "instanceParams": [ - { - "vnf_name": "My_VNF_ubuntuCDS_instance_001" - } - ], - "vfModules": [ - { - "modelInfo": { - "modelName": "Ubuntucds..base_ubuntuCDS..module-0", - "modelVersionId": "3025cd36-b170-4667-abb1-2bae1f297844", - "modelInvariantUuid": "0101f9e0-7beb-4b58-92c7-ba3324b5a54d", - "modelVersion": "1", - "modelCustomizationId": "9bca4d4b-e27c-4652-a61e-b1b4ebca503d" - }, - "instanceName": "My_vfModule_ubuntuCDS_instance_001", - "instanceParams": [ - { - "vnf_name": "My_VNF_ubuntuCDS_instance_001", - "vf_module_name": "My_vfModule_ubuntuCDS_instance_001", - "ubuntuCDS_pub_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDY15cdBmIs2XOpe4EiFCsaY6bmUmK/GysMoLl4UG51JCfJwvwoWCoA+6mDIbymZxhxq9IGxilp/yTA6WQ9s/5pBag1cUMJmFuda9PjOkXl04jgqh5tR6I+GZ97AvCg93KAECis5ubSqw1xOCj4utfEUtPoF1OuzqM/lE5mY4N6VKXn+fT7pCD6cifBEs6JHhVNvs5OLLp/tO8Pa3kKYQOdyS0xc3rh+t2lrzvKUSWGZbX+dLiFiEpjsUL3tDqzkEMNUn4pdv69OJuzWHCxRWPfdrY9Wg0j3mJesP29EBht+w+EC9/kBKq+1VKdmsXUXAcjEvjovVL8l1BrX3BY0R8D imported-openssh-key", - "ubuntuCDS_image_name": "ubuntu-18.04-daily", - "ubuntuCDS_flavor_name": "onap.small", - "ubuntuCDS_name_0": "ubuntuCDS-VM-001", - "admin_plane_net_name": "admin" - } - ] - } - ] - } - ] - }, - "modelInfo": { - "modelVersion": "1.0", - "modelVersionId": "10369444-1e06-4d5d-974b-362bcfd19533", - "modelInvariantId": "32e00b49-eff8-443b-82a8-b75fbb6e3867", - "modelName": "ubuntuCDS", - "modelType": "service" - } - } - } - ], - "aLaCarte": false, - "usePreload": false - }, - "owningEntity": { - "owningEntityId": "Useless_But_Mandatory", - "owningEntityName": "Useless_But_Mandatory" - }, - "modelInfo": { - "modelVersion": "1.0", - "modelVersionId": "10369444-1e06-4d5d-974b-362bcfd19533", - "modelInvariantId": "32e00b49-eff8-443b-82a8-b75fbb6e3867", - "modelName": "ubuntuCDS", - "modelType": "service" - } - } - }' - - -Trouble shooting ----------------- - -Have a look to - -- debug.log in CDS blueprint processor pod -- debug.log into SO Bpmn pod -- karaf.log into SDNC pod - -.. |image1| image:: ../media/cds-blueprint.png -.. |image2| image:: ../media/cba.png -.. |image3| image:: ../media/capabilities.png -.. |image4| image:: ../media/sdc.png -.. |image5| image:: ../media/mapping.png -.. _JIRA_SDNC_949: https://jira.onap.org/browse/SDNC-949 -.. _Resources: https://git.onap.org/ccsdk/cds/tree/components/model-catalog/resource-dictionary/starter-dictionary -.. _DG_VNF_ASSIGN: https://gerrit.onap.org/r/gitweb?p=sdnc/oam.git;a=blob_plain;f=platform-logic/generic-resource-api/src/main/json/GENERIC-RESOURCE-API_vnf-topology-operation-assign.json;hb=HEAD -.. _DG_VFMODULE_ASSIGN: https://gerrit.onap.org/r/gitweb?p=sdnc/oam.git;a=blob_plain;f=platform-logic/generic-resource-api/src/main/json/GENERIC-RESOURCE-API_vf-module-topology-operation-assign.json;hb=HEAD diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/artifact_types.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/artifact_types.json deleted file mode 100755 index da498e35e..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/artifact_types.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "artifact_types" : { - "artifact-mapping-resource" : { - "description" : "Resource Mapping File used along with Configuration template", - "version" : "1.0.0", - "derived_from" : "tosca.artifacts.Implementation", - "file_ext" : [ "json" ] - }, - "artifact-template-velocity" : { - "description" : " Velocity Template used for Configuration", - "version" : "1.0.0", - "derived_from" : "tosca.artifacts.Implementation", - "file_ext" : [ "vtl" ] - } - } -}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/data_types.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/data_types.json deleted file mode 100755 index 413a5e5b8..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/data_types.json +++ /dev/null @@ -1,116 +0,0 @@ -{ - "data_types" : { - "dt-resource-assignment-properties" : { - "description" : "Dynamic DataType definition for workflow(resource-assignment).", - "version" : "1.0.0", - "properties" : { - "vnf-id" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "default" : "", - "entry_schema" : { - "type" : "" - } - }, - "vf-module-id" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "default" : "", - "entry_schema" : { - "type" : "" - } - }, - "ubuntuCDS_pub_key" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "entry_schema" : { - "type" : "" - } - }, - "vnf_id" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "default" : "", - "entry_schema" : { - "type" : "" - } - }, - "service-instance-id" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "default" : "", - "entry_schema" : { - "type" : "" - } - }, - "vnf_name" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "default" : "ubuntuCDS-VNF-name", - "entry_schema" : { - "type" : "" - } - }, - "ubuntuCDS_flavor_name" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "entry_schema" : { - "type" : "" - } - }, - "ubuntuCDS_name_0" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "entry_schema" : { - "type" : "" - } - }, - "admin_plane_net_name" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "entry_schema" : { - "type" : "" - } - }, - "ubuntuCDS_image_name" : { - "description" : "", - "required" : false, - "type" : "string", - "status" : "", - "constraints" : [ { } ], - "entry_schema" : { - "type" : "" - } - } - }, - "derived_from" : "tosca.datatypes.Dynamic" - } - } -}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/node_types.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/node_types.json deleted file mode 100755 index e812db1cf..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/node_types.json +++ /dev/null @@ -1,260 +0,0 @@ -{ - "node_types" : { - "component-resource-resolution" : { - "description" : "This is Resource Assignment Component API", - "version" : "1.0.0", - "attributes" : { - "assignment-params" : { - "required" : true, - "type" : "string" - } - }, - "capabilities" : { - "component-node" : { - "type" : "tosca.capabilities.Node" - } - }, - "interfaces" : { - "ResourceResolutionComponent" : { - "operations" : { - "process" : { - "inputs" : { - "resolution-key" : { - "description" : "Key for service instance related correlation.", - "required" : false, - "type" : "string" - }, - "occurrence" : { - "description" : "Number of time to perform the resolution.", - "required" : false, - "type" : "integer", - "default" : 1 - }, - "store-result" : { - "description" : "Whether or not to store the output.", - "required" : false, - "type" : "boolean" - }, - "resource-type" : { - "description" : "Request type.", - "required" : false, - "type" : "string" - }, - "artifact-prefix-names" : { - "description" : "Template , Resource Assignment Artifact Prefix names", - "required" : true, - "type" : "list", - "entry_schema" : { - "type" : "string" - } - }, - "request-id" : { - "description" : "Request Id, Unique Id for the request.", - "required" : true, - "type" : "string" - }, - "resource-id" : { - "description" : "Resource Id.", - "required" : false, - "type" : "string" - }, - "action-name" : { - "description" : "Action Name of the process", - "required" : false, - "type" : "string" - }, - "dynamic-properties" : { - "description" : "Dynamic Json Content or DSL Json reference.", - "required" : false, - "type" : "json" - } - }, - "outputs" : { - "resource-assignment-params" : { - "required" : true, - "type" : "string" - }, - "status" : { - "required" : true, - "type" : "string" - } - } - } - } - } - }, - "derived_from" : "tosca.nodes.Component" - }, - "source-capability" : { - "description" : "This is Component Resource Source Node Type", - "version" : "1.0.0", - "properties" : { - "script-type" : { - "required" : true, - "type" : "string", - "constraints" : [ { - "valid_values" : [ "kotlin", "internal", "jython" ] - } ], - "default" : "kotlin" - }, - "script-class-reference" : { - "description" : "Capability reference name for internal and kotlin, for jython script file path", - "required" : true, - "type" : "string" - }, - "instance-dependencies" : { - "description" : "Instance dependency Names to Inject to Kotlin / Jython Script.", - "required" : false, - "type" : "list", - "entry_schema" : { - "type" : "string" - } - }, - "key-dependencies" : { - "description" : "Resource Resolution dependency dictionary names.", - "required" : true, - "type" : "list", - "entry_schema" : { - "type" : "string" - } - } - }, - "derived_from" : "tosca.nodes.ResourceSource" - }, - "source-db" : { - "description" : "This is Database Resource Source Node Type", - "version" : "1.0.0", - "properties" : { - "type" : { - "required" : true, - "type" : "string", - "constraints" : [ { - "valid_values" : [ "SQL", "PLSQL" ] - } ], - "default" : "SQL" - }, - "endpoint-selector" : { - "required" : false, - "type" : "string" - }, - "query" : { - "required" : true, - "type" : "string" - }, - "input-key-mapping" : { - "required" : false, - "type" : "map", - "entry_schema" : { - "type" : "string" - } - }, - "output-key-mapping" : { - "required" : false, - "type" : "map", - "entry_schema" : { - "type" : "string" - } - }, - "key-dependencies" : { - "required" : true, - "type" : "list", - "entry_schema" : { - "type" : "string" - } - } - }, - "derived_from" : "tosca.nodes.ResourceSource" - }, - "source-default" : { - "description" : "This is Default Resource Source Node Type", - "version" : "1.0.0", - "properties" : { }, - "derived_from" : "tosca.nodes.ResourceSource" - }, - "source-input" : { - "description" : "This is Input Resource Source Node Type", - "version" : "1.0.0", - "properties" : { }, - "derived_from" : "tosca.nodes.ResourceSource" - }, - "source-rest" : { - "description" : "This is Rest Resource Source Node Type", - "version" : "1.0.0", - "properties" : { - "type" : { - "required" : true, - "type" : "string", - "constraints" : [ { - "valid_values" : [ "JSON" ] - } ], - "default" : "JSON" - }, - "verb" : { - "required" : true, - "type" : "string", - "constraints" : [ { - "valid_values" : [ "GET", "POST", "DELETE", "PUT" ] - } ], - "default" : "GET" - }, - "payload" : { - "required" : false, - "type" : "string", - "default" : "" - }, - "endpoint-selector" : { - "required" : false, - "type" : "string" - }, - "url-path" : { - "required" : true, - "type" : "string" - }, - "path" : { - "required" : true, - "type" : "string" - }, - "expression-type" : { - "required" : false, - "type" : "string", - "constraints" : [ { - "valid_values" : [ "JSON_PATH", "JSON_POINTER" ] - } ], - "default" : "JSON_PATH" - }, - "input-key-mapping" : { - "required" : false, - "type" : "map", - "entry_schema" : { - "type" : "string" - } - }, - "output-key-mapping" : { - "required" : false, - "type" : "map", - "entry_schema" : { - "type" : "string" - } - }, - "key-dependencies" : { - "required" : true, - "type" : "list", - "entry_schema" : { - "type" : "string" - } - } - }, - "derived_from" : "tosca.nodes.ResourceSource" - }, - "tosca.nodes.Component" : { - "description" : "This is default Component Node", - "version" : "1.0.0", - "derived_from" : "tosca.nodes.Root" - }, - "tosca.nodes.ResourceSource" : { - "description" : "TOSCA base type for Resource Sources", - "version" : "1.0.0", - "derived_from" : "tosca.nodes.Root" - } - } -}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/policy_types.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/policy_types.json deleted file mode 100755 index 1e44cc70a..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/policy_types.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "policy_types" : { } -}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/relationship_types.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/relationship_types.json deleted file mode 100755 index 4ddd7a57c..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/relationship_types.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "relationship_types" : { } -}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/resources_definition_types.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/resources_definition_types.json deleted file mode 100755 index 96e9269ce..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/resources_definition_types.json +++ /dev/null @@ -1,283 +0,0 @@ -{ - "image_name" : { - "tags" : "image_name", - "name" : "image_name", - "property" : { - "description" : "image_name", - "type" : "string" - }, - "updated-by" : "Singal, Kapil <ks220y@att.com>", - "sources" : { - "input" : { - "type" : "source-input" - }, - "sdnc" : { - "type" : "source-rest", - "properties" : { - "type" : "JSON", - "url-path" : "config/GENERIC-RESOURCE-API:services/service/$service-instance-id/service-data/vnfs/vnf/$vnf-id/vnf-data/vnf-topology/vnf-parameters-data/param/image_name", - "path" : "/param/0/value", - "input-key-mapping" : { - "service-instance-id" : "service-instance-id", - "vnf-id" : "vnf-id" - }, - "output-key-mapping" : { - "image_name" : "value" - }, - "key-dependencies" : [ "service-instance-id", "vnf-id" ] - } - } - } - }, - "pub_key" : { - "tags" : "pub_key", - "name" : "pub_key", - "property" : { - "description" : "pub_key", - "type" : "string" - }, - "updated-by" : "MALAKOV, YURIY <yuriy.malakov@att.com>", - "sources" : { - "input" : { - "type" : "source-input" - }, - "default" : { - "type" : "source-default", - "properties" : { } - }, - "sdnc" : { - "type" : "source-rest", - "properties" : { - "type" : "JSON", - "url-path" : "config/GENERIC-RESOURCE-API:services/service/$service-instance-id/service-data/vnfs/vnf/$vnf-id/vnf-data/vnf-topology/vnf-parameters-data/param/pub_key", - "path" : "/param/0/value", - "input-key-mapping" : { - "service-instance-id" : "service-instance-id", - "vnf-id" : "vnf-id" - }, - "output-key-mapping" : { - "pub_key" : "value" - }, - "key-dependencies" : [ "service-instance-id", "vnf-id" ] - } - } - } - }, - "public_net_id" : { - "tags" : "public_net_id", - "name" : "public_net_id", - "property" : { - "description" : "public_net_id", - "type" : "string" - }, - "updated-by" : "MALAKOV, YURIY <yuriy.malakov@att.com>", - "sources" : { - "input" : { - "type" : "source-input" - }, - "default" : { - "type" : "source-default", - "properties" : { } - }, - "sdnc" : { - "type" : "source-rest", - "properties" : { - "type" : "JSON", - "url-path" : "config/GENERIC-RESOURCE-API:services/service/$service-instance-id/service-data/vnfs/vnf/$vnf-id/vnf-data/vnf-topology/vnf-parameters-data/param/public_net_id", - "path" : "/param/0/value", - "input-key-mapping" : { - "service-instance-id" : "service-instance-id", - "vnf-id" : "vnf-id" - }, - "output-key-mapping" : { - "public_net_id" : "value" - }, - "key-dependencies" : [ "service-instance-id", "vnf-id" ] - } - } - } - }, - "service-instance-id" : { - "tags" : "service-instance-id, tosca.datatypes.Root, data_type", - "name" : "service-instance-id", - "property" : { - "description" : "To be provided", - "type" : "string" - }, - "updated-by" : "Singal, Kapil <ks220y@att.com>", - "sources" : { - "input" : { - "type" : "source-input", - "properties" : { } - }, - "any-db" : { - "type" : "source-db", - "properties" : { - "query" : "SELECT artifact_name FROM BLUEPRINT_RUNTIME where artifact_version=\"1.0.0\"", - "input-key-mapping" : { }, - "output-key-mapping" : { - "service-instance-id" : "artifact_name" - } - } - }, - "processor-db" : { - "type" : "source-db", - "properties" : { - "query" : "SELECT artifact_name FROM BLUEPRINT_RUNTIME where artifact_version=\"1.0.0\"", - "input-key-mapping" : { }, - "output-key-mapping" : { - "service-instance-id" : "artifact_name" - } - } - }, - "capability" : { - "type" : "source-capability", - "properties" : { - "script-type" : "jython", - "script-class-reference" : "SampleRAProcessor", - "instance-dependencies" : [ ] - } - } - } - }, - "vlb_flavor_name" : { - "tags" : "vlb_flavor_name", - "name" : "vlb_flavor_name", - "property" : { - "description" : "vlb_flavor_name", - "type" : "string" - }, - "updated-by" : "MALAKOV, YURIY <yuriy.malakov@att.com>", - "sources" : { - "input" : { - "type" : "source-input" - }, - "default" : { - "type" : "source-default", - "properties" : { } - }, - "sdnc" : { - "type" : "source-rest", - "properties" : { - "type" : "JSON", - "url-path" : "config/GENERIC-RESOURCE-API:services/service/$service-instance-id/service-data/vnfs/vnf/$vnf-id/vnf-data/vnf-topology/vnf-parameters-data/param/vlb_flavor_name", - "path" : "/param/0/value", - "input-key-mapping" : { - "service-instance-id" : "service-instance-id", - "vnf-id" : "vnf-id" - }, - "output-key-mapping" : { - "vlb_flavor_name" : "value" - }, - "key-dependencies" : [ "service-instance-id", "vnf-id" ] - } - } - } - }, - "vnf-id" : { - "tags" : "vnf-id", - "name" : "vnf-id", - "property" : { - "description" : "vnf-id", - "type" : "string" - }, - "updated-by" : "MALAKOV, YURIY <yuriy.malakov@att.com>", - "sources" : { - "input" : { - "type" : "source-input" - }, - "default" : { - "type" : "source-default", - "properties" : { } - }, - "sdnc" : { - "type" : "source-rest", - "properties" : { - "type" : "JSON", - "url-path" : "config/GENERIC-RESOURCE-API:services/service/$service-instance-id/service-data/vnfs/vnf/$vnf-id/vnf-data/vnf-topology/vnf-parameters-data/param/vnf-id", - "path" : "/param/0/value", - "input-key-mapping" : { - "service-instance-id" : "service-instance-id", - "vnf-id" : "vnf-id" - }, - "output-key-mapping" : { - "vnf-id" : "value" - }, - "key-dependencies" : [ "service-instance-id", "vnf-id" ] - } - } - } - }, - "vf-module-id" : { - "name" : "vf-module-id", - "tags" : "vf-module-id", - "updated-by" : "Singal, Kapil <ks220y@att.com>", - "property" : { - "description" : "vf-module-id", - "type" : "string" - }, - "sources" : { - "input" : { - "type" : "source-input", - "properties" : { } - }, - "sdnc": { - "type": "source-rest", - "properties": { - "verb": "GET", - "type": "JSON", - "url-path": "/restconf/config/GENERIC-RESOURCE-API:services/service/$service-instance-id/service-data/vnfs/vnf/$vnf-id/vnf-data/vf-modules/vf-module/$vf-module-id", - "path": "/vf-module/0/vf-module-id", - "input-key-mapping": { - "service-instance-id": "service-instance-id", - "vnf-id": "vnf-id", - "vf-module-id": "vf-module.vf-module-id" - }, - "output-key-mapping": { - "vf-module-id": "vf-module-id" - }, - "key-dependencies": [ - "service-instance-id", - "vnf-id", - "vf-module.vf-module-id" - ] - } - } - } - }, - "vnf_name" : { - "tags" : "vnf_name", - "name" : "vnf_name", - "property" : { - "description" : "vnf_name", - "type" : "string" - }, - "updated-by" : "Singal, Kapil <ks220y@att.com>", - "sources" : { - "default" : { - "type" : "source-default", - "properties" : { } - }, - "input" : { - "type" : "source-input", - "properties" : { } - }, - "sdnc" : { - "type" : "source-rest", - "properties" : { - "type" : "JSON", - "url-path" : "config/GENERIC-RESOURCE-API:services/service/$service-instance-id/service-data/vnfs/vnf/$vnf-id/vnf-data/vnf-topology/vnf-parameters-data/param/vnf_name", - "path" : "/param/0/value", - "input-key-mapping" : { - "service-instance-id" : "service-instance-id", - "vnf-id" : "vnf-id" - }, - "output-key-mapping" : { - "vnf_name" : "value" - }, - "key-dependencies" : [ "service-instance-id", "vnf-id" ] - } - } - } - } -}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/ubuntuCDS.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/ubuntuCDS.json deleted file mode 100755 index 8933ce14b..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Definitions/ubuntuCDS.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "tosca_definitions_version": "ubuntuCDS_1_0_0", - "metadata": { - "template_author": "ONES", - "author-email": "rene.robert@orange.com", - "user-groups": "ADMIN, OPERATION", - "template_name": "ubuntuCDS", - "template_version": "1.0.0", - "template_tags": "ubuntuCDS" - }, - "imports": [ { - "file" : "Definitions/data_types.json" - }, { - "file" : "Definitions/relationship_types.json" - }, { - "file" : "Definitions/artifact_types.json" - }, { - "file" : "Definitions/node_types.json" - }, { - "file" : "Definitions/policy_types.json" - } ], - "dsl_definitions": {}, - "topology_template": { - "workflows": { - "resource-assignment": { - "steps": { - "resource-assignment": { - "description": "Resource Assign Workflow", - "target": "resource-assignment" - } - }, - "inputs": { - "template-prefix": { - "required": true, - "type": "list", - "entry_schema": { - "type": "string" - } - }, - "resource-assignment-properties": { - "description": "Dynamic PropertyDefinition for workflow(resource-assignment).", - "required": true, - "type": "dt-resource-assignment-properties" - } - }, - "outputs": { - "meshed-template": { - "type": "json", - "value": { - "get_attribute": [ - "resource-assignment", - "assignment-params" - ] - } - } - } - } - }, - "node_templates": { - "resource-assignment": { - "type": "component-resource-resolution", - "interfaces": { - "ResourceResolutionComponent": { - "operations": { - "process": { - "inputs": { - "artifact-prefix-names": { - "get_input": "template-prefix" - } - } - } - } - } - }, - "artifacts": { - "ubuntuCDS-template": { - "type": "artifact-template-velocity", - "file": "Templates/ubuntuCDS-template.vtl" - }, - "ubuntuCDS-mapping": { - "type": "artifact-mapping-resource", - "file": "Templates/ubuntuCDS-mapping.json" - }, - "base_ubuntuCDS-template": { - "type": "artifact-template-velocity", - "file": "Templates/base_ubuntuCDS-template.vtl" - }, - "base_ubuntuCDS-mapping": { - "type": "artifact-mapping-resource", - "file": "Templates/base_ubuntuCDS-mapping.json" - } - } - } - } - } - } diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/TOSCA-Metadata/TOSCA.meta b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/TOSCA-Metadata/TOSCA.meta deleted file mode 100755 index ed91e91cf..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/TOSCA-Metadata/TOSCA.meta +++ /dev/null @@ -1,6 +0,0 @@ -TOSCA-Meta-File-Version: 1.0.0 -CSAR-Version: 1.0 -Created-By: RG, ONES <romain.garel@orange.com> -Entry-Definitions: Definitions/ubuntuCDS.json -Template-Tags: ubuntuCDS -Content-Type: application/vnd.oasis.bpmn
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/base_ubuntuCDS-mapping.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/base_ubuntuCDS-mapping.json deleted file mode 100755 index 825f05add..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/base_ubuntuCDS-mapping.json +++ /dev/null @@ -1,185 +0,0 @@ -[
- {
- "name": "service-instance-id",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- },
- "default": ""
- },
- "input-param": false,
- "dictionary-name": "service-instance-id",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "vnf-id",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- },
- "default": ""
- },
- "input-param": false,
- "dictionary-name": "vnf-id",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "vf-module-id",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "vf-module-id",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "vnf_id",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- },
- "default": "ubuntuCDS_VNF"
- },
- "input-param": false,
- "dictionary-name": "vnf-id",
- "dictionary-source": "sdnc",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "ubuntuCDS_image_name",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "image_name",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "ubuntuCDS_flavor_name",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "vlb_flavor_name",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "ubuntuCDS_pub_key",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "pub_key",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "ubuntuCDS_name_0",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "vnf_name",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "admin_plane_net_name",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "public_net_id",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- }
-]
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/base_ubuntuCDS-template.vtl b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/base_ubuntuCDS-template.vtl deleted file mode 100755 index bfbe352d6..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/base_ubuntuCDS-template.vtl +++ /dev/null @@ -1,69 +0,0 @@ -{
- "resource-accumulator-resolved-data": [
- {
- "param-name": "service-instance-id",
- "param-value": "${service-instance-id}"
- },
- {
- "param-name": "vnf-id",
- "param-value": "${vnf-id}"
- },
- {
- "param-name": "vf_module_id",
- "param-value": "${vf-module-id}"
- },
- {
- "param-name": "vnf_id",
- "param-value": "${vnf-id}"
- },
- {
- "param-name": "vnf_name",
- "param-value": "${vnf_name}"
- },
- {
- "param-name": "vf_module_name",
- "param-value": "${vf_module_name}"
- },
- {
- "param-name": "ubuntuCDS_pub_key",
- "param-value": "${ubuntuCDS_pub_key}"
- },
- {
- "param-name": "ubuntuCDS_image_name",
- "param-value": "${ubuntuCDS_image_name}"
- },
- {
- "param-name": "ubuntuCDS_flavor_name",
- "param-value": "${ubuntuCDS_flavor_name}"
- },
- {
- "param-name": "ubuntuCDS_name_0",
- "param-value": "${ubuntuCDS_name_0}"
- },
- {
- "param-name": "admin_plane_net_name",
- "param-value": "${admin_plane_net_name}"
- }
- ],
- "capability-data": [
- {
- "capability-name": "aai-vf-module-put",
- "key-mapping": [
- {
- "payload": [
- {
- "param-name": "vf-module",
- "param-value": "vf-module"
- }
- ],
- "output-key-mapping": [
- {
- "resource-name": "aai-vf-module-put",
- "resource-value": "${status}"
- }
- ]
- }
- ]
- }
- ]
-}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/ubuntuCDS-mapping.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/ubuntuCDS-mapping.json deleted file mode 100755 index f0b2308bb..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/ubuntuCDS-mapping.json +++ /dev/null @@ -1,65 +0,0 @@ -[ - { - "name": "service-instance-id", - "property": { - "description": "", - "required": false, - "type": "string", - "status": "", - "constraints": [ - {} - ], - "entry_schema": { - "type": "" - }, - "default": "" - }, - "input-param": false, - "dictionary-name": "service-instance-id", - "dictionary-source": "input", - "dependencies": [], - "version": 0 - }, - { - "name": "vnf-id", - "property": { - "description": "", - "required": false, - "type": "string", - "status": "", - "constraints": [ - {} - ], - "entry_schema": { - "type": "" - }, - "default": "" - }, - "input-param": false, - "dictionary-name": "vnf-id", - "dictionary-source": "input", - "dependencies": [], - "version": 0 - }, - { - "name": "vnf_name", - "property": { - "description": "", - "required": false, - "type": "string", - "status": "", - "constraints": [ - {} - ], - "entry_schema": { - "type": "" - }, - "default": "ubuntuCDS-VNF-name" - }, - "input-param": false, - "dictionary-name": "vnf_name", - "dictionary-source": "input", - "dependencies": [], - "version": 0 - } -]
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/ubuntuCDS-template.vtl b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/ubuntuCDS-template.vtl deleted file mode 100755 index 209d78023..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/Templates/ubuntuCDS-template.vtl +++ /dev/null @@ -1,37 +0,0 @@ -{ - "resource-accumulator-resolved-data": [ - { - "param-name": "service-instance-id", - "param-value": "${service-instance-id}" - }, - { - "param-name": "vnf_id", - "param-value": "${vnf-id}" - }, - { - "param-name": "vnf_name", - "param-value": "${vnf_name}" - } - ], - "capability-data": [ - { - "capability-name": "aai-vnf-put", - "key-mapping": [ - { - "payload": [ - { - "param-name": "generic-vnf", - "param-value": "generic-vnf" - } - ], - "output-key-mapping": [ - { - "resource-name": "aai-vnf-put", - "resource-value": "${status}" - } - ] - } - ] - } - ] -}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/cba-ubuntuCDS-enriched.zip b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/cba-ubuntuCDS-enriched.zip Binary files differdeleted file mode 100755 index bb9ce8a42..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-after-enrichment/cba-ubuntuCDS-enriched.zip +++ /dev/null diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Definitions/ubuntuCDS.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Definitions/ubuntuCDS.json deleted file mode 100755 index 4859b8167..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Definitions/ubuntuCDS.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "tosca_definitions_version": "ubuntuCDS_1_0_0", - "metadata": { - "template_author": "ONES", - "author-email": "rene.robert@orange.com", - "user-groups": "ADMIN, OPERATION", - "template_name": "ubuntuCDS", - "template_version": "1.0.0", - "template_tags": "ubuntuCDS" - }, - "imports": [], - "dsl_definitions": {}, - "topology_template": { - "workflows": { - "resource-assignment": { - "steps": { - "resource-assignment": { - "description": "Resource Assign Workflow", - "target": "resource-assignment" - } - }, - "inputs": { - "template-prefix": { - "required": true, - "type": "list", - "entry_schema": { - "type": "string" - } - }, - "resource-assignment-properties": { - "description": "Dynamic PropertyDefinition for workflow(resource-assignment).", - "required": true, - "type": "dt-resource-assignment-properties" - } - }, - "outputs": { - "meshed-template": { - "type": "json", - "value": { - "get_attribute": [ - "resource-assignment", - "assignment-params" - ] - } - } - } - } - }, - "node_templates": { - "resource-assignment": { - "type": "component-resource-resolution", - "interfaces": { - "ResourceResolutionComponent": { - "operations": { - "process": { - "inputs": { - "artifact-prefix-names": { - "get_input": "template-prefix" - } - } - } - } - } - }, - "artifacts": { - "ubuntuCDS-template": { - "type": "artifact-template-velocity", - "file": "Templates/ubuntuCDS-template.vtl" - }, - "ubuntuCDS-mapping": { - "type": "artifact-mapping-resource", - "file": "Templates/ubuntuCDS-mapping.json" - }, - "base_ubuntuCDS-template": { - "type": "artifact-template-velocity", - "file": "Templates/base_ubuntuCDS-template.vtl" - }, - "base_ubuntuCDS-mapping": { - "type": "artifact-mapping-resource", - "file": "Templates/base_ubuntuCDS-mapping.json" - } - } - } - } - } - } diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/TOSCA-Metadata/TOSCA.meta b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/TOSCA-Metadata/TOSCA.meta deleted file mode 100755 index ed91e91cf..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/TOSCA-Metadata/TOSCA.meta +++ /dev/null @@ -1,6 +0,0 @@ -TOSCA-Meta-File-Version: 1.0.0 -CSAR-Version: 1.0 -Created-By: RG, ONES <romain.garel@orange.com> -Entry-Definitions: Definitions/ubuntuCDS.json -Template-Tags: ubuntuCDS -Content-Type: application/vnd.oasis.bpmn
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/base_ubuntuCDS-mapping.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/base_ubuntuCDS-mapping.json deleted file mode 100755 index 825f05add..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/base_ubuntuCDS-mapping.json +++ /dev/null @@ -1,185 +0,0 @@ -[
- {
- "name": "service-instance-id",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- },
- "default": ""
- },
- "input-param": false,
- "dictionary-name": "service-instance-id",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "vnf-id",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- },
- "default": ""
- },
- "input-param": false,
- "dictionary-name": "vnf-id",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "vf-module-id",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "vf-module-id",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "vnf_id",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- },
- "default": "ubuntuCDS_VNF"
- },
- "input-param": false,
- "dictionary-name": "vnf-id",
- "dictionary-source": "sdnc",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "ubuntuCDS_image_name",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "image_name",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "ubuntuCDS_flavor_name",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "vlb_flavor_name",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "ubuntuCDS_pub_key",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "pub_key",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "ubuntuCDS_name_0",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "vnf_name",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- },
- {
- "name": "admin_plane_net_name",
- "property": {
- "description": "",
- "required": false,
- "type": "string",
- "status": "",
- "constraints": [
- {}
- ],
- "entry_schema": {
- "type": ""
- }
- },
- "input-param": false,
- "dictionary-name": "public_net_id",
- "dictionary-source": "input",
- "dependencies": [],
- "version": 0
- }
-]
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/base_ubuntuCDS-template.vtl b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/base_ubuntuCDS-template.vtl deleted file mode 100755 index bfbe352d6..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/base_ubuntuCDS-template.vtl +++ /dev/null @@ -1,69 +0,0 @@ -{
- "resource-accumulator-resolved-data": [
- {
- "param-name": "service-instance-id",
- "param-value": "${service-instance-id}"
- },
- {
- "param-name": "vnf-id",
- "param-value": "${vnf-id}"
- },
- {
- "param-name": "vf_module_id",
- "param-value": "${vf-module-id}"
- },
- {
- "param-name": "vnf_id",
- "param-value": "${vnf-id}"
- },
- {
- "param-name": "vnf_name",
- "param-value": "${vnf_name}"
- },
- {
- "param-name": "vf_module_name",
- "param-value": "${vf_module_name}"
- },
- {
- "param-name": "ubuntuCDS_pub_key",
- "param-value": "${ubuntuCDS_pub_key}"
- },
- {
- "param-name": "ubuntuCDS_image_name",
- "param-value": "${ubuntuCDS_image_name}"
- },
- {
- "param-name": "ubuntuCDS_flavor_name",
- "param-value": "${ubuntuCDS_flavor_name}"
- },
- {
- "param-name": "ubuntuCDS_name_0",
- "param-value": "${ubuntuCDS_name_0}"
- },
- {
- "param-name": "admin_plane_net_name",
- "param-value": "${admin_plane_net_name}"
- }
- ],
- "capability-data": [
- {
- "capability-name": "aai-vf-module-put",
- "key-mapping": [
- {
- "payload": [
- {
- "param-name": "vf-module",
- "param-value": "vf-module"
- }
- ],
- "output-key-mapping": [
- {
- "resource-name": "aai-vf-module-put",
- "resource-value": "${status}"
- }
- ]
- }
- ]
- }
- ]
-}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/ubuntuCDS-mapping.json b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/ubuntuCDS-mapping.json deleted file mode 100755 index f0b2308bb..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/ubuntuCDS-mapping.json +++ /dev/null @@ -1,65 +0,0 @@ -[ - { - "name": "service-instance-id", - "property": { - "description": "", - "required": false, - "type": "string", - "status": "", - "constraints": [ - {} - ], - "entry_schema": { - "type": "" - }, - "default": "" - }, - "input-param": false, - "dictionary-name": "service-instance-id", - "dictionary-source": "input", - "dependencies": [], - "version": 0 - }, - { - "name": "vnf-id", - "property": { - "description": "", - "required": false, - "type": "string", - "status": "", - "constraints": [ - {} - ], - "entry_schema": { - "type": "" - }, - "default": "" - }, - "input-param": false, - "dictionary-name": "vnf-id", - "dictionary-source": "input", - "dependencies": [], - "version": 0 - }, - { - "name": "vnf_name", - "property": { - "description": "", - "required": false, - "type": "string", - "status": "", - "constraints": [ - {} - ], - "entry_schema": { - "type": "" - }, - "default": "ubuntuCDS-VNF-name" - }, - "input-param": false, - "dictionary-name": "vnf_name", - "dictionary-source": "input", - "dependencies": [], - "version": 0 - } -]
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/ubuntuCDS-template.vtl b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/ubuntuCDS-template.vtl deleted file mode 100755 index 209d78023..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/Templates/ubuntuCDS-template.vtl +++ /dev/null @@ -1,37 +0,0 @@ -{ - "resource-accumulator-resolved-data": [ - { - "param-name": "service-instance-id", - "param-value": "${service-instance-id}" - }, - { - "param-name": "vnf_id", - "param-value": "${vnf-id}" - }, - { - "param-name": "vnf_name", - "param-value": "${vnf_name}" - } - ], - "capability-data": [ - { - "capability-name": "aai-vnf-put", - "key-mapping": [ - { - "payload": [ - { - "param-name": "generic-vnf", - "param-value": "generic-vnf" - } - ], - "output-key-mapping": [ - { - "resource-name": "aai-vnf-put", - "resource-value": "${status}" - } - ] - } - ] - } - ] -}
\ No newline at end of file diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/cba-before-enrichment.zip b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/cba-before-enrichment.zip Binary files differdeleted file mode 100644 index 492e63bf1..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/cba-before-enrichment/cba-before-enrichment.zip +++ /dev/null diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/curls_resource_dictionary.txt b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/curls_resource_dictionary.txt deleted file mode 100644 index da04447fd..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/curls_resource_dictionary.txt +++ /dev/null @@ -1,50 +0,0 @@ - -HERE AFTER A REQUEST TO ADD RESOURCE IN CDS RESOURCE DICTIONARY -WE ADD a radius_test_user parameter with 3 methods to resolve that parameter: input, default, sdnc - - -curl -k 'https://cds-ui:30497/resourcedictionary/save' -X POST -H 'Content-type: application/json' \ --d '{ - "name": "radius_test_user", - "tags": "radius_test_user", - "data_type": "string", - "description": "radius_test_user", - "entry_schema": "string", - "updatedBy": "Seaudi, Abdelmuhaimen <abdelmuhaimen.seaudi@orange.com>", - "definition": { - "tags": "radius_test_user", - "name": "radius_test_user", - "property": { - "description": "radius_test_user", - "type": "string" - }, - "updated-by": "Seaudi, Abdelmuhaimen <abdelmuhaimen.seaudi@orange.com>", - "sources": { - "input": { - "type": "source-input" - }, - "default": { - "type": "source-default", - "properties": {} - }, - "sdnc": { - "type": "source-rest", - "properties": { - "verb": "GET", - "type": "JSON", - "url-path": "/restconf/config/GENERIC-RESOURCE-API:services/service/$service-instance-id/service-data/vnfs/vnf/$vnf-id/vnf-data/vnf-topology/vnf-parameters-data/param/radius_test_user", - "path": "/param/0/value", - "input-key-mapping": { - "service-instance-id": "service-instance-id", - "vnf-id": "vnf-id" - }, - "output-key-mapping": { - "radius_test_user": "value" - }, - "key-dependencies": ["service-instance-id", - "vnf-id"] - } - } - } - } -}' diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/base_ubuntuCDS.env b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/base_ubuntuCDS.env deleted file mode 100755 index b9e55fa7f..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/base_ubuntuCDS.env +++ /dev/null @@ -1,14 +0,0 @@ -parameters: -# Metadata required by ONAP - vnf_id: ubuntuCDS-VNF - vf_module_id: ubuntuCDS-VF-module - vnf_name: ubuntuCDS-VNF-name - -# Server parameters, naming required by ONAP - ubuntuCDS_image_name: ubuntu-18 - ubuntuCDS_flavor_name: onap.small - ubuntuCDS_pub_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDY15cdBmIs2XOpe4EiFCsaY6bmUmK/GysMoLl4UG51JCfJwvwoWCoA+6mDIbymZxhxq9IGxilp/yTA6WQ9s/5pBag1cUMJmFuda9PjOkXl04jgqh5tR6I+GZ97AvCg93KAECis5ubSqw1xOCj4utfEUtPoF1OuzqM/lE5mY4N6VKXn+fT7pCD6cifBEs6JHhVNvs5OLLp/tO8Pa3kKYQOdyS0xc3rh+t2lrzvKUSWGZbX+dLiFiEpjsUL3tDqzkEMNUn4pdv69OJuzWHCxRWPfdrY9Wg0j3mJesP29EBht+w+EC9/kBKq+1VKdmsXUXAcjEvjovVL8l1BrX3BY0R8D imported-openssh-key - ubuntuCDS_name_0: ubuntuCDS - -# Network parameters, naming required by ONAP - admin_plane_net_name: admin diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/base_ubuntuCDS.yaml b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/base_ubuntuCDS.yaml deleted file mode 100755 index ad250fa52..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/base_ubuntuCDS.yaml +++ /dev/null @@ -1,110 +0,0 @@ -heat_template_version: 2013-05-23 - -description: Heat template to deploy a ubuntuCDS VM - -parameters: - # Metadata required by ONAP - vnf_name: - type: string - label: VM name - description: The VM name - vnf_id: - type: string - label: VNF ID - description: The VNF ID is provided by ONAP - vf_module_id: - type: string - label: VF module ID - description: The VF Module ID is provided by ONAP - -# Server parameters, naming required by ONAP - ubuntuCDS_image_name: - type: string - label: Image name or ID - description: Image to be used for compute instance - ubuntuCDS_flavor_name: - type: string - label: Flavor - description: Type of instance (flavor) to be used - ubuntuCDS_pub_key: - type: string - label: Public key - description: Public key to be installed on the compute instance - ubuntuCDS_name_0: - type: string - label: VM name - description: The VM name - -# Network parameters, naming required by ONAP - admin_plane_net_name: - type: string - label: management network - description: The external management network - -resources: - random-str: - type: OS::Heat::RandomString - properties: - length: 4 - - ubuntuCDS_instantiated_key_name: - type: OS::Nova::KeyPair - properties: - name: - str_replace: - template: pre_base_rand - params: - pre: key_ - base: { get_param: vnf_name } - rand: { get_resource: random-str } - public_key: { get_param: ubuntuCDS_pub_key } - save_private_key: false - - ubuntuCDS_admin_security_group: - type: OS::Neutron::SecurityGroup - properties: - description: security group - name: - str_replace: - template: pre_base_rand - params: - pre: sg_ - base: { get_param: vnf_name } - rand: { get_resource: random-str } - rules: [ - {remote_ip_prefix: 0.0.0.0/0, protocol: tcp, port_range_min: 22, port_range_max: 22}, - {remote_ip_prefix: 0.0.0.0/0, protocol: icmp}] - - ubuntuCDS_0_admin_plane_port_0: - type: OS::Neutron::Port - properties: - name: - str_replace: - template: pre_base_rand - params: - pre: port_ - base: { get_param: vnf_name } - rand: { get_resource: random-str } - network: { get_param: admin_plane_net_name } - security_groups: [{ get_resource: ubuntuCDS_admin_security_group }] - - ubuntuCDS_VM_settings: - type: OS::Heat::SoftwareConfig - properties: - config: | - #!/bin/bash - sudo apt-get update - - ubuntuCDS_server_0: - type: OS::Nova::Server - properties: - image: { get_param: ubuntuCDS_image_name } - flavor: { get_param: ubuntuCDS_flavor_name } - name: { get_param: ubuntuCDS_name_0 } - metadata: {vnf_id: { get_param: vnf_id }, vf_module_id: { get_param: vf_module_id }, vnf_name: { get_param: vnf_name }} - key_name: { get_resource: ubuntuCDS_instantiated_key_name } - networks: - - port: { get_resource: ubuntuCDS_0_admin_plane_port_0 } - user_data_format: RAW - user_data: - get_resource: ubuntuCDS_VM_settings diff --git a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/ubuntuCDS_heat.zip b/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/ubuntuCDS_heat.zip Binary files differdeleted file mode 100755 index ad359bf32..000000000 --- a/docs/guides/onap-user/design/parameter_resolution/ubuntu_example/ubuntuCDS_heat/ubuntuCDS_heat.zip +++ /dev/null diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst deleted file mode 100644 index 8dc2af8a0..000000000 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_des_pre-onb: - -Pre-Onboarding -============== - - * `Generate Manifest and Package Artifacts`_ (for HEAT based VNFs) - * `Validate xNF Package (VNF/PNF)`_ - - -.. _doc_guide_user_des_pre-onb_gen-man: - -Generate Manifest and Package Artifacts ---------------------------------------- - -.. note:: - This section describes the steps required to package a given HEAT - template into a zip-file, which can be onboarded to SDC. Instructions - to create TOSCA based VNF or PNF Onboarding Packages are not described - here - -The for onboarding the zip-file requires besides the Heat template also a -MANIFEST.json file, which describes the content of the package. To generate a -MANIFEST.json file a script can be used offered by the SDC project: -`generate-manifest.py`_ - -These steps are performed outside SDC. - -**Prerequisites:** Obtain Heat/ENV files and other files required for -onboarding. The requirements are found in the following document: ONAP VNF -Requirements -> Heat Requirements. - -.. warning:: ONAP VNF Requirements (vnfrqts) are no longer maintained! - -#. Put the Heat, ENV, nested Heat, and other files used by get-file in templates - in a directory on a host, which supports python. - - Naming guidelines: - - - The base Heat should include "base" in the name. - - The ENV file name should match the name of the Heat file with which it - is associated. - - All get-file file names need to be unique. - -#. Put the python script in a directory one level above the directory that - contains the Heat/ENV and other files. - - For example, [dir x]/[dir y] - - - [dir y] contains the Heat/ENV files and other files - - [dir x] contains the python script - -#. Run the script via command line: - - .. code-block:: python - - python generate-manifest.py -f "dir y" - -#. Examine the manifest file and confirm that is correct. - -#. Package all Heat/ENV files, all other files, and the MANIFEST.json - into one .zip file. - -Example packages can be found in the SDC poject: `example-packages`_ - -.. _doc_guide_user_des_pre-onb_val: - -Validate xNF Package (VNF/PNF) ------------------------------- - -VNF and PNF packages have to follow the requirements described in "VNF and PNF -Modeling Requirements -> TOSCA Requirements" and "ONAP Management -Requirements". - -.. warning:: ONAP VNF Requirements (vnfrqts) are no longer maintained! - - -For Validation of VNF and PNF packages the tools delivered by VNFSDK can be -used. - -Prior to resource onboarding, the Certification Group does the following: - - - for VNF and PNF - - Validation of the delivered xNF package and artifacts - - using the VNF Validation Tools - - in case of VNF - - onboards the Heat template(s) and metadata to the SDC catalog - - creates a test VF - - runs the Heat scanning tools - - shares the results with any group that approves Virtual Functions - -In parallel, the Certification Group onboards the VF Image and OS to a -standalone ONAP instance (the "sandbox") and performs the following: - - - security scan - - compatibility test for the OS and vendor binary - - malware scan - -The Certification group then instantiates the VF image using the vendor -Heat (if provided) in order to validate that the VM can run on the Network -Cloud. - -No VF functionality testing is performed at this stage. - - -.. _generate-manifest.py: https://git.onap.org/sdc/tree/openecomp-be/tools/scripts/generate-manifest.py -.. _example-packages: https://git.onap.org/sdc/tree/integration-tests/src/test/resources/Files/VNFs diff --git a/docs/guides/onap-user/design/pre-onboarding/media/tenant.png b/docs/guides/onap-user/design/pre-onboarding/media/tenant.png Binary files differdeleted file mode 100644 index b5ae8c678..000000000 --- a/docs/guides/onap-user/design/pre-onboarding/media/tenant.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst deleted file mode 100644 index 4c31237d0..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/index.rst +++ /dev/null @@ -1,449 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019-2021 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_des_res-onb: - -Resource Onboarding -=================== -**Goal:** Add models and other artifacts required to create, configure, - instantiate, and manage a VF/PNF and, optionally, a VFC. - -**Tool:** SDC - -**SDC user role:** Designer - -|image0| - -**Steps** - * `Create a License Model [Optional]`_ - * `Create a License Key Group [Optional]`_ - * `Create an Entitlement Pool`_ - * `Create a Feature Group`_ - * `Create a License Agreement`_ - * `Create a Vendor Software Product`_ - * `Update VFCs in a VSP [optional]`_ - * `Update a VSP [optional]`_ - -After updating the artifacts in a VSP, also update: - * the VF/PNF created from the VSP - * any services that include the VF/PNF - -|image1| - -.. _doc_guide_user_des_res-onb_cre-lic: - -Create a License Model [Optional] ---------------------------------- - -VSPs optionally require a license and entitlements to enable the service -provider to track the usage. - -.. note:: - For interim saving while creating the license model and its components, click |image2| - -**Prerequisites:** To obtain license information, contact the service -provider's Supply Chain Management (SCM) group. - - -#. From the SDC HOME page, navigate to the ONBOARD Tab. - - |image11| - -#. In the Workspace select *CREATE NEW VLM*. - - |image12| - -#. Complete all fields. -#. Click *Create*. -#. After creation of the VLM, you should be presented with the “Overview” tab of the VLM. - - |image13| - - Select the following options in order: - - #. Create 0 or more license key groups (see - `Create a License Key Group [Optional]`_). - #. Create 1 or more entitlement pools (see `Create an Entitlement Pool`_). - #. Create 1 or more feature groups (see `Create a Feature Group`_). - #. Create 1 or more license agreements (see `Create a License Agreement`_). - - Note: Perform all steps above before submitting the license model to - the SDC catalog. - - |image14| - -#. Click *Submit* to add the license model to the catalog.After filling a comment, press *Commit&Submit*. - - |image15| - -#. After creating a license, complete `Create a Vendor Software Product`_ to - add the VSP required for the associated VF/PNF. - - -Create a License Key Group [Optional] -------------------------------------- - -If required by the resource model, create one or more license key groups; -otherwise the license key group is optional. - -**Prerequisites:** `Create a License Model [Optional]`_ - -#. Select the License Model in the Onboard section of the SDC. -#. In the Overview click the + inside the License Key Groups OR Navigate to License Key Groups and click on “+ ADD LICENSE KEY GROUP” - - |image4| - -#. Complete all fields (mandatory fields are marked by a red asterisk). -#. Click *Save*. - -Create an Entitlement Pool --------------------------- - -**Prerequisites:** If required by the resource model, create one or more -license key groups (see -`Create a License Key Group [Optional]`_). - -#. Select the License Model in the Onboard section of the SDC. -#. In the Overview click the + sign inside the Entitlement Pools OR Navigate to Entitlement Pools and click on “+ ADD ENTITLEMENT POOL” - - |image5| - -#. Complete required fields (mandatory fields are marked by a red asterisk). -#. Click *Save*. - -Create a Feature Group ----------------------- - -**Prerequisites:** Create one or more: - -* license key groups if required by the resource model - (see `Create a License Key Group [optional]`_) -* entitlement pools (see `Create an Entitlement Pool`_) - -#. Select the License Model in the Onboard section of the SDC. -#. In the Overview click the + sign inside the Feature Groups OR Navigate to Feature Groups and click on “+ ADD FEATURE GROUP” - - |image6| - -#. On the General tab, complete all fields. -#. Navigate to the *Entitlement Pools*. Tab - * In the Available Entitlement Pools, select one or more entitlement pools and click on the “>” sign. - * Selected pools should now be seen under the Selected Entitlements Pools. -#. Navigate to the *License Key Groups*. Tab - * In the Available License Key Groups, select one or more license key groups and click on the “>” sign. - * Selected pools should now be seen under the Selected License Key Groups. -#. Click *Save*. - -Create a License Agreement --------------------------- - -**Prerequisites:** Create one or more feature groups - (see `Create a Feature Group`_). - -#. Select the License Model in the Onboard section of the SDC. -#. In the Overview click the + sign inside the License Agreements OR Navigate to License Agreements and click on “+ Add FEATURE GROUP” - - |image7| - -#. On the General tab, complete required fields. -#. Click *Feature Groups*. -#. If not selected, click Available *Feature Groups*. - * Select one or more groups in the Available Feature Groups, select one or more feature groups and click on the “>” sign. - * Selected feature groups should now be seen under the Selected Feature Groups. -#. Click *Save*. -#. Return to step 6 of `Create a License Model [Optional]`_ to complete the license model. - -.. _doc_guide_user_des_res-onb_cre-vsp: - -Create a Vendor Software Product --------------------------------- - -Create one or more Vendor Software Products (VSPs) as the building blocks -for VFs/PNFs. - -.. note:: - For interim saving while creating a VSP, click |image2| - -**Prerequisites:** - -* `Create a License Model [Optional]`_ -* VNF HEAT package or VNF/PNF CSAR/Zip package is available. - - See :ref:`sdc_onboarding_package_types` for a description - of the onboarding package types. -* If the package is a secure package then :ref:`pre-install the corresponding Root Certificate in SDC <doc_guide_user_des_res-onb_pre-install_root_certificate>`. - -.. note:: - Example packages can be found in the SDC project: :ref:`SDC Packages<onap-sdc:sdc_onboarding_package_types>` - -#. From the SDC HOME page, click *ONBOARD*. - - |image11| - -#. In the Workspace select *CREATE NEW VSP*. - - |image21| - -#. Complete all fields. -#. Click *Create*. - The Overview page is shown - - |image22| - -#. Click *Internal* in the software product details section. - - .. note:: - Under License Agreement, there is a choice between internal or external license. - If internal is selected then after redirect to general tab, select licenses details. - If external is selected then in general tab licenses details are disabled. - -#. For the defined Vendor, select a licensing version, a license agreement, - and one or more feature groups. - - |image23| - -#. [Optional] Complete other fields, such as Availability (high-availability - zones) and Storage Data Replication (requirement for storage replication), - as required. -#. In the *Overview* section, select *Software Product Attachments* - (right pane), click *Select file*. -#. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*. - - In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package - and click *Open*. -#. The file is loaded and the attachments page opens - - |image24| - -#. Press the Button *Proceed to Validation*. After successful validation, SDC - displays the files and a success message. If validation fails, SDC displays - the errors in the files. - - In case the SDC Helm Validator is enabled in SDC configuration file and the - onboarding package is a CNF which contains any helm charts listed in MANIFEST.json - and marked as type=HELM, there will be an attempt to make a request to the Helm Validator - for each chart, to check its validity. More information on Helm Validator can be found - :ref:`here<onap-sdc:sdc_helm_validator>` - - This validation feature is enabled by default, and checks, if the chart can be deployed by - running helm template command. Helm v3 libraries are used for validation. - - Example Heat errors: - - |image9| - - Example helm chart validation warnings: - - |image27| - - Example helm chart validation errors (which caused the *Submit* button to be disabled) - - |image28| - -#. Click *Submit* to add the VSP to the catalog. - - After filling a comment, press *Commit&Submit*. -#. A success message is displayed. If the VSP attachments contain errors, an - error message is displayed instead. Fix the issue(s) and re-submit. -#. To configure VFCs associated with the VSP, see - `Update VFCs in a VSP [optional]`_, below. - - -.. _doc_guide_user_des_res-onb_upd-vfc: - -Update VFCs in a VSP [optional] -------------------------------- - -If required, configure Virtual Function Components (VFCs) associated with a -VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed -on the Components tab. - -.. note:: - All fields are optional. Answers to questionnaires are stored as metadata - only on the SDC platform. - -**Prerequisites:** Add one or more VSPs - (see `Create a Vendor Software Product`_). - -#. From the SDC HOME page, click *ONBOARD* and search for a VSP. -#. Selecting the VSP opens the *Versions* page. - - |image25| - -#. Press the + at *Create New Version* on the version to update - - |image26| - -#. Fill the fields and press *Create* -#. In Components , click a VFC (VSP component). - - The component links display in the left pane. -#. Click *General* to view and edit general parameters such as hypervisor, - image format, VM recovery details, and DNS configuration. -#. Click *Compute* to view and edit VM parameters such as the number of VMs - required for a VFC instance and persistent storage/volume size. -#. Click *High Availability & Load Balancing* to answer questions related - to VM availability and load balancing. -#. Click *Networks* to view or edit parameters related to network capacity - and interfaces. - - .. note:: - Click an interface to view or edit it. A dialog box displays similar - to the figure below. - - |image10| - -#. Click *Storage* to configure storage information, such as backup type, - storage size, and logging. -#. Click *Process Details*, click *Add Component Process Details*, and complete - the *Create New Process Details* dialog box. - - Use Process Details to identify - the processes and configuration associated with VFCs. -#. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling. -#. To update the VSP, click *Submit* - - After filling a comment, press *Commit&Submit* and the - new version is certified. - -.. _doc_guide_user_des_res-onb_upd-vsp: - -Update a VSP [optional] ------------------------ - -Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and service. - -**Prerequisites:** Add one or more VSPs - (see `Create a Vendor Software Product`_). - -#. From the SDC HOME page, click *ONBOARD* and search for a VSP. -#. Selecting the VSP opens the *Versions* page. - - |image25| - -#. Press the + at *Create New Version* on the version to update - - |image26| - -#. Fill the fields and press *Create* -#. In Software Product Attachments (right pane), click *Select file*. -#. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*. - - In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package - and click *Open*. - - SDC warns that uploading a new package erases existing data. -#. Click *Continue* to upload the new package. -#. The file is loaded and the attachments page opens - - |image24| - -#. Press the Button *Proceed to Validation*. After successful validation, SDC - displays the files and a success message. If validation fails, SDC displays - the errors in the files. - - In case the SDC Helm Validator is enabled in SDC configuration file and the - onboarding package is a CNF which contains any helm charts listed in MANIFEST.json - and marked as type=HELM, there will be an attempt to make a request to the Helm Validator - for each chart, to check its validity. More information on Helm Validator can be found - :ref:`here<onap-sdc:sdc_helm_validator>`. - - This validation feature is enabled by default, and checks, if the chart can be deployed by - running helm template command. Helm v3 libraries are used for validation. - - Example Heat errors: - - |image9| - - Example helm chart validation warnings: - - |image27| - - Example helm chart validation errors (which caused the *Submit* button to be disabled) - - |image28| - -#. Click *Submit* to add the new VSP version to the catalog. - After filling a comment, press *Commit&Submit* and the - new version is certified. -#. After updating the VSP: - - #. Upload the VSP to the Vf/PNF - (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`). - #. Update the VF/PNF version in services that include the VF/PNF (see step 4 - in :ref:`doc_guide_user_des_ser-des`). - -.. _doc_guide_user_des_res-onb_pre-install_root_certificate: - -Pre-Install Root Certificate in SDC [only needed for secure package] --------------------------------------------------------------------- -SDC supports the onboarding of packages that are secured according to security option 2 in ETSI NFV-SOL 004v2.6.1. - -During onboarding, SDC will validate the authenticity and integrity of a secure package. To enable this validation, -the root certificate corresponding to the certificate included in the package needs to be available to SDC. -This is currently done by uploading the root certificate to the following default directory location:: - - /dockerdata-nfs/{{ .Release.Name }}/sdc/onbaording/cert - -.. note:: - The directory listed above is mapped to the following directory in the onboarding pod (sdc-onboarding-be) - :: - - /var/lib/jetty/cert - - so it is also possible to copy the root certificate directly to this directory in the pod. - -The location where the root certificate is uploaded is configurable. The relevant parameters are described in -the *cert* block in the following values file:: - - <path_to_oom_kubernetes>/sdc/charts/sdc-onboarding-be/values.yaml - - -.. |image0| image:: media/sdro-resource-onboarding-workflow.png - -.. |image1| image:: media/sdro-vsp-service-workflow.png - -.. |image2| image:: media/sdro-sdc_vsp_save.png - -.. |image3| image:: media/sdro-license-creation.png - -.. |image4| image:: media/sdro-license-keygroup.png - -.. |image5| image:: media/sdro-entitlement-pool.png - -.. |image6| image:: media/sdro-feature-group.png - -.. |image7| image:: media/sdro-license-agreement.png - -.. |image8| image:: media/sdro-software-product.png - -.. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png - -.. |image10| image:: media/sdro-edit-nic.png - -.. |image11| image:: media/sdro-new-vlm.png - -.. |image12| image:: media/sdro-new-vlm-dialog.png - -.. |image13| image:: media/sdro-new-vlm-overview.png - -.. |image14| image:: media/sdro-license-model.png - -.. |image15| image:: media/sdro-license-model-submit.png - -.. |image21| image:: media/sdro-new-vsp.png - -.. |image22| image:: media/sdro-new-vsp-overview.png - -.. |image23| image:: media/sdro-new-vsp-general.png - -.. |image24| image:: media/sdro-new-vsp-attachments.png - -.. |image25| image:: media/sdro-vsp-version.png - -.. |image26| image:: media/sdro-vsp-version-dialog.png - -.. |image27| image:: media/sdro-design-onboardcnf-helm-validator-warnings.png - -.. |image28| image:: media/sdro-design-onboardcnf-helm-validator-errors.png diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-errors.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-errors.png Binary files differdeleted file mode 100644 index 15f59e6fa..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-errors.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-warnings.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-warnings.png Binary files differdeleted file mode 100644 index a3518ba49..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-warnings.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png Binary files differdeleted file mode 100644 index 27c8986e5..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png Binary files differdeleted file mode 100644 index 9429683b0..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png Binary files differdeleted file mode 100644 index 28d361b45..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png Binary files differdeleted file mode 100644 index 6633693d1..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png Binary files differdeleted file mode 100644 index fcc194d49..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png Binary files differdeleted file mode 100644 index a1cd74d5c..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-creation.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-creation.png Binary files differdeleted file mode 100644 index a358d03a4..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-creation.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png Binary files differdeleted file mode 100644 index 557e403b5..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model-submit.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model-submit.png Binary files differdeleted file mode 100644 index 382fca684..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model-submit.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model.png Binary files differdeleted file mode 100644 index cbc5a0e8a..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-dialog.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-dialog.png Binary files differdeleted file mode 100644 index 91a1cf041..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-dialog.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-overview.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-overview.png Binary files differdeleted file mode 100644 index 09dba66b7..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-overview.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm.png Binary files differdeleted file mode 100644 index 141f7b2dd..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-attachments.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-attachments.png Binary files differdeleted file mode 100644 index ae986acf8..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-attachments.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-general.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-general.png Binary files differdeleted file mode 100644 index 11bc97862..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-general.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-overview.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-overview.png Binary files differdeleted file mode 100644 index 0cb512c8d..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-overview.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp.png Binary files differdeleted file mode 100644 index 04841577c..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png Binary files differdeleted file mode 100644 index 123cd6a4a..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-sdc_vsp_save.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-sdc_vsp_save.png Binary files differdeleted file mode 100644 index 81f1df634..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-sdc_vsp_save.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-software-product.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-software-product.png Binary files differdeleted file mode 100644 index 457baa8cf..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-software-product.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png Binary files differdeleted file mode 100644 index 7528c8a44..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version-dialog.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version-dialog.png Binary files differdeleted file mode 100644 index be2901016..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version-dialog.png +++ /dev/null diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version.png Binary files differdeleted file mode 100644 index e73ddf151..000000000 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/index.rst b/docs/guides/onap-user/design/service-design/index.rst deleted file mode 100644 index 47fb614f0..000000000 --- a/docs/guides/onap-user/design/service-design/index.rst +++ /dev/null @@ -1,350 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_des_ser-des: - -Service Design -============== - -**Goal:** Add models and other artifacts required to create, configure, -instantiate, and manage services. Validate and certify the services. -Besides the manual creation of a Service Model, an existing model can -be imported via a CSAR file - -**Tool:** SDC - -**SDC user roles:** Designer - -|image1| - -**Figure: Workflow for Service design** - -**Steps** - - #. `Create Service`_ - #. `Create a Management Workflow [optional]`_ - #. `Create a Network Callflow [optional]`_ - #. `Manage Service Properties [optional]`_ - #. `Update Service [optional]`_ - #. `Certify Service`_ - #. `Import Service CSAR [optional]`_ - -.. _doc_guide_user_des_ser-cre_serv: - -Create Service --------------- - -**Prerequisites:** Create VF/PNFs required for this service (see :ref:`doc_guide_user_des_vf-cre`). - -#. From the SDC HOME page, hover over Add and select *ADD SERVICE*. - - |image0| - -#. In the General section, complete all fields. - - |image5| - -#. Click Create. - - A message displays when Service creation is complete. - -#. Click Composition in the left pane. - - |image6| - - For a description of the Composition section (see SDC User Guide ). - -#. Drag one or more elements from the Elements palette to the canvas. -#. To connect elements: - - #. Hover over an element and then hover over \ |image2|. - - Other elements that can connect to this element are highlighted. - - #. Drag to a highlighted element on the canvas. - #. Select options for Requirements and Capabilities. - #. Click on Finish. - -#. To add artifacts at the service level: - - #. Click an empty area in the canvas and click *Deployment Artifacts* - (right pane). - #. Click \ |image3|. - #. Select the type. - #. Click Browse, locate a file to upload, and click Open. - #. Complete all other fields. - #. Click Done. - - Use this function to add YANG artifacts for distribution to SDNC. - -#. [Optional] At any time before checking in the Service, click - these options to update Service information: - - .. note:: These tasks can be done only before certifying the Service. - - - **General->Icon** change the icon associated with the Service - - **TOSCA Artifacts** view and edit artifacts, such as the .csar file - and TOSCA template - - **Composition** view or edit the graphical representation of the - service-level TOSCA model - - **Activity Log** view activity related to the Service - (displays the action, date, user, status, and any comments related to each - action) - - **Management Workflow** model service lifecycle workflows for execution - in SO (see `Create a Management Workflow [optional]`_) - - **Network Call Flow** model interactions among VFs (see - `Create a Network Callflow [optional]`_) - - **Deployment** view HEAT modules in VSPs - - **Properties Assignment** define or update properties, - policies and input parameters used during Service instantiation. - - **Monitoring** ... - -#. Click *Check In* to save changes. - - A box displays for confirming the changes. - -#. Enter a comment and click OK. - - A message displays when the Service is checked in and the - Home page is displayed. - -#. After creating a service and configuring optional fields, certify it - (see `Certify Service`_). - -Note: Create Service can also be invoked via External SDC API. -Refer SDC REST API reference for details of the API. -Currently, only a 'Partner Domain Service' category is supported -which cannot be created manually from SDC portal. - -.. _doc_guide_user_des_ser-cre_wf: - -Create a Management Workflow [optional] ---------------------------------------- - -Create a workflow to model the SO recipes of the service life cycle such -as instantiation, upgrade, termination, or suspension of a service or -VNF. In the workflow each of the Activity, represent API calls to -various ONAP components (such as OOF, SDN-C, App-C, etc) that perform a -business function needed. - -Note: The information collected in this section is represented in BPMN -format and included in distributed service model. - -**Prerequisites:** All the required ActivitySpec as supported by SO - are registered in SDC. - -#. From the SDC HOME page, click CATALOG and search for a service. -#. Click the service and click *Check Out*. -#. Select the panel *Management Workflow*. -#. Click *Add Workflow*. -#. The *Create New Workflow* box displays. -#. Complete all fields. -#. Click Save. - - |image7| - -#. Specify Inputs & Outputs of Workflow -#. Define the Composition of Workflow. - - #. All the Tasks in the composition are expected to be ServiceTask - for using Activities defined in SO. - #. Select the Implementation in the Task "general" tab to Activity. - #. Select the required ActivitySpec. - -#. Mark the workflow as executable by selecting the Executable flag in - the workflow "general" tab. -#. Click Save. -#. Certify the Workflow. - -.. _doc_guide_user_des_ser-cre_nfw: - -Create a Network Callflow [optional] ------------------------------------- - -Create a network callflow to model the interactions among VFs within a -service, such how VFs interact to deliver a service while the service is -being consumed. In the model, lifelines represent VFs. - -Note: The information collected in this section is not distributed with -the service model. - -**Prerequisites:** `Create service`_ - -#. From the SDC HOME page, click CATALOG and search for the service. -#. Click the service and click *Check Out*. -#. Click Network Call Flow. -#. Click Add Workflow. - The Create New Workflow box displays. -#. Complete all fields. -#. Click Save. -#. In the new workflow pane, click the Lifelines icon. - - The LIFELINES/STEPS view displays. - -#. To add a lifeline (component), do the following: - - #. Click LIFELINES to expand the pane. - #. Click Add Lifeline. - #. In the [Unnamed Lifeline field], enter a name for the lifeline. - #. To add other lifelines to the workflow, repeat the actions above. - -#. After creating all required lifelines, do the following to add a step - (showing an action between two lifelines): - - #. Under STEPS (left pane), click Add Message. - An unnamed step is added under STEPS. - #. In the [Unnamed Message] field, enter a name or message for the - step. - #. From the component and arrow dropdown lists, select the two - components that communicate in this step, and the arrow to show in - which direction the communication flows. - #. To add another step, repeat the actions above. - -#. [Optional] Change the order of steps by clicking a step and dragging - it to the preferred position. -#. Click *Save*. You will be redirected to the Network Call Flow page. -#. Go to the General tab and click on *Check In* to save changes. -#. If needed, certify the service again (see `Certify Service`_). - -.. _doc_guide_user_des_ser-para_in: - -Manage Service Properties [optional] ------------------------------------- - -Add new Service parameters and define as input fields -during Service instantiation. - - -**Prerequisites:** `Create service`_ - -#. From the SDC HOME page, click CATALOG and search for a service. -#. Click the service and click *Check Out*. -#. Click *Properties Assignment*. - - |image8| - -#. From the *Composition* pane, select the *SELF* object - representing the service. -#. In the *Properties* the existing Service properites are shown -#. With *+Add Property* you can add a new property -#. To set a property as *Input* parameter, select the parameter - by clicking the check box in each row as required. - Note: Do not select inputs that are already in the ENV file (this - overwrites values specified in the ENV). - - |image9| - -#. Click *Declare Input* to add the selected parameter to the - Service *Input* pane. -#. Click *Check In* to save changes. -#. After adding Service Inputs, certify it (see `Certify Service`_). - -.. _doc_guide_user_des_ser-upd_serv: - -Update Service [optional] -------------------------- - -Update service information and artifacts. - -Update the version of a VF referenced in the service whenever the VF is -updated (see step 4). - -**Prerequisites:** - -- Create a service. -- If a VF included in the service was updated: - see :ref:`doc_guide_user_des_vf-cre_vf-upd` - -#. From the SDC HOME page, click CATALOG and search for the service. -#. Click the service and click *Check Out*. -#. Click Composition. -#. To update the version of a VF referenced in the service: - - #. Click Composition. - #. Click the VF in the canvas. - #. On the *General Info* tab (right pane), select the VF version. - -#. To update artifacts at the service level: - - #. Click an empty area in the canvas and click *Deployment Artifacts* - (right pane). - #. View, add, delete, or download artifacts as required. - -#. [Optional] Add, edit, or remove VFs that comprise the service - reference architecture (see steps 4 to 6 in \ `Create Service`_). -#. [Optional] Click *Operations* to edit Service Operations. - - #. Create/Edit Operations - #. Assign Workflow - #. Click Save - -#. [Optional] Click *Management Workflow* to edit, upload, or delete - associated deployment artifacts - (see `Create a Management Workflow [optional]`_). -#. [Optional] Click *Network Callflow* to edit the interactions among VFs - that comprise the service (see `Create a Network Callflow [optional]`_). -#. [Optional] Click *Properties Assignement* to select parameters as - input fields during Service instantiation. -#. Click *Check In* to save changes. -#. After updating a service and configuring optional fields, certify it - (see `Certify Service`_). - -.. _doc_guide_user_des_ser-cfy_serv: - -Certify Service ---------------- - -Note: A service cannot be submitted for testing if the reference -architecture contains uncertified resources. - -**Prerequisites:** `Create Service`_ - -**Steps** - -#. When a Service is ready for certification, - click *CATALOG* and search for the checked-in Service. -#. Click the Service and click *Certify*. - -#. Enter a comment and click *OK*. - -#. A Message appears, that the Service is certified. - - -Import Service CSAR [optional] ------------------------------- - -Note: This step can be used, when a Service Model already exists - -**Steps** - -#. From the SDC HOME page, hover over IMPORT and select *IMPORT SERVICE CSAR*. - - |image0| - -#. In the File Upload Dialog, select the csar file and press *Open*. - - |image10| - -#. In the General section, complete all fields. - - |image11| - -#. Click Create. - - A message displays when Service creation is complete. - -#. Continue with Service Design steps mentioned above - -.. |image0| image:: media/sdc-home.png -.. |image1| image:: media/sdc-service-workflow.png -.. |image2| image:: media/design_asdccanvas_connect_elements.png -.. |image3| image:: media/design_service_adddeploymentartifact.png -.. |image4| image:: media/design_service_inputs_move.png -.. |image5| image:: media/sdc-service-general.png -.. |image6| image:: media/sdc-service-composition.png -.. |image7| image:: media/sdc-service-workflow.png -.. |image8| image:: media/sdc-service-properties.png -.. |image9| image:: media/sdc-service-properties-input.png -.. |image10| image:: media/sdc-service-import.png -.. |image11| image:: media/sdc-service-general-import.png diff --git a/docs/guides/onap-user/design/service-design/media/design_asdccanvas_connect_elements.png b/docs/guides/onap-user/design/service-design/media/design_asdccanvas_connect_elements.png Binary files differdeleted file mode 100644 index 27c8986e5..000000000 --- a/docs/guides/onap-user/design/service-design/media/design_asdccanvas_connect_elements.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/design_service_adddeploymentartifact.png b/docs/guides/onap-user/design/service-design/media/design_service_adddeploymentartifact.png Binary files differdeleted file mode 100644 index 364a5ce01..000000000 --- a/docs/guides/onap-user/design/service-design/media/design_service_adddeploymentartifact.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/design_service_inputs_move.png b/docs/guides/onap-user/design/service-design/media/design_service_inputs_move.png Binary files differdeleted file mode 100644 index c4dcff760..000000000 --- a/docs/guides/onap-user/design/service-design/media/design_service_inputs_move.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/design_service_workflow.png b/docs/guides/onap-user/design/service-design/media/design_service_workflow.png Binary files differdeleted file mode 100644 index fbe4fa20d..000000000 --- a/docs/guides/onap-user/design/service-design/media/design_service_workflow.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-home.png b/docs/guides/onap-user/design/service-design/media/sdc-home.png Binary files differdeleted file mode 100644 index 201383e98..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-home.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-composition.png b/docs/guides/onap-user/design/service-design/media/sdc-service-composition.png Binary files differdeleted file mode 100644 index 4ac0d490c..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-composition.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-general-import.png b/docs/guides/onap-user/design/service-design/media/sdc-service-general-import.png Binary files differdeleted file mode 100644 index f050ff596..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-general-import.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-general.png b/docs/guides/onap-user/design/service-design/media/sdc-service-general.png Binary files differdeleted file mode 100644 index 4bb65d71e..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-general.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-import.png b/docs/guides/onap-user/design/service-design/media/sdc-service-import.png Binary files differdeleted file mode 100644 index bf0c8c196..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-import.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-properties-input.png b/docs/guides/onap-user/design/service-design/media/sdc-service-properties-input.png Binary files differdeleted file mode 100644 index 2296fd350..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-properties-input.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-properties.png b/docs/guides/onap-user/design/service-design/media/sdc-service-properties.png Binary files differdeleted file mode 100644 index 0dc111eac..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-properties.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png b/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png Binary files differdeleted file mode 100644 index 35ba6615b..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-workflow.png b/docs/guides/onap-user/design/service-design/media/sdc-service-workflow.png Binary files differdeleted file mode 100644 index 7caf98122..000000000 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-workflow.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-distribution/index.rst b/docs/guides/onap-user/design/service-distribution/index.rst deleted file mode 100644 index 9f374cdee..000000000 --- a/docs/guides/onap-user/design/service-distribution/index.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_des_ser-dis: - -Service Distribution -==================== - -Each ONAP platform operator will have a specific set of policies -and procedures for approving Services and deploying them in the -operator's ONAP environment. This outline describes the general -flow of such procedures. - -**Goal:** Add all information required to create, instantiate, and -manage a service in Runtime. - -**Tools:** SDC - -**SDC user roles:** Designer - - -|image1| - -**Figure: Workflow for Service Distribution** - -Steps ------ - -- `Distribute Service`_ -- `Monitor Distribution`_ - -.. _doc_guide_user_des_ser-dis-start: - -Distribute Service ------------------- - -**Prerequisites:** The Service is Certified. - -**Steps** - - -#. Sign in to SDC as Designer. -#. From the SDC HOME page, click CATALOG and search for the service. - It should read *Waiting For Distribution*. -#. Select the service that is *Ready for Distribution*. - - |image2| - -#. Review the version history to verify that the correct version is - selected. -#. In the header, click *Distribute*. - - The service state changes to *Distributed* -#. Continue with the step `Monitor Distribution`_ - - -.. _doc_guide_user_des_ser-dis-mon: - -Monitor Distribution --------------------- - -**Steps** - -#. Sign in to SDC as Designer. -#. From the SDC HOME page, click CATALOG and search for the service. -#. Select the service that is in *Distributed* state. -#. Click *Distribution* in the left pane. - The Distribution Report displays. - - |image3| - -#. In the Distribution Report, navigate to the Distribution ID for the - service and click the adjacent down arrow. - The report shows all components associated with the service and their - distribution statuses. -#. Review the status of each component. -#. If deploy errors are shown, the reason has to be investigated and the - Service can be *Redistributed* - - -.. |image1| image:: media/sdc-service-distribution-workflow.png -.. |image2| image:: media/sdc-service-distribute.png -.. |image3| image:: media/sdc-service-distribute-monitor.png diff --git a/docs/guides/onap-user/design/service-distribution/media/design_governance_workflow.png b/docs/guides/onap-user/design/service-distribution/media/design_governance_workflow.png Binary files differdeleted file mode 100644 index 44d6b702f..000000000 --- a/docs/guides/onap-user/design/service-distribution/media/design_governance_workflow.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribute-monitor.png b/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribute-monitor.png Binary files differdeleted file mode 100644 index 85c717f26..000000000 --- a/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribute-monitor.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribute.png b/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribute.png Binary files differdeleted file mode 100644 index d87385030..000000000 --- a/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribute.png +++ /dev/null diff --git a/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribution-workflow.png b/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribution-workflow.png Binary files differdeleted file mode 100644 index 4222f8548..000000000 --- a/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribution-workflow.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst deleted file mode 100644 index 59df89f3a..000000000 --- a/docs/guides/onap-user/design/vfcreation/index.rst +++ /dev/null @@ -1,233 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Doc Team. All rights reserved. - -.. _doc_guide_user_des_vf-cre: - -VF/PNF Creation and Testing -=========================== -**Goal**: Using VSPs, create one or more VFs/PNFs as the building blocks for a -service. Validate and certify the VFs/PNFs. - -**ONAP Component**: SDC - -**SDC user roles**: Designer - -|image1| - -Steps ------ - -- `Create a VF/PNF by VSP import`_ -- `Create a VF/PNF manually`_ -- `Update a VF/PNF [optional]`_ -- `Certify VF/PNF`_ - -.. _doc_guide_user_des_vf-cre_cre-imp: - -Create a VF/PNF by VSP import ------------------------------ - -**Prerequisites:** (see :ref:`doc_guide_user_des_res-onb` ) - -- Create a license for each VF/PNF -- Create a Vendor Software Product. - -**Steps** - -#. From the SDC HOME page, hover over *Import*, then click on *IMPORT VSP* - - |image2| - -#. From the *Import VSP* box, expand a VSP name and click the *Import VSP* icon. - - |image3| - -#. In the General section, complete all fields. - - |image10| - -#. Click *Create*. - - - A message displays while creation is in progress. (This can take up to - 10 minutes.) - - A message displays when creation is complete. - - -#. [Optional] At any time before checking in the VF/PNF, click - these options to update VF/PNF information: - - .. note:: These tasks can be done only before certifying the VF/PNF. - - - **General->Icon** change the icon associated with the VF/PNF - (vendor-supplied icons are preferred) - - **Deployment Artifacts** download, view, modify, or change deployment - artifacts (for example, the contents of the Heat .zip file, which contains - the Heat volume template, the license, CDS Blueprints,...) - - **Information Artifacts** view or upload artifacts, such as test - scripts, test results, or the AIC questionnaire - - **TOSCA Artifacts** view or upload the TOSCA model or the TOSCA template - - **Composition** view or edit the graphical representation of the resource-level - TOSCA model (generated from the Heat template) - - **Activity Log** view activity related to assets associated with the VF/PNF - (displays the action, date, user, status, and any comments related to each - action) - - **Deployment** view VF modules defined in the Heat template - - **Properties Assignment** define or update properties and input parameters - and policies - - **Req.& Capabilities** view and add requirements and capabilities - -#. Click *Check In* to save changes. - - - A box to enter comments for confirming the changes open. - -#. Enter a comment and click *OK*. - - - A message displays when the VF/PNF is checked in and you are redirected - to the Home screen. -#. After creating and checking a VF/PNF, certify it (see `Certify VF/PNF`_). - -.. _doc_guide_user_des_vf-cre_cre-man: - -Create a VF/PNF manually ------------------------- - -**Steps** - -#. From the SDC HOME page, hover over *Add*, then click on *ADD VF* or *ADD PNF*. - - |image2| - -#. In the General section, complete all fields. - -#. Click *Create*. - - - A message displays while creation is in progress. (This can take up to - 10 minutes.) - - A message displays when creation is complete. - -#. Before check-in the VF/PNF, click these - options to update VF/PNF information: - - .. note:: These tasks can be done only before certifying the VF/PNF. - - - **General->Icon** change the icon associated with the VF/PNF - (vendor-supplied icons are preferred) - - **Deployment Artifacts** download, view, modify, or change deployment - artifacts (for example, the contents of the Heat .zip file, which contains - the Heat volume template, the license, CDS Blueprints,...) - - **Information Artifacts** view or upload artifacts, such as test - scripts, test results, or the AIC questionnaire - - **TOSCA Artifacts** view or upload the TOSCA model or the TOSCA template - - **Composition** view or edit the graphical representation of the resource-level - TOSCA model (generated from the Heat template) - - **Activity Log** view activity related to assets associated with the VF/PNF - (displays the action, date, user, status, and any comments related to each - action) - - **Deployment** view VF modules defined in the Heat template - - **Properties Assignment** define or update properties and input parameters - and policies - - **Req.& Capabilities** view and add requirements and capabilities - -#. Click *Check In* to save changes. - - - A box to enter comments for confirming the changes open. - -#. Enter a comment and click *OK*. - - - A message displays when the VF/PNF is checked in and you are redirected - to the Home screen. -#. After creating and checking a VF/PNF, certify it (see `Certify VF/PNF`_). - - -.. _doc_guide_user_des_vf-cre_vf-upd: - -Update a VF/PNF [optional] --------------------------- - -- Update the VSP and other artifacts in a VF/PNF. -- Upload a new version the VSP to the VF/PNF whenever the VSP is updated - (see steps 3 to 5). -- Other reasons for updating a VF/PNF include: - - - artifact changes at the VF/PNF level that need be uploaded, for example, - changes to ENV values (see step 6) - -**Prerequisites:** - -- `Create a VF/PNF by VSP import`_ or `Create a VF/PNF manually`_ -- If the VSP was updated: :ref:`doc_guide_user_des_res-onb_upd-vsp` - -**Steps** - -#. From the SDC HOME page, click *CATALOG* and search for the VF/PNF, click on selected VF/PNF to update. - -#. In the General section, click *Check Out*. - The *VSP* field is displays. - -#. In the *VSP* field, click *Browse*. - The *Import VSP* box displays and shows the VSP that was used to create the VF/PNF. - -#. Expand the VSP field and click. - - |image4| - -#. Click *Update VSP* - A progress bar displays. - |image5| - -#. Click *Deployment Artifact* to edit, upload, or delete associated [Optional] - deployment artifacts. - -#. Click *Information Artifact* and edit, upload, or delete associated - [Optional] information artifacts. - -#. Click *Check In* to save changes. - - - A box to enter comments for confirming the changes open. - -#. Enter a comment and click *OK*. - - - A message displays when the VF/PNF is checked in and you are redirected - to the Home screen. -#. After updating the VF/PNF: - - - Certify it (see `Certify VF/PNF`_). - - Update the VF/PNF version in any service that contains the VF/PNF, - please go to :ref:`doc_guide_user_des_ser-upd_serv` - -.. _doc_guide_user_des_vf-cre_sub-tst: - -Certify VF/PNF --------------- - -**Prerequisites:** `Create a VF/PNF by VSP import`_ or -`Create a VF/PNF manually`_ - -**Steps** - -#. When a VF/PNF is ready for certification, - On the SDC HOME page, click *CATALOG* and search for the checked-in VF/PNF. - Bottom half of the VN/PNF will say “In Design Check In”. - -#. Click the VF/PNF and click *Certify*. - - |image7| - - |image8| - -#. Enter a comment and click *OK*. - -#. A Message appears, that the VF/PNF is certified. - - -.. |image1| image:: media/sdc-vf-workflow.png -.. |image2| image:: media/sdc-home.png -.. |image3| image:: media/sdc-Import.png -.. |image4| image:: media/sdc-vsp-update.png -.. |image5| image:: media/sdc_artifact_update.png -.. |image6| image:: media/design_vf_updatevspmessage.png -.. |image7| image:: media/sdc-vf-general-certify.png -.. |image8| image:: media/sdc-vf-certify-confirm.png -.. |image9| image:: media/SDC-Add.png -.. |image10| image:: media/sdc-vf-general.png diff --git a/docs/guides/onap-user/design/vfcreation/media/SDC-Add.png b/docs/guides/onap-user/design/vfcreation/media/SDC-Add.png Binary files differdeleted file mode 100644 index b4178c0ec..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/SDC-Add.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/design_vf_updatevspmessage.png b/docs/guides/onap-user/design/vfcreation/media/design_vf_updatevspmessage.png Binary files differdeleted file mode 100644 index bf401daac..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/design_vf_updatevspmessage.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png b/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png Binary files differdeleted file mode 100644 index d57365f51..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-13-30.png b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-13-30.png Binary files differdeleted file mode 100644 index 7bf32d4fc..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-13-30.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-14-3.png b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-14-3.png Binary files differdeleted file mode 100644 index 5a8d190a8..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-14-3.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-17-18.png b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-17-18.png Binary files differdeleted file mode 100644 index d12ca8fec..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-17-18.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-20-13.png b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-20-13.png Binary files differdeleted file mode 100644 index 82392a742..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-20-13.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-21-4.png b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-21-4.png Binary files differdeleted file mode 100644 index 594664344..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-21-4.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc-Import.png b/docs/guides/onap-user/design/vfcreation/media/sdc-Import.png Binary files differdeleted file mode 100644 index e253f2963..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/sdc-Import.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc-home.png b/docs/guides/onap-user/design/vfcreation/media/sdc-home.png Binary files differdeleted file mode 100644 index 201383e98..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/sdc-home.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc-vf-certify-confirm.png b/docs/guides/onap-user/design/vfcreation/media/sdc-vf-certify-confirm.png Binary files differdeleted file mode 100644 index 73ba1d277..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/sdc-vf-certify-confirm.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc-vf-general-certify.png b/docs/guides/onap-user/design/vfcreation/media/sdc-vf-general-certify.png Binary files differdeleted file mode 100644 index cf87faba9..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/sdc-vf-general-certify.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc-vf-general.png b/docs/guides/onap-user/design/vfcreation/media/sdc-vf-general.png Binary files differdeleted file mode 100644 index efd6d7d3e..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/sdc-vf-general.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc-vf-workflow.png b/docs/guides/onap-user/design/vfcreation/media/sdc-vf-workflow.png Binary files differdeleted file mode 100644 index a11f2d23c..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/sdc-vf-workflow.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc-vsp-update.png b/docs/guides/onap-user/design/vfcreation/media/sdc-vsp-update.png Binary files differdeleted file mode 100644 index 22caa0ad5..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/sdc-vsp-update.png +++ /dev/null diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc_artifact_update.png b/docs/guides/onap-user/design/vfcreation/media/sdc_artifact_update.png Binary files differdeleted file mode 100644 index 266d965f8..000000000 --- a/docs/guides/onap-user/design/vfcreation/media/sdc_artifact_update.png +++ /dev/null diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst deleted file mode 100644 index 60bdf283d..000000000 --- a/docs/guides/onap-user/index.rst +++ /dev/null @@ -1,39 +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. - -.. index:: User Guides - -.. _user-guides: - -User Guides -=========== -The following guides are provided to describe tasks that a user of -ONAP may need to perform when integrating, deploying, testing and operating -an instance of ONAP. - -.. note:: The ONAP Portal component is no longer maintained. E2E guides - referencing the ONAP Portal had to be removed consequently. - -E2E User Guides ---------------- - -.. toctree:: - :maxdepth: 1 - - design/index.rst - instantiate/index.rst - -Component User Guides ---------------------- - -For ONAP components please review the individual -document sets in :ref:`doc_onap-developer_guide_projects` - -Verified Use Cases ------------------- -In the following page you find all use cases and functional requirements -which have been officially verified in the actual release by the ONAP -community. - -* :doc:`Verified Use Cases<onap-integration:docs_usecases_release>` diff --git a/docs/guides/onap-user/instantiate/index.rst b/docs/guides/onap-user/instantiate/index.rst deleted file mode 100644 index d9bc3c7fb..000000000 --- a/docs/guides/onap-user/instantiate/index.rst +++ /dev/null @@ -1,20 +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. - - -Instantiate Service, PNF, VNF, Network -====================================== -The following guides are provided to describe tasks that a user of -ONAP may need to perform when instantiating a service. - -Instantiation includes the following topics: - -.. toctree:: - :maxdepth: 1 - - Pre-instantiation operations <./pre_instantiation/index.rst> - - Instantiation operation(s) <./instantiation/index.rst> - - Instantiation via Use-Case UI portal <./instantiation/uui/index.rst> diff --git a/docs/guides/onap-user/instantiate/instantiation/index.rst b/docs/guides/onap-user/instantiate/instantiation/index.rst deleted file mode 100644 index 9bfb6b6b3..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -Declare PNF instances: - -.. toctree:: - :maxdepth: 1 - - Declare PNF instances <./pnf_instance/index.rst> - -Instantiate a Service - -.. toctree:: - :maxdepth: 1 - - Instantiate a Service <./service_instance/index.rst> - -Instantiate a VNF: - -.. toctree:: - :maxdepth: 1 - - Instantiate a VNF <./vnf_instance/index.rst> - -Instantiate a Virtual Link: - -.. toctree:: - :maxdepth: 1 - - Instantiate a Virtual Link <./virtual_link_instance/index.rst> diff --git a/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst b/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst deleted file mode 100644 index 8c6e14d5d..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_ser_inst_nbi: - - -Service Instantiation via ONAP NBI API (TM Forum) -================================================= - -.. warning:: The ONAP :strong:`externalapi` project is :strong:`unmaintained`. - -ONAP NBI allow you to use a TM Forum standardized API (serviceOrder API). - -.. Additional info in: -.. -.. .. t o c t r e e : : -.. :maxdepth: 1 -.. :titlesonly: -.. -.. :ref:`NBI Guide<onap-externalapi-nbi:offeredapis>` - - -ONAP NBI will convert that request to ONAP SO request. - - -ServiceOrder management in NBI will support 2 modes: - -* E2E integration - NBI calls SO API to perform an End-To-end integration -* Service-level only integration - NBI will trigger only SO request at - serviceInstance level (not at VNF, not at Vf-module level and nothing will - be created on cloud platform) - -ONAP SO prerequisite: SO must be able to find a BPMN to process service -fulfillment (integrate VNF, VNF activation in SDNC, VF module) - -The choice of the mode is done by NBI depending on information retrieved -in SDC. If the serviceSpecification is within a Category "E2E Service" , -NBI will use E2E SO API, if not only API at service instance level -will be used. - -There is no difference or specific expectation in the service order API -used by NBI user. - - -Example of serviceOrder to instantiate (=add) a service based on model -with id=0d463b0c-e559-4def-8d7b-df64cfbd3159 - - -:: - - curl -X POST \ - http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/serviceOrder \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' \ - -d '{ - "externalId": "BSS_order_001", - "priority": "1", - "description": "this is a service order to instantiate a service", - "category": "Consumer", - "requestedStartDate": "", - "requestedCompletionDate": "", - "relatedParty": [ - { - "id": "JohnDoe", - "role": "ONAPcustomer", - "name": "JohnDoe" - } - ], - "orderItem": [ - { - "id": "1", - "action": "add", - "service": { - "name": "my_service_model_instance_01", - "serviceState": "active", - "serviceSpecification": { - "id": "0d463b0c-e559-4def-8d7b-df64cfbd3159" - } - } - } - ] - }' - -In the response, you will obtain the serviceOrderId value. - -Then you have the possibility to check about the serviceorder -(here after the serviceOrderId=5d06309da0e46400017b1123). - -This will allow you to get the serviceOrder Status (completed, failed...) - -:: - - curl -X GET \ - http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/serviceOrder/5d06309da0e46400017b1123 \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' diff --git a/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst deleted file mode 100644 index 765dd1f79..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - - -Declare PNF instances -===================== - -PNF instances can be declared in ONAP inventory (AAI) using REST API - - -An example: - -:: - - curl -X PUT \ - https://{{ONAP_LB_IP@}}:30233/aai/v16/network/pnfs/pnf/my_pnf_instance_001 \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Cache-Control: no-cache' \ - -H 'Content-Type: application/json' \ - -H 'Postman-Token: f5e2aae0-dc1c-4edb-b9e9-a93b05aee5e8' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 999' \ - -H 'depth: all' \ - -d '{ - "pnf-name":" my_pnf_instance_001", - "equip-type":" router", - "nf-role":"primary", - "p-interfaces": { - "p-interface": [ - { - "interface-name": "ae1", - "port-description": "Link aggregate for trunk between switches" - }, - { - "interface-name": "xe-0/0/6", - "port-description": "to PNF_instance_002 trunk1" - }, - { - "interface-name": "xe-0/0/2", - "port-description": "to PNF_instance_003 trunk1" - }, - { - "interface-name": "xe-0/0/10", - "port-description": "to PNF_instance_004 trunk1" - }, - { - "interface-name": "xe-0/0/0", - "port-description": "firewall trunk" - }, - { - "interface-name": "xe-0/0/14", - "port-description": "to PNF_instance_005 trunk1" - } - ] - } - }' -k - - -It is possible to declare the location where is deployed the PNF -(called a "complex" in ONAP AAI) - -:: - - curl -X PUT \ - https:// {{ONAP_LB_IP@}}:30233/aai/v11/cloud-infrastructure/complexes/complex/my_complex_name \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Cache-Control: no-cache' \ - -H 'Content-Type: application/json' \ - -H 'Postman-Token: 43523984-db01-449a-8a58-8888871110bc' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 999' \ - -H 'depth: all' \ - -d '{ - "physical-location-type":"PoP", - "physical-location-id":"my_complex_name", - "complex-name":"Name of my Complex", - "city":"LANNION", - "postal-code":"22300", - "country":"FRANCE", - "street1":"Avenue Pierre Marzin", - "region":"Europe" - }' -k - - - -To indicate that a PNF instance is located in a complex, we create a relation - -:: - - curl -X PUT \ - https:// {{ONAP_LB_IP@}}:30233/aai/v14/network/pnfs/pnf/my_pnf_instance_001/relationship-list/relationship \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Cache-Control: no-cache' \ - -H 'Content-Type: application/json' \ - -H 'Postman-Token: 15315304-17c5-4e64-aada-bb149f1af915' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 999' \ - -H 'depth: all' \ - -d '{ - "related-to": "complex", - "related-link": "/aai/v11/cloud-infrastructure/complexes/complex/my_complex_name" - }' -k diff --git a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst deleted file mode 100644 index 4e8dcab86..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -Service Instantiation -===================== - -**Pre-requisites** - -- The Service has been designed and distributed (see: :ref:`Service Design <doc_guide_user_des_ser-des>`) -- pre-instantiation operations have been performed - (see: :ref:`pre instantiation section <doc_guide_user_pre_ser-inst>`) - -**Possible Tools to perform Service Instantiation** - -- **via a Graphical User Interface tool** - using ONAP applications such as **ONAP VID** and **ONAP UUI** tools - -- **via any tool able to perform REST API requests** - (for example : Robot Framework, Postman, Curl...) connected - to **ONAP SO** legacy API or **ONAP extAPI/NBI** standard TMF641 API - to add/delete Service. - -**Possible methods with ONAP to instantiate a Service** - -- **A La Carte** - method requires the user to build and send - operations **for each object** to instantiate : Service, VNFs, - VFModules and Networks (in other words : once you have instantiated - the Service object, you still have to instantiate the various VNFs - or Networks that compose your Service). - To build those requests, the user needs to define/collect by himself - all necessary parameters/values. - -- **Macro** - method allows the user to build and send - **only one request to instantiate all objects** : Service, VNFs, - VFModules and Networks. Thanks to templates (see CDS Blueprint in - Design section), - ONAP will collect and assign all required parameters/values by itself. - - -.. Note:: - VID supports the "macro" flow orchestration in a ModernUI, which can be enabled by the system operator. - - **Macro** method is not (yet) available via extAPI/NBI. - -With "A La Carte" method ------------------------- - -.. toctree:: - :maxdepth: 1 - - using ONAP VID Portal <../vid1/index.rst> - using ONAP NBI REST API (TM Forum) <../nbi/index.rst> - using ONAP SO REST API <../so1/index.rst> - -With "Macro" method -------------------- - -.. toctree:: - :maxdepth: 1 - - using ONAP VID Portal <../vid2/index.rst> - using ONAP SO REST API <../so2/index.rst> diff --git a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst b/docs/guides/onap-user/instantiate/instantiation/so1/index.rst deleted file mode 100644 index af2edc8c9..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst +++ /dev/null @@ -1,465 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_ser_inst_so1: - - -A La Carte mode Service Instantiation via ONAP SO API -===================================================== - -Using ONAP SO API in "A La Carte" mode, the user needs to send -a request to instantiate the service object but also for each VNF/VF-module -and network that compose the Service. - -ONAP will instantiate resources on Cloud platforms only when user is requesting -to instantiate VF-module or Network (openstack neutron or contrail). - -To instantiate a VF-module, it is required to have instantiated a VNF object. - -To instantiate a VNF object, it is required to have instantiated -a Service object. - -To instantiate a Network object, it is required to have instantiated -a Service object. - -**Requests** - * `Request to instantiate Service object`_ - * `Request to instantiate VNF object`_ - * `Requests to instantiate VF-module object`_ - * `Requests to instantiate Neutron Network object`_ - * `Requests to instantiate a Contrail Network object`_ - - -Request to instantiate Service object -------------------------------------- - -Example to request a service instance directly to ONAP SO - -:: - - curl -X POST \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \ - -H 'Content-Type: application/json' \ - -H 'X-ONAP-PartnerName: NBI' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "requestInfo": { - "instanceName": "integration_test_service_instance_001", - "source": "VID", - "suppressRollback": false, - "requestorId": "demo" - }, - "modelInfo": { - "modelType": "service", - "modelInvariantId": "48d7ceec-7975-406c-8b96-cb3fbdbcfa33", - "modelVersionId": "33a99ef7-b5a3-4603-b21e-790582b4567e", - "modelName": "integration_test_service_ubuntu16", - "modelVersion": "1.0" - }, - "cloudConfiguration": { - "tenantId": "dd8fce79e74a4989a6be6b6c5e55acef", - "cloudOwner": "cloudOwner", - "lcpCloudRegionId": "RegionOne" - }, - "requestParameters": { - "userParams": [], - "testApi": "VNF_API", - "subscriptionServiceType": "integration_test_service_ubuntu16", - "aLaCarte": true - }, - "subscriberInfo": { - "globalSubscriberId": "integration_test_customer" - }, - "project": { - "projectName": "integration_test_project" - }, - "owningEntity": { - "owningEntityId": "8874891f-5120-4b98-b452-46284513958d", - "owningEntityName": "OE-Generic" - } - } - }' - - -In the response, you will obtain the serviceOrderId value. - -Then you have the possibility to check about the SO request -(here after the requestId=e3ad8df6-ea0d-4384-be95-bcb7dd39bbde). - -This will allow you to get the serviceOrder Status (completed, failed...) - -:: - - curl -X GET \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/orchestrationRequests/v6/e3ad8df6-ea0d-4384-be95-bcb7dd39bbde \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: get_aai_subscr' \ - -H 'cache-control: no-cache' - - -Request to instantiate VNF object ---------------------------------- - -To instantiate a VNF, you need to build an other request. -All necessary parameters are available in the Tosca service template -generated by SDC when you defined your service model. - -:: - - curl -X POST \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances/7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722/vnfs \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \ - -H 'Content-Type: application/json' \ - -H 'X-ONAP-PartnerName: NBI' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "requestInfo": { - "instanceName": "integration_test_vnf_instance_002", - "source": "VID", - "suppressRollback": false, - "requestorId": "test", - "productFamilyId": "1234" - }, - "modelInfo": { - "modelType": "vnf", - "modelInvariantId": "661a34ce-6f76-4ebf-ad94-814a9fc8a2aa", - "modelVersionId": "7e7d453c-0085-4df2-b4b5-91281ea2e710", - "modelName": "integration_test_VF_ubuntu16_2", - "modelVersion": "1.0", - "modelCustomizationId": "342c14b4-8a24-46dd-a8c3-ff39dd7949e9", - "modelCustomizationName": "integration_test_VF_ubuntu16_2 0" - }, - "requestParameters": { - "userParams": [], - "aLaCarte": true, - "testApi": "VNF_API" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "RegionOne", - "cloudOwner": "cloudOwner", - "tenantId": "dd8fce79e74a4989a6be6b6c5e55acef" - }, - "lineOfBusiness": { - "lineOfBusinessName": "integration_test_LOB" - }, - "platform": { - "platformName": "integration_test_platform" - }, - "relatedInstanceList": [{ - "relatedInstance": { - "instanceId": "7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722", - "modelInfo": { - "modelType": "service", - "modelName": "integration_test_service_ubuntu16", - "modelInvariantId": "48d7ceec-7975-406c-8b96-cb3fbdbcfa33", - "modelVersion": "1.0", - "modelVersionId": "33a99ef7-b5a3-4603-b21e-790582b4567e" - } - } - }] - } - } - - ' - - -Requests to instantiate VF-module object ----------------------------------------- - -To instantiate a VF module, you need to build two complex requests -All necessary parameters are available in the Tosca service template -generated by SDC when you defined your service model. - -1st request is called a "SDNC-preload" for a VNF object and is used -to store in SDNC some VNF parameters values -that will be needed for the instantiation - -:: - - curl -X POST \ - https://sdnc.api.simpledemo.onap.org:30267/restconf/operations/VNF-API:preload-vnf-topology-operation \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: API client' \ - -H 'X-TransactionId: 0a3f6713-ba96-4971-a6f8-c2da85a3176e' \ - -H 'cache-control: no-cache' \ - -d '{ - "input": { - "request-information": { - "notification-url": "onap.org", - "order-number": "1", - "order-version": "1", - "request-action": "PreloadVNFRequest", - "request-id": "test" - }, - "sdnc-request-header": { - "svc-action": "reserve", - "svc-notification-url": "http:\/\/onap.org:8080\/adapters\/rest\/SDNCNotify", - "svc-request-id": "test" - }, - "vnf-topology-information": { - "vnf-assignments": { - "availability-zones": [], - "vnf-networks": [], - "vnf-vms": [] - }, - "vnf-parameters": [], - "vnf-topology-identifier": { - "generic-vnf-name": "integration_test_vnf_instance_002", - "generic-vnf-type": "integration_test_VF_ubuntu16_2 0", - "service-type": "7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722", - "vnf-name": "integration_test_vfmodule_002", - "vnf-type": "IntegrationTestVfUbuntu162..base_ubuntu16..module-0" - } - } - } - }' - -The 2nd request is to instantiate the VF module via ONAP SO -(instance name must be identical in both requests) - -:: - - curl -X POST \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances/7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722/vnfs/9764c2af-e4b0-413d-80cd-b65014ea0926/vfModules \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \ - -H 'Content-Type: application/json' \ - -H 'X-ONAP-PartnerName: NBI' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "requestInfo": { - "instanceName": "integration_test_vfmodule_002", - "source": "VID", - "suppressRollback": false, - "requestorId": "test" - }, - "modelInfo": { - "modelType": "vfModule", - "modelInvariantId": "273bef63-1f26-4b14-91e0-003fa203ead2", - "modelVersionId": "7cdf75de-ff3c-4a7d-a7e0-ecbc00693e8e", - "modelName": "IntegrationTestVfUbuntu162..base_ubuntu16..module-0", - "modelVersion": "1", - "modelCustomizationId": "470956aa-b739-4cdd-b114-7ce032f65b18", - "modelCustomizationName": "IntegrationTestVfUbuntu162..base_ubuntu16..module-0" - }, - "requestParameters": { - "userParams": [], - "testApi": "VNF_API", - "usePreload": true - }, - "cloudConfiguration": { - "lcpCloudRegionId": "RegionOne", - "cloudOwner": "cloudOwner", - "tenantId": "dd8fce79e74a4989a6be6b6c5e55acef" - }, - "relatedInstanceList": [{ - "relatedInstance": { - "instanceId": "7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722", - "modelInfo": { - "modelType": "service", - "modelName": "integration_test_service_ubuntu16", - "modelInvariantId": "48d7ceec-7975-406c-8b96-cb3fbdbcfa33", - "modelVersion": "1.0", - "modelVersionId": "33a99ef7-b5a3-4603-b21e-790582b4567e" - } - } - }, - { - "relatedInstance": { - "instanceId": "9764c2af-e4b0-413d-80cd-b65014ea0926", - "modelInfo": { - "modelType": "vnf", - "modelName": "integration_test_VF_ubuntu16_2", - "modelInvariantId": "661a34ce-6f76-4ebf-ad94-814a9fc8a2aa", - "modelVersion": "1.0", - "modelVersionId": "7e7d453c-0085-4df2-b4b5-91281ea2e710", - "modelCustomizationId": "342c14b4-8a24-46dd-a8c3-ff39dd7949e9", - "modelCustomizationName": "integration_test_VF_ubuntu16_2 0" - } - } - }] - } - }' - - - -Requests to instantiate Neutron Network object ----------------------------------------------- - -To instantiate a Neutron Network, you need to build two complex request. -All necessary parameters are available in the Tosca service template -generated by SDC when you defined your service model. - - -1st request is the "SDNC-preload" for a neutron network object: - -:: - - curl -X POST \ - http://sdnc.api.simpledemo.onap.org:30202/restconf/operations/VNF-API:preload-network-topology-operation \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: API client' \ - -H 'X-TransactionId: 0a3f6713-ba96-4971-a6f8-c2da85a3176e' \ - -H 'cache-control: no-cache' \ - -d '{ - "input": { - "request-information": { - "request-id": "postman001", - "notification-url": "http://so.onap.org", - "order-number": "postman001", - "request-sub-action": "SUPP", - "request-action": "PreloadNetworkRequest", - "source": "postman", - "order-version": "1.0" - }, - "network-topology-information": { - "network-policy": [], - "route-table-reference": [], - "vpn-bindings": [], - "network-topology-identifier": { - "network-role": "integration_test_net", - "network-technology": "neutron", - "service-type": "my-service-2", - "network-name": "my_network_01", - "network-type": "Generic NeutronNet" - }, - "provider-network-information": { - "is-external-network": "false", - "is-provider-network": "false", - "is-shared-network": "false" - }, - "subnets": [ - { - "subnet-name": "my_subnet_01", - "subnet-role": "OAM", - "start-address": "192.168.90.0", - "cidr-mask": "24", - "ip-version": "4", - "dhcp-enabled": "Y", - "dhcp-start-address": "", - "dhcp-end-address": "", - "gateway-address": "192.168.90.1", - "host-routes":[] - } - ] - }, - "sdnc-request-header": { - "svc-action": "reserve", - "svc-notification-url": "http://so.onap.org", - "svc-request-id": "postman001" - } - } - }' - - -2nd request is to instantiate the neutron network via ONAP SO -(instance name must be identical in both requests) - - -:: - - curl -X POST \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/95762b50-0244-4723-8fde-35f911db9263/networks \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: get_aai_subscr' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "requestInfo": { - "instanceName": "my_network_01", - "source": "VID", - "suppressRollback": false, - "requestorId": "demo" - }, - "modelInfo": { - "modelType": "network", - "modelInvariantId": "0070b65c-48cb-4985-b4df-7c67ca99cd95", - "modelVersionId": "4f738bed-e804-4765-8d22-07bb4d11f14b", - "modelName": "Generic NeutronNet", - "modelVersion": "1.0", - "modelCustomizationId": "95534a95-dc8d-4ffb-89c7-091e2c49b55d", - "modelCustomizationName": "Generic NeutronNet 0" - }, - "requestParameters": { - "userParams": [], - "aLaCarte": true, - "testApi": "VNF_API" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "my_cloud_site", - "tenantId": "5906b9b8fd9642df9ba1c9e290063439" - }, - "lineOfBusiness": { - "lineOfBusinessName": "Test_LOB" - }, - "platform": { - "platformName": "Test_platform" - }, - "relatedInstanceList": [{ - "relatedInstance": { - "instanceId": "95762b50-0244-4723-8fde-35f911db9263", - "modelInfo": { - "modelType": "service", - "modelName": "my_service_model_name", - "modelInvariantId": "11265d8c-2cc2-40e5-95d8-57cad81c18da", - "modelVersion": "1.0", - "modelVersionId": "0d463b0c-e559-4def-8d7b-df64cfbd3159" - } - } - }] - } - }' - - -It is then possible to get information about that network from AAI: -replace {{virtual_link_UUID}} by the UUID of the virtual link - - -:: - - curl -X GET \ - https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/network/l3-networks/l3-network/{{virtual_link_UUID}} \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: get_aai_subscr' \ - -H 'cache-control: no-cache' - - -And also about subnet: - -:: - - curl -X GET \ - https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/network/l3-networks/l3-network/{{virtual_link_UUID}}/subnets \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: get_aai_subscr' \ - -H 'cache-control: no-cache' - - - -Requests to instantiate a Contrail Network object -------------------------------------------------- - -TO BE COMPLETED diff --git a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst b/docs/guides/onap-user/instantiate/instantiation/so2/index.rst deleted file mode 100644 index 9b1bbb351..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst +++ /dev/null @@ -1,193 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_ser_inst_so2: - - -Macro mode Service Instantiation via ONAP SO API -================================================ - -Using Macro mode, you have to build and send one and only one -request to ONAP SO. - -In that request you need to indicate all object instances -that you want to be instantiated. - -Reminder : ONAP SO in Macro mode will perform the VNF parameters/values -assignment based on CDS Blueprint templates -that are supposed to be defined during Design and Onboard steps. -That means ONAP should have all information -to be able to get all necessary values by itself (there is no longer need -for a user to provide those values via the "SDNC preload" operation). - -Additional info in: - -* CDS Documentation: :ref:`cds_main-doc` -* CDS vDNS Usecase Description in `Wiki <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin>`_ - -Request Example : - -:: - - curl -X POST \ - 'http://{{k8s}}:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances' \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "subscriberInfo": { - "globalSubscriberId": "Demonstration" - }, - "requestInfo": { - "suppressRollback": false, - "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb", - "requestorId": "adt", - "instanceName": "{{cds-instance-name}}", - "source": "VID" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "fr1", - "tenantId": "6270eaa820934710960682c506115453" - }, - "requestParameters": { - "subscriptionServiceType": "vFW", - "userParams": [ - { - "Homing_Solution": "none" - }, - { - "service": { - "instanceParams": [ - - ], - "instanceName": "{{cds-instance-name}}", - "resources": { - "vnfs": [ - { - "modelInfo": { - "modelName": "{{vnf-modelinfo-modelname}}", - "modelVersionId": "{{vnf-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-modelinfo-modelinvariantuuid}}", - "modelVersion": "1.0", - "modelCustomizationId": "{{vnf-modelinfo-modelcustomizationuuid}}", - "modelInstanceName": "{{vnf-modelinfo-modelinstancename}}" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "fr1", - "tenantId": "6270eaa820934710960682c506115453" - }, - "platform": { - "platformName": "test" - }, - "lineOfBusiness": { - "lineOfBusinessName": "someValue" - }, - "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb", - "instanceName": "{{vnf-modelinfo-modelinstancename}}", - "instanceParams": [ - { - "onap_private_net_id": "olc-private", - "onap_private_subnet_id": "olc-private", - "pub_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCwj7uJMyKiP1ogEsZv5kKDFw9mFNhxI+woR3Tuv8vjfNnqdB1GfSnvTFyNbdpyNdR8BlljkiZ1SlwJLEkvPk0HpOoSVVek/QmBeGC7mxyRcpMB2cNQwjXGfsVrforddXOnOkj+zx1aNdVGMc52Js3pex8B/L00H68kOcwP26BI1o77Uh+AxjOkIEGs+wlWNUmXabLDCH8l8IJk9mCTruKEN9KNj4NRZcaNC+XOz42SyHV9RT3N6efp31FqKzo8Ko63QirvKEEBSOAf9VlJ7mFMrGIGH37AP3JJfFYEHDdOA3N64ZpJLa39y25EWwGZNlWpO/GW5bNjTME04dl4eRyd", - "image_name": "Ubuntu 14.04", - "flavor_name":"s1.cw.small-1" - } - ], - "vfModules": [ - { - "modelInfo": { - "modelName": "{{vnf-vfmodule-0-modelinfo-modelname}}", - "modelVersionId": "{{vnf-vfmodule-0-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-vfmodule-0-modelinfo-modelinvariantuuid}}", - "modelVersion": "1", - "modelCustomizationId": "{{vnf-vfmodule-0-modelinfo-modelcustomizationuuid}}" - }, - "instanceName": "{{vnf-vfmodule-0-modelinfo-modelname}}", - "instanceParams": [ - { - "sec_group": "olc-open", - "public_net_id": "olc-net" - } - ] - }, - { - "modelInfo": { - "modelName": "{{vnf-vfmodule-1-modelinfo-modelname}}", - "modelVersionId": "{{vnf-vfmodule-1-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-vfmodule-1-modelinfo-modelinvariantuuid}}", - "modelVersion": "1", - "modelCustomizationId": "{{vnf-vfmodule-1-modelinfo-modelcustomizationuuid}}" - }, - "instanceName": "{{vnf-vfmodule-1-modelinfo-modelname}}", - "instanceParams": [ - { - "sec_group": "olc-open", - "public_net_id": "olc-net" - } - ] - }, - { - "modelInfo": { - "modelName": "{{vnf-vfmodule-2-modelinfo-modelname}}", - "modelVersionId": "{{vnf-vfmodule-2-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-vfmodule-2-modelinfo-modelinvariantuuid}}", - "modelVersion": "1", - "modelCustomizationId": "{{vnf-vfmodule-2-modelinfo-modelcustomizationuuid}}" - }, - "instanceName": "{{vnf-vfmodule-2-modelinfo-modelname}}", - "instanceParams": [ - { - "sec_group": "olc-open", - "public_net_id": "olc-net" - } - ] - }, - { - "modelInfo": { - "modelName": "{{vnf-vfmodule-3-modelinfo-modelname}}", - "modelVersionId": "{{vnf-vfmodule-3-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-vfmodule-3-modelinfo-modelinvariantuuid}}", - "modelVersion": "1", - "modelCustomizationId": "{{vnf-vfmodule-3-modelinfo-modelcustomizationuuid}}" - }, - "instanceName": "{{vnf-vfmodule-3-modelinfo-modelname}}", - "instanceParams": [ - { - "sec_group": "olc-open", - "public_net_id": "olc-net" - } - ] - } - ] - } - ] - }, - "modelInfo": { - "modelVersion": "1.0", - "modelVersionId": "{{service-uuid}}", - "modelInvariantId": "{{service-invariantUUID}}", - "modelName": "{{service-name}}", - "modelType": "service" - } - } - } - ], - "aLaCarte": false - }, - "project": { - "projectName": "Project-Demonstration" - }, - "owningEntity": { - "owningEntityId": "24ef5425-bec4-4fa3-ab03-c0ecf4eaac96", - "owningEntityName": "OE-Demonstration" - }, - "modelInfo": { - "modelVersion": "1.0", - "modelVersionId": "{{service-uuid}}", - "modelInvariantId": "{{service-invariantUUID}}", - "modelName": "{{service-name}}", - "modelType": "service" - } - } - }' diff --git a/docs/guides/onap-user/instantiate/instantiation/uui/index.rst b/docs/guides/onap-user/instantiate/instantiation/uui/index.rst deleted file mode 100644 index 70d825e70..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/uui/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -e2eServiceInstance mode via ONAP UUI Portal -=========================================== - - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -:ref:`usecase-ui docs platform installation user-guide<onap-usecase-ui:master_index>` diff --git a/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst deleted file mode 100644 index e3e4c5737..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -A La Carte mode Service Instantiation via ONAP VID Portal -========================================================= - -.. warning:: The ONAP :strong:`vid` project is :strong:`unmaintained`. diff --git a/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst deleted file mode 100644 index 2a1dbee4c..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -Macro mode Service Instantiation via ONAP VID Portal -==================================================== - -.. warning:: The ONAP :strong:`vid` project is :strong:`unmaintained`. diff --git a/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst deleted file mode 100644 index e12932a5d..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -Network Instantiation -===================== - -Note: in ONAP SDC, network object is called "virtual link" - -**Various possible methods are available with ONAP to instantiate a network** - -- With **A La Carte** - method, the user needs to build and send a Network instantiation - request. - - Note 1: prior to be able to send a request to instantiate - a Network, the user needs to instantiate a Service Object and then will - need to refer to that Service instance in the Network instantiate request. - - Note 2: the request to instantiate the Network object will update - ONAP AAI (inventory) and will send a request to the selected Cloud Platform - (Openstack, Azure, K8S...). - -- With **Macro** - method, the user do not need to send any - Network instantiation request. Network instantiation is being automatically - performed by ONAP when sending the request to instantiate the Service - (see: Instantiate Service). - -**Possible Tools to perform Network Instantiation** - -the user needs such a tool only if using the "A La Carte" method. - -- **via ONAP VID Graphical User Interface tool** - -- **via any tool able to perform REST API requests** - (for example : Robot Framework, Postman, Curl...) connected - to **ONAP SO** legacy API. - -With "A La Carte" method ------------------------- - -.. toctree:: - :maxdepth: 1 - - using ONAP VID Portal <../vid1/index.rst> - using ONAP SO REST API <../so1/index.rst> - -With "Macro" method ------------------------- - -Network instantiation is performed automatically when performing -Service Instantiation. diff --git a/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst deleted file mode 100644 index ccf036c2f..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -VNF Instantiation -================= - -**Pre-requisites** - -- The VNF is part of a Service Model (see: :ref:`Service Design <doc_guide_user_des_ser-des>`) - - .. Note:: In ONAP SDC tool, VNF is named "VF" - - -**Possible methods with ONAP to instantiate a VNF** - -- With **A La Carte** - method, the user needs to build and send a VNF instantiation - request. - - Note 1: prior to be able to send a request to instantiate - a VNF, the user needs to instantiate a Service Object and then will - need to refer to that Service instance in the VNF instantiate request. - - Note 2: after having instantiated the VNF object, the user needs to - instantiate a VF-module object, refering to the previously instantiated - VNF object. - - Note 3: the request to instantiate the VF-module object will, at last, send - a request to the selected Cloud Platform (Openstack, Azure, K8S...). - -- With **Macro** - method, the user do not need to send any - VNF instantiation request. VNF instantiation is being automatically - performed by ONAP when sending the request to instantiate the Service - (see: Instantiate Service). - - -**Possible Tools to perform VNF Instantiation** - -the user needs such a tool only if using the "A La Carte" method. - -- **via ONAP VID Graphical User Interface tool** - -- **via any tool able to perform REST API requests** - (for example : Robot Framework, Postman, Curl...) connected - to **ONAP SO** legacy API. - -With "A La Carte" method ------------------------- - -.. toctree:: - :maxdepth: 1 - - using ONAP VID Portal <../vid1/index.rst> - using ONAP SO REST API <../so1/index.rst> - -With "Macro" method ------------------------- - -VNF and VF-Module instantiation are performed automatically when performing -Service Instantiation. diff --git a/docs/guides/onap-user/instantiate/pre_instantiation/index.rst b/docs/guides/onap-user/instantiate/pre_instantiation/index.rst deleted file mode 100644 index ea3f90852..000000000 --- a/docs/guides/onap-user/instantiate/pre_instantiation/index.rst +++ /dev/null @@ -1,259 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_pre_ser-inst: - - -Pre Service instantiation Operations -==================================== - -Several operations need to be performed after Service model distribution, -but before instantiating a service. - -Those operations are only available via REST API requests. - -Various tools can be used to send REST API requests. - -Here after are examples using "curl" command line tool that you can use in -a Unix Terminal. - - -Declare owningEntity, lineOfBusiness, Platform and Project ----------------------------------------------------------- - -At one point during Service Instantiation, the user need to select values for -those 4 parameters - -* Owning Entity -* Line Of Business -* Platform -* Project - - -Those parameters and values must be pre-declared in ONAP VID component -using REST API - -Those informations will be available to all service instantiation -(you only need to declare them once in ONAP) - - -Example for "Owning Entity" named "OE-Generic" - -For Owning_Entity, it is important to declare the information in AAI -with a UUID value for "owning-entity-id". That value will be necessary -to instantiate a service with SO using GR_API. - -:: - - curl -k -X PUT \ - https://aai.api.sparky.simpledemo.onap.org:30233/aai/v13/business/owning-entities/owning-entity/8874891f-5120-4b98-b452-46284513958d \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: get_aai_subscr' \ - -H 'cache-control: no-cache' \ - -d '{ - "owning-entity-name": "OE-Generic", - "owning-entity-id": "8874891f-5120-4b98-b452-46284513958d" - }' - -:: - - curl -k -X GET \ - https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/business/owning-entities \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: get_aai_subscr' \ - -H 'cache-control: no-cache' - - -To declare the Owning Entity in VID: - -:: - - curl -k -X POST \ - https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/owningEntity \ - -H 'Accept-Encoding: gzip, deflate' \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' \ - -d '{ - "options": ["OE-Generic"] - }' - - -Example for "platform" named "Test_Platform" - -:: - - curl -k -X POST \ - https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/platform \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' \ - -d '{ - "options": ["Test_Platform"] - }' - -Example for "line of business" named "Test_LOB" - -:: - - curl -k -X POST \ - https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/lineOfBusiness \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' \ - -d '{ - "options": ["Test_LOB"] - }' - -Example for "project" named "Test_project" - -:: - - curl -k -X POST \ - https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/project \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' \ - -d '{ - "options": ["Test_project"] - }' - - - - -Declare a customer ------------------- - -Each time you have a new customer, you will need to perform those operations - -This operation is using ONAP AAI REST API - -Any service instance need to be linked to a customer - -in the query path, you put the customer_name - -in the query body you put the customer name again - -Here after an example to declare a customer named "my_customer_name" - - -:: - - curl -X PUT \ - https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/business/customers/customer/my_customer_name \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 808b54e3-e563-4144-a1b9-e24e2ed93d4f' \ - -H 'cache-control: no-cache' \ - -d '{ - "global-customer-id": "my_customer_name", - "subscriber-name": "my_customer_name", - "subscriber-type": "INFRA" - }' -k - - -check customers in ONAP AAI (you should see if everything ok in the response) - -:: - - curl -X GET \ - https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/business/customers \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 808b54e3-e563-4144-a1b9-e24e2ed93d4f' \ - -H 'cache-control: no-cache' -k - - -Associate Service Model to Customer ------------------------------------ - - -This operation is using ONAP AAI REST API - -in the query path, you put the customer_name and the service model name - -in the query body you put the service model UUID - -:: - - curl -X PUT \ - https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/business/customers/customer/my_customer_name/service-subscriptions/service-subscription/my_service_model_name \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'Postman-Token: d4bc4991-a518-4d75-8a87-674ba44bf13a' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 808b54e3-e563-4144-a1b9-e24e2ed93d4f' \ - -H 'cache-control: no-cache' \ - -d '{ - "service-id": "11265d8c-2cc2-40e5-95d8-57cad81c18da" - }' -k - - - - -Associate Cloud Site to Customer --------------------------------- - -in the query path, you put the customer_name and the service model name - -in the query body you put the cloud owner name, the cloud site name, -the tenant id and the tenant name - - -:: - - curl -X PUT \ - https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/business/customers/customer/my_customer_name/service-subscriptions/service-subscription/my_service_model_name/relationship-list/relationship \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'Postman-Token: 11ea9a9e-0dc8-4d20-8a78-c75cd6928916' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 808b54e3-e563-4144-a1b9-e24e2ed93d4f' \ - -H 'cache-control: no-cache' \ - -d '{ - "related-to": "tenant", - "related-link": "/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/my_cloud_owner_name/my_cloud_site_name/tenants/tenant/234a9a2dc4b643be9812915b214cdbbb", - "relationship-data": [ - { - "relationship-key": "cloud-region.cloud-owner", - "relationship-value": "my_cloud_owner_name" - }, - { - "relationship-key": "cloud-region.cloud-region-id", - "relationship-value": "my_cloud_site_name" - }, - { - "relationship-key": "tenant.tenant-id", - "relationship-value": "234a9a2dc4b643be9812915b214cdbbb" - } - ], - "related-to-property": [ - { - "property-key": "tenant.tenant-name", - "property-value": "my_tenant_name" - } - ] - }' -k - - -check (you should see if everything ok in the response) - -:: - - curl -X GET \ - 'https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/business/customers/customer/my_customer_name/service-subscriptions?depth=all' \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Content-Type: application/json' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 808b54e3-e563-4144-a1b9-e24e2ed93d4f' \ - -H 'cache-control: no-cache' -k |
