From 2f61caa006f4b5381fafd0ce1b74feebd991b441 Mon Sep 17 00:00:00 2001 From: pborla Date: Tue, 10 Dec 2024 13:03:15 +0530 Subject: [PATCH] [Task-Id: ODUHIGH-632] K release documentation Change-Id: I9d986dc7af6bb5b6a745804f90fe2c648dbb5465 Signed-off-by: pborla --- container-tag.yaml | 2 +- docs/Container_image.png | Bin 0 -> 12077 bytes docs/README | 85 +++++ docs/api-docs.rst | 6 +- docs/installation-guide.rst | 5 +- docs/overview.rst | 34 ++ docs/release-notes.rst | 506 ++++++++++++++++------------- docs/user-guide.rst | 190 ++++++++++- releases/container-release-o-du-l2 | 6 +- releases/container-release-o-du-l2-cu-stub | 6 +- tools/Fapi_Decoder/decoder.c | 2 - 11 files changed, 608 insertions(+), 234 deletions(-) create mode 100644 docs/Container_image.png diff --git a/container-tag.yaml b/container-tag.yaml index c74efefe2..447c5b6e1 100644 --- a/container-tag.yaml +++ b/container-tag.yaml @@ -1,4 +1,4 @@ # The Jenkins job requires a tag to build the Docker image. # Global-JJB script assumes this file is in the repo root. --- -tag: 10.0.1 +tag: 11.0.1 diff --git a/docs/Container_image.png b/docs/Container_image.png new file mode 100644 index 0000000000000000000000000000000000000000..f1cf9567fa579c0949626f380a4fbbb74159e8d3 GIT binary patch literal 12077 zcmcI~cT|&Gmp+Kd6;!-PQ4!E9RVgaHgGjH^NeB_?0fLl(lu%VvN&taS1e9Kbln_aT zhzf{^)DT(#r4xD!5CRjt^UeBZ)_iN$%y0ev$a+i8+2@>n-t+8dmltLxx@TE0vobI+ zoYmL6XU@RDh@k&`{y0T{Q#-EfLccKjo9o_XK>fI~Kz}&trfICnz)*u=J8)#CKc9Z2 zXXnqrz%6wAW7IbnTw`F6{G@+R)AF&yGKu9i=M1fVeeT@5sH^Fvnr56bHv+%#Cqy?< z@J$cnKu+-yp{YZo6CBD77rA6k0VmeFG1-3v? zSuxg@OZ7xnu{K&oCy{@~(3u!0a`q9zAv|R354+kaF`mY2Jb8;FmKJW`Q_fN=R}BID z40p<~!XDqVWN(I?lsVhM^!4<%tq?_;;in$IhKVK78DZzlUif61arz|5TJOT~{{a5q z*B9kk)AybIgwE5IFnzLv$>XnJ21QK_SKqx22ETkPRyg?kU%^-T1lg~O%s1T4Iu=(t z3K6z|C3B?Er)xz}YE=ngkoogiN`L`Xqgpo=RW6Gjkqo8}Wo;mSm}-oV4aNp3Pugyl#&q+y}{ zFln2w(FrWS-V~Itd+SQc*0lG>*Q|CfGk1bND0r2U@yo8zy5*q2&*MjZ35S7L^3hx! zNxS3-;>lGbUS|J#v9#TVufc72BT%CVa-$X-usY|-$b8+6tT%QgFlZA5U&X{|7 z>Wzl{`spw-M4Yza?2sR^X>77)b)Wi5Eo=UV(l3pm-j7ro`_C**1XUoK`P}^; zJHJfmA!4hoU1wLL&~@XmJ?B@<_6_7BVIP9-$& z6J<@^yb4Ih{fw^Tz!-L8Ea}=KOeemi$=7$K&2NWSwL{mpTfsIEQVNpQF3S(8Qfy3X zL4wlBE1eG=_}5c`uw@vi+o6Km9zt7*z4CJfzo2wv%Nelc^k>CSPEX-#Y@mR^T3YbE{Dk1ov?sq-|Y2-AB7Huhr{>Jq=ncU z)xZq-Z#a8&f;QYI938=n?A56r7R`v2uHLs!B9zaR32nru1KSH{eDJ^inmFs%_Lhnz z>Zl2*UTBLhhujUcFy2d>%U$mTvL#wDTh5EO%o=PNEE$|=XnvZH&wSj2@YH|NEc6w$ z(IYT&hlC6=J@PcGcRuHN!jPK9VCfDqegk;l|5tCpEml1|&`Co6(XMDvi$oBvD)1<8 zKJyl9Ih$19Fo^cC047hsS~dvNwPywSUeL(Vq_X}|JuKhG&txAcrt5ILgqg^_jtE>I zDSW0Cy0$D&kOdNWDulPf+jD;jRAcPGl-Y{vUBHX^*thDXs^`>4)S+KfIs;%6rn%C_ zw+@+l-P$~X*ThTPsLobe))8KwpM4E%ihgXmqwc96fMaOu*7-K()7u*o4few9 zXQx4d-RI?hC9{C={Dym)?|6>_Q37Li#bsFob2RvyRW`zA`$_{^c_V&vF$;J0z8QHS zxCR@gxJ`sinjyNEA|ioque$PWo>3<%pj&k&^^zo|z?G#P#r-Gq!-FwXsVF%DfeR-X z>MyweDcvZHLFHa9eWB&$WiJG+wMVv>mOC%4BDP)pA)`)w;KVDc-;iHX%O;m6`I|oM zE(yxy;q4<3qZO+<(1hGh9mBq&nrA?%rgzZjmT#U_Q#-1&_tf2?sb(_LhE8W#hYYrM zK1AcOFMr8~3xN_mOYgiXEPR66zS*(*exe12KuZd}yFeMKS=nBv$kjuIWU{-2aD0AG zlsBa2_SX@Glwyz1YGmr2e}>fQD9dD(T5>%3=;zKnE(%yT=hw^OtZ8V>-?-FpVxzRr zE#o@)H%8jn5CjohEZ>t&kFoB3x#VvIj6QnC{TmWnB2GP(Nv1>Eo0+KJ*U~`Qj?c*| zN#~9c?@Y#Z1le7IjEcR**paSj`l<|mtB-Jy-DL^-+r%J6 zG=Ce4B$cG!_P~3@vN2OypI?vVpA66GLtemdMLYrU*SSht@hn`WTb}zMD`O0oxz@4v zpf~?k6w~bAmP*`&z_*QY8neOVWIhh1ZA_7Rj#R(!jaQp)EjA8QR~4Yu?)rDCJ`ctP zB&qa3?B3~Nn?k$9)NWPbA7bVS{-Wm>WLb?`#p`TEj1O=&ea7;cc!g>_yBW8oxGh(OcG`t^@l|z} z31|Gn)PfC~J{Gp;D2vZC^{bnXw=a*m5$4lo6upsMV{ttEGYt-&+L(isxIrL>f3>*< zav0nsX;}MO#UXdC40zN{93)vQ?U-YB#B6Zw;LvW`7C9iIl3xLapC^1hk)r$3Qrf)F z%-AChWw`IcZTSUqKjbXBG<(=Ml+wFIWhn>)Eb{?{raCA}fv-67e&Rc^au1EK3;JmUtF# z$8~MQYu_Z(%Miaj-|h>|JIGFDaBhGVBBf0gFniY;>}NYHD{}Dv_zK$*10u| zb-p?{AfEw4YyE=2`N7F5=I_Q|qN~mk;tkMB@sJ|c8#nF;FGBmopVI zc5yLly7#W`cfz))0e4ow!{%J`Y(1=m!~O>`v_k7CQg47Df>UL0|0MXv`85BHydP(5 z%wDim=}*Y1SVspWgv~jDN5spYec(*EzrEOyDrI>8Q_rP&tc#0RMftbJ^dZlpjkx$0{SY|yNXr`Sdt8$Z=Am*!_{$J2rGvueP&s{ z{dTgtGxa$k>mHp(wpR)0mqAktFeqb_nIB7ceOXl+x;quuji^*?yY3#<;4sF7e8!6QveArg(;qH7qjU?50GXw?)KtV}a z+9l+#!y)zOl)05y;w~jFTnjF|=XQn6ZW}TGxm!_XJ^v{{Zf!`F2B%&81;=bGWuxo# zQX^9&%S$TIH{4%<08GZ4t*Hgit(!MT*<5;L>HHp z?>QM9ctVJEJ15Kklhp?S$!uuHyb>zW2ixeKy;RYC}KgF*2RNWmxe zHLrxz-h2^=$r>8GbDyDhvUo*YNVpfFNwg}j?~qcN?o6UJlk}O!3XpmHst{WtL;^}h zoK>y$$BY@}6-O-=DW^7x8<{G%R>Su5e8!kD?0)jE z2h{=5;#Y$$%`9HA%<`q^2Euo?F)Ihzt3eU!wCC=pYu^+J|E3dk!@ul$+loi*c=j!d z(SJLslBUteWa~qZezc5g(r=FwE2u2NUikEwK_Q)w5tHuU+SoMO1pu!J9aFH2zhP9v zq{sVjzIHYE>ThcH5AW5|vwTIIE|<;`{)x-~0|v2HK6wu zx&!b2-Dy=q{v|)7aew}yh$e%3)o$KNMusYfxZ_B~tSa3HkECRvm@5T zrX&9Vb_PI0L8$n7Ql}iso0&n6>p1N3FT4Hc=*T}edoxT5-SJ&Xg{24PHK|GhqJxd8 z4(%H4Cq!9n2wkPO5o2?Qs!NWPj@_CSvZ>luXZn1@2Vn54W)xAN0Y)M&O+l5{H7M<) z{5#!f=fJ1Epu>PDGV#bcLcLS%qI4gqfil}$;H+eAD2|H;I(6oZ2_N~}*300YksfFA z`mJ9&RI_=9QlS&ufwEJNcV;Wz15Fh^qQQlA$_FE%G=v?-iA8OZn_OFoqfN(<%9Cx~37XKU_Ht-V%-m^8jA~{vI|tyult1_^Uf!iW= zwd4XxmIXQo6zoES>(9E;9B1sWAk9xY7ixX9_hIvP3No0f3oY) zx)yIrl_2apw9&)hV&jDL@5+n&7pe2K-s`D-;mO(spO@Mm%vvgj# zK$XQRW)5uvx4s6?Rnr=^-3^;>Xf0zib2_`ThdpY0-d^D5=@FrFgvh43d4fVJSKkuJ z{{3s)?E<^zpk&{DXoEMll>#oC6AZwo`hTzYsZadWT?;RyxseH;-V>0CR!YSVE?r2K zr^Gw)D4}#EO_qd56y--VNy0%P;y7HngRiD7*)0vWlZ` ziU^+mG5(McLb5jyWw(C>0X^vT$6UeWksB7XpyUD*fAw(n;qH&UN(rt(tt>CMFJXr( zrK+aB(Hi^&5WM8WgGs%k*ACTy>IOs2&!VELuuZN*X)m2jkM9kanBV@y*w376+DBo# zDN|ap%l4EI=E>MEM}?!U(SrBrfYDJQd`t%6ZgqippAtEHjq1UOg@io$P{IM){ZtP%L`5xudLOaU$!r5^E z5s5XHN%D-ES;1eKL3SpJMVfnfgp*)LUFmf)FS9y z7Hy}bMQWE;0(7#I7%y&y0OO1`9bo-c`Jvkj@2fDK&AkPReQK^Fx*-$iL~<@jWPaZ1 z{l-h#Mu6W_xbaP~4zQ9Vm1QU1{@#=4&`;3ca}AYd{rYc*Qk^d!@uKleLS@Mm(k$}& zs2=|%3&@)f*UFQ>0c4|aJ>0SUtA;d%R}gakRSp~RcWHfl7!bU1>t)4$UuAuZYj0Cy z+T{Sb8R+O|WZqOb-t?%k?Q%NM2?V}T(?t7ZaTxx3ya4Xg(O~;dO6SEVY>efowS>dz z`44X6xt^n)=m)Why-mOR6kPj)%Utq9{VghV2J+4BzOWF|+6eQe|eW0{8!iZ|e^2(R-mfBAo&9Q+2SET~k zyse&?b&WMwq}bLlPJP&46+ur4=(h`nYwggn;6XyTzw3LW!;QLmhbb=JM_!O+?3I15 zvmp?#pOJAsJMale!gs^G4|^d2)xn~Qb~jCJn9M59Z`YUt)KYX$xoh+l`#n2j!Xv%D z-P_yb92Zn!Z}T$cSuvkLz_7RfHo_*$Sgt2Sr{-k&OxBE*M`&IUTD@3K|LxGubOO3o zwkAKr+~Qp_AN_3iJbv=y1`qSNA5O_Kw64X68Iq0OYLiCn)g}?X5=o9eVC!gOiue_k z93GiTZ$_Yn(JOahgyao7kIQ7U6I=<}T%-I>7Egf6#@BedpoS2*Xh*p8!W2E+9Z$!{ ztOj?UA`2T`Ehm8xhkltU(B072utq7_HQU|K0|;|jKUm3=hCf)DfMH5Cgi!38^FFp#!`|Jt&MUISH|FL#t*f zn3eXY7*fq+zN~Lvt0z^f*oU6ZYO4oa_Wv%pP$#oC!MP4E7`98FgsCMRn*16qknA?F zh9>c+=st5t;Z6a!Klh!6vC2KII#2spf6(QYm*JUJ9Gxa~m3B))K~!`>w=BJ*#pcXb z=l8h_<1bgb_>8tL<$vU6-?9G81G8B8Qo|00cc?cshXYaGO_a*1#UET|9QVyIjNw(p zA1Gpnn{UFfT!Q?Nn%T|yPkj5knJQVNf)NzOxoB6-Nay|H1sNQ0#-!pz*L=@6Lj_KeLv1?2iX4p+hfV z)GB&}C0JgD*Knd0m7ZO==3~`j+hO0*_XUF)P{U1`#_suxE)7}z$`EQYrE1zJ>+R>t zWmgUzzABuPNf_pcIc$T$7;}2cX!-d2LLWGPk%Y;3rKK}9<+Gl90ZI}amoVkMP+y}l#@%l`q54%^mdxR(K zc1A&ez0-s?C&s;p$3}2VbR`~rI833gy@T6U+S zuPI`+b4L2&6Lc4XZ@gPTicelBoUa{R5=K8W&!x{n8k`h%u>Lf+{)bvlbPUvC)Ya5x zEbcr7Cz((_Oatwe$JSq0+pTU6h(PPupp+N)Ud(hj0fSCt?$4AQhL#)E_Mu|;X>~0g zHadnkOc`xJF6u_*-ui;Q{z{1(I1>A2yEo<96wP;Frw#G5LjLs}SY8Ug`NQ+DuEcao z-BxQVN##!Atx2!o?HFipZpB`^>!C^9J}S{0dT}wPJ7OXnZ5M6o&=k;ndgU!#?vWEp zv7ffPjqL4fgv%Ugg3HlwzZ6e#mpHw5OkEqe-w$*GV$fOp`?p%sslLJD%a`*>|P8NjvX0 z(Sg+>RJm45sWiNeVA7|KH4w&u@4MFF_PZ*z3De2fSdD5&4n=lrua!65=zUHIV1vtT z=ue=FP8MhsYY2rLR5Qux8(jtLtZ8NsGDF!OSqQ`Dkqf%0k15l{GK)nuQ;?6ZfhfdI z>=A4glTC&%?KKZLN!X}=Sa@e?bCkJ5vm6N&-@%~|YW>1!vlovVFJJG2154Vj$`q%{ zr02Wrgb1;Em+a&;)Hxw%K-F*r%n;SsVqf**{hm_5R?)bH_@DDM2nfK|kGbKw6Kixu zZV34_z-wT{vZ7zuNHoJUR5mexwPe|WNs_G_hLLhxfl-3+K@j#F&EMV z&usv9raGr2>K_C<3v^t+z7MJcT>Pb!f~xPlc35LDng~l&8AwG?b=Sj?|u*7}3q;lBg=8c+0(!dtm#~p!V}}_Yc{G-3s4=uss~kP;mYgPO$rt-?pvX4u0R^$@N#5p2WY3;#~Z&k zGY@$%M>u%=qz!RddDp%SANB0Z1*KYgC|{j&7@*ZrW6)Cy23~-?HpGB&ai;lO{X+8yCU+2>KmWOEy&G~cPj?@~Bm0F4o!k%&PT zm%8rwl;}il6-CiT_vlD~yxixqAS8$EEUL@00lW_cs`kNNu&+k5_0 zDwWl2J+jo>>`osxPjxe?F*;TasIM!#>4y`impCj%*l-L)`qrogDEk`Q6y@+NT?Sm1 zk>pnBtQq{%ZMUzx(jbGmXtioauCDCSjT&)0!J&DeQFO7kuSU|SnI3r=yi~G$G+#DS zle&94@?pnfC(&We#a`&}RL{Ppul~+bFT$dVm7H=z2gH$`8{zrT+xCTSlz#Pn57MoN zjD{_uWxP5qcNsy9HxJcv4D(&`ed8WeUbQh>IuYl}+8n;-@{kQ`w#A}6ToDb1w57{t zawFUzM_cM$_-@vX5BD7@NNI%>`J|hG&g14 zc^YtK8Q{|Do|7eE_4r3jZzRS$uI+Y;n$6Umz&oWoF#ujjS=r13t~18N3300es@11? zR526PQ02>;@;yCj?25v{yH%q>U3Vlq#y{;2OUJbDJ#dT~6pg$wv>03QVAxFl<%t)k z%(jnoMHR@!Fi|}oGM;!xwS+kDcV$Nn1i716wf!^^D0*$^Dyqtq(QrbGq}htKsh0?> z&514@cdLuKp=t4A+b-XnIsx4bT3S*EBW3UVL7#U;_X(MJ<>(;LVeQJfQdtUuYHf~H z@plah4I&{D?%(QC$^a;(z`)mRVs_h=s{d|wrkL}rTFRGlmZ~IEuqhW&6 z_EmJqhn-4>ESXI)%DUVwP-Q2pyCgkot21>c|K`tfHbasQ*24^d zq?sYp&icvAj1SoE+r!h_tnc+dySZ(rLFb5(7rR_*TikL&^Vd(2yyPqtW5$e&=vh5= zxth1HGeI9ev_&d1$S|Gy&dAV6Pb2?Ng=N|~f`2e%1S#mBXGps7e=i*Kyl+ET4j^au zsxr6_H>*1n<{biktw0PK<^N4J+ds!^|KTP4>t-6S=4<<~T^VbT`oj0%XXECS{mPy| z&(LDfxH{m(n=Ah{7990GLv>qOUGmQM2UT*LPVp676m|WX#mmI9FYRWo@u8@drgh?I zNW|{uAgr3GQ!De zSx;z>0=#gpa9ZY((Q?IZ2wFYT;9Bt23!IZ&YvIjD8(9x_%d%J5LvhSI3LREby#!+c z)d6GPcM%;A=9xCrbQ?1T2uBes3sQ z1FcqSit`JaKXbh;E}ZtX7=bcA8S+-1$kIW7+#S;o4|L`o#1M%S=)4@4|Pz zMSZrTG%~X*jN)fYLM69cQu0=mCc5zO2+W$c>3b7Q^TNoE{ixK@Oh;6Blhv{^_T1dL zz-3cx?}U=Wrn&Lj_#iEyz3~v{>zxiJA@w^PXIYMRT(*6%`+l>rQ(+#d_O7Pczwo-- z9G$x^5Jl1VqjKT_(?y54vH_>PnPgr#+g}~sF{nr0*y>qu#cDC-Wy5lNw#jB5rsq%O zF5G3pw3;xt;2(z`i7cjPGPod@Y?1mk*^r}FTZxFMoTK@2CGlUY*?~=%ts=titMB+_ zM`#oXQO!1_(_+CrwrWHyCL0_!-;XwzXi6GjF*^u(-KH^+;x5Vi=H z@4v%HioqgU?fg72D}&9c^qFr=csCmd#-$IqO?0Oiy=}Nz%|oi_R`YC52;6bGHriIW zBKf9Fk6-U;bOF}VfHcqzj)#0(gk;hBEhiAwnvNtHhqpkd?}s~vU}3c6<-P`D+wo|g zPep4)Cq0`WXNN!Hgm_>)t-#Zej(MDw#88Wf3>A8rff$sn=o_~6?bcwC+*DHyj2u5P z!1aeEYX?*2o5OJCJ^_=_Z|qx#8$(?$m=&ZL+^QS^(G5ZAYp|MC72A z71Dlxz-LDEtEWcTH(%bp6;;^80JYF%5Ba$Rzof(fuB}^ZXLAj%6~P3$o?~-Hs_5zeF4G_yf&F;} zu7Y-&NVT>-z&*VCwqeYTz;Xe$AeR8J=^M zXq&}M)+lsC5Bz+P%DdST>)!T~8h!MM{qgkUPa64E_;0c-IE>72BW+Y2Ph2y*SmW zaGY)YFE!Ht8>=#yk1A)Qn>~7&8^cwr|7t=0zZOmZPYKeB|EQoY2xW*=$yReT3h<$4 t^yur=2J$m7aB9(Oy#HlpRO1Itz19CDzfZjoy)6TSzP8Cd)ZGWs{|1qP(w+bS literal 0 HcmV?d00001 diff --git a/docs/README b/docs/README index b84c2962e..127e55d37 100644 --- a/docs/README +++ b/docs/README @@ -20,6 +20,14 @@ A. Directory Structure : h. rlog : logging module i. O1 : O1 module +4. l2/container/ : contains helm charts of DU, CU and RIC + a. cu_helm : CU helm chart + b. du_helm : DU helm chart + c. ric_helm : RIC helm chart + +5. l2/tools/ : + a. Fapi_Decoder : Decodes FAPI messages + b. Memory_Leak_Detector : Detects memory leaks B. Pre-requisite for Compilation : ---------------------------------- @@ -313,3 +321,80 @@ J. Troubleshooting Netconf server issues $cd l2/build/scripts $sudo ./troubleshoot_netconf.sh cleanup execute section C.3 and C.4 again + +K. Running the DU, CU Stub and RIC Stub in containerization mode +----------------------------------------------------------------- + +1. Pre-requisite for Running in Containerization Mode + + - Install Docker + + - Set Up Kubernetes Cluster Using Minikube and Use Docker as the Driver + + +2. Steps to Run the DU, CU Stub, and RIC Stub in Containerization Mode + a. Clone and compile the Code + - Create a directory: + i. mkdir ODU_CONTAINER + + - Navigate to the directory: + i. cd ODU_CONTAINER + + - Clone the repository: + i. git clone "https://gerrit.o-ran-sc.org/r/o-du/l2" + + - Compilation steps are mentioned in section d. + + b. Set Docker Environment + - Set up Docker environment for Minikube: + i. eval $(minikube docker-env) + + c. Generate Docker Images + - Navigate to the l2 directory: + i. cd l2 + + - Build the Docker images: + i. docker build -f Dockerfile.cu -t new-cu-container:v1 . + ii. docker build -f Dockerfile.ric -t new-ric-container:v1 . + iii. docker build -f Dockerfile.du -t new-du-container:v1 . + + d. Check Docker Images + - Run the following command to check if the Docker images are created: + i. docker images + + e. Deploy with Helm + - Go to the container/cu_helm directory and deploy the ocu chart: + i. cd container/cu_helm + ii. helm install ocu cu + + - Go to the du_helm directory and deploy the odu chart: + i. cd ../du_helm + ii. helm install odu du + + - Go to the ric_helm directory and deploy the ric chart: + i. cd ../ric_helm + ii. helm install ric ric + + f. Get Pod, Deployment, and Service Info + - Run the following command to get information about the pod, deployment, and service: + i. kubectl get all + + g. Run the Pods in Separate Terminals + - Terminal 1 (CU Pod): + i. kubectl exec -it -- bash + ii. ./cu-docker-entrypoint.sh + iii. cd /root/l2/build/odu/bin + iv. ./cu_stub/cu_stub + + - Terminal 2 (RIC Pod): + i. kubectl exec -it -- bash + ii. ./ric-docker-entrypoint.sh + iii. cd /root/l2/build/odu/bin + iv. ./ric_stub/ric_stub + + - Terminal 3 (DU Pod): + i. kubectl exec -it -- bash + ii. ./docker-entrypoint.sh + iii. cd /root/l2/bin + iv. ./odu/odu + diff --git a/docs/api-docs.rst b/docs/api-docs.rst index b7520d8d5..9f4eb45fe 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -6,7 +6,7 @@ API-Docs ######## -This is the API-docs for J release o-du/l2. +This is the API-docs for K release o-du/l2. .. contents:: :depth: 3 @@ -296,7 +296,7 @@ Note: DU APP module consist functionality related to F1 Handler, E2 Handler and | +-------------------------------+-----------------+-----------+-----------------------------------------+ | |Cell Configuration Request | Additional API | |Configures cell information at MAC. | | +-------------------------------+-----------------+-----------+-----------------------------------------+ -| |Cell Configuration Response | Additional API | |Response to cell Cfg Req from DUAPP | +| |Cell Configuration Response | Additional API | |Response to cell Cfg Req from DUAPP | | +-------------------------------+-----------------+-----------+-----------------------------------------+ | |Cell Delete Request | Additional API | |Deletes cell information at MAC. | | +-------------------------------+-----------------+-----------+-----------------------------------------+ @@ -380,7 +380,7 @@ Note: DU APP module consist functionality related to F1 Handler, E2 Handler and |**DU APP** +-------------------------------+-----------------+-----------+-----------------------------------------+ | & **RLC** |UL-RRC Message Delivery Report | Aligned |11.2.5.9 | | | +-------------------------------+-----------------+-----------+-----------------------------------------+ -| |RLC Max Retransmission Reached | Not Implemented |11.2.5.10 | | +| |RLC Max Retransmission Reached | Aligned |11.2.5.10 | | | +-------------------------------+-----------------+-----------+-----------------------------------------+ | |UL-RLC Re-establishment Request| Not Implemented |11.2.5.11 | | | +-------------------------------+-----------------+-----------+-----------------------------------------+ diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 1cbea4cbc..92470c3ba 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -18,7 +18,10 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 2023-06-10 | 8.0.1 | Radisys | J release | +| 2024-12-10 | 9.0.1 | Radisys | K release | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2024-06-10 | 8.0.1 | Radisys | J release | | | | | | +--------------------+--------------------+--------------------+--------------------+ | 2023-12-14 | 7.0.1 | Radisys | I release | diff --git a/docs/overview.rst b/docs/overview.rst index 45f88a161..e91118fb4 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -812,3 +812,37 @@ The O-DU High partially supports below use-cases: - Health Check +Containerization of DU, CU stub & RIC stub +------------------------------------------- + + +This section describes the Containerization of DU, CU stub and RIC stub: + +- The DU, CU Stub, and RIC Stub are packaged into portable containers for consistent operation across various environments. + +- Docker is used to create these containers, ensuring that all necessary dependencies are included for proper functionality. + +- These containers are deployed and managed using Kubernetes, which handles scaling, load balancing, and resource allocation. + +- Helm automates the deployment and configuration of the containers, simplifying the management process. + + +.. figure:: Container_image.png + :width: 300 + :alt: Containerization of DU, CU stub & RIC stub + + Figure 28 - Containerization of DU, CU stub & RIC stub + +Addition Functionality +----------------------- + +Tool for FAPI message decoder ++++++++++++++++++++++++++++++ + +- This tool decodes FAPI messages exchanged between the DU and L1. + +Tool for Memory leak ++++++++++++++++++++++ + +- The tool detects the memory leaks in the ODU code. + diff --git a/docs/release-notes.rst b/docs/release-notes.rst index cf1dc1358..11b91a09c 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,7 +5,7 @@ Release-Notes ************** -This document provides the release notes for J Release of O-DU-L2. +This document provides the release notes for K Release of O-DU-L2. .. contents:: :depth: 3 @@ -19,6 +19,9 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2024-12-10 | 11.0.0 | Radisys | K release | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ | 2024-06-10 | 10.0.0 | Radisys | J release | | | | | | +--------------------+--------------------+--------------------+--------------------+ @@ -59,6 +62,16 @@ Version history Summary ------- +K- release +^^^^^^^^^^ +This release contains the following: + + - Containerization of CU-STUB, RIC-STUB and ODU + + - FAPI Decoder Tool + + - RLC Max Retransmission between RLC and DU is implemented + J- release ^^^^^^^^^^ This release contains the following: @@ -249,6 +262,25 @@ This release contains the following: Release Data ------------ +K release +^^^^^^^^^^ ++--------------------------------------+------------------------------------------+ +| **Project** | ODUHIGH | +| | | ++--------------------------------------+------------------------------------------+ +| **Repo/commit-ID** | o-du/l2/ | +| | I9d986dc7af6bb5b6a745804f90fe2c648dbb5465| ++--------------------------------------+------------------------------------------+ +| **Release designation** | K release | +| | | ++--------------------------------------+------------------------------------------+ +| **Release date** | 2024-12-10 | +| | | ++--------------------------------------+------------------------------------------+ +| **Purpose of the delivery** | K release | +| | | ++--------------------------------------+------------------------------------------+ + J release ^^^^^^^^^^ +--------------------------------------+------------------------------------------+ @@ -456,267 +488,307 @@ Feature Additions **JIRA BACK-LOG:** +K-release +^^^^^^^^^^ + ++-------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-611 | Containerization of ODU, CU stub & RIC stub | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-618 | Tool for FAPI message decoder | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-625 | Adding trigger for RLC_MAX_Transmission at RLC| +| | and handling RlcMaxRetransInd at DU | ++-------------------------------------------------------+-----------------------------------------------+ + J-release ^^^^^^^^^^ -+-----------------------------------------------+-----------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-556 | Multi UE per slot scheduling UL | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-538 | XML based input configuration for ODU-High | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-557 | OSC-OAI Collaboration | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-475 | Integration of ODU-High with intel L1 | -| | | -+-----------------------------------------------+-----------------------------------------------+ ++--------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-556 | Multi UE per slot scheduling UL | +| | | ++--------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-538 | XML based input configuration for ODU-High | +| | | ++--------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-557 | OSC-OAI Collaboration | +| | | ++--------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-475 | Integration of ODU-High with intel L1 | +| | | ++--------------------------------------------------------+-----------------------------------------------+ I-release ^^^^^^^^^^ -+-----------------------------------------------+-----------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-516 | Alignment to "O-RAN.WG3.E2AP-R003-v03.00" and | -| | "O-RAN.WG3.E2SM-KPM-R003-v03.00" | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-517 | Multi UE per slot scheduling | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-518 | Alignment to ORAN WG8 AAD v9.0 specification | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-538 | XML based input configuration for ODU-High | -| | | -+-----------------------------------------------+-----------------------------------------------+ ++-------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-516 | Alignment to "O-RAN.WG3.E2AP-R003-v03.00" and | +| | "O-RAN.WG3.E2SM-KPM-R003-v03.00" | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-517 | Multi UE per slot scheduling | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-518 | Alignment to ORAN WG8 AAD v9.0 specification | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-538 | XML based input configuration for ODU-High | +| | | ++-------------------------------------------------------+-----------------------------------------------+ H-release ^^^^^^^^^^ -+-----------------------------------------------+-----------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-463 | Inter-CU Handover | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-488 | Alignment to ORAN WG8 AAD v7.0 specification | -| | and Enhancement for Multi-scheduling alogrithm| -| | framework | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-510 | E2 upgrade to v3.0 and enhancement | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-475 | Integration of ODU-High with L1 | -| | | -+-----------------------------------------------+-----------------------------------------------+ ++-------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-463 | Inter-CU Handover | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-488 | Alignment to ORAN WG8 AAD v7.0 specification | +| | and Enhancement for Multi-scheduling alogrithm| +| | framework | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-510 | E2 upgrade to v3.0 and enhancement | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-475 | Integration of ODU-High with L1 | +| | | ++-------------------------------------------------------+-----------------------------------------------+ G-release ^^^^^^^^^^ -+-----------------------------------------------+-----------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-461 | Improvement of code coverage | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-462 | Implementation of Discontinuous Reception(DRX)| -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-464 | Alignment to latest ORAN WG8 AAD specification| -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-475 | Integration of ODU-High with L1 | -| | | -+-----------------------------------------------+-----------------------------------------------+ ++-------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-461 | Improvement of code coverage | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-462 | Implementation of Discontinuous Reception(DRX)| +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-464 | Alignment to latest ORAN WG8 AAD specification| +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-475 | Integration of ODU-High with L1 | +| | | ++-------------------------------------------------------+-----------------------------------------------+ F-release ^^^^^^^^^^ -+-----------------------------------------------+-----------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-402 | Support for HARQ and scheduler enhancement to | -| | prioritize retransmission | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-404 | Support for E2AP version 2.0 | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-405 | Support for Inter-DU Handover | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-406 | Support for Idle Mode Paging | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-429 | O1 Enhancements | -| | | -+-----------------------------------------------+-----------------------------------------------+ ++-------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-402 | Support for HARQ and scheduler enhancement to | +| | prioritize retransmission | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-404 | Support for E2AP version 2.0 | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-405 | Support for Inter-DU Handover | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-406 | Support for Idle Mode Paging | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-429 | O1 Enhancements | +| | | ++-------------------------------------------------------+-----------------------------------------------+ e-release ^^^^^^^^^^ -+-----------------------------------------------+-----------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-351 | Support for Multi bearers | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-352 | Support for Multi UE | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-363 | Network Slicing support | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-340 | Resource allocation in time domain changes to | -| | meet flexible k0, k1 and k2 values | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-361 | Support for cell configuration over O1 | -| | interface | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-395 | Optimization, scaling and rework | -| | | -+-----------------------------------------------+-----------------------------------------------+ ++-------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-351 | Support for Multi bearers | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-352 | Support for Multi UE | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-363 | Network Slicing support | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-340 | Resource allocation in time domain changes to | +| | meet flexible k0, k1 and k2 values | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-361 | Support for cell configuration over O1 | +| | interface | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-395 | Optimization, scaling and rework | +| | | ++-------------------------------------------------------+-----------------------------------------------+ D ^^^^^^^ -+-----------------------------------------------+-----------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-264 | Support for Mu1 | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-265 | Support for 100 MHz | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-266 | Support for TDD mode | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-267 | Integration with O-DU Low in Radio mode | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-268 | Integration with O-CU | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-269 | Support for E2E testing | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-299 | Closed Loop Automation use-case | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-196 | Netconf session for O1 interface for CM | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-340 | Resource allocation in time domain changes to | -| | meet flexible k0, k1 and k2 values | -+-----------------------------------------------+-----------------------------------------------+ ++-------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-264 | Support for Mu1 | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-265 | Support for 100 MHz | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-266 | Support for TDD mode | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-267 | Integration with O-DU Low in Radio mode | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-268 | Integration with O-CU | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-269 | Support for E2E testing | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-299 | Closed Loop Automation use-case | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-196 | Netconf session for O1 interface for CM | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-340 | Resource allocation in time domain changes to | +| | meet flexible k0, k1 and k2 values | ++-------------------------------------------------------+-----------------------------------------------+ Cherry ^^^^^^^ -+-----------------------------------------------+-----------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure with basic scheduling | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-188 | Support for all short PRACH formats | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-191 | Explore O1 interface | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-189 | Integration with O-DU Low | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-184 | UE UL Data path | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-185 | UE DL Data path | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-186 | Applying 64 QAM Modulation in DL | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-187 | Applying 16 QAM Modulation in UL | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-190 | Integration with VIAVI Software | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-214 | get-AlarmList implementation on O1 interface | -| | | -+-----------------------------------------------+-----------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-196 | CM Support on O1 interface | -| | | -+-----------------------------------------------+-----------------------------------------------+ ++-------------------------------------------------------+-----------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-10 | UE attach procedure with basic scheduling | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-188 | Support for all short PRACH formats | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-191 | Explore O1 interface | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-189 | Integration with O-DU Low | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-184 | UE UL Data path | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-185 | UE DL Data path | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-186 | Applying 64 QAM Modulation in DL | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-187 | Applying 16 QAM Modulation in UL | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-190 | Integration with VIAVI Software | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-214 | get-AlarmList implementation on O1 interface | +| | | ++-------------------------------------------------------+-----------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-196 | CM Support on O1 interface | +| | | ++-------------------------------------------------------+-----------------------------------------------+ Previous Releases ^^^^^^^^^^^^^^^^^^ -+---------------------------------------------+-------------------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+---------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-1 | F1-C enhancement | -| | | -+---------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-5 | F1-U implementation | -| | | -+---------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-11 | E2 implementation | -| | | -+---------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-9 | Cell broadcast procedure | -| | | -+---------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure till msg-4 | -| | | -+---------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-8 | FAPI interface implementation | -| | | -+---------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-27 | RLC layer interface enhancements | -| | | -+---------------------------------------------+-------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++-----------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-1 | F1-C enhancement | +| | | ++-----------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-5 | F1-U implementation | +| | | ++-----------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-11 | E2 implementation | +| | | ++-----------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-9 | Cell broadcast procedure | +| | | ++-----------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-10 | UE attach procedure till msg-4 | +| | | ++-----------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-8 | FAPI interface implementation | +| | | ++-----------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-27 | RLC layer interface enhancements | +| | | ++-----------------------------------------------------+-------------------------------------------------+ Bug Corrections ---------------- **JIRA TICKETS:** +K-release +^^^^^^^^^^ + ++------------------------------------------------------+-------------------------------------------------+ +| **JIRA REFERENCE** | **BUG DESCRIPTION** | +| | | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-631 | MSG4 PDCCH and PDSCH crash fix when K0 is not 0 | +| | | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-629 | SlotCfg correction as per TDD_PERIODICITY and | +| | numerology | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-624 | UL AM Config and DL AM Config to be swapped in | +| | UE Create/Reconfg API (F1AP-RLC Interface) | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-623 | Added RbType In UL/DL Data Transfer in | +| | RLC-MAC Interface | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-623 | Added RbType In UL/DL Data Transfer in | +| | RLC-MAC Interface | ++------------------------------------------------------+-------------------------------------------------+ + J-release ^^^^^^^^^^ -+----------------------------------------------+-------------------------------------------------+ -| **JIRA REFERENCE** | **BUG DESCRIPTION** | -| | | -+----------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-606 | Fixing null memory size allocation issue | -| | | -+----------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-593 | Pack and unpack function nomenclature correction| -| | | -+----------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-584 | Fixing the error number issue CmInetSctpConnectx| -| | function | -+----------------------------------------------+-------------------------------------------------+ -| https://jira.o-ran-sc.org/browse/ODUHIGH-574 | Fix for Inconsistent behavious in ML | -| | | -+----------------------------------------------+-------------------------------------------------+ ++------------------------------------------------------+-------------------------------------------------+ +| **JIRA REFERENCE** | **BUG DESCRIPTION** | +| | | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-606 | Fixing null memory size allocation issue | +| | | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-593 | Pack and unpack function nomenclature correction| +| | | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-584 | Fixing the error number issue CmInetSctpConnectx| +| | function | ++------------------------------------------------------+-------------------------------------------------+ +| https://lf-o-ran-sc.atlassian.net/browse/ODUHIGH-574 | Fix for Inconsistent behavious in ML | +| | | ++------------------------------------------------------+-------------------------------------------------+ Deliverables diff --git a/docs/user-guide.rst b/docs/user-guide.rst index fa7cda8ef..834a7bd1e 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -4,7 +4,7 @@ User Guide *********** -This is the user guide for J release of O-DU/l2. +This is the user guide for K release of O-DU/l2. Follow installation-guide to get all the dependencies ready. .. contents:: @@ -66,17 +66,17 @@ II. Execution - Using Docker Images The call flow between O-DU High and CU Stub can be achieved by executing docker containers. - Pull the last built docker images: - - docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:10.0.1 + - docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:11.0.1 - docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub: - Run CU Stub docker: - docker run -it --privileged --net=host --entrypoint bash - nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:10.0.1 + nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:11.0.1 - ./cu_stub - Run ODU docker: - docker run -it --privileged --net=host --entrypoint bash - nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:10.0.1 + nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:11.0.1 - ./odu @@ -254,3 +254,185 @@ E. How to execute the Health Check using netopeer-cli : get alarm-list The XML output is a list of active alarms in the O-DU High system. +F. Running the DU, CU Stub and RIC Stub in containerization mode +----------------------------------------------------------------- + +1. Pre-requisite for Running in Containerization Mode + + - Install Docker + + - Set Up Kubernetes Cluster Using Minikube and Use Docker as the Driver + + +2. Steps to Run the DU, CU Stub, and RIC Stub in Containerization Mode + a. Clone and compile the Code + - Create a directory: + i. mkdir ODU_CONTAINER + + - Navigate to the directory: + i. cd ODU_CONTAINER + + - Clone the repository: + i. git clone "https://gerrit.o-ran-sc.org/r/o-du/l2" + + - Compilation steps are mentioned in section d. + + b. Set Docker Environment + - Set up Docker environment for Minikube: + i. eval $(minikube docker-env) + + c. Generate Docker Images + - Navigate to the l2 directory: + i. cd l2 + + - Build the Docker images: + i. docker build -f Dockerfile.cu -t new-cu-container:v1 . + ii. docker build -f Dockerfile.ric -t new-ric-container:v1 . + iii. docker build -f Dockerfile.du -t new-du-container:v1 . + + d. Check Docker Images + - Run the following command to check if the Docker images are created: + i. docker images + + e. Deploy with Helm + - Go to the container/cu_helm directory and deploy the ocu chart: + i. cd container/cu_helm + ii. helm install ocu cu + + - Go to the du_helm directory and deploy the odu chart: + i. cd ../du_helm + ii. helm install odu du + + - Go to the ric_helm directory and deploy the ric chart: + i. cd ../ric_helm + ii. helm install ric ric + + f. Get Pod, Deployment, and Service Info + - Run the following command to get information about the pod, deployment, and service: + i. kubectl get all + + g. Run the Pods in Separate Terminals + - Terminal 1 (CU Pod): + i. kubectl exec -it -- bash + ii. ./cu-docker-entrypoint.sh + iii. cd /root/l2/build/odu/bin + iv. ./cu_stub/cu_stub + + - Terminal 2 (RIC Pod): + i. kubectl exec -it -- bash + ii. ./ric-docker-entrypoint.sh + iii. cd /root/l2/build/odu/bin + iv. ./ric_stub/ric_stub + + - Terminal 3 (DU Pod): + i. kubectl exec -it -- bash + ii. ./docker-entrypoint.sh + iii. cd /root/l2/bin + iv. ./odu/odu + +G. Steps to run FAPI decoder +----------------------------- + +1. Enable the Platform flag in the main makefile + - Location: `l2/build/odu/makefile` + - Add `-DFAPI_DECODER` to the `PLTFRM_FLAGS` line. It should look like: + `PLTFRM_FLAGS = -UMSPD -DODU -DINTEL_FAPI -DODU_MEMORY_DEBUG_LOG -DFAPI_DECODER` + +2. Compile and generate all binaries + - Binaries to compile: + - ODU + - CU_STUB + - RIC_STUB + +3. Go to the `l2/tools/Fapi_Decoder` directory and compile the decoder + - Run the following command: `gcc -o decoder decoder.c` + +4. Execute binaries and capture logs + - Step 1: Open four terminals: + - Terminal 1: Execute the RIC binary. + - Terminal 2: Execute the CU binary. + - Terminal 3: Execute the ODU binary. + - Terminal 4: Capture the logs at the decoder and run `./decoder`. + - Step 2: Execute the RIC and CU binaries in Terminal 1 and Terminal 2. + - Step 3: Run the decoder in Terminal 4 using the `./decoder` command. + - Step 4: Execute the ODU binary in Terminal 3 after completing the previous steps. + +H. Steps to run the memory leak tool +------------------------------------- + +1. Enable the Platform flag in the main makefile + - Location: l2/build/odu/makefile + - Add -DODU_MEMORY_DEBUG_LOG to the PLTFRM_FLAGS line: + PLTFRM_FLAGS = -UMSPD -DODU -DINTEL_FAPI -DODU_MEMORY_DEBUG_LOG + +2. Enable the CLA Use-case (Enable the Cell Down scenario) + - A hack to enable the complete scenario from Cell Up to Down so that memory status can be captured: + - This ensures that memory allocation and deallocation are tracked throughout the Cell Up and Cell Down process. + - The goal is to log memory usage and status for debugging or analysis during the transition from Cell Up to Cell Down. + + Files to change: + - File 1: l2/src/du_app/du_egtp.c + - In the egtpRecvMsg() function: + - Disable the infinite while loop in the EGTP receiver thread. + + - File 2: l2/src/du_app/du_f1ap_msg_hdl.c + - In the BuildAndSendUeCtxtRsp() function: + - Inside the case "UE_CTXT_MOD" action type, add: + BuildAndSendDUConfigUpdate(SERV_CELL_TO_DELETE); + +3. Compile and generate all binaries + - Binaries to compile: + - ODU + - CU_STUB + - RIC_STUB + +4. Execute binaries and capture logs + - Step 1: Execute RIC and CU binaries. + - Step 2: Before running the ODU binary: + - Capture logs using the script command. + +5. Complete CELL Down and stop capturing logs + - Once the CELL Down process completes in the ODU console: + - Stop/kill the ODU binary. + - Exit log capture. + +6. Download console logs + - Save the logs to your system (e.g., Desktop). + +7. Analyze ODU console logs + - Download TextAnalysisTool.NET.exe + - Open the log in the tool: + - File -> Open + - Filter ALLOC and FREE logs: + - Filters -> Add New Filters + - Add ALLOC and FREE filters. + - View -> Show only Filtered Lines + - Copy filtered results to separate Excel sheets. + - Split data into columns in Excel: + - Data -> Text to Columns + - Step 1: Choose Delimited + - Step 2: Select Tabs, Semicolon, and Comma + - Step 3: Click Finish + - Copy columns C and D (Size and Address). + +8. Generate memory logs + - Go to l2/tools/Memory_Leak_Detector + - Delete old files: + - freeoutput.txt + - allocoutput.txt + - Copy data to files: + - Paste columns C and D into:(Refer above 7th point) + - alloc.txt + - free.txt + - Remove double spaces: + - `:%s/ / /g (execute twice)` + - Compile the program + - `gcc -o scan.out scan.c` + - Execute the program: + - `./scan.out` + +9. Analyze outputs logs + - freeoutput.txt should be empty. + - If there is any address present in freeoutput.txt then check the address and resolve the dangling pointer issue. + - allocoutput.txt may show some initial allocations. + - If there is any address present in allocoutput.txt then check the address and free the memory allocation. diff --git a/releases/container-release-o-du-l2 b/releases/container-release-o-du-l2 index 146df7498..594e34852 100644 --- a/releases/container-release-o-du-l2 +++ b/releases/container-release-o-du-l2 @@ -1,11 +1,11 @@ --- distribution_type: container -container_release_tag: 10.0.1 +container_release_tag: 11.0.1 container_pull_registry: nexus.o-ran-sc.org:10004 container_push_registry: nexus.o-ran-sc.org:10002 project: o-du-l2 -ref: 666701aebc17e9f0160ad0f763497503d7c67870 +ref: 022cddba581286d2a334e05086cbb6a534f3efd2 containers: - name: o-du-l2 -version: 10.0.1 +version: 11.0.1 diff --git a/releases/container-release-o-du-l2-cu-stub b/releases/container-release-o-du-l2-cu-stub index ac7e37793..717502f44 100644 --- a/releases/container-release-o-du-l2-cu-stub +++ b/releases/container-release-o-du-l2-cu-stub @@ -1,11 +1,11 @@ --- distribution_type: container -container_release_tag: 10.0.1 +container_release_tag: 11.0.1 container_pull_registry: nexus.o-ran-sc.org:10004 container_push_registry: nexus.o-ran-sc.org:10002 project: o-du-l2 -ref: 666701aebc17e9f0160ad0f763497503d7c67870 +ref: 022cddba581286d2a334e05086cbb6a534f3efd2 containers: - name: o-du-l2-cu-stub -version: 10.0.1 +version: 11.0.1 diff --git a/tools/Fapi_Decoder/decoder.c b/tools/Fapi_Decoder/decoder.c index 428515c34..fd5b104e5 100644 --- a/tools/Fapi_Decoder/decoder.c +++ b/tools/Fapi_Decoder/decoder.c @@ -72,8 +72,6 @@ uint8_t processFapiMsg(uint8_t *buffer, size_t buffer_size) fapi_ul_tti_req_t *ulTtiReq = (fapi_ul_tti_req_t *)buffer; decode_fapi_ul_tti_req(ulTtiReq); } - printf("\nPrinting fapi_config_req_t\n"); - printf("\nPrinting fapi_config_req_t\n"); return 1; } -- 2.16.6