index.html 81 KB

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