diff options
author | Eric Debeau <eric.debeau@orange.com> | 2019-05-16 17:38:12 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2019-05-16 17:38:12 +0000 |
commit | 846e2e3ab2b9d7ed75f9f51e141684cd7d0917aa (patch) | |
tree | 991d1c206ebbef5fda092870e648f47eacaa3323 /docs/guides | |
parent | b249d25f1296bfb5e610b51ee223ef27e2400769 (diff) | |
parent | b1a0c9d80ecf994f3f086196dab26a8824736041 (diff) |
Merge ""Using Onap" section content and structure changed to reflect content and structure of the wiki Fixed missing CLI section Issue-ID: DOC-450"
Diffstat (limited to 'docs/guides')
-rw-r--r-- | docs/guides/onap-user/design/control-loop/index.rst (renamed from docs/guides/onap-user/control-loop/index.rst) | 0 | ||||
-rw-r--r-- | docs/guides/onap-user/design/control-loop/media/DesignModel.png (renamed from docs/guides/onap-user/control-loop/media/DesignModel.png) | bin | 16235 -> 16235 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/index.rst (renamed from docs/guides/onap-user/servicedesigner.rst) | 15 | ||||
-rw-r--r-- | docs/guides/onap-user/design/pre-onboarding/index.rst (renamed from docs/guides/onap-user/pre-onboarding/index.rst) | 0 | ||||
-rw-r--r-- | docs/guides/onap-user/design/pre-onboarding/media/tenant.png (renamed from docs/guides/onap-user/pre-onboarding/media/tenant.png) | bin | 62264 -> 62264 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/index.rst (renamed from docs/guides/onap-user/resource-onboarding/index.rst) | 0 | ||||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png) | bin | 649 -> 649 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png) | bin | 9770 -> 9770 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png) | bin | 43369 -> 43369 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png) | bin | 22319 -> 22319 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png) | bin | 21118 -> 21118 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png) | bin | 47854 -> 47854 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-license-creation.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png) | bin | 47655 -> 47655 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png) | bin | 21986 -> 21986 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png) | bin | 35518 -> 35518 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-sdc_vsp_save.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png) | bin | 497 -> 497 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-software-product.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png) | bin | 49341 -> 49341 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png (renamed from docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png) | bin | 11020 -> 11020 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/service-design/index.rst | 298 | ||||
-rw-r--r-- | docs/guides/onap-user/design/service-design/media/design_asdccanvas_connect_elements.png | bin | 0 -> 649 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/service-design/media/design_service_adddeploymentartifact.png | bin | 0 -> 599 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/service-design/media/design_service_inputs_move.png | bin | 0 -> 497 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/service-design/media/design_service_workflow.png | bin | 0 -> 21059 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/service-distribution/index.rst (renamed from docs/guides/onap-user/service-distribution/index.rst) | 0 | ||||
-rw-r--r-- | docs/guides/onap-user/design/service-distribution/media/design_governance_workflow.png (renamed from docs/guides/onap-user/service-distribution/media/design_governance_workflow.png) | bin | 9962 -> 9962 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/index.rst (renamed from docs/guides/onap-user/vfcreation/index.rst) | 20 | ||||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/design_vf_updatevspmessage.png (renamed from docs/guides/onap-user/vfcreation/media/design_vf_updatevspmessage.png) | bin | 1766 -> 1766 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png (renamed from docs/guides/onap-user/vfcreation/media/design_vf_workflow.png) | bin | 11197 -> 11197 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-13-30.png (renamed from docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png) | bin | 3256 -> 3256 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-14-3.png (renamed from docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png) | bin | 24179 -> 24179 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-17-18.png (renamed from docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png) | bin | 25712 -> 25712 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-20-13.png (renamed from docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png) | bin | 4564 -> 4564 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-21-4.png (renamed from docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png) | bin | 18646 -> 18646 bytes | |||
-rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/sdc_artifact_update.png (renamed from docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png) | bin | 1108 -> 1108 bytes | |||
-rw-r--r-- | docs/guides/onap-user/index.rst | 8 | ||||
-rw-r--r-- | docs/guides/onap-user/onapcli.rst (renamed from docs/guides/onap-user/onapadmin.rst) | 0 | ||||
-rw-r--r-- | docs/guides/onap-user/onapportal.rst (renamed from docs/guides/onap-user/platformadmin.rst) | 0 | ||||
-rw-r--r-- | docs/guides/onap-user/servicedeployment.rst (renamed from docs/guides/onap-user/servicecreator.rst) | 0 |
38 files changed, 321 insertions, 20 deletions
diff --git a/docs/guides/onap-user/control-loop/index.rst b/docs/guides/onap-user/design/control-loop/index.rst index a8e77007c..a8e77007c 100644 --- a/docs/guides/onap-user/control-loop/index.rst +++ b/docs/guides/onap-user/design/control-loop/index.rst diff --git a/docs/guides/onap-user/control-loop/media/DesignModel.png b/docs/guides/onap-user/design/control-loop/media/DesignModel.png Binary files differindex a7cac4f88..a7cac4f88 100644 --- a/docs/guides/onap-user/control-loop/media/DesignModel.png +++ b/docs/guides/onap-user/design/control-loop/media/DesignModel.png diff --git a/docs/guides/onap-user/servicedesigner.rst b/docs/guides/onap-user/design/index.rst index 0b593a8d5..28a808ba5 100644 --- a/docs/guides/onap-user/servicedesigner.rst +++ b/docs/guides/onap-user/design/index.rst @@ -2,14 +2,13 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. -.. _user-guides-service-design: +Design +====== -Service Design -============== -The goal of the service design process is to create all artifacts -(models) that are required to instantiate and manage resources, -services, and products on the ONAP platform. The design process -requires input from users with multiple roles. +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. The design process requires +input from users with multiple roles. Design progresses logically through a series of phases. Each phase: @@ -31,6 +30,8 @@ Design includes the following topics: VF Creation and Testing <./vfcreation/index.rst> + Service Design <./service-design/index.rst> + Governance Approval and Service Distribution <./service-distribution/index.rst> Control Loop Design <./control-loop/index.rst> diff --git a/docs/guides/onap-user/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index 155ec56fb..155ec56fb 100644 --- a/docs/guides/onap-user/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst diff --git a/docs/guides/onap-user/pre-onboarding/media/tenant.png b/docs/guides/onap-user/design/pre-onboarding/media/tenant.png Binary files differindex b5ae8c678..b5ae8c678 100644 --- a/docs/guides/onap-user/pre-onboarding/media/tenant.png +++ b/docs/guides/onap-user/design/pre-onboarding/media/tenant.png diff --git a/docs/guides/onap-user/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst index 4a3cbc1e3..4a3cbc1e3 100644 --- a/docs/guides/onap-user/resource-onboarding/index.rst +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst diff --git a/docs/guides/onap-user/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 differindex 27c8986e5..27c8986e5 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png Binary files differindex 94a6743ed..94a6743ed 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png Binary files differindex 2db64c40b..2db64c40b 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png Binary files differindex 20fee24c0..20fee24c0 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png Binary files differindex 9f4f1b408..9f4f1b408 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png Binary files differindex ef99406d9..ef99406d9 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-creation.png Binary files differindex a358d03a4..a358d03a4 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-creation.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png Binary files differindex c8f293401..c8f293401 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png Binary files differindex dcc3104e4..dcc3104e4 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-sdc_vsp_save.png Binary files differindex 81f1df634..81f1df634 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-sdc_vsp_save.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-software-product.png Binary files differindex 457baa8cf..457baa8cf 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-software-product.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png Binary files differindex 5a5ad9496..5a5ad9496 100644 --- a/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png diff --git a/docs/guides/onap-user/design/service-design/index.rst b/docs/guides/onap-user/design/service-design/index.rst new file mode 100644 index 000000000..dcc6b9c62 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/index.rst @@ -0,0 +1,298 @@ +.. 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 Design +============== + +**Goal:** Add models and other artifacts required to create, configure, +instantiate, and manage services. Validate and certify the services. + +**Tool:** SDC + +**SDC user roles:** Designer, Tester + +|image1| + +**Figure: Workflow for Service design** + +**Steps** + + #. `Create a Service`_ + #. `Create a Workflow [optional]`_ + #. `Create a Network Callflow [optional]`_ + #. `Select VID Inputs [optional]`_ + #. `Update a Service [optional]`_ + #. `Submit a Service for Testing`_ + #. `Test a Service`_ + #. `Assign an IP Address Plan`_ + +Create a Service +---------------- + +**Prerequisites:** Create VFs required for this service (see :ref:`vfcreation-and-testing`). + +#. From the SDC HOME page, hover over Add and select Add Service. +#. In the General section, complete all fields. + + Note: Use the letters "Svc" in the name to indicate that the + component is a service. + +#. Click Create. + + A message displays when VF creation is complete. + +#. Click Composition. + + For a description of the Composition section (see \ `Composition + (Service design) <https://wiki.onap.org/x/lIwP>`__ ). + +#. 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 Connect. + +#. 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. + +#. Click Check In to save changes. + + A box displays for confirming the changes. + +#. Enter a comment and click OK. + + A message displays when the VF is checked in. + +#. [Optional] At any time before submitting the service for testing, + click these options to update service information: + + - 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 + - Workflow — model service lifecycle workflows for execution in SO + (see `Create a Workflow [optional]`_) + - Network Call Flow — model interactions among VFs (see `Create a + Network Callflow [optional]`_) + - Deployment — view HEAT modules in VSPs + - Inputs — select parameters as input fields during VID + instantiation (see `Select VID Inputs [optional]`_). + +#. After creating a service and configuring optional fields, submit it + for testing (see `Submit a Service for Testing`_). + + +Create a 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 WORKFLOW. +#. Click Add Workflow. +#. The Create New Workflow box displays. +#. Complete all fields. +#. Click Create. +#. 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. + +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 a service`_ + +#. From the SDC HOME page, click CATALOG and search for a 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. +#. Click Check In to save changes. + +Select VID Inputs [optional] +---------------------------- + +Select parameters as input fields during +`VID <https://wiki.onap.org/display/DW/Glossary#Glossary-VID>`__ +instantiation. + +Note: For questions about how to use this section, contact the Service +Design and Creation team (see \ `Mailing +Lists <https://wiki.onap.org/display/DW/Mailing+Lists>`__). + +**Prerequisites:** `Create a service`_ + +#. From the SDC HOME page, click CATALOG and search for a service. +#. Click the service and click Check Out. +#. Click Inputs. +#. From the Resource instance inputs pane, expand the name of a + resource. +#. Select inputs 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). +#. Click \ |image4| to move selected inputs to the Service inputs pane. +#. Click Check In to save changes. + +Update a 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 "Update a VF + [optional]" and "Test a VF". + +#. From the SDC HOME page, click CATALOG and search for a 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 a Service`_). +#. [Optional] Click Operations to edit Service Operations. + + #. Create/Edit Operations + #. Assign Workflow + #. Click Save + +#. [Optional] Click Management Callflow 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 Inputs to select parameters as input fields during + VID instantiation (see `Select VID Inputs [optional]`_). +#. Click Check In to save changes. +#. After updating a service and configuring optional fields, submit it + for testing (see `Submit a Service for Testing`_). + +Submit a Service for Testing +---------------------------- + +Note: A service cannot be submitted for testing if the reference +architecture contains uncertified resources. + +**Prerequisites:** `Create a Service`_ + +#. When a service is ready for testing, click CATALOG and search for the + service. +#. Click the service and click Submit for Testing. + A box displays for sending a message to the testers. +#. Enter a message for the testers asking that they begin service + certification and click OK. + + The default mail client launches with a draft email containing the + message from step 2. + +#. Add the email addresses of the people on the Certification Group with + the Tester role and send the email. + +Test a Service +-------------- + +Test the design and associated artifacts of a service. + +**Prerequisites:** `Submit a Service for Testing`_. + +#. Sign in to SDC as a Tester. +#. From the HOME page, select Ready For Testing under Active Projects. +#. In the right pane, click the service to test. +#. Click Start Testing. +#. Test the service. +#. When testing is complete, click Accept. + +Assign an IP Address Plan +------------------------- + +Assigning an IP address plan is specific to each OpenECOMP installation. +The object: to assign a Service's key to a "plan" for allocating IP +addresses. + +.. |image1| image:: media/design_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 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 differnew file mode 100644 index 000000000..27c8986e5 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/design_asdccanvas_connect_elements.png 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 differnew file mode 100644 index 000000000..364a5ce01 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/design_service_adddeploymentartifact.png 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 differnew file mode 100644 index 000000000..c4dcff760 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/design_service_inputs_move.png 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 differnew file mode 100644 index 000000000..fbe4fa20d --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/design_service_workflow.png diff --git a/docs/guides/onap-user/service-distribution/index.rst b/docs/guides/onap-user/design/service-distribution/index.rst index 4ed231047..4ed231047 100644 --- a/docs/guides/onap-user/service-distribution/index.rst +++ b/docs/guides/onap-user/design/service-distribution/index.rst diff --git a/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png b/docs/guides/onap-user/design/service-distribution/media/design_governance_workflow.png Binary files differindex 44d6b702f..44d6b702f 100644 --- a/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png +++ b/docs/guides/onap-user/design/service-distribution/media/design_governance_workflow.png diff --git a/docs/guides/onap-user/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst index f4c8c15ae..39130665a 100644 --- a/docs/guides/onap-user/vfcreation/index.rst +++ b/docs/guides/onap-user/design/vfcreation/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Doc Team. All rights reserved. +.. _vfcreation-and-testing: + VF Creation and Testing ======================= **Goal**: Using VSPs, create one or more VFs as the building blocks for a @@ -64,22 +66,22 @@ Create a VF .. note:: These tasks can be done only before submitting the VF for testing. - - Icon — change the icon associated with the VF (vendor-supplied icons are + - Icon ??? change the icon associated with the VF (vendor-supplied icons are preferred) - - Deployment Artifacts — download, view, modify, or change VF deployment + - Deployment Artifacts ??? download, view, modify, or change VF deployment artifacts (for example, the contents of the Heat .zip file, which contains the Heat volume template, the VF license, etc.) - - Information Artifacts — view or upload artifacts, such as test scripts, test + - 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 - - Properties — define or update VF properties (not used in Release 1) - - Composition — view or edit the graphical representation of the resource-level + - TOSCA Artifacts ??? view or upload the TOSCA model or the TOSCA template + - Properties ??? define or update VF properties (not used in Release 1) + - 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 + - Activity Log ??? view activity related to assets associated with the VF (displays the action, date, user, status, and any comments related to each action) - - Deployment — view VF modules defined in the Heat template - - Inputs — view inputs defined for the resource-level TOSCA model + - Deployment ??? view VF modules defined in the Heat template + - Inputs ??? view inputs defined for the resource-level TOSCA model #. After creating a VF, submit it for testing (see `Submit a VF for testing`_). diff --git a/docs/guides/onap-user/vfcreation/media/design_vf_updatevspmessage.png b/docs/guides/onap-user/design/vfcreation/media/design_vf_updatevspmessage.png Binary files differindex bf401daac..bf401daac 100644 --- a/docs/guides/onap-user/vfcreation/media/design_vf_updatevspmessage.png +++ b/docs/guides/onap-user/design/vfcreation/media/design_vf_updatevspmessage.png diff --git a/docs/guides/onap-user/vfcreation/media/design_vf_workflow.png b/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png Binary files differindex d3e831229..d3e831229 100644 --- a/docs/guides/onap-user/vfcreation/media/design_vf_workflow.png +++ b/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png diff --git a/docs/guides/onap-user/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 differindex 7bf32d4fc..7bf32d4fc 100644 --- a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png +++ b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-13-30.png diff --git a/docs/guides/onap-user/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 differindex 5a8d190a8..5a8d190a8 100644 --- a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png +++ b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-14-3.png diff --git a/docs/guides/onap-user/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 differindex d12ca8fec..d12ca8fec 100644 --- a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png +++ b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-17-18.png diff --git a/docs/guides/onap-user/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 differindex 82392a742..82392a742 100644 --- a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png +++ b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-20-13.png diff --git a/docs/guides/onap-user/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 differindex 594664344..594664344 100644 --- a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png +++ b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-21-4.png diff --git a/docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png b/docs/guides/onap-user/design/vfcreation/media/sdc_artifact_update.png Binary files differindex 266d965f8..266d965f8 100644 --- a/docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png +++ b/docs/guides/onap-user/design/vfcreation/media/sdc_artifact_update.png diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index 39c2a32c4..709265e0b 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -13,9 +13,9 @@ an instance of ONAP. .. toctree:: :maxdepth: 1 - platformadmin.rst + onapportal.rst platformoperations.rst - servicedesigner.rst - servicecreator.rst - onapadmin.rst + design/index.rst + servicedeployment.rst + onapcli.rst Verified Use Cases <../../submodules/integration.git/docs/docs_usecases.rst> diff --git a/docs/guides/onap-user/onapadmin.rst b/docs/guides/onap-user/onapcli.rst index 6c13c2780..6c13c2780 100644 --- a/docs/guides/onap-user/onapadmin.rst +++ b/docs/guides/onap-user/onapcli.rst diff --git a/docs/guides/onap-user/platformadmin.rst b/docs/guides/onap-user/onapportal.rst index 8c1107bb4..8c1107bb4 100644 --- a/docs/guides/onap-user/platformadmin.rst +++ b/docs/guides/onap-user/onapportal.rst diff --git a/docs/guides/onap-user/servicecreator.rst b/docs/guides/onap-user/servicedeployment.rst index 941bf5b46..941bf5b46 100644 --- a/docs/guides/onap-user/servicecreator.rst +++ b/docs/guides/onap-user/servicedeployment.rst |