index.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124
  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="icon" href="../../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>FAQ - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <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>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. FAQ
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <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>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <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>
  72. <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>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <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>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link md-tabs__link--active">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../../contributing/devguide/" class="md-tabs__link">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <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>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item md-nav__item--active">
  189. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  190. <label class="md-nav__link md-nav__link--active" for="__toc">
  191. FAQ
  192. <span class="md-nav__icon md-icon"></span>
  193. </label>
  194. <a href="./" class="md-nav__link md-nav__link--active">
  195. FAQ
  196. </a>
  197. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  198. <label class="md-nav__title" for="__toc">
  199. <span class="md-nav__icon md-icon"></span>
  200. Table of contents
  201. </label>
  202. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  203. <li class="md-nav__item">
  204. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  205. Can i manually trigger a secret refresh?
  206. </a>
  207. </li>
  208. <li class="md-nav__item">
  209. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  210. How do i know when my secret was last synced?
  211. </a>
  212. </li>
  213. <li class="md-nav__item">
  214. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  215. Differences to csi-secret-store
  216. </a>
  217. </li>
  218. <li class="md-nav__item">
  219. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  220. How do i debug an external-secret that doesn't sync?
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  225. Upgrading from KES to ESO
  226. </a>
  227. </li>
  228. </ul>
  229. </nav>
  230. </li>
  231. <li class="md-nav__item">
  232. <a href="../stability-support/" class="md-nav__link">
  233. Stability and Support
  234. </a>
  235. </li>
  236. <li class="md-nav__item">
  237. <a href="../deprecation-policy/" class="md-nav__link">
  238. Deprecation Policy
  239. </a>
  240. </li>
  241. </ul>
  242. </nav>
  243. </li>
  244. <li class="md-nav__item md-nav__item--nested">
  245. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  246. <label class="md-nav__link" for="__nav_2">
  247. API
  248. <span class="md-nav__icon md-icon"></span>
  249. </label>
  250. <nav class="md-nav" aria-label="API" data-md-level="1">
  251. <label class="md-nav__title" for="__nav_2">
  252. <span class="md-nav__icon md-icon"></span>
  253. API
  254. </label>
  255. <ul class="md-nav__list" data-md-scrollfix>
  256. <li class="md-nav__item">
  257. <a href="../../api/components/" class="md-nav__link">
  258. Components
  259. </a>
  260. </li>
  261. <li class="md-nav__item md-nav__item--nested">
  262. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  263. <label class="md-nav__link" for="__nav_2_2">
  264. Core Resources
  265. <span class="md-nav__icon md-icon"></span>
  266. </label>
  267. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  268. <label class="md-nav__title" for="__nav_2_2">
  269. <span class="md-nav__icon md-icon"></span>
  270. Core Resources
  271. </label>
  272. <ul class="md-nav__list" data-md-scrollfix>
  273. <li class="md-nav__item">
  274. <a href="../../api/externalsecret/" class="md-nav__link">
  275. ExternalSecret
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../../api/secretstore/" class="md-nav__link">
  280. SecretStore
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../../api/clustersecretstore/" class="md-nav__link">
  285. ClusterSecretStore
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  290. ClusterExternalSecret
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="../../api/pushsecret/" class="md-nav__link">
  295. PushSecret
  296. </a>
  297. </li>
  298. </ul>
  299. </nav>
  300. </li>
  301. <li class="md-nav__item md-nav__item--nested">
  302. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  303. <div class="md-nav__link md-nav__link--index ">
  304. <a href="../../api/generator/">Generators</a>
  305. <label for="__nav_2_3">
  306. <span class="md-nav__icon md-icon"></span>
  307. </label>
  308. </div>
  309. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  310. <label class="md-nav__title" for="__nav_2_3">
  311. <span class="md-nav__icon md-icon"></span>
  312. Generators
  313. </label>
  314. <ul class="md-nav__list" data-md-scrollfix>
  315. <li class="md-nav__item">
  316. <a href="../../api/generator/acr/" class="md-nav__link">
  317. Azure Container Registry
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../../api/generator/ecr/" class="md-nav__link">
  322. AWS Elastic Container Registry
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../../api/generator/gcr/" class="md-nav__link">
  327. Google Container Registry
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="../../api/generator/vault/" class="md-nav__link">
  332. Vault Dynamic Secret
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../../api/generator/password/" class="md-nav__link">
  337. Password
  338. </a>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="../../api/generator/fake/" class="md-nav__link">
  342. Fake
  343. </a>
  344. </li>
  345. </ul>
  346. </nav>
  347. </li>
  348. <li class="md-nav__item md-nav__item--nested">
  349. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  350. <label class="md-nav__link" for="__nav_2_4">
  351. Reference Docs
  352. <span class="md-nav__icon md-icon"></span>
  353. </label>
  354. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  355. <label class="md-nav__title" for="__nav_2_4">
  356. <span class="md-nav__icon md-icon"></span>
  357. Reference Docs
  358. </label>
  359. <ul class="md-nav__list" data-md-scrollfix>
  360. <li class="md-nav__item">
  361. <a href="../../api/spec/" class="md-nav__link">
  362. API specification
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../../api/controller-options/" class="md-nav__link">
  367. Controller Options
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../../api/metrics/" class="md-nav__link">
  372. Metrics
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. </ul>
  379. </nav>
  380. </li>
  381. <li class="md-nav__item md-nav__item--nested">
  382. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  383. <label class="md-nav__link" for="__nav_3">
  384. Guides
  385. <span class="md-nav__icon md-icon"></span>
  386. </label>
  387. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  388. <label class="md-nav__title" for="__nav_3">
  389. <span class="md-nav__icon md-icon"></span>
  390. Guides
  391. </label>
  392. <ul class="md-nav__list" data-md-scrollfix>
  393. <li class="md-nav__item">
  394. <a href="../../guides/introduction/" class="md-nav__link">
  395. Introduction
  396. </a>
  397. </li>
  398. <li class="md-nav__item md-nav__item--nested">
  399. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  400. <label class="md-nav__link" for="__nav_3_2">
  401. Advanced Templating
  402. <span class="md-nav__icon md-icon"></span>
  403. </label>
  404. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  405. <label class="md-nav__title" for="__nav_3_2">
  406. <span class="md-nav__icon md-icon"></span>
  407. Advanced Templating
  408. </label>
  409. <ul class="md-nav__list" data-md-scrollfix>
  410. <li class="md-nav__item">
  411. <a href="../../guides/templating/" class="md-nav__link">
  412. v2
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/templating-v1/" class="md-nav__link">
  417. v1
  418. </a>
  419. </li>
  420. </ul>
  421. </nav>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../../guides/generator/" class="md-nav__link">
  425. Generators
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  430. All keys, One secret
  431. </a>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  435. Common K8S Secret Types
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../guides/controller-class/" class="md-nav__link">
  440. Controller Classes
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  445. Lifecycle: ownership & deletion
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  450. Decoding Strategies
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../guides/getallsecrets/" class="md-nav__link">
  455. Getting Multiple Secrets
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  460. Multi Tenancy
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  465. Rewriting Keys
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../../guides/v1beta1/" class="md-nav__link">
  470. Upgrading to v1beta1
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../../guides/using-latest-image/" class="md-nav__link">
  475. Using Latest Image
  476. </a>
  477. </li>
  478. <li class="md-nav__item">
  479. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  480. Disable Cluster Features
  481. </a>
  482. </li>
  483. </ul>
  484. </nav>
  485. </li>
  486. <li class="md-nav__item md-nav__item--nested">
  487. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  488. <label class="md-nav__link" for="__nav_4">
  489. Provider
  490. <span class="md-nav__icon md-icon"></span>
  491. </label>
  492. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  493. <label class="md-nav__title" for="__nav_4">
  494. <span class="md-nav__icon md-icon"></span>
  495. Provider
  496. </label>
  497. <ul class="md-nav__list" data-md-scrollfix>
  498. <li class="md-nav__item">
  499. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  500. AWS Secrets Manager
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  505. AWS Parameter Store
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  510. Azure Key Vault
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  515. Google Secret Manager
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  520. IBM Secrets Manager
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../provider/akeyless/" class="md-nav__link">
  525. Akeyless
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  530. HashiCorp Vault
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  535. Yandex Certificate Manager
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  540. Yandex Lockbox
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  545. Gitlab Variables
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../../provider/oracle-vault/" class="md-nav__link">
  550. Oracle Vault
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../provider/1password-automation/" class="md-nav__link">
  555. 1Password Secrets Automation
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../provider/webhook/" class="md-nav__link">
  560. Webhook
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../../provider/fake/" class="md-nav__link">
  565. Fake
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../../provider/kubernetes/" class="md-nav__link">
  570. Kubernetes
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  575. senhasegura DevOps Secrets Management (DSM)
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../provider/doppler/" class="md-nav__link">
  580. Doppler
  581. </a>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="../../provider/keeper-security/" class="md-nav__link">
  585. Keeper Security
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../provider/scaleway/" class="md-nav__link">
  590. Scaleway
  591. </a>
  592. </li>
  593. </ul>
  594. </nav>
  595. </li>
  596. <li class="md-nav__item md-nav__item--nested">
  597. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  598. <label class="md-nav__link" for="__nav_5">
  599. Examples
  600. <span class="md-nav__icon md-icon"></span>
  601. </label>
  602. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  603. <label class="md-nav__title" for="__nav_5">
  604. <span class="md-nav__icon md-icon"></span>
  605. Examples
  606. </label>
  607. <ul class="md-nav__list" data-md-scrollfix>
  608. <li class="md-nav__item">
  609. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  610. FluxCD
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  615. Anchore Engine
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  620. Jenkins
  621. </a>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. <li class="md-nav__item md-nav__item--nested">
  627. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  628. <label class="md-nav__link" for="__nav_6">
  629. Community
  630. <span class="md-nav__icon md-icon"></span>
  631. </label>
  632. <nav class="md-nav" aria-label="Community" data-md-level="1">
  633. <label class="md-nav__title" for="__nav_6">
  634. <span class="md-nav__icon md-icon"></span>
  635. Community
  636. </label>
  637. <ul class="md-nav__list" data-md-scrollfix>
  638. <li class="md-nav__item md-nav__item--nested">
  639. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  640. <label class="md-nav__link" for="__nav_6_1">
  641. Contributing
  642. <span class="md-nav__icon md-icon"></span>
  643. </label>
  644. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  645. <label class="md-nav__title" for="__nav_6_1">
  646. <span class="md-nav__icon md-icon"></span>
  647. Contributing
  648. </label>
  649. <ul class="md-nav__list" data-md-scrollfix>
  650. <li class="md-nav__item">
  651. <a href="../../contributing/devguide/" class="md-nav__link">
  652. Developer guide
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../contributing/process/" class="md-nav__link">
  657. Contributing Process
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="../../contributing/release/" class="md-nav__link">
  662. Release Process
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../contributing/coc/" class="md-nav__link">
  667. Code of Conduct
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../../contributing/roadmap/" class="md-nav__link">
  672. Roadmap
  673. </a>
  674. </li>
  675. </ul>
  676. </nav>
  677. </li>
  678. <li class="md-nav__item md-nav__item--nested">
  679. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  680. <label class="md-nav__link" for="__nav_6_2">
  681. External Resources
  682. <span class="md-nav__icon md-icon"></span>
  683. </label>
  684. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  685. <label class="md-nav__title" for="__nav_6_2">
  686. <span class="md-nav__icon md-icon"></span>
  687. External Resources
  688. </label>
  689. <ul class="md-nav__list" data-md-scrollfix>
  690. <li class="md-nav__item">
  691. <a href="../../eso-talks/" class="md-nav__link">
  692. Talks
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="../../eso-demos/" class="md-nav__link">
  697. Demos
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="../../eso-blogs/" class="md-nav__link">
  702. Blogs
  703. </a>
  704. </li>
  705. </ul>
  706. </nav>
  707. </li>
  708. </ul>
  709. </nav>
  710. </li>
  711. </ul>
  712. </nav>
  713. </div>
  714. </div>
  715. </div>
  716. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  717. <div class="md-sidebar__scrollwrap">
  718. <div class="md-sidebar__inner">
  719. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  720. <label class="md-nav__title" for="__toc">
  721. <span class="md-nav__icon md-icon"></span>
  722. Table of contents
  723. </label>
  724. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  725. <li class="md-nav__item">
  726. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  727. Can i manually trigger a secret refresh?
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  732. How do i know when my secret was last synced?
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  737. Differences to csi-secret-store
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  742. How do i debug an external-secret that doesn't sync?
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  747. Upgrading from KES to ESO
  748. </a>
  749. </li>
  750. </ul>
  751. </nav>
  752. </div>
  753. </div>
  754. </div>
  755. <div class="md-content" data-md-component="content">
  756. <article class="md-content__inner md-typeset">
  757. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/introduction/faq.md" title="Edit this page" class="md-content__button md-icon">
  758. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  759. </a>
  760. <h1>FAQ</h1>
  761. <h2 id="can-i-manually-trigger-a-secret-refresh">Can i manually trigger a secret refresh?</h2>
  762. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client.
  763. You just need to change an annotation, label or the spec of the resource:</p>
  764. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  765. </code></pre></div>
  766. <h2 id="how-do-i-know-when-my-secret-was-last-synced">How do i know when my secret was last synced?</h2>
  767. <p>Every ExternalSecret resource contains a status condition that indicates the time when the secret was last synced:</p>
  768. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep condition -A 5
  769. conditions:
  770. - lastTransitionTime: &quot;2022-05-21T21:02:47Z&quot;
  771. message: Secret was synced
  772. reason: SecretSynced
  773. status: &quot;True&quot;
  774. type: Ready
  775. </code></pre></div>
  776. <h2 id="differences-to-csi-secret-store">Differences to csi-secret-store</h2>
  777. <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>
  778. <h2 id="how-do-i-debug-an-external-secret-that-doesnt-sync">How do i debug an external-secret that doesn't sync?</h2>
  779. <p>First, check the status of the ExternalSecret resource using <code>kubectl describe</code>. That displays the status conditions as well as recent events.
  780. 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>
  781. <div class="highlight"><pre><span></span><code>kubectl describe es my-external-secret
  782. [...]
  783. Status:
  784. Conditions:
  785. Last Transition Time: 2022-05-21T21:02:47Z
  786. Message: Secret was synced
  787. Reason: SecretSynced
  788. Status: True
  789. Type: Ready
  790. Refresh Time: 2022-05-21T21:06:47Z
  791. Synced Resource Version: 1-5c833527afd7ba3f426cb0082ee7e083
  792. Events:
  793. Type Reason Age From Message
  794. ---- ------ ---- ---- -------
  795. Warning UpdateFailed 4m12s external-secrets secrets &quot;yyyyyyy&quot; already exists
  796. Normal Updated 12s (x4 over 3m12s) external-secrets Updated Secret
  797. </code></pre></div>
  798. <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>
  799. <p>In an ideally, the store should be validated and Ready.</p>
  800. <div class="highlight"><pre><span></span><code>kubectl describe css kubernetes
  801. [...]
  802. Status:
  803. Conditions:
  804. Last Transition Time: 2022-05-21T21:02:47Z
  805. Message: store validated
  806. Reason: Valid
  807. Status: True
  808. Type: Ready
  809. Events:
  810. Type Reason Age From Message
  811. ---- ------ ---- ---- -------
  812. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  813. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  814. </code></pre></div>
  815. <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>
  816. <h2 id="upgrading-from-kes-to-eso">Upgrading from KES to ESO</h2>
  817. <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>
  818. <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.
  819. 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>
  820. </article>
  821. </div>
  822. </div>
  823. </main>
  824. <footer class="md-footer">
  825. <nav class="md-footer__inner md-grid" aria-label="Footer">
  826. <a href="../getting-started/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Getting started" rel="prev">
  827. <div class="md-footer__button md-icon">
  828. <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>
  829. </div>
  830. <div class="md-footer__title">
  831. <div class="md-ellipsis">
  832. <span class="md-footer__direction">
  833. Previous
  834. </span>
  835. Getting started
  836. </div>
  837. </div>
  838. </a>
  839. <a href="../stability-support/" class="md-footer__link md-footer__link--next" aria-label="Next: Stability and Support" rel="next">
  840. <div class="md-footer__title">
  841. <div class="md-ellipsis">
  842. <span class="md-footer__direction">
  843. Next
  844. </span>
  845. Stability and Support
  846. </div>
  847. </div>
  848. <div class="md-footer__button md-icon">
  849. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  850. </div>
  851. </a>
  852. </nav>
  853. <div class="md-footer-meta md-typeset">
  854. <div class="md-footer-meta__inner md-grid">
  855. <div class="md-copyright">
  856. <div class="md-copyright__highlight">
  857. &copy; 2023 The external-secrets Authors.<br/>
  858. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  859. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  860. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  861. </div>
  862. Made with
  863. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  864. Material for MkDocs
  865. </a>
  866. </div>
  867. </div>
  868. </div>
  869. </footer>
  870. </div>
  871. <div class="md-dialog" data-md-component="dialog">
  872. <div class="md-dialog__inner md-typeset"></div>
  873. </div>
  874. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  875. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  876. </body>
  877. </html>