index.html 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114
  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="../getting-started/">
  7. <link rel="next" href="../stability-support/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.7">
  10. <title>FAQ - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.f2e4d321.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="#can-i-manually-trigger-a-secret-refresh" 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. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  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. FAQ
  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" 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.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 2023 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 md-tabs__item--active">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/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. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.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 2023 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>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  168. <div class="md-nav__link md-nav__container">
  169. <a href="../.." class="md-nav__link ">
  170. <span class="md-ellipsis">
  171. Introduction
  172. </span>
  173. </a>
  174. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
  175. <span class="md-nav__icon md-icon"></span>
  176. </label>
  177. </div>
  178. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  179. <label class="md-nav__title" for="__nav_1">
  180. <span class="md-nav__icon md-icon"></span>
  181. Introduction
  182. </label>
  183. <ul class="md-nav__list" data-md-scrollfix>
  184. <li class="md-nav__item">
  185. <a href="../overview/" class="md-nav__link">
  186. <span class="md-ellipsis">
  187. Overview
  188. </span>
  189. </a>
  190. </li>
  191. <li class="md-nav__item">
  192. <a href="../getting-started/" class="md-nav__link">
  193. <span class="md-ellipsis">
  194. Getting started
  195. </span>
  196. </a>
  197. </li>
  198. <li class="md-nav__item md-nav__item--active">
  199. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  200. <label class="md-nav__link md-nav__link--active" for="__toc">
  201. <span class="md-ellipsis">
  202. FAQ
  203. </span>
  204. <span class="md-nav__icon md-icon"></span>
  205. </label>
  206. <a href="./" class="md-nav__link md-nav__link--active">
  207. <span class="md-ellipsis">
  208. FAQ
  209. </span>
  210. </a>
  211. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  212. <label class="md-nav__title" for="__toc">
  213. <span class="md-nav__icon md-icon"></span>
  214. Table of contents
  215. </label>
  216. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  217. <li class="md-nav__item">
  218. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Can I manually trigger a secret refresh?
  221. </span>
  222. </a>
  223. </li>
  224. <li class="md-nav__item">
  225. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  226. <span class="md-ellipsis">
  227. How do I know when my secret was last synced?
  228. </span>
  229. </a>
  230. </li>
  231. <li class="md-nav__item">
  232. <a href="#how-do-i-know-when-the-status-of-my-secret-changed-the-last-time" class="md-nav__link">
  233. <span class="md-ellipsis">
  234. How do I know when the status of my secret changed the last time?
  235. </span>
  236. </a>
  237. </li>
  238. <li class="md-nav__item">
  239. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  240. <span class="md-ellipsis">
  241. Differences to csi-secret-store
  242. </span>
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  247. <span class="md-ellipsis">
  248. How do I debug an external-secret that doesn't sync?
  249. </span>
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  254. <span class="md-ellipsis">
  255. Upgrading from KES to ESO
  256. </span>
  257. </a>
  258. </li>
  259. </ul>
  260. </nav>
  261. </li>
  262. <li class="md-nav__item">
  263. <a href="../stability-support/" class="md-nav__link">
  264. <span class="md-ellipsis">
  265. Stability and Support
  266. </span>
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="../deprecation-policy/" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. Deprecation Policy
  273. </span>
  274. </a>
  275. </li>
  276. </ul>
  277. </nav>
  278. </li>
  279. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  280. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  281. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  282. <span class="md-ellipsis">
  283. API
  284. </span>
  285. <span class="md-nav__icon md-icon"></span>
  286. </label>
  287. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  288. <label class="md-nav__title" for="__nav_2">
  289. <span class="md-nav__icon md-icon"></span>
  290. API
  291. </label>
  292. <ul class="md-nav__list" data-md-scrollfix>
  293. <li class="md-nav__item">
  294. <a href="../../api/components/" class="md-nav__link">
  295. <span class="md-ellipsis">
  296. Components
  297. </span>
  298. </a>
  299. </li>
  300. <li class="md-nav__item md-nav__item--nested">
  301. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  302. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  303. <span class="md-ellipsis">
  304. Core Resources
  305. </span>
  306. <span class="md-nav__icon md-icon"></span>
  307. </label>
  308. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  309. <label class="md-nav__title" for="__nav_2_2">
  310. <span class="md-nav__icon md-icon"></span>
  311. Core Resources
  312. </label>
  313. <ul class="md-nav__list" data-md-scrollfix>
  314. <li class="md-nav__item">
  315. <a href="../../api/externalsecret/" class="md-nav__link">
  316. <span class="md-ellipsis">
  317. ExternalSecret
  318. </span>
  319. </a>
  320. </li>
  321. <li class="md-nav__item">
  322. <a href="../../api/secretstore/" class="md-nav__link">
  323. <span class="md-ellipsis">
  324. SecretStore
  325. </span>
  326. </a>
  327. </li>
  328. <li class="md-nav__item">
  329. <a href="../../api/clustersecretstore/" class="md-nav__link">
  330. <span class="md-ellipsis">
  331. ClusterSecretStore
  332. </span>
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  337. <span class="md-ellipsis">
  338. ClusterExternalSecret
  339. </span>
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="../../api/pushsecret/" class="md-nav__link">
  344. <span class="md-ellipsis">
  345. PushSecret
  346. </span>
  347. </a>
  348. </li>
  349. </ul>
  350. </nav>
  351. </li>
  352. <li class="md-nav__item md-nav__item--nested">
  353. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  354. <div class="md-nav__link md-nav__container">
  355. <a href="../../api/generator/" class="md-nav__link ">
  356. <span class="md-ellipsis">
  357. Generators
  358. </span>
  359. </a>
  360. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  361. <span class="md-nav__icon md-icon"></span>
  362. </label>
  363. </div>
  364. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  365. <label class="md-nav__title" for="__nav_2_3">
  366. <span class="md-nav__icon md-icon"></span>
  367. Generators
  368. </label>
  369. <ul class="md-nav__list" data-md-scrollfix>
  370. <li class="md-nav__item">
  371. <a href="../../api/generator/acr/" class="md-nav__link">
  372. <span class="md-ellipsis">
  373. Azure Container Registry
  374. </span>
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../../api/generator/ecr/" class="md-nav__link">
  379. <span class="md-ellipsis">
  380. AWS Elastic Container Registry
  381. </span>
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="../../api/generator/gcr/" class="md-nav__link">
  386. <span class="md-ellipsis">
  387. Google Container Registry
  388. </span>
  389. </a>
  390. </li>
  391. <li class="md-nav__item">
  392. <a href="../../api/generator/vault/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. Vault Dynamic Secret
  395. </span>
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../../api/generator/password/" class="md-nav__link">
  400. <span class="md-ellipsis">
  401. Password
  402. </span>
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../api/generator/fake/" class="md-nav__link">
  407. <span class="md-ellipsis">
  408. Fake
  409. </span>
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. <li class="md-nav__item md-nav__item--nested">
  416. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  417. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  418. <span class="md-ellipsis">
  419. Reference Docs
  420. </span>
  421. <span class="md-nav__icon md-icon"></span>
  422. </label>
  423. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  424. <label class="md-nav__title" for="__nav_2_4">
  425. <span class="md-nav__icon md-icon"></span>
  426. Reference Docs
  427. </label>
  428. <ul class="md-nav__list" data-md-scrollfix>
  429. <li class="md-nav__item">
  430. <a href="../../api/spec/" class="md-nav__link">
  431. <span class="md-ellipsis">
  432. API specification
  433. </span>
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../../api/controller-options/" class="md-nav__link">
  438. <span class="md-ellipsis">
  439. Controller Options
  440. </span>
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../api/metrics/" class="md-nav__link">
  445. <span class="md-ellipsis">
  446. Metrics
  447. </span>
  448. </a>
  449. </li>
  450. </ul>
  451. </nav>
  452. </li>
  453. </ul>
  454. </nav>
  455. </li>
  456. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  457. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  458. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  459. <span class="md-ellipsis">
  460. Guides
  461. </span>
  462. <span class="md-nav__icon md-icon"></span>
  463. </label>
  464. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  465. <label class="md-nav__title" for="__nav_3">
  466. <span class="md-nav__icon md-icon"></span>
  467. Guides
  468. </label>
  469. <ul class="md-nav__list" data-md-scrollfix>
  470. <li class="md-nav__item">
  471. <a href="../../guides/introduction/" class="md-nav__link">
  472. <span class="md-ellipsis">
  473. Introduction
  474. </span>
  475. </a>
  476. </li>
  477. <li class="md-nav__item md-nav__item--nested">
  478. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  479. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  480. <span class="md-ellipsis">
  481. External Secrets
  482. </span>
  483. <span class="md-nav__icon md-icon"></span>
  484. </label>
  485. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  486. <label class="md-nav__title" for="__nav_3_2">
  487. <span class="md-nav__icon md-icon"></span>
  488. External Secrets
  489. </label>
  490. <ul class="md-nav__list" data-md-scrollfix>
  491. <li class="md-nav__item">
  492. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  493. <span class="md-ellipsis">
  494. Extract structured data
  495. </span>
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../guides/getallsecrets/" class="md-nav__link">
  500. <span class="md-ellipsis">
  501. Find Secrets by Name or Metadata
  502. </span>
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  507. <span class="md-ellipsis">
  508. Rewriting Keys
  509. </span>
  510. </a>
  511. </li>
  512. <li class="md-nav__item md-nav__item--nested">
  513. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  514. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  515. <span class="md-ellipsis">
  516. Advanced Templating
  517. </span>
  518. <span class="md-nav__icon md-icon"></span>
  519. </label>
  520. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  521. <label class="md-nav__title" for="__nav_3_2_4">
  522. <span class="md-nav__icon md-icon"></span>
  523. Advanced Templating
  524. </label>
  525. <ul class="md-nav__list" data-md-scrollfix>
  526. <li class="md-nav__item">
  527. <a href="../../guides/templating/" class="md-nav__link">
  528. <span class="md-ellipsis">
  529. v2
  530. </span>
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../guides/templating-v1/" class="md-nav__link">
  535. <span class="md-ellipsis">
  536. v1
  537. </span>
  538. </a>
  539. </li>
  540. </ul>
  541. </nav>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. Kubernetes Secret Types
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Lifecycle: ownership & deletion
  554. </span>
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  559. <span class="md-ellipsis">
  560. Decoding Strategies
  561. </span>
  562. </a>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="../../guides/controller-class/" class="md-nav__link">
  566. <span class="md-ellipsis">
  567. Controller Classes
  568. </span>
  569. </a>
  570. </li>
  571. </ul>
  572. </nav>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="../../guides/generator/" class="md-nav__link">
  576. <span class="md-ellipsis">
  577. Generators
  578. </span>
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../guides/pushsecrets/" class="md-nav__link">
  583. <span class="md-ellipsis">
  584. Push Secrets
  585. </span>
  586. </a>
  587. </li>
  588. <li class="md-nav__item md-nav__item--nested">
  589. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  590. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  591. <span class="md-ellipsis">
  592. Operations
  593. </span>
  594. <span class="md-nav__icon md-icon"></span>
  595. </label>
  596. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  597. <label class="md-nav__title" for="__nav_3_5">
  598. <span class="md-nav__icon md-icon"></span>
  599. Operations
  600. </label>
  601. <ul class="md-nav__list" data-md-scrollfix>
  602. <li class="md-nav__item">
  603. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Multi Tenancy
  606. </span>
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="../../guides/security-best-practices/" class="md-nav__link">
  611. <span class="md-ellipsis">
  612. Security Best Practices
  613. </span>
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../../guides/threat-model/" class="md-nav__link">
  618. <span class="md-ellipsis">
  619. Threat Model
  620. </span>
  621. </a>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="../../guides/v1beta1/" class="md-nav__link">
  625. <span class="md-ellipsis">
  626. Upgrading to v1beta1
  627. </span>
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="../../guides/using-latest-image/" class="md-nav__link">
  632. <span class="md-ellipsis">
  633. Using Latest Image
  634. </span>
  635. </a>
  636. </li>
  637. <li class="md-nav__item">
  638. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  639. <span class="md-ellipsis">
  640. Disable Cluster Features
  641. </span>
  642. </a>
  643. </li>
  644. </ul>
  645. </nav>
  646. </li>
  647. </ul>
  648. </nav>
  649. </li>
  650. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  651. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  652. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  653. <span class="md-ellipsis">
  654. Provider
  655. </span>
  656. <span class="md-nav__icon md-icon"></span>
  657. </label>
  658. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  659. <label class="md-nav__title" for="__nav_4">
  660. <span class="md-nav__icon md-icon"></span>
  661. Provider
  662. </label>
  663. <ul class="md-nav__list" data-md-scrollfix>
  664. <li class="md-nav__item">
  665. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  666. <span class="md-ellipsis">
  667. AWS Secrets Manager
  668. </span>
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  673. <span class="md-ellipsis">
  674. AWS Parameter Store
  675. </span>
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  680. <span class="md-ellipsis">
  681. Azure Key Vault
  682. </span>
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../../provider/conjur/" class="md-nav__link">
  687. <span class="md-ellipsis">
  688. CyberArk Conjur
  689. </span>
  690. </a>
  691. </li>
  692. <li class="md-nav__item">
  693. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  694. <span class="md-ellipsis">
  695. Google Cloud Secret Manager
  696. </span>
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  701. <span class="md-ellipsis">
  702. HashiCorp Vault
  703. </span>
  704. </a>
  705. </li>
  706. <li class="md-nav__item">
  707. <a href="../../provider/kubernetes/" class="md-nav__link">
  708. <span class="md-ellipsis">
  709. Kubernetes
  710. </span>
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  715. <span class="md-ellipsis">
  716. IBM Secrets Manager
  717. </span>
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="../../provider/akeyless/" class="md-nav__link">
  722. <span class="md-ellipsis">
  723. Akeyless
  724. </span>
  725. </a>
  726. </li>
  727. <li class="md-nav__item">
  728. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  729. <span class="md-ellipsis">
  730. Yandex Certificate Manager
  731. </span>
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  736. <span class="md-ellipsis">
  737. Yandex Lockbox
  738. </span>
  739. </a>
  740. </li>
  741. <li class="md-nav__item">
  742. <a href="../../provider/alibaba/" class="md-nav__link">
  743. <span class="md-ellipsis">
  744. Alibaba Cloud
  745. </span>
  746. </a>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  750. <span class="md-ellipsis">
  751. GitLab Variables
  752. </span>
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="../../provider/oracle-vault/" class="md-nav__link">
  757. <span class="md-ellipsis">
  758. Oracle Vault
  759. </span>
  760. </a>
  761. </li>
  762. <li class="md-nav__item">
  763. <a href="../../provider/1password-automation/" class="md-nav__link">
  764. <span class="md-ellipsis">
  765. 1Password Secrets Automation
  766. </span>
  767. </a>
  768. </li>
  769. <li class="md-nav__item">
  770. <a href="../../provider/webhook/" class="md-nav__link">
  771. <span class="md-ellipsis">
  772. Webhook
  773. </span>
  774. </a>
  775. </li>
  776. <li class="md-nav__item">
  777. <a href="../../provider/fake/" class="md-nav__link">
  778. <span class="md-ellipsis">
  779. Fake
  780. </span>
  781. </a>
  782. </li>
  783. <li class="md-nav__item">
  784. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  785. <span class="md-ellipsis">
  786. senhasegura DevOps Secrets Management (DSM)
  787. </span>
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="../../provider/doppler/" class="md-nav__link">
  792. <span class="md-ellipsis">
  793. Doppler
  794. </span>
  795. </a>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="../../provider/keeper-security/" class="md-nav__link">
  799. <span class="md-ellipsis">
  800. Keeper Security
  801. </span>
  802. </a>
  803. </li>
  804. <li class="md-nav__item">
  805. <a href="../../provider/cloak/" class="md-nav__link">
  806. <span class="md-ellipsis">
  807. Cloak End 2 End Encrypted Secrets
  808. </span>
  809. </a>
  810. </li>
  811. <li class="md-nav__item">
  812. <a href="../../provider/scaleway/" class="md-nav__link">
  813. <span class="md-ellipsis">
  814. Scaleway
  815. </span>
  816. </a>
  817. </li>
  818. <li class="md-nav__item">
  819. <a href="../../provider/delinea/" class="md-nav__link">
  820. <span class="md-ellipsis">
  821. Delinea
  822. </span>
  823. </a>
  824. </li>
  825. </ul>
  826. </nav>
  827. </li>
  828. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  829. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  830. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
  831. <span class="md-ellipsis">
  832. Examples
  833. </span>
  834. <span class="md-nav__icon md-icon"></span>
  835. </label>
  836. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  837. <label class="md-nav__title" for="__nav_5">
  838. <span class="md-nav__icon md-icon"></span>
  839. Examples
  840. </label>
  841. <ul class="md-nav__list" data-md-scrollfix>
  842. <li class="md-nav__item">
  843. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. FluxCD
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. Anchore Engine
  853. </span>
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  858. <span class="md-ellipsis">
  859. Jenkins
  860. </span>
  861. </a>
  862. </li>
  863. <li class="md-nav__item">
  864. <a href="../../examples/bitwarden/" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. BitWarden
  867. </span>
  868. </a>
  869. </li>
  870. </ul>
  871. </nav>
  872. </li>
  873. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  874. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  875. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  876. <span class="md-ellipsis">
  877. Community
  878. </span>
  879. <span class="md-nav__icon md-icon"></span>
  880. </label>
  881. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  882. <label class="md-nav__title" for="__nav_6">
  883. <span class="md-nav__icon md-icon"></span>
  884. Community
  885. </label>
  886. <ul class="md-nav__list" data-md-scrollfix>
  887. <li class="md-nav__item md-nav__item--nested">
  888. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  889. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  890. <span class="md-ellipsis">
  891. Contributing
  892. </span>
  893. <span class="md-nav__icon md-icon"></span>
  894. </label>
  895. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  896. <label class="md-nav__title" for="__nav_6_1">
  897. <span class="md-nav__icon md-icon"></span>
  898. Contributing
  899. </label>
  900. <ul class="md-nav__list" data-md-scrollfix>
  901. <li class="md-nav__item">
  902. <a href="../../contributing/devguide/" class="md-nav__link">
  903. <span class="md-ellipsis">
  904. Developer guide
  905. </span>
  906. </a>
  907. </li>
  908. <li class="md-nav__item">
  909. <a href="../../contributing/process/" class="md-nav__link">
  910. <span class="md-ellipsis">
  911. Contributing Process
  912. </span>
  913. </a>
  914. </li>
  915. <li class="md-nav__item">
  916. <a href="../../contributing/release/" class="md-nav__link">
  917. <span class="md-ellipsis">
  918. Release Process
  919. </span>
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../../contributing/coc/" class="md-nav__link">
  924. <span class="md-ellipsis">
  925. Code of Conduct
  926. </span>
  927. </a>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../../contributing/roadmap/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. Roadmap
  933. </span>
  934. </a>
  935. </li>
  936. </ul>
  937. </nav>
  938. </li>
  939. <li class="md-nav__item md-nav__item--nested">
  940. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  941. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  942. <span class="md-ellipsis">
  943. External Resources
  944. </span>
  945. <span class="md-nav__icon md-icon"></span>
  946. </label>
  947. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  948. <label class="md-nav__title" for="__nav_6_2">
  949. <span class="md-nav__icon md-icon"></span>
  950. External Resources
  951. </label>
  952. <ul class="md-nav__list" data-md-scrollfix>
  953. <li class="md-nav__item">
  954. <a href="../../eso-talks/" class="md-nav__link">
  955. <span class="md-ellipsis">
  956. Talks
  957. </span>
  958. </a>
  959. </li>
  960. <li class="md-nav__item">
  961. <a href="../../eso-demos/" class="md-nav__link">
  962. <span class="md-ellipsis">
  963. Demos
  964. </span>
  965. </a>
  966. </li>
  967. <li class="md-nav__item">
  968. <a href="../../eso-blogs/" class="md-nav__link">
  969. <span class="md-ellipsis">
  970. Blogs
  971. </span>
  972. </a>
  973. </li>
  974. </ul>
  975. </nav>
  976. </li>
  977. </ul>
  978. </nav>
  979. </li>
  980. </ul>
  981. </nav>
  982. </div>
  983. </div>
  984. </div>
  985. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  986. <div class="md-sidebar__scrollwrap">
  987. <div class="md-sidebar__inner">
  988. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  989. <label class="md-nav__title" for="__toc">
  990. <span class="md-nav__icon md-icon"></span>
  991. Table of contents
  992. </label>
  993. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  994. <li class="md-nav__item">
  995. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  996. <span class="md-ellipsis">
  997. Can I manually trigger a secret refresh?
  998. </span>
  999. </a>
  1000. </li>
  1001. <li class="md-nav__item">
  1002. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  1003. <span class="md-ellipsis">
  1004. How do I know when my secret was last synced?
  1005. </span>
  1006. </a>
  1007. </li>
  1008. <li class="md-nav__item">
  1009. <a href="#how-do-i-know-when-the-status-of-my-secret-changed-the-last-time" class="md-nav__link">
  1010. <span class="md-ellipsis">
  1011. How do I know when the status of my secret changed the last time?
  1012. </span>
  1013. </a>
  1014. </li>
  1015. <li class="md-nav__item">
  1016. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  1017. <span class="md-ellipsis">
  1018. Differences to csi-secret-store
  1019. </span>
  1020. </a>
  1021. </li>
  1022. <li class="md-nav__item">
  1023. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  1024. <span class="md-ellipsis">
  1025. How do I debug an external-secret that doesn't sync?
  1026. </span>
  1027. </a>
  1028. </li>
  1029. <li class="md-nav__item">
  1030. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  1031. <span class="md-ellipsis">
  1032. Upgrading from KES to ESO
  1033. </span>
  1034. </a>
  1035. </li>
  1036. </ul>
  1037. </nav>
  1038. </div>
  1039. </div>
  1040. </div>
  1041. <div class="md-content" data-md-component="content">
  1042. <article class="md-content__inner md-typeset">
  1043. <h1>FAQ</h1>
  1044. <h2 id="can-i-manually-trigger-a-secret-refresh">Can I manually trigger a secret refresh?</h2>
  1045. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client.
  1046. You just need to change an annotation, label or the spec of the resource:</p>
  1047. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  1048. </code></pre></div>
  1049. <h2 id="how-do-i-know-when-my-secret-was-last-synced">How do I know when my secret was last synced?</h2>
  1050. <p>The last synchronization timestamp of an ExternalSecret can be retrieved from the field <code>refreshTime</code>. </p>
  1051. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep refreshTime
  1052. refreshTime: &quot;2022-05-21T23:02:47Z&quot;
  1053. </code></pre></div>
  1054. <p>The interval can be changed by the <code>spec.refreshInterval</code> in the ExternalSecret.</p>
  1055. <h2 id="how-do-i-know-when-the-status-of-my-secret-changed-the-last-time">How do I know when the status of my secret changed the last time?</h2>
  1056. <p>Every ExternalSecret resource contains a status condition that indicates whether a secret was successfully synchronized, along with the timestamp of the last status change of the ExternalSecret (e.g. from SecretSyncedError to SecretSynced). This can be obtained from the field <code>lastTransitionTime</code>:</p>
  1057. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep condition -A 5
  1058. conditions:
  1059. - lastTransitionTime: &quot;2022-05-21T21:02:47Z&quot;
  1060. message: Secret was synced
  1061. reason: SecretSynced
  1062. status: &quot;True&quot;
  1063. type: Ready
  1064. </code></pre></div>
  1065. <h2 id="differences-to-csi-secret-store">Differences to csi-secret-store</h2>
  1066. <p>Please take a look at this <a href="https://github.com/external-secrets/external-secrets/issues/478#issuecomment-964413129">issue comment here</a>.</p>
  1067. <h2 id="how-do-i-debug-an-external-secret-that-doesnt-sync">How do I debug an external-secret that doesn't sync?</h2>
  1068. <p>First, check the status of the ExternalSecret resource using <code>kubectl describe</code>. That displays the status conditions as well as recent events.
  1069. You should expect a status condition with <code>Type=Ready</code>, <code>Status=True</code>. Further you shouldn't see any events with <code>Type=Warning</code>. Read carefully if they exist.</p>
  1070. <div class="highlight"><pre><span></span><code>kubectl describe es my-external-secret
  1071. [...]
  1072. Status:
  1073. Conditions:
  1074. Last Transition Time: 2022-05-21T21:02:47Z
  1075. Message: Secret was synced
  1076. Reason: SecretSynced
  1077. Status: True
  1078. Type: Ready
  1079. Refresh Time: 2022-05-21T21:06:47Z
  1080. Synced Resource Version: 1-5c833527afd7ba3f426cb0082ee7e083
  1081. Events:
  1082. Type Reason Age From Message
  1083. ---- ------ ---- ---- -------
  1084. Warning UpdateFailed 4m12s external-secrets secrets &quot;yyyyyyy&quot; already exists
  1085. Normal Updated 12s (x4 over 3m12s) external-secrets Updated Secret
  1086. </code></pre></div>
  1087. <p>If everything looks good you should check the corresponding secret store resource that is referenced from an ExternalSecret. Again, use <code>kubectl describe</code> to show status conditions and events and look for warning signs as described above.</p>
  1088. <p>In an ideally, the store should be validated and Ready.</p>
  1089. <div class="highlight"><pre><span></span><code>kubectl describe css kubernetes
  1090. [...]
  1091. Status:
  1092. Conditions:
  1093. Last Transition Time: 2022-05-21T21:02:47Z
  1094. Message: store validated
  1095. Reason: Valid
  1096. Status: True
  1097. Type: Ready
  1098. Events:
  1099. Type Reason Age From Message
  1100. ---- ------ ---- ---- -------
  1101. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  1102. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  1103. </code></pre></div>
  1104. <p>If everything looks normal so far, please go ahead and ensure that the created secret has the expected value. Also, take a look at the logs of the controller.</p>
  1105. <h2 id="upgrading-from-kes-to-eso">Upgrading from KES to ESO</h2>
  1106. <p>Migrating from KES to ESO is quite tricky! There is a tool we built to help users out available <a href="https://github.com/external-secrets/kes-to-eso">here</a>, and there is a small migration procedure.</p>
  1107. <p>There are some incompatibilities between KES to ESO, and while the tool tries to cover most of them, some of them will require manual intervention. We recommend to first convert the manifest files, and actually see if the tool provides a warning about any file needed to be changed.
  1108. Beware that the tool points the SecretStores to use KES Service Account, so you'll also need to tweak that if you plan to uninstall KES after the upgrade.</p>
  1109. </article>
  1110. </div>
  1111. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1112. </div>
  1113. </main>
  1114. <footer class="md-footer">
  1115. <div class="md-footer-meta md-typeset">
  1116. <div class="md-footer-meta__inner md-grid">
  1117. <div class="md-copyright">
  1118. <div class="md-copyright__highlight">
  1119. &copy; 2023 The external-secrets Authors.<br/>
  1120. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1121. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1122. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1123. </div>
  1124. Made with
  1125. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1126. Material for MkDocs
  1127. </a>
  1128. </div>
  1129. </div>
  1130. </div>
  1131. </footer>
  1132. </div>
  1133. <div class="md-dialog" data-md-component="dialog">
  1134. <div class="md-dialog__inner md-typeset"></div>
  1135. </div>
  1136. <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>
  1137. <script src="../../assets/javascripts/bundle.caa56a14.min.js"></script>
  1138. </body>
  1139. </html>