From 9db4d711a0fdf039b6de9b0f7ca673aa4a1be96b Mon Sep 17 00:00:00 2001 From: Keiran S Date: Sat, 13 Oct 2018 21:09:07 +1100 Subject: [PATCH] Add Route53 component documentation (#6439) * Add Route53 component documentation * :pencil2: Tweaks * Update 'ha_release' --- source/_components/route53.markdown | 103 +++++++++++++++++++++ source/images/supported_brands/route53.png | Bin 0 -> 10158 bytes 2 files changed, 103 insertions(+) create mode 100644 source/_components/route53.markdown create mode 100644 source/images/supported_brands/route53.png diff --git a/source/_components/route53.markdown b/source/_components/route53.markdown new file mode 100644 index 00000000000..a00e5e708d0 --- /dev/null +++ b/source/_components/route53.markdown @@ -0,0 +1,103 @@ +--- +layout: page +title: "route53" +description: "Automatically update your AWS Route53 DNS records." +date: 2018-02-10 20:08 +sidebar: true +comments: false +sharing: true +footer: true +logo: route53.png +ha_category: Network +ha_release: "0.81" +--- + +With the `route53` component can you keep your AWS Route53 DNS records up to date. + +The component will run every hour, but can also be started manually by using the service `route53.update_records` under services. + +Please note that this platform uses the API from [ipify.org](https://www.ipify.org/) to set the public IP address. + +## {% linkable_title Setup %} + +You will need to configure your AWS Account with a suitable IAM policy and API keys for this to function. + +If you are familiar with this process, you can skip the next section and head directly to the configuration section. + +On the AWS side, you need to do the following; + +1. Create a suitable zone for a domain that you own and manage in Route53, the domain `home.yourdomain.com` is used as an example. + +2. Once created, write down the Hosted Zone ID value for the domain. This is needed for the plugin and IAM configuration. + +3. Create an IAM Policy that provides update and query access to this domain explicitly and has no other permissions to the AWS account. + +Here is an IAM Policy sample, don't forget to update your Zone ID on the Resource line. + +``` +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "VisualEditor0", + "Effect": "Allow", + "Action": [ + "route53:GetHostedZone", + "route53:ChangeResourceRecordSets", + "route53:ListResourceRecordSets" + ], + "Resource": "arn:aws:route53:::hostedzone/YOURZONEIDGOESHERE" + }, + { + "Sid": "VisualEditor1", + "Effect": "Allow", + "Action": "route53:TestDNSAnswer", + "Resource": "*" + } + ] +} +``` + +4. Once this has been done, create a new user called `homeassistant` and add the IAM policy to the user, allowing it to manage this DNS resource. + +5. Under the security credentials tab for the `homeassistant` user, create a set of access keys for placement in the component definition YAML. + +## {% linkable_title Configuration %} + +To use the component in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +route53: + aws_access_key_id: ABC123 + aws_secret_access_key: DEF456 + zone: ZONEID678 + domain: home.yourdomain.com + records: + - vpn + - hassio + - home +``` + +{% configuration route53 %} +aws_access_key_id: + description: The AWS access key ID for the account that has IAM access to the domain. + required: true + type: string +aws_secret_access_key: + description: The AWS secret access key for the account that has IAM access to the domain. + required: true + type: string +zone: + description: The AWS zone ID for the domain in Route53. + required: true + type: string +domain: + description: The domain name for the domain in Route53. + required: true + type: string +records: + description: A list of records you want to update. + required: true + type: list +{% endconfiguration %} diff --git a/source/images/supported_brands/route53.png b/source/images/supported_brands/route53.png new file mode 100644 index 0000000000000000000000000000000000000000..07f3e8018dbbe135ddb10efcba87808add702777 GIT binary patch literal 10158 zcmeHtbxd8s7bcYA?k*2^cP$TlNO9=HwNTuPLkm3I-6<{wio4503k8Z>ad-E9zx`)7 z*<`bSY&N^e-eht!Gk4~kduGm=?>m_YbyWpSG%_?eI5a|0zc$bW(fz!B%>%R zt?gxel7s9=D0kQGANBgeHtmatBioBK-HsZr86EU360P7Jsz82ucn}IJ3RjUdoDC4= zeb6^Bj`YAgT5xp*v&8mLJTc z#TpRiNXiNvxmp>*0_Lw}K!QOmo$!K%d^8OLF>OGkc^Ip##`( zv5Da73`<2evuaK-Tv5L@kM>p;Z_{W4-f&Xk;$5vsP_sKI z4+F!Zmd}RYG`5RDH@dQ9*YcJAbA%pgk$UTH8L$p_Y)%AEOVRA|z``IPlh69Te?$5q zEtb96-}qk_b^j#AGM)8Qd_Mj!yA-=9R(gY)<7H=ZVdVPrmBl2~vC?s}Lu#UAp$@nF zGMw(S0z3PNpWQCDDZkw^kKb4>k1y88BgZvRKZHBgYWz<;en>Hq|z>j^B7T$9ZDft9dHoyCJm|z8}bP(+~gFc1m%P ziFouNm`Oj-wh_df+Sv3fG$d#MLIpRUKPIGmD>EId1w;$K>|xpHt)D&aX+R7aQe(&* z>1LgtJ-qhR(8JXH3pdMRy=mKs=zf@YC#aI>j+WuDc`HqCRx>_*@*OnV8_X-ZksguM z2E^jF^Pf*cBk0-#!RK>D0fh1%9UKKe4}?@m4V9?q$szH)QSD?|E@_QY7XwB?1gv_o ztOM{=7W|;)DC*U`8uL@TBx8=r0J=JZi!Zn2fQ$ic(xgscW%8~XMvgX*2VSn^snSUn zY+N{OocXs@0M%;Rwb3&hz6nd%dib#}u)#&o419n_NXzn($;M@#`B#f_V}el`F#8(= z*;!|g*>ngV=rJ&o!Hx|ef+ zfx+SRBA3nZrrczNxnbOq2?+v%0KL2Y>KLf-xQUf ztBkPhO(Z6v1(hc?WNPlKR?9%ZT6SOhpHJW8zYfLf3(_u_lm13T^T;&#K3nArf8d0XnSwkxYI6o&D<&R}2 zapjTdq~7+v|5jXAGrBqO%~Sg#S-jhwVKxQrdbqCK%{EOcUbBRyiUt~Os3Z~z-EuW3AjFf$j-xwYj zCW=e3m>BaUS&8-2cNw~+9GoY(>#jn9L6V2;s=6&SJ&U4TYCA4%q!q?t?=ypDjI`lQrZTH@Z#ab=B%IC+0+rSaao^Bxj2fyLQ7yDm^ zjW#8LK$RF7a_fvlPhUJ(jpN~m)^m6XzDXAyt?>FVmNzU&%DJ=P z%~lPh$7@bWI0<#{Z$<&Fu$UFH6kRa!NHWq7#k%+X{NgTl@b&AnBYw8T`i0{v7d_`* z-wbJRU^=|d$CR2J@Z`Xqd5e9&6}CLC7Hwjg099+vSa+<-BQZd4q=)_mWgFXRWxvHj zP6ADM?&EG|xD)D`u*f`l&KeK50CZwIa)2q)XvwE8i!UAqyv8Hc)R%jyh*t9$e@51d zJ|CsZ1>S9Z^EUg<*k#CAXP0pPFUTzCl9y3qRhdlU%;tH&&@az8@p|PPfN*BXJWlRn z(l5;bom=Z{m>&r~`W(K>n0O=$C=re3Hl4aJUAGHNvVjj3wA`d?Pr23&U&v1BP*Q1h zrvL4SGuG1_Uy}|yU{3CjA?vyrB3)ZodApEkY!0&7exXWbRFz0*VcU~4-TSR#(l~8< zev4l?Ec^oTsd&HXcCxG=oH8hD1SCxj{DNb61eycH{DvL}*>*cbr7A~|5h`LaZ!odj z94x~OTnIwx)q@@k;&>U0ly6vd0J~McH~KQ@2L)DyAJ+V(Fs!{U3VA0^H`DZvyZBba! zM|!T>L*mB_ePYCY79`E+965)~)2Hb+LLD=5Xth3g^E5mqyRWl_N7j9wS52^&rz|2@GZ7BOz$#=TsNllfR;4g+DpS^juC&WwsM8=S-6mRb^jGOT8~S9zTQU9Yd78WS7F(MiAdF0=)(QDF)*h^u>!O(V~Q;Z&jj=#%B1(3t`Ua^cPzLnPaqUTwZs%2fxyMyM^W^Lo4X>SBteh^@v>--BBU` zWV8XT*@5x^-8%bWF}VT@{2@{P*+7ejlKNX^lR9mis2orz8Cj3WanrU9FtkS1i?cBLTRX18>G@U>%C zl03;H%`hM5%Ea@0BbE<&g(a}=`Y?r+{w_%sU;*4oih{1sgK&+Mf8h9mHlvY+pkxY) z=CPz&n%NW*y1pJGwi}sj12q9xCc-?(^bX+h z+Q@49y971PCIJFGbH9bufi@D#NPiL&j3pccr@b)D+i|-ZJ4Xawv0eU!)W-uEcFjus zF%Wl>8EvYmCZBGd%3|Gd^oVHIDjF%}CLfZ_q%0h9=k{0n5%PY#&9UKlXrj+!?9stf z09Rq-V({q_57W1cMe(tFreD$d>7?=8RgaP|3qiHR4`dig^8%=sk8baL({lgp-SXrY z_qC<^bUKVssS%tkL#<7pG|v#zVor@Dt$I4I!gTe?^j?M{8s}B3n$6m3jU6*ix)D%+ zJGJ;4%kb`7j~&BR5|w);GVhtcfbh1OFjk*F&#?~70gBX0@cjPtc)kC#?BvJQ?IQ6~ zAoEh-lTICUe8^W9wO&KB-plpaacduO%7NzTU|jTsKN#xH%(r)XX;@l)!M?HV4KP0h4w zIdgUxA1t=M<#E;QSMyH`6Rpt(-14y>$R)_JRNpvxbfVNrt}R%%XGDG7ZGHPMGOy#4 z_u@X;PsX`59D~58Y^3Eagr-T?Z%zda;50`sBQmMdkAkS~BYxP%u%YhP-n7 z+>a87@y-exE-{)bbL| zSHuq@gg1bB^1WEfrJMN#iEgJSZ|lv=s-te>dh_02Y*McQHqUjF)|@ZyOXDuT#z|&; zH_y}Lul+5xyRBZtbp4B8UOIC-_aF+&QtJ)cSz(b)0o*1(A0OV?t&o6Upd~u5FWhYv zK3b+#9aYrh>s>AzoWG-Pd@8odPo6`O(kN$+s%@NB#LiZglxZtoxbtr(la8vRdSmV< zDgOPd@ARU=lcayGx}*z=!p3Ihsg$WTqg2K?+P+dn&ij6%)Ui?mb~gQv^%1?}Z-e@> zJYw$U3T%U~|Y&p7JE{vSN zT$>Qr%1$jU`vT0%LV^$fG;m{;j%~>S4Tz3r+xEYGWuR?ar@DGH+VV|{Jw%{r&0(#%q?34Kih0s9rEfRz|xa zU!HNwZUs;+&nz(Euw=ADt}kgmSKugmQH?IX9cS8gSbu0}n!0!N>Ac~&nH&78oUXC% zN8B4Y`5f9E`1i|QwrHuR|L#FH$7QtmPw{#I6kf*NGt>yGXxw@v^=c1}dH>`Tk-2LV zq?vdX4^kxe+hZFnsc~vS&>oo;M7T*pqYYl9ATF!3zxsFlJ?E%qjvd_^n% zYaSq5%sTyFMH~`_)7$#+DMNv;k1TJSg3nQRqWdh`B0rxFRXv$~riN$#_7fJ>L*u*8N`-Il|DxL!Q~u<3fLQmqQG+JT#r@B7PYuqzqh zd{VTX6t+(?GNZw8qz(}dR+r};!ghEw>ow3aZnuWzD{zgXGF}H3G7P;}c0d3d4=aHc z0s|&9eVr-jViIz(lZ39Az zpxVX(7RFb>c1*bv-k?Y4wG~QIQbI++A80OcjLhlYmYY)}CSjgcdK7{V{}2jAcOv#R zlUv46I)R*pNo*R!a!cuqJhKD!Ot<8eEnxDXMM?%XSmp?m%8eguf8YvhI-~m)Tu)E? zRsE($^#R5T1UEUaC^wV`jResY*%Ya@UI2GWii(1w@vN9E+ORyv@T`SisppEv?sh_> zvcgc84qqkRYtb-Cf1cOv#etzx3C#J@M;8(dJU`VD>I|;~#|h{sr#W}5RVkG29hFv= zJ^F(#H`P>fNCJcJZkb34H;XZ6oJf|^D|u!c

i6yzJ)&rWKVg%R_dwtg+EiusLz4 z42QSWG(F5&=w0Of!8{qa5^9&IwE$Lw1vx7zM-Um@EGb>by;Ug z874qLsMNs*z74D87&~3vWn{TNjuwNRN{R(6btjQ3;MQ<^!7{?s{K6Z!R#pPrW1)zI z+-n3_7f)Z^8>=ohg`!`e)JNgvSR}+g4I4JH+*um0Hrjwi$WZl1_CVmpT;5&)!J>Gb za=wN%VpnWgi%8SsZfmGuqFV9OQ>bA@Uken5(J5Op7<%1tTpGFun8E{r>)9OX}rX%g^t5rPZzb?e)ohG9_wQ4=q9N z^mws;QtHjGHwf`)_Gfe8TLAR0en2($wo77Cl0n0ljiV!j3T+l@>byh-;%tq11Sk5h7R={Jr(5AyNigqi#{eMzrpfp1yj z-j~TNT77+etlDMYe*3@N%xg+>hPba@C1Qrd=N@;PH z*l)ai$)&|#s{MhbK;ZiJawlXrXMgy&9G^)wIhQVu!=P!H!7HxhW0vIAI3GGO=Sscx z^?oQb{Vw}|@;%qQnYN6p4Mnn18KQlmX2pM! z_%@1F@`dJf4pr1Bhmf6~0p`l;IQtn+Sj zz$?Qg)0J054#3+o4i9hl;lqb5XpF{~mYRf4lf51)hVWoQrX@6vTJ4K+u8!^bzh0S8 z481PD*2Qs%)Z4S$N{fqA=Z&tr`*oN96LT%+`?-49?^ySIgV*jMQp=P4m|vMG^?cqR zj!Q>NOWXGmJYP=Z#**r?JDwrpw(Go+<%}Ooex_#PycDmLnh5%#|c_)!pKgVF{#XKtAf!3x8dFB|<MW6wVT6llbD^7@L8JHa_Ds};OS&@FpAHBy=}n4#l6X1r1@OCoKgfo)hONgFSM*aQ_~KXh z>n6eRTIbWn5H*)>B?;v9^)+OEr50w_^l&iViL=9cmp>gHU90ZnhnG*r-jLg3ERbDd zEkTgK7Q9%Y^Y2UnSv@t$hob0EabBhVj_2oRFVRik+|1X>ETK59Y46;Z^|x0~6_w~@ z5I{zDW4c&*yn?}wxxLsb{YK!4uqZ2N53w}_FFMrmY^gCSZ6(T}*=`;yKj3nNDftJf z?d$zk90rQ*+fJIvg0krkoWOMrL2D%j|dt-^dmF2P6}XA0Ob6!bA;+PfrsR zr~spV2Cj5IAQAH5-QQV-XdweM2y5v)3ViI(+UHGH-tXt$$!Fzm*{u7XN!+TM_}>r` zyDG6Nr;+d@MQ-TVnj=n8M#YK~#DE|xz*zNg0sLr|uantk6e@g$|B0XV`c7*d8KS%w zEr^vBJ~xMzD!a2tzq%e-8T+QLmfQu{w+(Y$l(vo6{jM<6a0FcDmi;zb_i`=rQ>vJ_ zGW2arqB?48Di}erw#@I(28f7)Z~wM9!`rceYiL+gCJa{NF&NUZglwk@5MN`eIM9&Y zhxJ5RUSKDN#Z-Y@_sgxp)~L2Kv3rEh2jc>qYzI*Yj^_r`=NW8aA|R!EV_^5i3{IZ{ zwf_L*-geRsziAb86vfp=!}SsMIxP39BTnKLyxQiWhYKgN(XWS2!g)9hay?#ZWYZeC z|D)aMb5kV1nPxpHw@pAz%lDlF4?`teSOd)r8cnLg=fdZWN;Pm@%fte|yA_NrXr~^*zCxQpTvXbVuA(xs% z6^lPVaTyN4d`XE4g7XcxEq+h0h^&v1CfVQ|Z}=M+bygNIp#25U0;p}EFr)}G8cufU%ZeC1Sn8G@w_9b``K%-`C;L0*hFxj zPcl9sUx0NuNnib43o&OJ`Nj|s2yD^F5_ACn+t2!Iwh8u6Z{aj*JO9$6d+Wu^o_)ig zMn23U8Ith%Sk&`0dZ>pBUkP`_+0r10>Ky_CkKLgo#Xbh(6Hf?A}j>XEH=?e4PGxG+G4v_uK_^! zjiV@}j^_6j08HM#^mpN9A;LIGYSc%cmGnQb!3=Fx}oE9r05)~0Zc53s^eEMao1AxB_MkUwrK1#^K z2Ap>XT4ZsMyUY*VAMY#0PvXs(w~e=VPTf^}Xah*{qJg3whq8#R9*zKodmK_;S_X_- z-@8-$z`}w8`8X;V2~f=aoO@u6MPgWCc9c3btP+n)z4>yBH3w~zOO_MwQMTIO&2q{W zbRhHo-bjs2BPlD|Q=v#_?>wTcO}7(_glYaYqHcKXI_gl=eZS|{Xw&H!HED2j#7)Vk z5f+*K!kJ|&BQZdsq6Ij#6iNe$3s0MvB`O)Tv)p!@_zf{?g?xszlnY({Vn5}Vn;gm! zV0dIAi3uAm|J}(j9sb6-a4NR6_6intkXs2N*)}k{BHZNA5WsuvnhZFct0D)`8i|=Ycv_I#B;f==Vx}wg50nqDA8Ki;D%JuQiJww)Gc2rB$$aD*1QJruwAH0xm zm(_1FRWk~T3_eC3KNQ07-WK#G<}`HPMRX$efBNt6SO}ac@54%SeU#YA({{803z#>k zsVFbrEH8%5j+DXQjtUXWL$PW(9!(81Mti;^=+*C>7|}%cW_fobM3E0bX#c^YU}PHq zU}~rXo@7Y15@mc&+npH2nsdsvbo}#Fp~6lv;so{lP=MkZwMAw+-DIown%5R4zqr@A z=_PH&N?+q0z+4541i(p^&cz*25eZtLcEOrs*I<`^2TxMMGC#V*98xTl1Ee2KL`=CM z)I!0+vLdn}S~i#Gaaoi{&>FraKn_yWyMQLpDF_cDC4WsfrEO@mo3BH{p8zmb=5Zt$ z#xCO0;z8q^-PzC*{6X>%bp_ahg{1wJ?!3Is>F}2O$jjf?CC<1y#k zvh{|*CkjMpjPDdkUHy-Bp1=I>7;>Syd}}>3XGXPL_St}k9b&;xUQF_d5|c0#Kc1Qc z#v=4qsAz@Qoyl0P3=TwaTD})iLL3=mU2AqSQA!sf0t%LIXGn1}1rPGw)nV5X-N5#G z!`$>W@q{Zn(DF7@#i7-8N1aB2;OSv6&y9%tH%yh( zSxSqYVZW!Rr?E@+tKV}O&Shr(q1!eeeHg?%aPv{V{b&C&hlt^QR?O#z_+PP?C47}V zVaF`XIaNgVLSqNd*&MO9jmnrE{e>@>sj1u>PqPaHqDfkn!m@T> zP`|qXUNexb;mzS%2M+m$V^BgrL`JW&A* zGd7Htu_v%HPNdiHgTyGlBb#)1@tlAIOOok~KX3Fw#L3znpdSyjFnu`*wi$wt zsqjoIOR5gb_$q9af6X_O8GpgTj4S@D^PDPDdA8Ou`CySkS@i;dktZGV6F^W?< z7OeASX9q+XpQZ_>w9K@#fp_hb z_k2UmD8$`k7|c~wpD|ZETKuPvH7(kdP(KExBiR)&BdXhK>52=ZvCK+X(*Mt0;`-lx g`>d58M(?PF+vtfH>KYngckJL4fu=$K1?I~ukN^Mx literal 0 HcmV?d00001