index.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806
  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. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-decoding-strategy/" class="md-nav__link">
  242. Decoding Strategies
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../guides-getallsecrets/" class="md-nav__link">
  247. Getting Multiple Secrets
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../guides-multi-tenancy/" class="md-nav__link">
  252. Multi Tenancy
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../guides-metrics/" class="md-nav__link">
  257. Metrics
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../guides-datafrom-rewrite/" class="md-nav__link">
  262. Rewriting Keys
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="../guides-v1beta1/" class="md-nav__link">
  267. Upgrading to v1beta1
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="../guides-using-latest-image/" class="md-nav__link">
  272. Using Latest Image
  273. </a>
  274. </li>
  275. </ul>
  276. </nav>
  277. </li>
  278. <li class="md-nav__item md-nav__item--nested">
  279. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  280. <label class="md-nav__link" for="__nav_5">
  281. Provider
  282. <span class="md-nav__icon md-icon"></span>
  283. </label>
  284. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  285. <label class="md-nav__title" for="__nav_5">
  286. <span class="md-nav__icon md-icon"></span>
  287. Provider
  288. </label>
  289. <ul class="md-nav__list" data-md-scrollfix>
  290. <li class="md-nav__item md-nav__item--nested">
  291. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  292. <label class="md-nav__link" for="__nav_5_1">
  293. AWS
  294. <span class="md-nav__icon md-icon"></span>
  295. </label>
  296. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  297. <label class="md-nav__title" for="__nav_5_1">
  298. <span class="md-nav__icon md-icon"></span>
  299. AWS
  300. </label>
  301. <ul class="md-nav__list" data-md-scrollfix>
  302. <li class="md-nav__item">
  303. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  304. Secrets Manager
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  309. Parameter Store
  310. </a>
  311. </li>
  312. </ul>
  313. </nav>
  314. </li>
  315. <li class="md-nav__item md-nav__item--nested">
  316. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  317. <label class="md-nav__link" for="__nav_5_2">
  318. Azure
  319. <span class="md-nav__icon md-icon"></span>
  320. </label>
  321. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  322. <label class="md-nav__title" for="__nav_5_2">
  323. <span class="md-nav__icon md-icon"></span>
  324. Azure
  325. </label>
  326. <ul class="md-nav__list" data-md-scrollfix>
  327. <li class="md-nav__item">
  328. <a href="../provider-azure-key-vault/" class="md-nav__link">
  329. Key Vault
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. <li class="md-nav__item md-nav__item--nested">
  336. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  337. <label class="md-nav__link" for="__nav_5_3">
  338. Google
  339. <span class="md-nav__icon md-icon"></span>
  340. </label>
  341. <nav class="md-nav" aria-label="Google" data-md-level="2">
  342. <label class="md-nav__title" for="__nav_5_3">
  343. <span class="md-nav__icon md-icon"></span>
  344. Google
  345. </label>
  346. <ul class="md-nav__list" data-md-scrollfix>
  347. <li class="md-nav__item">
  348. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  349. Secret Manager
  350. </a>
  351. </li>
  352. </ul>
  353. </nav>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  357. <label class="md-nav__link" for="__nav_5_4">
  358. IBM
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_5_4">
  363. <span class="md-nav__icon md-icon"></span>
  364. IBM
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  369. Secrets Manager
  370. </a>
  371. </li>
  372. </ul>
  373. </nav>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../provider-akeyless/" class="md-nav__link">
  377. Akeyless
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  382. HashiCorp Vault
  383. </a>
  384. </li>
  385. <li class="md-nav__item md-nav__item--nested">
  386. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  387. <label class="md-nav__link" for="__nav_5_7">
  388. Yandex
  389. <span class="md-nav__icon md-icon"></span>
  390. </label>
  391. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  392. <label class="md-nav__title" for="__nav_5_7">
  393. <span class="md-nav__icon md-icon"></span>
  394. Yandex
  395. </label>
  396. <ul class="md-nav__list" data-md-scrollfix>
  397. <li class="md-nav__item">
  398. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  399. Certificate Manager
  400. </a>
  401. </li>
  402. <li class="md-nav__item">
  403. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  404. Lockbox
  405. </a>
  406. </li>
  407. </ul>
  408. </nav>
  409. </li>
  410. <li class="md-nav__item md-nav__item--nested">
  411. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  412. <label class="md-nav__link" for="__nav_5_8">
  413. Gitlab
  414. <span class="md-nav__icon md-icon"></span>
  415. </label>
  416. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  417. <label class="md-nav__title" for="__nav_5_8">
  418. <span class="md-nav__icon md-icon"></span>
  419. Gitlab
  420. </label>
  421. <ul class="md-nav__list" data-md-scrollfix>
  422. <li class="md-nav__item">
  423. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  424. Gitlab Project Variables
  425. </a>
  426. </li>
  427. </ul>
  428. </nav>
  429. </li>
  430. <li class="md-nav__item md-nav__item--nested">
  431. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  432. <label class="md-nav__link" for="__nav_5_9">
  433. Oracle
  434. <span class="md-nav__icon md-icon"></span>
  435. </label>
  436. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  437. <label class="md-nav__title" for="__nav_5_9">
  438. <span class="md-nav__icon md-icon"></span>
  439. Oracle
  440. </label>
  441. <ul class="md-nav__list" data-md-scrollfix>
  442. <li class="md-nav__item">
  443. <a href="../provider-oracle-vault/" class="md-nav__link">
  444. Oracle Vault
  445. </a>
  446. </li>
  447. </ul>
  448. </nav>
  449. </li>
  450. <li class="md-nav__item md-nav__item--nested">
  451. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  452. <label class="md-nav__link" for="__nav_5_10">
  453. 1Password
  454. <span class="md-nav__icon md-icon"></span>
  455. </label>
  456. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  457. <label class="md-nav__title" for="__nav_5_10">
  458. <span class="md-nav__icon md-icon"></span>
  459. 1Password
  460. </label>
  461. <ul class="md-nav__list" data-md-scrollfix>
  462. <li class="md-nav__item">
  463. <a href="../provider-1password-automation/" class="md-nav__link">
  464. Secrets Automation
  465. </a>
  466. </li>
  467. </ul>
  468. </nav>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../provider-webhook/" class="md-nav__link">
  472. Webhook
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../provider-fake/" class="md-nav__link">
  477. Fake
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../provider-kubernetes/" class="md-nav__link">
  482. Kubernetes
  483. </a>
  484. </li>
  485. <li class="md-nav__item md-nav__item--nested">
  486. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  487. <label class="md-nav__link" for="__nav_5_14">
  488. senhasegura
  489. <span class="md-nav__icon md-icon"></span>
  490. </label>
  491. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  492. <label class="md-nav__title" for="__nav_5_14">
  493. <span class="md-nav__icon md-icon"></span>
  494. senhasegura
  495. </label>
  496. <ul class="md-nav__list" data-md-scrollfix>
  497. <li class="md-nav__item">
  498. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  499. DevOps Secrets Management (DSM)
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. <li class="md-nav__item md-nav__item--nested">
  509. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  510. <label class="md-nav__link" for="__nav_6">
  511. Examples
  512. <span class="md-nav__icon md-icon"></span>
  513. </label>
  514. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  515. <label class="md-nav__title" for="__nav_6">
  516. <span class="md-nav__icon md-icon"></span>
  517. Examples
  518. </label>
  519. <ul class="md-nav__list" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  522. FluxCD
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  527. Anchore Engine
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  532. Jenkins
  533. </a>
  534. </li>
  535. </ul>
  536. </nav>
  537. </li>
  538. <li class="md-nav__item md-nav__item--nested">
  539. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  540. <label class="md-nav__link" for="__nav_7">
  541. External Resources
  542. <span class="md-nav__icon md-icon"></span>
  543. </label>
  544. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  545. <label class="md-nav__title" for="__nav_7">
  546. <span class="md-nav__icon md-icon"></span>
  547. External Resources
  548. </label>
  549. <ul class="md-nav__list" data-md-scrollfix>
  550. <li class="md-nav__item">
  551. <a href="../eso-talks/" class="md-nav__link">
  552. Talks
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../eso-demos/" class="md-nav__link">
  557. Demos
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../eso-blogs/" class="md-nav__link">
  562. Blogs
  563. </a>
  564. </li>
  565. </ul>
  566. </nav>
  567. </li>
  568. <li class="md-nav__item md-nav__item--nested">
  569. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  570. <label class="md-nav__link" for="__nav_8">
  571. References
  572. <span class="md-nav__icon md-icon"></span>
  573. </label>
  574. <nav class="md-nav" aria-label="References" data-md-level="1">
  575. <label class="md-nav__title" for="__nav_8">
  576. <span class="md-nav__icon md-icon"></span>
  577. References
  578. </label>
  579. <ul class="md-nav__list" data-md-scrollfix>
  580. <li class="md-nav__item">
  581. <a href="../spec/" class="md-nav__link">
  582. API specification
  583. </a>
  584. </li>
  585. </ul>
  586. </nav>
  587. </li>
  588. <li class="md-nav__item md-nav__item--nested">
  589. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  590. <label class="md-nav__link" for="__nav_9">
  591. Contributing
  592. <span class="md-nav__icon md-icon"></span>
  593. </label>
  594. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  595. <label class="md-nav__title" for="__nav_9">
  596. <span class="md-nav__icon md-icon"></span>
  597. Contributing
  598. </label>
  599. <ul class="md-nav__list" data-md-scrollfix>
  600. <li class="md-nav__item">
  601. <a href="../contributing-devguide/" class="md-nav__link">
  602. Developer guide
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../contributing-process/" class="md-nav__link">
  607. Contributing Process
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../contributing-release/" class="md-nav__link">
  612. Release Process
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="../contributing-coc/" class="md-nav__link">
  617. Code of Conduct
  618. </a>
  619. </li>
  620. </ul>
  621. </nav>
  622. </li>
  623. <li class="md-nav__item">
  624. <a href="../roadmap/" class="md-nav__link">
  625. Roadmap
  626. </a>
  627. </li>
  628. <li class="md-nav__item md-nav__item--active">
  629. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  630. <label class="md-nav__link md-nav__link--active" for="__toc">
  631. FAQ
  632. <span class="md-nav__icon md-icon"></span>
  633. </label>
  634. <a href="./" class="md-nav__link md-nav__link--active">
  635. FAQ
  636. </a>
  637. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  638. <label class="md-nav__title" for="__toc">
  639. <span class="md-nav__icon md-icon"></span>
  640. Table of contents
  641. </label>
  642. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  643. <li class="md-nav__item">
  644. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  645. Can i manually trigger a secret refresh?
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  650. How do i know when my secret was last synced?
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  655. Differences to csi-secret-store
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  660. How do i debug an external-secret that doesn't sync?
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  665. Upgrading from KES to ESO
  666. </a>
  667. </li>
  668. </ul>
  669. </nav>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../stability-support/" class="md-nav__link">
  673. Stability and Support
  674. </a>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../deprecation-policy/" class="md-nav__link">
  678. Deprecation Policy
  679. </a>
  680. </li>
  681. </ul>
  682. </nav>
  683. </div>
  684. </div>
  685. </div>
  686. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  687. <div class="md-sidebar__scrollwrap">
  688. <div class="md-sidebar__inner">
  689. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  690. <label class="md-nav__title" for="__toc">
  691. <span class="md-nav__icon md-icon"></span>
  692. Table of contents
  693. </label>
  694. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  695. <li class="md-nav__item">
  696. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  697. Can i manually trigger a secret refresh?
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  702. How do i know when my secret was last synced?
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  707. Differences to csi-secret-store
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  712. How do i debug an external-secret that doesn't sync?
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  717. Upgrading from KES to ESO
  718. </a>
  719. </li>
  720. </ul>
  721. </nav>
  722. </div>
  723. </div>
  724. </div>
  725. <div class="md-content" data-md-component="content">
  726. <article class="md-content__inner md-typeset">
  727. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/faq.md" title="Edit this page" class="md-content__button md-icon">
  728. <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>
  729. </a>
  730. <h1>FAQ</h1>
  731. <h2 id="can-i-manually-trigger-a-secret-refresh">Can i manually trigger a secret refresh?</h2>
  732. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client.
  733. You just need to change an annotation, label or the spec of the resource:</p>
  734. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  735. </code></pre></div>
  736. <h2 id="how-do-i-know-when-my-secret-was-last-synced">How do i know when my secret was last synced?</h2>
  737. <p>Every ExternalSecret resource contains a status condition that indicates the time when the secret was last synced:</p>
  738. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep condition -A 5
  739. conditions:
  740. - lastTransitionTime: &quot;2022-05-21T21:02:47Z&quot;
  741. message: Secret was synced
  742. reason: SecretSynced
  743. status: &quot;True&quot;
  744. type: Ready
  745. </code></pre></div>
  746. <h2 id="differences-to-csi-secret-store">Differences to csi-secret-store</h2>
  747. <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>
  748. <h2 id="how-do-i-debug-an-external-secret-that-doesnt-sync">How do i debug an external-secret that doesn't sync?</h2>
  749. <p>First, check the status of the ExternalSecret resource using <code>kubectl describe</code>. That displays the status conditions as well as recent events.
  750. 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>
  751. <div class="highlight"><pre><span></span><code>kubectl describe es my-external-secret
  752. [...]
  753. Status:
  754. Conditions:
  755. Last Transition Time: 2022-05-21T21:02:47Z
  756. Message: Secret was synced
  757. Reason: SecretSynced
  758. Status: True
  759. Type: Ready
  760. Refresh Time: 2022-05-21T21:06:47Z
  761. Synced Resource Version: 1-5c833527afd7ba3f426cb0082ee7e083
  762. Events:
  763. Type Reason Age From Message
  764. ---- ------ ---- ---- -------
  765. Warning UpdateFailed 4m12s external-secrets secrets &quot;yyyyyyy&quot; already exists
  766. Normal Updated 12s (x4 over 3m12s) external-secrets Updated Secret
  767. </code></pre></div>
  768. <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>
  769. <p>In an ideally, the store should be validated and Ready.</p>
  770. <div class="highlight"><pre><span></span><code>kubectl describe css kubernetes
  771. [...]
  772. Status:
  773. Conditions:
  774. Last Transition Time: 2022-05-21T21:02:47Z
  775. Message: store validated
  776. Reason: Valid
  777. Status: True
  778. Type: Ready
  779. Events:
  780. Type Reason Age From Message
  781. ---- ------ ---- ---- -------
  782. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  783. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  784. </code></pre></div>
  785. <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>
  786. <h2 id="upgrading-from-kes-to-eso">Upgrading from KES to ESO</h2>
  787. <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>
  788. <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.
  789. 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>
  790. </article>
  791. </div>
  792. </div>
  793. </main>
  794. <footer class="md-footer">
  795. <nav class="md-footer__inner md-grid" aria-label="Footer">
  796. <a href="../roadmap/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Roadmap" rel="prev">
  797. <div class="md-footer__button md-icon">
  798. <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>
  799. </div>
  800. <div class="md-footer__title">
  801. <div class="md-ellipsis">
  802. <span class="md-footer__direction">
  803. Previous
  804. </span>
  805. Roadmap
  806. </div>
  807. </div>
  808. </a>
  809. <a href="../stability-support/" class="md-footer__link md-footer__link--next" aria-label="Next: Stability and Support" rel="next">
  810. <div class="md-footer__title">
  811. <div class="md-ellipsis">
  812. <span class="md-footer__direction">
  813. Next
  814. </span>
  815. Stability and Support
  816. </div>
  817. </div>
  818. <div class="md-footer__button md-icon">
  819. <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>
  820. </div>
  821. </a>
  822. </nav>
  823. <div class="md-footer-meta md-typeset">
  824. <div class="md-footer-meta__inner md-grid">
  825. <div class="md-copyright">
  826. <div class="md-copyright__highlight">
  827. &copy; 2022 The external-secrets Authors.<br/>
  828. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  829. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  830. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  831. </div>
  832. Made with
  833. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  834. Material for MkDocs
  835. </a>
  836. </div>
  837. </div>
  838. </div>
  839. </footer>
  840. </div>
  841. <div class="md-dialog" data-md-component="dialog">
  842. <div class="md-dialog__inner md-typeset"></div>
  843. </div>
  844. <script id="__config" type="application/json">{"base": "..", "features": [], "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>
  845. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  846. </body>
  847. </html>