From 4318ea3af3d27cfdb7057f092d3daa99ddf20a04 Mon Sep 17 00:00:00 2001 From: adakisme Date: Tue, 27 Jul 2021 15:52:43 +0800 Subject: [PATCH] Add a doc: Configure webhook notifications Signed-off-by: adakisme --- .../configure-webhook.md | 40 +++++++++++++++--- .../configure-webhook/toggle-switch-1.png | Bin 0 -> 5496 bytes .../configure-webhook/toggle-switch.png | Bin 0 -> 3035 bytes 3 files changed, 35 insertions(+), 5 deletions(-) create mode 100644 static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch-1.png create mode 100644 static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch.png diff --git a/content/en/docs/cluster-administration/platform-settings/notification-management/configure-webhook.md b/content/en/docs/cluster-administration/platform-settings/notification-management/configure-webhook.md index e1b2289f0..ab6c6f31f 100644 --- a/content/en/docs/cluster-administration/platform-settings/notification-management/configure-webhook.md +++ b/content/en/docs/cluster-administration/platform-settings/notification-management/configure-webhook.md @@ -1,10 +1,40 @@ --- -title: "Configure Webhook" -keywords: 'KubeSphere, Kubernetes, custom, platform' -description: '' -linkTitle: "Configure Webhook" +title: "Configure Webhook Notifications" +keywords: 'KubeSphere, Kubernetes, custom, platform, webhook' +description: 'Configure a webhook server to receive platform notifications through the webhook.' +linkTitle: "Configure Webhook notifications" weight: 8725 --- -TBD +A webhook is a way for an app to send notifications triggered by specific events. It delivers information to other applications in real time, allowing users to receive notifications immediately. +This tutorial describes how to configure a webhook server to receive platform notifications. + +## Prerequisites + +You need an account granted the `platform-admin` role. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../../quick-start/create-workspace-and-project/). + +## Configure the Webhook Server + +1. Log in to the KubeSphere web console as the `platform-admin` user. + +2. Click **Platform** on the upper-left corner and select **Platform Settings**. + +3. In the left nevigation pane, click **Webhook** under **Notification Management**. + +4. On the **Webhook** page, configure your webhook server by filling in the text boxes. The parameters are described as follows: + + - **URL**: URL of the webhook server. + + - **Verification Type**: Select a verification method for security authentication. + - **No Auth**: Skip the authentication. It means that all notifications can be sent to the URL. + - **Bearer Token**: Add a token to the URL for unique identification. + - **Basic Auth**: Provide a username and password for authentication. + + {{< notice note>}}Currently, Kubesphere does not suppot TLS connections (https). You need to select the checkbox on the left of **Skip TLS Certification** if you use https. + + {{}} + +5. Click **Save** after you finish. + +6. (Optional) You can click / to turn on/off webhook notifications. After you finish, click **Update** to save the changes. diff --git a/static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch-1.png b/static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch-1.png new file mode 100644 index 0000000000000000000000000000000000000000..2aa3b59762543144aee3db1c8ee3714057a46d26 GIT binary patch literal 5496 zcmV-;6^H7HP)BE1ZQLxAY_vg;$?V;oX(lt{{G@3qJ`_O^!KmPq;Qw2}Cn0L9?Tam?khm;cmfj@-EE=vY<#k5o0f^m&*sM6pBI0EL{uRZtU4R5Z z`^X8`V)zNfJ8YaF;u6EP09P2E5Ad?jnUOMxUqvh^s*L``+lU9}BlcPZ2XpY-jyyG} zttleQMaed+noc9ry@UIIwng1*#M^^UkFzj+6yF25_LnMhmf?pGpH<}CbcnAmX|u%; z|7E#p3GpKUUAw%6atiT2#A8)^yd3Cssj4^8z$>TJnP(8+gLrkpJj%xIMEtceUz`ec zeo~wa<_{hK;NmJRuzL3+9o0iVC08s$)vACv7|KExH6jmbd4gn8^0FkllzkRT6fd|P0n zrwSVAXrbt(XrcJk;OyVRDf#{Yw^VBW$m{6QFhZvPBk<6w!tZERBfJcLd1$M3&)TehHS09YRtkN(Z(GDi^F2;vKBX;HY+Q*UEnTqUvgh@A9J5aYSek}G;8j! zqp=F+X_rylpF&#LEj%b>g+0Q~5^H*5N-?MwSLAe5T{?GXqX;9WfX;*4pXw6&V*io?m|<6;W0GAb4f<-njQ>$>Q>9MPr@ zwU=n+0I+*9IKpp9{{0u*d8K7@p9VPmCp-6AwmA>rtOL;dXv;Q$XXCx^0IWWyc=l3w zC&Xgk0yx!!!@*Zi8qcdA>-AfBZYACT*nGWS|NH%Vee(m<-vGFv{{#Oecnig2*2@3@ z0BmJgNoGw=04e|g00;mC0U7`W000010000!0UH1X000010000+0Vn_i0000100IC2 zhiL!=000010000^000000001x000010001x0000100N)_00aO40096108pR<00aO4 z0096103-ka0038*<3<1g010qNS#tmY79{`x79{~mQY7#I01%i-L_t(&1>IU}a8=b6 zUgz8!0tCo|U_!0y*ET^(}!($a_`w^@3q(C z+iR`8&ptOuN9lAFh=gJ#ofZjj&l2Gi3L3;UpxV@PNVc^$$gX4iWM9`2Y41HQJ*ktD z)`4jW(t(cP_?$u(X>yA^H>FEJ_&_3n97qHIbQDSuQgRx9Xb*4&Pc2k50iqPHpkcr3 zv3}5gRQUmn9G%FQ2_p-oqNq$}6-}1f(wQ=4OxYRjSAhzNSrWi--o}M$!G!qUS6*n^ zBG2Pf-*Eskk%#zU|?t%0%Q)1CHo4&hkOv{YNf2)fCR4p zKKV0?E9HvnMY44AA}=)S>h1DZSVjQN)3WHYs;{=x$&(F#fwvtp%rN@_z%m29M`ajt zsNSht(?>i`gvNOc8q+BN<$z4XGcg6RRD$gR%;8LC{~`I61!Zz`&82c-`J6a9RlyvE z6u<~g)GVtwqE&TI%esAA(8~ZzsrlN4P>~djCXgKF0EoaUKsZ_>QUI!&8WatJXMh_4 zIw>}*k4Zy0B8(+e&Z^YMDSv6zB3VA?S}KZ&{Es!832NYhi(Rli!WC7 zf$9K`L4wCB;Gp*2Mcm!OLLN3z$Z-LIwM_iqBENcUnXEkT78yTsEESE5dL!?A2D*Ri zYJhi$FyX_nr9Ey0S4TD8-6J1G^cq*_L0sJo2v1AU!6V@60a~}haw7EKff@y*BVU5Y z|9_!;$iP}3^GrvO!4L8^Q(KHPxf`T$U8^&$fiT@ng=lzY58#ZnVe`t3_#Go+FBU{cg`0l8M+_pX_qH=ua_4ZH-i-Nb0+(A z`&ZQ76tB*)2j2GbDrth7GH~2xBS)6r_)w-sq3y+}8x@{ZFkbFnc!SI+tkebtJBvem z-!XY;`x@EN_5sGS!>sb-eamp=b3DVoqF{o2ciwd}v!vR@up_%DXlyX~*etDd-7o0^o&k^i62q3y8A(Se znK-IM9$0*>v!X?Z0d8m*jJm zizLbM>-KE}L$IW`QZV*%Tpih_DmY6cfJeT%On{8E1<6rz*Su@-STsU9Pj$-=-&`Zx z4>zDEfqw9WE0&Kdmha8GNoEvJmao+;MSs1#htSr3HGs9@$yY5RcnoyAW5F^99s$x| z%;4xSQgQgofX5cKQXOnT>2&$#ysPEW9nWD>z=a?VVgK5ut+KSTRzj}0^&R^((Px9h zaNs>Pu#Jw(QB;HgJi4X3UB18RS8^NxbMURR zzW@Uetnlc(AWtgBl*(j;-bi?9UYLh8Fj+odRV(M0*U0$%v1gQTd(l9yn0B7bFP-6Z zv)!muL@)3NyQ=b8^{lFa8pu`EpO)Fe@_2a18d)}V2^OF-+!Ot@oP>8hy7M_i$>!7KGXe%MK}^RS zhg$p_iLy{%rt`i}jMw{cL< zQ*!u-xgY>Th`|jbN&^$0AB*#gk@qaOz23SL?VNc|1hoJ?(N^EY1w7tFXj`Ws*^hTp z(B#VUxz|Y*Hmq9^;s;M0#mE4wXr6p))-}3F4VIsd61sglr?^U{j4f3=;?RU>j*km< z(h^tnE~a*95Da`Qwme8Ycm>DJoN&g zE~N9)#`1kDfqaY<-4V( zutMsNHX?=wpeOu#ko`^Fha^1K+o_;MJOn^tz!7m4H4SxjB!3@wB&0BZ6z^2g?txwa zhS3DehHD?cu+%GKY)afQj{F6ZTd)vdwTne*bTG+JTL#%mYvem->38wN0)f0 zonoq~wv~;>stcLffa#$4%jZNY=Nq%y(Bz|yy~L8GWK227J;1jwDP=@4*3WXQt7f4<*sbiYy zjZ6`aHFex@@SPm_QPeNHI-AfVQk*Q%Yv#+H4uNsfr5g6pt1=+*h9$G!Q=Zaz!A6h; zKD2c-d8i;uAQ+vJj@B+I=|x_L-q3*7frfRk)X}ZW4M8=LSgXE(l9Gw_RF6Oox$7~ZdNEpbTZt|kN9lS*MZuVyE33~3B|-w{TzmDj$M`4%enCf? zl_MWIk;+Q0e1;d(Lt|H~n+#H!x#YxRV4-5SSrxZWjOo$khWf>4FP@cEBZjAzT=`@0 z;1HH-=wYmv3qro9utM?h3H1~j21YS6g-3qfuvQJMC@7H|W-b8*eV(Ho4_BX8Hcc+6 zn6I?YHg1#-oH?2pFUutId$4>1fznTxA7HZTTHbdPr4Hj5dA_PZtWIV!vL_}Zn>Cua z=lDVFUv1GdeNMN(2-t;HW5?@g^*EmQL2jfVfeRjwSbPrf;iU*M+(Ek$iGC+eG&u09 z)0fJM+8dBczeRa<_Vvh94KHb(j_tFP8b(BikZ%*hE?YQa z`B0b1zZWMff7Y|7e9EfQ4ivg-57Lx#AS-cBb_b5Vd33Y{?-2N*(h(*g zi4z)M8u8Tg(6%R}Yv2@`RAOwJ8jj68S!T;u=Lad}Q-d7&3}J9$&Rz5Fdbx7yxtP?9 zJReoMvGz)2U9-W~I%brRH6A-C&wlV%2@_}q6UrFM{#oNHB&?lKqn>2uD80Vx&|C*= zbdN|S!9tCoF?uL!v~-%|r+VbRt-qC@y#0(2q!j+Bw1JnF=H3o@>Vuc%&etB1y(bRC zYsd{00D!8+1#Up2`L4ywrzm;{J#Dc35L+*9zxdbO*C9XJ_WPJsra~FULo48~-o_j4 z%94*J0{O_BPwNJq{p?L+f`+occH#^PQrNeAXTzgXf3!(G4fMH1-_ueS!oA>^X(4QdaKN=U2B<(*`v``I@mg3j7`Uwr9jfS5Z#M zva=V+n!H`3?Gc@!XiK9%fRT0}N+OZ|bUzMKxq_k4%K%n} zC-~!DZSsw{lJ9WjLpYUyvD7t`XLfJE7O72cn|rlXj6Dl|kmO_8G}3#@Qs7)$-I3k$ z^SAzp#iJRoTVW5z&?bGcPtBaJ-hN`nk~vUaze@IXx1x!O4<1FK8JuF{ILI^0sZ#*9 zIDFxhNb{J1Dxx^SsxHA~csjoHW>qMrVaGo%pYNEpK@(_L(#hW9r4toosqIPCc4Maz{-4B%^c zf&K#=>8mYS;bf{YS)&L4KFO=$N@ueZFFy1n(1j#ap_zkH@@COjnjwL5AhVI37^0V9 z$mfQ^-plX}HarLKMEHCk!aMm(hqJKJALR~pLx9@_@LEnBfjs=t+mc$-m;Ka&{zLGF zvj3iiH_75jb4=g(wI(Q6y^R;?`1wZcAv6rd*=9F`zO9c_XL&FO0Om)1t(h4_g-FA~ zoWpH};>8U*^Q18}0{1;cQ`~QTCZ9jC;5}dPs}W$V3zpua1^t{dQq$WgALluE*2RLy zA-L*cvJ#P#6_a80?3YSx$$8e|8~B={N~2`*j`62(&4h6qiP&PQQlbge2NeRrelDR_ zb-e&gd+dwg(QD`>1W!3Q&&A#(mZdU2f_%-bV8tsJ0Avz8CxZ_b1m?8>UY5tu#0L#{ z2?qFrgwpU{&pin?fgD194UWy0&$%YHKyjwltoX75Z{T?*N8{6)6bu1X3Pc7KVQ^uM znmw)=2OqkM9KbPHnI1XDri5+W#*j0Al;rcJ0_8>wSHALA0G)m@m`MeZ;3V~f{UR3& z9A|Q`8HX&|SO&|lE}SU$*4~UBZ;?4e0MGJMA9o(@>y(vSo{)O{gw5b1OER`FRUYgh zFM1DP^|y>iTfNxFf7gR{xSI`99bCJHE*tE0g*?3zvXxX;{t5XIi)hu5Ri(iyo=T<} z0D30*^t^lFSo*63ua3JafNGm-pz=B!xc_n8ALP$XZ@?f5Kp~;u9@ZY4mQ zG1{8-n}h(H-sZ=U?&JD>Aa(jE@-M4iD0j}jj^s8#?LZy2>gGCLM3lmO3E9BiiEwp( z!vDO@M551mBKhzGVE5DxUI{df(K9J#hd3A04150neS*B(fhOPks za@omvoVMrU;Yh7ZB%{x0ojk|+BW{g7keroqT7f6mEQ+)l^%`X&XnROYg4dj ueiFbfz=pdLbq%yZkoZOe6jBE1ZQLxAY_vg;$?V;oX(lt{{G@3qJ`_O^!KmPq;Qw2}Cn0L9?Tam?khm;cmfj@-EE=vY<#k5o0f^m&*sM6pBI0EL{uRZtU4R5Z z`^X8`V)zNfJ8YaF;u6EP09P2E5Ad?jnUOMxUqvh^s*L``+lU9}BlcPZ2XpY-jyyG} zttleQMaed+noc9ry@UIIwng1*#M^^UkFzj+6yF25_LnMhmf?pGpH<}CbcnAmX|u%; z|7E#p3GpKUUAw%6atiT2#A8)^yd3Cssj4^8z$>TJnP(8+gLrkpJj%xIMEtceUz`ec zeo~wa<_{hK;NmJRuzL3+9o0iVC08s$)vACv7|KExH6jmbd4gn8^0FkllzkRT6fd|P0n zrwSVAXrbt(XrcJk;OyVRDf#{Yw^VBW$m{6QFhZvPBk<6w!tZERBfJcLd1$M3&)TehHS09YRtkN(Z(GDi^F2;vKBX;HY+Q*UEnTqUvgh@A9J5aYSek}G;8j! zqp=F+X_rylpF&#LEj%b>g+0Q~5^H*5N-?MwSLAe5T{?GXqX;9WfX;*4pXw6&V*io?m|<6;W0GAb4f<-njQ>$>Q>9MPr@ zwU=n+0I+*9IKpp9{{0u*d8K7@p9VPmCp-6AwmA>rtOL;dXv;Q$XXCx^0IWWyc=l3w zC&Xgk0yx!!!@*Zi8qcdA>-AfBZYACT*nGWS|NH%Vee(m<-vGFv{{#Oecnig2*2@3@ z0BmJgNoGw=04e|g00;mC0U7`W000010000!0UH1X000010000+0Vn_i0000100IC2 zhiL!=000010000^000000001x000010001x0000100N)_00aO40096108*d>00aO4 z0096103-ka004uebAbQ=010qNS#tmY79{`x79{~mQY7#I00#R>L_t(&1?^f1TiZws zRcz-D5RO17P++^=e*6Fb%Wk&^g>sa$gj^(X;_Q24#yF1SqZfr%`5Ygk(b#V!jU+oW z21yF)4Qy$3deZ6kq(2ylZI5I)8l{l%^RZf{DcP(k`CLxQrGm_r3sT5sQ{8ALDUhFU z+H%!s1Hju<13Xsda;YfG)ru@FR1!TxERZ+Nj+|aK^jmyneizqGfJy%uubu0)MOj;^DoM104*V1E(=;+lJBx5Dw2W7~ zn{se+F3om#VpM9d25|t8*q=m~v@~DwK;&ffF%kACd@?44`c8N+#EwC`0+Ja^9C7dp z(x)#0QOjmunqwR3Wt^3lp(z?f_Sru=M@njIQEKnk)~)qr`FHPDoDnC?SR zXf1s@X*hJ`&HjmIOT8y{1k#{7$EAJL25#%Ci>U_+cAyL`FWBZk-&l2nUq0yDgOe!` z$=mF7W$)-zbz^L|w&ZGWE}Ml+j2N3jo@H4Z#L_BI^8XHPwa@H#R5b$ zxidUhDMBNQ(X0ttDTA`wYFx^mHgTFO7YNenWn)6i)J5MP&9aH;U>=bJefOt}Yk9d- z_aX?*`f7JWA5QG^0PpV?o9Y_n>>Zs=v?nxr|;HEXDkir;4QrE6gNw6QQGVpFhguWjGOZ<5;Wl-O~f!f%Jtoe3i)7T zO#8kSDOr%IWQPbH^zXsQQF~)Zy8^P&-#r8wOuv#)x7$y`mWU@#7UM=uwWS4p7`o3O zIA`8V>LEZLJJYTrwBt9tNDK|WtB9g8qZ8<@N~@w6Q?%(6P00@F$8_%k=_HB4ZlyeX zp=0%0$A1ic9)gIW!DN0Gxfn9B6XeM^DrA|(oAf%v9?J5|4(odcP)2tz)&6{5mpal# zrhFMpD*Yy7%^lPQb@tQh+{#TLMGTYsJ+2W$i*L;u%~>fT9~Y*A8+QrI&h|S+o-V62iB2ubK^t=7d}>)j!v$oh5Vo^#L(cY$2c-z+r0Uc z^D89j%{ca%?d(e#ltr0w#G=64y3{^ey?ZIh8 zzU@|hSgUiOC9DPhwYw#Y313rcu&z-hdGp~AKmbBGXVc*1C}=cG?4JFKc}pBDC|sQ% zVqpp1B;Vt_+^)N7!3cjgxu(aWXvV}b_W!&;kRxb9QX((=urFok0xK>g6`}YzksU-2 z)YP8=MBbFf&a06B_u)9QCh6wJV^m8<&`d{0$U5k|R+krLrMiGu4U>x&Ly^nIjhtUy zEA256TpOskm>Cmz0#Iy^ow)evVu%N1{Hq4n#0e@POo_#lQTz2h#zdV+A6wja4eCGZn^%fX>sr48T;b zL22UC05SOTYoe0LFA13E&Mx#490K9Sa$}sZiUTBFXUnCO1jSTrXy@vz%~f{Ks#~d>;D6unz>LfFv`)O!vtOKxIcCxv)JA z@bqJ)`ea3S;y&JI`njL>anL6QpEgt@{Y<|<>-z?u_4xt){h_HJjp^f9jSO~SYWDln d=O8K~{{vt3lSFVi30wdG002ovPDHLkV1iN?qLlyu literal 0 HcmV?d00001