From b1a0c9d80ecf994f3f086196dab26a8824736041 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 16 May 2019 15:47:49 +0200 Subject: "Using Onap" section content and structure changed to reflect content and structure of the wiki Fixed missing CLI section Issue-ID: DOC-450 Change-Id: I2ad3f57e854e9e64023887fa54656d8f01bf87e0 Signed-off-by: thmsdt --- docs/guides/onap-user/control-loop/index.rst | 271 ------------------- .../onap-user/control-loop/media/DesignModel.png | Bin 16235 -> 0 bytes .../guides/onap-user/design/control-loop/index.rst | 271 +++++++++++++++++++ .../design/control-loop/media/DesignModel.png | Bin 0 -> 16235 bytes docs/guides/onap-user/design/index.rst | 41 +++ .../onap-user/design/pre-onboarding/index.rst | 126 +++++++++ .../design/pre-onboarding/media/tenant.png | Bin 0 -> 62264 bytes .../onap-user/design/resource-onboarding/index.rst | 250 +++++++++++++++++ .../sdro-design_asdccanvas_connect_elements.png | Bin 0 -> 649 bytes .../media/sdro-design_onboardvsp_heaterrors.png | Bin 0 -> 9770 bytes .../resource-onboarding/media/sdro-edit-nic.png | Bin 0 -> 43369 bytes .../media/sdro-entitlement-pool.png | Bin 0 -> 22319 bytes .../media/sdro-feature-group.png | Bin 0 -> 21118 bytes .../media/sdro-license-agreement.png | Bin 0 -> 47854 bytes .../media/sdro-license-creation.png | Bin 0 -> 47655 bytes .../media/sdro-license-keygroup.png | Bin 0 -> 21986 bytes .../media/sdro-resource-onboarding-workflow.png | Bin 0 -> 35518 bytes .../media/sdro-sdc_vsp_save.png | Bin 0 -> 497 bytes .../media/sdro-software-product.png | Bin 0 -> 49341 bytes .../media/sdro-vsp-service-workflow.png | Bin 0 -> 11020 bytes .../onap-user/design/service-design/index.rst | 298 +++++++++++++++++++++ .../media/design_asdccanvas_connect_elements.png | Bin 0 -> 649 bytes .../media/design_service_adddeploymentartifact.png | Bin 0 -> 599 bytes .../media/design_service_inputs_move.png | Bin 0 -> 497 bytes .../media/design_service_workflow.png | Bin 0 -> 21059 bytes .../design/service-distribution/index.rst | 135 ++++++++++ .../media/design_governance_workflow.png | Bin 0 -> 9962 bytes docs/guides/onap-user/design/vfcreation/index.rst | 179 +++++++++++++ .../media/design_vf_updatevspmessage.png | Bin 0 -> 1766 bytes .../design/vfcreation/media/design_vf_workflow.png | Bin 0 -> 11197 bytes .../vfcreation/media/image2017-1-27_11-13-30.png | Bin 0 -> 3256 bytes .../vfcreation/media/image2017-1-27_11-14-3.png | Bin 0 -> 24179 bytes .../vfcreation/media/image2017-1-27_11-17-18.png | Bin 0 -> 25712 bytes .../vfcreation/media/image2017-1-27_11-20-13.png | Bin 0 -> 4564 bytes .../vfcreation/media/image2017-1-27_11-21-4.png | Bin 0 -> 18646 bytes .../vfcreation/media/sdc_artifact_update.png | Bin 0 -> 1108 bytes docs/guides/onap-user/index.rst | 8 +- docs/guides/onap-user/onapadmin.rst | 11 - docs/guides/onap-user/onapcli.rst | 11 + docs/guides/onap-user/onapportal.rst | 58 ++++ docs/guides/onap-user/platformadmin.rst | 58 ---- docs/guides/onap-user/pre-onboarding/index.rst | 126 --------- .../onap-user/pre-onboarding/media/tenant.png | Bin 62264 -> 0 bytes .../guides/onap-user/resource-onboarding/index.rst | 250 ----------------- .../sdro-design_asdccanvas_connect_elements.png | Bin 649 -> 0 bytes .../media/sdro-design_onboardvsp_heaterrors.png | Bin 9770 -> 0 bytes .../resource-onboarding/media/sdro-edit-nic.png | Bin 43369 -> 0 bytes .../media/sdro-entitlement-pool.png | Bin 22319 -> 0 bytes .../media/sdro-feature-group.png | Bin 21118 -> 0 bytes .../media/sdro-license-agreement.png | Bin 47854 -> 0 bytes .../media/sdro-license-creation.png | Bin 47655 -> 0 bytes .../media/sdro-license-keygroup.png | Bin 21986 -> 0 bytes .../media/sdro-resource-onboarding-workflow.png | Bin 35518 -> 0 bytes .../media/sdro-sdc_vsp_save.png | Bin 497 -> 0 bytes .../media/sdro-software-product.png | Bin 49341 -> 0 bytes .../media/sdro-vsp-service-workflow.png | Bin 11020 -> 0 bytes .../onap-user/service-distribution/index.rst | 135 ---------- .../media/design_governance_workflow.png | Bin 9962 -> 0 bytes docs/guides/onap-user/servicecreator.rst | 42 --- docs/guides/onap-user/servicedeployment.rst | 42 +++ docs/guides/onap-user/servicedesigner.rst | 40 --- docs/guides/onap-user/vfcreation/index.rst | 177 ------------ .../media/design_vf_updatevspmessage.png | Bin 1766 -> 0 bytes .../vfcreation/media/design_vf_workflow.png | Bin 11197 -> 0 bytes .../vfcreation/media/image2017-1-27_11-13-30.png | Bin 3256 -> 0 bytes .../vfcreation/media/image2017-1-27_11-14-3.png | Bin 24179 -> 0 bytes .../vfcreation/media/image2017-1-27_11-17-18.png | Bin 25712 -> 0 bytes .../vfcreation/media/image2017-1-27_11-20-13.png | Bin 4564 -> 0 bytes .../vfcreation/media/image2017-1-27_11-21-4.png | Bin 18646 -> 0 bytes .../vfcreation/media/sdc_artifact_update.png | Bin 1108 -> 0 bytes 70 files changed, 1415 insertions(+), 1114 deletions(-) delete mode 100644 docs/guides/onap-user/control-loop/index.rst delete mode 100644 docs/guides/onap-user/control-loop/media/DesignModel.png create mode 100644 docs/guides/onap-user/design/control-loop/index.rst create mode 100644 docs/guides/onap-user/design/control-loop/media/DesignModel.png create mode 100644 docs/guides/onap-user/design/index.rst create mode 100644 docs/guides/onap-user/design/pre-onboarding/index.rst create mode 100644 docs/guides/onap-user/design/pre-onboarding/media/tenant.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/index.rst create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-license-creation.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-sdc_vsp_save.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-software-product.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png create mode 100644 docs/guides/onap-user/design/service-design/index.rst create mode 100644 docs/guides/onap-user/design/service-design/media/design_asdccanvas_connect_elements.png create mode 100644 docs/guides/onap-user/design/service-design/media/design_service_adddeploymentartifact.png create mode 100644 docs/guides/onap-user/design/service-design/media/design_service_inputs_move.png create mode 100644 docs/guides/onap-user/design/service-design/media/design_service_workflow.png create mode 100644 docs/guides/onap-user/design/service-distribution/index.rst create mode 100644 docs/guides/onap-user/design/service-distribution/media/design_governance_workflow.png create mode 100644 docs/guides/onap-user/design/vfcreation/index.rst create mode 100644 docs/guides/onap-user/design/vfcreation/media/design_vf_updatevspmessage.png create mode 100644 docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png create mode 100644 docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-13-30.png create mode 100644 docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-14-3.png create mode 100644 docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-17-18.png create mode 100644 docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-20-13.png create mode 100644 docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-21-4.png create mode 100644 docs/guides/onap-user/design/vfcreation/media/sdc_artifact_update.png delete mode 100644 docs/guides/onap-user/onapadmin.rst create mode 100644 docs/guides/onap-user/onapcli.rst create mode 100644 docs/guides/onap-user/onapportal.rst delete mode 100644 docs/guides/onap-user/platformadmin.rst delete mode 100644 docs/guides/onap-user/pre-onboarding/index.rst delete mode 100644 docs/guides/onap-user/pre-onboarding/media/tenant.png delete mode 100644 docs/guides/onap-user/resource-onboarding/index.rst delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png delete mode 100644 docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png delete mode 100644 docs/guides/onap-user/service-distribution/index.rst delete mode 100644 docs/guides/onap-user/service-distribution/media/design_governance_workflow.png delete mode 100644 docs/guides/onap-user/servicecreator.rst create mode 100644 docs/guides/onap-user/servicedeployment.rst delete mode 100644 docs/guides/onap-user/servicedesigner.rst delete mode 100644 docs/guides/onap-user/vfcreation/index.rst delete mode 100644 docs/guides/onap-user/vfcreation/media/design_vf_updatevspmessage.png delete mode 100644 docs/guides/onap-user/vfcreation/media/design_vf_workflow.png delete mode 100644 docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png delete mode 100644 docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png delete mode 100644 docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png delete mode 100644 docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png delete mode 100644 docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png delete mode 100644 docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png (limited to 'docs/guides/onap-user') diff --git a/docs/guides/onap-user/control-loop/index.rst b/docs/guides/onap-user/control-loop/index.rst deleted file mode 100644 index a8e77007c..000000000 --- a/docs/guides/onap-user/control-loop/index.rst +++ /dev/null @@ -1,271 +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 `_) to - confirm that a blueprint for the Service has been generated and - is available on DCAE. - -**Prerequisites:** Create and test a VF -(see :ref:`VF Creation and Testing `). - - #. 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, -see :ref:`Policy Design `. - - -.. |image0| image:: media/DesignModel.png - diff --git a/docs/guides/onap-user/control-loop/media/DesignModel.png b/docs/guides/onap-user/control-loop/media/DesignModel.png deleted file mode 100644 index a7cac4f88..000000000 Binary files a/docs/guides/onap-user/control-loop/media/DesignModel.png and /dev/null differ diff --git a/docs/guides/onap-user/design/control-loop/index.rst b/docs/guides/onap-user/design/control-loop/index.rst new file mode 100644 index 000000000..a8e77007c --- /dev/null +++ b/docs/guides/onap-user/design/control-loop/index.rst @@ -0,0 +1,271 @@ +.. 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 `_) to + confirm that a blueprint for the Service has been generated and + is available on DCAE. + +**Prerequisites:** Create and test a VF +(see :ref:`VF Creation and Testing `). + + #. 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, +see :ref:`Policy 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 new file mode 100644 index 000000000..a7cac4f88 Binary files /dev/null and b/docs/guides/onap-user/design/control-loop/media/DesignModel.png differ diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst new file mode 100644 index 000000000..28a808ba5 --- /dev/null +++ b/docs/guides/onap-user/design/index.rst @@ -0,0 +1,41 @@ +.. 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. + +Design +====== + +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: + +* is organized into steps that are completed in sequence + +* is accessed using a different role with specific responsibilities + generates artifacts that are used in other phases of design or when + instantiating or monitoring virtual functions. + +Design includes the following topics: + +.. 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> + + Governance Approval and Service Distribution <./service-distribution/index.rst> + + Control Loop Design <./control-loop/index.rst> + +* `Policy Design `_ + +* `SDC Artifacts List `_ diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst new file mode 100644 index 000000000..155ec56fb --- /dev/null +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -0,0 +1,126 @@ +.. 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. + +Pre-Onboarding +============== + + * `Create a Tenant`_ + * `Validate VFs (Virtual Functions)`_ + * `Generate Manifest and Package Artifacts`_ + +Create a Tenant +--------------- + +Each service requires a tenant_ (a group of users who share a common access) +in which resources are stored in the cloud. This process is performed using +facilities of the network cloud, outside of ONAP. Confirm that the tenant is +created and note the tenant ID. + +ONAP admin users can configure a cloud-owner to add new cloud resources. +These are the computing and networking resources, that will support +running VNFs. A cloud-owner holds a keystone URL, login, region and +password, in the case of an Openstack cluster. A cloud-owner also +belongs to a region. The region name should be the same as the Openstack +region. Prior to creation of a cloud-owner, its region must be created +first. Multiple tenants can share the same cloud-owner. Note that these +tenants are ONAP tenants, not Openstack tenants. Tenant register +services that customers are allowed to deploy. Finally, the customer is +like an instance of the tenant. + +Note: there is no GUI (yet) to configure these objects. REST requests +are sent to AAI to achieve the configuration. For a detailed list of +required REST commands see: + +https://wiki.onap.org/display/DW/running+vFW+Demo+on+ONAP+Amsterdam+Release + +The overall process is as follows: + + #. Create a region and a cloud-owner. This steps registers Openstack + credentials. This is the only step requiring entering Openstack specific + parameters. + + #. Create a complex. The complex describes the coverage of the region with + a street address etc. + + #. Create a service. The service name should match the name of the service + onboarded in SDC. + + #. Create a tenant. Tenant in ONAP stores a design for a generic customer. + + #. Associate tenants with their allowed services. + + #. Create an instance of the tenant or customer. The customer is visible in + VID. A VID user can deploy allowed services on this new customer. + + |image1| + + +Validate VFs (Virtual Functions) +-------------------------------- + +Prior to resource onboarding, the Certification Group does the following: + + - 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 and Package Artifacts +--------------------------------------- + +Before onboarding resources, run generate-manifest.py to generate a +MANIFEST file. These steps are performed outside SDC. + +OBSOLETE: **Prerequisites:** Obtain Heat/ENV files and other files required for +onboarding. See the reference document `VNF Heat Template Requirements +for OpenECOMP `__ for details. + +UPDATE: see VNF Modeling Requirements / HEAT: https://onap.readthedocs.io/en/casablanca/submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.html + +#. Put the Heat, ENV, nested Heat, and other files used by get-file in templates + in a directory. + + 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 on the Windows command line: + + .. code-block:: + + 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. + + +.. |image1| image:: media/tenant.png +.. _tenant: https://wiki.onap.org/display/DW/Glossary#Glossary-tenant diff --git a/docs/guides/onap-user/design/pre-onboarding/media/tenant.png b/docs/guides/onap-user/design/pre-onboarding/media/tenant.png new file mode 100644 index 000000000..b5ae8c678 Binary files /dev/null and b/docs/guides/onap-user/design/pre-onboarding/media/tenant.png differ diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst new file mode 100644 index 000000000..4a3cbc1e3 --- /dev/null +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst @@ -0,0 +1,250 @@ +.. 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. + +Resource Onboarding +=================== +**Goal:** Add models and other artifacts required to create, configure, instantiate, and manage a VF and, optionally, a VFC. + +**Tool:** SDC + +**SDC user role:** Designer + +|image0| + +**Steps** + * `Create a License Model`_ + * `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 created from the VSP + * any services that include the VF + +|image1| + +Create a License Model +---------------------- + +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. + +|image3| + +#. From the SDC HOME page, click *ONBOARD*. +#. Hover over Add and select New License Model. +#. Complete all fields. +#. Click *Save*. +#. In the ONBOARD header, hover over the arrow after License Agreements to reveal a menu. + 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. + +#. In the header, click the license model created in steps 1 to 4. +#. Click *Check In* to save changes. +#. Click *Submit* to add the license model to the catalog. A success message displays. +#. After creating a license, complete `Create a Vendor Software Product`_ to add the VSP required for the associated VF. + +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`_ + +|image4| + +1. From the drop-down menu, select License Key Groups. +2. Click *Add License Key Group*. + The Create New License Key Group box displays. +3. Complete all fields. + Note: Enter the manufacturer reference number in the Name field. +4. 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]`_). + +|image5| + +1. From the drop-down menu, select Entitlement Pools. +2. Click *Add Entitlement Pool*. + The Create New Entitlement Pool box displays. +3. Complete required fields (mandatory fields are marked by a red asterisk). +4. 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`_) + +|image6| + +1. From the drop-down menu, select Feature Groups. +2. Click *Add Feature Group*. + The Create New Feature Group box displays. +3. On the General tab, complete all fields. +4. Click *Entitlement Pools*. +5. Click *Available Entitlement Pools*. +6. Select one or more entitlement pools and click the right arrow. +7. Click *License Key Groups*. +8. Click *Available License Key Groups*. +9. Select one or more license key groups and click the right arrow. +10. Click *Save*. + +Create a License Agreement +-------------------------- + +**Prerequisites:** Create one or more feature groups (see `Create a Feature Group`_). + +|image7| + +1. From the drop-down menu, select License Agreements. +2. Click *Add License Agreement*. + The Create New License Agreement box displays. +3. On the General tab, complete required fields (mandatory fields are marked by a red asterisk). +4. Click *Feature Groups*. +5. If not selected, click *Available Feature Groups*. +6. Select one or more groups and click the right arrow. +7. Click *Save*. +8. Return to step 5 of `Create a License Model`_ to complete the license model. + +Create a Vendor Software Product +-------------------------------- + +Create one or more Vendor Software Products (VSPs) as the building blocks for VFs. + +.. note:: + For interim saving while creating a VSP, click |image2| + +**Prerequisites:** + +* `Create a License Model`_ +* Generate manifest and package artifacts. + +#. From the SDC HOME page, click *ONBOARD*. +#. Hover over Add and select New Vendor Software Product. +#. The New Software Product box is displayed. + Complete all fields. +#. Click *Save*. + The Overview section is displayed. + + .. note:: + A warning is displayed under License Agreement if the VSP does not have an associated license. + +#. Click *Software Product Details* (left pane). + + |image8| + +#. In order, select a licensing version, a license agreement, and one or more feature groups. +#. [Optional] Complete other fields, such as Availability (high-availability zones) and Storage + Data Replication (requirement for storage replication), as required. +#. In Software Product Attachments (right pane), click *Select file*. +#. Locate a Heat .zip package and click *Open*. + SDC validates the files in the package. After successful validation, SDC displays the files + and a success message. If validation fails, SDC displays the errors in the files. + + Example Heat errors: + + |image9| + +#. Click *Check In* to save the changes. +#. Click *Submit* to add the VSP to the catalog. +#. 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. + + +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. +#. In the Overview section, click *Check Out*. +#. In Components (bottom pane), 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. +#. Click *Overview* and click *Check In* to save changes. +#. If updating a VSP, click *Submit*. If this procedure is performed during the workflow to create a VSP, there is no need to click *Submit* now. + +Update a VSP [optional] +----------------------- + +Upload a new Heat package to a VSP. Afterward, update the VF 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. +#. In the Overview section, click *Check Out*. +#. In Software Product Attachments (right pane), click *Select file*. +#. Locate a Heat .zip package and click *Open*. + SDC warns that uploading a new package erases existing data. +#. Click *Continue* to upload the new Heat package. + SDC validates the files in the package. After successful validation, SDC displays the files and a success message. If validation fails, SDC displays the errors in the files. + + .. note:: + If the Heat template contains errors, contact the Certification Group for guidance on how to proceed. + +#. Click *Check In* to save changes. +#. Click *Submit* to add the VSP to the catalog. + A success message is displayed. If the VSP attachments contain errors, an error message is displayed instead. Fix the issue(s) and re-submit. +#. After updating the VSP: + #. Upload the VSP to the VF (see steps 3 to 5 in (TBD)Update a VF [optional]). + #. Update the VF version in services that include the VF (see step 4 in (TBD) Update a service [optional]). + + +.. |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 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 new file mode 100644 index 000000000..27c8986e5 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png differ 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 new file mode 100644 index 000000000..94a6743ed Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png differ 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 new file mode 100644 index 000000000..2db64c40b Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png differ 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 new file mode 100644 index 000000000..20fee24c0 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png differ 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 new file mode 100644 index 000000000..9f4f1b408 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png differ 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 new file mode 100644 index 000000000..ef99406d9 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png differ 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 new file mode 100644 index 000000000..a358d03a4 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-creation.png differ 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 new file mode 100644 index 000000000..c8f293401 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png differ 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 new file mode 100644 index 000000000..dcc3104e4 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png differ 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 new file mode 100644 index 000000000..81f1df634 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-sdc_vsp_save.png differ 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 new file mode 100644 index 000000000..457baa8cf Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-software-product.png differ 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 new file mode 100644 index 000000000..5a5ad9496 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png differ 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) `__ ). + +#. 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 `__ +instantiation. + +Note: For questions about how to use this section, contact the Service +Design and Creation team (see \ `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 new file mode 100644 index 000000000..27c8986e5 Binary files /dev/null and b/docs/guides/onap-user/design/service-design/media/design_asdccanvas_connect_elements.png differ 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 new file mode 100644 index 000000000..364a5ce01 Binary files /dev/null and b/docs/guides/onap-user/design/service-design/media/design_service_adddeploymentartifact.png differ 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 new file mode 100644 index 000000000..c4dcff760 Binary files /dev/null and b/docs/guides/onap-user/design/service-design/media/design_service_inputs_move.png differ 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 new file mode 100644 index 000000000..fbe4fa20d Binary files /dev/null and b/docs/guides/onap-user/design/service-design/media/design_service_workflow.png differ diff --git a/docs/guides/onap-user/design/service-distribution/index.rst b/docs/guides/onap-user/design/service-distribution/index.rst new file mode 100644 index 000000000..4ed231047 --- /dev/null +++ b/docs/guides/onap-user/design/service-distribution/index.rst @@ -0,0 +1,135 @@ +.. 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. + +Governance Approval and 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. + +**Tools:** SDC + +**SDC user roles:** Governor, Ops + +Steps +----- + +- `Review a Service for Governance Approval`_ +- `Request Service Distribution`_ +- `Distribute a Service`_ +- `Verify that the DCAE Blueprint is Deployed`_ + +|image1| + +**Figure 1. Workflow** + +Review a Service for Governance Approval +---------------------------------------- + +A member of the Governance Board performs a governance review of a +certified service and its associated VFs, and then approves (or rejects) +the artifacts for distribution. + +**Prerequisites:** Service is tested. + +**Steps** + +#. Sign in to SDC as a Governor. +#. From the HOME page, click CATALOG and select a service that is ready + for governance review. +#. Review the service and its associated resources. +#. To view deployment artifacts: + + #. Click *Composition* tab (left pane) and then click the Deployment + Artifact icon (right pane) to see the list of artifacts. + #. Click the download icon adjacent to an artifact to download and + view it. + +#. When the review is complete, click: + + - *Accept* if the service passes the governance review. The service is + marked Approved for Distribution. + - *Reject* if the service fails the governance review. The service is + marked Rejected for Distribution. + +After a service receives governance approval, it moves into the Waiting +to be Distributed section of the Operations Workspace (Ops role) + +Request Service Distribution +---------------------------- + +Request service distribution to populate all appropriate ONAP +components with the resources and artifacts ssociated with the service and its +VFs. + +**Prerequisites:** + +A service has received governance approval and is +available in the Waiting to be Distributed section of the SDC Operations +Workspace (under the Ops Role). For more information, see +`Review a Service for Governance Approval`_. + +The steps shown here are generic; each service provider has a different, +specific set of instructions. Contact your site IT support for the +particulars. + +**Steps** + +#. Open at ticket request at your site +#. Make a "DISTRIBUTION REQUEST" +#. Provide the following information in your request: + + - Environment + - Name of service to be distributed + - Version number + - [Optional] Additional information or instructions (provide special + instructions for the request) + - Your user ID + - [Optional] Alternate Contact user ID (provide an alternate contact + if the primary contact is unavailable) + +Distribute a Service +-------------------- + +**Prerequisites:** The service is approved. + +**Steps** + + +#. Sign in to SDC as Ops. +#. In the Active Projects pane (left pane) of the HOME page, select the + W*aiting For Distribution* check box. +#. Select a service that is ready for distribution. +#. Review the version history to verify that the correct version is + selected. +#. In the header, click *Distribute*. + + The service moves from the Ready For Distribution folder to the + Distributed Services folder. + +#. From the Workspace pane, click *Distributed Services*. + All distributed services display. +#. Select the service distributed in step 5 and click *Monitor*. + The Distribution Report displays. +#. In the Distribution Report, navigate to the Component ID for the + service and click the adjacent down arrow. + The report shows all components associated with the service and their + distribution statuses, such as DOWNLOAD_OK. +#. Review the status of each component. + +Verify that the DCAE Blueprint is Deployed +------------------------------------------ + +The DCAE controller requires a blueprint (or guideline) to be available +at the site on which the first VNF is deployed. This blueprint is a +management workflow and configuration description for a given VNF, and +it must be available after completing the service distribution process +and before beginning the instantiation process. + +.. |image1| image:: media/design_governance_workflow.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 new file mode 100644 index 000000000..44d6b702f Binary files /dev/null and b/docs/guides/onap-user/design/service-distribution/media/design_governance_workflow.png differ diff --git a/docs/guides/onap-user/design/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst new file mode 100644 index 000000000..39130665a --- /dev/null +++ b/docs/guides/onap-user/design/vfcreation/index.rst @@ -0,0 +1,179 @@ +.. 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. + +.. _vfcreation-and-testing: + +VF Creation and Testing +======================= +**Goal**: Using VSPs, create one or more VFs as the building blocks for a +service. Validate and certify the VFs. + +**ONAP Component**: SDC + +**SDC user roles**: Designer, Tester + +|image1| + +Steps +----- + +- `Create a VF`_ +- `Update a VF [optional]`_ +- `Submit a VF for testing`_ +- `Test a VF`_ + +Create a VF +----------- + +**Prerequisites:** + +- Create a license for each VF (see Create a license model) (see also the + tutorial Creating a Licensing Model) +- Create a Vendor Software Product. + +**Steps** + +#. From the SDC HOME page, click the *Vendor Software Component* icon in the + header (upper right). + + |image2| + +#. From the Import VF box, expand a VSP name and click the *Import VSP* icon. + + |image3| + +#. In the General section, complete all fields. + + .. note:: Use the letters "VF" in the name to indicate that the component is a VF. + +#. Click *Create*. + + - A message displays while VF creation is in progress. (This can take up to + 10 minutes.) + - A message displays when VF creation is complete. + +#. 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 VF for testing, click these + options to update VF information: + + .. 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 + preferred) + - 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 + 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 model (generated from the Heat template) + - 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 + +#. After creating a VF, submit it for testing (see `Submit a VF for testing`_). + +Update a VF [optional] +---------------------- + +- Update the VSP and other artifacts in a VF. +- Upload a new version the VSP to the VF whenever the VSP is updated (see steps + 3 to 5). Other reasons for updating a VF include: + + - artifact changes at the VF level that need be uploaded, for example, + changes to ENV values (see step 6) + +**Prerequisites:** + +- `Create a VF`_. +- If the VSP was updated: Update a VSP [optional] + +**Steps** + +#. From the SDC HOME page, click *CATALOG* and search for a VF. + +#. In the General section, click *Check Out*. + The Select VSP field is displays. + +#. In the Select VSP field, click *Browse*. + The Import VF box displays and shows the VSP that was used to create the VF. + +#. Expand the VSP field and click. + + |image4| + +#. Click |image5| + A progress bar displays. |image6| + +#. 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. + +#. After updating the VF: + + - Submit the VF for testing (see Submit a VF for testing). + - Update the VF version in any service that contains the VF + (see step 4 in Update a service [optional]). + +Submit a VF for testing +----------------------- + +**Prerequisites:** `Create a VF`_ + +**Steps** + +#. When a VF is ready for testing, click *CATALOG* and service for the VF. +#. Click the VF and click *Submit for Testing*. + + |image7| + + |image8| + +#. 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. + +#. Add the email addresses of the people on the Certification Group for this + site with the *Tester* role and send the email. + +Test a VF +--------- + +Test the design and artifacts of a VF. + +**Prerequisites:** `Submit a VF for testing`_. + +**Steps** + +#. Sign in to SDC as a *Tester*. +#. From the HOME page, select *Ready For Testing* under Active Projects. +#. In the right pane, click the VF. +#. Click *Start Testing*. +#. Test the VF. +#. When testing is complete, click *Accept*. + +.. |image1| image:: media/design_vf_workflow.png +.. |image2| image:: media/image2017-1-27_11-13-30.png +.. |image3| image:: media/image2017-1-27_11-14-3.png +.. |image4| image:: media/image2017-1-27_11-17-18.png +.. |image5| image:: media/sdc_artifact_update.png +.. |image6| image:: media/design_vf_updatevspmessage.png +.. |image7| image:: media/image2017-1-27_11-20-13.png +.. |image8| image:: media/image2017-1-27_11-21-4.png 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 new file mode 100644 index 000000000..bf401daac Binary files /dev/null and b/docs/guides/onap-user/design/vfcreation/media/design_vf_updatevspmessage.png differ 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 new file mode 100644 index 000000000..d3e831229 Binary files /dev/null and b/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png differ 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 new file mode 100644 index 000000000..7bf32d4fc Binary files /dev/null and b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-13-30.png differ 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 new file mode 100644 index 000000000..5a8d190a8 Binary files /dev/null and b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-14-3.png differ 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 new file mode 100644 index 000000000..d12ca8fec Binary files /dev/null and b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-17-18.png differ 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 new file mode 100644 index 000000000..82392a742 Binary files /dev/null and b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-20-13.png differ 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 new file mode 100644 index 000000000..594664344 Binary files /dev/null and b/docs/guides/onap-user/design/vfcreation/media/image2017-1-27_11-21-4.png differ 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 new file mode 100644 index 000000000..266d965f8 Binary files /dev/null and b/docs/guides/onap-user/design/vfcreation/media/sdc_artifact_update.png differ 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/onapadmin.rst deleted file mode 100644 index 6c13c2780..000000000 --- a/docs/guides/onap-user/onapadmin.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - - -ONAP CLI -======== - -.. toctree:: - :maxdepth: 2 - - ../../../submodules/cli.git/docs/user_guide.rst - ../../../submodules/cli.git/docs/OCLIP.rst \ No newline at end of file diff --git a/docs/guides/onap-user/onapcli.rst b/docs/guides/onap-user/onapcli.rst new file mode 100644 index 000000000..6c13c2780 --- /dev/null +++ b/docs/guides/onap-user/onapcli.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +ONAP CLI +======== + +.. toctree:: + :maxdepth: 2 + + ../../../submodules/cli.git/docs/user_guide.rst + ../../../submodules/cli.git/docs/OCLIP.rst \ No newline at end of file diff --git a/docs/guides/onap-user/onapportal.rst b/docs/guides/onap-user/onapportal.rst new file mode 100644 index 000000000..8c1107bb4 --- /dev/null +++ b/docs/guides/onap-user/onapportal.rst @@ -0,0 +1,58 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +ONAP Portal +=========== +The ONAP Portal integrates different ONAP applications in one place. +The Portal platform provides common management services and +connectivity, while the applications run separately. + +From the Portal, users access applications. Administrators +onboard and manage applications and widgets, and manage user access. + +The Portal SDK for application developers includes bundled tools, +technologies, and built-in capabilities such as services, APIs, +and UI controls. Existing applications can migrate to the Portal +with the provided APIs and libraries. +See Portal SDK_. + +.. _SDK: https://docs.onap.org/en/latest/submodules/portal.git/docs/tutorials/portal-sdk/index.html + +Access the ONAP Portal +---------------------- + +Access the ONAP Portal using a browser such as Mozilla Firefox or +Google Chrome. The URL is dependent on a specific ONAP platform +deployment. + +From the Portal, users access applications directly or by +function using the Manage menu. + +.. figure:: onap-portal-home.png + :width: 900 px + :height: 600 px + + +Roles in the ONAP Portal +------------------------ +The Portal displays different menus for the following roles: + +* User + +* Portal Administrator + +* Application Administrator + +* Governor + +* Operator + +Each application also defines a distinct set of user roles. +See Users. + +See also +-------- + +* `Applications in the Portal `_ diff --git a/docs/guides/onap-user/platformadmin.rst b/docs/guides/onap-user/platformadmin.rst deleted file mode 100644 index 8c1107bb4..000000000 --- a/docs/guides/onap-user/platformadmin.rst +++ /dev/null @@ -1,58 +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. - - -ONAP Portal -=========== -The ONAP Portal integrates different ONAP applications in one place. -The Portal platform provides common management services and -connectivity, while the applications run separately. - -From the Portal, users access applications. Administrators -onboard and manage applications and widgets, and manage user access. - -The Portal SDK for application developers includes bundled tools, -technologies, and built-in capabilities such as services, APIs, -and UI controls. Existing applications can migrate to the Portal -with the provided APIs and libraries. -See Portal SDK_. - -.. _SDK: https://docs.onap.org/en/latest/submodules/portal.git/docs/tutorials/portal-sdk/index.html - -Access the ONAP Portal ----------------------- - -Access the ONAP Portal using a browser such as Mozilla Firefox or -Google Chrome. The URL is dependent on a specific ONAP platform -deployment. - -From the Portal, users access applications directly or by -function using the Manage menu. - -.. figure:: onap-portal-home.png - :width: 900 px - :height: 600 px - - -Roles in the ONAP Portal ------------------------- -The Portal displays different menus for the following roles: - -* User - -* Portal Administrator - -* Application Administrator - -* Governor - -* Operator - -Each application also defines a distinct set of user roles. -See Users. - -See also --------- - -* `Applications in the Portal `_ diff --git a/docs/guides/onap-user/pre-onboarding/index.rst b/docs/guides/onap-user/pre-onboarding/index.rst deleted file mode 100644 index 155ec56fb..000000000 --- a/docs/guides/onap-user/pre-onboarding/index.rst +++ /dev/null @@ -1,126 +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. - -Pre-Onboarding -============== - - * `Create a Tenant`_ - * `Validate VFs (Virtual Functions)`_ - * `Generate Manifest and Package Artifacts`_ - -Create a Tenant ---------------- - -Each service requires a tenant_ (a group of users who share a common access) -in which resources are stored in the cloud. This process is performed using -facilities of the network cloud, outside of ONAP. Confirm that the tenant is -created and note the tenant ID. - -ONAP admin users can configure a cloud-owner to add new cloud resources. -These are the computing and networking resources, that will support -running VNFs. A cloud-owner holds a keystone URL, login, region and -password, in the case of an Openstack cluster. A cloud-owner also -belongs to a region. The region name should be the same as the Openstack -region. Prior to creation of a cloud-owner, its region must be created -first. Multiple tenants can share the same cloud-owner. Note that these -tenants are ONAP tenants, not Openstack tenants. Tenant register -services that customers are allowed to deploy. Finally, the customer is -like an instance of the tenant. - -Note: there is no GUI (yet) to configure these objects. REST requests -are sent to AAI to achieve the configuration. For a detailed list of -required REST commands see: - -https://wiki.onap.org/display/DW/running+vFW+Demo+on+ONAP+Amsterdam+Release - -The overall process is as follows: - - #. Create a region and a cloud-owner. This steps registers Openstack - credentials. This is the only step requiring entering Openstack specific - parameters. - - #. Create a complex. The complex describes the coverage of the region with - a street address etc. - - #. Create a service. The service name should match the name of the service - onboarded in SDC. - - #. Create a tenant. Tenant in ONAP stores a design for a generic customer. - - #. Associate tenants with their allowed services. - - #. Create an instance of the tenant or customer. The customer is visible in - VID. A VID user can deploy allowed services on this new customer. - - |image1| - - -Validate VFs (Virtual Functions) --------------------------------- - -Prior to resource onboarding, the Certification Group does the following: - - - 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 and Package Artifacts ---------------------------------------- - -Before onboarding resources, run generate-manifest.py to generate a -MANIFEST file. These steps are performed outside SDC. - -OBSOLETE: **Prerequisites:** Obtain Heat/ENV files and other files required for -onboarding. See the reference document `VNF Heat Template Requirements -for OpenECOMP `__ for details. - -UPDATE: see VNF Modeling Requirements / HEAT: https://onap.readthedocs.io/en/casablanca/submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.html - -#. Put the Heat, ENV, nested Heat, and other files used by get-file in templates - in a directory. - - 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 on the Windows command line: - - .. code-block:: - - 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. - - -.. |image1| image:: media/tenant.png -.. _tenant: https://wiki.onap.org/display/DW/Glossary#Glossary-tenant diff --git a/docs/guides/onap-user/pre-onboarding/media/tenant.png b/docs/guides/onap-user/pre-onboarding/media/tenant.png deleted file mode 100644 index b5ae8c678..000000000 Binary files a/docs/guides/onap-user/pre-onboarding/media/tenant.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/index.rst b/docs/guides/onap-user/resource-onboarding/index.rst deleted file mode 100644 index 4a3cbc1e3..000000000 --- a/docs/guides/onap-user/resource-onboarding/index.rst +++ /dev/null @@ -1,250 +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. - -Resource Onboarding -=================== -**Goal:** Add models and other artifacts required to create, configure, instantiate, and manage a VF and, optionally, a VFC. - -**Tool:** SDC - -**SDC user role:** Designer - -|image0| - -**Steps** - * `Create a License Model`_ - * `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 created from the VSP - * any services that include the VF - -|image1| - -Create a License Model ----------------------- - -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. - -|image3| - -#. From the SDC HOME page, click *ONBOARD*. -#. Hover over Add and select New License Model. -#. Complete all fields. -#. Click *Save*. -#. In the ONBOARD header, hover over the arrow after License Agreements to reveal a menu. - 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. - -#. In the header, click the license model created in steps 1 to 4. -#. Click *Check In* to save changes. -#. Click *Submit* to add the license model to the catalog. A success message displays. -#. After creating a license, complete `Create a Vendor Software Product`_ to add the VSP required for the associated VF. - -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`_ - -|image4| - -1. From the drop-down menu, select License Key Groups. -2. Click *Add License Key Group*. - The Create New License Key Group box displays. -3. Complete all fields. - Note: Enter the manufacturer reference number in the Name field. -4. 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]`_). - -|image5| - -1. From the drop-down menu, select Entitlement Pools. -2. Click *Add Entitlement Pool*. - The Create New Entitlement Pool box displays. -3. Complete required fields (mandatory fields are marked by a red asterisk). -4. 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`_) - -|image6| - -1. From the drop-down menu, select Feature Groups. -2. Click *Add Feature Group*. - The Create New Feature Group box displays. -3. On the General tab, complete all fields. -4. Click *Entitlement Pools*. -5. Click *Available Entitlement Pools*. -6. Select one or more entitlement pools and click the right arrow. -7. Click *License Key Groups*. -8. Click *Available License Key Groups*. -9. Select one or more license key groups and click the right arrow. -10. Click *Save*. - -Create a License Agreement --------------------------- - -**Prerequisites:** Create one or more feature groups (see `Create a Feature Group`_). - -|image7| - -1. From the drop-down menu, select License Agreements. -2. Click *Add License Agreement*. - The Create New License Agreement box displays. -3. On the General tab, complete required fields (mandatory fields are marked by a red asterisk). -4. Click *Feature Groups*. -5. If not selected, click *Available Feature Groups*. -6. Select one or more groups and click the right arrow. -7. Click *Save*. -8. Return to step 5 of `Create a License Model`_ to complete the license model. - -Create a Vendor Software Product --------------------------------- - -Create one or more Vendor Software Products (VSPs) as the building blocks for VFs. - -.. note:: - For interim saving while creating a VSP, click |image2| - -**Prerequisites:** - -* `Create a License Model`_ -* Generate manifest and package artifacts. - -#. From the SDC HOME page, click *ONBOARD*. -#. Hover over Add and select New Vendor Software Product. -#. The New Software Product box is displayed. - Complete all fields. -#. Click *Save*. - The Overview section is displayed. - - .. note:: - A warning is displayed under License Agreement if the VSP does not have an associated license. - -#. Click *Software Product Details* (left pane). - - |image8| - -#. In order, select a licensing version, a license agreement, and one or more feature groups. -#. [Optional] Complete other fields, such as Availability (high-availability zones) and Storage - Data Replication (requirement for storage replication), as required. -#. In Software Product Attachments (right pane), click *Select file*. -#. Locate a Heat .zip package and click *Open*. - SDC validates the files in the package. After successful validation, SDC displays the files - and a success message. If validation fails, SDC displays the errors in the files. - - Example Heat errors: - - |image9| - -#. Click *Check In* to save the changes. -#. Click *Submit* to add the VSP to the catalog. -#. 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. - - -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. -#. In the Overview section, click *Check Out*. -#. In Components (bottom pane), 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. -#. Click *Overview* and click *Check In* to save changes. -#. If updating a VSP, click *Submit*. If this procedure is performed during the workflow to create a VSP, there is no need to click *Submit* now. - -Update a VSP [optional] ------------------------ - -Upload a new Heat package to a VSP. Afterward, update the VF 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. -#. In the Overview section, click *Check Out*. -#. In Software Product Attachments (right pane), click *Select file*. -#. Locate a Heat .zip package and click *Open*. - SDC warns that uploading a new package erases existing data. -#. Click *Continue* to upload the new Heat package. - SDC validates the files in the package. After successful validation, SDC displays the files and a success message. If validation fails, SDC displays the errors in the files. - - .. note:: - If the Heat template contains errors, contact the Certification Group for guidance on how to proceed. - -#. Click *Check In* to save changes. -#. Click *Submit* to add the VSP to the catalog. - A success message is displayed. If the VSP attachments contain errors, an error message is displayed instead. Fix the issue(s) and re-submit. -#. After updating the VSP: - #. Upload the VSP to the VF (see steps 3 to 5 in (TBD)Update a VF [optional]). - #. Update the VF version in services that include the VF (see step 4 in (TBD) Update a service [optional]). - - -.. |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 diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png b/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png deleted file mode 100644 index 27c8986e5..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png b/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png deleted file mode 100644 index 94a6743ed..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png b/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png deleted file mode 100644 index 2db64c40b..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png b/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png deleted file mode 100644 index 20fee24c0..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png b/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png deleted file mode 100644 index 9f4f1b408..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png deleted file mode 100644 index ef99406d9..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png deleted file mode 100644 index a358d03a4..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png deleted file mode 100644 index c8f293401..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png b/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png deleted file mode 100644 index dcc3104e4..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png b/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png deleted file mode 100644 index 81f1df634..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png b/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png deleted file mode 100644 index 457baa8cf..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png and /dev/null differ diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png b/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png deleted file mode 100644 index 5a5ad9496..000000000 Binary files a/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png and /dev/null differ diff --git a/docs/guides/onap-user/service-distribution/index.rst b/docs/guides/onap-user/service-distribution/index.rst deleted file mode 100644 index 4ed231047..000000000 --- a/docs/guides/onap-user/service-distribution/index.rst +++ /dev/null @@ -1,135 +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. - -Governance Approval and 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. - -**Tools:** SDC - -**SDC user roles:** Governor, Ops - -Steps ------ - -- `Review a Service for Governance Approval`_ -- `Request Service Distribution`_ -- `Distribute a Service`_ -- `Verify that the DCAE Blueprint is Deployed`_ - -|image1| - -**Figure 1. Workflow** - -Review a Service for Governance Approval ----------------------------------------- - -A member of the Governance Board performs a governance review of a -certified service and its associated VFs, and then approves (or rejects) -the artifacts for distribution. - -**Prerequisites:** Service is tested. - -**Steps** - -#. Sign in to SDC as a Governor. -#. From the HOME page, click CATALOG and select a service that is ready - for governance review. -#. Review the service and its associated resources. -#. To view deployment artifacts: - - #. Click *Composition* tab (left pane) and then click the Deployment - Artifact icon (right pane) to see the list of artifacts. - #. Click the download icon adjacent to an artifact to download and - view it. - -#. When the review is complete, click: - - - *Accept* if the service passes the governance review. The service is - marked Approved for Distribution. - - *Reject* if the service fails the governance review. The service is - marked Rejected for Distribution. - -After a service receives governance approval, it moves into the Waiting -to be Distributed section of the Operations Workspace (Ops role) - -Request Service Distribution ----------------------------- - -Request service distribution to populate all appropriate ONAP -components with the resources and artifacts ssociated with the service and its -VFs. - -**Prerequisites:** - -A service has received governance approval and is -available in the Waiting to be Distributed section of the SDC Operations -Workspace (under the Ops Role). For more information, see -`Review a Service for Governance Approval`_. - -The steps shown here are generic; each service provider has a different, -specific set of instructions. Contact your site IT support for the -particulars. - -**Steps** - -#. Open at ticket request at your site -#. Make a "DISTRIBUTION REQUEST" -#. Provide the following information in your request: - - - Environment - - Name of service to be distributed - - Version number - - [Optional] Additional information or instructions (provide special - instructions for the request) - - Your user ID - - [Optional] Alternate Contact user ID (provide an alternate contact - if the primary contact is unavailable) - -Distribute a Service --------------------- - -**Prerequisites:** The service is approved. - -**Steps** - - -#. Sign in to SDC as Ops. -#. In the Active Projects pane (left pane) of the HOME page, select the - W*aiting For Distribution* check box. -#. Select a service that is ready for distribution. -#. Review the version history to verify that the correct version is - selected. -#. In the header, click *Distribute*. - - The service moves from the Ready For Distribution folder to the - Distributed Services folder. - -#. From the Workspace pane, click *Distributed Services*. - All distributed services display. -#. Select the service distributed in step 5 and click *Monitor*. - The Distribution Report displays. -#. In the Distribution Report, navigate to the Component ID for the - service and click the adjacent down arrow. - The report shows all components associated with the service and their - distribution statuses, such as DOWNLOAD_OK. -#. Review the status of each component. - -Verify that the DCAE Blueprint is Deployed ------------------------------------------- - -The DCAE controller requires a blueprint (or guideline) to be available -at the site on which the first VNF is deployed. This blueprint is a -management workflow and configuration description for a given VNF, and -it must be available after completing the service distribution process -and before beginning the instantiation process. - -.. |image1| image:: media/design_governance_workflow.png diff --git a/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png b/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png deleted file mode 100644 index 44d6b702f..000000000 Binary files a/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png and /dev/null differ diff --git a/docs/guides/onap-user/servicecreator.rst b/docs/guides/onap-user/servicecreator.rst deleted file mode 100644 index 941bf5b46..000000000 --- a/docs/guides/onap-user/servicecreator.rst +++ /dev/null @@ -1,42 +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. - - -Service Deployment -================== -Deploy a service by following these general steps: - -* `Instantiate a network `_ -* `Gather and validate data for an infrastructure service/network `_ -* `Instantiate an infrastructure service `_ -* `Post instantiation `_ - -About infrastructure services ------------------------------ - -Infrastructure services describe VFs that are designed to meet -the need for additional capacity in the network. Service Designers -create the VFs/services that represent such capacity, and -Operations representatives trigger the instantiation of the -infrastructure service using the Virtual Instantiation -Deployment (VID) GUI. These services are based on the need for -additional capacity or the removal of deployed capacity. - -Example infrastructure service types: - - * mobile - - * layer 3 - - * layer 4+ - - * cloud - -Capacity Planning ------------------ - -Before triggering VF instantiation, -ensure the capacity and resources required by each VF in -a service are available. diff --git a/docs/guides/onap-user/servicedeployment.rst b/docs/guides/onap-user/servicedeployment.rst new file mode 100644 index 000000000..941bf5b46 --- /dev/null +++ b/docs/guides/onap-user/servicedeployment.rst @@ -0,0 +1,42 @@ + +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +Service Deployment +================== +Deploy a service by following these general steps: + +* `Instantiate a network `_ +* `Gather and validate data for an infrastructure service/network `_ +* `Instantiate an infrastructure service `_ +* `Post instantiation `_ + +About infrastructure services +----------------------------- + +Infrastructure services describe VFs that are designed to meet +the need for additional capacity in the network. Service Designers +create the VFs/services that represent such capacity, and +Operations representatives trigger the instantiation of the +infrastructure service using the Virtual Instantiation +Deployment (VID) GUI. These services are based on the need for +additional capacity or the removal of deployed capacity. + +Example infrastructure service types: + + * mobile + + * layer 3 + + * layer 4+ + + * cloud + +Capacity Planning +----------------- + +Before triggering VF instantiation, +ensure the capacity and resources required by each VF in +a service are available. diff --git a/docs/guides/onap-user/servicedesigner.rst b/docs/guides/onap-user/servicedesigner.rst deleted file mode 100644 index 0b593a8d5..000000000 --- a/docs/guides/onap-user/servicedesigner.rst +++ /dev/null @@ -1,40 +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. - -.. _user-guides-service-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. - -Design progresses logically through a series of phases. Each phase: - -* is organized into steps that are completed in sequence - -* is accessed using a different role with specific responsibilities - generates artifacts that are used in other phases of design or when - instantiating or monitoring virtual functions. - -Design includes the following topics: - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - Pre-Onboarding <./pre-onboarding/index.rst> - - Resource-Onboarding <./resource-onboarding/index.rst> - - VF Creation and Testing <./vfcreation/index.rst> - - Governance Approval and Service Distribution <./service-distribution/index.rst> - - Control Loop Design <./control-loop/index.rst> - -* `Policy Design `_ - -* `SDC Artifacts List `_ diff --git a/docs/guides/onap-user/vfcreation/index.rst b/docs/guides/onap-user/vfcreation/index.rst deleted file mode 100644 index f4c8c15ae..000000000 --- a/docs/guides/onap-user/vfcreation/index.rst +++ /dev/null @@ -1,177 +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. - -VF Creation and Testing -======================= -**Goal**: Using VSPs, create one or more VFs as the building blocks for a -service. Validate and certify the VFs. - -**ONAP Component**: SDC - -**SDC user roles**: Designer, Tester - -|image1| - -Steps ------ - -- `Create a VF`_ -- `Update a VF [optional]`_ -- `Submit a VF for testing`_ -- `Test a VF`_ - -Create a VF ------------ - -**Prerequisites:** - -- Create a license for each VF (see Create a license model) (see also the - tutorial Creating a Licensing Model) -- Create a Vendor Software Product. - -**Steps** - -#. From the SDC HOME page, click the *Vendor Software Component* icon in the - header (upper right). - - |image2| - -#. From the Import VF box, expand a VSP name and click the *Import VSP* icon. - - |image3| - -#. In the General section, complete all fields. - - .. note:: Use the letters "VF" in the name to indicate that the component is a VF. - -#. Click *Create*. - - - A message displays while VF creation is in progress. (This can take up to - 10 minutes.) - - A message displays when VF creation is complete. - -#. 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 VF for testing, click these - options to update VF information: - - .. 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 - preferred) - - 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 - 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 model (generated from the Heat template) - - 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 - -#. After creating a VF, submit it for testing (see `Submit a VF for testing`_). - -Update a VF [optional] ----------------------- - -- Update the VSP and other artifacts in a VF. -- Upload a new version the VSP to the VF whenever the VSP is updated (see steps - 3 to 5). Other reasons for updating a VF include: - - - artifact changes at the VF level that need be uploaded, for example, - changes to ENV values (see step 6) - -**Prerequisites:** - -- `Create a VF`_. -- If the VSP was updated: Update a VSP [optional] - -**Steps** - -#. From the SDC HOME page, click *CATALOG* and search for a VF. - -#. In the General section, click *Check Out*. - The Select VSP field is displays. - -#. In the Select VSP field, click *Browse*. - The Import VF box displays and shows the VSP that was used to create the VF. - -#. Expand the VSP field and click. - - |image4| - -#. Click |image5| - A progress bar displays. |image6| - -#. 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. - -#. After updating the VF: - - - Submit the VF for testing (see Submit a VF for testing). - - Update the VF version in any service that contains the VF - (see step 4 in Update a service [optional]). - -Submit a VF for testing ------------------------ - -**Prerequisites:** `Create a VF`_ - -**Steps** - -#. When a VF is ready for testing, click *CATALOG* and service for the VF. -#. Click the VF and click *Submit for Testing*. - - |image7| - - |image8| - -#. 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. - -#. Add the email addresses of the people on the Certification Group for this - site with the *Tester* role and send the email. - -Test a VF ---------- - -Test the design and artifacts of a VF. - -**Prerequisites:** `Submit a VF for testing`_. - -**Steps** - -#. Sign in to SDC as a *Tester*. -#. From the HOME page, select *Ready For Testing* under Active Projects. -#. In the right pane, click the VF. -#. Click *Start Testing*. -#. Test the VF. -#. When testing is complete, click *Accept*. - -.. |image1| image:: media/design_vf_workflow.png -.. |image2| image:: media/image2017-1-27_11-13-30.png -.. |image3| image:: media/image2017-1-27_11-14-3.png -.. |image4| image:: media/image2017-1-27_11-17-18.png -.. |image5| image:: media/sdc_artifact_update.png -.. |image6| image:: media/design_vf_updatevspmessage.png -.. |image7| image:: media/image2017-1-27_11-20-13.png -.. |image8| image:: media/image2017-1-27_11-21-4.png diff --git a/docs/guides/onap-user/vfcreation/media/design_vf_updatevspmessage.png b/docs/guides/onap-user/vfcreation/media/design_vf_updatevspmessage.png deleted file mode 100644 index bf401daac..000000000 Binary files a/docs/guides/onap-user/vfcreation/media/design_vf_updatevspmessage.png and /dev/null differ diff --git a/docs/guides/onap-user/vfcreation/media/design_vf_workflow.png b/docs/guides/onap-user/vfcreation/media/design_vf_workflow.png deleted file mode 100644 index d3e831229..000000000 Binary files a/docs/guides/onap-user/vfcreation/media/design_vf_workflow.png and /dev/null differ diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png deleted file mode 100644 index 7bf32d4fc..000000000 Binary files a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png and /dev/null differ diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png deleted file mode 100644 index 5a8d190a8..000000000 Binary files a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png and /dev/null differ diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png deleted file mode 100644 index d12ca8fec..000000000 Binary files a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png and /dev/null differ diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png deleted file mode 100644 index 82392a742..000000000 Binary files a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png and /dev/null differ diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png deleted file mode 100644 index 594664344..000000000 Binary files a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png and /dev/null differ diff --git a/docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png b/docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png deleted file mode 100644 index 266d965f8..000000000 Binary files a/docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png and /dev/null differ -- cgit 1.2.3-korg