index.html 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645
  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="next" href="introduction/overview/">
  7. <link rel="icon" href="pictures/eso-round-logo.svg">
  8. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.3">
  9. <title>Introduction - External Secrets Operator</title>
  10. <link rel="stylesheet" href="assets/stylesheets/main.d7758b05.min.css">
  11. <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  16. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#sponsored-by" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../.">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL("."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <img src="pictures/eso-round-logo.svg" alt="logo">
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Introduction
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <form class="md-header__option" data-md-component="palette">
  64. <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">
  65. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  66. <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>
  67. </label>
  68. <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">
  69. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  70. <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>
  71. </label>
  72. </form>
  73. <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>
  74. <label class="md-header__button md-icon" for="__search">
  75. <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>
  76. </label>
  77. <div class="md-search" data-md-component="search" role="dialog">
  78. <label class="md-search__overlay" for="__search"></label>
  79. <div class="md-search__inner" role="search">
  80. <form class="md-search__form" name="search">
  81. <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>
  82. <label class="md-search__icon md-icon" for="__search">
  83. <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>
  84. <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>
  85. </label>
  86. <nav class="md-search__options" aria-label="Search">
  87. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  88. <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>
  89. </button>
  90. </nav>
  91. </form>
  92. <div class="md-search__output">
  93. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  94. <div class="md-search-result" data-md-component="search-result">
  95. <div class="md-search-result__meta">
  96. Initializing search
  97. </div>
  98. <ol class="md-search-result__list" role="presentation"></ol>
  99. </div>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. <div class="md-header__source">
  105. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  106. <div class="md-source__icon md-icon">
  107. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  108. </div>
  109. <div class="md-source__repository">
  110. External Secrets Operator
  111. </div>
  112. </a>
  113. </div>
  114. </nav>
  115. </header>
  116. <div class="md-container" data-md-component="container">
  117. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  118. <div class="md-grid">
  119. <ul class="md-tabs__list">
  120. <li class="md-tabs__item md-tabs__item--active">
  121. <a href="." class="md-tabs__link">
  122. Introduction
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="api/components/" class="md-tabs__link">
  127. API
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="guides/introduction/" class="md-tabs__link">
  132. Guides
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="provider/aws-secrets-manager/" class="md-tabs__link">
  137. Provider
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="examples/gitops-using-fluxcd/" class="md-tabs__link">
  142. Examples
  143. </a>
  144. </li>
  145. <li class="md-tabs__item">
  146. <a href="contributing/devguide/" class="md-tabs__link">
  147. Community
  148. </a>
  149. </li>
  150. </ul>
  151. </div>
  152. </nav>
  153. <main class="md-main" data-md-component="main">
  154. <div class="md-main__inner md-grid">
  155. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  156. <div class="md-sidebar__scrollwrap">
  157. <div class="md-sidebar__inner">
  158. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  159. <label class="md-nav__title" for="__drawer">
  160. <a href="." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  161. <img src="pictures/eso-round-logo.svg" alt="logo">
  162. </a>
  163. External Secrets Operator
  164. </label>
  165. <div class="md-nav__source">
  166. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  167. <div class="md-source__icon md-icon">
  168. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  169. </div>
  170. <div class="md-source__repository">
  171. External Secrets Operator
  172. </div>
  173. </a>
  174. </div>
  175. <ul class="md-nav__list" data-md-scrollfix>
  176. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  177. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  178. <div class="md-nav__link md-nav__container">
  179. <a href="." class="md-nav__link md-nav__link--active">
  180. <span class="md-ellipsis">
  181. Introduction
  182. </span>
  183. </a>
  184. <label class="md-nav__link md-nav__link--active" for="__nav_1" id="__nav_1_label" tabindex="">
  185. <span class="md-nav__icon md-icon"></span>
  186. </label>
  187. </div>
  188. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  189. <label class="md-nav__title" for="__nav_1">
  190. <span class="md-nav__icon md-icon"></span>
  191. Introduction
  192. </label>
  193. <ul class="md-nav__list" data-md-scrollfix>
  194. <li class="md-nav__item">
  195. <a href="introduction/overview/" class="md-nav__link">
  196. <span class="md-ellipsis">
  197. Overview
  198. </span>
  199. </a>
  200. </li>
  201. <li class="md-nav__item">
  202. <a href="introduction/glossary/" class="md-nav__link">
  203. <span class="md-ellipsis">
  204. Glossary
  205. </span>
  206. </a>
  207. </li>
  208. <li class="md-nav__item">
  209. <a href="introduction/prerequisites/" class="md-nav__link">
  210. <span class="md-ellipsis">
  211. Prerequisites
  212. </span>
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="introduction/getting-started/" class="md-nav__link">
  217. <span class="md-ellipsis">
  218. Getting started
  219. </span>
  220. </a>
  221. </li>
  222. <li class="md-nav__item">
  223. <a href="introduction/faq/" class="md-nav__link">
  224. <span class="md-ellipsis">
  225. FAQ
  226. </span>
  227. </a>
  228. </li>
  229. <li class="md-nav__item">
  230. <a href="introduction/stability-support/" class="md-nav__link">
  231. <span class="md-ellipsis">
  232. Stability and Support
  233. </span>
  234. </a>
  235. </li>
  236. <li class="md-nav__item">
  237. <a href="introduction/deprecation-policy/" class="md-nav__link">
  238. <span class="md-ellipsis">
  239. Deprecation Policy
  240. </span>
  241. </a>
  242. </li>
  243. </ul>
  244. </nav>
  245. </li>
  246. <li class="md-nav__item md-nav__item--nested">
  247. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  248. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  249. <span class="md-ellipsis">
  250. API
  251. </span>
  252. <span class="md-nav__icon md-icon"></span>
  253. </label>
  254. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  255. <label class="md-nav__title" for="__nav_2">
  256. <span class="md-nav__icon md-icon"></span>
  257. API
  258. </label>
  259. <ul class="md-nav__list" data-md-scrollfix>
  260. <li class="md-nav__item">
  261. <a href="api/components/" class="md-nav__link">
  262. <span class="md-ellipsis">
  263. Components
  264. </span>
  265. </a>
  266. </li>
  267. <li class="md-nav__item md-nav__item--nested">
  268. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  269. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  270. <span class="md-ellipsis">
  271. Core Resources
  272. </span>
  273. <span class="md-nav__icon md-icon"></span>
  274. </label>
  275. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  276. <label class="md-nav__title" for="__nav_2_2">
  277. <span class="md-nav__icon md-icon"></span>
  278. Core Resources
  279. </label>
  280. <ul class="md-nav__list" data-md-scrollfix>
  281. <li class="md-nav__item">
  282. <a href="api/externalsecret/" class="md-nav__link">
  283. <span class="md-ellipsis">
  284. ExternalSecret
  285. </span>
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="api/secretstore/" class="md-nav__link">
  290. <span class="md-ellipsis">
  291. SecretStore
  292. </span>
  293. </a>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="api/clustersecretstore/" class="md-nav__link">
  297. <span class="md-ellipsis">
  298. ClusterSecretStore
  299. </span>
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="api/clusterexternalsecret/" class="md-nav__link">
  304. <span class="md-ellipsis">
  305. ClusterExternalSecret
  306. </span>
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="api/pushsecret/" class="md-nav__link">
  311. <span class="md-ellipsis">
  312. PushSecret
  313. </span>
  314. </a>
  315. </li>
  316. </ul>
  317. </nav>
  318. </li>
  319. <li class="md-nav__item md-nav__item--nested">
  320. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  321. <div class="md-nav__link md-nav__container">
  322. <a href="api/generator/" class="md-nav__link ">
  323. <span class="md-ellipsis">
  324. Generators
  325. </span>
  326. </a>
  327. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  328. <span class="md-nav__icon md-icon"></span>
  329. </label>
  330. </div>
  331. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  332. <label class="md-nav__title" for="__nav_2_3">
  333. <span class="md-nav__icon md-icon"></span>
  334. Generators
  335. </label>
  336. <ul class="md-nav__list" data-md-scrollfix>
  337. <li class="md-nav__item">
  338. <a href="api/generator/acr/" class="md-nav__link">
  339. <span class="md-ellipsis">
  340. Azure Container Registry
  341. </span>
  342. </a>
  343. </li>
  344. <li class="md-nav__item">
  345. <a href="api/generator/ecr/" class="md-nav__link">
  346. <span class="md-ellipsis">
  347. AWS Elastic Container Registry
  348. </span>
  349. </a>
  350. </li>
  351. <li class="md-nav__item">
  352. <a href="api/generator/sts/" class="md-nav__link">
  353. <span class="md-ellipsis">
  354. AWS STS Session Token
  355. </span>
  356. </a>
  357. </li>
  358. <li class="md-nav__item">
  359. <a href="api/generator/cluster/" class="md-nav__link">
  360. <span class="md-ellipsis">
  361. Cluster Generator
  362. </span>
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="api/generator/gcr/" class="md-nav__link">
  367. <span class="md-ellipsis">
  368. Google Container Registry
  369. </span>
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="api/generator/quay/" class="md-nav__link">
  374. <span class="md-ellipsis">
  375. Quay
  376. </span>
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="api/generator/vault/" class="md-nav__link">
  381. <span class="md-ellipsis">
  382. Vault Dynamic Secret
  383. </span>
  384. </a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="api/generator/password/" class="md-nav__link">
  388. <span class="md-ellipsis">
  389. Password
  390. </span>
  391. </a>
  392. </li>
  393. <li class="md-nav__item">
  394. <a href="api/generator/fake/" class="md-nav__link">
  395. <span class="md-ellipsis">
  396. Fake
  397. </span>
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="api/generator/webhook/" class="md-nav__link">
  402. <span class="md-ellipsis">
  403. Webhook
  404. </span>
  405. </a>
  406. </li>
  407. <li class="md-nav__item">
  408. <a href="api/generator/github/" class="md-nav__link">
  409. <span class="md-ellipsis">
  410. Github
  411. </span>
  412. </a>
  413. </li>
  414. <li class="md-nav__item">
  415. <a href="api/generator/uuid/" class="md-nav__link">
  416. <span class="md-ellipsis">
  417. UUID
  418. </span>
  419. </a>
  420. </li>
  421. </ul>
  422. </nav>
  423. </li>
  424. <li class="md-nav__item md-nav__item--nested">
  425. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  426. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  427. <span class="md-ellipsis">
  428. Reference Docs
  429. </span>
  430. <span class="md-nav__icon md-icon"></span>
  431. </label>
  432. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  433. <label class="md-nav__title" for="__nav_2_4">
  434. <span class="md-nav__icon md-icon"></span>
  435. Reference Docs
  436. </label>
  437. <ul class="md-nav__list" data-md-scrollfix>
  438. <li class="md-nav__item">
  439. <a href="api/spec/" class="md-nav__link">
  440. <span class="md-ellipsis">
  441. API specification
  442. </span>
  443. </a>
  444. </li>
  445. <li class="md-nav__item">
  446. <a href="api/controller-options/" class="md-nav__link">
  447. <span class="md-ellipsis">
  448. Controller Options
  449. </span>
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="api/metrics/" class="md-nav__link">
  454. <span class="md-ellipsis">
  455. Metrics
  456. </span>
  457. </a>
  458. </li>
  459. </ul>
  460. </nav>
  461. </li>
  462. </ul>
  463. </nav>
  464. </li>
  465. <li class="md-nav__item md-nav__item--nested">
  466. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  467. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  468. <span class="md-ellipsis">
  469. Guides
  470. </span>
  471. <span class="md-nav__icon md-icon"></span>
  472. </label>
  473. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  474. <label class="md-nav__title" for="__nav_3">
  475. <span class="md-nav__icon md-icon"></span>
  476. Guides
  477. </label>
  478. <ul class="md-nav__list" data-md-scrollfix>
  479. <li class="md-nav__item">
  480. <a href="guides/introduction/" class="md-nav__link">
  481. <span class="md-ellipsis">
  482. Introduction
  483. </span>
  484. </a>
  485. </li>
  486. <li class="md-nav__item md-nav__item--nested">
  487. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  488. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  489. <span class="md-ellipsis">
  490. External Secrets
  491. </span>
  492. <span class="md-nav__icon md-icon"></span>
  493. </label>
  494. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  495. <label class="md-nav__title" for="__nav_3_2">
  496. <span class="md-nav__icon md-icon"></span>
  497. External Secrets
  498. </label>
  499. <ul class="md-nav__list" data-md-scrollfix>
  500. <li class="md-nav__item">
  501. <a href="guides/all-keys-one-secret/" class="md-nav__link">
  502. <span class="md-ellipsis">
  503. Extract structured data
  504. </span>
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="guides/getallsecrets/" class="md-nav__link">
  509. <span class="md-ellipsis">
  510. Find Secrets by Name or Metadata
  511. </span>
  512. </a>
  513. </li>
  514. <li class="md-nav__item">
  515. <a href="guides/datafrom-rewrite/" class="md-nav__link">
  516. <span class="md-ellipsis">
  517. Rewriting Keys
  518. </span>
  519. </a>
  520. </li>
  521. <li class="md-nav__item md-nav__item--nested">
  522. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  523. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  524. <span class="md-ellipsis">
  525. Advanced Templating
  526. </span>
  527. <span class="md-nav__icon md-icon"></span>
  528. </label>
  529. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  530. <label class="md-nav__title" for="__nav_3_2_4">
  531. <span class="md-nav__icon md-icon"></span>
  532. Advanced Templating
  533. </label>
  534. <ul class="md-nav__list" data-md-scrollfix>
  535. <li class="md-nav__item">
  536. <a href="guides/templating/" class="md-nav__link">
  537. <span class="md-ellipsis">
  538. v2
  539. </span>
  540. </a>
  541. </li>
  542. <li class="md-nav__item">
  543. <a href="guides/templating-v1/" class="md-nav__link">
  544. <span class="md-ellipsis">
  545. v1
  546. </span>
  547. </a>
  548. </li>
  549. </ul>
  550. </nav>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="guides/common-k8s-secret-types/" class="md-nav__link">
  554. <span class="md-ellipsis">
  555. Kubernetes Secret Types
  556. </span>
  557. </a>
  558. </li>
  559. <li class="md-nav__item">
  560. <a href="guides/ownership-deletion-policy/" class="md-nav__link">
  561. <span class="md-ellipsis">
  562. Lifecycle: ownership & deletion
  563. </span>
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="guides/decoding-strategy/" class="md-nav__link">
  568. <span class="md-ellipsis">
  569. Decoding Strategies
  570. </span>
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="guides/controller-class/" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. Controller Classes
  577. </span>
  578. </a>
  579. </li>
  580. </ul>
  581. </nav>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="guides/generator/" class="md-nav__link">
  585. <span class="md-ellipsis">
  586. Generators
  587. </span>
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="guides/pushsecrets/" class="md-nav__link">
  592. <span class="md-ellipsis">
  593. Push Secrets
  594. </span>
  595. </a>
  596. </li>
  597. <li class="md-nav__item md-nav__item--nested">
  598. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  599. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  600. <span class="md-ellipsis">
  601. Operations
  602. </span>
  603. <span class="md-nav__icon md-icon"></span>
  604. </label>
  605. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  606. <label class="md-nav__title" for="__nav_3_5">
  607. <span class="md-nav__icon md-icon"></span>
  608. Operations
  609. </label>
  610. <ul class="md-nav__list" data-md-scrollfix>
  611. <li class="md-nav__item">
  612. <a href="guides/multi-tenancy/" class="md-nav__link">
  613. <span class="md-ellipsis">
  614. Multi Tenancy
  615. </span>
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="guides/security-best-practices/" class="md-nav__link">
  620. <span class="md-ellipsis">
  621. Security Best Practices
  622. </span>
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="guides/threat-model/" class="md-nav__link">
  627. <span class="md-ellipsis">
  628. Threat Model
  629. </span>
  630. </a>
  631. </li>
  632. <li class="md-nav__item">
  633. <a href="guides/v1beta1/" class="md-nav__link">
  634. <span class="md-ellipsis">
  635. Upgrading to v1beta1
  636. </span>
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="guides/using-latest-image/" class="md-nav__link">
  641. <span class="md-ellipsis">
  642. Using Latest Image
  643. </span>
  644. </a>
  645. </li>
  646. <li class="md-nav__item">
  647. <a href="guides/disable-cluster-features/" class="md-nav__link">
  648. <span class="md-ellipsis">
  649. Disable Cluster Features
  650. </span>
  651. </a>
  652. </li>
  653. </ul>
  654. </nav>
  655. </li>
  656. <li class="md-nav__item md-nav__item--nested">
  657. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  658. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  659. <span class="md-ellipsis">
  660. Tooling
  661. </span>
  662. <span class="md-nav__icon md-icon"></span>
  663. </label>
  664. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  665. <label class="md-nav__title" for="__nav_3_6">
  666. <span class="md-nav__icon md-icon"></span>
  667. Tooling
  668. </label>
  669. <ul class="md-nav__list" data-md-scrollfix>
  670. <li class="md-nav__item">
  671. <a href="guides/using-esoctl-tool/" class="md-nav__link">
  672. <span class="md-ellipsis">
  673. Using the esoctl tool
  674. </span>
  675. </a>
  676. </li>
  677. </ul>
  678. </nav>
  679. </li>
  680. </ul>
  681. </nav>
  682. </li>
  683. <li class="md-nav__item md-nav__item--nested">
  684. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  685. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  686. <span class="md-ellipsis">
  687. Provider
  688. </span>
  689. <span class="md-nav__icon md-icon"></span>
  690. </label>
  691. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  692. <label class="md-nav__title" for="__nav_4">
  693. <span class="md-nav__icon md-icon"></span>
  694. Provider
  695. </label>
  696. <ul class="md-nav__list" data-md-scrollfix>
  697. <li class="md-nav__item">
  698. <a href="provider/aws-secrets-manager/" class="md-nav__link">
  699. <span class="md-ellipsis">
  700. AWS Secrets Manager
  701. </span>
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="provider/aws-parameter-store/" class="md-nav__link">
  706. <span class="md-ellipsis">
  707. AWS Parameter Store
  708. </span>
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="provider/azure-key-vault/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. Azure Key Vault
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="provider/beyondtrust/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. BeyondTrust
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="provider/bitwarden-secrets-manager/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. Bitwarden Secrets Manager
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="provider/chef/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. Chef
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="provider/conjur/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. CyberArk Conjur
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="provider/device42/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Device42
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="provider/google-secrets-manager/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Google Cloud Secret Manager
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="provider/hashicorp-vault/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. HashiCorp Vault
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="provider/kubernetes/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Kubernetes
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="provider/ibm-secrets-manager/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. IBM Secrets Manager
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="provider/akeyless/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. Akeyless
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="provider/yandex-certificate-manager/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. Yandex Certificate Manager
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="provider/yandex-lockbox/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. Yandex Lockbox
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="provider/alibaba/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Alibaba Cloud
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="provider/gitlab-variables/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. GitLab Variables
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="provider/oracle-vault/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. Oracle Vault
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="provider/1password-automation/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. 1Password Secrets Automation
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="provider/webhook/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Webhook
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="provider/fake/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. Fake
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="provider/senhasegura-dsm/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. senhasegura DevOps Secrets Management (DSM)
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="provider/doppler/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. Doppler
  855. </span>
  856. </a>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="provider/keeper-security/" class="md-nav__link">
  860. <span class="md-ellipsis">
  861. Keeper Security
  862. </span>
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="provider/cloak/" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. Cloak End 2 End Encrypted Secrets
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="provider/scaleway/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. Scaleway
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="provider/delinea/" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. Delinea
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="provider/secretserver/" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. Secret Server
  890. </span>
  891. </a>
  892. </li>
  893. <li class="md-nav__item">
  894. <a href="provider/passbolt/" class="md-nav__link">
  895. <span class="md-ellipsis">
  896. Passbolt
  897. </span>
  898. </a>
  899. </li>
  900. <li class="md-nav__item">
  901. <a href="provider/pulumi/" class="md-nav__link">
  902. <span class="md-ellipsis">
  903. Pulumi ESC
  904. </span>
  905. </a>
  906. </li>
  907. <li class="md-nav__item">
  908. <a href="provider/onboardbase/" class="md-nav__link">
  909. <span class="md-ellipsis">
  910. Onboardbase
  911. </span>
  912. </a>
  913. </li>
  914. <li class="md-nav__item">
  915. <a href="provider-passworddepot/" class="md-nav__link">
  916. <span class="md-ellipsis">
  917. Password Depot
  918. </span>
  919. </a>
  920. </li>
  921. <li class="md-nav__item">
  922. <a href="provider/fortanix/" class="md-nav__link">
  923. <span class="md-ellipsis">
  924. Fortanix
  925. </span>
  926. </a>
  927. </li>
  928. <li class="md-nav__item">
  929. <a href="provider/infisical/" class="md-nav__link">
  930. <span class="md-ellipsis">
  931. Infisical
  932. </span>
  933. </a>
  934. </li>
  935. <li class="md-nav__item">
  936. <a href="provider/previder/" class="md-nav__link">
  937. <span class="md-ellipsis">
  938. Previder
  939. </span>
  940. </a>
  941. </li>
  942. </ul>
  943. </nav>
  944. </li>
  945. <li class="md-nav__item md-nav__item--nested">
  946. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  947. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  948. <span class="md-ellipsis">
  949. Examples
  950. </span>
  951. <span class="md-nav__icon md-icon"></span>
  952. </label>
  953. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  954. <label class="md-nav__title" for="__nav_5">
  955. <span class="md-nav__icon md-icon"></span>
  956. Examples
  957. </label>
  958. <ul class="md-nav__list" data-md-scrollfix>
  959. <li class="md-nav__item">
  960. <a href="examples/gitops-using-fluxcd/" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. FluxCD
  963. </span>
  964. </a>
  965. </li>
  966. <li class="md-nav__item">
  967. <a href="examples/anchore-engine-credentials/" class="md-nav__link">
  968. <span class="md-ellipsis">
  969. Anchore Engine
  970. </span>
  971. </a>
  972. </li>
  973. <li class="md-nav__item">
  974. <a href="examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  975. <span class="md-ellipsis">
  976. Jenkins
  977. </span>
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="examples/bitwarden/" class="md-nav__link">
  982. <span class="md-ellipsis">
  983. Bitwarden
  984. </span>
  985. </a>
  986. </li>
  987. </ul>
  988. </nav>
  989. </li>
  990. <li class="md-nav__item md-nav__item--nested">
  991. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  992. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  993. <span class="md-ellipsis">
  994. Community
  995. </span>
  996. <span class="md-nav__icon md-icon"></span>
  997. </label>
  998. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  999. <label class="md-nav__title" for="__nav_6">
  1000. <span class="md-nav__icon md-icon"></span>
  1001. Community
  1002. </label>
  1003. <ul class="md-nav__list" data-md-scrollfix>
  1004. <li class="md-nav__item md-nav__item--nested">
  1005. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1006. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1007. <span class="md-ellipsis">
  1008. Contributing
  1009. </span>
  1010. <span class="md-nav__icon md-icon"></span>
  1011. </label>
  1012. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1013. <label class="md-nav__title" for="__nav_6_1">
  1014. <span class="md-nav__icon md-icon"></span>
  1015. Contributing
  1016. </label>
  1017. <ul class="md-nav__list" data-md-scrollfix>
  1018. <li class="md-nav__item">
  1019. <a href="contributing/devguide/" class="md-nav__link">
  1020. <span class="md-ellipsis">
  1021. Developer guide
  1022. </span>
  1023. </a>
  1024. </li>
  1025. <li class="md-nav__item">
  1026. <a href="contributing/process/" class="md-nav__link">
  1027. <span class="md-ellipsis">
  1028. Contributing Process
  1029. </span>
  1030. </a>
  1031. </li>
  1032. <li class="md-nav__item">
  1033. <a href="contributing/release/" class="md-nav__link">
  1034. <span class="md-ellipsis">
  1035. Release Process
  1036. </span>
  1037. </a>
  1038. </li>
  1039. <li class="md-nav__item">
  1040. <a href="contributing/coc/" class="md-nav__link">
  1041. <span class="md-ellipsis">
  1042. Code of Conduct
  1043. </span>
  1044. </a>
  1045. </li>
  1046. <li class="md-nav__item">
  1047. <a href="contributing/roadmap/" class="md-nav__link">
  1048. <span class="md-ellipsis">
  1049. Roadmap
  1050. </span>
  1051. </a>
  1052. </li>
  1053. </ul>
  1054. </nav>
  1055. </li>
  1056. <li class="md-nav__item md-nav__item--nested">
  1057. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1058. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1059. <span class="md-ellipsis">
  1060. External Resources
  1061. </span>
  1062. <span class="md-nav__icon md-icon"></span>
  1063. </label>
  1064. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1065. <label class="md-nav__title" for="__nav_6_2">
  1066. <span class="md-nav__icon md-icon"></span>
  1067. External Resources
  1068. </label>
  1069. <ul class="md-nav__list" data-md-scrollfix>
  1070. <li class="md-nav__item">
  1071. <a href="eso-talks/" class="md-nav__link">
  1072. <span class="md-ellipsis">
  1073. Talks
  1074. </span>
  1075. </a>
  1076. </li>
  1077. <li class="md-nav__item">
  1078. <a href="eso-demos/" class="md-nav__link">
  1079. <span class="md-ellipsis">
  1080. Demos
  1081. </span>
  1082. </a>
  1083. </li>
  1084. <li class="md-nav__item">
  1085. <a href="eso-blogs/" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. Blogs
  1088. </span>
  1089. </a>
  1090. </li>
  1091. <li class="md-nav__item">
  1092. <a href="eso-tools/" class="md-nav__link">
  1093. <span class="md-ellipsis">
  1094. Tools
  1095. </span>
  1096. </a>
  1097. </li>
  1098. </ul>
  1099. </nav>
  1100. </li>
  1101. </ul>
  1102. </nav>
  1103. </li>
  1104. </ul>
  1105. </nav>
  1106. </div>
  1107. </div>
  1108. </div>
  1109. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1110. <div class="md-sidebar__scrollwrap">
  1111. <div class="md-sidebar__inner">
  1112. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1113. </nav>
  1114. </div>
  1115. </div>
  1116. </div>
  1117. <div class="md-content" data-md-component="content">
  1118. <article class="md-content__inner md-typeset">
  1119. <h1 id="sponsored-by"><a href="https://opencollective.com/external-secrets-org">Sponsored by</a></h1>
  1120. <p><a href="https://container-solutions.com"><img alt="cs-logo" src="pictures/cs_logo.png" /></a>
  1121. <a href="https://externalsecrets.com"><img alt="External Secrets inc." src="pictures/ESI_Logo.svg" /></a>
  1122. <a href="https://www.form3.tech/"><img alt="Form3" src="pictures/form3_logo.png" /></a>
  1123. <a href="https://pento.io"><img alt="Pento" src="pictures/pento_logo.png" /></a></p>
  1124. <h1 id="introduction">Introduction</h1>
  1125. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  1126. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  1127. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  1128. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  1129. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  1130. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  1131. Vault</a>, <a href="https://www.ibm.com/cloud/secrets-manager">IBM Cloud Secrets Manager</a>, <a href="https://www.conjur.org">CyberArk Conjur</a>, <a href="https://www.pulumi.com/product/esc/">Pulumi ESC</a> and many more. The
  1132. operator reads information from external APIs and automatically injects the
  1133. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  1134. Secret</a>.</p>
  1135. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  1136. <p>The goal of External Secrets Operator is to synchronize secrets from external
  1137. APIs into Kubernetes. ESO is a collection of custom API resources -
  1138. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  1139. user-friendly abstraction for the external API that stores and manages the
  1140. lifecycle of the secrets for you.</p>
  1141. <h3 id="where-to-get-started">Where to get started</h3>
  1142. <p>To get started, please read through <a href="introduction/overview/">API overview</a> this should
  1143. give you a high-level overview to understand the API and use-cases. After that
  1144. please follow one of our <a href="guides/introduction/">guides</a> to get a jump start
  1145. using the operator. See our <a href="introduction/getting-started/">getting started guide</a> for installation instructions.</p>
  1146. <p>For a complete reference of the API types please refer to our <a href="api/spec/">API
  1147. Reference</a>.</p>
  1148. <h3 id="how-to-get-involved">How to get involved</h3>
  1149. <p>This project is driven by its users and contributors, and we welcome everybody
  1150. to get involved. Join our meetings, open issues or ask questions in Slack. The
  1151. success of this project depends on your input: No contribution is too small -
  1152. even opinions matter!</p>
  1153. <p>How to get involved:</p>
  1154. <ul>
  1155. <li>Bi-weekly Development Meeting every odd week at <a href="https://dateful.com/time-zone-converter?t=20:00&amp;tz=Europe/Berlin">8:00 PM Berlin Time</a> on Wednesday
  1156. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>, <a href="https://meet.jit.si/eso-community-meeting">jitsi call</a>)</li>
  1157. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  1158. #external-secrets</a></li>
  1159. <li><a href="contributing/process/">Contributing Process</a></li>
  1160. <li><a href="https://twitter.com/ExtSecretsOptr">Twitter</a></li>
  1161. </ul>
  1162. <h3 id="kicked-off-by">Kicked off by</h3>
  1163. <p><img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  1164. </article>
  1165. </div>
  1166. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1167. </div>
  1168. </main>
  1169. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1170. <footer class="md-footer">
  1171. <div class="md-footer-meta md-typeset">
  1172. <div class="md-footer-meta__inner md-grid">
  1173. <div class="md-copyright">
  1174. <div class="md-copyright__highlight">
  1175. &copy; 2024 The external-secrets Authors.<br/>
  1176. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1177. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1178. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1179. </div>
  1180. Made with
  1181. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1182. Material for MkDocs
  1183. </a>
  1184. </div>
  1185. </div>
  1186. </div>
  1187. </footer>
  1188. </div>
  1189. <div class="md-dialog" data-md-component="dialog">
  1190. <div class="md-dialog__inner md-typeset"></div>
  1191. </div>
  1192. <script id="__config" type="application/json">{"base": ".", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "assets/javascripts/workers/search.f8cc74c7.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>
  1193. <script src="assets/javascripts/bundle.f1b6f286.min.js"></script>
  1194. </body>
  1195. </html>