index.html 78 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615
  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="../secretstore/">
  7. <link rel="next" href="../clusterexternalsecret/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
  10. <title>ClusterSecretStore - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.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="#example" 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. ClusterSecretStore
  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.7.1 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 md-tabs__item--active">
  127. <a href="../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">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 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--active md-nav__item--section md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  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="true">
  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="../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--active md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" checked>
  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="true">
  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="../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="../secretstore/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. SecretStore
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item md-nav__item--active">
  283. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  284. <label class="md-nav__link md-nav__link--active" for="__toc">
  285. <span class="md-ellipsis">
  286. ClusterSecretStore
  287. </span>
  288. <span class="md-nav__icon md-icon"></span>
  289. </label>
  290. <a href="./" class="md-nav__link md-nav__link--active">
  291. <span class="md-ellipsis">
  292. ClusterSecretStore
  293. </span>
  294. </a>
  295. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  296. <label class="md-nav__title" for="__toc">
  297. <span class="md-nav__icon md-icon"></span>
  298. Table of contents
  299. </label>
  300. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  301. <li class="md-nav__item">
  302. <a href="#example" class="md-nav__link">
  303. <span class="md-ellipsis">
  304. Example
  305. </span>
  306. </a>
  307. </li>
  308. </ul>
  309. </nav>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../clusterexternalsecret/" class="md-nav__link">
  313. <span class="md-ellipsis">
  314. ClusterExternalSecret
  315. </span>
  316. </a>
  317. </li>
  318. <li class="md-nav__item">
  319. <a href="../pushsecret/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. PushSecret
  322. </span>
  323. </a>
  324. </li>
  325. </ul>
  326. </nav>
  327. </li>
  328. <li class="md-nav__item md-nav__item--nested">
  329. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  330. <div class="md-nav__link md-nav__container">
  331. <a href="../generator/" class="md-nav__link ">
  332. <span class="md-ellipsis">
  333. Generators
  334. </span>
  335. </a>
  336. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  337. <span class="md-nav__icon md-icon"></span>
  338. </label>
  339. </div>
  340. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  341. <label class="md-nav__title" for="__nav_2_3">
  342. <span class="md-nav__icon md-icon"></span>
  343. Generators
  344. </label>
  345. <ul class="md-nav__list" data-md-scrollfix>
  346. <li class="md-nav__item">
  347. <a href="../generator/acr/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Azure Container Registry
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../generator/ecr/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. AWS Elastic Container Registry
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../generator/sts/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. AWS STS Session Token
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../generator/cluster/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Cluster Generator
  371. </span>
  372. </a>
  373. </li>
  374. <li class="md-nav__item">
  375. <a href="../generator/gcr/" class="md-nav__link">
  376. <span class="md-ellipsis">
  377. Google Container Registry
  378. </span>
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="../generator/quay/" class="md-nav__link">
  383. <span class="md-ellipsis">
  384. Quay
  385. </span>
  386. </a>
  387. </li>
  388. <li class="md-nav__item">
  389. <a href="../generator/vault/" class="md-nav__link">
  390. <span class="md-ellipsis">
  391. Vault Dynamic Secret
  392. </span>
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../generator/password/" class="md-nav__link">
  397. <span class="md-ellipsis">
  398. Password
  399. </span>
  400. </a>
  401. </li>
  402. <li class="md-nav__item">
  403. <a href="../generator/fake/" class="md-nav__link">
  404. <span class="md-ellipsis">
  405. Fake
  406. </span>
  407. </a>
  408. </li>
  409. <li class="md-nav__item">
  410. <a href="../generator/webhook/" class="md-nav__link">
  411. <span class="md-ellipsis">
  412. Webhook
  413. </span>
  414. </a>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="../generator/github/" class="md-nav__link">
  418. <span class="md-ellipsis">
  419. Github
  420. </span>
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../generator/uuid/" class="md-nav__link">
  425. <span class="md-ellipsis">
  426. UUID
  427. </span>
  428. </a>
  429. </li>
  430. </ul>
  431. </nav>
  432. </li>
  433. <li class="md-nav__item md-nav__item--nested">
  434. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  435. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  436. <span class="md-ellipsis">
  437. Reference Docs
  438. </span>
  439. <span class="md-nav__icon md-icon"></span>
  440. </label>
  441. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  442. <label class="md-nav__title" for="__nav_2_4">
  443. <span class="md-nav__icon md-icon"></span>
  444. Reference Docs
  445. </label>
  446. <ul class="md-nav__list" data-md-scrollfix>
  447. <li class="md-nav__item">
  448. <a href="../spec/" class="md-nav__link">
  449. <span class="md-ellipsis">
  450. API specification
  451. </span>
  452. </a>
  453. </li>
  454. <li class="md-nav__item">
  455. <a href="../controller-options/" class="md-nav__link">
  456. <span class="md-ellipsis">
  457. Controller Options
  458. </span>
  459. </a>
  460. </li>
  461. <li class="md-nav__item">
  462. <a href="../metrics/" class="md-nav__link">
  463. <span class="md-ellipsis">
  464. Metrics
  465. </span>
  466. </a>
  467. </li>
  468. </ul>
  469. </nav>
  470. </li>
  471. </ul>
  472. </nav>
  473. </li>
  474. <li class="md-nav__item md-nav__item--nested">
  475. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  476. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  477. <span class="md-ellipsis">
  478. Guides
  479. </span>
  480. <span class="md-nav__icon md-icon"></span>
  481. </label>
  482. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  483. <label class="md-nav__title" for="__nav_3">
  484. <span class="md-nav__icon md-icon"></span>
  485. Guides
  486. </label>
  487. <ul class="md-nav__list" data-md-scrollfix>
  488. <li class="md-nav__item">
  489. <a href="../../guides/introduction/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. Introduction
  492. </span>
  493. </a>
  494. </li>
  495. <li class="md-nav__item md-nav__item--nested">
  496. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  497. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  498. <span class="md-ellipsis">
  499. External Secrets
  500. </span>
  501. <span class="md-nav__icon md-icon"></span>
  502. </label>
  503. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  504. <label class="md-nav__title" for="__nav_3_2">
  505. <span class="md-nav__icon md-icon"></span>
  506. External Secrets
  507. </label>
  508. <ul class="md-nav__list" data-md-scrollfix>
  509. <li class="md-nav__item">
  510. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  511. <span class="md-ellipsis">
  512. Extract structured data
  513. </span>
  514. </a>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="../../guides/getallsecrets/" class="md-nav__link">
  518. <span class="md-ellipsis">
  519. Find Secrets by Name or Metadata
  520. </span>
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  525. <span class="md-ellipsis">
  526. Rewriting Keys
  527. </span>
  528. </a>
  529. </li>
  530. <li class="md-nav__item md-nav__item--nested">
  531. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  532. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  533. <span class="md-ellipsis">
  534. Advanced Templating
  535. </span>
  536. <span class="md-nav__icon md-icon"></span>
  537. </label>
  538. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  539. <label class="md-nav__title" for="__nav_3_2_4">
  540. <span class="md-nav__icon md-icon"></span>
  541. Advanced Templating
  542. </label>
  543. <ul class="md-nav__list" data-md-scrollfix>
  544. <li class="md-nav__item">
  545. <a href="../../guides/templating/" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. v2
  548. </span>
  549. </a>
  550. </li>
  551. <li class="md-nav__item">
  552. <a href="../../guides/templating-v1/" class="md-nav__link">
  553. <span class="md-ellipsis">
  554. v1
  555. </span>
  556. </a>
  557. </li>
  558. </ul>
  559. </nav>
  560. </li>
  561. <li class="md-nav__item">
  562. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  563. <span class="md-ellipsis">
  564. Kubernetes Secret Types
  565. </span>
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  570. <span class="md-ellipsis">
  571. Lifecycle: ownership & deletion
  572. </span>
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  577. <span class="md-ellipsis">
  578. Decoding Strategies
  579. </span>
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../../guides/controller-class/" class="md-nav__link">
  584. <span class="md-ellipsis">
  585. Controller Classes
  586. </span>
  587. </a>
  588. </li>
  589. </ul>
  590. </nav>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../guides/generator/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. Generators
  596. </span>
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../../guides/pushsecrets/" class="md-nav__link">
  601. <span class="md-ellipsis">
  602. Push Secrets
  603. </span>
  604. </a>
  605. </li>
  606. <li class="md-nav__item md-nav__item--nested">
  607. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  608. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  609. <span class="md-ellipsis">
  610. Operations
  611. </span>
  612. <span class="md-nav__icon md-icon"></span>
  613. </label>
  614. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  615. <label class="md-nav__title" for="__nav_3_5">
  616. <span class="md-nav__icon md-icon"></span>
  617. Operations
  618. </label>
  619. <ul class="md-nav__list" data-md-scrollfix>
  620. <li class="md-nav__item">
  621. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  622. <span class="md-ellipsis">
  623. Multi Tenancy
  624. </span>
  625. </a>
  626. </li>
  627. <li class="md-nav__item">
  628. <a href="../../guides/security-best-practices/" class="md-nav__link">
  629. <span class="md-ellipsis">
  630. Security Best Practices
  631. </span>
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="../../guides/threat-model/" class="md-nav__link">
  636. <span class="md-ellipsis">
  637. Threat Model
  638. </span>
  639. </a>
  640. </li>
  641. <li class="md-nav__item">
  642. <a href="../../guides/v1beta1/" class="md-nav__link">
  643. <span class="md-ellipsis">
  644. Upgrading to v1beta1
  645. </span>
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="../../guides/using-latest-image/" class="md-nav__link">
  650. <span class="md-ellipsis">
  651. Using Latest Image
  652. </span>
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  657. <span class="md-ellipsis">
  658. Disable Cluster Features
  659. </span>
  660. </a>
  661. </li>
  662. </ul>
  663. </nav>
  664. </li>
  665. </ul>
  666. </nav>
  667. </li>
  668. <li class="md-nav__item md-nav__item--nested">
  669. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  670. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  671. <span class="md-ellipsis">
  672. Provider
  673. </span>
  674. <span class="md-nav__icon md-icon"></span>
  675. </label>
  676. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  677. <label class="md-nav__title" for="__nav_4">
  678. <span class="md-nav__icon md-icon"></span>
  679. Provider
  680. </label>
  681. <ul class="md-nav__list" data-md-scrollfix>
  682. <li class="md-nav__item">
  683. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. AWS Secrets Manager
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. AWS Parameter Store
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Azure Key Vault
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/beyondtrust/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. BeyondTrust
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Bitwarden Secrets Manager
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/chef/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. Chef
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/conjur/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. CyberArk Conjur
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/device42/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Device42
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Google Cloud Secret Manager
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. HashiCorp Vault
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/kubernetes/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Kubernetes
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. IBM Secrets Manager
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/akeyless/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Akeyless
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Yandex Certificate Manager
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Yandex Lockbox
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/alibaba/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. Alibaba Cloud
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. GitLab Variables
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../provider/oracle-vault/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. Oracle Vault
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../provider/1password-automation/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. 1Password Secrets Automation
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../../provider/webhook/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Webhook
  819. </span>
  820. </a>
  821. </li>
  822. <li class="md-nav__item">
  823. <a href="../../provider/fake/" class="md-nav__link">
  824. <span class="md-ellipsis">
  825. Fake
  826. </span>
  827. </a>
  828. </li>
  829. <li class="md-nav__item">
  830. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  831. <span class="md-ellipsis">
  832. senhasegura DevOps Secrets Management (DSM)
  833. </span>
  834. </a>
  835. </li>
  836. <li class="md-nav__item">
  837. <a href="../../provider/doppler/" class="md-nav__link">
  838. <span class="md-ellipsis">
  839. Doppler
  840. </span>
  841. </a>
  842. </li>
  843. <li class="md-nav__item">
  844. <a href="../../provider/keeper-security/" class="md-nav__link">
  845. <span class="md-ellipsis">
  846. Keeper Security
  847. </span>
  848. </a>
  849. </li>
  850. <li class="md-nav__item">
  851. <a href="../../provider/cloak/" class="md-nav__link">
  852. <span class="md-ellipsis">
  853. Cloak End 2 End Encrypted Secrets
  854. </span>
  855. </a>
  856. </li>
  857. <li class="md-nav__item">
  858. <a href="../../provider/scaleway/" class="md-nav__link">
  859. <span class="md-ellipsis">
  860. Scaleway
  861. </span>
  862. </a>
  863. </li>
  864. <li class="md-nav__item">
  865. <a href="../../provider/delinea/" class="md-nav__link">
  866. <span class="md-ellipsis">
  867. Delinea
  868. </span>
  869. </a>
  870. </li>
  871. <li class="md-nav__item">
  872. <a href="../../provider/secretserver/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. Secret Server
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../provider/passbolt/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Passbolt
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../provider/pulumi/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Pulumi ESC
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../provider/onboardbase/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. Onboardbase
  896. </span>
  897. </a>
  898. </li>
  899. <li class="md-nav__item">
  900. <a href="../../provider-passworddepot/" class="md-nav__link">
  901. <span class="md-ellipsis">
  902. Password Depot
  903. </span>
  904. </a>
  905. </li>
  906. <li class="md-nav__item">
  907. <a href="../../provider/fortanix/" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Fortanix
  910. </span>
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="../../provider/infisical/" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. Infisical
  917. </span>
  918. </a>
  919. </li>
  920. <li class="md-nav__item">
  921. <a href="../../provider/previder/" class="md-nav__link">
  922. <span class="md-ellipsis">
  923. Previder
  924. </span>
  925. </a>
  926. </li>
  927. </ul>
  928. </nav>
  929. </li>
  930. <li class="md-nav__item md-nav__item--nested">
  931. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  932. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  933. <span class="md-ellipsis">
  934. Examples
  935. </span>
  936. <span class="md-nav__icon md-icon"></span>
  937. </label>
  938. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  939. <label class="md-nav__title" for="__nav_5">
  940. <span class="md-nav__icon md-icon"></span>
  941. Examples
  942. </label>
  943. <ul class="md-nav__list" data-md-scrollfix>
  944. <li class="md-nav__item">
  945. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. FluxCD
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Anchore Engine
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. Jenkins
  962. </span>
  963. </a>
  964. </li>
  965. <li class="md-nav__item">
  966. <a href="../../examples/bitwarden/" class="md-nav__link">
  967. <span class="md-ellipsis">
  968. BitWarden
  969. </span>
  970. </a>
  971. </li>
  972. </ul>
  973. </nav>
  974. </li>
  975. <li class="md-nav__item md-nav__item--nested">
  976. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  977. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  978. <span class="md-ellipsis">
  979. Community
  980. </span>
  981. <span class="md-nav__icon md-icon"></span>
  982. </label>
  983. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  984. <label class="md-nav__title" for="__nav_6">
  985. <span class="md-nav__icon md-icon"></span>
  986. Community
  987. </label>
  988. <ul class="md-nav__list" data-md-scrollfix>
  989. <li class="md-nav__item md-nav__item--nested">
  990. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  991. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  992. <span class="md-ellipsis">
  993. Contributing
  994. </span>
  995. <span class="md-nav__icon md-icon"></span>
  996. </label>
  997. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  998. <label class="md-nav__title" for="__nav_6_1">
  999. <span class="md-nav__icon md-icon"></span>
  1000. Contributing
  1001. </label>
  1002. <ul class="md-nav__list" data-md-scrollfix>
  1003. <li class="md-nav__item">
  1004. <a href="../../contributing/devguide/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Developer guide
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../../contributing/process/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Contributing Process
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../../contributing/release/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Release Process
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../../contributing/coc/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Code of Conduct
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../../contributing/roadmap/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Roadmap
  1035. </span>
  1036. </a>
  1037. </li>
  1038. </ul>
  1039. </nav>
  1040. </li>
  1041. <li class="md-nav__item md-nav__item--nested">
  1042. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1043. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1044. <span class="md-ellipsis">
  1045. External Resources
  1046. </span>
  1047. <span class="md-nav__icon md-icon"></span>
  1048. </label>
  1049. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1050. <label class="md-nav__title" for="__nav_6_2">
  1051. <span class="md-nav__icon md-icon"></span>
  1052. External Resources
  1053. </label>
  1054. <ul class="md-nav__list" data-md-scrollfix>
  1055. <li class="md-nav__item">
  1056. <a href="../../eso-talks/" class="md-nav__link">
  1057. <span class="md-ellipsis">
  1058. Talks
  1059. </span>
  1060. </a>
  1061. </li>
  1062. <li class="md-nav__item">
  1063. <a href="../../eso-demos/" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. Demos
  1066. </span>
  1067. </a>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="../../eso-blogs/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Blogs
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="../../eso-tools/" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Tools
  1080. </span>
  1081. </a>
  1082. </li>
  1083. </ul>
  1084. </nav>
  1085. </li>
  1086. </ul>
  1087. </nav>
  1088. </li>
  1089. </ul>
  1090. </nav>
  1091. </div>
  1092. </div>
  1093. </div>
  1094. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1095. <div class="md-sidebar__scrollwrap">
  1096. <div class="md-sidebar__inner">
  1097. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1098. <label class="md-nav__title" for="__toc">
  1099. <span class="md-nav__icon md-icon"></span>
  1100. Table of contents
  1101. </label>
  1102. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1103. <li class="md-nav__item">
  1104. <a href="#example" class="md-nav__link">
  1105. <span class="md-ellipsis">
  1106. Example
  1107. </span>
  1108. </a>
  1109. </li>
  1110. </ul>
  1111. </nav>
  1112. </div>
  1113. </div>
  1114. </div>
  1115. <div class="md-content" data-md-component="content">
  1116. <article class="md-content__inner md-typeset">
  1117. <h1>ClusterSecretStore</h1>
  1118. <p><img alt="ClusterSecretStore" src="../../pictures/diagrams-high-level-cluster-detail.png" /></p>
  1119. <p>The <code>ClusterSecretStore</code> is a cluster scoped SecretStore that can be referenced by all
  1120. <code>ExternalSecrets</code> from all namespaces. Use it to offer a central gateway to your secret backend.</p>
  1121. <h2 id="example">Example</h2>
  1122. <p>For a full list of supported fields see <a href="../spec/">spec</a> or dig into our <a href="../../guides/introduction/">guides</a>.</p>
  1123. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1124. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1125. <span class="nt">metadata</span><span class="p">:</span>
  1126. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1127. <span class="nt">spec</span><span class="p">:</span>
  1128. <span class="w"> </span><span class="c1"># Used to select the correct ESO controller (think: ingress.ingressClassName)</span>
  1129. <span class="w"> </span><span class="c1"># The ESO controller is instantiated with a specific controller name</span>
  1130. <span class="w"> </span><span class="c1"># and filters ES based on this property</span>
  1131. <span class="w"> </span><span class="c1"># Optional</span>
  1132. <span class="w"> </span><span class="nt">controller</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev</span>
  1133. <span class="w"> </span><span class="c1"># provider field contains the configuration to access the provider</span>
  1134. <span class="w"> </span><span class="c1"># which contains the secret exactly one provider must be configured.</span>
  1135. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1136. <span class="w"> </span><span class="c1"># (1): AWS Secrets Manager</span>
  1137. <span class="w"> </span><span class="c1"># aws configures this store to sync secrets using AWS Secret Manager provider</span>
  1138. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1139. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  1140. <span class="w"> </span><span class="c1"># Role is a Role ARN which the SecretManager provider will assume</span>
  1141. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">iam-role</span>
  1142. <span class="w"> </span><span class="c1"># AWS Region to be used for the provider</span>
  1143. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  1144. <span class="w"> </span><span class="c1"># Auth defines the information necessary to authenticate against AWS</span>
  1145. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1146. <span class="w"> </span><span class="c1"># Getting the accessKeyID and secretAccessKey from an already created Kubernetes Secret</span>
  1147. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1148. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1149. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  1150. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span>
  1151. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1152. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  1153. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  1154. <span class="w"> </span><span class="c1"># IAM roles for service accounts</span>
  1155. <span class="w"> </span><span class="c1"># https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-technical-overview.html</span>
  1156. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  1157. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1158. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span>
  1159. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sa-namespace</span>
  1160. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  1161. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  1162. <span class="w"> </span><span class="c1"># Path is the mount path of the Vault KV backend endpoint</span>
  1163. <span class="w"> </span><span class="c1"># Used as a path prefix for the external secret key</span>
  1164. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  1165. <span class="w"> </span><span class="c1"># Version is the Vault KV secret engine version.</span>
  1166. <span class="w"> </span><span class="c1"># This can be either &quot;v1&quot; or &quot;v2&quot;, defaults to &quot;v2&quot;</span>
  1167. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  1168. <span class="w"> </span><span class="c1"># vault enterprise namespace: https://www.vaultproject.io/docs/enterprise/namespaces</span>
  1169. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;a-team&quot;</span>
  1170. <span class="w"> </span><span class="c1"># base64 encoded string of certificate</span>
  1171. <span class="w"> </span><span class="nt">caBundle</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;...&quot;</span>
  1172. <span class="w"> </span><span class="c1"># Instead of caBundle you can also specify a caProvider</span>
  1173. <span class="w"> </span><span class="c1"># this will retrieve the cert from a Secret or ConfigMap</span>
  1174. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  1175. <span class="w"> </span><span class="c1"># Can be Secret or ConfigMap</span>
  1176. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Secret&quot;</span>
  1177. <span class="w"> </span><span class="c1"># namespace is mandatory for ClusterSecretStore and not relevant for SecretStore</span>
  1178. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-cert-secret-namespace&quot;</span>
  1179. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-cert-secret&quot;</span>
  1180. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;cert-key&quot;</span>
  1181. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1182. <span class="w"> </span><span class="c1"># static token: https://www.vaultproject.io/docs/auth/token</span>
  1183. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span>
  1184. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1185. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  1186. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token&quot;</span>
  1187. <span class="w"> </span><span class="c1"># AppRole auth: https://www.vaultproject.io/docs/auth/approle</span>
  1188. <span class="w"> </span><span class="nt">appRole</span><span class="p">:</span>
  1189. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;approle&quot;</span>
  1190. <span class="w"> </span><span class="c1"># Instead of referencing the AppRole&#39;s ID from the secret, you can also specify it directly</span>
  1191. <span class="w"> </span><span class="c1"># roleId: &quot;db02de05-fa39-4855-059b-67221c5c2f63&quot;</span>
  1192. <span class="w"> </span><span class="nt">roleRef</span><span class="p">:</span>
  1193. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1194. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  1195. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-role-id&quot;</span>
  1196. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1197. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1198. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  1199. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-role-secret&quot;</span>
  1200. <span class="w"> </span><span class="c1"># Kubernetes auth: https://www.vaultproject.io/docs/auth/kubernetes</span>
  1201. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1202. <span class="w"> </span><span class="nt">mountPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;kubernetes&quot;</span>
  1203. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;demo&quot;</span>
  1204. <span class="w"> </span><span class="c1"># Optional service account reference</span>
  1205. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1206. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-sa&quot;</span>
  1207. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  1208. <span class="w"> </span><span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span>
  1209. <span class="w"> </span><span class="c1"># used for authenticating with Vault</span>
  1210. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1211. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  1212. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  1213. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault&quot;</span>
  1214. <span class="w"> </span><span class="c1"># (2): GCP Secret Manager</span>
  1215. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  1216. <span class="w"> </span><span class="c1"># Auth defines the information necessary to authenticate against GCP by getting</span>
  1217. <span class="w"> </span><span class="c1"># the credentials from an already created Kubernetes Secret.</span>
  1218. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1219. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1220. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1221. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gcpsm-secret</span>
  1222. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-credentials</span>
  1223. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1224. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myproject</span>
  1225. <span class="w"> </span><span class="c1"># (3): Kubernetes provider</span>
  1226. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  1227. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  1228. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://myapiserver.tld&quot;</span>
  1229. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  1230. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span>
  1231. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-cluster-secrets</span>
  1232. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example</span>
  1233. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ca.crt</span>
  1234. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1235. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span>
  1236. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;example-sa&quot;</span>
  1237. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;example&quot;</span>
  1238. <span class="w"> </span><span class="c1"># (4): Oracle provider</span>
  1239. <span class="w"> </span><span class="nt">oracle</span><span class="p">:</span>
  1240. <span class="w"> </span><span class="c1"># The vault OCID</span>
  1241. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocid1.vault.oc1.eu-frankfurt-1.aaa1aaaaaaaaa.aaaaaaaaaaaaaa1aaaaaaa111aaaaaaaaaaaaaaaa</span>
  1242. <span class="w"> </span><span class="c1"># The vault region</span>
  1243. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-frankfurt-1</span>
  1244. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1245. <span class="w"> </span><span class="c1"># The user OCID</span>
  1246. <span class="w"> </span><span class="nt">user</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocid1.user.oc1..aaa1aaaaaaaaa.aaaaaaaaaaaaaa1aaaaaaa111aaaaaaaaaaaaaaaa</span>
  1247. <span class="w"> </span><span class="c1"># The tenancy OCID</span>
  1248. <span class="w"> </span><span class="nt">tenancy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocid1.tenancy.oc1..aaa1aaaaaaaaa.aaaaaaaaaaaaaa1aaaaaaa111aaaaaaaaaaaaaaaa</span>
  1249. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1250. <span class="w"> </span><span class="nt">privatekey</span><span class="p">:</span>
  1251. <span class="w"> </span><span class="c1"># The secret that contains your privatekey</span>
  1252. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oci-secret-name</span>
  1253. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">privateKey</span>
  1254. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-namespace</span>
  1255. <span class="w"> </span><span class="nt">fingerprint</span><span class="p">:</span>
  1256. <span class="w"> </span><span class="c1"># The secret that contains your fingerprint</span>
  1257. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oci-secret-name</span>
  1258. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fingerprint</span>
  1259. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">example-namespace</span>
  1260. <span class="w"> </span><span class="c1"># (TODO): add more provider examples here</span>
  1261. <span class="w"> </span><span class="c1"># Conditions about namespaces in which the ClusterSecretStore is usable for ExternalSecrets</span>
  1262. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  1263. <span class="w"> </span><span class="c1"># Options are namespaceSelector, namespaces or namespacesRegex</span>
  1264. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaceSelector</span><span class="p">:</span>
  1265. <span class="w"> </span><span class="nt">matchLabels</span><span class="p">:</span>
  1266. <span class="w"> </span><span class="nt">my.namespace.io/some-label</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;value&quot;</span><span class="w"> </span><span class="c1"># Only namespaces with that label will work</span>
  1267. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaces</span><span class="p">:</span>
  1268. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;namespace-a&quot;</span>
  1269. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;namespace-b&quot;</span>
  1270. <span class="w"> </span><span class="c1"># Namespace regexes are useful for policy management or when external tools auto-generate namespaces with prefixes/suffixes</span>
  1271. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaceRegexes</span><span class="p">:</span>
  1272. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;namespace-a-.*&quot;</span><span class="w"> </span><span class="c1"># All namespaces prefixed by namespace-a- will work</span>
  1273. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;namespace-b-.*&quot;</span><span class="w"> </span><span class="c1"># All namespaces prefixed by namespace-b- will work</span>
  1274. <span class="w"> </span><span class="c1"># conditions needs only one of the conditions to meet for the CSS to be usable in the namespace.</span>
  1275. <span class="nt">status</span><span class="p">:</span>
  1276. <span class="w"> </span><span class="c1"># Standard condition schema</span>
  1277. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  1278. <span class="w"> </span><span class="c1"># SecretStore ready condition indicates the given store is in ready</span>
  1279. <span class="w"> </span><span class="c1"># state and able to referenced by ExternalSecrets</span>
  1280. <span class="w"> </span><span class="c1"># If the `status` of this condition is `False`, ExternalSecret controllers</span>
  1281. <span class="w"> </span><span class="c1"># should prevent attempts to fetch secrets</span>
  1282. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ready</span>
  1283. <span class="w"> </span><span class="nt">status</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;False&quot;</span>
  1284. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ConfigError&quot;</span>
  1285. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecretStore</span><span class="nv"> </span><span class="s">validation</span><span class="nv"> </span><span class="s">failed&quot;</span>
  1286. <span class="w"> </span><span class="nt">lastTransitionTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  1287. </code></pre></div>
  1288. </article>
  1289. </div>
  1290. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1291. </div>
  1292. </main>
  1293. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1294. <footer class="md-footer">
  1295. <div class="md-footer-meta md-typeset">
  1296. <div class="md-footer-meta__inner md-grid">
  1297. <div class="md-copyright">
  1298. <div class="md-copyright__highlight">
  1299. &copy; 2024 The external-secrets Authors.<br/>
  1300. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1301. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1302. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1303. </div>
  1304. Made with
  1305. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1306. Material for MkDocs
  1307. </a>
  1308. </div>
  1309. </div>
  1310. </div>
  1311. </footer>
  1312. </div>
  1313. <div class="md-dialog" data-md-component="dialog">
  1314. <div class="md-dialog__inner md-typeset"></div>
  1315. </div>
  1316. <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>
  1317. <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
  1318. </body>
  1319. </html>