From 24b27c6941222a0405a2ecdd5dff7f825a66012a Mon Sep 17 00:00:00 2001 From: ivaosthu Date: Fri, 8 Feb 2019 08:30:07 +0100 Subject: [PATCH] fix: Toggle variants documentation --- docs/assets/variants.png | Bin 0 -> 15383 bytes docs/beta-features.md | 52 +++++++++++++++++++++++++++++++++++++++ website/sidebars.json | 3 ++- 3 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 docs/assets/variants.png create mode 100644 docs/beta-features.md diff --git a/docs/assets/variants.png b/docs/assets/variants.png new file mode 100644 index 0000000000000000000000000000000000000000..e77dc9d3bc148aa15b3256caa5b1d285a7ce4961 GIT binary patch literal 15383 zcmeIZXIN9;x9WxP3k zeEYViWl)OqGkkLS20n+poRMBb7bQ)l+d|NduPG6rc_AvnhIKu}fd<%FrMtquft$xB zMTI9hAwfBfG4bo%wFstgKnlL)GUiUmi!yd{TFc|i6)C}Vv8@B|{)O1XbOBdA{UW{Z z4}Un3%gr(ePSBnrdR+8iE|UAedyDI-MeI_@VYTl}1f!u+s4oLL!N*E{DH zh#2RF3FKfp8YCIASmUHJK?TdS=ffbCX)Yw};)Q4gvgj7Ijx*&>?|sz-bCr$$pricA zDK5>WZ|MB}Y1`$^g@Qpb>n0;N;IspnsxG>0;8A3PM#LFVv39#RK&x}w^UG-bv-7+D zbqWSWts9o2lJEb1VgHnopA*odA}A0pQ&Q&9!Zg^nD+!r8!3uSyO@izEmi16b5 z20W!;{B>sU*v!cjSx6&yaLQy?`2xW{6Is3`0wQ^jHfyW?+#)VpuVd6B>Mt9nJ3(pI zp;syu*u=T}VQiU=3Gv>%POeE{{-<*b%8@KEEV));qchUALCe$Fb|JFUS7loOzV@3Lm~r%4?g>(Mc4w zuh*~q?3EK!;CxzJ1^r|(Fkjc_lHXNSd0$(Dw(&qDSdaOaC+QDw`K?5Zm`Tr12a&z^ zCS(`B=A<8-HoK?CMoT(-?LCbDS?FIdH~kDtViswU1Hj}3Rg1<|yPYuormr6m_B9zv zXav!5n!la)=0p(!1A7}*&^9`M-4q;Xu)i(F2W#@v;EC6xk)|@Y2ej;-z4;y<=DOQ0 zSfp2R_oLej)p0K2Q{F9Z@7KGCcES3Qf`jENkH1=a;I_q_Ac2Tlnc;S^;hE+8+Wt5q{OZh;JCWNTQ1X#4 zh4lC0y_2gfPI*$1cWKlT&)~y5@1Gp2?q_%tBLr4F8(+ct?2qQ~pMdOePP ztR>0l^VicK$*DN!KV<~?`RYI2BS{&m%#G%l2bFsr{dz;#R1~N2eizpEwmv-(v_bfA zJ;_VZ@p9{z5s1_Ppfk=g;a@A!tvjg7(?B&OS${#BtMl{87f;ifGds~oiGKHeKh`^e zCm%!8Za5p(CqGiHVLId5t}T2?t3q|`1$dLpyY;53N1|Efsy;al<~!Vj#X#~8KntL6 z-c)U*N|-pgbH+Fp*qOM!6THj2D8rMq^Nc^?o5^B0^Mgv`(#w?>C&-hBZJO(rWRNlM z($m&8dcQaIjQDwdSSi5F^ld?{;*liV$>IBL&&fM{H(|xFG5;j5U8B#w&!YGu0B<7U z9lm!?a*p~;p2mAp89Hd}Q%K$!w=JqPklQ0y!LSq_I zD;=4g%QrJ+$Y_=<&CNtFqOZf_X2?V|Thix?DOHEa*c?KpP5q+qFM=696%`}I$d6!6 z>iqEs)e)1zky1aSNG@V+8)3LDRhCR`>_tdMVncFW|C5D_knH4)jofW)ACS!F@w&PW z8{m-wJx3R#F*L;Hf$bY#&=>ZRJTkg<=vx9(7d!s{6?4r+duJf%$RNp_5iYEdvh(66 zDC<=~2KC{KZd$wtIM>p2CTL?Vfs8eXY&B2G`fu-yEFC91jHQQMFe3nF^;_ z=ys>yxpPOqEVm-`{H8%c?Ke9X6SnPVAH9h(pVY2&}1m)WcZ8*ZZ#>Anq8 zHAX{MS`w(p;e?~j7L@=w=>l@xW4#(d@u3s6cl_Nf2S}ONK29~#rr)Z5xjF?z!7UoD zRKq5Iy4_Wqg~nv3+5cQ(SIV|NOS}(f(fbi_`E5<@paOmEv`U<(v6tg%8Cmk*#I0!d z7d$QK7hy1NyJ%YC=hXJRzK2WIGD`S4Kqc_R^9z^F?jewKPw8a8;^DJk-HrujgJX|ieymGcu;yMY3m$>;O;WhB?a*bgvY=#ybgL>{PC5P_ zBP3z?D>rW3U5{mSlTxBC7mJ-kMwhEl4Rqm>MDYee1v~-|2ys)=)Rw6!sQd~B^1Dxb zvtej|uzTHWaUn%uInW!}`DgIl)|@th<;RnyoI*m3ZtA>#Uxx6eH1VOuQZ&1ulB;7y+A5)nt*x+b> zjaSOV_X*!m-L@v#tcQ|mXfE-4)aM&No{Y%;Ucu?XMyF1W+QMGzy||KxV`$y3tmIX#~Nl(i%gz2F7?9m*Ci*K{C~q2Oj%eHCw3*Rm$6lnJvE=BAeT3E`J!)-A55sy0Bfcs4*2Df) z!(Ug!8TdnC>=tS6z4}d$n%WJ}pCOr+;Qh3dTDK_l$DEa9;D)_N*S4zxDu}gly@G)x z|MjSii%F!od+OV&VpAzv&&Ar{_4Vzyx7>R_%=ja3Ic#f=l9t2fBw^!QGc%GBm56D? z7F^!L=bh53?Fjsa>Gp0Bf(_HX{FtE27?0{Xc)QSlHpFwo-)ie%))%rvQN~XK24VIc zIV!&krRov_%Af&4MIC59pNuZZ?oL&P$c{Uli}IL>dD=}rj{fj0U9?8WqNnqq?r{>l zZRWc(r7h|_6pJ!tQ$F()-Wv~O=i}h(T%FE#hKbiINSV+{rE4M#D_N_R%s-1~Sm?g5 zFiGk^Zqsk-WOuXTmtQ!k)HP6u(_2Y9)F@Cs8vR?;KWp5THsCY_ynR<}M9RI<%Puvxr5$Wc}{I=wYFu%L+Mmd``KH|t#{8gy~7$qyFkEL55$ zd)HBhsLlM=Tjsw8c%_bCAh`r1>J*Gqquu0#xdwV`-P zt!;jL=BoC}{PLl(uN8s;{>EpD4O8*@JOE8;H{bnTU)%>NTSbVJawqKu!q(Se75=me z0og_Es{v4d690of#MZ`BlU(cQUdy=7_>`2Cj0`$jT0x7>^ee%Qp^Y@1Vp$fTLh4x7@i~Y*g zfXz7~_IKx5Ow$AZ*xzclVFxvWfvujt9!0TvVmwNfp)u|qYh|+fmN#;0`S)#Tuvx9Z z8sFQyem9Qf3v{ylbUI5<%Ketnwf&kVdlOUr0m(0CX*ZqlPrl00US`$11T02)CF$*5 z@%Q<_mpDy{&9op@<`7&>V}ivt|CPj#I2a7YVjJa92jfK^oC096ZMMeZ^+k?!c!xCu(iDdU-T`43rh6Irt8BDkix~}=KgP(n`6cF1Fibf zoo7o0_;E=){e_HW@sC&R6Q9%M+#7uM--LujQks+elf;>u37ss`Z3uA*|2o$2^*^{p z4GQAN&Xd2d;th_ULa?7gobKV|1DOX{5_w<+yeRf%nxA3U;F)Lyj#;v!umlq&0KHtT zZ0w3K(q1YEnhIF*`IVxN!vrTy?D~+#nBfqDof!)h3#weWPonHtO@v614>yZ=GAxKV zf2F{EqQznf-P_#zxJh(j*RD%+=qB#d9W2h=Y0bBqb%)*w_e!>gNs==yDolopciZZCX~g z!A*tpWssgb;T0W8+~})VH3uQU8ejNw6a{nI8OmuL5z5QB7(SL@I>51e@N^bA^6Q7z z#R{u7wKCSXJR$hs16tU@BKV@^-(@XWBu6l)(g{iP_ey&>* z`kV5Dyh@*IliGD(_KyIRB4EER{sueLHSgX6j__9QzDO2!)>jD2L*IGS8X#_5XE!_r z9e>UfmKh5K(^p$=%``}uIA%TdZRs-agCjs|(R#1*=zH1MI(nqF%anckjSjfz;EK{2 z`~{xY`FBizwmV205e;H+AKi~V8GehhZ6E5iNSJP(5uYlK0S2SnqmT*TeWwdutW|$- zzE*GNr5~$X*)F9>n9+rY4#byihwoUPYch1|{ZHZ^k4 zI&AUnVLBcv%?1jop-l^ zo0CF!lNRol2-}bB0cnD-$=Vv4dBX}+B{@G=t?$>M$g!;B_`)t_h&glS;}@;9&<_~b z1+{^Kk@SY#(*pgw!z%FOZI6jouyg`Xk@9S*E1=E+Q${fmt`I9Za3ZIAix@FD;Dt5) z)Uf$})9aI?;o@#qPtq1^LEwJvoBKm3J3Rx1Bv4Q#_3oebZKzr1Y(33IkXWBya~ve*Zq1=Q?=hzQDA>A!4>FVzKc-;H?P1{cJ;!hVSua zr`}5Eenr?~MLH{%r_x1?8Xw8so?J7nwcgp@jl*z@0xEn`rYhBDQl40jOJQSJi37A7 zj0XGqhHu83U&Ib}wYkMqQ*yuqtl)a1Bqi|We&RdMT@nVeKhRx|bkX<;##T)rh5Cu{ zGoWK8MWsRU=~Ht_a2BaNZ_tYHnfq)PbJ-t5ga}O|-~rN6-${RQ1d7mMS%|GyByX5+ z8pEU+G-}%Tx^2)O_L_mnQf8YP$t69_`C=(Vw+rP*&v$Iz)%g_-BP129NoolM} z1k0h&T;!$TfYT{pc=_d;;F0#}&iS^L_T z9@M6Z-`U6KCNNG^40_aRsC^$J^yGJy#i%eHT&WU0^i0;+IGs!q2C|OXaFz)P=zsi& zJa{SaK!+L21;H{W6Su<#i&c^L%orkXl_QDGsN^eBb|$LVb`{-y*4_|V!|ndOF zuU-8BwgE>QdRxr%dp1cMdA&KRr+1O((Rz6^5znued_Kny1;^BKpCPrk!BPk5<1B4!mNp z*+R^<_r-+;Lu{Sw(P@)AbYUVBn;(4p3u$zyVOa}lc^yd;D4IT_g|dY=kinq{^1A#;+I3h@+2v> zr;Gb9_ll<%YDg&eZ$M6ri@xdGJ>%UdS<)yUx93mc7Z4~fFAoU`;c80T!|52oJCq%i zlU8q4$5;hLpw&R&(YN?eG7(8+3EhYI_{D{V1q7l9ZYx9`t(^C1zcb4a4`WvxuW<3l z*>4D6>H(fSf#U=!Cp!WbC?sRs*!>`ejloOEY`ze_xxCFG^+(%QReuC(@OeSK0E=>e~Y@Ka!B_g{M4=9W3-?KR4yMA z?k{Bv^PWp>@I6HOHTdsr+~A581C%)CiRgb!@Da@Y!YqJ!(aE_c={a7ashcLhgZ>GO z^4qPSR?Czuaa%?8IG9qlH>P7+gNz$|4v~_7J4MWfB0YO4w$m~n3`#s!rKjXO8s}CF z6*F)9s}N_l5!Nn6hpNKoZ5t2h6e{*!k10izN0x*&oNwT|o5_#^e-zX^_qpF9-f10) zb$Z+pn&VH#cMnYH8S@6$+Anj3L*=msWW3#tj`SFlrv;AvKL#dsA`eccVw6IdnG_mb zem4vOKNpOIX9ti}iI$xWF?$d0Y>b~a{XY9Ve>Csh-{z57?v7aIMp#Xkn=U8!4@Ibl zl7_8dT*n>#Dcf7^$IC2Cld?=Ae734mGq!33{-FIUb4ier+WEN$v0FUdqsG@gSZBy4 z;2ys%|a1ohH=qi`4qbmtQQklo86SP#^!| zGdb1azchou<-PEH&qp@8J`Wc$Q(ijkki6{1esWK`$s>cA36Zn7k_wW8CP1rWq|zC> znGd@3bM^VG*{bYqPw*+EpwaeZ zJ1xq0;;jeRZKv+a{88hnJMgWM#PE_;82&kqS&+Y&5cKG1H4%Rt;HeC9G|AVJzLNI4{q3*&zn-GRR)uq6?~aFgt)ykT6Mokksdx%DhgUJc7(M5Ppl+WqJI?)=^q0Y3ZCjSrmJ`{X*ApQ=(Kr=XPF ztl#K8o%^i4lhpz6!?W@3cOzBN%_U%~{S$*{8VwFK@*#bmMuugD$1Qb6hmXIkobTeF z1lx8Zw90k-H9Fx9*B)3-Q?>F$SPLw{oQGCo*Y^eq$$mpdTL^!yi%-4LxmS?~6LMKf zc;7vBdgf;8kk^juUHcNjzkpBmHT9K)fKHzpyqRv?osP9v-v-pEja;TcQ0ge97 zHp>k|9cyVB67?6&ji6>B{3V_s2JeN>WR6y0xBQ(=C5~|1ATy^=7$3R*)m%70U|GMe z&G{m|6R|U9-#rVy-NV#SVb`-RfzU;cy2p=*5k^^Gn8XWKzW1SDBK9TOcxC0L`D&Yk zo?YeU;h9bXdYmbbfs2dsO$P2pjC1#56ZkH3uFKPj2T+@~zIROuk=I8lY z09|Y~8lU#-vWzRj>hSt}F^U)YLPiT);c7WtNVKFf+262QyFr^Mu3wEWkL4Np8XH`Z z8C-@fIV~s_yl@rWJ#1l5vGnz_aP8v6YUcml_*>N6-XLJ(n2jgDRWOdEzAud zN-gz2Oyo`zR*2|tKk?OwiHGTGh&AT6mHT=$kv`O(Nv_{G3~%G(lQ18N{dSD(E?-#0 zm-4aet3s=XHKI@wTYk0Q^4G>G5appl$I(<@t={syAFn^nO+t>G9%u>55gyil_@p9_Y{9z`qjzCFpJaqN&)c2`Hy~CXh}}~#WjilRpAG$VMu34&S9f3F4||p6SYq_F3_Ba zg6z>rc)}0|CHgLXf;j``8iLYfNB1P759KJMAs8u=|y;ZHi z(Vx6wzC%#e^!*4xTs;!4la^Rte-Ne%LZ)iRzD5+&K}YpEeK|1opQMEV^0ivf?Y>A8tEpEZQE?xfR#0P z)2Dd8yi&2_W8Z;?xPT=$m#WwR8Em6N^q+=YQn6l=8US?WlPz|}e!Di=xVOLL?|U=K zc72VMZS%DKq9nltEBLV|TIx*cJ=>?OKC`~g?-;N(S*Mkb{aWU~N+S0xF1SJE-zXx| zf7iKh>n$@#F|~kJHbtG;Vb8*U$ZOpk^f?C_m!;(g2pjZk4o`f;X)&h7^>_UwWBl;+ z{bLC}7?S#T+204|WNRt;5LD>>*XrH*KWAoqguA=FU~gT!>g4mAnN7f*zVUpgyCO}s zuZXP@Dizz2&a;oDm`u9a$O8P?e2~A)=w;bID|?(nSMg&~>A-cDrUKZgEAS3${&B7m zf$(F@(HB2%-l&p@nmWYqYsC^TutJGi&rr$Iz{R+BH1{BNb``vR@sfy(K9d><+z;*ZeC@x(M%9c-<;ufhdBH1ueK^G})qUIpnM##W zDzZiD&89Lao^Km<-oKMyJ9&8~=sfioroSxx98k%rJDRBV+iOsA)!&l-m|HSfF;q?H z$^hBiThOcs*`Yq_nR^c^O7MuTL4E$4GIFyCWz_Xu1!2h1=5=unrn%-*5XUz}yyv6k^}ua_A( z3|Jagc+eEl>o{0Bcy+WOYl5<0`um~4y{3jKzz8nPg;O_1jaEXnQONqpN^#0U`Tq5D z=nD!ew4KeLO%>s6RZQIfzk-}Qy2kJ2|4mn<&e@^;%MUU#W)rd185^jfE+}r+%hX3< z^;2^1q_odk4Ak!6Ms%CU@wB$&(oqa$KXUx^`CHLOuPN8kj1~LoTJLU@!J&P!*z&HR zx7*wU)@M(EpyS1v0t~vrh~yD}zj59jd@3*F z>)Sp9CfLk{om3xtK@T>m-*-E|2ha%H`SddWe)S?+#f_UR;rHa(kJ0~#V%%}`@vf@O z^nyPa+xs9?00hZ~kqJ>v%M4}Q$ziZLu-j@Vw6X1X7&USNrB@k_c^z5V{pDdaILvoi zfb%hcXmMR6cQ>caUu21%OGN}CG$V9nhuxxj zq!8iX(r3F}Liq~uPVc@zTzL~{irZfPOtFFc_M6GP_vIXG@2|7I3tie0OsSv9TgrFo zttZ!9u0^YpGM~dh7vqNtn~h@jvd# zQ~-D&r*4$4>hDfV#3ElvrG09G@QC8;J_j&&R84*{;(d3v_9eUoRML4Ra-<(K#GqF5 zwM)v`ngNT^PW-`fcJI^-Ey95!Z1t7_{g5g_-ITziaH1pt*OJG)rfmpmNZdY3zfR}F zNSakBI5ASN|E0#Hdwd-p5_>Lq?qf;iqNHE)*>ReQ(f89ffY>a~5Z$MyR&x$=EU z@5qxh(gdu`#%>Zyb@n@fRqd8&A2Yny=E8#cw;qrgSusN8Xo3zQ} z=jRHpIEm0Pir2~RCZu)jIlb|tztpm%Aww!uaxz86#8kJ65EIIk6_pCb_598$b+cJK zPc;&D!4^BR29Af`tG|=0A;tdcgTCk4HaLR92~r}%u{PO-U8_tk57o6X#H_D< zRY5uV%&hm{nGbyw68OV0xGp;l5tbsRRQ8hjG3W=owQfhTz+8t3JNO$ip((r%4{<$p z%~Ap^+0!a!^pyiVGmT2G)QW`jTlxWAjas?ar#6;xX zalutIC8)|;z)b%2D(-MNj0uFbSk8aDVOJg=m3Y(U;n}yzH+A7$f(|C7a6sQ00E^P#M z1A4t}c1&Ycd^hdyxGQ|PPjl8ansRI|g_`;D%t*pxW2~Y5Zw(FhtVYh`koeK&{A(g4 z9PWthR6kj-guGA}(M008rJxrSSU-_jB7UTrCd!rjbI||#T{CIAl4&7Z?Itu#z z{rmSmqid48on+{=5n>5r+KG}$e>&o=iY5!PHDAp5=0~=w@)nPz@{ia<6+sIGUm^Zk z0d_M5qzne3frt3fu6F~aS?bA0kWIe>TV-M3ePMcmT0jfZJ)hPwmtXl`G?K`gM^66+ zAFOp(M#eBICvlG8@l&{G|1}n=-Im&^H{Sge5@(Kkl|eTq&CSdjy&Kj#t(KeIm6GLm zP@Nc5!=_4I<0N{&{m`l>^-S9^;6~9C*7_&&p%r|*^;Gnl53ESQ=Z#c#mVY`pJO=-+ zgEKN96Y@}qXP~gwf2gnE?F<$?)-_t?ZZ|!ITByf*`6zx;$fJ6G)*mf`J)Gcr5Oa_V zRMO@cG?0<8;;Kt8qHUV6Q{3Fstf4-PENQk zojx(B-}0?f9QEUGAm*r+S~tn|$Mpvay#72Y>dB zKBh~Z*X0zf|4IpVpySmGN*J1m&omaT;rd3kWKzlvZOiTekaWTJE0Sh24c#*hHGE&F ztEkBX;PdrsJ9#G@f<}VJN5>RB`KUCTxI_>NdUTWZp1g;Ox3XU|@DYgVG%*Y{R~OOnPislI<{LidLUHXesT<@7L?Y6NFe?td6} z2W`6V)UFyRR$)ttU>Az;ENS-|li>-mKZF3L&<>k3>!hID-O`m%+r@uC0(+W8uY%tf z*o`RSyg1&`thYx{J(^e9OAVzxIAX|;<405lZXYWaR~hgBu%ZWvFmt+@Z#FmADXL*S zF{L`W%v)Yo`{X6u%9;Ey-*!x)P?aZY#mu`z9K8YS6G{D>l`<=@4s_}-w%JL%MRShu zo&VB`p?mfp%M^B=4~>Sq5=TZl5&*0`u7~KMP_}SKF4uvf1c&oSPZS>#baFHP|8$n? zjBw87Ndg9JvBao+9)Qk+S*DClprTjiHD+7~ym<|KBqTrWuK3$?)W}W_Qa-va{3K~6 z9n~kEfHnfjxv!D8;>u;@<2mk$sQ*EyRoh8(U(VuMf5r2|Yqz_9^4)p@6d zm^tB+Qnau=6ZuYUUaU3jc$S#3osj=^FS01Wl=C13!iDFj!_MnnWm5LkrZz>`X?2cb zk|uW@u8x(-ro9@`Yf_R!K}DOdKl$b<2S?#5-$f;a{i|RXD(pKXg3!qKw&UNQs?$RU ztX*7Pd6&Tk1_nzr4>@tmiigjUJ&HKp6;7!qv@v4b%`Zs20fqrLw>o7T>gzW{vBzM0 z>;?a^$8;6@_6tNG$|(R~Ejj&E*^qET;qgqEs)GBlqt~o7xz{pxAU-XP*`&iWlHP!9 zI`8tul&8wgne8r;+^)duDwq1SANo6nZ z2*AD;Q)WeI1Kwgm*tA(jzPnh6r#f>eYVoa~gM>{J#z}X7=G8By#6(>xQ4y5vw1Wqg z5g0?*X+w@8zztJyUT$C)P=k_P*jojp=gUuNj%&F!D_vCv=}9P2tzE;pOeXe)6W^T; t0UX^@VPA7Kdi80Q>HH$LU^|hv6OVE`oG`S;zUhmnB(E-4{QT9M{|1q0i0l9W literal 0 HcmV?d00001 diff --git a/docs/beta-features.md b/docs/beta-features.md new file mode 100644 index 0000000000..09f22f95b3 --- /dev/null +++ b/docs/beta-features.md @@ -0,0 +1,52 @@ +--- +id: beta_features +title: Beta Features +--- + +## Beta Features + +In this section we will introduce beta features available in Unleash. These features are considered stable enough to use in production, but they are subject to change in later versions in Unleash. You must therefore take extra care updating Unleash if you depend on these features. + +### Feature Toggle Variants + +> This feature was introduces in _Unleash v3.2.0_. To enable this feature you must create a new enabled feature toggle named `unleash.beta.variants` + +Do you want to facilitate more advanced experimentations? Do you want to use Unleash to handle you A/B experiments? Say hello to feature toggle variants! + +You can now extend your feature toggles with multiple variants! This feature enable you to extend your toggle to also spread your traffic among a set of variants. + +![toggle_variants](assets/variants.png 'Feature Toggle Variants') + +#### How does it work? + +Unleash will first use activation strategies in order to decide whether a feature toggle is considered enabled or disabled for the current user. + +If the toggle is considered **enabled**, Unleash client will select the correct variant for the request. Unleash clients will use values from the Unleash context in order to make the allocation predictable. `UserId` is the preferred value, then `sessionId` and `remoteAdr`. If no context data is provided the traffic will be spread randomly for each request. + +If the toggle is considered **disabled** you will get the built-in `disabled` variant. + +> If you change the number of variants it will affect variant allocations. This means that some of the users will be moved to the next variant. + +_Java SDK example:_ + +```java +Variant variant = unleash.getVariant("toggle.name", unleashContext); +System.out.println(variant.getName()); +``` + +### Payload + +#### Client SDK Support + +To make use of toggle variants you need to use a compatible client. Client SDK with variant support: + +- [unleash-client-node](https://github.com/Unleash/unleash-client-node) (from v3.2.0) +- [unleash-client-java](https://github.com/Unleash/unleash-client-java) (from v3.2.0) + +#### Limitations + +- Currently you can not set the variant weights yourself. The plan is to make this customizable. In order to have it stable over time the total weights needs to be stable, and we have currently defined the sum to be 100, meaning we have 100 slots to spread the traffic. +- You are only able to provide overrides based on `userId`. This allows you to control which variant a specific user should get. In the future you will be able to define overrides on all context parameters. +- Payload only support `type=string`. This might change in the future. For now you can pass an optional string payload to the client and your application is responsible for parsing it correctly (JSON, csv, etc). + +If you want to give feedback on this feature, experiences issues or have questions please feel free to open an issue request on [GitHub](https://github.com/Unleash/unleash/). diff --git a/website/sidebars.json b/website/sidebars.json index a8336c15b4..ee3d1d5d73 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -6,7 +6,8 @@ "unleash_context", "activation_strategy", "client_specification", - "migration_guide" + "migration_guide", + "beta_features" ], "Developer Guide": [ "developer_guide",