index.html 64 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>Kubernetes - 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="#external-secret-spec" 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. Kubernetes
  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="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../aws-secrets-manager/" class="md-tabs__link md-tabs__link--active">
  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--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" 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="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" 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">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/password/" class="md-nav__link">
  294. Password
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/fake/" class="md-nav__link">
  299. Fake
  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_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  307. <label class="md-nav__link" for="__nav_2_4">
  308. Reference Docs
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_2_4">
  313. <span class="md-nav__icon md-icon"></span>
  314. Reference Docs
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../../api/spec/" class="md-nav__link">
  319. API specification
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../../api/controller-options/" class="md-nav__link">
  324. Controller Options
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/metrics/" class="md-nav__link">
  329. Metrics
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. </ul>
  336. </nav>
  337. </li>
  338. <li class="md-nav__item md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  340. <label class="md-nav__link" for="__nav_3">
  341. Guides
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  345. <label class="md-nav__title" for="__nav_3">
  346. <span class="md-nav__icon md-icon"></span>
  347. Guides
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="../../guides/introduction/" class="md-nav__link">
  352. Introduction
  353. </a>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  357. <label class="md-nav__link" for="__nav_3_2">
  358. Advanced Templating
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_3_2">
  363. <span class="md-nav__icon md-icon"></span>
  364. Advanced Templating
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../../guides/templating/" class="md-nav__link">
  369. v2
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating-v1/" class="md-nav__link">
  374. v1
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../guides/generator/" class="md-nav__link">
  382. Generators
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  387. All keys, One secret
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  392. Common K8S Secret Types
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/controller-class/" class="md-nav__link">
  397. Controller Classes
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  402. Lifecycle: ownership & deletion
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  407. Decoding Strategies
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/getallsecrets/" class="md-nav__link">
  412. Getting Multiple Secrets
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  417. Multi Tenancy
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  422. Rewriting Keys
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/v1beta1/" class="md-nav__link">
  427. Upgrading to v1beta1
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/using-latest-image/" class="md-nav__link">
  432. Using Latest Image
  433. </a>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  439. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  440. <label class="md-nav__link" for="__nav_4">
  441. Provider
  442. <span class="md-nav__icon md-icon"></span>
  443. </label>
  444. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  445. <label class="md-nav__title" for="__nav_4">
  446. <span class="md-nav__icon md-icon"></span>
  447. Provider
  448. </label>
  449. <ul class="md-nav__list" data-md-scrollfix>
  450. <li class="md-nav__item">
  451. <a href="../aws-secrets-manager/" class="md-nav__link">
  452. AWS Secrets Manager
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../aws-parameter-store/" class="md-nav__link">
  457. AWS Parameter Store
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../azure-key-vault/" class="md-nav__link">
  462. Azure Key Vault
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../google-secrets-manager/" class="md-nav__link">
  467. Google Secret Manager
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../ibm-secrets-manager/" class="md-nav__link">
  472. IBM Secrets Manager
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../akeyless/" class="md-nav__link">
  477. Akeyless
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../hashicorp-vault/" class="md-nav__link">
  482. HashiCorp Vault
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../yandex-certificate-manager/" class="md-nav__link">
  487. Yandex Certificate Manager
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../yandex-lockbox/" class="md-nav__link">
  492. Yandex Lockbox
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../gitlab-variables/" class="md-nav__link">
  497. Gitlab Variables
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../oracle-vault/" class="md-nav__link">
  502. Oracle Vault
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../1password-automation/" class="md-nav__link">
  507. 1Password Secrets Automation
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../webhook/" class="md-nav__link">
  512. Webhook
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../fake/" class="md-nav__link">
  517. Fake
  518. </a>
  519. </li>
  520. <li class="md-nav__item md-nav__item--active">
  521. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  522. <label class="md-nav__link md-nav__link--active" for="__toc">
  523. Kubernetes
  524. <span class="md-nav__icon md-icon"></span>
  525. </label>
  526. <a href="./" class="md-nav__link md-nav__link--active">
  527. Kubernetes
  528. </a>
  529. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  530. <label class="md-nav__title" for="__toc">
  531. <span class="md-nav__icon md-icon"></span>
  532. Table of contents
  533. </label>
  534. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  535. <li class="md-nav__item">
  536. <a href="#external-secret-spec" class="md-nav__link">
  537. External Secret Spec
  538. </a>
  539. <nav class="md-nav" aria-label="External Secret Spec">
  540. <ul class="md-nav__list">
  541. <li class="md-nav__item">
  542. <a href="#find-by-tag-name" class="md-nav__link">
  543. find by tag &amp; name
  544. </a>
  545. </li>
  546. </ul>
  547. </nav>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="#target-api-server-configuration" class="md-nav__link">
  551. Target API-Server Configuration
  552. </a>
  553. </li>
  554. <li class="md-nav__item">
  555. <a href="#authentication" class="md-nav__link">
  556. Authentication
  557. </a>
  558. <nav class="md-nav" aria-label="Authentication">
  559. <ul class="md-nav__list">
  560. <li class="md-nav__item">
  561. <a href="#authenticating-with-bearertoken" class="md-nav__link">
  562. Authenticating with BearerToken
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="#authenticating-with-serviceaccount" class="md-nav__link">
  567. Authenticating with ServiceAccount
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="#authenticating-with-client-certificates" class="md-nav__link">
  572. Authenticating with Client Certificates
  573. </a>
  574. </li>
  575. </ul>
  576. </nav>
  577. </li>
  578. </ul>
  579. </nav>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../senhasegura-dsm/" class="md-nav__link">
  583. senhasegura DevOps Secrets Management (DSM)
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../doppler/" class="md-nav__link">
  588. Doppler
  589. </a>
  590. </li>
  591. </ul>
  592. </nav>
  593. </li>
  594. <li class="md-nav__item md-nav__item--nested">
  595. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  596. <label class="md-nav__link" for="__nav_5">
  597. Examples
  598. <span class="md-nav__icon md-icon"></span>
  599. </label>
  600. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  601. <label class="md-nav__title" for="__nav_5">
  602. <span class="md-nav__icon md-icon"></span>
  603. Examples
  604. </label>
  605. <ul class="md-nav__list" data-md-scrollfix>
  606. <li class="md-nav__item">
  607. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  608. FluxCD
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  613. Anchore Engine
  614. </a>
  615. </li>
  616. <li class="md-nav__item">
  617. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  618. Jenkins
  619. </a>
  620. </li>
  621. </ul>
  622. </nav>
  623. </li>
  624. <li class="md-nav__item md-nav__item--nested">
  625. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" data-md-state="indeterminate" type="checkbox" id="__nav_6" checked>
  626. <label class="md-nav__link" for="__nav_6">
  627. Community
  628. <span class="md-nav__icon md-icon"></span>
  629. </label>
  630. <nav class="md-nav" aria-label="Community" data-md-level="1">
  631. <label class="md-nav__title" for="__nav_6">
  632. <span class="md-nav__icon md-icon"></span>
  633. Community
  634. </label>
  635. <ul class="md-nav__list" data-md-scrollfix>
  636. <li class="md-nav__item md-nav__item--nested">
  637. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" data-md-state="indeterminate" type="checkbox" id="__nav_6_1" checked>
  638. <label class="md-nav__link" for="__nav_6_1">
  639. Contributing
  640. <span class="md-nav__icon md-icon"></span>
  641. </label>
  642. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  643. <label class="md-nav__title" for="__nav_6_1">
  644. <span class="md-nav__icon md-icon"></span>
  645. Contributing
  646. </label>
  647. <ul class="md-nav__list" data-md-scrollfix>
  648. <li class="md-nav__item">
  649. <a href="../../contributing/devguide/" class="md-nav__link">
  650. Developer guide
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="../../contributing/process/" class="md-nav__link">
  655. Contributing Process
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="../../contributing/release/" class="md-nav__link">
  660. Release Process
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../../contributing/coc/" class="md-nav__link">
  665. Code of Conduct
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../contributing/roadmap/" class="md-nav__link">
  670. Roadmap
  671. </a>
  672. </li>
  673. </ul>
  674. </nav>
  675. </li>
  676. <li class="md-nav__item md-nav__item--nested">
  677. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  678. <label class="md-nav__link" for="__nav_6_2">
  679. External Resources
  680. <span class="md-nav__icon md-icon"></span>
  681. </label>
  682. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  683. <label class="md-nav__title" for="__nav_6_2">
  684. <span class="md-nav__icon md-icon"></span>
  685. External Resources
  686. </label>
  687. <ul class="md-nav__list" data-md-scrollfix>
  688. <li class="md-nav__item">
  689. <a href="../../eso-talks/" class="md-nav__link">
  690. Talks
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="../../eso-demos/" class="md-nav__link">
  695. Demos
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../../eso-blogs/" class="md-nav__link">
  700. Blogs
  701. </a>
  702. </li>
  703. </ul>
  704. </nav>
  705. </li>
  706. </ul>
  707. </nav>
  708. </li>
  709. </ul>
  710. </nav>
  711. </div>
  712. </div>
  713. </div>
  714. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  715. <div class="md-sidebar__scrollwrap">
  716. <div class="md-sidebar__inner">
  717. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  718. <label class="md-nav__title" for="__toc">
  719. <span class="md-nav__icon md-icon"></span>
  720. Table of contents
  721. </label>
  722. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  723. <li class="md-nav__item">
  724. <a href="#external-secret-spec" class="md-nav__link">
  725. External Secret Spec
  726. </a>
  727. <nav class="md-nav" aria-label="External Secret Spec">
  728. <ul class="md-nav__list">
  729. <li class="md-nav__item">
  730. <a href="#find-by-tag-name" class="md-nav__link">
  731. find by tag &amp; name
  732. </a>
  733. </li>
  734. </ul>
  735. </nav>
  736. </li>
  737. <li class="md-nav__item">
  738. <a href="#target-api-server-configuration" class="md-nav__link">
  739. Target API-Server Configuration
  740. </a>
  741. </li>
  742. <li class="md-nav__item">
  743. <a href="#authentication" class="md-nav__link">
  744. Authentication
  745. </a>
  746. <nav class="md-nav" aria-label="Authentication">
  747. <ul class="md-nav__list">
  748. <li class="md-nav__item">
  749. <a href="#authenticating-with-bearertoken" class="md-nav__link">
  750. Authenticating with BearerToken
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="#authenticating-with-serviceaccount" class="md-nav__link">
  755. Authenticating with ServiceAccount
  756. </a>
  757. </li>
  758. <li class="md-nav__item">
  759. <a href="#authenticating-with-client-certificates" class="md-nav__link">
  760. Authenticating with Client Certificates
  761. </a>
  762. </li>
  763. </ul>
  764. </nav>
  765. </li>
  766. </ul>
  767. </nav>
  768. </div>
  769. </div>
  770. </div>
  771. <div class="md-content" data-md-component="content">
  772. <article class="md-content__inner md-typeset">
  773. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/provider/kubernetes.md" title="Edit this page" class="md-content__button md-icon">
  774. <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>
  775. </a>
  776. <h1>Kubernetes</h1>
  777. <p>External Secrets Operator allows to retrieve secrets from a Kubernetes Cluster - this can be either a remote cluster or the local one where the operator runs in.</p>
  778. <p>A <code>SecretStore</code> points to a <strong>specific namespace</strong> in the target Kubernetes Cluster. You are able to retrieve all secrets from that particular namespace given you have the correct set of RBAC permissions.</p>
  779. <p>The <code>SecretStore</code> reconciler checks if you have read access for secrets in that namespace using <code>SelfSubjectRulesReview</code>. See below on how to set that up properly.</p>
  780. <h3 id="external-secret-spec">External Secret Spec</h3>
  781. <p>This provider supports the use of the <code>Property</code> field. With it you point to the key of the remote secret. If you leave it empty it will json encode all key/value pairs.</p>
  782. <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>
  783. <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>
  784. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  785. <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">database-credentials</span><span class="w"></span>
  786. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  787. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  788. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  789. <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>
  790. <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">k8s-store</span><span class="w"> </span><span class="c1"># name of the SecretStore (or kind specified)</span><span class="w"></span>
  791. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  792. <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">database-credentials</span><span class="w"> </span><span class="c1"># name of the k8s Secret to be created</span><span class="w"></span>
  793. <span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"></span>
  794. <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>
  795. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  796. <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>
  797. <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>
  798. <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">password</span><span class="w"></span>
  799. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span><span class="w"></span>
  800. <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>
  801. <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">password</span><span class="w"></span>
  802. </code></pre></div>
  803. <h4 id="find-by-tag-name">find by tag &amp; name</h4>
  804. <p>You can fetch secrets based on labels or names matching a regexp:</p>
  805. <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>
  806. <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>
  807. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  808. <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">fetch-tls-and-nginx</span><span class="w"></span>
  809. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  810. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"></span>
  811. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span><span class="w"></span>
  812. <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>
  813. <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">k8s-store</span><span class="w"></span>
  814. <span class="w"> </span><span class="nt">target</span><span class="p">:</span><span class="w"></span>
  815. <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">fetch-tls-and-nginx</span><span class="w"></span>
  816. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span><span class="w"></span>
  817. <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>
  818. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"></span>
  819. <span class="w"> </span><span class="c1"># match secret name with regexp</span><span class="w"></span>
  820. <span class="w"> </span><span class="nt">regexp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls-.*&quot;</span><span class="w"></span>
  821. <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>
  822. <span class="w"> </span><span class="nt">tags</span><span class="p">:</span><span class="w"></span>
  823. <span class="w"> </span><span class="c1"># fetch secrets based on label combination</span><span class="w"></span>
  824. <span class="w"> </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;nginx&quot;</span><span class="w"></span>
  825. </code></pre></div>
  826. <h3 id="target-api-server-configuration">Target API-Server Configuration</h3>
  827. <p>The servers <code>url</code> can be omitted and defaults to <code>kubernetes.default</code>. You <strong>have to</strong> provide a CA certificate in order to connect to the API Server securely.
  828. For your convenience, each namespace has a ConfigMap <code>kube-root-ca.crt</code> that contains the CA certificate of the internal API Server (see <code>RootCAConfigMap</code> <a href="https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/">feature gate</a>).
  829. Use that if you want to connect to the same API server.
  830. If you want to connect to a remote API Server you need to fetch it and store it inside the cluster as ConfigMap or Secret.
  831. You may also define it inline as base64 encoded value using the <code>caBundle</code> property.</p>
  832. <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>
  833. <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>
  834. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  835. <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">k8s-store-default-ns</span><span class="w"></span>
  836. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  837. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  838. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  839. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span><span class="w"></span>
  840. <span class="w"> </span><span class="nt">remoteNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  841. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  842. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://myapiserver.tld&quot;</span><span class="w"></span>
  843. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span><span class="w"></span>
  844. <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">ConfigMap</span><span class="w"></span>
  845. <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">kube-root-ca.crt</span><span class="w"></span>
  846. <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">ca.crt</span><span class="w"></span>
  847. </code></pre></div>
  848. <h3 id="authentication">Authentication</h3>
  849. <p>It's possible to authenticate against the Kubernetes API using client certificates, a bearer token or service account. The operator enforces that exactly one authentication method is used. You can not use the service account that is mounted inside the operator, this is by design to avoid reading secrets across namespaces.</p>
  850. <p><strong>NOTE:</strong> <code>SelfSubjectRulesReview</code> permission is required in order to validation work properly. Please use the following role as reference:</p>
  851. <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">rbac.authorization.k8s.io/v1</span><span class="w"></span>
  852. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Role</span><span class="w"></span>
  853. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  854. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  855. <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">eso-store-role</span><span class="w"></span>
  856. <span class="nt">rules</span><span class="p">:</span><span class="w"></span>
  857. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiGroups</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;&quot;</span><span class="p p-Indicator">]</span><span class="w"></span>
  858. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span><span class="w"></span>
  859. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secrets</span><span class="w"></span>
  860. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span><span class="w"></span>
  861. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">get</span><span class="w"></span>
  862. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span><span class="w"></span>
  863. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watch</span><span class="w"></span>
  864. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiGroups</span><span class="p">:</span><span class="w"></span>
  865. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">authorization.k8s.io</span><span class="w"></span>
  866. <span class="w"> </span><span class="nt">resources</span><span class="p">:</span><span class="w"></span>
  867. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">selfsubjectrulesreviews</span><span class="w"></span>
  868. <span class="w"> </span><span class="nt">verbs</span><span class="p">:</span><span class="w"></span>
  869. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">create</span><span class="w"></span>
  870. </code></pre></div>
  871. <h4 id="authenticating-with-bearertoken">Authenticating with BearerToken</h4>
  872. <p>Create a Kubernetes secret with a client token. There are many ways to acquire such a token, please refer to the <a href="https://kubernetes.io/docs/reference/access-authn-authz/authentication/#authentication-strategies">Kubernetes Authentication docs</a>.</p>
  873. <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">v1</span><span class="w"></span>
  874. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Secret</span><span class="w"></span>
  875. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  876. <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">my-token</span><span class="w"></span>
  877. <span class="nt">data</span><span class="p">:</span><span class="w"></span>
  878. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;....&quot;</span><span class="w"></span>
  879. </code></pre></div>
  880. <p>Create a SecretStore: The <code>auth</code> section indicates that the type <code>token</code> will be used for authentication, it includes the path to fetch the token. Set <code>remoteNamespace</code> to the name of the namespace where your target secrets reside.</p>
  881. <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>
  882. <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>
  883. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  884. <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">k8s-store-token-auth</span><span class="w"></span>
  885. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  886. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  887. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  888. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span><span class="w"></span>
  889. <span class="w"> </span><span class="nt">remoteNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  890. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  891. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  892. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  893. <span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"></span>
  894. <span class="w"> </span><span class="nt">bearerToken</span><span class="p">:</span><span class="w"></span>
  895. <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">my-token</span><span class="w"></span>
  896. <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">token</span><span class="w"></span>
  897. </code></pre></div>
  898. <h4 id="authenticating-with-serviceaccount">Authenticating with ServiceAccount</h4>
  899. <p>Create a Kubernetes Service Account, please refer to the <a href="https://kubernetes.io/docs/reference/access-authn-authz/authentication/#service-account-tokens">Service Account Tokens Documentation</a> on how they work and how to create them.</p>
  900. <div class="highlight"><pre><span></span><code>$ kubectl create serviceaccount my-store
  901. </code></pre></div>
  902. <p>This Service Account needs permissions to read <code>Secret</code> and create <code>SelfSubjectRulesReview</code> resources. Please see the above role.</p>
  903. <div class="highlight"><pre><span></span><code>$ kubectl create rolebinding my-store --role=eso-store-role --serviceaccount=default:my-store
  904. </code></pre></div>
  905. <p>Create a SecretStore: the <code>auth</code> section indicates that the type <code>serviceAccount</code> will be used for authentication.</p>
  906. <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>
  907. <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>
  908. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  909. <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">k8s-store-sa-auth</span><span class="w"></span>
  910. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  911. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  912. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  913. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span><span class="w"></span>
  914. <span class="w"> </span><span class="nt">remoteNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  915. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  916. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  917. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  918. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span><span class="w"></span>
  919. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-store&quot;</span><span class="w"></span>
  920. </code></pre></div>
  921. <h4 id="authenticating-with-client-certificates">Authenticating with Client Certificates</h4>
  922. <p>Create a Kubernetes secret which contains the client key and certificate. See <a href="https://kubernetes.io/docs/tasks/administer-cluster/certificates/">Generate Certificates Documentations</a> on how to create them.</p>
  923. <div class="highlight"><pre><span></span><code>$ kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
  924. </code></pre></div>
  925. <p>Reference the <code>tls-secret</code> in the SecretStore</p>
  926. <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>
  927. <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>
  928. <span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
  929. <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">k8s-store-cert-auth</span><span class="w"></span>
  930. <span class="nt">spec</span><span class="p">:</span><span class="w"></span>
  931. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"></span>
  932. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span><span class="w"></span>
  933. <span class="w"> </span><span class="c1"># with this, the store is able to pull only from `default` namespace</span><span class="w"></span>
  934. <span class="w"> </span><span class="nt">remoteNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"></span>
  935. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
  936. <span class="w"> </span><span class="c1"># ...</span><span class="w"></span>
  937. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span><span class="w"></span>
  938. <span class="w"> </span><span class="nt">cert</span><span class="p">:</span><span class="w"></span>
  939. <span class="w"> </span><span class="nt">clientCert</span><span class="p">:</span><span class="w"></span>
  940. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls-secret&quot;</span><span class="w"></span>
  941. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls.crt&quot;</span><span class="w"></span>
  942. <span class="w"> </span><span class="nt">clientKey</span><span class="p">:</span><span class="w"></span>
  943. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls-secret&quot;</span><span class="w"></span>
  944. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;tls.key&quot;</span><span class="w"></span>
  945. </code></pre></div>
  946. </article>
  947. </div>
  948. </div>
  949. </main>
  950. <footer class="md-footer">
  951. <nav class="md-footer__inner md-grid" aria-label="Footer">
  952. <a href="../fake/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Fake" rel="prev">
  953. <div class="md-footer__button md-icon">
  954. <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>
  955. </div>
  956. <div class="md-footer__title">
  957. <div class="md-ellipsis">
  958. <span class="md-footer__direction">
  959. Previous
  960. </span>
  961. Fake
  962. </div>
  963. </div>
  964. </a>
  965. <a href="../senhasegura-dsm/" class="md-footer__link md-footer__link--next" aria-label="Next: senhasegura DevOps Secrets Management (DSM)" rel="next">
  966. <div class="md-footer__title">
  967. <div class="md-ellipsis">
  968. <span class="md-footer__direction">
  969. Next
  970. </span>
  971. senhasegura DevOps Secrets Management (DSM)
  972. </div>
  973. </div>
  974. <div class="md-footer__button md-icon">
  975. <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>
  976. </div>
  977. </a>
  978. </nav>
  979. <div class="md-footer-meta md-typeset">
  980. <div class="md-footer-meta__inner md-grid">
  981. <div class="md-copyright">
  982. <div class="md-copyright__highlight">
  983. &copy; 2022 The external-secrets Authors.<br/>
  984. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  985. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  986. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  987. </div>
  988. Made with
  989. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  990. Material for MkDocs
  991. </a>
  992. </div>
  993. </div>
  994. </div>
  995. </footer>
  996. </div>
  997. <div class="md-dialog" data-md-component="dialog">
  998. <div class="md-dialog__inner md-typeset"></div>
  999. </div>
  1000. <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>
  1001. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1002. </body>
  1003. </html>