From 99ee139b4a3b38a48f8873817b77754b58339bef Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 6 Jul 2023 22:00:01 +0000 Subject: [PATCH] Add new zip for example SAML configuration files that reflect latest version (#3665) * Add new zip for example SAML configuration files that reflect latest version These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files. * fix#618 saml example download Signed-off-by: cwillum * fix#618 saml example download Signed-off-by: cwillum * fix#618 saml example download Signed-off-by: cwillum * fix#618 saml example download Signed-off-by: cwillum * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: cwillum Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> (cherry picked from commit 07c4019e33db71fb68c2d1f4bc7914c80e8735c9) Signed-off-by: github-actions[bot] --- _security/authentication-backends/saml.md | 28 ++++++++++++++++++---- assets/examples/saml-example-custom.zip | Bin 0 -> 5337 bytes assets/examples/saml-example.zip | Bin 4580 -> 0 bytes 3 files changed, 23 insertions(+), 5 deletions(-) create mode 100644 assets/examples/saml-example-custom.zip delete mode 100644 assets/examples/saml-example.zip diff --git a/_security/authentication-backends/saml.md b/_security/authentication-backends/saml.md index cce06c4fce..25e8251ba0 100755 --- a/_security/authentication-backends/saml.md +++ b/_security/authentication-backends/saml.md @@ -19,13 +19,31 @@ This profile is meant for use with web browsers. It is not a general-purpose way We provide a fully functional example that can help you understand how to use SAML with OpenSearch Dashboards. -1. Download and unzip [the example zip file]({{site.url}}{{site.baseurl}}/assets/examples/saml-example.zip). -1. At the command line, run `docker-compose up`. +1. Download [the example zip file]({{site.url}}{{site.baseurl}}/assets/examples/saml-example-custom.zip) to a preferred location in your directory and unzip it. +1. At the command line, specify the location of the files in your directory and run `docker-compose up`. 1. Review the files: - * `docker-compose.yml` defines two OpenSearch nodes, an OpenSearch Dashboards server, and a SAML server. - * `custom-opensearch_dashboards.yml` add a few SAML settings to the default `opensearch_dashboards.yml` file. - * `config.yml` configures SAML for authentication. + * `customize-docker-compose.yml`: Defines two OpenSearch nodes, an OpenSearch Dashboards server, and a SAML server. + * `customize-opensearch_dashboards.yml`: Includes SAML settings for the default `opensearch_dashboards.yml` file. + * `customize-config.yml`: Configures SAML for authentication. + + You can remove "customize" from the file names if you plan to modify and keep these files for production. + {: .tip } + +1. In the `docker-compose.yml` file, specify your OpenSearch version number in the `image` field for nodes 1 and 2, and OpenSearch Dashboards server. For example, if you are running OpenSearch version 2.6, the `image` fields will resemble the following examples: + + ```yml + opensearch-saml-node1: + image: opensearchproject/opensearch:2.8.0 + ``` + ```yml + opensearch-saml-node2: + image: opensearchproject/opensearch:2.8.0 + ``` + ```yml + opensearch-saml-dashboards: + image: opensearchproject/opensearch-dashboards:2.8.0 + ``` 1. Access OpenSearch Dashboards at [http://localhost:5601](http://localhost:5601){:target='\_blank'}. Note that OpenSearch Dashboards immediately redirects you to the SAML login page. diff --git a/assets/examples/saml-example-custom.zip b/assets/examples/saml-example-custom.zip new file mode 100644 index 0000000000000000000000000000000000000000..acb733ffd51858aec59d3f1a603da3b522cf5232 GIT binary patch literal 5337 zcmd5=c|6p6_aDYG*|TqDYm$sLOP0!#EMv+wj4jI;6EgN0;tFFYdnqN^Z07^ZLy9JFoBeb;*-Jq1^_Ft4@ocJ)VPR>pr5vHh*oTxanaQak1ur!y5 zlA>ZY*j+rQJDs@ag&;RK1DZ&{(T$>1pr&TNoJ>s1ufH9qwnRi+wxABRycUi7CMI5w zb>cF(&v$+|KXfd^WvocKQWS$_KHe1HI+JifS+;?q1vaaS5>J2-&d#Nr~FveN0p%JSFPx$q+0C)0-3>? zAqv*-L~3Y20^YCTVi%%~T!olH5Cr0<;j$hK1^L5BMnW8 zCf=O1?_hdAe^j~JBZ(+3y|~kua{N$$h+f*8=DE{gu6;h@3WU?6@c6G_`|L2;Zo94_FyZdm6SBAlmJo+&a@H| z0gJ7uTE*iCfD$O-2w%@yC$B5d87pp6NmhjEj0LHoNod!zka z{N;l@aVx>{jtp~oPg}tChs2DwX!d%h$VMHPh0Imc#b2JQAEMOTB@xSV%V#mDA;v{n1>5H#TH#sjubR+yWDtUoM6Mae@ECChP)D0KVS=fdo0 zq()5OcJX=W%oWuack9fq@30ogg}Q7*G-Yr9C~#a6h2^}PrFQXB92%x2PTH99A0~(6BwirN_xbfnkIrAH5rdPCj?d!B z9rFB&S$76-!B^yJ2F~Ri)YqgED+WG?K<@VxxXOjNX>${nN4@rQT8l5&g(ppc^O*dp z-5P?}c2owW=!T*9fQGE!*QOO2jhLkW)@}HpBNA5?lnZyJHwb1D&Ip9avPo?&&#wnp!+B_j&o2=(ST zk9>^yO~D4#m=UIvXTL|l^-FOP~i;ZABopCwETExQvDV}IucZ{bO)D}Ev3x6&R6 zHoSXE-_UkV$+JWb+WC2xId?{nqK(1a`vRZuX{s?@dmGDJ68;%1VW zH%iaOX5O~g7#z>Ys8JHE5#I_eYAunGiHDXvpldd(^A7KiBof8)5>#JmGr=XmkVMxQ4K7 z;u__Qvw}b}TT_mUH^u|&Cx`L&^zrt`{>e2x%`lhgf3F|7<~i#5v1f{0VdEA184;AO z-{d@6C1+9*Mk1K-Jz4YojcpmHzDU(%>n%C=ahz+3p3yMATd z{aXFcs@zU!8)i*|-m+vEocL6YxyZYth;{l`M$m<6;j>No%3oQ>+$VM*ks(9wqQRkN^t8&r#)AoMx?7Q53i6UjY_BI%C=7JlG%k+EZ9vNoc zgujWbO6l`zyxIDUZ)oh&r>sCZ=d_GL&1dhcM|SVf*1g9UcsbrwIjn=yox*t8?Oo}< z(n*tZgB|a!YKSOO+&^i3&}k1h0_5z$*u@0*3#fo?Az|e z)|r7X`>7$bYFfsJiUt;2`@R&<+6E`Km48O6YPL~hlR0>6M+c2IV zL1wUz*_t;d@G(SusB#yacL=`{k=^5OL^3_3!gaD48W>p_;F@xa2d7Q9Vw{4U?EU& zUZ$VjD9KVP%l#L4?NrS3QtxKbDQRC%1g=deav+iVzPU=Ir`U9n5Gdcuzhu(;^!UJj z3V3$VM?J+V%OF)8<*!?m#Hw>s_;YZ)cSGjH*VCzvsy+dDsWoCRZ?He^d$JZ8!z8t!r@jGW-o6tr7=s%)z9m+7~af&K7r+>F&1 z6gatW9qu$$*`v24aQaNdL2oVe=X<_qv%P_SC|{|^L_tegc`R@{btsZ&LMt zhx#ZQ#Wd=}R=o6N$+r>W$PU(ujDEV*W?`sReiNF<-m=KNgLhIy&|1(o>!KhuEAy(b z^$je4(Qj|8tVKjF*=lNOT%6FfAz4pe%CsX-+6rq3O$d`Nk%cvE1RFDjZIl5hnISQI z9b^7VeXi%%8t`t0KU&QV9p+j^!FYR}aCiNa^3v}j(R*k!kMv*Xo^0eF?bVWO+;nBT zwwC)@>`lJ=XgamresYbjv1w`Rc{XGDv0FJVPm{A%bZ(r{)izH_Nx_TW`^6#c4vgN% z6Cng6p_qe?pUO@7$vrwKjdee76DQviUdlH9LQFAGFBR*SdCQI4I*NVCykJ@Oj?h? zuh|yk&yjYEjs+Q8mwIK^Q_zDIv0@{6YF}->R)3#Em;WwzgdwkDNpVVb=-IiZoY>-V zkPhi-bTVD<)vgd!{8i(az?`Z47|xf?hFa-F=_Qp+ zsqnh4$-CjMl(##X2%hq-{p4QJc0Id=;o&RaqB-VosH-$sp-fxwOw+}WXF>yiA#}y` zL^`IEt3_Yz61vuSVVw9R3$JmZtMX8beQ3T~2@X=a(?Uu-_+tA71** zZFMSkfpnKWv{^2+mG=U!^?m;VyBhXi7e3_GmKTHpanp{$lDBj0!~h;CXYJ%;IKXSjr-b- zVe&F^M-j%xFk?#&NX#`VsHL8bEgwRNE{ZpZ4}x9{Dq&+jfH&7k*o8fMCi3n7f1s(% z|M0Mi)?EOAn8E4jdBIyBB+y=4ktSW>vLWR*oB(Wktni2G)q{ogqcw1_uqsVNIPLa7 zJZ4zkKVSry($`O_z?8l!g+vU^+YS5Qd?ejuX8+N~`hgIbc~_;77)0xe|8!)dv41`R zuQvxwnd{qaV9H#TLSg`|1Z}Xg#)ALx%=x4B^{pt-(yvM(F_vj-XMc7ho21tIjR2kR z`kD)LzN=D5oM7G(hQBGUKrj45AN-@)_4NoS=&MpljHea+;D8xjx*eTftA&DBL zC`-#*5^3|=B}(L#d^7cVlcTrOIp25ZJf8WVai06!`@g^6{aqVN5DP!RFjS-g;_H|H z{^0^70Rkq#U&SjN6Asf z9xDK-tUn4HLLlM;RPaGwfdns1FxE%K6GQOvz+-|v391nR{$E`QrrTje=!>zha}{sb z8aSX1X&F@lf2?InI{&fZd2<6QC1gC!Q|WjinEzZ&{9TItJ@}tg39pNAq;k0$xqCre zV$t)Yc~L9J`K#WOAx^Bi+m3w#AFRwhpLw-BA?=w<%!hms$(dUJaEGMDz7&#EF>hDe z10%E)yL?4R385~IwXVUKr@&;NXy%6i2a%iBbHzFFh+X8c&61(Av$pXWp# zjjKdO^ z_dCvU=&uH#$Zwn7Snfi>b^jy0#1wLQ?UOB)&LYZkypbnjr(MDi+NbaZ!P}Jb9Ewa1 z)Cb=anuA;ti|0tJ5uU;fTAn2`ZIkozWtzMT1Qw|gSkje#Cs#hG*FQ_^ z-TuS4wCycPk0e~(Y3hwT3*dA+yquLMfQg#0=ROnKEKt<{Z0Esm^PPOX0NCR8<@d z0s_%ycR3mXR)_qBhf@8UYx!+$WMd*IACbq89Tc+$`eqv4qal*5DNsX7pI}^-c8^pX zuSw!jY!&f&sHjQeww-xA@l`~EXdb&>D0Zjo*nXWWHSYP+Ib&8rO^>>}_jC#yCM${Z z9oL9=ESPklD!0813L0KqGQw!Ba7sl9pBM@eo8e~ZSZl8u&sE*vo^L(0`qiKBY1kAwp9>@bg96|p%8f|&2$%5ulkagmk-nL&JB}Y#useao$VPyfHjPdgG8>oJqsH%y z^fhjmkFStPZ)LKybcNFvZB#R*i>jx}*m;dbVRErV78a*K&$oKAC-BzRCutA%zo%1aohmbS4t_GRQeO88+vX3*|~t#MwM^77derxjRR*ccdaxy%wPZiy(Pf zOzcA_vFZ1K{(>wfWi-l(jYL>DRs?1@G-LXy2@)?0wEuScyLROxrfONmoTY%eq&}(j zd?16Cmryzi7&ktx?rzrb>dkYb#65e{65iD?t_`oKn4p*p$wVTPE?SVo@+J$(Jg-~# z>QhMaOPblz(e)1|?nL97$Hdt}0#tAJH9Z#VG(j!Ac#-=#o_qe9j^-5yq*WV{ZL0Lq zY*g5RkO$;HW8EoDwPLSiM9QvajgorL5qD)hs5WYIjVjcRefi}^laF_uM9cjzbFY>6 z9$TJRez7#S#UVUlq45q^RI5tVZT>9(+tYo!QJ1-nEW9hIt13FisOVNCkb0MnaYjvS zTrGdn>uCGGRP;{@=eJ6F)i=#SHHCOka7EBt(?N6P#>(7uI} zKHejReh1MQw6{l~_nRq?yWcR9>1|j{rpLvI?R(T`*T|#zO#mRV9wVN3te;n~3Kky_ zgeQ3YgO&I+J4^z7G4^#>d4fdY`_=iQMjgZsz>i9?_`qCc#2;O<9jIr`4D3gFQb4m? z2hO}T9;Z@sf;BYvRUmZU-tHTn{;;TzA=@5k1?d{@s#45=ZY|p63vAz8mDZvAksouW z-7F@c9LP_$(g;!xR*dqfSWc1g(Lr^G9^A%R#WAcP{YT&Fb9{|;riMkfL1dR3a?CT5 zJ)24nXjc-BJq^3$B0AvsNz)|aPcff*`rNd z+HdZ9G*+ta5#=v9*{Z`VBk5BO)r%CwBEuKCiBN`kpcqqA?QB!3HH=`zcC|HQ@O$rw z?64tFM$Ip$x=BFPrp<+3FK2a*>3tSAk9~cs^xZPLY+zbl{ha)@OXpm=T#^JJVC(4g zi^0d>-Ym8p&+PLjS$-ec>VNNR( z;QTgI_E+^!V=_A0HV0`Gh)nk{G!350tqgaPRqGQjf#XqJy=JYZ9kn=+^w!M5gqsEn z18+Rkklo&PvzZyyzM31&LmfDN^WNMZKCZP zYRrDCdsSQq&PtevC-VkVRC2T8hDt|G43X}G3JZ|*p1oY@J?Na9S3&}>AG>7^AyFpzBFKuEyJXs-Mq5qv2TS{YKR#RL*s7oYQL8jj=!RV zUNOpyZOd&g_iSXHDU>vjef+evZttn)Ew?g9zc_`8r>YiG9Y$Zf_Fd_Qwm|)5&g2-0 z8idiR^6Go&0Zyb&&CSVFTQ1X1=tY!eIcx8yKUWmaYI&BcuQM%4zAZKGt zF|@>ve_@he!0Y!I<$tNH-W@OZfE}Oiz2*}$W^xn+;@sm0-Gjhda(*!NTZwsGXzB+g z2ssEzL$R(1f{ueL9|*zcx)%x+a$Ir%# zjoocf?Q7jJ^xWFs&CqkJR!lNyTNlz#n)C+hZoQMWt&$-FR;`#s1phpypZNPlP>cq= zmPQy2c-4wYz8vd<`UPKX(2myz$8fe5j0|R4wPMnB$j^iOh2IT>WTn3m0N|j1#_2^r I%*A;659D5