index.html 73 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549
  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="../components/">
  7. <link rel="next" href="../secretstore/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.29">
  10. <title>ExternalSecret - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.76a95c52.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 n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#template" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></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. ExternalSecret
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(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([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  64. <label class="md-header__button md-icon" for="__search">
  65. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 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 5Z"/></svg>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 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 5Z"/></svg>
  74. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.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.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item md-tabs__item--active">
  116. <a href="../components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. </ul>
  146. </div>
  147. </nav>
  148. <main class="md-main" data-md-component="main">
  149. <div class="md-main__inner md-grid">
  150. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  151. <div class="md-sidebar__scrollwrap">
  152. <div class="md-sidebar__inner">
  153. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  154. <label class="md-nav__title" for="__drawer">
  155. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  156. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  157. </a>
  158. External Secrets Operator
  159. </label>
  160. <div class="md-nav__source">
  161. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  162. <div class="md-source__icon md-icon">
  163. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.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.81z"/></svg>
  164. </div>
  165. <div class="md-source__repository">
  166. External Secrets Operator
  167. </div>
  168. </a>
  169. </div>
  170. <ul class="md-nav__list" data-md-scrollfix>
  171. <li class="md-nav__item md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  173. <div class="md-nav__link md-nav__container">
  174. <a href="../.." class="md-nav__link ">
  175. <span class="md-ellipsis">
  176. Introduction
  177. </span>
  178. </a>
  179. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  180. <span class="md-nav__icon md-icon"></span>
  181. </label>
  182. </div>
  183. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  184. <label class="md-nav__title" for="__nav_1">
  185. <span class="md-nav__icon md-icon"></span>
  186. Introduction
  187. </label>
  188. <ul class="md-nav__list" data-md-scrollfix>
  189. <li class="md-nav__item">
  190. <a href="../../introduction/overview/" class="md-nav__link">
  191. <span class="md-ellipsis">
  192. Overview
  193. </span>
  194. </a>
  195. </li>
  196. <li class="md-nav__item">
  197. <a href="../../introduction/getting-started/" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. Getting started
  200. </span>
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="../../introduction/faq/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. FAQ
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../introduction/stability-support/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Stability and Support
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Deprecation Policy
  221. </span>
  222. </a>
  223. </li>
  224. </ul>
  225. </nav>
  226. </li>
  227. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  229. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  230. <span class="md-ellipsis">
  231. API
  232. </span>
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  236. <label class="md-nav__title" for="__nav_2">
  237. <span class="md-nav__icon md-icon"></span>
  238. API
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../components/" class="md-nav__link">
  243. <span class="md-ellipsis">
  244. Components
  245. </span>
  246. </a>
  247. </li>
  248. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  249. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" checked>
  250. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  251. <span class="md-ellipsis">
  252. Core Resources
  253. </span>
  254. <span class="md-nav__icon md-icon"></span>
  255. </label>
  256. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="true">
  257. <label class="md-nav__title" for="__nav_2_2">
  258. <span class="md-nav__icon md-icon"></span>
  259. Core Resources
  260. </label>
  261. <ul class="md-nav__list" data-md-scrollfix>
  262. <li class="md-nav__item md-nav__item--active">
  263. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  264. <label class="md-nav__link md-nav__link--active" for="__toc">
  265. <span class="md-ellipsis">
  266. ExternalSecret
  267. </span>
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. <a href="./" class="md-nav__link md-nav__link--active">
  271. <span class="md-ellipsis">
  272. ExternalSecret
  273. </span>
  274. </a>
  275. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  276. <label class="md-nav__title" for="__toc">
  277. <span class="md-nav__icon md-icon"></span>
  278. Table of contents
  279. </label>
  280. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  281. <li class="md-nav__item">
  282. <a href="#template" class="md-nav__link">
  283. <span class="md-ellipsis">
  284. Template
  285. </span>
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="#update-behavior" class="md-nav__link">
  290. <span class="md-ellipsis">
  291. Update Behavior
  292. </span>
  293. </a>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="#features" class="md-nav__link">
  297. <span class="md-ellipsis">
  298. Features
  299. </span>
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="#example" class="md-nav__link">
  304. <span class="md-ellipsis">
  305. Example
  306. </span>
  307. </a>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="../secretstore/" class="md-nav__link">
  314. <span class="md-ellipsis">
  315. SecretStore
  316. </span>
  317. </a>
  318. </li>
  319. <li class="md-nav__item">
  320. <a href="../clustersecretstore/" class="md-nav__link">
  321. <span class="md-ellipsis">
  322. ClusterSecretStore
  323. </span>
  324. </a>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="../clusterexternalsecret/" class="md-nav__link">
  328. <span class="md-ellipsis">
  329. ClusterExternalSecret
  330. </span>
  331. </a>
  332. </li>
  333. <li class="md-nav__item">
  334. <a href="../pushsecret/" class="md-nav__link">
  335. <span class="md-ellipsis">
  336. PushSecret
  337. </span>
  338. </a>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  345. <div class="md-nav__link md-nav__container">
  346. <a href="../generator/" class="md-nav__link ">
  347. <span class="md-ellipsis">
  348. Generators
  349. </span>
  350. </a>
  351. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  352. <span class="md-nav__icon md-icon"></span>
  353. </label>
  354. </div>
  355. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  356. <label class="md-nav__title" for="__nav_2_3">
  357. <span class="md-nav__icon md-icon"></span>
  358. Generators
  359. </label>
  360. <ul class="md-nav__list" data-md-scrollfix>
  361. <li class="md-nav__item">
  362. <a href="../generator/acr/" class="md-nav__link">
  363. <span class="md-ellipsis">
  364. Azure Container Registry
  365. </span>
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="../generator/ecr/" class="md-nav__link">
  370. <span class="md-ellipsis">
  371. AWS Elastic Container Registry
  372. </span>
  373. </a>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../generator/gcr/" class="md-nav__link">
  377. <span class="md-ellipsis">
  378. Google Container Registry
  379. </span>
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="../generator/vault/" class="md-nav__link">
  384. <span class="md-ellipsis">
  385. Vault Dynamic Secret
  386. </span>
  387. </a>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="../generator/password/" class="md-nav__link">
  391. <span class="md-ellipsis">
  392. Password
  393. </span>
  394. </a>
  395. </li>
  396. <li class="md-nav__item">
  397. <a href="../generator/fake/" class="md-nav__link">
  398. <span class="md-ellipsis">
  399. Fake
  400. </span>
  401. </a>
  402. </li>
  403. <li class="md-nav__item">
  404. <a href="../generator/webhook/" class="md-nav__link">
  405. <span class="md-ellipsis">
  406. Webhook
  407. </span>
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../generator/github/" class="md-nav__link">
  412. <span class="md-ellipsis">
  413. Github
  414. </span>
  415. </a>
  416. </li>
  417. </ul>
  418. </nav>
  419. </li>
  420. <li class="md-nav__item md-nav__item--nested">
  421. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  422. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  423. <span class="md-ellipsis">
  424. Reference Docs
  425. </span>
  426. <span class="md-nav__icon md-icon"></span>
  427. </label>
  428. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  429. <label class="md-nav__title" for="__nav_2_4">
  430. <span class="md-nav__icon md-icon"></span>
  431. Reference Docs
  432. </label>
  433. <ul class="md-nav__list" data-md-scrollfix>
  434. <li class="md-nav__item">
  435. <a href="../spec/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. API specification
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../controller-options/" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. Controller Options
  445. </span>
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../metrics/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. Metrics
  452. </span>
  453. </a>
  454. </li>
  455. </ul>
  456. </nav>
  457. </li>
  458. </ul>
  459. </nav>
  460. </li>
  461. <li class="md-nav__item md-nav__item--nested">
  462. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  463. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  464. <span class="md-ellipsis">
  465. Guides
  466. </span>
  467. <span class="md-nav__icon md-icon"></span>
  468. </label>
  469. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  470. <label class="md-nav__title" for="__nav_3">
  471. <span class="md-nav__icon md-icon"></span>
  472. Guides
  473. </label>
  474. <ul class="md-nav__list" data-md-scrollfix>
  475. <li class="md-nav__item">
  476. <a href="../../guides/introduction/" class="md-nav__link">
  477. <span class="md-ellipsis">
  478. Introduction
  479. </span>
  480. </a>
  481. </li>
  482. <li class="md-nav__item md-nav__item--nested">
  483. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  484. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  485. <span class="md-ellipsis">
  486. External Secrets
  487. </span>
  488. <span class="md-nav__icon md-icon"></span>
  489. </label>
  490. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  491. <label class="md-nav__title" for="__nav_3_2">
  492. <span class="md-nav__icon md-icon"></span>
  493. External Secrets
  494. </label>
  495. <ul class="md-nav__list" data-md-scrollfix>
  496. <li class="md-nav__item">
  497. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  498. <span class="md-ellipsis">
  499. Extract structured data
  500. </span>
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../guides/getallsecrets/" class="md-nav__link">
  505. <span class="md-ellipsis">
  506. Find Secrets by Name or Metadata
  507. </span>
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  512. <span class="md-ellipsis">
  513. Rewriting Keys
  514. </span>
  515. </a>
  516. </li>
  517. <li class="md-nav__item md-nav__item--nested">
  518. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  519. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  520. <span class="md-ellipsis">
  521. Advanced Templating
  522. </span>
  523. <span class="md-nav__icon md-icon"></span>
  524. </label>
  525. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  526. <label class="md-nav__title" for="__nav_3_2_4">
  527. <span class="md-nav__icon md-icon"></span>
  528. Advanced Templating
  529. </label>
  530. <ul class="md-nav__list" data-md-scrollfix>
  531. <li class="md-nav__item">
  532. <a href="../../guides/templating/" class="md-nav__link">
  533. <span class="md-ellipsis">
  534. v2
  535. </span>
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../../guides/templating-v1/" class="md-nav__link">
  540. <span class="md-ellipsis">
  541. v1
  542. </span>
  543. </a>
  544. </li>
  545. </ul>
  546. </nav>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  550. <span class="md-ellipsis">
  551. Kubernetes Secret Types
  552. </span>
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  557. <span class="md-ellipsis">
  558. Lifecycle: ownership & deletion
  559. </span>
  560. </a>
  561. </li>
  562. <li class="md-nav__item">
  563. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  564. <span class="md-ellipsis">
  565. Decoding Strategies
  566. </span>
  567. </a>
  568. </li>
  569. <li class="md-nav__item">
  570. <a href="../../guides/controller-class/" class="md-nav__link">
  571. <span class="md-ellipsis">
  572. Controller Classes
  573. </span>
  574. </a>
  575. </li>
  576. </ul>
  577. </nav>
  578. </li>
  579. <li class="md-nav__item">
  580. <a href="../../guides/generator/" class="md-nav__link">
  581. <span class="md-ellipsis">
  582. Generators
  583. </span>
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../guides/pushsecrets/" class="md-nav__link">
  588. <span class="md-ellipsis">
  589. Push Secrets
  590. </span>
  591. </a>
  592. </li>
  593. <li class="md-nav__item md-nav__item--nested">
  594. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  595. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  596. <span class="md-ellipsis">
  597. Operations
  598. </span>
  599. <span class="md-nav__icon md-icon"></span>
  600. </label>
  601. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  602. <label class="md-nav__title" for="__nav_3_5">
  603. <span class="md-nav__icon md-icon"></span>
  604. Operations
  605. </label>
  606. <ul class="md-nav__list" data-md-scrollfix>
  607. <li class="md-nav__item">
  608. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  609. <span class="md-ellipsis">
  610. Multi Tenancy
  611. </span>
  612. </a>
  613. </li>
  614. <li class="md-nav__item">
  615. <a href="../../guides/security-best-practices/" class="md-nav__link">
  616. <span class="md-ellipsis">
  617. Security Best Practices
  618. </span>
  619. </a>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../../guides/threat-model/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. Threat Model
  625. </span>
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../../guides/v1beta1/" class="md-nav__link">
  630. <span class="md-ellipsis">
  631. Upgrading to v1beta1
  632. </span>
  633. </a>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../../guides/using-latest-image/" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. Using Latest Image
  639. </span>
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  644. <span class="md-ellipsis">
  645. Disable Cluster Features
  646. </span>
  647. </a>
  648. </li>
  649. </ul>
  650. </nav>
  651. </li>
  652. </ul>
  653. </nav>
  654. </li>
  655. <li class="md-nav__item md-nav__item--nested">
  656. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  657. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  658. <span class="md-ellipsis">
  659. Provider
  660. </span>
  661. <span class="md-nav__icon md-icon"></span>
  662. </label>
  663. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  664. <label class="md-nav__title" for="__nav_4">
  665. <span class="md-nav__icon md-icon"></span>
  666. Provider
  667. </label>
  668. <ul class="md-nav__list" data-md-scrollfix>
  669. <li class="md-nav__item">
  670. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  671. <span class="md-ellipsis">
  672. AWS Secrets Manager
  673. </span>
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  678. <span class="md-ellipsis">
  679. AWS Parameter Store
  680. </span>
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  685. <span class="md-ellipsis">
  686. Azure Key Vault
  687. </span>
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  692. <span class="md-ellipsis">
  693. Bitwarden Secrets Manager
  694. </span>
  695. </a>
  696. </li>
  697. <li class="md-nav__item">
  698. <a href="../../provider/chef/" class="md-nav__link">
  699. <span class="md-ellipsis">
  700. Chef
  701. </span>
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../../provider/conjur/" class="md-nav__link">
  706. <span class="md-ellipsis">
  707. CyberArk Conjur
  708. </span>
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="../../provider/device42/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. Device42
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. Google Cloud Secret Manager
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. HashiCorp Vault
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="../../provider/kubernetes/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. Kubernetes
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. IBM Secrets Manager
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../provider/akeyless/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Akeyless
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Yandex Certificate Manager
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Yandex Lockbox
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../../provider/alibaba/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Alibaba Cloud
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. GitLab Variables
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../../provider/oracle-vault/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. Oracle Vault
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../../provider/1password-automation/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. 1Password Secrets Automation
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../provider/webhook/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. Webhook
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../../provider/fake/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Fake
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. senhasegura DevOps Secrets Management (DSM)
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../../provider/doppler/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. Doppler
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="../../provider/keeper-security/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Keeper Security
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="../../provider/cloak/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Cloak End 2 End Encrypted Secrets
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../../provider/scaleway/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. Scaleway
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="../../provider/delinea/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Delinea
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="../../provider/delinea/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. Delinea
  855. </span>
  856. </a>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="../../provider/passbolt/" class="md-nav__link">
  860. <span class="md-ellipsis">
  861. Passbolt
  862. </span>
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="../../provider/pulumi/" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. Pulumi ESC
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="../../provider/onboardbase/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. Onboardbase
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="../../provider-passworddepot/" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. Password Depot
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="../../provider/fortanix/" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. Fortanix
  890. </span>
  891. </a>
  892. </li>
  893. <li class="md-nav__item">
  894. <a href="../../provider/infisical/" class="md-nav__link">
  895. <span class="md-ellipsis">
  896. Infisical
  897. </span>
  898. </a>
  899. </li>
  900. </ul>
  901. </nav>
  902. </li>
  903. <li class="md-nav__item md-nav__item--nested">
  904. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  905. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  906. <span class="md-ellipsis">
  907. Examples
  908. </span>
  909. <span class="md-nav__icon md-icon"></span>
  910. </label>
  911. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  912. <label class="md-nav__title" for="__nav_5">
  913. <span class="md-nav__icon md-icon"></span>
  914. Examples
  915. </label>
  916. <ul class="md-nav__list" data-md-scrollfix>
  917. <li class="md-nav__item">
  918. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  919. <span class="md-ellipsis">
  920. FluxCD
  921. </span>
  922. </a>
  923. </li>
  924. <li class="md-nav__item">
  925. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  926. <span class="md-ellipsis">
  927. Anchore Engine
  928. </span>
  929. </a>
  930. </li>
  931. <li class="md-nav__item">
  932. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  933. <span class="md-ellipsis">
  934. Jenkins
  935. </span>
  936. </a>
  937. </li>
  938. <li class="md-nav__item">
  939. <a href="../../examples/bitwarden/" class="md-nav__link">
  940. <span class="md-ellipsis">
  941. BitWarden
  942. </span>
  943. </a>
  944. </li>
  945. </ul>
  946. </nav>
  947. </li>
  948. <li class="md-nav__item md-nav__item--nested">
  949. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  950. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  951. <span class="md-ellipsis">
  952. Community
  953. </span>
  954. <span class="md-nav__icon md-icon"></span>
  955. </label>
  956. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  957. <label class="md-nav__title" for="__nav_6">
  958. <span class="md-nav__icon md-icon"></span>
  959. Community
  960. </label>
  961. <ul class="md-nav__list" data-md-scrollfix>
  962. <li class="md-nav__item md-nav__item--nested">
  963. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  964. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  965. <span class="md-ellipsis">
  966. Contributing
  967. </span>
  968. <span class="md-nav__icon md-icon"></span>
  969. </label>
  970. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  971. <label class="md-nav__title" for="__nav_6_1">
  972. <span class="md-nav__icon md-icon"></span>
  973. Contributing
  974. </label>
  975. <ul class="md-nav__list" data-md-scrollfix>
  976. <li class="md-nav__item">
  977. <a href="../../contributing/devguide/" class="md-nav__link">
  978. <span class="md-ellipsis">
  979. Developer guide
  980. </span>
  981. </a>
  982. </li>
  983. <li class="md-nav__item">
  984. <a href="../../contributing/process/" class="md-nav__link">
  985. <span class="md-ellipsis">
  986. Contributing Process
  987. </span>
  988. </a>
  989. </li>
  990. <li class="md-nav__item">
  991. <a href="../../contributing/release/" class="md-nav__link">
  992. <span class="md-ellipsis">
  993. Release Process
  994. </span>
  995. </a>
  996. </li>
  997. <li class="md-nav__item">
  998. <a href="../../contributing/coc/" class="md-nav__link">
  999. <span class="md-ellipsis">
  1000. Code of Conduct
  1001. </span>
  1002. </a>
  1003. </li>
  1004. <li class="md-nav__item">
  1005. <a href="../../contributing/roadmap/" class="md-nav__link">
  1006. <span class="md-ellipsis">
  1007. Roadmap
  1008. </span>
  1009. </a>
  1010. </li>
  1011. </ul>
  1012. </nav>
  1013. </li>
  1014. <li class="md-nav__item md-nav__item--nested">
  1015. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1016. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1017. <span class="md-ellipsis">
  1018. External Resources
  1019. </span>
  1020. <span class="md-nav__icon md-icon"></span>
  1021. </label>
  1022. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1023. <label class="md-nav__title" for="__nav_6_2">
  1024. <span class="md-nav__icon md-icon"></span>
  1025. External Resources
  1026. </label>
  1027. <ul class="md-nav__list" data-md-scrollfix>
  1028. <li class="md-nav__item">
  1029. <a href="../../eso-talks/" class="md-nav__link">
  1030. <span class="md-ellipsis">
  1031. Talks
  1032. </span>
  1033. </a>
  1034. </li>
  1035. <li class="md-nav__item">
  1036. <a href="../../eso-demos/" class="md-nav__link">
  1037. <span class="md-ellipsis">
  1038. Demos
  1039. </span>
  1040. </a>
  1041. </li>
  1042. <li class="md-nav__item">
  1043. <a href="../../eso-blogs/" class="md-nav__link">
  1044. <span class="md-ellipsis">
  1045. Blogs
  1046. </span>
  1047. </a>
  1048. </li>
  1049. </ul>
  1050. </nav>
  1051. </li>
  1052. </ul>
  1053. </nav>
  1054. </li>
  1055. <li class="md-nav__item md-nav__item--nested">
  1056. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1057. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1058. <span class="md-ellipsis">
  1059. References
  1060. </span>
  1061. <span class="md-nav__icon md-icon"></span>
  1062. </label>
  1063. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1064. <label class="md-nav__title" for="__nav_7">
  1065. <span class="md-nav__icon md-icon"></span>
  1066. References
  1067. </label>
  1068. <ul class="md-nav__list" data-md-scrollfix>
  1069. <li class="md-nav__item">
  1070. <a href="../../spec/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. API specification
  1073. </span>
  1074. </a>
  1075. </li>
  1076. </ul>
  1077. </nav>
  1078. </li>
  1079. </ul>
  1080. </nav>
  1081. </div>
  1082. </div>
  1083. </div>
  1084. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1085. <div class="md-sidebar__scrollwrap">
  1086. <div class="md-sidebar__inner">
  1087. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1088. <label class="md-nav__title" for="__toc">
  1089. <span class="md-nav__icon md-icon"></span>
  1090. Table of contents
  1091. </label>
  1092. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1093. <li class="md-nav__item">
  1094. <a href="#template" class="md-nav__link">
  1095. <span class="md-ellipsis">
  1096. Template
  1097. </span>
  1098. </a>
  1099. </li>
  1100. <li class="md-nav__item">
  1101. <a href="#update-behavior" class="md-nav__link">
  1102. <span class="md-ellipsis">
  1103. Update Behavior
  1104. </span>
  1105. </a>
  1106. </li>
  1107. <li class="md-nav__item">
  1108. <a href="#features" class="md-nav__link">
  1109. <span class="md-ellipsis">
  1110. Features
  1111. </span>
  1112. </a>
  1113. </li>
  1114. <li class="md-nav__item">
  1115. <a href="#example" class="md-nav__link">
  1116. <span class="md-ellipsis">
  1117. Example
  1118. </span>
  1119. </a>
  1120. </li>
  1121. </ul>
  1122. </nav>
  1123. </div>
  1124. </div>
  1125. </div>
  1126. <div class="md-content" data-md-component="content">
  1127. <article class="md-content__inner md-typeset">
  1128. <h1>ExternalSecret</h1>
  1129. <p>The <code>ExternalSecret</code> describes what data should be fetched, how the data should
  1130. be transformed and saved as a <code>Kind=Secret</code>:</p>
  1131. <ul>
  1132. <li>tells the operator what secrets should be synced by using <code>spec.data</code> to
  1133. explicitly sync individual keys or use <code>spec.dataFrom</code> to get <strong>all values</strong>
  1134. from the external API.</li>
  1135. <li>you can specify how the secret should look like by specifying a
  1136. <code>spec.target.template</code></li>
  1137. </ul>
  1138. <h2 id="template">Template</h2>
  1139. <p>When the controller reconciles the <code>ExternalSecret</code> it will use the <code>spec.template</code> as a blueprint to construct a new <code>Kind=Secret</code>. You can use golang templates to define the blueprint and use template functions to transform secret values. You can also pull in <code>ConfigMaps</code> that contain golang-template data using <code>templateFrom</code>. See <a href="../../guides/templating/">advanced templating</a> for details.</p>
  1140. <h2 id="update-behavior">Update Behavior</h2>
  1141. <p>The <code>Kind=Secret</code> is updated when:</p>
  1142. <ul>
  1143. <li>the <code>spec.refreshInterval</code> has passed and is not <code>0</code></li>
  1144. <li>the <code>ExternalSecret</code>'s <code>labels</code> or <code>annotations</code> are changed</li>
  1145. <li>the <code>ExternalSecret</code>'s <code>spec</code> has been changed</li>
  1146. </ul>
  1147. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client:</p>
  1148. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  1149. </code></pre></div>
  1150. <h2 id="features">Features</h2>
  1151. <p>Individual features are described in the <a href="../../guides/introduction/">Guides section</a>:</p>
  1152. <ul>
  1153. <li><a href="../../guides/getallsecrets/">Find many secrets / Extract from structured data</a></li>
  1154. <li><a href="../../guides/templating/">Templating</a></li>
  1155. <li><a href="../../guides/generator/">Using Generators</a></li>
  1156. <li><a href="../../guides/ownership-deletion-policy/">Secret Ownership and Deletion</a></li>
  1157. <li><a href="../../guides/datafrom-rewrite/">Key Rewriting</a></li>
  1158. <li><a href="../../guides/decoding-strategy/">Decoding Strategy</a></li>
  1159. </ul>
  1160. <h2 id="example">Example</h2>
  1161. <p>Take a look at an annotated example to understand the design behind the
  1162. <code>ExternalSecret</code>.</p>
  1163. <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>
  1164. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1165. <span class="nt">metadata</span><span class="p">:</span>
  1166. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;hello-world&quot;</span>
  1167. <span class="w"> </span><span class="c1"># labels and annotations are copied over to the</span>
  1168. <span class="w"> </span><span class="c1"># secret that will be created</span>
  1169. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
  1170. <span class="w"> </span><span class="nt">acme.org/owned-by</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;q-team&quot;</span>
  1171. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1172. <span class="w"> </span><span class="nt">acme.org/sha</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1234</span>
  1173. <span class="nt">spec</span><span class="p">:</span>
  1174. <span class="w"> </span><span class="c1"># Optional, SecretStoreRef defines the default SecretStore to use when fetching the secret data.</span>
  1175. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1176. <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">aws-store</span>
  1177. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"> </span><span class="c1"># or ClusterSecretStore</span>
  1178. <span class="w"> </span><span class="c1"># RefreshInterval is the amount of time before the values reading again from the SecretStore provider</span>
  1179. <span class="w"> </span><span class="c1"># Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot; (from time.ParseDuration)</span>
  1180. <span class="w"> </span><span class="c1"># May be set to zero to fetch and create it once</span>
  1181. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1h&quot;</span>
  1182. <span class="w"> </span><span class="c1"># the target describes the secret that shall be created</span>
  1183. <span class="w"> </span><span class="c1"># there can only be one target per ExternalSecret</span>
  1184. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1185. <span class="w"> </span><span class="c1"># The secret name of the resource</span>
  1186. <span class="w"> </span><span class="c1"># Defaults to .metadata.name of the ExternalSecret</span>
  1187. <span class="w"> </span><span class="c1"># It is immutable</span>
  1188. <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">application-config</span>
  1189. <span class="w"> </span><span class="c1"># Enum with values: &#39;Owner&#39;, &#39;Merge&#39;, or &#39;None&#39;</span>
  1190. <span class="w"> </span><span class="c1"># Default value of &#39;Owner&#39;</span>
  1191. <span class="w"> </span><span class="c1"># Owner creates the secret and sets .metadata.ownerReferences of the resource</span>
  1192. <span class="w"> </span><span class="c1"># Merge does not create the secret, but merges in the data fields to the secret</span>
  1193. <span class="w"> </span><span class="c1"># None does not create a secret (future use with injector)</span>
  1194. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;Merge&#39;</span>
  1195. <span class="w"> </span><span class="c1"># DeletionPolicy defines how/when to delete the Secret in Kubernetes</span>
  1196. <span class="w"> </span><span class="c1"># if the provider secret gets deleted.</span>
  1197. <span class="w"> </span><span class="c1"># Valid values are Delete, Merge, Retain</span>
  1198. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Retain&quot;</span>
  1199. <span class="w"> </span><span class="c1"># Specify a blueprint for the resulting Kind=Secret</span>
  1200. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1201. <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">kubernetes.io/dockerconfigjson</span><span class="w"> </span><span class="c1"># or TLS...</span>
  1202. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1203. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
  1204. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
  1205. <span class="w"> </span><span class="c1"># Use inline templates to construct your desired config file that contains your secret</span>
  1206. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1207. <span class="w"> </span><span class="nt">config.yml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
  1208. <span class="w"> </span><span class="no">database:</span>
  1209. <span class="w"> </span><span class="no">connection: postgres://{{ .username }}:{{ .password }}@{{ .database_host }}:5432/payments</span>
  1210. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span>
  1211. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  1212. <span class="w"> </span><span class="c1"># It does not update the configmap, it creates a secret with: data[&quot;alertmanager.yml&quot;] = ...result...</span>
  1213. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1214. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1215. <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">application-config-tmpl</span>
  1216. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1217. <span class="w"> </span><span class="p p-Indicator">-</span><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">config.yml</span>
  1218. <span class="w"> </span><span class="c1"># Data defines the connection between the Kubernetes Secret keys and the Provider data</span>
  1219. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1220. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span>
  1221. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</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">database-credentials</span>
  1223. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1224. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span>
  1225. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span><span class="w"> </span><span class="c1"># can be None, Base64, Base64URL or Auto</span>
  1226. <span class="w"> </span><span class="c1"># define the source of the secret. Can be a SecretStore or a Generator kind</span>
  1227. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1228. <span class="w"> </span><span class="c1"># point to a SecretStore that should be used to fetch a secret.</span>
  1229. <span class="w"> </span><span class="c1"># must be defined if no spec.secretStoreRef is defined.</span>
  1230. <span class="w"> </span><span class="nt">storeRef</span><span class="p">:</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">aws-secretstore</span>
  1232. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1233. <span class="w"> </span><span class="c1"># Used to fetch all properties from the Provider key</span>
  1234. <span class="w"> </span><span class="c1"># If multiple dataFrom are specified, secrets are merged in the specified order</span>
  1235. <span class="w"> </span><span class="c1"># Can be defined using sourceRef.generatorRef or extract / find</span>
  1236. <span class="w"> </span><span class="c1"># Both use cases are exemplified below</span>
  1237. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1238. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span>
  1239. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span>
  1240. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">generators.external-secrets.io/v1alpha1</span>
  1241. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ECRAuthorizationToken</span>
  1242. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-ecr&quot;</span>
  1243. <span class="w"> </span><span class="c1">#Or</span>
  1244. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1245. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1246. <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">database-credentials</span>
  1247. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1248. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">data</span>
  1249. <span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Default</span>
  1250. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Auto</span>
  1251. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1252. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1253. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;exp-(.*?)-ression&quot;</span>
  1254. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;rewriting-${1}-with-groups&quot;</span>
  1255. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span>
  1256. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path-to-filter</span>
  1257. <span class="w"> </span><span class="nt">name</span><span class="p">:</span>
  1258. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;.*foobar.*&quot;</span>
  1259. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span>
  1260. <span class="w"> </span><span class="nt">foo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bar</span>
  1261. <span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Unicode</span>
  1262. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Base64</span>
  1263. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span>
  1264. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span>
  1265. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
  1266. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
  1267. <span class="nt">status</span><span class="p">:</span>
  1268. <span class="w"> </span><span class="c1"># refreshTime is the time and date the external secret was fetched and</span>
  1269. <span class="w"> </span><span class="c1"># the target secret updated</span>
  1270. <span class="w"> </span><span class="nt">refreshTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span>
  1271. <span class="w"> </span><span class="c1"># Standard condition schema</span>
  1272. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  1273. <span class="w"> </span><span class="c1"># ExternalSecret ready condition indicates the secret is ready for use.</span>
  1274. <span class="w"> </span><span class="c1"># This is defined as:</span>
  1275. <span class="w"> </span><span class="c1"># - The target secret exists</span>
  1276. <span class="w"> </span><span class="c1"># - The target secret has been refreshed within the last refreshInterval</span>
  1277. <span class="w"> </span><span class="c1"># - The target secret content is up-to-date based on any target templates</span>
  1278. <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>
  1279. <span class="w"> </span><span class="nt">status</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;True&quot;</span><span class="w"> </span><span class="c1"># False if last refresh was not successful</span>
  1280. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecretSynced&quot;</span>
  1281. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Secret</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">synced&quot;</span>
  1282. <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>
  1283. </code></pre></div>
  1284. </article>
  1285. </div>
  1286. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1287. </div>
  1288. </main>
  1289. <footer class="md-footer">
  1290. <div class="md-footer-meta md-typeset">
  1291. <div class="md-footer-meta__inner md-grid">
  1292. <div class="md-copyright">
  1293. <div class="md-copyright__highlight">
  1294. &copy; 2024 The external-secrets Authors.<br/>
  1295. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1296. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1297. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1298. </div>
  1299. Made with
  1300. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1301. Material for MkDocs
  1302. </a>
  1303. </div>
  1304. </div>
  1305. </div>
  1306. </footer>
  1307. </div>
  1308. <div class="md-dialog" data-md-component="dialog">
  1309. <div class="md-dialog__inner md-typeset"></div>
  1310. </div>
  1311. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.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>
  1312. <script src="../../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
  1313. </body>
  1314. </html>