From 540fa7f9202bef93be0c4523f4615d26dbdf86f1 Mon Sep 17 00:00:00 2001 From: Lvbo163 Date: Tue, 7 Nov 2017 10:46:33 +0800 Subject: [PATCH] Add docs for workflow designer Add docs Issue-ID: SDC-636 Change-Id: I7246a974e16850b4dce37d384e09c8b400044442 Signed-off-by: Lvbo163 --- docs/index.rst | 10 +++++- docs/platform/architecture.rst | 16 +++++++++ docs/platform/consumedapis.rst | 7 ++++ docs/platform/delivery.rst | 10 ++++++ docs/platform/human-interfaces.rst | 19 +++++++++++ docs/platform/images/workflow architecture.PNG | Bin 0 -> 22125 bytes docs/platform/index.rst | 18 +++++++++++ docs/platform/installation.rst | 33 +++++++++++++++++++ docs/platform/offeredapis.rst | 4 +++ docs/release-notes.rst | 43 +++++++++++++++++++++++++ 10 files changed, 159 insertions(+), 1 deletion(-) create mode 100644 docs/platform/architecture.rst create mode 100644 docs/platform/consumedapis.rst create mode 100644 docs/platform/delivery.rst create mode 100644 docs/platform/human-interfaces.rst create mode 100644 docs/platform/images/workflow architecture.PNG create mode 100644 docs/platform/index.rst create mode 100644 docs/platform/installation.rst create mode 100644 docs/platform/offeredapis.rst create mode 100644 docs/release-notes.rst diff --git a/docs/index.rst b/docs/index.rst index 833e1aa9..7198c38b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,16 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -TODO Add files to toctree and delete this header +SDC-Workflow-Designer ------------------------------------------------ + +Workflow Designer provides the ablitilty to design a bpmn workflow. It extends restful task and tosca task. so it can be combined with tosca template easily. + +This document is aimed to give the users some brief introductions of Workflow Designer. The users could find useful information, e.g. the architecture, the APIs and the installation steps, etc. as well as the release notes in this document. + .. toctree:: :maxdepth: 1 + + platform/index.rst + release-notes.rst diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst new file mode 100644 index 00000000..8569dd9f --- /dev/null +++ b/docs/platform/architecture.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Architecture +------------ +SDC Workflow Designer is a workflow design tool. It implements bpmn workflow standards. And it extends some elements for tosca specification. So in this designer the users can orchestrate services and interactive with tosca template more easily. + +SDC Workflow Designer is a component of SDC. Right now it doesn't depend on other components. It can work alone. In the future, it will depend on MSB and SDC Catalog. + +SDC Workflow Designer contains two parts: UI, Backend. + +.. image:: images/workflow-architecture.png + +UI is the designer. It can access SDC Catalog to get tosca template info. Users can orchestrate ONAP services. + +Backend is the storage of Workflow Designer. It will translate the workflow definition to standard bpmn workflow. And it can save workflow artifact to SDC catalog. \ No newline at end of file diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst new file mode 100644 index 00000000..c18f59bb --- /dev/null +++ b/docs/platform/consumedapis.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Consumed APIs +------------- + +In the Amsterdam release, Workflow Designer does not consume any APIs provided by other ONAP components. It will consume apis of MSB and SDC in the future. diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst new file mode 100644 index 00000000..af33c9d5 --- /dev/null +++ b/docs/platform/delivery.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Delivery +-------- + +:Docker: + - onap/sdc/sdc-workflow-designer +Docker containers can be downloaded from ONAP docker repository https://nexus3.onap.org/. + diff --git a/docs/platform/human-interfaces.rst b/docs/platform/human-interfaces.rst new file mode 100644 index 00000000..4a0484e1 --- /dev/null +++ b/docs/platform/human-interfaces.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Human Interfaces +---------------- +SDC Workflow Designer provides a Web GUI Portal for users. +Users can orchestrate services. Right now, the designer supports parse swagger. Users can set services for every workflow by swagger. + +Target Users +^^^^^^^^^^^^ +Workflow designer. + +Interface Type +^^^^^^^^^^^^^^ +Web GUI. + +Access +^^^^^^ +Http://MSB_API_GATEWAY_IP:80/workflow \ No newline at end of file diff --git a/docs/platform/images/workflow architecture.PNG b/docs/platform/images/workflow architecture.PNG new file mode 100644 index 0000000000000000000000000000000000000000..35dcf7b07e967052737f7bc56f8911656c0359b6 GIT binary patch literal 22125 zcmeFZXH=8j5;h#Vh=7U$(u;x$NN>^v1Z;qc^b(}^DxFY71QA3;dXple^p?7K4D z2t?J4|0Za6%rOIjv=ZySlQONm;ri<=`S6^vD z1K3JBX+H$4T@5VaCU8~^4}DIT@ci`~Gy2EF%Omo`gXc|?>xo`nVd^*{i*g*3MS^>td`WwdYE+7!_^?;B7FFx=K(f|A9zbQfS z7QqrH>%kcg4vttIP(Te^0~-g2NjD*AL8*YiVoRf5{_fqDi}wQv0&3V#Ua}z<0KFF{ zroVgl?jt@xr`xYVL7}0cU#~TQ?#!GwK7ZkYU^y{8sDqL4957~fEQko?r5J!8W%!~o zh|Teg0Pya3J;HOK1=Yec0{YAzd?qR*OY9sbm#>}i_(pb@X0Afy{sh zIF2XAt**armF0Z%ie_KQGwg$n-0d>2b$uppP%s};kps- z**)SkZ$LSypuT6va5ow9CNj=Hz)O3b^44CYu9=t8zo)s=2a4XLs@M2bj|pUOD50WK zg~gqZKTBsEF4p1+tJKu}*Q8bXDFwU**IxyV6jsl1JqurjxdzK-{`_R`sQF_w_wZ2X z{1()_&1qC=*;_0f{K+xpP{L+;pec$@VND|O4MBExb^oLUK?Xs4z4!b@CVfb)1WQb0$hi?^!8r;)BOku`2L7cEb&?T+K3B%HcMMV+!xc zq&x5){K8TSY`vVOys?DPNnbCcq-%0W+7yC?7V^9L7o-~ql3!jn5@bGmPp>2A%8GXB zFTd-JEqP$u0+H4>TZ1g|vjT(I2-t2@2$io>nh=NR zTLa6g)oB1{fcnyA;xD3bsXAP|-EkJggHlc{ zv!u5}Fl_G)>^{tK2Ks@;mI$z~%fe11W~y<}TapbelVb)|+ln5a6`zKZzmD@vIuuI` z{)E1V-!s2j3AhY4Z?{&0kE)dFSwJ>7wM7k@?MGft4)MJ=9OjVK@~nOhO>mJ@i0s{Q z#yOrnaEcFg^)2W67t?jGm7llxJYsLcT-?wQW^WLI|MkFb zG;w@l_gLp`m~KT%y>yz>2j!FX-k=gNlF+UGx$AkaIC$f1egzDhp{>@`&3L)7(XH<| z^Z7N^fcurK(0y^aBpllLc3>8*%Ub=MeTyoUz`EzI{Z*tk5oaTZ`x+rT?=Zh{UZkKq z(-1PLD*w_&4x!5;{nC6pr=#S*d~(l z>bybCSNHV&Q);WukB2-X;F|WMPuZOFReE6-?lBuvFeztU5Sv5LM!_=J{tFthRxg}7 zc5B}s!*#RuEfyMEw@SwHNb5p&ZnyC*#LT*W4Cgk&;^*j*2O^?}%Q-t%g3 z+Ou}Z*Y#R=pUQr4l09gUPnD-Sr?Ee1Qa1W9jtq70Xz*{avr1J=+ z!)r?_gTnzQ`TiUMDTV18w2*-h^5hN~U^^Kj)NJYftyz=;yY9ZBte{V#fMezZ=6e@> z%oACC!T3Ynt%>7N;X36jAU1Mf<5K`DF*ruem`@t-our(WZtZ)yt!$oJm++1#5E!6< zvo3z%?Jo$%JeY5o4I%e8`g}iteCJ_J*Y`ZtK5gqWzoW*9H`cn(-yo7Pc=_XNkpmy0 z^z)g~V`SLByKAl9g*zFu9HYDqA{fQ^=kxyl*~)#ao7|`I;s1{Fm;e78HU6)EaH3=) z=Sk@2qI>6!tJ0aN-+o0Wn}23jObQ7N)qD?%=F>|L)w%nYm>`>Ra;qrbre9ZUQn1V` zG*kx&bQ30To9hqS#LrXQAZW{k5y#Iv9<$JPsPzy@y*`biT>57ObY74Pun^PRg`~uj zxu3IV;o#7cCwv4wZ(Ou|(OCM7z&MqZAoUvkr1agpc`u3M?bsWP2d_1F0o3M=k z`*8{ZjTsLEw%8hsrPf-ci%hLh=PwkWy=Yt#3<^?;1I^0^G`f$!@iJ~7I1TA$6a=Ji zZxOTwfr5}lG^mDm>Ai|~TW;P9=%gh)M{7tJPDVfqf6l!W__qlI77c`4YQl5SX1k@v zo4>Y~zV@$Z;=J)wqOcsp%n+T~PJh9tJ;@MP80}`n@BJRbdOLUQMeA54J}gP9 zUWCojGx6LF!oEF#=52W&h%l5YPMVfEEHbWmx0F2m^ZAj8#?lRM;b)B$f_U{nRSNI< z0|8BQ%=Tt5$C2RXD~0tMoUaQ~QE= zw0+sO*H>N4oen;Xndb}J%Dw**_mRDUxFEnvTbPi5Q_C3scylIXrhZE>i6q|KF|mB( zp?2vf)AleU!L7Z*tr&Wbh-N{7z-3v8fCx3O8 z@q7kBmUF-sdgRrItN;`HB3bLTDzPllil(4Y`{+N1K=%Y`FIpq|N_(JnDWnM~8J z$VLrZ(09ClmP9m(?zq6F+Bj#ERYl^e$TUXD$u%9R z+n5cb19GUiX_nU%&h!ma$R}$w=SbaX8OCg`i^l!IpC$$uq@K#<7ya%_+E!l@6#&j7 zb3}zb<=;0A&bubqFpd;EW~*Vi$dRsKJCyU@11+v&=hLppm&ZsF7#8ODft?x4vk=YnVi6xtW`#6KA*!`^8F)L4JYg`Sd1v|kXMxW3_v>0?`t6j5F z2m>tkF;5L+aDbIyUb#JzR!ILUx54h2Z^3VMqF82)TmqcoulJ^TI?5sHXNY&3q_L)( zPui@1>5xI`{Fsy(Z)IRUOUpe7*xKVPiL~e&FaExf>u%61M0n0!`On!3Cy?Ery*s*d z_R-Vg^~)80PbNR*jDC@yIaS{ zVvCF?4rifI$yeuX@Wc#mdRd!;k!U?BwNTyre;TgOl00^!DV|5rJ$zrfOv$`LCz7sK z%uIysSqt={@%Kwz1@83OT)%f#;48})2bqrX_Sv7sS_R3k z$}mjJG}VwEdbnC5qNo)T!Bn3$5Ijx=c$mL!c{{jt5%}}b`l`?fBjBH)P7yS`PWrsh zG%nY>X+Zq0vfKRv&?Lm5e33FpoihWICZa`6DTfOuderM=yai2js+nXk&Pz9C^^&~+ zzxwAQA(O~vG~-_bv6%$zn6rPk@b$R+FT(q|1a0+a2XksEuMUd6NzY*M9Id%REwCQn z*;>l*?e;}uJ?YUKgyHt{23z-RSoIwu!5)t657QxP!m_EMiGO-Bv>i(YIF9M4!Oy7@ z!1*}(Ew5$L2oc!!K07D-^;fXxvkB^$b??oTBhN;I`rZdO05dtO&*oG1EZMfzO`R}& zO#Frf@!sdprpy#9iMw|u7GGUkbmoBypM;b$p#>Ist9ApTZsda$-S}d5Mxe8< zVta4qi5`!f)~J-bq`24Eer=wfLmYpcCNx*E)*q5YFzP-63lYRegm~%Qv%4d?AKj3y z#Ron&?OBB1dO0nIQ720>G+{`EGVxBiF_)2H@TU;%Bb#LstBNAc=8z01_Oe1A@i;q9*x9Lrcv8nDc3IdR=_u!Yh z{|ZxP9R$-wLTA9XQGIABKvR=N#a#ww{u#_BO%N^q6_J;Sz)*_P|%U%zpKv zv3CYD=WR0N2pw|eUZz`UsQD0%Dx~dbE7Jet0SeLmo?Y?C6gvM-stZ=P%U2jo0nAv= zP6GCZ#PNb{S>3}KAu_Q!r~u(3U?}M|3SB8d_ja{Q1@cHwy$dP9cxlK%QRdUppdlJ0 zeX&>0%=b%Kjrsbaq1V3SsK)l|k1=wHo6RAte%FsN^~bB1wvK^mbF%tw2F|nMHpvc9 zX~%2j?@Aq}Zy)UWAA5MM=EKa8ljYk>Nse8Njy3Fs^|-3}dMv!&3r6uPUY19@;3F8f z9k=}!e5BxqL#1{1`=Nyqu?1;I3*6gXJcSZ)b(7tdk?rkn{%(&t6!QTZR?o*@x1Vt| zB!`Wz*=(ZNjy&Fv+&)6}cNhBY@)Wu;3D1bvAEaqUPk{bHwpxtIwNj`FMSk;uxPL^YBFl%PUgtMg=(3K#~w@moGJ)Mc{T*xM>z%_L}Z_%b8sO`$(l>Yn7F?|SWenf&eD?hRSYV65Y! zGdvcp+=e=SgG5+>T(_kve4* zy`0}1;lVx$tm_7%KQ3BMR9#KhF*SL=GikBK)$s#OU+ojM+GY3h!a=4lrs`=Lu23e( zN{pyw*T+aOyGn{nC6n8>xy!=+xZB-jz;OH2sfYIyeAg;n1_Tiu@+$rcRMLlbl0R~; zlpH^??82#}-iUrDp@_6K*c?zdE9~U%Xs5bu#Kj_Eh?f2#G2wb_E%f~OYe~Cb`>?cL z+lExDS86%VB6UqftzGeMUrDQq$A>|E0_v7nrDnKEL`E4ExJn(nOG@R!R5Ww=4oh}! z$3Mh&t+<^9cX&1Kmf=eIJ7KSFvvTzT%trmJEwkm}&M%v^PfOqKT@<$Hd5j@Wk@10! z-R}DwXY>s{$RuDKFy+)tNgPi~+WeaF0byVZIp0kG5ll)I2FYo)C2)&>?cbtgsvJFe?+y2O-hDAVK{ixpAAHHGk ze$6c2BC#3+hY#B`Ofng_u}G;Xue*I%6Q0+a!1U4UW3_GGbc{<>`9utHAts+Jp0<#lb%>J=R~>XHe2c1FWveMGM&hG9=~;Zpg22}%5ox*pe0yP}EnjJyIO+|15Z zlVhIaTXbI`FB6-92PJziX#%T}eP{HLLDg#Dka*gAD%A#@Nq$o=?Nd_3gc{OTWKMaN z=0$Ua%2!B4-0XJNBzKP2t@1i$nxit=Cv-BE%1AjFtwcHciR!@M;q2C~{}Z@M?HtZA z7aIXN+<5{lFa%KwY~>&9jNgE#I^_b=jHQmMXqYy=BDaBmqLw=<8oRBQ2y&f;?0MzS zXORn_mU>Zo?UILY|w(h*81$fpo~yC`K`^_8yIztzHEOkzhFhhr z7dlCbMrFTwX&VA-qy!t~UN%RiJ;pGoMiuUodpDLp1QrrSRX7T$h|Xx$cFKF|Zn^qn z)VrF|u?kdbNDeUnfE-}{4cWlk$9E_IH$!u={A7+acYvS0vNn*2Aq!t+B+W4Kqx?ca z)qsO#DjHx^*YeL`Wcgs>F^GFDVZf5;6L~NfQ)0k3U@#}!nMLspbkZl2rA(STw(`T5 z+PIPvB{P7Ra#by;5_3VBu*pvHS}sr$o1H@O75FQw{KBnle%~?j$t9Z*@@cMsB(}Qw zeWH|ki>9;$)1{k9qsPz?Be$1zVWGGo1C?pS#y$JbV2k|qm)A{8O&!c2|B)iBx9=9 z%pUe-tm{vjpkWlt5(% zRo?ViU+eGYE(@W4V=*ib!qUCkviLJcWJ(Xx)r?>A>k4YK3{jM^< zYih;Z;XnxHm!MzLlW)8fE8uE7{!KG?p&qwdUo-056N2c?w^)J-yJ8Y5KlfNU+!uzu z!?yb$g}5^6UtEHUyXGcUB73KB7Jg!h`agT}otJ<>e6+}Kw7L|JeoMz6ODUd5)}7)$ z*(oVY3s~Y{(Ht=)jowmHDI&JUxI`%ENoC!gB(Xd}irRb6B^1 zHfW@)=2eEfdAqsS=a3^i1=%?gbDT;6_vx!?2rPOo#C548*7#V@OfwbtvIyZS5{eOS zlQjr)ETve~Zb-y?`DW#=Pn0TMKjt#cHkFeksU|$jc34ZI!X>wb+*lZTk<5NuyMrl5 zKf4Vg1X|-NWwHkO?o>aL9_Fv>iJ{i_P2k~x?jQDKAOI`Wke&eE=0#2mUg`?JQCCof zkp$w}rTdM*e+f!j<1_+B!U~l)aEU)V46K2_D+x9E>nx;NwKH+qoQw*krTDAL!b`|@HsNmP_{Zn=34y8gc{RDV{LH+urr6qS>RNt=KUhOBe zXrjkv@4PU~M-m1Z5mBm?T;i%ogg5orKh*=zBdL#jZZ!4g>#W;b&U!ek3c*E{zT7Z~ zp23RGpvG@nGI~fKxqj&YR%rIobNkT*V4;xCdf=9_Nz@IIB_ODLFm#`2l{0F7P3bC2 zO@rkU0#>THXpZE+=5E6C&u7Ore6%(t{5Ni~>s%3F3V{ z`PNG-k)#A%6Q1LnbsOeQ-~G7|mJM``B*ZwRz`HM(2X%8u=q(c{`HTiO3mZJ;$S@Lt>=hBOsJB#L zi#u<9XWDpOiS8$YXl7qyTqCGR=uu2ak99*F(hNJQ4_0=d!`Zck=C`+}j*0w5ry;#A zl?49gu}&vVN-?Hp)jkxq%=@DG!N-n}{S-&C(&3lAVUzvo1M|U@tZ*MT3ke+_}BEZwrxlU{TDuBz+6c`l2dN+)Qy|btg%&-&zlO%C@0v z&Q9F<&8nTwF*De<8lP&2ELpx_Ve*G}m;6HeNV(=a))TmFeg?b8s@LycOQ`z+_p8py zHvE1^E!2rgsNoLaro;9NSc?d^{iW zpA25S2zAfp7(b%XI7(%Q5s`*?Id5ykmtys_x{`@^m`=a6iss4;(^HPG4589N`kTuO zkvXsi;CcMB3g|jgU-rCRR_1+#^xqY`~hV4(5;*>u%@|dOQtC{g!pqE7NOb8u!%RPg$bHwWYNdcX5 zs>yz6H{6sM8abxkwjr!^t7^{HAV$8$C{w0gUhI^DUF%f;d(sziF!7s2O?O78^mqA% zq;aiMGA;DG&U0l#KYq3Bi8`Qm|B5|-p*usS@c%f-^8q+3E+N?k=X<4gL=ERF&LWMJ zE|=jj(Jey=|6}d`m0AhPor*tfu(QB`2*UcXx|FzTw)v_l+lGYd(Efwr_)P{EC3xJz z23Jijlcs!0@h{&E4ONQzlX*O4rhR^Xc4c)nqQL_=H32>xWd)7U}iP8qxvsOL*e?2UN{6<`_zk;m$ zj~zWv-G2WFdhuBoGRdu}qy+#)Xks`x+@Jb5ytD(jTs-YP9-ZcHvi2_JxHdb&q1EQ zP>Qb_{Ed%3RRik#l!*mcqb)G#bw?Iw-+M_9T*_o!k$de%GVADz8>^S%YJZ7%cmce( zXt(~9vgWhM%O>LG2!{VXv(hB8+^p`T+*qLe?KV0AlnLVF@X58o3+$NL9^~Bzfap0W z27I^ zxlL&ig=_KB7;}h8XeB%d`1;{@>%=4RviX?l!4M-h$RQf(#;)ws=lzY*_`6}?8^0yC z!vx~?#Z|Ku*vv&cOISMXPotEQg<<>`H=?NQ(Lwi8z0-q()zjUHTMu`GKRM zi~Pzvn!0N@aFTD8G3#i`^}-=7O4b=aPe_^bIlnXj28_shW9R#IZQD65q7iUdy_y#Sg00Q;WB1O$T4p7mb}x^O+7tn*IyF=Y9L2Htoe<9=$yfZ3`b))ua&R zS}QxFHT@&P@3e6bF3|JGBkdI!A{?0~{l>gXdPMX~b+|^B8h@lWn{O8*y2`s}+`Zc| zDzk%*BJL5(I3JS3s(Y+oa^3|;I(Z6qSJ4^kO|-xI^wS=8uoarLasU;RkkuuPk41O- zv;2&Q634Gt`#XX_3nT>D8S8F`y*QNd6mtCGh`Y|Qas2_8kknY2R}NjNMZ!hn43a`h z-eTkPeDU)nP;j{NS>@`Q!Ri$XRxls+ZMx@m{B*=i%~`GGPwKEGM_JINv04B8nRd8( zb+0!&(}eo*GmJfc=S6>9?Sx3eTR!{@(O0$7|^11KMe@vB_Hth)6kL(|Egorn`3Eu zvU3bK+h=x?C+ogXQg8aOuBihx`&Vx}MB0en@-Zm}=V@n+#))2E(x8oTPmbvZ#{xO~ zT`_vUtoWl6i!GAA`jVB9C@Ay?43ifeUWQ>E;BT03=dcTEXX5#(KdVyBTNMFpHFwzM zGhuV{gJI;6#e-YUJzNdTHkgk^X#k_D`5iX{0(DRjJ|dZ34~WF{%MaLdr({733(y;l zH9ULX-3(;$iMZ;+TW^A`vJ6x1r03LdveZL*c$gRm^K#1OJ%bNqBI~aecKLT|tI6ES z_WcFh+QOzKUCNI_-u|ZK?wN9}GSu<$$9Cv!1SFhK8158VNuzTyQiTX9X1YwEEF=4l zl0`iiZ;qmpes$LH=Z*uozTYCXO7Db)BvY@$5o}gzb=ZZ_iO6r*o0dOvqtlF@f@ee; zbQD{k?=yR2sOr@!K2eg<7T!BY3wPJ$Or(v8;uyQ}Y8qRy>SLkg>C4EwlSZl_b6InDFvAP`2if)^welD# zA`lz@83E00^hQ^kK5~T#)5vJgmFXebad5mO#mcry%{X@qM(SUqX?iQ@1|_m|8bOkx z2*HqZlT}&sW_H&at}yRl*y^O>oq*JWl`ww!mMaVy1)<)$NDvZAtnZj5Vm=-bE* zr;{$OXC3$qfE9z4bq=vB#-#Th!;+n{*1WdMaaBZp_3B74Id=1Dy*;m0GibghiS@== z(~V8|&nNr_^T8&y0&6Y>Z7me{^Ult*?Ux`8_V#tJ zkFHbVaO)2!)UqMBlw4$rXBm?}rd!B&2i@1Nzv1ee=crlcUnCSI4*u|!k|A&Fl~8y5Ekdq|Xv+J3~0EuL_JCb=(-w zxuZS$Yc8`KG*ml3bhve|h-OQ^7<;ait13NSyu*bL(AOL2YdM5MwZfI($_%v`(ozdF z8V^5xuAlh?ljElox~>?ul@_X5VQaRP71^XR+-*0B<8sA!8+pU)+c zkz{$IAvYWGF49rr@qW7!GRZgZ=|*(sMH3VFqjCN1T%7gP!fzZh@Bc{NlFcJM944_S29kokQ=%eVZr0>e&R9lmkm zk=RV-4xP(kt4D_xJaVs}tgQ}v*tw2jx<+So{2q_GZNPVXv@zZ!crSD!UWrGap+7&K zcqXM{_?gB?ng^?!LJ#EH_~74o`{a#}f<^tQEtWfqh2~mvM|SDsKtr+{02=CO=Qm)} zcPPzWgLHHP^X>uvZW7FHawz(x)rTrt9i+=$6}&}|EsTd;Kv0gx1MAiE#n@9NUUpv& z73@P9<0?KwS>`VqZ+omd(|iWkmQcHuwC8DF*d-t* z*vX4{4e6EdKa*O2{;k6xTf?()fQWHQ4I$@-C>usPm+}%8Sth=BIp9<8#N%iHPah&; z(it5%_N1W?kV9~DKa&r-eUuozpw#D)^PQ+Y1>QU*NG*-=&9#PfM#=u>7L5XpG1DpD zx1gRr5^C&SHHkgt3A-M5mwj@&ulC>AP&Cm!E)JK4{E$z zFk^n-&^MBP5Az%>Hz53XIe^|$yaG`(RSTCBfUK@hn;(vP?_3)gWR|9=7RBR;vH1G$ zWthIxU)27DhvC9olPBN}V)_=^o{}>SM{ zRTA&lGVk;TLv=2_J@n=V`l^fpNokw)S&pI}$)Ijdm<0vFhLu+|KhEs?n7i($ zW*-OpAL<15CEgspYWCX-AI{cck6hz`^3C4+A^y6|$J*xcCy#2bBmHFg$08`Dc%y_S zta{W+w#E$?HgzL&>;>>k5!+n})?-&myRGrsv82+UO1MDIlStC3OV?$$$=s%1t?Q`e zYH2c~`?}&E3XKo*-f{Dvm!l3bfZnwaIee*}pfaq`O7&GeB72R;}8%$i5+^ zZv0l*xFoeqGmA>T)m`4O-*)}&U_J)zC1JPJY{Pi6Qy2G^`2E1y$u5=WX3c~T7Bs=n z;4hy3HqD}XseevNX8RlW5h75(<2!zv*R}^o7P=SoSgnTRQ%-!8aWjk+`n@x;(**x` z_{xP+*4?xafFLS>HsTFihZ5m`5b_-cmb+5YsO+-rjOYde!4vzq;8UCQ_xRJS04^UFU68`38W`Dnjj87gVfK$YH|<1o>}Dw<$0~+ZsKnQS{PO==4xGY2 zmt*rY^11SjFUPrBK-ApF?fs8;EvFFgHHOho)Pb5LFgqtn)OVlZ-M_@* z`=?mZa#*EfF9~!uVpxn`yqg1*n}5LDlRm`%KD}8iHi4qe$H+bk0J3bYf!VAO;io@ z;Fcy))Knu_N(nK4S8|IHAix9uQlNDWP+^zcTrM@oHZtxb`f~7P^Dp-82*kEqNrAf> zc<6Ip?pG3ef3F`8!ZEJ4&oiVT3Kxy5@>4uMp$d-=3ta#`9kzGYY&p$%Av!nw_M{4f z-x?NPjzB))$*MJ{ipmu(b{b?R7cd{|8v=r`yj>$;BrPI|j!dg#{sDG%i&Q1p0!(K| zFKoL%eUxA|pI;m@S1sAo4>OOD{K|c4=RQFj+O_awMLOGvCe3Uaq^4nRo-}sc-ZC9N zxg(qI7TCT@`V~}cI>(%OCSPVIHED6G2u1Zl5cW<6s3w;5ioy5WZO4nAmpIKS9Be9j z^o=j-4UXU1(AQ*?c$U{6!)yTm%u<518F+PiGpw;l@}Ekl)A z0cSV#1%OQ^7!e&Q*)C@(=CbBKZ@xC1D zd-hSZY*gC3c3?)}E&AcIG%3W7-u6!KX0aHcXg_R*G?}?c%4S?a)EHq$NR>J<)A?shpHANk z#$j;%fceM?r5J5c3sR=Th@m}Ri5HwX@ zcDoHZd~wk0=r>=UGo}DYs+RI{nw&DqjvmuZ%vD#Yw^K0BieJY)c9? zZF4TD+3%jR=Q6Ba_6pdVBqlG9bja)!i)L|EoAlBXIU{g+@xy=+jl&j9CDuqsg(shLj9B7r<_%E>wGI=(06!0Vn0IL zF+0-SJh>suRA=99o%Vt;4p~UIIJdYS^X75VGlJ}iab*v|3nhe;V*iLKq{D+$`2qw`!3(qti6ROZ&C z&#~a>jPK_XLw}%Y=hdj2uV12x%q5N*!dd-n5_<8PyA=L=T_K}l2R9!^%NjLoVtnK< zNFw>}S&LHHMvw+(0xMQ(eCLfpV=KECM5`HqVqVi4gWn?+*FZG#3 zfs?r6vwPM`F)P%)u#dipq*B9xCy@O>?1rsbrFOC{EdMLgR*bcJ#sT>)&fK0YT%vo% z`qJZ)vjWal5Q+qB{WjCW1)DHDw0$DKk?=E*oO?r>35@6la{g#9UpwmFk@}i)Pcnl#ZX9~X0RH4-MI!55W_SGuaYRza_ zwR^?GOeQ`Vh=Fz#r}9NEpmi^?O)l$ue6ax`yqd!YjZyppX2Zj8Z1MxC z(~MSX>{P1Ll<+i%sZ0S{`?A#2WWN`J{U`j!unYU@2K-~Q#~&u48oyz?@)L^0lIM|` zS|S{@ttaac$`=nTZL3?OqFhwzE$~$z7N_K?lfEK){+jjNlPt2JTk(Hnv!_|44!(#e zgw3-xho|ht)?rs*uOTjdbi-(+j|Xq=;~k|f(SJ(^mo^q*(l^M|v033$N0~UUP8)?D z_v$rHJQON-yzo~7&kzVC@c$w6L3O*I3I@SBk5BgSl_*_pUUvu1p~FkMrwL9W-SU;c zC+@$Y>-d!ogF_0p%0XX}lFCDqf+l$h)s1#$8XI2FEspD_KM%)g&zm2)!geI z=<1)i;c=E;Z94Gn4QENS$uDL@gYXVO@?5C!EpL~Is+zq2rSHpIp^}lEXtGo;6+`St z6lz@Ni$s58{8osh9IMZ~Yx!g0hwm!4HWaY}c7UI>_;SEiRBAcHO+%f0D=36&uU}9Z zr5h_WLp93$I}2{EgZ?v%W0D%I9rKTlTwgzuwm6ytcttgd?+0GPR2T_4$J+j#$8zWJ z+gZi~7i8EsYb@yhwl!5d57-4Uo$aYSX?51tzZ@wa@|+s&82vxek5Ei1q}qRKFTpw2 zt{BeVcdS|j)TZ5hQe?G}kp*}{!pigV-k>-)T`{cvy6t8lFQqRiCI#~B< zTC+#;k8$5~!ls8L*A>Mk6vP-|X()eJiV2|O=Jv7pYPp{devc*jv^UG0Bw-FmM;^nw zZPEQn2w(c+(QAb{tGQQC1)iPzlj+D-U~xInK1rars3&1ye@Wj_P8+#Aybh|k@{*m_ zBTAYbFc0f-M9BwUYrjfIp!Bh)X1hW8rv+&UA}yb1ILIBGE0=iCP0-2t@S5L5t=?`=sc%9Vci~>J~n~npK z74uib=vMGMdL32?0jOWvEFn-u?ym4`A{dnFsJ7pq}LjJVm9AUoH-_eWVj;eTvb=FVABsiIV7fIt}b~@JK-D| zlyw}ido%`f1Nvnb12Qc-PWqZ!*Ur^Zofj?l8v2GVrB6__G!3|^&)){1!aM2~AsqmJ-6%H&82Y`U zPwp-(K-E*+)`2n!(?C7!)<)A`d*2TbMZhBhZ)Abmi@HZbYCMwNH|3eVKxqq<`I74TAl)MZ{e?!B;Ay;WGpg`8;qXg=u7gnx=288!2|Z)yA}-G$st z8E()e^8fNV3rnD5TgWa`6+4#ghNt$%BAL0q7M;m}g?@dI7INE~k?9{^}w zkteyB{`V|F@p+QvLT)aWnd867@&=b=`>T<^vxTSIv0hQED>KI&K&eYIUvQ&IR^{XFx^n0g_&C zF1)oU8g(ZrMCrSMq@ecWo|sFnO09KEJ+N2S$O{*SZ2GxDN$Af`w_D)%u9+ zS(cDT{Ko?ad0_`VVFznrkQCisO9M6Buyi>;hlw6ilH?O``0yJE0oP~ubNNnfCgYu6 zpL&~Xrh%T`qp{c#-=z2hEkP90WJ$lR%rB;76@p+Y%YLXk_Rs*GjXG~QqtE>?Ml4ij zFcl060}d+coi~1J(>`$4lJ|8&f6z%ey{!&kJ;Wa|?18I8mb&|9Z3X>dtw-3{r22hG zx#4F%rvP2x7`5f>XuhwaVVZJv1inGwGqZ{M)qko$p!?*IO3j2#hj>GLy`7_MwF&M! z7C^<{?8En@aXbkACEL}KU3*1o4Xlb3TBfQt64vQqEWgzb6+KP)nWm)V1Hx z8_C4+3S{v@viv$XkzVBgSdDnB^s+-h@y09tDUX(EYHgJn=EzIKKu42(vAT9PD@4$3T5k z@=&pociY}Lw6E8zm({{#(c_u(!=Wrek65d-p^lU+`cB6`(;&{|4i9ZJ`v_XNCTHjV zIngzQya!?U9uG5H$3Ht_d}(TaI4&9ku|@B((NO&++rs*lezm+JL((;|q(bz<}&H1b{2jt(~WX5gJ{ zCP&NJ40svDG*U3Lz2NJb{&&Ic_Or;4y&7e7uOlO*u6#ZyUg1C7PH7rhJ}EupIo$RB z8TYvGS5w8_{OP8V9$cC8Zwa>+K2`WQFVU z))l0wiDxJaO@E82j(;+)iqyWDD?DbzbZi*Sw?p)u?ZLZN6-B2VnmG(?);_ zVGUnl{F3c@%>5ZAm_yy-o9zmeiuq`lobdmmy$@VqEaIADh{jJea(#YkQFRzMAyaD;=@A=wI;;b?6cO(odgU?lS z5|D-V6>CeYj8yFU1zDeVt3B__T-Lh5HJHOy#Y1R1Z2Jpg*MfjhkzvOB=kX0>|@M$Ji7R*y|DKq zA-p781F@1e?M?c$3NkUbB7?i9TQAHh@&Fwh{iL<+kH|So^rnk+VaGapZ5M8 z)of5dD)hl0qu}em`YL51W@%SouSeSrwyTbE#nm-ueC4x8+kogbeXnu((ns=En5jrh zh5eL*q!NK4r`8WH+PVuPJa??m$+cNsm@0*=83hQ!$w^8WtlPua3w6_890_}!SQksC z7Gb!pZ+*q~%W2@)93WKndR2Eqh%2Jc&F>v){Id75;b}ZUWJtNTl5uR*-4Zrko$B|@ zGu*O?c3%{@P5rJODOGaNN4Af$-?NUxtiDS+etCSHo8RA)hbmgz?q-3uOfS>A26tz_#Sc(vzdEXdB zCMDOODB8VBPzxZ2lR#|ng6E2{!*N0QH0rv4L4?!-ujJ;-{w{a2)SHSb;ZeP9NIIW) z5L?K|qA0%8*UnC!C|vs}?of;aFnX18gl2&B!NxJpapJ|0YD%Sq{bbqW07+!oQ1US~ ztE}{kq$@itr!m}hFyABq-#3es7N(*X5!rDCjt6u)!>)pZ?|%n+s+-$rfz#8Fn+N%K zfg0mGoBm9Y7b>REw>2#?Q#rx~SDxOsKhf_uYD->A`7hyfX^o+WOZx2j^u1%?WuRJoXVOu1Q@Z@(cy4t*)Kt2l5!DeEID6WjqbiEmd1 zTIcUPiN_O&9y0zE*?WqoQ0%QkOhE%NqVeNuYE-RSy)JYH;dupMFc7vMkyDHkFXjhO zNm{2jBYcvHB)k+1oAK^Wi))+3pjkHO! z_*bv^hEo8CGu$2~iNYVFM91E7e0>V*=w>W!Zz#zE2mbHI@_QMMj*h;NS;bAki5}7Z z^=Wc}$9Hl2?Q&h|AuKmpeIMtVe;WJO9149tUt?1H*?mT!xBTDj+4D=TvM;ZAH%}b8 ztX1MM`U!-LQ{*oq)~&rc{2DZ5@b4=hq{uyDb7 z2U7^B{(oDa#lrow-~osDzp4gK_9-8>J$gNPdh0dI7p?U=Jr;>4>ZTp%Rx)+^Etw@8 zlXjeg9XRC9a?Cup`L)n-bGN=m%YVL1k;_3oNp5g70Un~W@fGm2l*Ma+=WhI2SRnXn zHS3HQn+gOva?igI`SVdh|8ZSLfef z)aZ4TQ~scW(7iB=4KB`J3+5ZUnJlR=lf9q&T+X<;PE<1=9P<%j(6iHS2JT>ZEc&`L z+(t=JrR?Yt?OSi3do|r&DgLT3XZMY7QKmcUdk?iH1CPtt{+N~P^ZyHWTZIy&dgZU& zUgmgvz6{X6z_KC|dYD-XD8|H1gq&PT=89R|S+L3Np8%J^$%7g@&c0#xS*&fr3*0+& z?u+Sf@q6zxfSbz}zx>g4@IiAFGc@2&wXrX{8EfMhs zFDVfrk0>QKc{Mm5Sq0n?fhZvn4n~xYYhbAgQ8K1Zg`AH!Sr%TPBix24%;6C-yE9e91E8lj0Z%`?tPMU25qLffa?wGVwoq!MWYFzv?T%G3e>)=d#Wzp$PyI Cx?3Uu literal 0 HcmV?d00001 diff --git a/docs/platform/index.rst b/docs/platform/index.rst new file mode 100644 index 00000000..e63fde54 --- /dev/null +++ b/docs/platform/index.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Platform +-------- + +Microservices Bus provide key infrastructure functionalities to support ONAP microservice architecture including service registration/discovery, service gateway, service load balancer and service governance. It's a pluggable architecture so it can be extended with plugins to provide value added services such as centralized authentication for APIs. Microservices Platform also provides a GUI portal for service management. + +.. toctree:: + :maxdepth: 1 + + architecture.rst + offeredapis.rst + consumedapis.rst + delivery.rst + log-and-diagnostic-info.rst + installation.rst + administration.rst + human-interfaces.rst diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst new file mode 100644 index 00000000..7362603b --- /dev/null +++ b/docs/platform/installation.rst @@ -0,0 +1,33 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Installation +------------ + +Install docker +^^^^^^^^^^^^^^^^^^^^^^^ + +sudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-xenial main' + +sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D + +sudo apt-get update + +apt-cache policy docker-engine + +sudo apt-get install -y docker-engine + +docker ps + +Run sdc-workflow-designer docker +^^^^^^^^^^^^^^^^^^^^^^^ + +Login the ONAP docker registry first: sudo docker login -u docker -p docker nexus3.onap.org:10001 + +sudo docker run -p 9519:8080 -d --net=host --name sdc-workflow-designer nexus3.onap.org:10001/onap/sdc/sdc-workflow-designer + +Check status of Workflow designer +^^^^^^^^^^^^^^^^^^^^^^^ + +Visit workflow designer web ui: + +http://127.0.0.1:9527/ \ No newline at end of file diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst new file mode 100644 index 00000000..f179df4d --- /dev/null +++ b/docs/platform/offeredapis.rst @@ -0,0 +1,4 @@ +Offered APIs +------------ + +Right now, SDC Workflow Designer just provide a web UI. It will provides APIs in the future release. \ No newline at end of file diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..299586f0 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,43 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +SDC Workflow Designer Release Notes +============================= + +Workflow Designer provides the ablitilty to design a bpmn workflow. It extends restful task and tosca task. so it can be combined with tosca template easily. + + + +Version: 1.0.0 +-------------- + + +:Release Date: yyyy-mm-dd + + + +**New Features** + + +* Support export workflow definition file; +* Support basic workflow definition; + + +**Bug Fixes** + + +**Known Issues** + +**Security Issues** + + +**Upgrade Notes** + +**Deprecation Notes** + +**Other** + +=========== + +End of Release Notes -- 2.16.6