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