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