index.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770
  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-getallsecrets/" class="md-nav__link">
  242. Getting Multiple Secrets
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../guides-multi-tenancy/" class="md-nav__link">
  247. Multi Tenancy
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../guides-metrics/" class="md-nav__link">
  252. Metrics
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../guides-v1beta1/" class="md-nav__link">
  257. Upgrading to v1beta1
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../guides-using-latest-image/" class="md-nav__link">
  262. Using Latest Image
  263. </a>
  264. </li>
  265. </ul>
  266. </nav>
  267. </li>
  268. <li class="md-nav__item md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  270. <label class="md-nav__link" for="__nav_5">
  271. Provider
  272. <span class="md-nav__icon md-icon"></span>
  273. </label>
  274. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  275. <label class="md-nav__title" for="__nav_5">
  276. <span class="md-nav__icon md-icon"></span>
  277. Provider
  278. </label>
  279. <ul class="md-nav__list" data-md-scrollfix>
  280. <li class="md-nav__item md-nav__item--nested">
  281. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  282. <label class="md-nav__link" for="__nav_5_1">
  283. AWS
  284. <span class="md-nav__icon md-icon"></span>
  285. </label>
  286. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  287. <label class="md-nav__title" for="__nav_5_1">
  288. <span class="md-nav__icon md-icon"></span>
  289. AWS
  290. </label>
  291. <ul class="md-nav__list" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  294. Secrets Manager
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  299. Parameter Store
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  307. <label class="md-nav__link" for="__nav_5_2">
  308. Azure
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_5_2">
  313. <span class="md-nav__icon md-icon"></span>
  314. Azure
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../provider-azure-key-vault/" class="md-nav__link">
  319. Key Vault
  320. </a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </li>
  325. <li class="md-nav__item md-nav__item--nested">
  326. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  327. <label class="md-nav__link" for="__nav_5_3">
  328. Google
  329. <span class="md-nav__icon md-icon"></span>
  330. </label>
  331. <nav class="md-nav" aria-label="Google" data-md-level="2">
  332. <label class="md-nav__title" for="__nav_5_3">
  333. <span class="md-nav__icon md-icon"></span>
  334. Google
  335. </label>
  336. <ul class="md-nav__list" data-md-scrollfix>
  337. <li class="md-nav__item">
  338. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  339. Secret Manager
  340. </a>
  341. </li>
  342. </ul>
  343. </nav>
  344. </li>
  345. <li class="md-nav__item md-nav__item--nested">
  346. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  347. <label class="md-nav__link" for="__nav_5_4">
  348. IBM
  349. <span class="md-nav__icon md-icon"></span>
  350. </label>
  351. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  352. <label class="md-nav__title" for="__nav_5_4">
  353. <span class="md-nav__icon md-icon"></span>
  354. IBM
  355. </label>
  356. <ul class="md-nav__list" data-md-scrollfix>
  357. <li class="md-nav__item">
  358. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  359. Secrets Manager
  360. </a>
  361. </li>
  362. </ul>
  363. </nav>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../provider-akeyless/" class="md-nav__link">
  367. Akeyless
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  372. HashiCorp Vault
  373. </a>
  374. </li>
  375. <li class="md-nav__item md-nav__item--nested">
  376. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  377. <label class="md-nav__link" for="__nav_5_7">
  378. Yandex
  379. <span class="md-nav__icon md-icon"></span>
  380. </label>
  381. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  382. <label class="md-nav__title" for="__nav_5_7">
  383. <span class="md-nav__icon md-icon"></span>
  384. Yandex
  385. </label>
  386. <ul class="md-nav__list" data-md-scrollfix>
  387. <li class="md-nav__item">
  388. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  389. Certificate Manager
  390. </a>
  391. </li>
  392. <li class="md-nav__item">
  393. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  394. Lockbox
  395. </a>
  396. </li>
  397. </ul>
  398. </nav>
  399. </li>
  400. <li class="md-nav__item md-nav__item--nested">
  401. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  402. <label class="md-nav__link" for="__nav_5_8">
  403. Gitlab
  404. <span class="md-nav__icon md-icon"></span>
  405. </label>
  406. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  407. <label class="md-nav__title" for="__nav_5_8">
  408. <span class="md-nav__icon md-icon"></span>
  409. Gitlab
  410. </label>
  411. <ul class="md-nav__list" data-md-scrollfix>
  412. <li class="md-nav__item">
  413. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  414. Gitlab Project Variables
  415. </a>
  416. </li>
  417. </ul>
  418. </nav>
  419. </li>
  420. <li class="md-nav__item md-nav__item--nested">
  421. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  422. <label class="md-nav__link" for="__nav_5_9">
  423. Oracle
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  427. <label class="md-nav__title" for="__nav_5_9">
  428. <span class="md-nav__icon md-icon"></span>
  429. Oracle
  430. </label>
  431. <ul class="md-nav__list" data-md-scrollfix>
  432. <li class="md-nav__item">
  433. <a href="../provider-oracle-vault/" class="md-nav__link">
  434. Oracle Vault
  435. </a>
  436. </li>
  437. </ul>
  438. </nav>
  439. </li>
  440. <li class="md-nav__item md-nav__item--nested">
  441. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  442. <label class="md-nav__link" for="__nav_5_10">
  443. 1Password
  444. <span class="md-nav__icon md-icon"></span>
  445. </label>
  446. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  447. <label class="md-nav__title" for="__nav_5_10">
  448. <span class="md-nav__icon md-icon"></span>
  449. 1Password
  450. </label>
  451. <ul class="md-nav__list" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="../provider-1password-automation/" class="md-nav__link">
  454. Secrets Automation
  455. </a>
  456. </li>
  457. </ul>
  458. </nav>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../provider-webhook/" class="md-nav__link">
  462. Webhook
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../provider-fake/" class="md-nav__link">
  467. Fake
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../provider-kubernetes/" class="md-nav__link">
  472. Kubernetes
  473. </a>
  474. </li>
  475. <li class="md-nav__item md-nav__item--nested">
  476. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  477. <label class="md-nav__link" for="__nav_5_14">
  478. senhasegura
  479. <span class="md-nav__icon md-icon"></span>
  480. </label>
  481. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  482. <label class="md-nav__title" for="__nav_5_14">
  483. <span class="md-nav__icon md-icon"></span>
  484. senhasegura
  485. </label>
  486. <ul class="md-nav__list" data-md-scrollfix>
  487. <li class="md-nav__item">
  488. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  489. DevOps Secrets Management (DSM)
  490. </a>
  491. </li>
  492. </ul>
  493. </nav>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. <li class="md-nav__item md-nav__item--nested">
  499. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  500. <label class="md-nav__link" for="__nav_6">
  501. Examples
  502. <span class="md-nav__icon md-icon"></span>
  503. </label>
  504. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  505. <label class="md-nav__title" for="__nav_6">
  506. <span class="md-nav__icon md-icon"></span>
  507. Examples
  508. </label>
  509. <ul class="md-nav__list" data-md-scrollfix>
  510. <li class="md-nav__item">
  511. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  512. FluxCD
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  517. Anchore Engine
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  522. Jenkins
  523. </a>
  524. </li>
  525. </ul>
  526. </nav>
  527. </li>
  528. <li class="md-nav__item md-nav__item--nested">
  529. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  530. <label class="md-nav__link" for="__nav_7">
  531. External Resources
  532. <span class="md-nav__icon md-icon"></span>
  533. </label>
  534. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  535. <label class="md-nav__title" for="__nav_7">
  536. <span class="md-nav__icon md-icon"></span>
  537. External Resources
  538. </label>
  539. <ul class="md-nav__list" data-md-scrollfix>
  540. <li class="md-nav__item">
  541. <a href="../eso-talks/" class="md-nav__link">
  542. Talks
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../eso-demos/" class="md-nav__link">
  547. Demos
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../eso-blogs/" class="md-nav__link">
  552. Blogs
  553. </a>
  554. </li>
  555. </ul>
  556. </nav>
  557. </li>
  558. <li class="md-nav__item md-nav__item--nested">
  559. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  560. <label class="md-nav__link" for="__nav_8">
  561. References
  562. <span class="md-nav__icon md-icon"></span>
  563. </label>
  564. <nav class="md-nav" aria-label="References" data-md-level="1">
  565. <label class="md-nav__title" for="__nav_8">
  566. <span class="md-nav__icon md-icon"></span>
  567. References
  568. </label>
  569. <ul class="md-nav__list" data-md-scrollfix>
  570. <li class="md-nav__item">
  571. <a href="../spec/" class="md-nav__link">
  572. API specification
  573. </a>
  574. </li>
  575. </ul>
  576. </nav>
  577. </li>
  578. <li class="md-nav__item md-nav__item--nested">
  579. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  580. <label class="md-nav__link" for="__nav_9">
  581. Contributing
  582. <span class="md-nav__icon md-icon"></span>
  583. </label>
  584. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  585. <label class="md-nav__title" for="__nav_9">
  586. <span class="md-nav__icon md-icon"></span>
  587. Contributing
  588. </label>
  589. <ul class="md-nav__list" data-md-scrollfix>
  590. <li class="md-nav__item">
  591. <a href="../contributing-devguide/" class="md-nav__link">
  592. Developer guide
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../contributing-process/" class="md-nav__link">
  597. Contributing Process
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../contributing-release/" class="md-nav__link">
  602. Release Process
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../contributing-coc/" class="md-nav__link">
  607. Code of Conduct
  608. </a>
  609. </li>
  610. </ul>
  611. </nav>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../roadmap/" class="md-nav__link">
  615. Roadmap
  616. </a>
  617. </li>
  618. <li class="md-nav__item md-nav__item--active">
  619. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  620. <label class="md-nav__link md-nav__link--active" for="__toc">
  621. FAQ
  622. <span class="md-nav__icon md-icon"></span>
  623. </label>
  624. <a href="./" class="md-nav__link md-nav__link--active">
  625. FAQ
  626. </a>
  627. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  628. <label class="md-nav__title" for="__toc">
  629. <span class="md-nav__icon md-icon"></span>
  630. Table of contents
  631. </label>
  632. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  633. <li class="md-nav__item">
  634. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  635. Can i manually trigger a secret refresh?
  636. </a>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  640. How do i know when my secret was last synced?
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  645. Differences to csi-secret-store
  646. </a>
  647. </li>
  648. <li class="md-nav__item">
  649. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  650. How do i debug an external-secret that doesn't sync?
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  655. Upgrading from KES to ESO
  656. </a>
  657. </li>
  658. </ul>
  659. </nav>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../stability-support/" class="md-nav__link">
  663. Stability and Support
  664. </a>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../deprecation-policy/" class="md-nav__link">
  668. Deprecation Policy
  669. </a>
  670. </li>
  671. </ul>
  672. </nav>
  673. </div>
  674. </div>
  675. </div>
  676. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  677. <div class="md-sidebar__scrollwrap">
  678. <div class="md-sidebar__inner">
  679. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  680. <label class="md-nav__title" for="__toc">
  681. <span class="md-nav__icon md-icon"></span>
  682. Table of contents
  683. </label>
  684. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  685. <li class="md-nav__item">
  686. <a href="#can-i-manually-trigger-a-secret-refresh" class="md-nav__link">
  687. Can i manually trigger a secret refresh?
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="#how-do-i-know-when-my-secret-was-last-synced" class="md-nav__link">
  692. How do i know when my secret was last synced?
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="#differences-to-csi-secret-store" class="md-nav__link">
  697. Differences to csi-secret-store
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="#how-do-i-debug-an-external-secret-that-doesnt-sync" class="md-nav__link">
  702. How do i debug an external-secret that doesn't sync?
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="#upgrading-from-kes-to-eso" class="md-nav__link">
  707. Upgrading from KES to ESO
  708. </a>
  709. </li>
  710. </ul>
  711. </nav>
  712. </div>
  713. </div>
  714. </div>
  715. <div class="md-content" data-md-component="content">
  716. <article class="md-content__inner md-typeset">
  717. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/faq.md" title="Edit this page" class="md-content__button md-icon">
  718. <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>
  719. </a>
  720. <h1>FAQ</h1>
  721. <h2 id="can-i-manually-trigger-a-secret-refresh">Can i manually trigger a secret refresh?</h2>
  722. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client.
  723. You just need to change an annotation, label or the spec of the resource:</p>
  724. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  725. </code></pre></div>
  726. <h2 id="how-do-i-know-when-my-secret-was-last-synced">How do i know when my secret was last synced?</h2>
  727. <p>Every ExternalSecret resource contains a status condition that indicates the time when the secret was last synced:</p>
  728. <div class="highlight"><pre><span></span><code>kubectl get es my-external-secret -o yaml | grep condition -A 5
  729. conditions:
  730. - lastTransitionTime: &quot;2022-05-21T21:02:47Z&quot;
  731. message: Secret was synced
  732. reason: SecretSynced
  733. status: &quot;True&quot;
  734. type: Ready
  735. </code></pre></div>
  736. <h2 id="differences-to-csi-secret-store">Differences to csi-secret-store</h2>
  737. <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>
  738. <h2 id="how-do-i-debug-an-external-secret-that-doesnt-sync">How do i debug an external-secret that doesn't sync?</h2>
  739. <p>First, check the status of the ExternalSecret resource using <code>kubectl describe</code>. That displays the status conditions as well as recent events.
  740. 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>
  741. <div class="highlight"><pre><span></span><code>kubectl describe es my-external-secret
  742. [...]
  743. Status:
  744. Conditions:
  745. Last Transition Time: 2022-05-21T21:02:47Z
  746. Message: Secret was synced
  747. Reason: SecretSynced
  748. Status: True
  749. Type: Ready
  750. Refresh Time: 2022-05-21T21:06:47Z
  751. Synced Resource Version: 1-5c833527afd7ba3f426cb0082ee7e083
  752. Events:
  753. Type Reason Age From Message
  754. ---- ------ ---- ---- -------
  755. Warning UpdateFailed 4m12s external-secrets secrets &quot;yyyyyyy&quot; already exists
  756. Normal Updated 12s (x4 over 3m12s) external-secrets Updated Secret
  757. </code></pre></div>
  758. <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>
  759. <p>In an ideally, the store should be validated and Ready.</p>
  760. <div class="highlight"><pre><span></span><code>kubectl describe css kubernetes
  761. [...]
  762. Status:
  763. Conditions:
  764. Last Transition Time: 2022-05-21T21:02:47Z
  765. Message: store validated
  766. Reason: Valid
  767. Status: True
  768. Type: Ready
  769. Events:
  770. Type Reason Age From Message
  771. ---- ------ ---- ---- -------
  772. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  773. Normal Valid 52s (x4 over 10m) cluster-secret-store store validated
  774. </code></pre></div>
  775. <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>
  776. <h2 id="upgrading-from-kes-to-eso">Upgrading from KES to ESO</h2>
  777. <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>
  778. <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.
  779. 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>
  780. </article>
  781. </div>
  782. </div>
  783. </main>
  784. <footer class="md-footer">
  785. <nav class="md-footer__inner md-grid" aria-label="Footer">
  786. <a href="../roadmap/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Roadmap" rel="prev">
  787. <div class="md-footer__button md-icon">
  788. <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>
  789. </div>
  790. <div class="md-footer__title">
  791. <div class="md-ellipsis">
  792. <span class="md-footer__direction">
  793. Previous
  794. </span>
  795. Roadmap
  796. </div>
  797. </div>
  798. </a>
  799. <a href="../stability-support/" class="md-footer__link md-footer__link--next" aria-label="Next: Stability and Support" rel="next">
  800. <div class="md-footer__title">
  801. <div class="md-ellipsis">
  802. <span class="md-footer__direction">
  803. Next
  804. </span>
  805. Stability and Support
  806. </div>
  807. </div>
  808. <div class="md-footer__button md-icon">
  809. <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>
  810. </div>
  811. </a>
  812. </nav>
  813. <div class="md-footer-meta md-typeset">
  814. <div class="md-footer-meta__inner md-grid">
  815. <div class="md-copyright">
  816. Made with
  817. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  818. Material for MkDocs
  819. </a>
  820. </div>
  821. </div>
  822. </div>
  823. </footer>
  824. </div>
  825. <div class="md-dialog" data-md-component="dialog">
  826. <div class="md-dialog__inner md-typeset"></div>
  827. </div>
  828. <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>
  829. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  830. </body>
  831. </html>