4ed2310474690d03c6b514c505d70f3325816eb4
[doc.git] / docs / guides / onap-user / design / service-distribution / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2 .. International License. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2019 ONAP Contributors.  All rights reserved.
4
5 Governance Approval and Service Distribution
6 ============================================
7
8 Each ONAP platform operator will have a specific set of policies
9 and procedures for approving Services and deploying them in the
10 operator's ONAP environment. This outline describes the general
11 flow of such procedures.
12
13 **Goal:** Add all information required to create, instantiate, and
14 manage a service.
15
16 **Tools:** SDC
17
18 **SDC user roles:** Governor, Ops
19
20 Steps
21 -----
22
23 - `Review a Service for Governance Approval`_
24 - `Request Service Distribution`_
25 - `Distribute a Service`_
26 - `Verify that the DCAE Blueprint is Deployed`_
27
28 |image1|
29
30 **Figure 1. Workflow**
31
32 Review a Service for Governance Approval
33 ----------------------------------------
34
35 A member of the Governance Board performs a governance review of a
36 certified service and its associated VFs, and then approves (or rejects)
37 the artifacts for distribution.
38
39 **Prerequisites:** Service is tested.
40
41 **Steps**
42
43 #. Sign in to SDC as a Governor.
44 #. From the HOME page, click CATALOG and select a service that is ready
45    for governance review.
46 #. Review the service and its associated resources.
47 #. To view deployment artifacts:
48
49    #. Click *Composition* tab (left pane) and then click the Deployment
50       Artifact icon (right pane) to see the list of artifacts.
51    #. Click the download icon adjacent to an artifact to download and
52       view it.
53
54 #. When the review is complete, click:
55
56    -  *Accept* if the service passes the governance review. The service is
57       marked Approved for Distribution.
58    -  *Reject* if the service fails the governance review. The service is
59       marked Rejected for Distribution.
60
61 After a service receives governance approval, it moves into the Waiting
62 to be Distributed section of the Operations Workspace (Ops role)
63
64 Request Service Distribution
65 ----------------------------
66
67 Request service distribution to populate all appropriate ONAP
68 components with the resources and artifacts ssociated with the service and its
69 VFs.
70
71 **Prerequisites:**
72
73 A service has received governance approval and is
74 available in the Waiting to be Distributed section of the SDC Operations
75 Workspace (under the Ops Role). For more information, see
76 `Review a Service for Governance Approval`_.
77
78 The steps shown here are generic; each service provider has a different,
79 specific set of instructions. Contact your site IT support for the
80 particulars.
81
82 **Steps**
83
84 #. Open at ticket request at your site
85 #. Make a "DISTRIBUTION REQUEST"
86 #. Provide the following information in your request:
87
88    -  Environment
89    -  Name of service to be distributed
90    -  Version number
91    -  [Optional] Additional information or instructions (provide special
92       instructions for the request)
93    -  Your user ID
94    -  [Optional] Alternate Contact user ID (provide an alternate contact
95       if the primary contact is unavailable)
96
97 Distribute a Service
98 --------------------
99
100 **Prerequisites:** The service is approved.
101
102 **Steps**
103
104
105 #. Sign in to SDC as Ops.
106 #. In the Active Projects pane (left pane) of the HOME page, select the
107    W*aiting For Distribution* check box.
108 #. Select a service that is ready for distribution.
109 #. Review the version history to verify that the correct version is
110    selected.
111 #. In the header, click *Distribute*.
112
113    The service moves from the Ready For Distribution folder to the
114    Distributed Services folder.
115
116 #. From the Workspace pane, click *Distributed Services*.
117    All distributed services display.
118 #. Select the service distributed in step 5 and click *Monitor*.
119    The Distribution Report displays.
120 #. In the Distribution Report, navigate to the Component ID for the
121    service and click the adjacent down arrow.
122    The report shows all components associated with the service and their
123    distribution statuses, such as DOWNLOAD_OK.
124 #. Review the status of each component.
125
126 Verify that the DCAE Blueprint is Deployed
127 ------------------------------------------
128
129 The DCAE controller requires a blueprint (or guideline) to be available
130 at the site on which the first VNF is deployed. This blueprint is a
131 management workflow and configuration description for a given VNF, and
132 it must be available after completing the service distribution process
133 and before beginning the instantiation process.
134
135 .. |image1| image:: media/design_governance_workflow.png