[DOC] Fix tox docs-linkcheck profile issues
[doc.git] / docs / guides / onap-user / vfw-design-tutorial / 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 © 2017-2020 Aarna Networks, Inc.
4
5 vFW Service Design Tutorial
6 ###########################
7
8 Browser settings
9 ================
10
11 This exercise will use the ONAP Portal. To interact properly with Portal services, please make sure to set the
12 following settings in your Firefox browser before starting the Service Design and Deployment.
13
14 Check your Firefox browser setting to make sure that Remote Proxy DNS setting is on
15
16 * Type "about:config" in the address bar
17 * Select "Accept the risk"
18 * In the Search enter Proxy
19 * Enable "network.proxy.socks_remote_dns  = true" (Just double click to change the flag)
20 * Please make sure to undo this change after testing, since this could cause potential security risk!
21
22 Check your Firefox settings to allow mixed contents
23
24 * Type "about:config" in the address bar
25 * In the Search enter Mixed
26 * Click on variable security.mixed_content.block_active_content
27 * Change the value to False (Just double click to change the flag)
28
29 Below are the portal URL & User Login details to connect to the ONAP portal
30
31 https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm
32
33 User login credentials and roles
34 ::
35
36   Username=cs0008, password=demo123456!, Role=DESIGNER
37   Username=demo,   password=demo123456!, Role=ADMIN
38
39 .. note::
40   From F release onwards, service design and deployment can be done with cs0008 and demo users
41
42 Ex: To open portal URL from FireFox browser and accept SSL certificate exception after the settings
43
44 |image8|
45
46 Login into the portal as designer (cs0008) and enter password (demo123456!) then click on LOGIN
47
48 |image21|
49
50 Service Design & Distribution using SDC GUI
51 ===========================================
52
53 In this section, you will learn the following through the SDC GUI
54
55 * How to create a Vendor License Model
56 * How to create and onboard Vendor Software Product
57 * How to create a Service
58 * How to distribute a Service
59
60 Let us start by creating the VLM
61
62 1. Create Vendor Licence Model (VLM) in SDC
63
64  A. Login to the ONAP portal as designer cs0008 / demo123456!
65  B. Go to SDC → ONBOARD → WORKSPACE → CREATE NEW VLM (Enter below attributes and Create)
66
67  |image35|
68
69  |image34|
70
71  C. Create New License Key Group
72
73  |image15|
74
75  D. Create Entitlement Pool
76
77  |image38|
78
79  E. Create Feature Group (Assign Entitlement Pool & License Key Group in other 2 tabs)
80
81  |image5|
82
83  |image40|
84
85  |image27|
86
87  F. Create License Agreement (Assign Feature Group under the Feature Group Tab)
88
89  |image32|
90
91  |image9|
92
93  G. Click Submit (Top Right Corner of the page) and fill comment then press Commit & Submit
94
95  |image7|
96
97 2. Create Vendor Software Product (VSP)
98
99 Prerequisite: Download VNF Heat package from gerrit
100
101 .. code: bash
102    git clone "https://gerrit.onap.org/r/demo"
103
104 and copy the required HEAT package & use it while upload the package
105
106  A. Go to SDC Home → ONBOARD → WORKSPACE  → CREATE NEW VSP (complete all the fields, click on Network Package
107  checkbox then click create)
108
109  |image22|
110
111  B. Assign the license Agreement by selecting the Missing icon
112
113  |image20|
114
115  C. Select the Licenses drop down box (populate all three fields)
116
117  |image24|
118
119  D. Go to Overview (Left hand side bar), select Software Product Attachments in the right pane, click Select file
120
121    Import HEAT package (ex: vfw_demo.zip) by clicking Select File Button. This file should be copied to your
122    local workstation where the browser is running.
123
124  |image37|
125
126 It will take you to the setup page
127
128 |image25|
129
130  E. Click on “PROCEED TO VALIDATION” and ignore warnings
131
132  |image17|
133
134  F. Click Submit (right corner), fill the comment then press COMMIT & SUBMIT, you will see submit successful message
135
136  |image3|
137
138 3. Import Vendor Software Product and certify
139
140  A. Go to the SDC Home page click Import VSP button
141
142  |image13|
143
144  B. From the Import VSP box, expand a VSP name and click the Import VSP icon
145
146  |image39|
147
148  C. In the General section, complete all fields then click create (top right corner)
149
150  |image43|
151
152  D. Click Check In to save changes (top right corner), enter a comment and click OK
153
154  |image29|
155
156  E.  click CATALOG and search for the checked-in VF, you will see your VF In Design Check In state
157
158  |image10|
159
160  F. Click the VF and click certify (top right corner), enter a comment then click OK
161
162  |image11|
163
164  |image31|
165
166 4. Create a Service and certify
167
168  A. Go to SDC UI → Home Page and Select the Add Service Button
169
170  |image44|
171
172  B In the General section, complete all fields then click Create
173
174  |image19|
175
176  C. select the “Composition” Menu on the left hand side menu bar
177
178  |image41|
179
180  D. On the Composition Page, Search for the vFW_demo service (look under Application L4+)
181
182  |image14|
183
184  E. On the Composition Page, Search for  Generic NeutronNet (look under Generic/Network Elements)
185
186  |image26|
187
188  F. Drag and drop vFW_demo created earlier during onboarding & the Generic NeutronNet onto the right hand side palette
189
190  |image1|
191
192  G. Connect the elements by connecting + signs and Select appropriate options for
193  Requirements and Capabilities, click Next then click Finish at the end
194
195  |image33|
196
197  |image2|
198
199  |image23|
200
201  |image36|
202
203  H. Click Check In to save changes, Enter a comment and click OK
204
205  |image6|
206
207  I. click CATALOG and search for the checked-in Service, you will see you service is in
208  Design Checkin state
209
210  |image28|
211
212  J. Click the Service and click Certify, Enter a comment and click OK, you will
213  see certification succeeded message
214
215  |image31|
216
217 5. Distribute the Service
218
219  A. From the SDC HOME page, click CATALOG and search for the service
220  (it will be in Waiting For Distribution state)
221
222  |image18|
223
224  B. Select the service that is Ready for Distribution, click Distribute (top right corner)
225
226  |image30|
227
228  |image12|
229
230  C. To Monitor Distribution, click on Distribution on the left pane
231
232  |image41|
233
234  |image16|
235
236
237 .. |image1| image:: media/image1.png
238 .. |image2| image:: media/image2.png
239 .. |image3| image:: media/image3.png
240 .. |image5| image:: media/image5.png
241 .. |image6| image:: media/image6.png
242 .. |image7| image:: media/image7.png
243 .. |image8| image:: media/image8.png
244 .. |image9| image:: media/image9.png
245 .. |image10| image:: media/image10.png
246 .. |image11| image:: media/image11.png
247 .. |image12| image:: media/image12.png
248 .. |image13| image:: media/image13.png
249 .. |image14| image:: media/image14.png
250 .. |image15| image:: media/image15.png
251 .. |image16| image:: media/image16.png
252 .. |image17| image:: media/image17.png
253 .. |image18| image:: media/image18.png
254 .. |image19| image:: media/image19.png
255 .. |image20| image:: media/image20.png
256 .. |image21| image:: media/image21.png
257 .. |image22| image:: media/image22.png
258 .. |image23| image:: media/image23.png
259 .. |image24| image:: media/image24.png
260 .. |image25| image:: media/image25.png
261 .. |image26| image:: media/image26.png
262 .. |image27| image:: media/image27.png
263 .. |image28| image:: media/image28.png
264 .. |image29| image:: media/image29.png
265 .. |image30| image:: media/image30.png
266 .. |image31| image:: media/image31.png
267 .. |image32| image:: media/image32.png
268 .. |image33| image:: media/image33.png
269 .. |image34| image:: media/image34.png
270 .. |image35| image:: media/image35.png
271 .. |image36| image:: media/image36.png
272 .. |image37| image:: media/image37.png
273 .. |image38| image:: media/image38.png
274 .. |image39| image:: media/image39.png
275 .. |image40| image:: media/image40.png
276 .. |image41| image:: media/image41.png
277 .. |image43| image:: media/image43.png
278 .. |image44| image:: media/image44.png