From eb86a84f25a0ae78e0ad21b03853305fd231f696 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Thu, 18 Apr 2019 11:35:46 +0000 Subject: [PATCH] Migration of Service Design from Wiki to Readthedocs User Guide Source: https://wiki.onap.org/display/DW/Governance+Approval+and+Service+Distribution Corrections to suppress OpenECOMP and USH Portal references Issue-ID: DOC-438 Change-Id: Ic678210cf882a15f248d17664d3f89631fcbc2ee Signed-off-by: Eric Debeau --- .../onap-user/service-distribution/index.rst | 135 +++++++++++++++++++++ .../media/design_governance_workflow.png | Bin 0 -> 9962 bytes 2 files changed, 135 insertions(+) create mode 100644 docs/guides/onap-user/service-distribution/index.rst create mode 100644 docs/guides/onap-user/service-distribution/media/design_governance_workflow.png 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 new file mode 100644 index 0000000000000000000000000000000000000000..44d6b702ff0bcdbbf41b852f2cf0e31f64fffb1c GIT binary patch literal 9962 zcmb`tWmubC^Dhd;3PnnwE$)E;ZE<%m!Ci|4cXyWp!6`wDQ{1IUv4@i4?p7#);!c53 zY^Trvyyv{<g2q`ULge zzmo9<^@HxAsUVG3J5IHS8erN;sYs!rH6%T|Gsi-Wab4dTc%Y#X_Wk{!54eCe8>Z8j`Hk1lAan2=p?yU=X+o8lQ%7AvssiMs_v@6n=gS>&;1upz;~G?~V{} z;yF1SJsiC~KJMr^c|ZpL9$d@H&CR{`yUIE_JPzP+@!x7!q<5*$=^s81n)F4OuetMapGqnvO;lQc>6$)YNVihIPs>i3JO&wl`UfXtMgP~_ z4a5Rb1Kv(Tf2tmraM%;57yaD*-E}ebdyC*REBT051Y-*qJx9>5F&H;t&Vf6(J`Te2=z9|7gOG<=OKMaXT_# zXaD>b4b7mz_1EGoWfchL-bS0>wsh@bTPpj@#Bah_HuXSIb#rY|J+~`~nI$7xA zHAq^^d~T)AF#ekmJKx(DJnHfZxgx7BUfOae_T9&OA|!?zt>DGzaY)u!bJ;qvRc`x| zUv@>S^I}hZJ*ZL=`g0wPlg1aduP*5i2dAW4*27$DCV*C-V;C(|m+si_PfJYW_|chN zcE$SoJj-x_@hS3n#myKdRsetT1dK09^RyV=uS@{OfVJ&QLeU2?)DdhLz*=E-2--Os ztZi5lT15yW3l&8J)^e*ODlvfAbVR5*{Qp|6MGZVQ{vls|Oe#kg3W#XbieHTeWaRoU zn5TnB2YUVL@1M*W+lHva955BgMcHV^Y>I`J-OGhxWS`ZB+zK*B(i?IJUN?!X-^Li=wjmz|Sjx9?`+47??wQo}Ir z>r}O1Py+^yxSZCPP{X>n;n6BWVE9zbC%&)y?b5`8S!pO`57*g7Em*8x(3h){6ELN7BAqM|A~Cj6LauG{FuVz7H4JUvIU`zUdPv2z@LKQisXU6bF|SGe>OlH zetWoVL(G@k$rvTUze0}NA+wJL#NJ~#mu&YY@6@d!IfC7lhukc4co~@>p*tJn;ui6d z+#swq442nYZoMZuo<%v#lQje=Dd$$GOg6FPFhRQrNy(!^UVFL8>IHC(p=_u3#+Nwa z*#h}L8t(YR^%#~V@O}kA1g>D!e0=3$Fb{DJW_5!JWAgaMkG(|5ssD)YQzs_F>-0(r z#|-ZR+UP$vb%mYUFj;-+aivUcDY*8m96JO-!}l!S!^&03Xtk zVel3B%gRxkCp_C|J#~H0+EV(Y=*2H$%c4a7Bw>6Yd{`D=({ zwsWUjf>~p`+=g5H-O=Z&8l3rm$w!#2My`nYcExC*F)oK$pNo!<46RC$y$TB#p8Z)L z#H|ZSL^6FDsNF}V5wS|NEm{G8hW!&=qk|NI3wiG6M$uNb8we#_#4oo{mERtQO+e;n zg{yq}%~%LfCX7#<5n}FcN)Ai9dww{(&ABxMk2aeXiNFLOhKgw7HuHh-`8chOsT726 z-Az@)@-SFPa{ru~JP~8F{0w)r3`-&%l{cwNGNKlmBco;fN$QsD$UG9*SEa|_M=y*U zue~?sE?>fwXXZP=9=(r=;W#^+Sp6T`+N_Glx6!8;!#qZ*v$Q(M$Vh-lxlrfJC&Yk> zGRJ&?%J*CJfjH;*#T5r~1h0G2YaD-m)os4&qiuyV)mf)h{ItbLY|AQL`F%k!aF=vN z$}wb;k*!mF(J0|3G5#fpx`*i3I}P%OL-~Zer(WZ`4^IgT;B-2Uuc|gFYOTU=L1{lr zoJC@eGN3Y%6XIb(1;I+UifJwe+~1g(V2g^Jw*HHrROl~MYV=YJ4$PArPaPg3m$f@H zCx8B^S}0VM2P@l-ljbuZH86^ssY}h=VwY-mr%%I)jZ9pQR3KDEElqhEbVOQ}GI>AB zH6+3h;x8q_u|Qn!D39DObq2h53Xn+!nLX#7Ksy)0T8Mi(a93KaJk){kFon{cS~~79?4% z0FK5R=4FzI3UdDmXw0a`j2Q~hqXu!Isi1rj7Zu?CcY@ykW{mv5w7f`>fb9 zLZD3Ug)OlP+gYKK1*yWHI#9$DX}iIT6o8g?*yxZX^fsEsub^z_mE4O#oF!H+m3aqY z?Bn~XjTXLJe53Q+`=ribZ;y3O=I}#kC7joxr|o3;JR^}(YD@mI`PH-P92pX~fuR%y zf!vOrA!o*LOQjIk(+1Pr^`#K4X6&rwD8NkopXC(#?Duwwd_~IM>tBlAytL*eLn}OXIz8T_?+d+@jIR*b-eHlWhM;F)EgNr3nH)D>s5g zdBv4RSQ!i67T;v)S|i>~;!W!yP;y@POghMR6;AOsI8RtjVZF=Z1S>l*8tPJ-<5_r; z&g+X95H-oz?txAVg3?sxOw!4Z?m_{ArwgN^#g$ ze1NjV@tr30(;W}=kNg5AP1J4+kkCAZY03Cc_F;>#Q#n&h`o*1tX@|MW*c z2Npv%zyez>q5u$mOU{f3c@wy%9c=EiD8gyj0ObjreR}^QulOi`STPG|jTA(%(0v5v z0Tk}fI&gf{*6uyerEP)CeM!QWk`OS}!$`oPb7uNlooP}fTtBxYtPp6iLS#@zzLM z&0kh-ZUd&$GV$w50R!rY-MUxl1Nx%kQ9N9aCOAfb!<9|u&dJ5 z7;ti>!-Nq7>B_R3gQKv{aD^bZniyw$9eGh2M>s-_k&A2xl z&p*8cvY&M&SV9Zo#NBgJDQSLqz;RkAtJ{_Yb7Bb`VM!;1I{NnjTsf*3Ck6imI>Wq8 zOQJ9YzEgDj%k^o9@?nX6sOyBpX`UbkKnpRb##hYFl^69_!1GXflW3GzOTfsvB87NecNP=OFWYgx6hmH%lwkqHVpRfv>Ggx$ZvOcGbAp=Fl zOqqL2Rwe6*dN=q)iIpVMM%z$a-fuk#SJ(i->XsAYCtL*B#MQ-SDutWdoH9G2LeT#( z%{-0N%hX1B00!co&yeYWHjk7ALlI@!Gyl%7CtAxuz{;`@)4H-oSI1+&ezcmu4cMLB znz^5$Uf7PZK8{I_q$`Je)>-(98+4qEDfJJUN7V@Nbp^X#E!JQWf7FNHP3sC8ozK!+ zjB@tT?Bx~(9#UlG6JDc%@&M5xxug^6E&2T7uSV+?ZcFEL^9v>8lHm-BK-FtgLZrFN zN{dlFXN%?SVjKn!16#sVHaGvrL5il3)%B}+6^nm3Gc-OXjmzolReb)f2E%iZu)%+^ z-B{Am-={ot2FrZ6x86;9wLj255Z3Ov^ssVI!nNK3tbohr&xfo^qDM;mg#o{sxJV6)v-Q@|VrD`Q*3qCrBHgdcn1hfIwGnRsXWqqCcb8 z{w)M+-2M1Gju&$2Nv4bJ=M5VO!4|;DVUHaqi1ii`LMW=-RPwY3HHD#?n(c9>5Fv zxed<``3KR~dE4?-S+?j=RSDz}@>oR1@U)kwY~Y6K{iBzRBam6spJ&k{SU(VZGA5+~ zI&iCBka0|r^gB2?wH`o{@>t)N67&#_gA*0ZBL4O%PR*?Exj-j#HCXxcS*`iS6gwo4 zj*6*2P~*$Ze$G>6Qd_w+q(vo1SD-RJVPw>C7AWT0XYO{h%Npi;y6uTDedZge)I%or zl)zM2!kgjTMT)r&4!av!zKt*FZvn0^JqACPA+*9l)uP{Op$l&XkUHEM0Ft5LHy2ss z&mfj`ct<;nOb@o}uo$rH$J}B&gFvsXbTaa%1V1>>doV5)>Rh&ne3L*kJpLR3po?~+1e0>afx+E6Njh|=|RonDNt{g z!?3gn4&R*(%#je%JG`E!*%kFu2^4%z{Sf+fqf0vo$ebOrfZST?A+~tZP$1Z^Z&gLr zAw0E($h6+!(Q}SP58FM(nf1!k;H!hnq7Vr)ZCKz<+Gg^G^-rSm;@}bPH$djnomZPZ zJi+^?i5~hv0&<#QWyfR6#H_VP&!3-iGvJ|;#@Tuhh;1PMl|!+FFHMt2lc--&?@Ey@ zEVDpIZ`739wCO}GB-W>I?4t;9o9Zj?OV&rb{>OVg?A_Fyu;&5_;b7%SQ5vuJmn;Vp zEl%V&LpN?*bk8$T`(@%P->t_!7Kex|qg;cxJ*F_U&9W4Z`2(wF#Y1R%|E4?S#38`L z_7^ecR|EG-IMwi@f{BFD<1k%su-kgtRE1x*X90XHwHn}I+ul`bQScD^=}ME*Ua_nc zT@v~!dNmUUAmLTfDw=y#nL!ys52SAob+JuFO4~#O1k_M(*oAXEdv5oX^oHqTU-yg$ zhKMQ12#CO|qV2j6+#d{eCpTMrxe=ZbauuqSmhWH5D~8I&b@&v*p(qHa^e39d&P%Sr zsACg>0)I0hcAxBL*BPP!ELiPaQo!_NCawJ`OO=M=58Pve%~A|1X+__Ebf_af51K%M zOhY2KE}E`Gwpj8W98Qy>%1sTnZr5*Nf~>KHaPv?Ai*zNJ3LE66nM^sOj^J$8hN_8P zORiMb6sda}mjAm#4hZu-sO0~ElP5yIFO|H?#`Vec#q;k`$&?qRaDQe%CB&aNk+pEY zK^;O1a?=2H0Rr0VR98xdXSRmE07eA;NnDVUxJ27Xm zY3b{Xfd{O83eUfz#uEIavc_@6wGFgO zz4V9P(lrK0x8{7sw&onWo$C=?-9NWpC6wb`>9*li{vq85JR#cM_{?vr4MB6bTK=18 zmmlEH`oT&>X{iCUio9yG)!};`SR&?rSCg84DDNqgwT|)n9xXG zu9fNz;T5?-NO$*|_oG79X2Fc|jv22(DfL&y&NrZq5st0?C!hvRmKH}smfsczL$BjL zz8Wwj0;?~TUZP2Ju;MIj=2NR9V%6<|)_XvYn6g@&x|vipR`v=Oficg|{Z}TwT0P8d z>wSXJC0%~cMY0uZWy#$ANE#r*a)+oae zV!4Eypf_MgQ~hYl`u^&Kc~cX5fo)T$15J$+rHPLBLBLoGN)8V8v!cHQSVz;6U;HKD z41DQVUYhpN>h-PVpN8=1_}Dc)kLE*dZoMKF-oBJmL!7mW?|W277&w>#iV;tOEk^c9 zT1?&Qz4eNzM)(~*Jnya{klqvPNv8Cuh38!dNl*lkgJ-?+KRKmwC$-vEV(ZxT@y`+d z9+xr3H9!Y$pN77mJ3wf91FcU-e`{z~zcl^!v>~f9a*AkuV0lkyB>RSMIQSP5Coe#? zJHWkVA!?_!o{*6%wg{f*V!5&UXZb` zF71reO|KyXzxqY||0k*o4NAiwEQhkRZKN%pw98841F?nG5z~^+k$_jZ2sSqr7HT$o zfE3h0#K3f){sT666+Bv1hh1gUY}SPXd`qw;4|0obYZTDHtA-nU(Q?8vbe31G{k7P& zr1GCR@L29YOyGmu*c)~lJ(e=D(lj6o@#-{#308WDbnL0TE?g~3;PwXYxK*d&w;`Bkzun*y;#fgf?RSy+s!5+4=FwdPl&eL&kNidqOp=?Jk*;M;%diE3kes z4*pYDIbgu*rd06}K%`38>SWY_7!;OCGAem6=#2|&v^mE8YO8#2d-Ac;Q57a4yETYkhX zpkXM~+Sie89AYE5F5p$T0ZoTcuOKw+TzFe$@PiKf{+raM8C+cI()I06x zhkw_%?(KKJYj&bE_<9kuaRone5&xscmuQ@%7T@3%S^$dmHH^&(ulD!^zu~xARwMpf!n&N@-B>PWwH0s65{g-W4 zYGq0adneE!nD#8U`jC`f*T>IPP0|NaLeQ)~k%rW}3la9e+{Q_kh@A2=#&hihZp|4F z!oBS``$*RxgD=?SgHq-F?_T|gcnQ1`uiI9c>6&(snplirST^X}I{eH1ZTiOA=pm2D z?rbZ~ssLLQ!=Tsm1QMi8h6R@}ej*nZ&HkD-a=yNdKjZ^<%7eqK$8Dc!NUrrht#jZ^ zx!Q2|;+GfToTpZ(8&MQ*UU^1qOqX_0sOcNWh~wP!ym-7>4~;fEk!RjuuaKd0}aJ`SFOTPUy>q1MONPD_5_0%IxNlFz%E*EWS1ieX%8B+4tJGt5)nc@rZ~IrXOM(r9=*p-EpYo0mO_ z%5J6Qs#|P4@NRDFr$lgP;J ztN%S>HZZc*d6oX}1CLMBpEFan09rpVao9TRxQgfy#IBFyC;e-e$&^jnklNnP#sV+jw z34Qd52B9l{-x^2NoN)8M4-kbyiKzdi6!ube0NBOp>}ie9*dz2rMEe5Ny+KE?wR`OO z@i@$OE=r&-U#5i~;tp#nC9`_jr84om1YI$$(P$EYl48^i)G))B*cQ$fWTDjSRcQIq z=!TgG$ggQQjm#s9j9ASK1K@c#TL0|#gj#v&FMgnrP`*%(?B`p)0 z8-023=BuH@w?XeYb@qyUvwUrfhh?*$ulqIZAN{6KX^P3v|Mz~;gOl045?qX3LB`u~y5Z=K{*qdt52n2vFf;r5e~Siaxa z6lKk9!ExoKfR1o#z@@9$bc&rj(~uS~P#%<dpS1*dD{+Kv<4#OAi{fP6sQb z6WCUUwnuLb=>4#5W5~X?&(ll#IAG9G#5l@MpDzh@INgntz5%rY0u(_-10?#arz-Ps zWw{Uz8Ij~--k*MN{nf|IOa+F~{ddA@?K?V~&cnU&bn~}oQ}lqkxtllgZ;-*#prFA7 zA#Fr9JF-Rd^gZ!XfTNL<>58|{FDJGm_h*06s3FvVf=w&;V{v~e7cE-=Zr4_!c7q2f z;1^AoiO@g0;~W$s(w=G9LOPI0ZsDzd<24ciwoK=gU+Q6#iQe8;$AfSF2W#?AtFZ0| z=nu&#Z}xV{PqXP*ed_k8gsaw(2k7G#ZvC~B#M)8nb}X>~Tmv`hhTg1v(zm)=B1!pDp|bwa>|$4? zeHJ{IimBGi|0R6guOMqt_mdDy0q@{J0Hlxht3{9PUr%zlVSKzAHv2(JQlD#<*!clK5J*>Uj=vrv5AN301+`LFk1?zLluN$QKb`#|6nO< z)LTs`0E6H^{!55b{eOE94oWKpa7hfXF~z?i4^FXR2V=n@*H#)6tFaV zF;$N=qoXn6_@WP`72#6Bu$908I>)9o%(I`-_C(`;HJ~}MxXCmEt_6A}MqSVK4bEHN zG}ShO&KSE6P4>T_8#S^SDSq8`_lHFq2S;A`YTtH67^IQn+v2xYm-Na!}1Grv4Pf3dU zj&HJK!sdi*N|-pJ>T_~)?Do(6wHeEp`mK!Luoiw7M~zgKbd>LB-tCVFTs&2@OcrJ1 zIzym!ym>ez3|wd7_T&q^6;ujnOmrY{j)DG0Wjj_NZ<%q^GchaL$oh6FIvzbwu z3{2C4l%U{O9o)O!c=MCCVoD>gj$6HUWNJn8ffZ-To~Xx+Ep(7u8p^u=790K0z{Xbp=gYJD z!J#aFd$N^|paO0xWKKjFxc!{R9WEC^t} z53OR3rE3@Apa^%an>d$7