From f538f839488feff9ba3e94975b55660724f420e7 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Tue, 22 Aug 2023 16:16:39 +0200 Subject: [PATCH 1/8] Add instructions for changing to a new IdP --- _toc.yml | 1 + .../saml/saml-change-identity-provider.rst | 36 +++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 docs/platform/howto/saml/saml-change-identity-provider.rst diff --git a/_toc.yml b/_toc.yml index 26fa012087..f6c4139b8e 100644 --- a/_toc.yml +++ b/_toc.yml @@ -90,6 +90,7 @@ entries: - file: docs/platform/howto/saml/setup-saml-okta - file: docs/platform/howto/saml/setup-saml-onelogin - file: docs/platform/howto/saml/setup-saml-google + - file: docs/platform/howto/saml/saml-change-identity-provider - file: docs/platform/howto/list-groups entries: - file: docs/platform/howto/manage-groups diff --git a/docs/platform/howto/saml/saml-change-identity-provider.rst b/docs/platform/howto/saml/saml-change-identity-provider.rst new file mode 100644 index 0000000000..dff5495cad --- /dev/null +++ b/docs/platform/howto/saml/saml-change-identity-provider.rst @@ -0,0 +1,36 @@ +Change identity providers +========================== + +To change the identity provider (IdP) for your SAML authentication, you first need to set up the new IdP. Then you can link your organization's users to the new IdP with the signup or account link URL. + +To change to a new IdP: + +#. :doc:`Follow the instructions ` for setting up the SAML authentication method in Aiven, configuring it on your IdP, and enabling it in Aiven. + +#. In the Aiven Console, click **Admin**. + +#. Click **Authentication** and select the name of the authentication method that you created. + +#. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP: + +* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP. +* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP. + +When a user clicks on the link, they will be redirected to a page to link their Aiven user account with the SAML account: + +* For existing users that are already logged into the Aiven Console + + #. Click on the **Link profile** button. You are redirected to your SAML provider's authentication page. + #. Once logged in to the provider, you will be redirected back to the Aiven Console. The authentication method is linked to your profile. + +* For existing users that are not logged into the Aiven Console + + #. Click on the **Login** button. + #. On the login page of the Aiven Console, log in as usual. You are redirected to your SAML provider's authentication page. + #. Once logged in to the provider, you are redirected back to the Aiven Console. The authentication method is linked to your profile. + +* For new users without an Aiven user account + + #. Click **Sign up**. You are redirected to your SAML provider's authentication page. + #. Once logged in to the provider, you are redirected back to the Aiven sign up page. + #. Complete the sign up process. Your Aiven profile is linked with your SAML authentication method. From f733976167b8f211dd80e280b7f60d5feea7469e Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 23 Aug 2023 11:28:53 +0200 Subject: [PATCH 2/8] Update SSO articles for clearer instructions --- _toc.yml | 1 - .../howto/saml/saml-authentication.rst | 2 +- .../saml/saml-change-identity-provider.rst | 36 ------------------ docs/platform/howto/saml/setup-saml-auth0.rst | 8 +++- docs/platform/howto/saml/setup-saml-azure.rst | 8 +++- .../howto/saml/setup-saml-fusionauth.rst | 11 +++--- .../platform/howto/saml/setup-saml-google.rst | 8 +++- .../howto/saml/setup-saml-jumpcloud.rst | 8 +++- docs/platform/howto/saml/setup-saml-okta.rst | 10 ++++- .../howto/saml/setup-saml-onelogin.rst | 12 ++++-- .../howto/saml/fusionauth/login-sso.png | Bin 10749 -> 0 bytes 11 files changed, 51 insertions(+), 53 deletions(-) delete mode 100644 docs/platform/howto/saml/saml-change-identity-provider.rst delete mode 100644 images/platform/howto/saml/fusionauth/login-sso.png diff --git a/_toc.yml b/_toc.yml index f6c4139b8e..26fa012087 100644 --- a/_toc.yml +++ b/_toc.yml @@ -90,7 +90,6 @@ entries: - file: docs/platform/howto/saml/setup-saml-okta - file: docs/platform/howto/saml/setup-saml-onelogin - file: docs/platform/howto/saml/setup-saml-google - - file: docs/platform/howto/saml/saml-change-identity-provider - file: docs/platform/howto/list-groups entries: - file: docs/platform/howto/manage-groups diff --git a/docs/platform/howto/saml/saml-authentication.rst b/docs/platform/howto/saml/saml-authentication.rst index 92012cfe2e..6fca2064b3 100644 --- a/docs/platform/howto/saml/saml-authentication.rst +++ b/docs/platform/howto/saml/saml-authentication.rst @@ -98,7 +98,7 @@ After the authentication method is enabled, there are two URLs in the **Signup a * **Signup URL**: For users that don't have an Aiven user account to create a new Aiven user linked to the configured IdP. * **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP. -Send the appropriate URL to link the authentication method to a new or existing Aiven user. +Send the appropriate URL to link the authentication method to a new or existing Aiven user. If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup. When a user clicks on the link, they will be redirected to a page to link their Aiven user account with the SAML account: diff --git a/docs/platform/howto/saml/saml-change-identity-provider.rst b/docs/platform/howto/saml/saml-change-identity-provider.rst deleted file mode 100644 index dff5495cad..0000000000 --- a/docs/platform/howto/saml/saml-change-identity-provider.rst +++ /dev/null @@ -1,36 +0,0 @@ -Change identity providers -========================== - -To change the identity provider (IdP) for your SAML authentication, you first need to set up the new IdP. Then you can link your organization's users to the new IdP with the signup or account link URL. - -To change to a new IdP: - -#. :doc:`Follow the instructions ` for setting up the SAML authentication method in Aiven, configuring it on your IdP, and enabling it in Aiven. - -#. In the Aiven Console, click **Admin**. - -#. Click **Authentication** and select the name of the authentication method that you created. - -#. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP: - -* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP. -* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP. - -When a user clicks on the link, they will be redirected to a page to link their Aiven user account with the SAML account: - -* For existing users that are already logged into the Aiven Console - - #. Click on the **Link profile** button. You are redirected to your SAML provider's authentication page. - #. Once logged in to the provider, you will be redirected back to the Aiven Console. The authentication method is linked to your profile. - -* For existing users that are not logged into the Aiven Console - - #. Click on the **Login** button. - #. On the login page of the Aiven Console, log in as usual. You are redirected to your SAML provider's authentication page. - #. Once logged in to the provider, you are redirected back to the Aiven Console. The authentication method is linked to your profile. - -* For new users without an Aiven user account - - #. Click **Sign up**. You are redirected to your SAML provider's authentication page. - #. Once logged in to the provider, you are redirected back to the Aiven sign up page. - #. Complete the sign up process. Your Aiven profile is linked with your SAML authentication method. diff --git a/docs/platform/howto/saml/setup-saml-auth0.rst b/docs/platform/howto/saml/setup-saml-auth0.rst index e88580b9ba..945a886bc4 100644 --- a/docs/platform/howto/saml/setup-saml-auth0.rst +++ b/docs/platform/howto/saml/setup-saml-auth0.rst @@ -76,7 +76,13 @@ Go back to the **Authentication** page in `Aiven Console IgXlVGd@1<1H(4GKjXy}Sq z7>~@o_u6wbGz>Il1$F6%hlk6{%k%T|larI9qocjOz1`j2jg5_igM;Pe<%NZX>gvYv z@$uQ&*`c8!6biMqwIwVp-P6<4-{1f6aC3YAC~$W5@UV3I@Nl>FaJzhT|6rj1X`M=e z_03y{w?Ys12V9!z&E9gkhJx2U!4KENQ}G%bcMt3D3$#T=$8H`TPTC*N>yUx(Z#%vz z$4!0iyn=As>~X7nJ5@J)^Lcg}cTuI|Xj7lUnz) z?R(3Tf46^rY%+LnF)NvUkTK;EiJQ0y9k|}ew@z}_;p7z2%UTt1sNpgy(B+nvov|P%D?#@v5{Fycv(*fP7xbG>Y!N=&CPjFNx*hF$r$m|IygH zVcNP|?gH0>9ra#Xd>_{}OX~dQDxqjz{MpdQOgr7={pi8HasH;7?brK?u{IZ$sjB)1B`Amd-RZ{nu9eX0 zsf&)WE#0(rzPNS9kWJ^l{QO_X7N34aI~=H(OPa=>`T5?ad+k-69ye|pg|+Uu*KnyO zCt2AJM{C~g4INJXvhd9jmDZd(zrWtQv5M=ADe1VX&fEI%MOe}O%)@DOtkLCbiB4et zJ6Paiseej@@5Wo(j*Xk<@vWo6zQMeZucq&ZR}OQB_8-ocZ~u;*)eK)GeO)=ey&RhR z_ji0hwkN{PdH3Re1Dbk}H#gDUe(7T}zkPN)+;~}6+xtbYX}%#gr>d|wzw38T-pJy@ z-a!A^?u2ZI92y#Povf6&y64=#*>;B@E<$M))1Uym-khts+s~%n#P4u2innv(Hi2T+ z;y8yoxY#ap))$BvKnsom5wD>?^AZyWl>a}>BN{JHyqyuRwT~U#Td|*0!hW=S;_c4% zg1o*d#rGDjmGt8>Aq=SuTbu$YjtVV*H(g2tS1;^B>6*p#S)#StK~dcxCPF5#R{@#$ zAOgd*(6Vw$rNwtpa!GqWnY*Nxa9eUja%t*E1rsi271Ia$=iwQ!6XMiWEP=3CpG66r zE-hW4B}R~cm20_nQfy3cYge4Q=d&!0L|^V=wEcG~h2+H2^CMxJeLKjQD_d0%(McR; z*B3)T6`_P+lQ)A5Ca=Z;MvC|7D8*U^16>nWE`}cVi&%wph@k^yb+SFmmhCr9PG7D7 z@H2?Q_LGSICrEE+OpO4|zCDBy(b*m)dF+`Ao{olj+s{%D&g@R+ZT$+10(ogywi+5R z`!xXLJcu(|u;jUEsh7gRE**-_OX|3sX`SfojL>*^w<11_?xv+@T(qR|LJuMI7rsC} zShtyqfC1T6z*T`cl>fLqf2|_#EQUaMm(Gi7&A87;)CPDk5nV(u zge?wI?F~LI|JfIG*7kAAbftYN<=CjvYF8X^mjz0Y0^Xa{^Sp#1M`47w?ff$Y*5t-& z7UbytOIZ@#hQ`(3KFm^9^e=grRc2##g{m_0hc{m=NlIWneNxfw-6H=lhS?wMO|y~> zD&u3uhyBfi=04FPiK@hgQ$ZJ`FU5wWcjzuuw(y4FSVVvFYGp1-+PrE7>Bft&0 z-2^tU8h=<13YA+V_2UP8j9HMj8N++7`76;gmN0}yv&x_Bs;*nM;t4|Z9}w$qJ&?wm z+bE~%@vNjMv;CmMG;Ps1Y3l8GxcuD<*TMtF*Vpj=W`iR|TP(!!TlD+xUq4b%q8Oqt zA(W$ygZwcRiX$;xozmVJCpAZHJ`-}3LOz0o z=kYe#d|vYIfEy&Eq$ghQNCrdS*Bx9>oB38p#ec=v$Fe|nssBiORz)J=XDltCl{nUC zrO9LU%{TJN$#dCp-DZqZfR%&*H}7g)wj4bhM-3fG;_~zhXKL8K@z`hf50;iA5)`uC zjSfgO=x=X3H;Axp5*6-;tR<7lExD2x2sJQMoT*vX$;!tI+L5GR`k&375F<@-L`pNq zMX(adfoR-MGHltX;KLY#p8nlUwE=53j$=rp`uU&mZucTC`4W6-5B^Ubw-D^+8w-3m z%vCVMRo|2Jf_8=|M|q4Ju{!!13rK2qtl#AC=^y{GHJe|D)kG$-y4-9=8JJgNOActB z_Fg72(Es!F2w?ZS0Cq5)!;*P2*{Q%+>E~Si^%TG*;wiQI|abAmnB^%aAy*lf=s?i)jqq5B5PNT zcP#Mcb#DL(%ex9P;#^HbtunR)a&(7}+CDWod#{SGQ*OqKcrAI)RKE`!Sqjo9?&v%6 z0}E0|o)3?!{G$Adg%`y#o>YeKX?ENu`Eh0`C#3Z8RW*GxRx)zj=IDl(OjCYdEGL@! zK$r2K*53XDG#6ZSg;<87eyueQ(?|RGsaD!3L9FnX>taaB-r#{xkEC0dD9fpRP@QoN%f^w&8e&_=4cK z!Aw6>y79WnlqN@Ams2p~_0(y>LXi8@WQU$(q4tru>dC4)M;fuxw1fHs@nQ`M;*|ZpG?^GuE-c0oOoz4tNGv_V-lSk}EU%_eREslo~5S{N4kx znwN53eyinK7=QDf`BTZi}s-r`EBa=mx+gm!&fmijZf-dl4uG7 z==TQ=x9k@&xE42Wo7j;ImazzGOTHj%gEvAw3*8mt@^8)zDCB9`2=?6%eOOY3KtlL8 zie;0bE1o3)MWS0sV9{aYnK;sc`$#w0H-&?%)w&wV6*YrMFe!NAX-!p+drOE`S8NrF2B$(+HH_gC_@{t}IUfnLZN z$^$1?F<0D4GR_8V4krIC$5h{Pb!^)*N7?%8Iv&oP-u%9(?K3FO z8du-a2yH~pa${Ho10$P})ebr8vC@%6EZfx0N7%6K2hXg(E!W9j**nWUg|lX(NZmpx%?f9ff95 zo4@D`Kn(|twPWGK6D*^vS?HFR119S5%Sr`9bg&se*ozxhz+q|FhYA;~%%`RpAn>q`ReWpOsm9*N$gm`1#eQhy@w z6AU6W+jOY&b_B2UOgQX@A8n@=O4xQ><-P1`L1#Wth*GInA^iY7iPBar`ZOrR`Wh8> zI7OVEuZ@~YKb!itvJ&-_#1d|paP3T%n9IrI=bM6RFVLdVWVy&fZ#c#2_T(y)v!@2% zzFiIAgt8yv1AC)9TgdvI+IoLoro&5;3o$)}QUdGbYWs@JMPXvfsm$=AS;4bx+KX2` zi$ToMfT;)M^gXL){EZH+^OR+O>?%{%>9{ZuYJ9NIJ+uw5yy!rQH$CZq`eu5^jEr|# z;YyJK#Z%teA4OFwVzLZQYqy(0Zp?Zw-LzWTB@w~JUma*M1<3=^l|b5Pd6`p3Tm%dX zE4l~S!rtJ?S#NDtwH4g{l~9lX<*aO2#l?(dGpsMbu?~72?v~ny(pq3BQPUGMW=S3i z0ZnvibZ#-dv(sKcS|ra_ymqG=PQcxZSHJFGst@KTk~Y4q<9qiV!mAa9i~TD6JxMSv zPL4RQLKUGKQ6rH!vFoPH)1U0&v^70n`qnhWP-Hc?w;$SW1S3GKuQpMK8O>e ztIqUhz2BmjHW47GZliFxLp`B2(o`fs`seILoeRbd@cH6$I&;QhY3nP^Fh6dL-n3SS z!m6L2iTBmGVH1g`|JlH&kKPv+^<|Az`&FQGjgNt3$}I~Ed=Fh=6z3{~cJ~iJl=ohH z-OE}~=ef}gfL9Jpb|{CETh0Iq0y97qj~zIl(hl51Q41Q!uLYs-=7Y8|=YyO=_u5^9 z_Syv>gBse;jna(0xfUINLoGn$2<{u2IR-9VawYCJhu}RTv>wx^`PSg*u(C%VJMd$m z|G;Yd`Jur7*pE{=>Of|I`$xVU8s6DmIm$_bHl=h5Gk!U^`$0-9hpOK`kUv|5PKU%b zc`P>1#zAsZdiC({ccJq-9@ZXKe77t#q^e~;2_j>u3p!I|;fH`(R0gJbJUS~IhSQZx zl%2~$noPlY9F^kAa?V;oT+~*+o1R%9Do1^1Sve(*T#>I~9{;kb`t3UZnpBB)UaR{N zZV)7OFTb$Ya4f1*RX>wInkwYApZ(57(4b9filTiTL3h2bkjy+Tt3oDWR%;At;Zwh} znTQJW`u49&s6RfGwFl=o;`WP(Hd;A{&hy#N9QFpYo_xcC!gMyA1sP^!-JS2w{o{1K zNihRgiQX~VB!vD_g`BpFVQ}J|dv4W?v#8ZOJ@&orrnF83zg-0O&TewZ(@sdkl0a`> zbFUF2e#mgjO0C5c@oBxb@odmZj9N*{vzcnBJlgSUZV=I#;1W{n)HphfhSIvLbQ@#` zD?{RnY^Y4U#E-VXoeh7ax&TA~{+bst{#&x&zb(~Aen?&|V9xDMtw^wFs!IM$_CSmu zxkJ9i&7dEywZT3I5@ib{st?4Se)1wT;MM)Ar|Ce=Vf8L8Go)yx*weEYKnqjK+5SmH z0rt{uQ>@pLJpBMEp8>#gCvMd);i@A);^(&2Yb~o^@}a~#*Ru-qocpNlkQlH@g3kmm zMPzNrapa^I^i?x-vp+L0(gB663IMBxP2Fn%s0>>>b~%04ovZkFDrTagE4Q`2v~<_x z^+nZzg6e=ofu|r9M|LbW-RT=+xP%UG?V`T3L#EiusL(haKs17UOmn!8FkwQ71m88x zJ4UGY8g1+bOJ-U8BcCn}xy<^5Ib`jNxX@=;`l?cEMAi^c7Z=00I+Son0zQ~wmnB*wD5pbZ=VN~{-a=n`sh z_>m?K!;}=O+x3fdj(OcTH>|)?1!!T?Opi^#L7l^ko7C!?{dv}1uL9}7TR>)=ivW{} zjh`FKwdhBBXHr@^n_!n@k(!P=siZo`v+~>7(Gq~ue{@xa@pOVU6uiw*lP%$4VgHO#$4CpmG4#Pvyc={}o_RpiOmAfcVf@eD z@v%S&GXIXLbRHS~SHqZX=8wiDWi9CBOZvNNbaE^cT2G~MzjpBeer&IF3!8FMU8pj6 zqtdGo>97+3&jJR`PXvE$^1t)jU8!@fLB4rw7<;9E6FJE7zn>O@zQafV4+C;wxE`~c zIMnI(s2dan-bni}RXG`%&N!tgAhZ7Rr!}GGZi>8YoLs8KB9Hn^=zEGJCjkx~JUU(n z>$ks%RwOy`*ekzcW;`RRf7+;3D9unw!7MopB-ic0~D=4BK z&*H{-UryD;&Ioj0eLEr!}oPgoonAQNTuIUea+fjK@TZH}KPz!L%T8EqsV@i|Kw z6xW~wRom^;ZX2*!G>6cnq|VZ3MZCEL2ot}A8voBl3m<0+sDg0iJ5IW? zeJaM+_MJ{dN^=nZ91r^Dg+EqEIjeN`Jh>dAdAf_rU~>4=!$m)_pXiqU+e$j=&)PrX z*_Gh)!Z??&Es2+N;>p52+agx0{I{Rqvb$b?VKJv0ptTw-vQHggRw6R!FhB0BX=KM; zU%Fj6nk&EQv81@evN8XFomSnfz#Y0L7}Ap4a0F(J9{iqD>gUzh0*g0etP zQt{tLy8~+jN3+Wt=B2(`CbgtZZz2RDJim!_$et)oK<9v(mn_{BJ{M0W!Dj4^Cxg6NAmh>Im60=>@qeARTYiKFKX}SS z#|Ps5Hgk4rIbK4M=H2@WZV`wP)4>*dy1QY!R=(u@w3&W5=%Ob z@m$S2y^?_!;@f1OR)f=fJ|y+HWZqzD$*-VU&{SpgHF_C0gosLV4<06moxdHkef^Ze zfoqH^h=|<_%l!wl2O_2`y3q9G_51=dC1{SW32quS_QyOp=p!35#elyL?T+2h23svf z0H!Uh_{C>It;oynbCw_{S;tX4^7rpo7GGZ)-(I zW=bJcpj!T;#c-EC3%Yt=66U*~o6nBDX zpPf!mBgi==~5DKw1N&OCMCV96(AXp_`&NiAy`v1=f7W^|T8TQAJ1JY%)Vms4a(gn&tQ8xf@p|VC&FG$j7cIbhf12ea+sx6|dO)eC1d9^PJiZDintvi{x}>wy zof{fk091c0Z^nASxaERsufa23?lh`okJ6o~W!dVktpgI^XYf&^`fD!|(J{rFqzG@A zV*;u@7J4=nefE+{HV~13$M~T&2U|hdL3o&^6X7xRgUk|zaeLYX$N$Bl9{o|_-DZLe z;4&S-6Fw1zG;-l{@O{z`rS7+MQo}_$eDkcbxA^k7Gqf8L>5e&o26d+uO(xY z>>eu>1A)j78t$oRrT}N)zAI_{@jHci~b%;{H*W~Dr1P=cxw87PixlssEhSnrt0 zNa%E!)gV89pogZhlEM!w`3B+<+i$-3$%9#m?&Pp{Jxfatt9S7*#--8CV$>*Y;huJC zOuyzgzTI2MuB9z2$^`L@1=&SA8!`>42uYGX3kK@<;NMIGWa|yS%1<0YzYaup)yC#W zzc?-`EbCcD-b?i1Bq>Fa?^$oMN>I9qLrzEef39ZjaO;tPhCxc}XkXgNj-J9$&m*8@ zmnl6#dDE&17WPSNeU7$*9z)&Mu4$$uHWy;*dHTwRZ1*!-`kyg_Y+Lif3Z1>MbwJZ@ zcuTgLqz6H-*m?iU`g5)MG@QT@nf<+t)TPidQn{5^o0GR8@8&mYhr@4GteMZ{*pS8J zL(*WM+cIZxi<$;9HaB1Xh7nW9-j8kxqS<4rQ%begJefV!R*1Wr{oi&;WkuwYOrSa# zoJv+%WNA{aWL)=EK=wGh!?hT=>wqh|DZACdpTpBE`PU3S@(2?L9yMi7EKFTqv96Hf zMV;|Z`&8D`^6H`2+<4#H7x)%k-nFL)osJIwG`Be+8xMa4e=3e3Fx7FIoNL(1M$lkM zf~jHXv?{FhrDl57n`_O4X}x}L5!gy#`>L1Gz#vqWev!5WfBZ;JJVO1fd|M?t0=-xW z#a;1~xaL5x=Ki7(R?oE)JD3l$jvrJ3C*CMitgjSN%0R2_i@V%r(^NZm9At-eYsb7M zB;S>FnDTHOF)wF>qTD(QVfcP$qfS&w2c_jv89Z4PqZo4GgbFjOhmwz%bOn#Oz=wfp zFCCSBhWf?AX%CkF?ye_30roMK+Hj{N>gU$uPh`$=VO)z9B~42bVE$pe_i)z_9SyMy zK>|lF7wX2&-&EgK+gmEC4cex%I@Jul7MomQamgjuyNe)zR-f364pWRZH55Qj+uFT4 zgfFZ%9}D3Xvjcof5N(d-GfO?sT8Tx}UT-HqN=G~C6BEJzlM-+y*^eTd+*XDQ@_82H zjy@jbl(HFGYwfrOc}Rx*?8}m8wmtbju?wn?^1_OPe7o1Ko>9TM?7u@=s~24;o|UON zBkO01UNNdbL0pzX?xuurt9kW^-AbXF4^uFfl(Bq6hlK3IZfk~3dt!K9n%1m$2jzQN z=;`v5IChdClq}BOD^npO1J?so=lq6H`f>TN7CU4|E00UavtHD9-@lMpJN|Dc;lmJ- zA<;RTl~wfxo6jpyKoJ^+YFqQGAb6^M@Io^9zXK6p9{e-!vI>rb z(yKui#4=mMal(wmDbTSlo!Iin(WD+|J54N3eulS4nz~>4U@^PTl|DRe-Hl*xOrY+B z`sNN#L&-id9;>ehaesiZz-v5S)UPXncW1w`5pH~ZLh-pqsfkI4OYVr;h@;9^7jl}I zRQwn(58cX*UTp3Nz+uPP$KV%%ve55RHP9OMxEIeYoeD=a-0zctgx@oUHekRrDhB zaoc#W11LQM*|A!B;&%^%Iex}gX}APm7Vu|iu;xtWn%n+6^FkZR@Zom&yOLRej3#1` zfjB^+%cH2}%Y%Y2j@^8a1UdYc`)t`_tS~Yt&374*SpeJc=h<9`Eo&v7Dr5R7L&wxJ z9jex%>~OqIyJc>fJhBZgWpPM~{O;icaHcj=o>AN z1v170vq&!D)^?n?a;7u10_3y!Aq434=?96EIG(?U|Z^` zNdxb~)sEgis8Q;`;^2k6AV->|eC4L$sA;=iNtZbC$_HLS33zxH3v^VeY+2b~;h8=2 z7eztzie!Zqg%rba49nA6^$mXw>rIN;*q2D`LcHbP4cIgDX!low1-b!cv{Aq9Dpduk zti}bTzypd(O8>r_Yjn_<6Amo@{_1V#8}|4SVrz6{SUNvU*K^_phoAqcBeQy=mSZpu zGJT=KPUJgC)57Y@s4(%O3*D&6tUz;9?GGTvoK@SUD}Ys45DdKU+4fkfoOr<>)F^S9 zm5;3(XTVH%HG~3EIcsb(=sw9&qA(=DOEU{z8K<=%LCXGWg113#%4r006alh zbcKDl449}OBRK|CF@mdK4e)aJ=`Umj9q40pL*tasiJq z3&RT|p#TG@=GDtyVK>JOQL;jQL9K=AsBc|uT~PuP=JwOY?Q%=B{9MHuj^>Rx(a?Et0?ScZnIC3CD(>2)0)u&i zfQNw>^Fs{hw?_0who5&_`j;P+5ox8|`VSacSHm0(z{3|f`G1XbTVYsx()kc=y#{%B zAQqX?t6=@V3FFRJq6i|QuBfJ7dh_iX6Mos5!f^(cuFx}DA#JcpCp?C#1XN)ReNQkI zG*b>Rf_BC2w83#fXSDn!puVG|v#mmyxgFef7Osqdt3b8E9dN>_pj#E_zJU^S=L!6D z5vm2=QQ=epKeG9Nz>W%oEFx9oKPnW^gaXF;l&bi<kK-T%w} zca}UCsxI+v@63uFDmG?HKAlaMz*T}elmUArbNGk`Px8NX@8u*P3u@1__Od@V#-v(oQ~mnKp3(eoE8lDAmwe_M%%v?#lx-Ke4uY*!@4 z7~+QWNIDPmwE>c8-K`NQ4$wVC?Hu5Y??dqwg%_V&=lWaVf0w1DB>sOQ!njF;qR@2~1E z$T^Lv3i?>2As?li_?x&spvbv&uN!+hi;-7krsSMkpr<<1ZqIMmWQmM81MJw=#NKh~ z4#U8WKnnO0UA&7BP4+#V7#<lBX@4R4jG}`uhtZjdMsYz_oL_T&X0MJ( z=+~*068M?5m{bf>EK;hLKc4}*ZHz}Y8W>MwzzKQIyN>dr+6vk4Ch#x-Mhj@i_YO|6ewmCj3B*r=C$0zj{Halw*ekMhN4u}0h7*bkm`Q2CH$@ zUQjXlolbN$uy@C3BE78Mzj6-iH1S*JYn4|ZK1V*QG}&ACew9~YG=A|t<|;LHk@}Pz c1AYgkvHOqL{4R+RcBVHEhk0P71cSpWb4 From f85af6daa8125f8a2d883b7533f6ff06b1ab8122 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 23 Aug 2023 17:12:19 +0200 Subject: [PATCH 3/8] Restructure Terraform section --- .../styles/Aiven/capitalization_headings.yml | 2 + _toc.yml | 122 ++++++++++-------- docs/tools/terraform.rst | 6 +- docs/tools/terraform/concepts.rst | 2 + .../tools/terraform/concepts/data-sources.rst | 4 +- docs/tools/terraform/howto.rst | 2 + .../howto/upgrade-provider-v1-v2.rst | 2 +- .../howto/upgrade-provider-v2-v3.rst | 2 +- .../howto/upgrade-provider-v3-v4.rst | 2 +- .../terraform/howto/vnet-peering-azure.rst | 4 +- .../tools/terraform/howto/vpc-peering-aws.rst | 4 +- .../tools/terraform/howto/vpc-peering-gcp.rst | 4 +- .../terraform/list-upgrade-terraform.rst | 6 + docs/tools/terraform/list-vpc-terraform.rst | 6 + docs/tools/terraform/reference.rst | 2 + docs/tools/terraform/reference/cookbook.rst | 6 +- 16 files changed, 103 insertions(+), 73 deletions(-) create mode 100644 docs/tools/terraform/list-upgrade-terraform.rst create mode 100644 docs/tools/terraform/list-vpc-terraform.rst diff --git a/.github/vale/styles/Aiven/capitalization_headings.yml b/.github/vale/styles/Aiven/capitalization_headings.yml index df3214d797..02e1425623 100644 --- a/.github/vale/styles/Aiven/capitalization_headings.yml +++ b/.github/vale/styles/Aiven/capitalization_headings.yml @@ -13,6 +13,8 @@ exceptions: - APIs - Aiven - Aiven Console + - Aiven Provider + - Aiven Provider for Terraform - Apache - AWS Transit Gateway - AWS Marketplace diff --git a/_toc.yml b/_toc.yml index 26fa012087..4848de1a80 100644 --- a/_toc.yml +++ b/_toc.yml @@ -211,6 +211,8 @@ entries: # -------- TOOLS -------- - file: docs/tools entries: + + # -------- CLI -------- - file: docs/tools/cli entries: - file: docs/tools/cli/account @@ -231,79 +233,87 @@ entries: entries: - glob: docs/tools/cli/user/* - file: docs/tools/cli/vpc + + # -------- API -------- - file: docs/tools/api title: Aiven API entries: - file: docs/tools/api/examples + + # -------- TERRAFORM -------- - file: docs/tools/terraform - title: Aiven Terraform provider + title: Aiven Provider for Terraform entries: - file: docs/tools/terraform/get-started title: Get started - - file: docs/tools/terraform/howto - title: HowTo + - file: docs/tools/terraform/concepts/data-sources + - file: docs/tools/terraform/howto/terraform-logging + title: Enable debug logging + - file: docs/tools/terraform/howto/promote-to-master-pg-rr + title: Promote PostgreSQL read-only replica to primary + - file: docs/tools/terraform/howto/config-postgresql-provider + title: Use PostgreSQL Provider with Aiven Provider + - file: docs/tools/terraform/list-upgrade-terraform + title: Upgrade Aiven Provider entries: - - file: docs/tools/terraform/howto/terraform-logging - title: Enable debug logging - file: docs/tools/terraform/howto/upgrade-provider-v1-v2 - title: Upgrade the Aiven Terraform Provider from v1 to v2 + title: Upgrade from v1 to v2 - file: docs/tools/terraform/howto/upgrade-provider-v2-v3 - title: Upgrade the Aiven Terraform Provider from v2 to v3 + title: Upgrade from v2 to v3 - file: docs/tools/terraform/howto/upgrade-provider-v3-v4 - title: Upgrade the Aiven Terraform Provider from v3 to v4 - - file: docs/tools/terraform/howto/update-deprecated-resources - - file: docs/tools/terraform/howto/config-postgresql-provider - title: Use PostgreSQL provider alongside Aiven Terraform Provider - - file: docs/tools/terraform/howto/promote-to-master-pg-rr - title: Promote PostgreSQL read-only replica to master + title: Upgrade from v3 to v4 - file: docs/tools/terraform/howto/upgrade-to-opensearch + - file: docs/tools/terraform/howto/update-deprecated-resources + - file: docs/tools/terraform/list-vpc-terraform + title: Virtual network peering + entries: + - file: docs/tools/terraform/howto/vpc-peering-aws + title: Set up AWS virtual network peering - file: docs/tools/terraform/howto/vnet-peering-azure + title: Set up Azure virtual network peering - file: docs/tools/terraform/howto/vpc-peering-gcp - - file: docs/tools/terraform/howto/vpc-peering-aws - - file: docs/tools/terraform/concepts - title: Concepts + title: Set up Google Cloud Platform virtual network peering + - file: docs/tools/terraform/reference/cookbook + title: Terraform cookbook entries: - - glob: docs/tools/terraform/concepts/* - - file: docs/tools/terraform/reference + - file: docs/tools/terraform/reference/cookbook/kafka-connect-terraform-recipe + title: Apache Kafka and OpenSearch + - file: docs/tools/terraform/reference/cookbook/multicloud-postgresql-recipe + title: Multicloud PostgreSQL + - file: docs/tools/terraform/reference/cookbook/kafka-flink-integration-recipe + title: Apache Kafka and Apache Flink + - file: docs/tools/terraform/reference/cookbook/kafka-mirrormaker-recipe + title: Apache Kafka and Apache MirrorMaker + - file: docs/tools/terraform/reference/cookbook/kafka-karapace-recipe + title: Apache Kafka with Karapace + - file: docs/tools/terraform/reference/cookbook/grafana-m3db-postgresql-recipe + title: Visualize PostgreSQL metrics with Grafana + - file: docs/tools/terraform/reference/cookbook/postgresql-custom-configs-recipe + title: PostgreSQL with custom configs + - file: docs/tools/terraform/reference/cookbook/kafka-mongodb-recipe + title: Apache Kafka MongoDB Source Connector + - file: docs/tools/terraform/reference/cookbook/kafka-debezium-postgres-source + title: Debezium Source Connector across clouds + - file: docs/tools/terraform/reference/cookbook/kafka-topics-http-connector-recipe.rst + title: Apache Kafka with topics and HTTP sink connector + - file: docs/tools/terraform/reference/cookbook/kafka-custom-conf-recipe.rst + title: Apache Kafka with custom configurations + - file: docs/tools/terraform/reference/cookbook/m3db-m3agg-recipe + title: M3 and M3 Aggregator + - file: docs/tools/terraform/reference/cookbook/postgresql-read-replica-recipe + title: PostgreSQL® read-only replica + - file: docs/tools/terraform/reference/cookbook/clickhouse-access-setup-recipe + title: Configure ClickHouse user's access + - file: docs/tools/terraform/reference/cookbook/kafka-clickhouse-integration-recipe + title: Apache Kafka and ClickHouse + - file: docs/tools/terraform/reference/cookbook/postgres-clickhouse-integration-recipe + title: ClickHouse and PostgreSQL + - file: docs/tools/terraform/reference/troubleshooting entries: - - file: docs/tools/terraform/reference/cookbook - entries: - - file: docs/tools/terraform/reference/cookbook/kafka-connect-terraform-recipe - title: Apache Kafka and OpenSearch - - file: docs/tools/terraform/reference/cookbook/multicloud-postgresql-recipe - title: Multicloud PostgreSQL - - file: docs/tools/terraform/reference/cookbook/kafka-flink-integration-recipe - title: Apache Kafka and Apache Flink - - file: docs/tools/terraform/reference/cookbook/kafka-mirrormaker-recipe - title: Apache Kafka and Apache MirrorMaker - - file: docs/tools/terraform/reference/cookbook/kafka-karapace-recipe - title: Apache Kafka with Karapace - - file: docs/tools/terraform/reference/cookbook/grafana-m3db-postgresql-recipe - title: Visualize PostgreSQL metrics with Grafana - - file: docs/tools/terraform/reference/cookbook/postgresql-custom-configs-recipe - title: PostgreSQL with custom configs - - file: docs/tools/terraform/reference/cookbook/kafka-mongodb-recipe - title: Apache Kafka MongoDB Source Connector - - file: docs/tools/terraform/reference/cookbook/kafka-debezium-postgres-source - title: Debezium Source Connector across clouds - - file: docs/tools/terraform/reference/cookbook/kafka-topics-http-connector-recipe.rst - title: Apache Kafka with topics and HTTP sink connector - - file: docs/tools/terraform/reference/cookbook/kafka-custom-conf-recipe.rst - title: Apache Kafka with custom configurations - - file: docs/tools/terraform/reference/cookbook/m3db-m3agg-recipe - title: M3 and M3 Aggregator - - file: docs/tools/terraform/reference/cookbook/postgresql-read-replica-recipe - title: PostgreSQL® read-only replica - - file: docs/tools/terraform/reference/cookbook/clickhouse-access-setup-recipe - title: Configure ClickHouse user's access - - file: docs/tools/terraform/reference/cookbook/kafka-clickhouse-integration-recipe - title: Apache Kafka and ClickHouse - - file: docs/tools/terraform/reference/cookbook/postgres-clickhouse-integration-recipe - title: ClickHouse and PostgreSQL - - file: docs/tools/terraform/reference/troubleshooting - entries: - - file: docs/tools/terraform/reference/troubleshooting/private-access-error - title: Private access error when using VPC + - file: docs/tools/terraform/reference/troubleshooting/private-access-error + title: Private access error when using VPC + + # -------- KUBERNETES -------- - file: docs/tools/kubernetes title: Aiven Operator for Kubernetes diff --git a/docs/tools/terraform.rst b/docs/tools/terraform.rst index 1cfe6f4bf0..df56ecaec3 100644 --- a/docs/tools/terraform.rst +++ b/docs/tools/terraform.rst @@ -1,5 +1,5 @@ -Aiven Terraform provider -======================== +Aiven Provider for Terraform +============================= With Aiven's `Terraform `_ provider, you can use an open-source infrastructure as code software tool to declare and manage your cloud services. @@ -16,7 +16,7 @@ See the `Aiven Terraform provider documentation ` for your first Terraform project. +Check out the :doc:`get started guide ` for your first Terraform project. .. grid:: 1 2 2 2 diff --git a/docs/tools/terraform/concepts.rst b/docs/tools/terraform/concepts.rst index 7841c1cb92..0b753b088e 100644 --- a/docs/tools/terraform/concepts.rst +++ b/docs/tools/terraform/concepts.rst @@ -1,3 +1,5 @@ +:orphan: + Understanding the Aiven Terraform provider ========================================== diff --git a/docs/tools/terraform/concepts/data-sources.rst b/docs/tools/terraform/concepts/data-sources.rst index 9037005f16..326fc2af9e 100644 --- a/docs/tools/terraform/concepts/data-sources.rst +++ b/docs/tools/terraform/concepts/data-sources.rst @@ -1,5 +1,5 @@ -Data sources in Terraform -========================= +Data sources +============= It is common to want your Terraform configuration to refer to information beyond the current Terraform definition, either because it is defined in a separate Terraform project, or because the item is not under the control of Terraform. This is supported in Terraform by a concept called `data sources `_. Providers offer data sources alongside their data types, and in the Aiven Terraform provider, you will find that there are many situations where the same item appears as both a managed resource and a read-only data source. diff --git a/docs/tools/terraform/howto.rst b/docs/tools/terraform/howto.rst index 2fafa3be26..056dda9179 100644 --- a/docs/tools/terraform/howto.rst +++ b/docs/tools/terraform/howto.rst @@ -1,3 +1,5 @@ +:orphan: + HowTo ===== diff --git a/docs/tools/terraform/howto/upgrade-provider-v1-v2.rst b/docs/tools/terraform/howto/upgrade-provider-v1-v2.rst index 103e4f144e..3a76ce58b1 100644 --- a/docs/tools/terraform/howto/upgrade-provider-v1-v2.rst +++ b/docs/tools/terraform/howto/upgrade-provider-v1-v2.rst @@ -1,4 +1,4 @@ -Upgrade the Aiven Terraform Provider from v1 to v2 +Upgrade Aiven Provider for Terraform from v1 to v2 ================================================== Version 2 of the Aiven Terraform Provider was released in `October of diff --git a/docs/tools/terraform/howto/upgrade-provider-v2-v3.rst b/docs/tools/terraform/howto/upgrade-provider-v2-v3.rst index 7db5fdab04..e5d47ae979 100644 --- a/docs/tools/terraform/howto/upgrade-provider-v2-v3.rst +++ b/docs/tools/terraform/howto/upgrade-provider-v2-v3.rst @@ -1,4 +1,4 @@ -Upgrade the Aiven Terraform Provider from v2 to v3 +Upgrade Aiven Provider for Terraform from v2 to v3 ================================================== This article will walk you through upgrading the Aiven Terraform Provider from v2 to v3. diff --git a/docs/tools/terraform/howto/upgrade-provider-v3-v4.rst b/docs/tools/terraform/howto/upgrade-provider-v3-v4.rst index bafbd4ef1c..893220486c 100644 --- a/docs/tools/terraform/howto/upgrade-provider-v3-v4.rst +++ b/docs/tools/terraform/howto/upgrade-provider-v3-v4.rst @@ -1,4 +1,4 @@ -Upgrade the Aiven Terraform Provider from v3 to v4 +Upgrade Aiven Provider for Terraform from v3 to v4 =================================================== The Aiven Terraform Provider version 4.0.0 was released in February 2023. If you previously upgraded the Terraform provider from version 2 to version 3, then no other actions are needed. Otherwise, this article has information on how to upgrade to version 4. diff --git a/docs/tools/terraform/howto/vnet-peering-azure.rst b/docs/tools/terraform/howto/vnet-peering-azure.rst index ae276acd7f..d3089af389 100644 --- a/docs/tools/terraform/howto/vnet-peering-azure.rst +++ b/docs/tools/terraform/howto/vnet-peering-azure.rst @@ -1,5 +1,5 @@ -Azure virtual network peering -============================= +Set up Azure virtual network peering with Terraform +==================================================== This help article contains step-by-step instructions for setting up peering in Azure. See the `Using VPC peering `__ diff --git a/docs/tools/terraform/howto/vpc-peering-aws.rst b/docs/tools/terraform/howto/vpc-peering-aws.rst index 03d7db15ce..6cb84a70d4 100644 --- a/docs/tools/terraform/howto/vpc-peering-aws.rst +++ b/docs/tools/terraform/howto/vpc-peering-aws.rst @@ -1,5 +1,5 @@ -AWS virtual network peering -============================= +Set up AWS virtual network peering with Terraform +================================================== This help article provides step-by-step instructions for setting up a VPC peering connection between Aiven and Amazon Web Services Platform (AWS) using Terraform. See the `Using VPC peering `__ diff --git a/docs/tools/terraform/howto/vpc-peering-gcp.rst b/docs/tools/terraform/howto/vpc-peering-gcp.rst index 6489776e64..e76e59bbc9 100644 --- a/docs/tools/terraform/howto/vpc-peering-gcp.rst +++ b/docs/tools/terraform/howto/vpc-peering-gcp.rst @@ -1,5 +1,5 @@ -GCP virtual network peering -============================= +Set up Google Cloud Platform virtual network peering with Terraform +==================================================================== This help article provides step-by-step instructions for setting up a VPC peering connection between Aiven and Google Cloud Platform (GCP) using Terraform. See the `Using VPC peering `__ diff --git a/docs/tools/terraform/list-upgrade-terraform.rst b/docs/tools/terraform/list-upgrade-terraform.rst new file mode 100644 index 0000000000..ef596cbd07 --- /dev/null +++ b/docs/tools/terraform/list-upgrade-terraform.rst @@ -0,0 +1,6 @@ +Upgrade Aiven Provider for Terraform +===================================== + +Guides for upgrading from different versions of Aiven Provider: + +.. tableofcontents:: \ No newline at end of file diff --git a/docs/tools/terraform/list-vpc-terraform.rst b/docs/tools/terraform/list-vpc-terraform.rst new file mode 100644 index 0000000000..7c5ff106f4 --- /dev/null +++ b/docs/tools/terraform/list-vpc-terraform.rst @@ -0,0 +1,6 @@ +Set up virtual network peering with Terraform +============================================== + +Instructions for setting up virtual network peering with Aiven Provider for Terraform: + +.. tableofcontents:: \ No newline at end of file diff --git a/docs/tools/terraform/reference.rst b/docs/tools/terraform/reference.rst index 12e2d0a61a..6bbd4b2b46 100644 --- a/docs/tools/terraform/reference.rst +++ b/docs/tools/terraform/reference.rst @@ -1,3 +1,5 @@ +:orphan: + Reference ========= diff --git a/docs/tools/terraform/reference/cookbook.rst b/docs/tools/terraform/reference/cookbook.rst index 00737c628a..b0330cdf88 100644 --- a/docs/tools/terraform/reference/cookbook.rst +++ b/docs/tools/terraform/reference/cookbook.rst @@ -1,12 +1,12 @@ -Aiven Terraform Cookbook +Aiven Terraform cookbook ======================== -Sometimes an example is easier to understand than a long tutorial or detailed configuration documentation. We've put together some of the most common terraform setups, and listed them here. Use them as they are, or combine them to cook up something new and tasty for your own needs. +Sometimes an example is easier to understand than a long tutorial or detailed configuration documentation. We've put together some of the most common Terraform setups. Use them as they are, or combine them to cook up something new and tasty for your own needs. Recipes ------- -Each "recipe" includes an architecture diagram and the terraform sample code you need to build the setup yourself. +Each recipe includes an architecture diagram and the terraform sample code you need to build the setup yourself. .. grid:: 1 3 3 3 From 9ac7a9f75cb6b965017fc6d9851aaa8f60e6b543 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 23 Aug 2023 17:35:45 +0200 Subject: [PATCH 4/8] Fix TOC errors --- docs/tools/terraform/concepts.rst | 2 -- docs/tools/terraform/howto.rst | 2 -- docs/tools/terraform/reference.rst | 2 -- 3 files changed, 6 deletions(-) diff --git a/docs/tools/terraform/concepts.rst b/docs/tools/terraform/concepts.rst index 0b753b088e..a233a26767 100644 --- a/docs/tools/terraform/concepts.rst +++ b/docs/tools/terraform/concepts.rst @@ -4,5 +4,3 @@ Understanding the Aiven Terraform provider ========================================== In this section you can learn more about the concepts used with the Aiven Terraform provider. - -.. tableofcontents:: diff --git a/docs/tools/terraform/howto.rst b/docs/tools/terraform/howto.rst index 056dda9179..8671dac9b9 100644 --- a/docs/tools/terraform/howto.rst +++ b/docs/tools/terraform/howto.rst @@ -4,5 +4,3 @@ HowTo ===== A collection of helpful guides for performing tasks with Aiven Terraform Provider. - -.. tableofcontents:: \ No newline at end of file diff --git a/docs/tools/terraform/reference.rst b/docs/tools/terraform/reference.rst index 6bbd4b2b46..6fbf48d2b9 100644 --- a/docs/tools/terraform/reference.rst +++ b/docs/tools/terraform/reference.rst @@ -4,5 +4,3 @@ Reference ========= Aiven Terraform provider reference contents. - -.. tableofcontents:: \ No newline at end of file From c93db06dca0a291556417ab26de6511626586d5c Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 23 Aug 2023 17:36:01 +0200 Subject: [PATCH 5/8] Fix TOC errors --- _toc.yml | 2 +- docs/tools/terraform/concepts.rst | 2 +- docs/tools/terraform/howto.rst | 2 +- docs/tools/terraform/reference.rst | 3 ++- docs/tools/terraform/reference/cookbook.rst | 2 +- 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/_toc.yml b/_toc.yml index 4848de1a80..877439619a 100644 --- a/_toc.yml +++ b/_toc.yml @@ -274,7 +274,7 @@ entries: - file: docs/tools/terraform/howto/vpc-peering-gcp title: Set up Google Cloud Platform virtual network peering - file: docs/tools/terraform/reference/cookbook - title: Terraform cookbook + title: Terraform Cookbook entries: - file: docs/tools/terraform/reference/cookbook/kafka-connect-terraform-recipe title: Apache Kafka and OpenSearch diff --git a/docs/tools/terraform/concepts.rst b/docs/tools/terraform/concepts.rst index a233a26767..d9ea572092 100644 --- a/docs/tools/terraform/concepts.rst +++ b/docs/tools/terraform/concepts.rst @@ -3,4 +3,4 @@ Understanding the Aiven Terraform provider ========================================== -In this section you can learn more about the concepts used with the Aiven Terraform provider. +:doc:`Data sources in Terraform ` \ No newline at end of file diff --git a/docs/tools/terraform/howto.rst b/docs/tools/terraform/howto.rst index 8671dac9b9..35c4c20372 100644 --- a/docs/tools/terraform/howto.rst +++ b/docs/tools/terraform/howto.rst @@ -3,4 +3,4 @@ HowTo ===== -A collection of helpful guides for performing tasks with Aiven Terraform Provider. +:doc:`Get started with Aiven Provider for Terraform ` \ No newline at end of file diff --git a/docs/tools/terraform/reference.rst b/docs/tools/terraform/reference.rst index 6fbf48d2b9..289e6f14b2 100644 --- a/docs/tools/terraform/reference.rst +++ b/docs/tools/terraform/reference.rst @@ -3,4 +3,5 @@ Reference ========= -Aiven Terraform provider reference contents. +:doc:`Aiven Terraform Cookbook ` +:doc:`Troubleshooting ` \ No newline at end of file diff --git a/docs/tools/terraform/reference/cookbook.rst b/docs/tools/terraform/reference/cookbook.rst index b0330cdf88..0a8e1d297d 100644 --- a/docs/tools/terraform/reference/cookbook.rst +++ b/docs/tools/terraform/reference/cookbook.rst @@ -1,4 +1,4 @@ -Aiven Terraform cookbook +Aiven Terraform Cookbook ======================== Sometimes an example is easier to understand than a long tutorial or detailed configuration documentation. We've put together some of the most common Terraform setups. Use them as they are, or combine them to cook up something new and tasty for your own needs. From 31499c249dc807948b884b917953b8146a14f82d Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 23 Aug 2023 17:46:29 +0200 Subject: [PATCH 6/8] Fix link --- docs/tools/terraform/concepts.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/terraform/concepts.rst b/docs/tools/terraform/concepts.rst index d9ea572092..634677c9dc 100644 --- a/docs/tools/terraform/concepts.rst +++ b/docs/tools/terraform/concepts.rst @@ -3,4 +3,4 @@ Understanding the Aiven Terraform provider ========================================== -:doc:`Data sources in Terraform ` \ No newline at end of file +:doc:`Data sources in Terraform ` \ No newline at end of file From e283a26b4e7a6a842cb12d4d3ef1cde066e80024 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Wed, 23 Aug 2023 19:48:50 +0200 Subject: [PATCH 7/8] fix step number --- docs/platform/howto/byoc/create-custom-cloud.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/howto/byoc/create-custom-cloud.rst b/docs/platform/howto/byoc/create-custom-cloud.rst index a706afce6a..4711859c7a 100644 --- a/docs/platform/howto/byoc/create-custom-cloud.rst +++ b/docs/platform/howto/byoc/create-custom-cloud.rst @@ -78,7 +78,7 @@ In the **Create custom cloud** workflow, proceed as follows: **BYOC standard** is the only option supported currently. -1. Select **Next**. +2. Select **Next**. .. topic:: Result From dcfc046c464f9d9a66ac7b35e269df70718c126f Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Thu, 24 Aug 2023 09:26:54 +0200 Subject: [PATCH 8/8] fix the title --- .../kafka/kafka-connect/howto/mqtt-source-connector.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/products/kafka/kafka-connect/howto/mqtt-source-connector.rst b/docs/products/kafka/kafka-connect/howto/mqtt-source-connector.rst index a01767fc81..a090a2f585 100644 --- a/docs/products/kafka/kafka-connect/howto/mqtt-source-connector.rst +++ b/docs/products/kafka/kafka-connect/howto/mqtt-source-connector.rst @@ -1,5 +1,5 @@ -Create a source connector from Apache Kafka® to MQTT -======================================================= +Create a source connector from MQTT to Apache Kafka® +==================================================== The `MQTT source connector `_ copies messages from the MQTT topic into Apache Kafka® where they can be transformed and read by multiple consumers. Then, the Stream Reactor MQTT source connector creates a queue and binds it to the ``amq.topic`` defined in the KCQL statement, then messages are copied to the Apache Kafka® service.