index.html 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223
  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>ExternalSecret - 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="#template" 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. ExternalSecret
  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">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../components/" class="md-tabs__link md-tabs__link--active">
  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--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" 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="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item md-nav__item--active">
  236. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  237. <label class="md-nav__link md-nav__link--active" for="__toc">
  238. ExternalSecret
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <a href="./" class="md-nav__link md-nav__link--active">
  242. ExternalSecret
  243. </a>
  244. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  245. <label class="md-nav__title" for="__toc">
  246. <span class="md-nav__icon md-icon"></span>
  247. Table of contents
  248. </label>
  249. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  250. <li class="md-nav__item">
  251. <a href="#template" class="md-nav__link">
  252. Template
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="#update-behavior" class="md-nav__link">
  257. Update Behavior
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="#features" class="md-nav__link">
  262. Features
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="#example" class="md-nav__link">
  267. Example
  268. </a>
  269. </li>
  270. </ul>
  271. </nav>
  272. </li>
  273. <li class="md-nav__item">
  274. <a href="../secretstore/" class="md-nav__link">
  275. SecretStore
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../clustersecretstore/" class="md-nav__link">
  280. ClusterSecretStore
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../clusterexternalsecret/" class="md-nav__link">
  285. ClusterExternalSecret
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="../pushsecret/" class="md-nav__link">
  290. PushSecret
  291. </a>
  292. </li>
  293. </ul>
  294. </nav>
  295. </li>
  296. <li class="md-nav__item md-nav__item--nested">
  297. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  298. <div class="md-nav__link md-nav__link--index ">
  299. <a href="../generator/">Generators</a>
  300. <label for="__nav_2_3">
  301. <span class="md-nav__icon md-icon"></span>
  302. </label>
  303. </div>
  304. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  305. <label class="md-nav__title" for="__nav_2_3">
  306. <span class="md-nav__icon md-icon"></span>
  307. Generators
  308. </label>
  309. <ul class="md-nav__list" data-md-scrollfix>
  310. <li class="md-nav__item">
  311. <a href="../generator/acr/" class="md-nav__link">
  312. Azure Container Registry
  313. </a>
  314. </li>
  315. <li class="md-nav__item">
  316. <a href="../generator/ecr/" class="md-nav__link">
  317. AWS Elastic Container Registry
  318. </a>
  319. </li>
  320. <li class="md-nav__item">
  321. <a href="../generator/gcr/" class="md-nav__link">
  322. Google Container Registry
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../generator/vault/" class="md-nav__link">
  327. Vault Dynamic Secret
  328. </a>
  329. </li>
  330. <li class="md-nav__item">
  331. <a href="../generator/password/" class="md-nav__link">
  332. Password
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../generator/fake/" class="md-nav__link">
  337. Fake
  338. </a>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  345. <label class="md-nav__link" for="__nav_2_4">
  346. Reference Docs
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  350. <label class="md-nav__title" for="__nav_2_4">
  351. <span class="md-nav__icon md-icon"></span>
  352. Reference Docs
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../spec/" class="md-nav__link">
  357. API specification
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../controller-options/" class="md-nav__link">
  362. Controller Options
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../metrics/" class="md-nav__link">
  367. Metrics
  368. </a>
  369. </li>
  370. </ul>
  371. </nav>
  372. </li>
  373. </ul>
  374. </nav>
  375. </li>
  376. <li class="md-nav__item md-nav__item--nested">
  377. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  378. <label class="md-nav__link" for="__nav_3">
  379. Guides
  380. <span class="md-nav__icon md-icon"></span>
  381. </label>
  382. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  383. <label class="md-nav__title" for="__nav_3">
  384. <span class="md-nav__icon md-icon"></span>
  385. Guides
  386. </label>
  387. <ul class="md-nav__list" data-md-scrollfix>
  388. <li class="md-nav__item">
  389. <a href="../../guides/introduction/" class="md-nav__link">
  390. Introduction
  391. </a>
  392. </li>
  393. <li class="md-nav__item md-nav__item--nested">
  394. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  395. <label class="md-nav__link" for="__nav_3_2">
  396. Advanced Templating
  397. <span class="md-nav__icon md-icon"></span>
  398. </label>
  399. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  400. <label class="md-nav__title" for="__nav_3_2">
  401. <span class="md-nav__icon md-icon"></span>
  402. Advanced Templating
  403. </label>
  404. <ul class="md-nav__list" data-md-scrollfix>
  405. <li class="md-nav__item">
  406. <a href="../../guides/templating/" class="md-nav__link">
  407. v2
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/templating-v1/" class="md-nav__link">
  412. v1
  413. </a>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../guides/generator/" class="md-nav__link">
  420. Generators
  421. </a>
  422. </li>
  423. <li class="md-nav__item">
  424. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  425. All keys, One secret
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  430. Common K8S Secret Types
  431. </a>
  432. </li>
  433. <li class="md-nav__item">
  434. <a href="../../guides/controller-class/" class="md-nav__link">
  435. Controller Classes
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  440. Lifecycle: ownership & deletion
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  445. Decoding Strategies
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../../guides/getallsecrets/" class="md-nav__link">
  450. Getting Multiple Secrets
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  455. Multi Tenancy
  456. </a>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  460. Rewriting Keys
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../../guides/v1beta1/" class="md-nav__link">
  465. Upgrading to v1beta1
  466. </a>
  467. </li>
  468. <li class="md-nav__item">
  469. <a href="../../guides/using-latest-image/" class="md-nav__link">
  470. Using Latest Image
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  475. Disable Cluster Features
  476. </a>
  477. </li>
  478. </ul>
  479. </nav>
  480. </li>
  481. <li class="md-nav__item md-nav__item--nested">
  482. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  483. <label class="md-nav__link" for="__nav_4">
  484. Provider
  485. <span class="md-nav__icon md-icon"></span>
  486. </label>
  487. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  488. <label class="md-nav__title" for="__nav_4">
  489. <span class="md-nav__icon md-icon"></span>
  490. Provider
  491. </label>
  492. <ul class="md-nav__list" data-md-scrollfix>
  493. <li class="md-nav__item">
  494. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  495. AWS Secrets Manager
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  500. AWS Parameter Store
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  505. Azure Key Vault
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  510. Google Secret Manager
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  515. IBM Secrets Manager
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../provider/akeyless/" class="md-nav__link">
  520. Akeyless
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  525. HashiCorp Vault
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  530. Yandex Certificate Manager
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  535. Yandex Lockbox
  536. </a>
  537. </li>
  538. <li class="md-nav__item">
  539. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  540. Gitlab Variables
  541. </a>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="../../provider/oracle-vault/" class="md-nav__link">
  545. Oracle Vault
  546. </a>
  547. </li>
  548. <li class="md-nav__item">
  549. <a href="../../provider/1password-automation/" class="md-nav__link">
  550. 1Password Secrets Automation
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../provider/webhook/" class="md-nav__link">
  555. Webhook
  556. </a>
  557. </li>
  558. <li class="md-nav__item">
  559. <a href="../../provider/fake/" class="md-nav__link">
  560. Fake
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../../provider/kubernetes/" class="md-nav__link">
  565. Kubernetes
  566. </a>
  567. </li>
  568. <li class="md-nav__item">
  569. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  570. senhasegura DevOps Secrets Management (DSM)
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../../provider/doppler/" class="md-nav__link">
  575. Doppler
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../provider/keeper-security/" class="md-nav__link">
  580. Keeper Security
  581. </a>
  582. </li>
  583. <li class="md-nav__item">
  584. <a href="../../provider/scaleway/" class="md-nav__link">
  585. Scaleway
  586. </a>
  587. </li>
  588. </ul>
  589. </nav>
  590. </li>
  591. <li class="md-nav__item md-nav__item--nested">
  592. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  593. <label class="md-nav__link" for="__nav_5">
  594. Examples
  595. <span class="md-nav__icon md-icon"></span>
  596. </label>
  597. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  598. <label class="md-nav__title" for="__nav_5">
  599. <span class="md-nav__icon md-icon"></span>
  600. Examples
  601. </label>
  602. <ul class="md-nav__list" data-md-scrollfix>
  603. <li class="md-nav__item">
  604. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  605. FluxCD
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  610. Anchore Engine
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  615. Jenkins
  616. </a>
  617. </li>
  618. </ul>
  619. </nav>
  620. </li>
  621. <li class="md-nav__item md-nav__item--nested">
  622. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  623. <label class="md-nav__link" for="__nav_6">
  624. Community
  625. <span class="md-nav__icon md-icon"></span>
  626. </label>
  627. <nav class="md-nav" aria-label="Community" data-md-level="1">
  628. <label class="md-nav__title" for="__nav_6">
  629. <span class="md-nav__icon md-icon"></span>
  630. Community
  631. </label>
  632. <ul class="md-nav__list" data-md-scrollfix>
  633. <li class="md-nav__item md-nav__item--nested">
  634. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  635. <label class="md-nav__link" for="__nav_6_1">
  636. Contributing
  637. <span class="md-nav__icon md-icon"></span>
  638. </label>
  639. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  640. <label class="md-nav__title" for="__nav_6_1">
  641. <span class="md-nav__icon md-icon"></span>
  642. Contributing
  643. </label>
  644. <ul class="md-nav__list" data-md-scrollfix>
  645. <li class="md-nav__item">
  646. <a href="../../contributing/devguide/" class="md-nav__link">
  647. Developer guide
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="../../contributing/process/" class="md-nav__link">
  652. Contributing Process
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../contributing/release/" class="md-nav__link">
  657. Release Process
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="../../contributing/coc/" class="md-nav__link">
  662. Code of Conduct
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../contributing/roadmap/" class="md-nav__link">
  667. Roadmap
  668. </a>
  669. </li>
  670. </ul>
  671. </nav>
  672. </li>
  673. <li class="md-nav__item md-nav__item--nested">
  674. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  675. <label class="md-nav__link" for="__nav_6_2">
  676. External Resources
  677. <span class="md-nav__icon md-icon"></span>
  678. </label>
  679. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  680. <label class="md-nav__title" for="__nav_6_2">
  681. <span class="md-nav__icon md-icon"></span>
  682. External Resources
  683. </label>
  684. <ul class="md-nav__list" data-md-scrollfix>
  685. <li class="md-nav__item">
  686. <a href="../../eso-talks/" class="md-nav__link">
  687. Talks
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../../eso-demos/" class="md-nav__link">
  692. Demos
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="../../eso-blogs/" class="md-nav__link">
  697. Blogs
  698. </a>
  699. </li>
  700. </ul>
  701. </nav>
  702. </li>
  703. </ul>
  704. </nav>
  705. </li>
  706. </ul>
  707. </nav>
  708. </div>
  709. </div>
  710. </div>
  711. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  712. <div class="md-sidebar__scrollwrap">
  713. <div class="md-sidebar__inner">
  714. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  715. <label class="md-nav__title" for="__toc">
  716. <span class="md-nav__icon md-icon"></span>
  717. Table of contents
  718. </label>
  719. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  720. <li class="md-nav__item">
  721. <a href="#template" class="md-nav__link">
  722. Template
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="#update-behavior" class="md-nav__link">
  727. Update Behavior
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="#features" class="md-nav__link">
  732. Features
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="#example" class="md-nav__link">
  737. Example
  738. </a>
  739. </li>
  740. </ul>
  741. </nav>
  742. </div>
  743. </div>
  744. </div>
  745. <div class="md-content" data-md-component="content">
  746. <article class="md-content__inner md-typeset">
  747. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/api/externalsecret.md" title="Edit this page" class="md-content__button md-icon">
  748. <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>
  749. </a>
  750. <h1>ExternalSecret</h1>
  751. <p>The <code>ExternalSecret</code> describes what data should be fetched, how the data should
  752. be transformed and saved as a <code>Kind=Secret</code>:</p>
  753. <ul>
  754. <li>tells the operator what secrets should be synced by using <code>spec.data</code> to
  755. explicitly sync individual keys or use <code>spec.dataFrom</code> to get <strong>all values</strong>
  756. from the external API.</li>
  757. <li>you can specify how the secret should look like by specifying a
  758. <code>spec.target.template</code></li>
  759. </ul>
  760. <h2 id="template">Template</h2>
  761. <p>When the controller reconciles the <code>ExternalSecret</code> it will use the <code>spec.template</code> as a blueprint to construct a new <code>Kind=Secret</code>. You can use golang templates to define the blueprint and use template functions to transform secret values. You can also pull in <code>ConfigMaps</code> that contain golang-template data using <code>templateFrom</code>. See <a href="../../guides/templating/">advanced templating</a> for details.</p>
  762. <h2 id="update-behavior">Update Behavior</h2>
  763. <p>The <code>Kind=Secret</code> is updated when:</p>
  764. <ul>
  765. <li>the <code>spec.refreshInterval</code> has passed and is not <code>0</code></li>
  766. <li>the <code>ExternalSecret</code>'s <code>labels</code> or <code>annotations</code> are changed</li>
  767. <li>the <code>ExternalSecret</code>'s <code>spec</code> has been changed</li>
  768. </ul>
  769. <p>You can trigger a secret refresh by using kubectl or any other kubernetes api client:</p>
  770. <div class="highlight"><pre><span></span><code>kubectl annotate es my-es force-sync=$(date +%s) --overwrite
  771. </code></pre></div>
  772. <h2 id="features">Features</h2>
  773. <p>Individual features are described in the <a href="../../guides/introduction/">Guides section</a>:</p>
  774. <ul>
  775. <li><a href="../../guides/getallsecrets/">Find many secrets / Extract from structured data</a></li>
  776. <li><a href="../../guides/templating/">Templating</a></li>
  777. <li><a href="../../guides/generator/">Using Generators</a></li>
  778. <li><a href="../../guides/ownership-deletion-policy/">Secret Ownership and Deletion</a></li>
  779. <li><a href="../../guides/datafrom-rewrite/">Key Rewriting</a></li>
  780. <li><a href="../../guides/decoding-strategy/">Decoding Strategy</a></li>
  781. </ul>
  782. <h2 id="example">Example</h2>
  783. <p>Take a look at an annotated example to understand the design behind the
  784. <code>ExternalSecret</code>.</p>
  785. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span><span class="w"></span>
  786. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span><span class="w"></span>
  787. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  788. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;hello-world&quot;</span><span class="w"></span>
  789. <span class="w"> </span><span class="c1"># labels and annotations are copied over to the</span><span class="w"></span>
  790. <span class="w"> </span><span class="c1"># secret that will be created</span><span class="w"></span>
  791. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"></span>
  792. <span class="w"> </span><span class="nt">acme.org/owned-by</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;q-team&quot;</span><span class="w"></span>
  793. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"></span>
  794. <span class="w"> </span><span class="nt">acme.org/sha</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1234</span><span class="w"></span>
  795. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  796. <span class="w"> </span><span class="c1"># Optional, SecretStoreRef defines the default SecretStore to use when fetching the secret data.</span><span class="w"></span>
  797. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  798. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aws-store</span><span class="w"></span>
  799. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span><span class="w"> </span><span class="c1"># or ClusterSecretStore</span><span class="w"></span>
  800. <span class="w"> </span><span class="c1"># RefreshInterval is the amount of time before the values reading again from the SecretStore provider</span><span class="w"></span>
  801. <span class="w"> </span><span class="c1"># Valid time units are &quot;ns&quot;, &quot;us&quot; (or &quot;µs&quot;), &quot;ms&quot;, &quot;s&quot;, &quot;m&quot;, &quot;h&quot; (from time.ParseDuration)</span><span class="w"></span>
  802. <span class="w"> </span><span class="c1"># May be set to zero to fetch and create it once</span><span class="w"></span>
  803. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1h&quot;</span><span class="w"></span>
  804. <span class="w"> </span><span class="c1"># the target describes the secret that shall be created</span><span class="w"></span>
  805. <span class="w"> </span><span class="c1"># there can only be one target per ExternalSecret</span><span class="w"></span>
  806. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  807. <span class="w"> </span><span class="c1"># The secret name of the resource</span><span class="w"></span>
  808. <span class="w"> </span><span class="c1"># Defaults to .metadata.name of the ExternalSecret</span><span class="w"></span>
  809. <span class="w"> </span><span class="c1"># It is immutable</span><span class="w"></span>
  810. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application-config</span><span class="w"></span>
  811. <span class="w"> </span><span class="c1"># Enum with values: &#39;Owner&#39;, &#39;Merge&#39;, or &#39;None&#39;</span><span class="w"></span>
  812. <span class="w"> </span><span class="c1"># Default value of &#39;Owner&#39;</span><span class="w"></span>
  813. <span class="w"> </span><span class="c1"># Owner creates the secret and sets .metadata.ownerReferences of the resource</span><span class="w"></span>
  814. <span class="w"> </span><span class="c1"># Merge does not create the secret, but merges in the data fields to the secret</span><span class="w"></span>
  815. <span class="w"> </span><span class="c1"># None does not create a secret (future use with injector)</span><span class="w"></span>
  816. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;Merge&#39;</span><span class="w"></span>
  817. <span class="w"> </span><span class="c1"># DeletionPolicy defines how/when to delete the Secret in Kubernetes</span><span class="w"></span>
  818. <span class="w"> </span><span class="c1"># if the provider secret gets deleted.</span><span class="w"></span>
  819. <span class="w"> </span><span class="c1"># Valid values are Delete, Merge, Retain</span><span class="w"></span>
  820. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Retain&quot;</span><span class="w"></span>
  821. <span class="w"> </span><span class="c1"># Specify a blueprint for the resulting Kind=Secret</span><span class="w"></span>
  822. <span class="w"> </span><span class="nt">template</span><span class="p">:</span><span class="w"></span>
  823. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubernetes.io/dockerconfigjson</span><span class="w"> </span><span class="c1"># or TLS...</span><span class="w"></span>
  824. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  825. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span><span class="w"></span>
  826. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span><span class="w"></span>
  827. <span class="w"> </span><span class="c1"># Use inline templates to construct your desired config file that contains your secret</span><span class="w"></span>
  828. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  829. <span class="w"> </span><span class="nt">config.yml</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span><span class="w"></span>
  830. <span class="w"> </span><span class="no">database:</span><span class="w"></span>
  831. <span class="w"> </span><span class="no">connection: postgres://{{ .username }}:{{ .password }}@{{ .database_host }}:5432/payments</span><span class="w"></span>
  832. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span><span class="w"></span>
  833. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span><span class="w"></span>
  834. <span class="w"> </span><span class="c1"># It does not update the configmap, it creates a secret with: data[&quot;alertmanager.yml&quot;] = ...result...</span><span class="w"></span>
  835. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span><span class="w"></span>
  836. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span><span class="w"></span>
  837. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application-config-tmpl</span><span class="w"></span>
  838. <span class="w"> </span><span class="nt">items</span><span class="p">:</span><span class="w"></span>
  839. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">config.yml</span><span class="w"></span>
  840. <span class="w"> </span><span class="c1"># Data defines the connection between the Kubernetes Secret keys and the Provider data</span><span class="w"></span>
  841. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  842. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span><span class="w"></span>
  843. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  844. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">database-credentials</span><span class="w"></span>
  845. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span><span class="w"></span>
  846. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">username</span><span class="w"></span>
  847. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span><span class="w"> </span><span class="c1"># can be None, Base64, Base64URL or Auto</span><span class="w"></span>
  848. <span class="w"> </span><span class="c1"># define the source of the secret. Can be a SecretStore or a Generator kind</span><span class="w"></span>
  849. <span class="w"> </span><span class="nt">sourceRef</span><span class="p">:</span><span class="w"></span>
  850. <span class="w"> </span><span class="c1"># point to a SecretStore that should be used to fetch a secret.</span><span class="w"></span>
  851. <span class="w"> </span><span class="c1"># must be defined if no spec.secretStoreRef is defined.</span><span class="w"></span>
  852. <span class="w"> </span><span class="nt">storeRef</span><span class="p">:</span><span class="w"></span>
  853. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aws-secretstore</span><span class="w"></span>
  854. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span><span class="w"></span>
  855. <span class="w"> </span><span class="c1"># point to a generator resource that provides the secret value</span><span class="w"></span>
  856. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span><span class="w"></span>
  857. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">generators.external-secrets.io/v1alpha1</span><span class="w"></span>
  858. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Password</span><span class="w"></span>
  859. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">db-password</span><span class="w"></span>
  860. <span class="w"> </span><span class="c1"># Used to fetch all properties from the Provider key</span><span class="w"></span>
  861. <span class="w"> </span><span class="c1"># If multiple dataFrom are specified, secrets are merged in the specified order</span><span class="w"></span>
  862. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  863. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span><span class="w"></span>
  864. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">database-credentials</span><span class="w"></span>
  865. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span><span class="w"></span>
  866. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">data</span><span class="w"></span>
  867. <span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Default</span><span class="w"></span>
  868. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Auto</span><span class="w"></span>
  869. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  870. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"></span>
  871. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;exp-(.*?)-ression&quot;</span><span class="w"></span>
  872. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;rewriting-${1}-with-groups&quot;</span><span class="w"></span>
  873. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">find</span><span class="p">:</span><span class="w"></span>
  874. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path-to-filter</span><span class="w"></span>
  875. <span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">source</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">&quot;exp-(.*?)-ression&quot;</span><span class="w"></span>
  876. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;rewriting-${1}-with-groups&quot;</span><span class="w"></span>
  877. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"></span>
  878. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;.*foobar.*&quot;</span><span class="w"></span>
  879. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"></span>
  880. <span class="w"> </span><span class="nt">foo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bar</span><span class="w"></span>
  881. <span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Unicode</span><span class="w"></span>
  882. <span class="w"> </span><span class="nt">decodingStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Base64</span><span class="w"></span>
  883. <span class="w"> </span><span class="nt">rewrite</span><span class="p">:</span><span class="w"></span>
  884. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"></span>
  885. <span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"></span>
  886. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bar&quot;</span><span class="w"></span>
  887. <span class="nt">status</span><span class="p">:</span><span class="w"></span>
  888. <span class="w"> </span><span class="c1"># refreshTime is the time and date the external secret was fetched and</span><span class="w"></span>
  889. <span class="w"> </span><span class="c1"># the target secret updated</span><span class="w"></span>
  890. <span class="w"> </span><span class="nt">refreshTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span><span class="w"></span>
  891. <span class="w"> </span><span class="c1"># Standard condition schema</span><span class="w"></span>
  892. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span><span class="w"></span>
  893. <span class="w"> </span><span class="c1"># ExternalSecret ready condition indicates the secret is ready for use.</span><span class="w"></span>
  894. <span class="w"> </span><span class="c1"># This is defined as:</span><span class="w"></span>
  895. <span class="w"> </span><span class="c1"># - The target secret exists</span><span class="w"></span>
  896. <span class="w"> </span><span class="c1"># - The target secret has been refreshed within the last refreshInterval</span><span class="w"></span>
  897. <span class="w"> </span><span class="c1"># - The target secret content is up-to-date based on any target templates</span><span class="w"></span>
  898. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ready</span><span class="w"></span>
  899. <span class="w"> </span><span class="nt">status</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;True&quot;</span><span class="w"> </span><span class="c1"># False if last refresh was not successful</span><span class="w"></span>
  900. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecretSynced&quot;</span><span class="w"></span>
  901. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Secret</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">synced&quot;</span><span class="w"></span>
  902. <span class="w"> </span><span class="nt">lastTransitionTime</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-08-12T12:33:02Z&quot;</span><span class="w"></span>
  903. </code></pre></div>
  904. </article>
  905. </div>
  906. </div>
  907. </main>
  908. <footer class="md-footer">
  909. <nav class="md-footer__inner md-grid" aria-label="Footer">
  910. <a href="../components/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Components" rel="prev">
  911. <div class="md-footer__button md-icon">
  912. <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>
  913. </div>
  914. <div class="md-footer__title">
  915. <div class="md-ellipsis">
  916. <span class="md-footer__direction">
  917. Previous
  918. </span>
  919. Components
  920. </div>
  921. </div>
  922. </a>
  923. <a href="../secretstore/" class="md-footer__link md-footer__link--next" aria-label="Next: SecretStore" rel="next">
  924. <div class="md-footer__title">
  925. <div class="md-ellipsis">
  926. <span class="md-footer__direction">
  927. Next
  928. </span>
  929. SecretStore
  930. </div>
  931. </div>
  932. <div class="md-footer__button md-icon">
  933. <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>
  934. </div>
  935. </a>
  936. </nav>
  937. <div class="md-footer-meta md-typeset">
  938. <div class="md-footer-meta__inner md-grid">
  939. <div class="md-copyright">
  940. <div class="md-copyright__highlight">
  941. &copy; 2023 The external-secrets Authors.<br/>
  942. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  943. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  944. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  945. </div>
  946. Made with
  947. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  948. Material for MkDocs
  949. </a>
  950. </div>
  951. </div>
  952. </div>
  953. </footer>
  954. </div>
  955. <div class="md-dialog" data-md-component="dialog">
  956. <div class="md-dialog__inner md-typeset"></div>
  957. </div>
  958. <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>
  959. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  960. </body>
  961. </html>