index.html 78 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../../provider/fortanix/">
  7. <link rel="next" href="../anchore-engine-credentials/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
  10. <title>FluxCD - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.6543a935.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#gitops-using-fluxcd-v2" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. FluxCD
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  64. <label class="md-header__button md-icon" for="__search">
  65. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  74. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item md-tabs__item--active">
  131. <a href="./" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. </ul>
  146. </div>
  147. </nav>
  148. <main class="md-main" data-md-component="main">
  149. <div class="md-main__inner md-grid">
  150. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  151. <div class="md-sidebar__scrollwrap">
  152. <div class="md-sidebar__inner">
  153. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  154. <label class="md-nav__title" for="__drawer">
  155. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  156. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  157. </a>
  158. External Secrets Operator
  159. </label>
  160. <div class="md-nav__source">
  161. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  162. <div class="md-source__icon md-icon">
  163. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  164. </div>
  165. <div class="md-source__repository">
  166. External Secrets Operator
  167. </div>
  168. </a>
  169. </div>
  170. <ul class="md-nav__list" data-md-scrollfix>
  171. <li class="md-nav__item md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  173. <div class="md-nav__link md-nav__container">
  174. <a href="../.." class="md-nav__link ">
  175. <span class="md-ellipsis">
  176. Introduction
  177. </span>
  178. </a>
  179. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  180. <span class="md-nav__icon md-icon"></span>
  181. </label>
  182. </div>
  183. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  184. <label class="md-nav__title" for="__nav_1">
  185. <span class="md-nav__icon md-icon"></span>
  186. Introduction
  187. </label>
  188. <ul class="md-nav__list" data-md-scrollfix>
  189. <li class="md-nav__item">
  190. <a href="../../introduction/overview/" class="md-nav__link">
  191. <span class="md-ellipsis">
  192. Overview
  193. </span>
  194. </a>
  195. </li>
  196. <li class="md-nav__item">
  197. <a href="../../introduction/getting-started/" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. Getting started
  200. </span>
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="../../introduction/faq/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. FAQ
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../introduction/stability-support/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Stability and Support
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Deprecation Policy
  221. </span>
  222. </a>
  223. </li>
  224. </ul>
  225. </nav>
  226. </li>
  227. <li class="md-nav__item md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  229. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  230. <span class="md-ellipsis">
  231. API
  232. </span>
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  236. <label class="md-nav__title" for="__nav_2">
  237. <span class="md-nav__icon md-icon"></span>
  238. API
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../../api/components/" class="md-nav__link">
  243. <span class="md-ellipsis">
  244. Components
  245. </span>
  246. </a>
  247. </li>
  248. <li class="md-nav__item md-nav__item--nested">
  249. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  250. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  251. <span class="md-ellipsis">
  252. Core Resources
  253. </span>
  254. <span class="md-nav__icon md-icon"></span>
  255. </label>
  256. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  257. <label class="md-nav__title" for="__nav_2_2">
  258. <span class="md-nav__icon md-icon"></span>
  259. Core Resources
  260. </label>
  261. <ul class="md-nav__list" data-md-scrollfix>
  262. <li class="md-nav__item">
  263. <a href="../../api/externalsecret/" class="md-nav__link">
  264. <span class="md-ellipsis">
  265. ExternalSecret
  266. </span>
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="../../api/secretstore/" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. SecretStore
  273. </span>
  274. </a>
  275. </li>
  276. <li class="md-nav__item">
  277. <a href="../../api/clustersecretstore/" class="md-nav__link">
  278. <span class="md-ellipsis">
  279. ClusterSecretStore
  280. </span>
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  285. <span class="md-ellipsis">
  286. ClusterExternalSecret
  287. </span>
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="../../api/pushsecret/" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. PushSecret
  294. </span>
  295. </a>
  296. </li>
  297. </ul>
  298. </nav>
  299. </li>
  300. <li class="md-nav__item md-nav__item--nested">
  301. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  302. <div class="md-nav__link md-nav__container">
  303. <a href="../../api/generator/" class="md-nav__link ">
  304. <span class="md-ellipsis">
  305. Generators
  306. </span>
  307. </a>
  308. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. </div>
  312. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  313. <label class="md-nav__title" for="__nav_2_3">
  314. <span class="md-nav__icon md-icon"></span>
  315. Generators
  316. </label>
  317. <ul class="md-nav__list" data-md-scrollfix>
  318. <li class="md-nav__item">
  319. <a href="../../api/generator/acr/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. Azure Container Registry
  322. </span>
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../../api/generator/ecr/" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. AWS Elastic Container Registry
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/generator/gcr/" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. Google Container Registry
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="../../api/generator/vault/" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. Vault Dynamic Secret
  343. </span>
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../../api/generator/password/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Password
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../../api/generator/fake/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. Fake
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../../api/generator/webhook/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. Webhook
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../../api/generator/github/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Github
  371. </span>
  372. </a>
  373. </li>
  374. </ul>
  375. </nav>
  376. </li>
  377. <li class="md-nav__item md-nav__item--nested">
  378. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  379. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  380. <span class="md-ellipsis">
  381. Reference Docs
  382. </span>
  383. <span class="md-nav__icon md-icon"></span>
  384. </label>
  385. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  386. <label class="md-nav__title" for="__nav_2_4">
  387. <span class="md-nav__icon md-icon"></span>
  388. Reference Docs
  389. </label>
  390. <ul class="md-nav__list" data-md-scrollfix>
  391. <li class="md-nav__item">
  392. <a href="../../api/spec/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. API specification
  395. </span>
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../../api/controller-options/" class="md-nav__link">
  400. <span class="md-ellipsis">
  401. Controller Options
  402. </span>
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../api/metrics/" class="md-nav__link">
  407. <span class="md-ellipsis">
  408. Metrics
  409. </span>
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. <li class="md-nav__item md-nav__item--nested">
  419. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  420. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  421. <span class="md-ellipsis">
  422. Guides
  423. </span>
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  427. <label class="md-nav__title" for="__nav_3">
  428. <span class="md-nav__icon md-icon"></span>
  429. Guides
  430. </label>
  431. <ul class="md-nav__list" data-md-scrollfix>
  432. <li class="md-nav__item">
  433. <a href="../../guides/introduction/" class="md-nav__link">
  434. <span class="md-ellipsis">
  435. Introduction
  436. </span>
  437. </a>
  438. </li>
  439. <li class="md-nav__item md-nav__item--nested">
  440. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  441. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  442. <span class="md-ellipsis">
  443. External Secrets
  444. </span>
  445. <span class="md-nav__icon md-icon"></span>
  446. </label>
  447. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  448. <label class="md-nav__title" for="__nav_3_2">
  449. <span class="md-nav__icon md-icon"></span>
  450. External Secrets
  451. </label>
  452. <ul class="md-nav__list" data-md-scrollfix>
  453. <li class="md-nav__item">
  454. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  455. <span class="md-ellipsis">
  456. Extract structured data
  457. </span>
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../../guides/getallsecrets/" class="md-nav__link">
  462. <span class="md-ellipsis">
  463. Find Secrets by Name or Metadata
  464. </span>
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. Rewriting Keys
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item md-nav__item--nested">
  475. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  476. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  477. <span class="md-ellipsis">
  478. Advanced Templating
  479. </span>
  480. <span class="md-nav__icon md-icon"></span>
  481. </label>
  482. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  483. <label class="md-nav__title" for="__nav_3_2_4">
  484. <span class="md-nav__icon md-icon"></span>
  485. Advanced Templating
  486. </label>
  487. <ul class="md-nav__list" data-md-scrollfix>
  488. <li class="md-nav__item">
  489. <a href="../../guides/templating/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. v2
  492. </span>
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../guides/templating-v1/" class="md-nav__link">
  497. <span class="md-ellipsis">
  498. v1
  499. </span>
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  507. <span class="md-ellipsis">
  508. Kubernetes Secret Types
  509. </span>
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  514. <span class="md-ellipsis">
  515. Lifecycle: ownership & deletion
  516. </span>
  517. </a>
  518. </li>
  519. <li class="md-nav__item">
  520. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  521. <span class="md-ellipsis">
  522. Decoding Strategies
  523. </span>
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../../guides/controller-class/" class="md-nav__link">
  528. <span class="md-ellipsis">
  529. Controller Classes
  530. </span>
  531. </a>
  532. </li>
  533. </ul>
  534. </nav>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../../guides/generator/" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Generators
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../guides/pushsecrets/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Push Secrets
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item md-nav__item--nested">
  551. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  552. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  553. <span class="md-ellipsis">
  554. Operations
  555. </span>
  556. <span class="md-nav__icon md-icon"></span>
  557. </label>
  558. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  559. <label class="md-nav__title" for="__nav_3_5">
  560. <span class="md-nav__icon md-icon"></span>
  561. Operations
  562. </label>
  563. <ul class="md-nav__list" data-md-scrollfix>
  564. <li class="md-nav__item">
  565. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  566. <span class="md-ellipsis">
  567. Multi Tenancy
  568. </span>
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../../guides/security-best-practices/" class="md-nav__link">
  573. <span class="md-ellipsis">
  574. Security Best Practices
  575. </span>
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../guides/threat-model/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. Threat Model
  582. </span>
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../guides/v1beta1/" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. Upgrading to v1beta1
  589. </span>
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../guides/using-latest-image/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. Using Latest Image
  596. </span>
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  601. <span class="md-ellipsis">
  602. Disable Cluster Features
  603. </span>
  604. </a>
  605. </li>
  606. </ul>
  607. </nav>
  608. </li>
  609. </ul>
  610. </nav>
  611. </li>
  612. <li class="md-nav__item md-nav__item--nested">
  613. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  614. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  615. <span class="md-ellipsis">
  616. Provider
  617. </span>
  618. <span class="md-nav__icon md-icon"></span>
  619. </label>
  620. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  621. <label class="md-nav__title" for="__nav_4">
  622. <span class="md-nav__icon md-icon"></span>
  623. Provider
  624. </label>
  625. <ul class="md-nav__list" data-md-scrollfix>
  626. <li class="md-nav__item">
  627. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. AWS Secrets Manager
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. AWS Parameter Store
  637. </span>
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. Azure Key Vault
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../provider/chef/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. Chef
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../provider/conjur/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. CyberArk Conjur
  658. </span>
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  663. <span class="md-ellipsis">
  664. Google Cloud Secret Manager
  665. </span>
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. HashiCorp Vault
  672. </span>
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../provider/kubernetes/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. Kubernetes
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. IBM Secrets Manager
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../provider/akeyless/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Akeyless
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Yandex Certificate Manager
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. Yandex Lockbox
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/alibaba/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Alibaba Cloud
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. GitLab Variables
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/oracle-vault/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. Oracle Vault
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/1password-automation/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. 1Password Secrets Automation
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/webhook/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Webhook
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/fake/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Fake
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. senhasegura DevOps Secrets Management (DSM)
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/doppler/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. Doppler
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/keeper-security/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Keeper Security
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/cloak/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Cloak End 2 End Encrypted Secrets
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/scaleway/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Scaleway
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/delinea/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. Delinea
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/passbolt/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Passbolt
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../provider/pulumi/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. Pulumi ESC
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../provider/onboardbase/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Onboardbase
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../../provider-passworddepot/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Password Depot
  819. </span>
  820. </a>
  821. </li>
  822. <li class="md-nav__item">
  823. <a href="../../provider/fortanix/" class="md-nav__link">
  824. <span class="md-ellipsis">
  825. Fortanix
  826. </span>
  827. </a>
  828. </li>
  829. </ul>
  830. </nav>
  831. </li>
  832. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  833. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
  834. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
  835. <span class="md-ellipsis">
  836. Examples
  837. </span>
  838. <span class="md-nav__icon md-icon"></span>
  839. </label>
  840. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
  841. <label class="md-nav__title" for="__nav_5">
  842. <span class="md-nav__icon md-icon"></span>
  843. Examples
  844. </label>
  845. <ul class="md-nav__list" data-md-scrollfix>
  846. <li class="md-nav__item md-nav__item--active">
  847. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  848. <label class="md-nav__link md-nav__link--active" for="__toc">
  849. <span class="md-ellipsis">
  850. FluxCD
  851. </span>
  852. <span class="md-nav__icon md-icon"></span>
  853. </label>
  854. <a href="./" class="md-nav__link md-nav__link--active">
  855. <span class="md-ellipsis">
  856. FluxCD
  857. </span>
  858. </a>
  859. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  860. <label class="md-nav__title" for="__toc">
  861. <span class="md-nav__icon md-icon"></span>
  862. Table of contents
  863. </label>
  864. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  865. <li class="md-nav__item">
  866. <a href="#advantages" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. Advantages
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="#the-approach" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. The approach
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="#the-problem" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. The problem
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="#the-solution" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. The solution
  890. </span>
  891. </a>
  892. </li>
  893. <li class="md-nav__item">
  894. <a href="#create-the-main-kustomization" class="md-nav__link">
  895. <span class="md-ellipsis">
  896. Create the main kustomization
  897. </span>
  898. </a>
  899. </li>
  900. <li class="md-nav__item">
  901. <a href="#create-the-secret" class="md-nav__link">
  902. <span class="md-ellipsis">
  903. Create the secret
  904. </span>
  905. </a>
  906. </li>
  907. <li class="md-nav__item">
  908. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  909. <span class="md-ellipsis">
  910. Creating the references to repositories
  911. </span>
  912. </a>
  913. </li>
  914. <li class="md-nav__item">
  915. <a href="#deploy-the-crds" class="md-nav__link">
  916. <span class="md-ellipsis">
  917. Deploy the CRDs
  918. </span>
  919. </a>
  920. </li>
  921. <li class="md-nav__item">
  922. <a href="#deploy-the-operator" class="md-nav__link">
  923. <span class="md-ellipsis">
  924. Deploy the operator
  925. </span>
  926. </a>
  927. </li>
  928. <li class="md-nav__item">
  929. <a href="#deploy-the-crs" class="md-nav__link">
  930. <span class="md-ellipsis">
  931. Deploy the CRs
  932. </span>
  933. </a>
  934. </li>
  935. <li class="md-nav__item">
  936. <a href="#results" class="md-nav__link">
  937. <span class="md-ellipsis">
  938. Results
  939. </span>
  940. </a>
  941. </li>
  942. </ul>
  943. </nav>
  944. </li>
  945. <li class="md-nav__item">
  946. <a href="../anchore-engine-credentials/" class="md-nav__link">
  947. <span class="md-ellipsis">
  948. Anchore Engine
  949. </span>
  950. </a>
  951. </li>
  952. <li class="md-nav__item">
  953. <a href="../jenkins-kubernetes-credentials/" class="md-nav__link">
  954. <span class="md-ellipsis">
  955. Jenkins
  956. </span>
  957. </a>
  958. </li>
  959. <li class="md-nav__item">
  960. <a href="../bitwarden/" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. BitWarden
  963. </span>
  964. </a>
  965. </li>
  966. </ul>
  967. </nav>
  968. </li>
  969. <li class="md-nav__item md-nav__item--nested">
  970. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  971. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  972. <span class="md-ellipsis">
  973. Community
  974. </span>
  975. <span class="md-nav__icon md-icon"></span>
  976. </label>
  977. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  978. <label class="md-nav__title" for="__nav_6">
  979. <span class="md-nav__icon md-icon"></span>
  980. Community
  981. </label>
  982. <ul class="md-nav__list" data-md-scrollfix>
  983. <li class="md-nav__item md-nav__item--nested">
  984. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  985. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  986. <span class="md-ellipsis">
  987. Contributing
  988. </span>
  989. <span class="md-nav__icon md-icon"></span>
  990. </label>
  991. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  992. <label class="md-nav__title" for="__nav_6_1">
  993. <span class="md-nav__icon md-icon"></span>
  994. Contributing
  995. </label>
  996. <ul class="md-nav__list" data-md-scrollfix>
  997. <li class="md-nav__item">
  998. <a href="../../contributing/devguide/" class="md-nav__link">
  999. <span class="md-ellipsis">
  1000. Developer guide
  1001. </span>
  1002. </a>
  1003. </li>
  1004. <li class="md-nav__item">
  1005. <a href="../../contributing/process/" class="md-nav__link">
  1006. <span class="md-ellipsis">
  1007. Contributing Process
  1008. </span>
  1009. </a>
  1010. </li>
  1011. <li class="md-nav__item">
  1012. <a href="../../contributing/release/" class="md-nav__link">
  1013. <span class="md-ellipsis">
  1014. Release Process
  1015. </span>
  1016. </a>
  1017. </li>
  1018. <li class="md-nav__item">
  1019. <a href="../../contributing/coc/" class="md-nav__link">
  1020. <span class="md-ellipsis">
  1021. Code of Conduct
  1022. </span>
  1023. </a>
  1024. </li>
  1025. <li class="md-nav__item">
  1026. <a href="../../contributing/roadmap/" class="md-nav__link">
  1027. <span class="md-ellipsis">
  1028. Roadmap
  1029. </span>
  1030. </a>
  1031. </li>
  1032. </ul>
  1033. </nav>
  1034. </li>
  1035. <li class="md-nav__item md-nav__item--nested">
  1036. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1037. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1038. <span class="md-ellipsis">
  1039. External Resources
  1040. </span>
  1041. <span class="md-nav__icon md-icon"></span>
  1042. </label>
  1043. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1044. <label class="md-nav__title" for="__nav_6_2">
  1045. <span class="md-nav__icon md-icon"></span>
  1046. External Resources
  1047. </label>
  1048. <ul class="md-nav__list" data-md-scrollfix>
  1049. <li class="md-nav__item">
  1050. <a href="../../eso-talks/" class="md-nav__link">
  1051. <span class="md-ellipsis">
  1052. Talks
  1053. </span>
  1054. </a>
  1055. </li>
  1056. <li class="md-nav__item">
  1057. <a href="../../eso-demos/" class="md-nav__link">
  1058. <span class="md-ellipsis">
  1059. Demos
  1060. </span>
  1061. </a>
  1062. </li>
  1063. <li class="md-nav__item">
  1064. <a href="../../eso-blogs/" class="md-nav__link">
  1065. <span class="md-ellipsis">
  1066. Blogs
  1067. </span>
  1068. </a>
  1069. </li>
  1070. </ul>
  1071. </nav>
  1072. </li>
  1073. </ul>
  1074. </nav>
  1075. </li>
  1076. <li class="md-nav__item md-nav__item--nested">
  1077. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1078. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1079. <span class="md-ellipsis">
  1080. References
  1081. </span>
  1082. <span class="md-nav__icon md-icon"></span>
  1083. </label>
  1084. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1085. <label class="md-nav__title" for="__nav_7">
  1086. <span class="md-nav__icon md-icon"></span>
  1087. References
  1088. </label>
  1089. <ul class="md-nav__list" data-md-scrollfix>
  1090. <li class="md-nav__item">
  1091. <a href="../../spec/" class="md-nav__link">
  1092. <span class="md-ellipsis">
  1093. API specification
  1094. </span>
  1095. </a>
  1096. </li>
  1097. </ul>
  1098. </nav>
  1099. </li>
  1100. </ul>
  1101. </nav>
  1102. </div>
  1103. </div>
  1104. </div>
  1105. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1106. <div class="md-sidebar__scrollwrap">
  1107. <div class="md-sidebar__inner">
  1108. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1109. <label class="md-nav__title" for="__toc">
  1110. <span class="md-nav__icon md-icon"></span>
  1111. Table of contents
  1112. </label>
  1113. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1114. <li class="md-nav__item">
  1115. <a href="#advantages" class="md-nav__link">
  1116. <span class="md-ellipsis">
  1117. Advantages
  1118. </span>
  1119. </a>
  1120. </li>
  1121. <li class="md-nav__item">
  1122. <a href="#the-approach" class="md-nav__link">
  1123. <span class="md-ellipsis">
  1124. The approach
  1125. </span>
  1126. </a>
  1127. </li>
  1128. <li class="md-nav__item">
  1129. <a href="#the-problem" class="md-nav__link">
  1130. <span class="md-ellipsis">
  1131. The problem
  1132. </span>
  1133. </a>
  1134. </li>
  1135. <li class="md-nav__item">
  1136. <a href="#the-solution" class="md-nav__link">
  1137. <span class="md-ellipsis">
  1138. The solution
  1139. </span>
  1140. </a>
  1141. </li>
  1142. <li class="md-nav__item">
  1143. <a href="#create-the-main-kustomization" class="md-nav__link">
  1144. <span class="md-ellipsis">
  1145. Create the main kustomization
  1146. </span>
  1147. </a>
  1148. </li>
  1149. <li class="md-nav__item">
  1150. <a href="#create-the-secret" class="md-nav__link">
  1151. <span class="md-ellipsis">
  1152. Create the secret
  1153. </span>
  1154. </a>
  1155. </li>
  1156. <li class="md-nav__item">
  1157. <a href="#creating-the-references-to-repositories" class="md-nav__link">
  1158. <span class="md-ellipsis">
  1159. Creating the references to repositories
  1160. </span>
  1161. </a>
  1162. </li>
  1163. <li class="md-nav__item">
  1164. <a href="#deploy-the-crds" class="md-nav__link">
  1165. <span class="md-ellipsis">
  1166. Deploy the CRDs
  1167. </span>
  1168. </a>
  1169. </li>
  1170. <li class="md-nav__item">
  1171. <a href="#deploy-the-operator" class="md-nav__link">
  1172. <span class="md-ellipsis">
  1173. Deploy the operator
  1174. </span>
  1175. </a>
  1176. </li>
  1177. <li class="md-nav__item">
  1178. <a href="#deploy-the-crs" class="md-nav__link">
  1179. <span class="md-ellipsis">
  1180. Deploy the CRs
  1181. </span>
  1182. </a>
  1183. </li>
  1184. <li class="md-nav__item">
  1185. <a href="#results" class="md-nav__link">
  1186. <span class="md-ellipsis">
  1187. Results
  1188. </span>
  1189. </a>
  1190. </li>
  1191. </ul>
  1192. </nav>
  1193. </div>
  1194. </div>
  1195. </div>
  1196. <div class="md-content" data-md-component="content">
  1197. <article class="md-content__inner md-typeset">
  1198. <h1 id="gitops-using-fluxcd-v2">GitOps using FluxCD (v2)</h1>
  1199. <p>FluxCD is a GitOps operator for Kubernetes. It synchronizes the status of the cluster from manifests allocated in
  1200. different repositories (Git or Helm). This approach fits perfectly with External Secrets on clusters which are dynamically
  1201. created, to get credentials with no manual intervention from the beginning.</p>
  1202. <h2 id="advantages">Advantages</h2>
  1203. <p>This approach has several advantages as follows:</p>
  1204. <ul>
  1205. <li><strong>Homogenize environments</strong> allowing developers to use the same toolset in Kind in the same way they do in the cloud
  1206. provider distributions such as EKS or GKE. This accelerates the development</li>
  1207. <li><strong>Reduce security risks</strong>, because credentials can be easily obtained, so temptation to store them locally is reduced.</li>
  1208. <li><strong>Application compatibility increase</strong>: Applications are deployed in different ways, and sometimes they need to share
  1209. credentials. This can be done using External Secrets as a wire for them at real time.</li>
  1210. <li><strong>Automation by default</strong> oh, come on!</li>
  1211. </ul>
  1212. <h2 id="the-approach">The approach</h2>
  1213. <p>FluxCD is composed by several controllers dedicated to manage different custom resources. The most important
  1214. ones are <strong>Kustomization</strong> (to clarify, Flux one, not Kubernetes' one) and <strong>HelmRelease</strong> to deploy using the approaches
  1215. of the same names.</p>
  1216. <p>External Secrets can be deployed using Helm <a href="../../introduction/getting-started/">as explained here</a>. The deployment includes the
  1217. CRDs if enabled on the <code>values.yaml</code>, but after this, you need to deploy some <code>SecretStore</code> to start
  1218. getting credentials from your secrets manager with External Secrets.</p>
  1219. <blockquote>
  1220. <p>The idea of this guide is to deploy the whole stack, using flux, needed by developers not to worry about the credentials,
  1221. but only about the application and its code.</p>
  1222. </blockquote>
  1223. <h2 id="the-problem">The problem</h2>
  1224. <p>This can sound easy, but External Secrets is deployed using Helm, which is managed by the HelmController,
  1225. and your custom resources, for example a <code>ClusterSecretStore</code> and the related <code>Secret</code>, are often deployed using a
  1226. <code>kustomization.yaml</code>, which is deployed by the KustomizeController.</p>
  1227. <p>Both controllers manage the resources independently, at different moments, with no possibility to wait each other.
  1228. This means that we have a wonderful race condition where sometimes the CRs (<code>SecretStore</code>,<code>ClusterSecretStore</code>...) tries
  1229. to be deployed before than the CRDs needed to recognize them.</p>
  1230. <h2 id="the-solution">The solution</h2>
  1231. <p>Let's see the conditions to start working on a solution:</p>
  1232. <ul>
  1233. <li>The External Secrets operator is deployed with Helm, and admits disabling the CRDs deployment</li>
  1234. <li>The race condition only affects the deployment of <code>CustomResourceDefinition</code> and the CRs needed later</li>
  1235. <li>CRDs can be deployed directly from the Git repository of the project using a Flux <code>Kustomization</code></li>
  1236. <li>Required CRs can be deployed using a Flux <code>Kustomization</code> too, allowing dependency between CRDs and CRs</li>
  1237. <li>All previous manifests can be applied with a Kubernetes <code>kustomization</code></li>
  1238. </ul>
  1239. <h2 id="create-the-main-kustomization">Create the main kustomization</h2>
  1240. <p>To have a better view of things needed later, the first manifest to be created is the <code>kustomization.yaml</code></p>
  1241. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kustomize.config.k8s.io/v1beta1</span>
  1242. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span>
  1243. <span class="nt">resources</span><span class="p">:</span>
  1244. <span class="c1"># Deploy the Vault access secret</span>
  1245. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">namespace.yaml</span>
  1246. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-token.yaml</span>
  1247. <span class="c1"># Deploy the repositories</span>
  1248. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">repositories.yaml</span>
  1249. <span class="c1"># Deploy the CRDs</span>
  1250. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment-crds.yaml</span>
  1251. <span class="c1"># Deploy the operator</span>
  1252. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment.yaml</span>
  1253. <span class="c1"># Deploy default Custom Resources from &#39;crs&#39; directory</span>
  1254. <span class="c1"># INFO: This depends on the CRDs deployment. Will happen after it</span>
  1255. <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">deployment-crs.yaml</span>
  1256. </code></pre></div>
  1257. <h2 id="create-the-secret">Create the secret</h2>
  1258. <p>To access your secret manager, External Secrets needs some credentials. They are stored inside a Secret, which is intended
  1259. to be deployed by automation as a good practise. This time, a placeholder called <code>secret-token.yaml</code> is show as an example:</p>
  1260. <div class="highlight"><pre><span></span><code><span class="c1"># The namespace.yaml first</span>
  1261. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1262. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Namespace</span>
  1263. <span class="nt">metadata</span><span class="p">:</span>
  1264. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1265. </code></pre></div>
  1266. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1267. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1268. <span class="nt">metadata</span><span class="p">:</span>
  1269. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault-token-global</span>
  1270. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1271. <span class="nt">stringData</span><span class="p">:</span>
  1272. <span class="w"> </span><span class="c1"># This token must be patched by overlays. Not here for security reasons</span>
  1273. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">change-me-placeholder</span>
  1274. </code></pre></div>
  1275. <h2 id="creating-the-references-to-repositories">Creating the references to repositories</h2>
  1276. <p>Create a manifest called <code>repositories.yaml</code> to store the references to external repositories for Flux</p>
  1277. <div class="highlight"><pre><span></span><code><span class="c1"># Reference to Helm repository</span>
  1278. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source.toolkit.fluxcd.io/v1beta1</span>
  1279. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HelmRepository</span>
  1280. <span class="nt">metadata</span><span class="p">:</span>
  1281. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1282. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span>
  1283. <span class="nt">spec</span><span class="p">:</span>
  1284. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span>
  1285. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://charts.external-secrets.io</span>
  1286. <span class="nn">---</span>
  1287. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source.toolkit.fluxcd.io/v1beta1</span>
  1288. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GitRepository</span>
  1289. <span class="nt">metadata</span><span class="p">:</span>
  1290. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1291. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span>
  1292. <span class="nt">spec</span><span class="p">:</span>
  1293. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span>
  1294. <span class="w"> </span><span class="nt">ref</span><span class="p">:</span>
  1295. <span class="w"> </span><span class="nt">branch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
  1296. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://github.com/external-secrets/external-secrets</span>
  1297. </code></pre></div>
  1298. <h2 id="deploy-the-crds">Deploy the CRDs</h2>
  1299. <p>As mentioned, CRDs can be deployed using the official Helm package, but to solve the race condition, they will be deployed
  1300. from our git repository using a Kustomization manifest called <code>deployment-crds.yaml</code> as follows:</p>
  1301. <div class="highlight"><pre><span></span><code><span class="nn">---</span>
  1302. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kustomize.toolkit.fluxcd.io/v1beta2</span>
  1303. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span>
  1304. <span class="nt">metadata</span><span class="p">:</span>
  1305. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets-crds</span>
  1306. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span>
  1307. <span class="nt">spec</span><span class="p">:</span>
  1308. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span>
  1309. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./deploy/crds</span>
  1310. <span class="w"> </span><span class="nt">prune</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
  1311. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1312. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GitRepository</span>
  1313. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1314. </code></pre></div>
  1315. <h2 id="deploy-the-operator">Deploy the operator</h2>
  1316. <p>The operator is deployed using a HelmRelease manifest to deploy the Helm package, but due to the special race condition,
  1317. the deployment must be disabled in the <code>values</code> of the manifest called <code>deployment.yaml</code>, as follows:</p>
  1318. <div class="highlight"><pre><span></span><code><span class="c1"># How to manage values files. Ref: https://fluxcd.io/docs/guides/helmreleases/#refer-to-values-inside-the-chart</span>
  1319. <span class="c1"># How to inject values: https://fluxcd.io/docs/guides/helmreleases/#cloud-storage</span>
  1320. <span class="nn">---</span>
  1321. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">helm.toolkit.fluxcd.io/v2beta1</span>
  1322. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HelmRelease</span>
  1323. <span class="nt">metadata</span><span class="p">:</span>
  1324. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1325. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span>
  1326. <span class="nt">spec</span><span class="p">:</span>
  1327. <span class="w"> </span><span class="c1"># Override Release name to avoid the pattern Namespace-Release</span>
  1328. <span class="w"> </span><span class="c1"># Ref: https://fluxcd.io/docs/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.HelmRelease</span>
  1329. <span class="w"> </span><span class="nt">releaseName</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1330. <span class="w"> </span><span class="nt">targetNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1331. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span>
  1332. <span class="w"> </span><span class="nt">chart</span><span class="p">:</span>
  1333. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1334. <span class="w"> </span><span class="nt">chart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1335. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0.9.4</span>
  1336. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1337. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HelmRepository</span>
  1338. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1339. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span>
  1340. <span class="w"> </span><span class="nt">values</span><span class="p">:</span>
  1341. <span class="w"> </span><span class="nt">installCRDs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
  1342. <span class="w"> </span><span class="c1"># Ref: https://fluxcd.io/docs/components/helm/api/#helm.toolkit.fluxcd.io/v2beta1.Install</span>
  1343. <span class="w"> </span><span class="nt">install</span><span class="p">:</span>
  1344. <span class="w"> </span><span class="nt">createNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
  1345. </code></pre></div>
  1346. <h2 id="deploy-the-crs">Deploy the CRs</h2>
  1347. <p>Now, be ready for the arcane magic. Create a Kustomization manifest called <code>deployment-crs.yaml</code> with the following content:</p>
  1348. <div class="highlight"><pre><span></span><code><span class="nn">---</span>
  1349. <span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kustomize.toolkit.fluxcd.io/v1beta2</span>
  1350. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Kustomization</span>
  1351. <span class="nt">metadata</span><span class="p">:</span>
  1352. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets-crs</span>
  1353. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span>
  1354. <span class="nt">spec</span><span class="p">:</span>
  1355. <span class="w"> </span><span class="nt">dependsOn</span><span class="p">:</span>
  1356. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets-crds</span>
  1357. <span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10m</span>
  1358. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./infrastructure/external-secrets/crs</span>
  1359. <span class="w"> </span><span class="nt">prune</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
  1360. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1361. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GitRepository</span>
  1362. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span>
  1363. </code></pre></div>
  1364. <p>There are several interesting details to see here, that finally solves the race condition:</p>
  1365. <ol>
  1366. <li>First one is the field <code>dependsOn</code>, which points to a previous Kustomization called <code>external-secrets-crds</code>. This
  1367. dependency forces this deployment to wait for the other to be ready, before start being deployed.</li>
  1368. <li>The reference to the place where to find the CRs
  1369. <div class="highlight"><pre><span></span><code><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./infrastructure/external-secrets/crs</span>
  1370. <span class="nt">sourceRef</span><span class="p">:</span>
  1371. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GitRepository</span>
  1372. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">flux-system</span>
  1373. </code></pre></div>
  1374. Custom Resources will be searched in the relative path <code>./infrastructure/external-secrets/crs</code> of the GitRepository
  1375. called <code>flux-system</code>, which is a reference to the same repository that FluxCD watches to synchronize the cluster.
  1376. With fewer words, a reference to itself, but going to another directory called <code>crs</code></li>
  1377. </ol>
  1378. <p>Of course, allocate inside the mentioned path <code>./infrastructure/external-secrets/crs</code>, all the desired CRs to be deployed,
  1379. for example, a manifest <code>clusterSecretStore.yaml</code> to reach your Hashicorp Vault as follows:</p>
  1380. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1381. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1382. <span class="nt">metadata</span><span class="p">:</span>
  1383. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vault-backend-global</span>
  1384. <span class="nt">spec</span><span class="p">:</span>
  1385. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1386. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1387. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.your-domain.com&quot;</span>
  1388. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret</span>
  1389. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2</span>
  1390. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1391. <span class="w"> </span><span class="c1"># points to a secret that contains a vault token</span>
  1392. <span class="w"> </span><span class="c1"># https://www.vaultproject.io/docs/auth/token</span>
  1393. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span>
  1394. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token-global&quot;</span>
  1395. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;token&quot;</span>
  1396. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets</span>
  1397. </code></pre></div>
  1398. <h2 id="results">Results</h2>
  1399. <p>At the end, the required files tree is shown in the following picture:</p>
  1400. <p><img alt="FluxCD files tree" src="../../pictures/screenshot_gitops_final_directory_tree.png" /></p>
  1401. </article>
  1402. </div>
  1403. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1404. </div>
  1405. </main>
  1406. <footer class="md-footer">
  1407. <div class="md-footer-meta md-typeset">
  1408. <div class="md-footer-meta__inner md-grid">
  1409. <div class="md-copyright">
  1410. <div class="md-copyright__highlight">
  1411. &copy; 2024 The external-secrets Authors.<br/>
  1412. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1413. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1414. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1415. </div>
  1416. Made with
  1417. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1418. Material for MkDocs
  1419. </a>
  1420. </div>
  1421. </div>
  1422. </div>
  1423. </footer>
  1424. </div>
  1425. <div class="md-dialog" data-md-component="dialog">
  1426. <div class="md-dialog__inner md-typeset"></div>
  1427. </div>
  1428. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1429. <script src="../../assets/javascripts/bundle.081f42fc.min.js"></script>
  1430. </body>
  1431. </html>