diff options
Diffstat (limited to 'docs')
55 files changed, 312 insertions, 0 deletions
diff --git a/docs/guides/onap-user/service-distribution/index.rst b/docs/guides/onap-user/service-distribution/index.rst new file mode 100644 index 000000000..4ed231047 --- /dev/null +++ b/docs/guides/onap-user/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/service-distribution/media/design_governance_workflow.png b/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png Binary files differnew file mode 100644 index 000000000..44d6b702f --- /dev/null +++ b/docs/guides/onap-user/service-distribution/media/design_governance_workflow.png diff --git a/docs/guides/onap-user/vfcreation/index.rst b/docs/guides/onap-user/vfcreation/index.rst new file mode 100644 index 000000000..f4c8c15ae --- /dev/null +++ b/docs/guides/onap-user/vfcreation/index.rst @@ -0,0 +1,177 @@ +.. 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 Binary files differnew file mode 100644 index 000000000..bf401daac --- /dev/null +++ b/docs/guides/onap-user/vfcreation/media/design_vf_updatevspmessage.png diff --git a/docs/guides/onap-user/vfcreation/media/design_vf_workflow.png b/docs/guides/onap-user/vfcreation/media/design_vf_workflow.png Binary files differnew file mode 100644 index 000000000..d3e831229 --- /dev/null +++ b/docs/guides/onap-user/vfcreation/media/design_vf_workflow.png diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png Binary files differnew file mode 100644 index 000000000..7bf32d4fc --- /dev/null +++ b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-13-30.png diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png Binary files differnew file mode 100644 index 000000000..5a8d190a8 --- /dev/null +++ b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-14-3.png diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png Binary files differnew file mode 100644 index 000000000..d12ca8fec --- /dev/null +++ b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-17-18.png diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png Binary files differnew file mode 100644 index 000000000..82392a742 --- /dev/null +++ b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-20-13.png diff --git a/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png Binary files differnew file mode 100644 index 000000000..594664344 --- /dev/null +++ b/docs/guides/onap-user/vfcreation/media/image2017-1-27_11-21-4.png diff --git a/docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png b/docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png Binary files differnew file mode 100644 index 000000000..266d965f8 --- /dev/null +++ b/docs/guides/onap-user/vfcreation/media/sdc_artifact_update.png diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git -Subproject 096803ce0a8f4a57cc2f78f7d969cab18cb7a93 +Subproject 513471c517baae37437dca2d1af6d2bdb31ab12 diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git -Subproject 1e6ea4bd794c8e84dcdb20be7a028bcdedb2dff +Subproject 9fe1f66fe72cbb008c063dae9d60f377d3dfd41 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject 38a4d515a8414e83a3724bccbb5ab83cd50d7df +Subproject d1bddabef57ab3582d1b1c045c0554d1e476e52 diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject cd9e460cfa7cbd090156045711c4d95efa6765b +Subproject 7480619227377cade2f2119865a87b41641314c diff --git a/docs/submodules/ccsdk/apps.git b/docs/submodules/ccsdk/apps.git -Subproject 79903ae40b4f23a95b200f2ca045475c9c9becb +Subproject 16a34aeeebad1775ea4a6675c19f041b273dcdf diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git -Subproject f2136a47fd53fcbdc117899c6e134d7ceea46d8 +Subproject f6aba62c7ee10eb14e9db2aaf1dc7676ccc130f diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject c6e85bc88f2dd3427360523270c7ed92c12abdc +Subproject b594a9b61a49ccb3a53be0807fb090da3f60651 diff --git a/docs/submodules/ccsdk/features.git b/docs/submodules/ccsdk/features.git -Subproject 7ab848ccda31cef44d4a817f22f2edd5a3d4a20 +Subproject c013cb97ea71ed746d31c5d822d57c5679fe206 diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git -Subproject 9dcd199fa355a3f3cd9e52c0b63aee01988301e +Subproject e8e914a2d6fbefe2ab403af1ec43f60623edc5f diff --git a/docs/submodules/ccsdk/utils.git b/docs/submodules/ccsdk/utils.git -Subproject 1e65a92a826ef75e03b33ffceb72d8357ec88cc +Subproject 950f9e1ca067c45ba74933030ebf715206bb601 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject a1ec959e3f5f8639117a5134ffbfb59f7b542f8 +Subproject cc58619d3f4410f47c0d6fa8ac25e3aa7ca5143 diff --git a/docs/submodules/cli.git b/docs/submodules/cli.git -Subproject 26fc3d01a9be64e10cbeb814559fd98fefbd7ba +Subproject 70d51414231a0d4f6010e40646386e3b740a7e0 diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject 701110ba1719151a20393ced327e4e935d991ad +Subproject 9f58a5d51f8945b4813227957edc8e49451c1ec diff --git a/docs/submodules/dmaap/buscontroller.git b/docs/submodules/dmaap/buscontroller.git -Subproject 0494603a4624d391af8b5a3918555ea7e47ffa1 +Subproject 08b47104ed2dfa350fc3e239cb8bfaff932a474 diff --git a/docs/submodules/dmaap/datarouter.git b/docs/submodules/dmaap/datarouter.git -Subproject bceb18df30982e2ace538baf5c49336fe0e45b0 +Subproject bb01feceff0527c8f63ad513d85975e5c4e2e52 diff --git a/docs/submodules/dmaap/dbcapi.git b/docs/submodules/dmaap/dbcapi.git -Subproject 40e1e60eb8d8cc18d8542dbd7c00f69a9cc3042 +Subproject 682f1965193e672620bc8766fec6bcb2648aa8e diff --git a/docs/submodules/dmaap/messagerouter/messageservice.git b/docs/submodules/dmaap/messagerouter/messageservice.git -Subproject c0415134c3d9bfd028fb2bd98291a95d39dcab1 +Subproject edecb4c2e01f0f55e17cf8982dfde0164469c29 diff --git a/docs/submodules/externalapi/nbi.git b/docs/submodules/externalapi/nbi.git -Subproject 0095af54a51619546e6ab9783adff625b696f4e +Subproject 4e864e25383896e6a04d608b86fed31c23b7f3c diff --git a/docs/submodules/holmes/engine-management.git b/docs/submodules/holmes/engine-management.git -Subproject f99ee485e1973ab462d8a0ccd86e2240109d85d +Subproject ca5ee016903924350111f39daef36018dd0a065 diff --git a/docs/submodules/holmes/rule-management.git b/docs/submodules/holmes/rule-management.git -Subproject e19a1115bb056b002b42c7b15afa0226877c7f4 +Subproject 3c487f863a32c2fe7399298e071414811e33647 diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject 6eaaedc4d320b4e032beb958123ee00f5cf9a7a +Subproject 12750c04bc340ac2e4cf4497bc31323f9d1811e diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git -Subproject 4c9735f80c983573c08c708307e1d03c84140d6 +Subproject 62dfa44900b49551f83b1e215fbf8b7d940f23a diff --git a/docs/submodules/msb/swagger-sdk.git b/docs/submodules/msb/swagger-sdk.git -Subproject 617f07b4e70b297de558b4e62ed58acc6cf706a +Subproject 4cd47877f91e4ca261115a8d8411c2f91e7456c diff --git a/docs/submodules/multicloud/azure.git b/docs/submodules/multicloud/azure.git -Subproject 2fbd078605c199e49118037747325e833318ef5 +Subproject 78c9d578f5e35015cc5746c2275590f43b4127c diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject 388ef1f2943d5fb581cd6533e1fc225a0309df7 +Subproject 51d1d3a0c0009a58f79cc7642a2777833d9c5d5 diff --git a/docs/submodules/multicloud/k8s.git b/docs/submodules/multicloud/k8s.git -Subproject 63933b0cf304cfdd49fc73278d9c64dcb48f90e +Subproject 619ccde3c59cdbf5066a667d2bbea465d4a6898 diff --git a/docs/submodules/music.git b/docs/submodules/music.git -Subproject 4c8d63c24acd45a9ae19af0434848c273f470ae +Subproject 9a8b8ae8d7c8d6931f99def68068f8936a8cc0b diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject 99b4523cfe191ab8d1f0d82bb68ab1605f881da +Subproject 96080d06124ab60ce9642a840e8b9b9ca15b253 diff --git a/docs/submodules/oom/offline-installer.git b/docs/submodules/oom/offline-installer.git -Subproject 8cbef61dee77ba2a77120b9b512e4e6971fa2af +Subproject 3dc563b8f1d42daf3e6455b40b63525c37001ba diff --git a/docs/submodules/optf/cmso.git b/docs/submodules/optf/cmso.git -Subproject d4014abb85d839c14c9a2572098571e7a852310 +Subproject 7e459e2f5cdd50e85a3242b9400d561b83647af diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git -Subproject d6be402c0765aee388bc5dc64882696a0a23be2 +Subproject 268968846d94239d800240b3540173f2e5d4d23 diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git -Subproject 0a358ab8f3f546f11c36f913018edef63ff17ed +Subproject e817f0f5ad80a48fb54407c4be4951b093d2cb3 diff --git a/docs/submodules/policy/apex-pdp.git b/docs/submodules/policy/apex-pdp.git -Subproject ca558cfb1ea47de081527771af47abb37a8cd96 +Subproject 62bc4a162b169971349bce415f97ace15c15eee diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject b38e59b1f797b15d0a3e1170e43a0db92216bbd +Subproject cf915641e6476ff74761dd71601add65a8762e1 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git -Subproject a543a773266e13155d739e00c4b9d4b0d1529ab +Subproject 10df99f8ffc45b03f5557a30eec5bcc307503cc diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject 9142d9cea9f033c798c7f669df05e0f6f5b6320 +Subproject a39129f4712805698b596da57459d980a7b4f33 diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git -Subproject 9c48804399cb73b135b3f1c7a321b225635caf2 +Subproject c6bdb4e477d0ad6b146ce811f32fc8356c12a22 diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git -Subproject 797f2333a91eb3de6fdbc8260e02f39e6b99e80 +Subproject 7b30b7a2becb47823067526bd8c84af9155ac7a diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 9a1a01dd07e5a64422bca75fa22ea36daa1d88d +Subproject 0502bae356e44cb381cd7ec0f72c7b2bd6429e8 diff --git a/docs/submodules/so/libs.git b/docs/submodules/so/libs.git -Subproject 25990a8c079094f906414c4583ec7b0dd81b4d3 +Subproject f9b78e1d7ca2b64badd8529aa4600250387ddae diff --git a/docs/submodules/usecase-ui.git b/docs/submodules/usecase-ui.git -Subproject 8aff6d8cbc022cbe4db09cabe096f463aa98b00 +Subproject 76cafb66f1897b971736a9c9bdf2e8f0fd5a957 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject 22631f12c6029a38be6cb3acdc21e6f8f6400f6 +Subproject 669ef8d8b4f9b9170d0710bc92ac621fe27fcb8 diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject f3b31fe846630953923844ed3ab7defea9ac444 +Subproject 4b49617c80ada42ee41f3eb118898f7872f794e diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git -Subproject 3422870a179cdeed4df9631faa08357d28da5c7 +Subproject 09bbd2f9f5cdcf84b18ff1be53caec852f33124 |
