index.html 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552
  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="../../examples/bitwarden/">
  7. <link rel="next" href="../process/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.44">
  10. <title>Developer guide - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.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="#getting-started" 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. Developer guide
  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">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item md-tabs__item--active">
  147. <a href="./" 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/sts/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. AWS STS Session Token
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/gcr/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Google Container Registry
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/vault/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Vault Dynamic Secret
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/password/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. Password
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/fake/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Fake
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/webhook/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Webhook
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/github/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Github
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../api/generator/uuid/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. UUID
  391. </span>
  392. </a>
  393. </li>
  394. </ul>
  395. </nav>
  396. </li>
  397. <li class="md-nav__item md-nav__item--nested">
  398. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  399. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  400. <span class="md-ellipsis">
  401. Reference Docs
  402. </span>
  403. <span class="md-nav__icon md-icon"></span>
  404. </label>
  405. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  406. <label class="md-nav__title" for="__nav_2_4">
  407. <span class="md-nav__icon md-icon"></span>
  408. Reference Docs
  409. </label>
  410. <ul class="md-nav__list" data-md-scrollfix>
  411. <li class="md-nav__item">
  412. <a href="../../api/spec/" class="md-nav__link">
  413. <span class="md-ellipsis">
  414. API specification
  415. </span>
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../api/controller-options/" class="md-nav__link">
  420. <span class="md-ellipsis">
  421. Controller Options
  422. </span>
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../api/metrics/" class="md-nav__link">
  427. <span class="md-ellipsis">
  428. Metrics
  429. </span>
  430. </a>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. <li class="md-nav__item md-nav__item--nested">
  439. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  440. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  441. <span class="md-ellipsis">
  442. Guides
  443. </span>
  444. <span class="md-nav__icon md-icon"></span>
  445. </label>
  446. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  447. <label class="md-nav__title" for="__nav_3">
  448. <span class="md-nav__icon md-icon"></span>
  449. Guides
  450. </label>
  451. <ul class="md-nav__list" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="../../guides/introduction/" class="md-nav__link">
  454. <span class="md-ellipsis">
  455. Introduction
  456. </span>
  457. </a>
  458. </li>
  459. <li class="md-nav__item md-nav__item--nested">
  460. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  461. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  462. <span class="md-ellipsis">
  463. External Secrets
  464. </span>
  465. <span class="md-nav__icon md-icon"></span>
  466. </label>
  467. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  468. <label class="md-nav__title" for="__nav_3_2">
  469. <span class="md-nav__icon md-icon"></span>
  470. External Secrets
  471. </label>
  472. <ul class="md-nav__list" data-md-scrollfix>
  473. <li class="md-nav__item">
  474. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  475. <span class="md-ellipsis">
  476. Extract structured data
  477. </span>
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../guides/getallsecrets/" class="md-nav__link">
  482. <span class="md-ellipsis">
  483. Find Secrets by Name or Metadata
  484. </span>
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  489. <span class="md-ellipsis">
  490. Rewriting Keys
  491. </span>
  492. </a>
  493. </li>
  494. <li class="md-nav__item md-nav__item--nested">
  495. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  496. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  497. <span class="md-ellipsis">
  498. Advanced Templating
  499. </span>
  500. <span class="md-nav__icon md-icon"></span>
  501. </label>
  502. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  503. <label class="md-nav__title" for="__nav_3_2_4">
  504. <span class="md-nav__icon md-icon"></span>
  505. Advanced Templating
  506. </label>
  507. <ul class="md-nav__list" data-md-scrollfix>
  508. <li class="md-nav__item">
  509. <a href="../../guides/templating/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. v2
  512. </span>
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../guides/templating-v1/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. v1
  519. </span>
  520. </a>
  521. </li>
  522. </ul>
  523. </nav>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  527. <span class="md-ellipsis">
  528. Kubernetes Secret Types
  529. </span>
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  534. <span class="md-ellipsis">
  535. Lifecycle: ownership & deletion
  536. </span>
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Decoding Strategies
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../guides/controller-class/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Controller Classes
  550. </span>
  551. </a>
  552. </li>
  553. </ul>
  554. </nav>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../../guides/generator/" class="md-nav__link">
  558. <span class="md-ellipsis">
  559. Generators
  560. </span>
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../../guides/pushsecrets/" class="md-nav__link">
  565. <span class="md-ellipsis">
  566. Push Secrets
  567. </span>
  568. </a>
  569. </li>
  570. <li class="md-nav__item md-nav__item--nested">
  571. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  572. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  573. <span class="md-ellipsis">
  574. Operations
  575. </span>
  576. <span class="md-nav__icon md-icon"></span>
  577. </label>
  578. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  579. <label class="md-nav__title" for="__nav_3_5">
  580. <span class="md-nav__icon md-icon"></span>
  581. Operations
  582. </label>
  583. <ul class="md-nav__list" data-md-scrollfix>
  584. <li class="md-nav__item">
  585. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  586. <span class="md-ellipsis">
  587. Multi Tenancy
  588. </span>
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../../guides/security-best-practices/" class="md-nav__link">
  593. <span class="md-ellipsis">
  594. Security Best Practices
  595. </span>
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../../guides/threat-model/" class="md-nav__link">
  600. <span class="md-ellipsis">
  601. Threat Model
  602. </span>
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../guides/v1beta1/" class="md-nav__link">
  607. <span class="md-ellipsis">
  608. Upgrading to v1beta1
  609. </span>
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../guides/using-latest-image/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. Using Latest Image
  616. </span>
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Disable Cluster Features
  623. </span>
  624. </a>
  625. </li>
  626. </ul>
  627. </nav>
  628. </li>
  629. </ul>
  630. </nav>
  631. </li>
  632. <li class="md-nav__item md-nav__item--nested">
  633. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  634. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  635. <span class="md-ellipsis">
  636. Provider
  637. </span>
  638. <span class="md-nav__icon md-icon"></span>
  639. </label>
  640. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  641. <label class="md-nav__title" for="__nav_4">
  642. <span class="md-nav__icon md-icon"></span>
  643. Provider
  644. </label>
  645. <ul class="md-nav__list" data-md-scrollfix>
  646. <li class="md-nav__item">
  647. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  648. <span class="md-ellipsis">
  649. AWS Secrets Manager
  650. </span>
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  655. <span class="md-ellipsis">
  656. AWS Parameter Store
  657. </span>
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  662. <span class="md-ellipsis">
  663. Azure Key Vault
  664. </span>
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="../../provider/beyondtrust/" class="md-nav__link">
  669. <span class="md-ellipsis">
  670. BeyondTrust
  671. </span>
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  676. <span class="md-ellipsis">
  677. Bitwarden Secrets Manager
  678. </span>
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../../provider/chef/" class="md-nav__link">
  683. <span class="md-ellipsis">
  684. Chef
  685. </span>
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="../../provider/conjur/" class="md-nav__link">
  690. <span class="md-ellipsis">
  691. CyberArk Conjur
  692. </span>
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="../../provider/device42/" class="md-nav__link">
  697. <span class="md-ellipsis">
  698. Device42
  699. </span>
  700. </a>
  701. </li>
  702. <li class="md-nav__item">
  703. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  704. <span class="md-ellipsis">
  705. Google Cloud Secret Manager
  706. </span>
  707. </a>
  708. </li>
  709. <li class="md-nav__item">
  710. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  711. <span class="md-ellipsis">
  712. HashiCorp Vault
  713. </span>
  714. </a>
  715. </li>
  716. <li class="md-nav__item">
  717. <a href="../../provider/kubernetes/" class="md-nav__link">
  718. <span class="md-ellipsis">
  719. Kubernetes
  720. </span>
  721. </a>
  722. </li>
  723. <li class="md-nav__item">
  724. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  725. <span class="md-ellipsis">
  726. IBM Secrets Manager
  727. </span>
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="../../provider/akeyless/" class="md-nav__link">
  732. <span class="md-ellipsis">
  733. Akeyless
  734. </span>
  735. </a>
  736. </li>
  737. <li class="md-nav__item">
  738. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  739. <span class="md-ellipsis">
  740. Yandex Certificate Manager
  741. </span>
  742. </a>
  743. </li>
  744. <li class="md-nav__item">
  745. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  746. <span class="md-ellipsis">
  747. Yandex Lockbox
  748. </span>
  749. </a>
  750. </li>
  751. <li class="md-nav__item">
  752. <a href="../../provider/alibaba/" class="md-nav__link">
  753. <span class="md-ellipsis">
  754. Alibaba Cloud
  755. </span>
  756. </a>
  757. </li>
  758. <li class="md-nav__item">
  759. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  760. <span class="md-ellipsis">
  761. GitLab Variables
  762. </span>
  763. </a>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="../../provider/oracle-vault/" class="md-nav__link">
  767. <span class="md-ellipsis">
  768. Oracle Vault
  769. </span>
  770. </a>
  771. </li>
  772. <li class="md-nav__item">
  773. <a href="../../provider/1password-automation/" class="md-nav__link">
  774. <span class="md-ellipsis">
  775. 1Password Secrets Automation
  776. </span>
  777. </a>
  778. </li>
  779. <li class="md-nav__item">
  780. <a href="../../provider/webhook/" class="md-nav__link">
  781. <span class="md-ellipsis">
  782. Webhook
  783. </span>
  784. </a>
  785. </li>
  786. <li class="md-nav__item">
  787. <a href="../../provider/fake/" class="md-nav__link">
  788. <span class="md-ellipsis">
  789. Fake
  790. </span>
  791. </a>
  792. </li>
  793. <li class="md-nav__item">
  794. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  795. <span class="md-ellipsis">
  796. senhasegura DevOps Secrets Management (DSM)
  797. </span>
  798. </a>
  799. </li>
  800. <li class="md-nav__item">
  801. <a href="../../provider/doppler/" class="md-nav__link">
  802. <span class="md-ellipsis">
  803. Doppler
  804. </span>
  805. </a>
  806. </li>
  807. <li class="md-nav__item">
  808. <a href="../../provider/keeper-security/" class="md-nav__link">
  809. <span class="md-ellipsis">
  810. Keeper Security
  811. </span>
  812. </a>
  813. </li>
  814. <li class="md-nav__item">
  815. <a href="../../provider/cloak/" class="md-nav__link">
  816. <span class="md-ellipsis">
  817. Cloak End 2 End Encrypted Secrets
  818. </span>
  819. </a>
  820. </li>
  821. <li class="md-nav__item">
  822. <a href="../../provider/scaleway/" class="md-nav__link">
  823. <span class="md-ellipsis">
  824. Scaleway
  825. </span>
  826. </a>
  827. </li>
  828. <li class="md-nav__item">
  829. <a href="../../provider/delinea/" class="md-nav__link">
  830. <span class="md-ellipsis">
  831. Delinea
  832. </span>
  833. </a>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="../../provider/secretserver/" class="md-nav__link">
  837. <span class="md-ellipsis">
  838. Secret Server
  839. </span>
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="../../provider/passbolt/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. Passbolt
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="../../provider/pulumi/" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. Pulumi ESC
  853. </span>
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="../../provider/onboardbase/" class="md-nav__link">
  858. <span class="md-ellipsis">
  859. Onboardbase
  860. </span>
  861. </a>
  862. </li>
  863. <li class="md-nav__item">
  864. <a href="../../provider-passworddepot/" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. Password Depot
  867. </span>
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="../../provider/fortanix/" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. Fortanix
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="../../provider/infisical/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. Infisical
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../../provider/previder/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. Previder
  888. </span>
  889. </a>
  890. </li>
  891. </ul>
  892. </nav>
  893. </li>
  894. <li class="md-nav__item md-nav__item--nested">
  895. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  896. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  897. <span class="md-ellipsis">
  898. Examples
  899. </span>
  900. <span class="md-nav__icon md-icon"></span>
  901. </label>
  902. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  903. <label class="md-nav__title" for="__nav_5">
  904. <span class="md-nav__icon md-icon"></span>
  905. Examples
  906. </label>
  907. <ul class="md-nav__list" data-md-scrollfix>
  908. <li class="md-nav__item">
  909. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  910. <span class="md-ellipsis">
  911. FluxCD
  912. </span>
  913. </a>
  914. </li>
  915. <li class="md-nav__item">
  916. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  917. <span class="md-ellipsis">
  918. Anchore Engine
  919. </span>
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  924. <span class="md-ellipsis">
  925. Jenkins
  926. </span>
  927. </a>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../../examples/bitwarden/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. BitWarden
  933. </span>
  934. </a>
  935. </li>
  936. </ul>
  937. </nav>
  938. </li>
  939. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  940. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
  941. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  942. <span class="md-ellipsis">
  943. Community
  944. </span>
  945. <span class="md-nav__icon md-icon"></span>
  946. </label>
  947. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
  948. <label class="md-nav__title" for="__nav_6">
  949. <span class="md-nav__icon md-icon"></span>
  950. Community
  951. </label>
  952. <ul class="md-nav__list" data-md-scrollfix>
  953. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  954. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
  955. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  956. <span class="md-ellipsis">
  957. Contributing
  958. </span>
  959. <span class="md-nav__icon md-icon"></span>
  960. </label>
  961. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
  962. <label class="md-nav__title" for="__nav_6_1">
  963. <span class="md-nav__icon md-icon"></span>
  964. Contributing
  965. </label>
  966. <ul class="md-nav__list" data-md-scrollfix>
  967. <li class="md-nav__item md-nav__item--active">
  968. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  969. <label class="md-nav__link md-nav__link--active" for="__toc">
  970. <span class="md-ellipsis">
  971. Developer guide
  972. </span>
  973. <span class="md-nav__icon md-icon"></span>
  974. </label>
  975. <a href="./" class="md-nav__link md-nav__link--active">
  976. <span class="md-ellipsis">
  977. Developer guide
  978. </span>
  979. </a>
  980. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  981. <label class="md-nav__title" for="__toc">
  982. <span class="md-nav__icon md-icon"></span>
  983. Table of contents
  984. </label>
  985. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  986. <li class="md-nav__item">
  987. <a href="#getting-started" class="md-nav__link">
  988. <span class="md-ellipsis">
  989. Getting Started
  990. </span>
  991. </a>
  992. </li>
  993. <li class="md-nav__item">
  994. <a href="#building-testing" class="md-nav__link">
  995. <span class="md-ellipsis">
  996. Building &amp; Testing
  997. </span>
  998. </a>
  999. </li>
  1000. <li class="md-nav__item">
  1001. <a href="#using-tilt" class="md-nav__link">
  1002. <span class="md-ellipsis">
  1003. Using Tilt
  1004. </span>
  1005. </a>
  1006. </li>
  1007. <li class="md-nav__item">
  1008. <a href="#installing" class="md-nav__link">
  1009. <span class="md-ellipsis">
  1010. Installing
  1011. </span>
  1012. </a>
  1013. </li>
  1014. <li class="md-nav__item">
  1015. <a href="#documentation" class="md-nav__link">
  1016. <span class="md-ellipsis">
  1017. Documentation
  1018. </span>
  1019. </a>
  1020. </li>
  1021. </ul>
  1022. </nav>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../process/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Contributing Process
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../release/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Release Process
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="../coc/" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Code of Conduct
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="../roadmap/" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Roadmap
  1049. </span>
  1050. </a>
  1051. </li>
  1052. </ul>
  1053. </nav>
  1054. </li>
  1055. <li class="md-nav__item md-nav__item--nested">
  1056. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1057. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1058. <span class="md-ellipsis">
  1059. External Resources
  1060. </span>
  1061. <span class="md-nav__icon md-icon"></span>
  1062. </label>
  1063. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1064. <label class="md-nav__title" for="__nav_6_2">
  1065. <span class="md-nav__icon md-icon"></span>
  1066. External Resources
  1067. </label>
  1068. <ul class="md-nav__list" data-md-scrollfix>
  1069. <li class="md-nav__item">
  1070. <a href="../../eso-talks/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Talks
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="../../eso-demos/" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Demos
  1080. </span>
  1081. </a>
  1082. </li>
  1083. <li class="md-nav__item">
  1084. <a href="../../eso-blogs/" class="md-nav__link">
  1085. <span class="md-ellipsis">
  1086. Blogs
  1087. </span>
  1088. </a>
  1089. </li>
  1090. <li class="md-nav__item">
  1091. <a href="../../eso-tools/" class="md-nav__link">
  1092. <span class="md-ellipsis">
  1093. Tools
  1094. </span>
  1095. </a>
  1096. </li>
  1097. </ul>
  1098. </nav>
  1099. </li>
  1100. </ul>
  1101. </nav>
  1102. </li>
  1103. </ul>
  1104. </nav>
  1105. </div>
  1106. </div>
  1107. </div>
  1108. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1109. <div class="md-sidebar__scrollwrap">
  1110. <div class="md-sidebar__inner">
  1111. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1112. <label class="md-nav__title" for="__toc">
  1113. <span class="md-nav__icon md-icon"></span>
  1114. Table of contents
  1115. </label>
  1116. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1117. <li class="md-nav__item">
  1118. <a href="#getting-started" class="md-nav__link">
  1119. <span class="md-ellipsis">
  1120. Getting Started
  1121. </span>
  1122. </a>
  1123. </li>
  1124. <li class="md-nav__item">
  1125. <a href="#building-testing" class="md-nav__link">
  1126. <span class="md-ellipsis">
  1127. Building &amp; Testing
  1128. </span>
  1129. </a>
  1130. </li>
  1131. <li class="md-nav__item">
  1132. <a href="#using-tilt" class="md-nav__link">
  1133. <span class="md-ellipsis">
  1134. Using Tilt
  1135. </span>
  1136. </a>
  1137. </li>
  1138. <li class="md-nav__item">
  1139. <a href="#installing" class="md-nav__link">
  1140. <span class="md-ellipsis">
  1141. Installing
  1142. </span>
  1143. </a>
  1144. </li>
  1145. <li class="md-nav__item">
  1146. <a href="#documentation" class="md-nav__link">
  1147. <span class="md-ellipsis">
  1148. Documentation
  1149. </span>
  1150. </a>
  1151. </li>
  1152. </ul>
  1153. </nav>
  1154. </div>
  1155. </div>
  1156. </div>
  1157. <div class="md-content" data-md-component="content">
  1158. <article class="md-content__inner md-typeset">
  1159. <h1>Developer guide</h1>
  1160. <h2 id="getting-started">Getting Started</h2>
  1161. <p>You must have a working <a href="https://golang.org/doc/install">Go environment</a> and
  1162. then clone the repo:</p>
  1163. <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/external-secrets/external-secrets.git
  1164. <span class="nb">cd</span><span class="w"> </span>external-secrets
  1165. </code></pre></div>
  1166. <p><em>Note: many of the <code>make</code> commands use <a href="https://github.com/mikefarah/yq">yq</a>, version 4.2X.X or higher.</em></p>
  1167. <p>Our helm chart is tested using <code>helm-unittest</code>. You will need it to run tests locally if you modify the helm chart. Install it with the following command:</p>
  1168. <div class="highlight"><pre><span></span><code>$ helm plugin install https://github.com/helm-unittest/helm-unittest
  1169. </code></pre></div>
  1170. <h2 id="building-testing">Building &amp; Testing</h2>
  1171. <p>The project uses the <code>make</code> build system. It'll run code generators, tests and
  1172. static code analysis.</p>
  1173. <p>Building the operator binary and docker image:</p>
  1174. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>build
  1175. make<span class="w"> </span>docker.build<span class="w"> </span><span class="nv">IMAGE_NAME</span><span class="o">=</span>external-secrets<span class="w"> </span><span class="nv">IMAGE_TAG</span><span class="o">=</span>latest
  1176. </code></pre></div>
  1177. <p>Run tests and lint the code:
  1178. <div class="highlight"><pre><span></span><code>make<span class="w"> </span><span class="nb">test</span>
  1179. make<span class="w"> </span>lint<span class="w"> </span><span class="c1"># OR</span>
  1180. docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>-v<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>:/app<span class="w"> </span>-w<span class="w"> </span>/app<span class="w"> </span>golangci/golangci-lint:v1.49.0<span class="w"> </span>golangci-lint<span class="w"> </span>run
  1181. </code></pre></div></p>
  1182. <p>Build the documentation:
  1183. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs
  1184. </code></pre></div></p>
  1185. <h2 id="using-tilt">Using Tilt</h2>
  1186. <p><a href="https://tilt.dev">Tilt</a> can be used to develop external-secrets. Tilt will hot-reload changes to the code and replace
  1187. the running binary in the container using a process manager of its own.</p>
  1188. <p>To run tilt, download the utility for your operating system and run <code>make tilt-up</code>. This will do two things:
  1189. - downloads tilt for the current OS and ARCH under <code>bin/tilt</code>
  1190. - make manifest files of your current changes and place them under <code>./bin/deploy/manifests/external-secrets.yaml</code>
  1191. - run tilt with <code>tilt run</code></p>
  1192. <p>Hit <code>space</code> and you can observe all the pods starting up and track their output in the tilt UI.</p>
  1193. <h2 id="installing">Installing</h2>
  1194. <p>To install the External Secret Operator into a Kubernetes Cluster run:</p>
  1195. <div class="highlight"><pre><span></span><code>helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>external-secrets<span class="w"> </span>https://charts.external-secrets.io
  1196. helm<span class="w"> </span>repo<span class="w"> </span>update
  1197. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span>external-secrets/external-secrets
  1198. </code></pre></div>
  1199. <p>You can alternatively run the controller on your host system for development purposes:</p>
  1200. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>crds.install
  1201. make<span class="w"> </span>run
  1202. </code></pre></div>
  1203. <p>To remove the CRDs run:</p>
  1204. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>crds.uninstall
  1205. </code></pre></div>
  1206. <p>If you need to test some other k8s integrations and need the operator to be deployed to the actual cluster while developing, you can use the following workflow:</p>
  1207. <div class="highlight"><pre><span></span><code><span class="c1"># Start a local K8S cluster with KinD</span>
  1208. kind<span class="w"> </span>create<span class="w"> </span>cluster<span class="w"> </span>--name<span class="w"> </span>external-secrets
  1209. <span class="nb">export</span><span class="w"> </span><span class="nv">TAG</span><span class="o">=</span><span class="k">$(</span>make<span class="w"> </span>docker.tag<span class="k">)</span>
  1210. <span class="nb">export</span><span class="w"> </span><span class="nv">IMAGE</span><span class="o">=</span><span class="k">$(</span>make<span class="w"> </span>docker.imagename<span class="k">)</span>
  1211. <span class="c1"># Build docker image</span>
  1212. make<span class="w"> </span>docker.build
  1213. <span class="c1"># Load docker image into local kind cluster</span>
  1214. kind<span class="w"> </span>load<span class="w"> </span>docker-image<span class="w"> </span><span class="nv">$IMAGE</span>:<span class="nv">$TAG</span><span class="w"> </span>--name<span class="w"> </span>external-secrets
  1215. <span class="c1"># (Optional) Pull the image from GitHub Repo to copy into kind</span>
  1216. <span class="c1"># docker pull ghcr.io/external-secrets/external-secrets:v0.8.2</span>
  1217. <span class="c1"># kind load docker-image ghcr.io/external-secrets/external-secrets:v0.8.2 -n external-secrets</span>
  1218. <span class="c1"># export TAG=v0.8.2</span>
  1219. <span class="c1"># Update helm charts and install to KinD cluster</span>
  1220. make<span class="w"> </span>helm.generate
  1221. helm<span class="w"> </span>upgrade<span class="w"> </span>--install<span class="w"> </span>external-secrets<span class="w"> </span>./deploy/charts/external-secrets/<span class="w"> </span><span class="se">\</span>
  1222. --set<span class="w"> </span>image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>image.tag<span class="o">=</span><span class="nv">$TAG</span><span class="w"> </span><span class="se">\</span>
  1223. --set<span class="w"> </span>webhook.image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>webhook.image.tag<span class="o">=</span><span class="nv">$TAG</span><span class="w"> </span><span class="se">\</span>
  1224. --set<span class="w"> </span>certController.image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>certController.image.tag<span class="o">=</span><span class="nv">$TAG</span>
  1225. <span class="c1"># Command to delete the cluster when done</span>
  1226. <span class="c1"># kind delete cluster -n external-secrets</span>
  1227. </code></pre></div>
  1228. <div class="admonition note">
  1229. <p class="admonition-title">Contributing Flow</p>
  1230. <p>The HOW TO guide for contributing is at the <a href="../process/">Contributing Process</a> page.</p>
  1231. </div>
  1232. <h2 id="documentation">Documentation</h2>
  1233. <p>We use <a href="https://squidfunk.github.io/mkdocs-material/">mkdocs material</a> and <a href="https://github.com/jimporter/mike">mike</a> to generate this
  1234. documentation. See <code>/docs</code> for the source code and <code>/hack/api-docs</code> for the build process.</p>
  1235. <p>When writing documentation it is advised to run the mkdocs server with livereload:</p>
  1236. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs.serve
  1237. </code></pre></div>
  1238. <p>Run the following command to run a complete build. The rendered assets are available under <code>/site</code>.</p>
  1239. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs
  1240. make<span class="w"> </span>docs.serve
  1241. </code></pre></div>
  1242. <p>Open <code>http://localhost:8000</code> in your browser.</p>
  1243. <p>Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local <code>gh-pages</code> branch.</p>
  1244. <p>When finished writing/reviewing the docs, clean up your local docs branch changes with <code>git branch -D gh-pages</code></p>
  1245. </article>
  1246. </div>
  1247. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1248. </div>
  1249. </main>
  1250. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1251. <footer class="md-footer">
  1252. <div class="md-footer-meta md-typeset">
  1253. <div class="md-footer-meta__inner md-grid">
  1254. <div class="md-copyright">
  1255. <div class="md-copyright__highlight">
  1256. &copy; 2024 The external-secrets Authors.<br/>
  1257. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1258. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1259. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1260. </div>
  1261. Made with
  1262. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1263. Material for MkDocs
  1264. </a>
  1265. </div>
  1266. </div>
  1267. </div>
  1268. </footer>
  1269. </div>
  1270. <div class="md-dialog" data-md-component="dialog">
  1271. <div class="md-dialog__inner md-typeset"></div>
  1272. </div>
  1273. <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>
  1274. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1275. </body>
  1276. </html>