index.html 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386
  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="prev" href="../secretstore/">
  7. <link rel="next" href="../clusterexternalsecret/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.9">
  10. <title>ClusterSecretStore - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.85bb2934.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__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>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#example" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <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>
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. ClusterSecretStore
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <label class="md-header__button md-icon" for="__search">
  65. <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>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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>
  74. <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>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../components/" class="md-tabs__link md-tabs__link--active">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../../guides/introduction/" class="md-tabs__link">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <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>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  168. <div class="md-nav__link md-nav__link--index ">
  169. <a href="../..">Introduction</a>
  170. <label for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. </label>
  173. </div>
  174. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  175. <label class="md-nav__title" for="__nav_1">
  176. <span class="md-nav__icon md-icon"></span>
  177. Introduction
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../../introduction/overview/" class="md-nav__link">
  182. Overview
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../../introduction/getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../introduction/faq/" class="md-nav__link">
  192. FAQ
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/stability-support/" class="md-nav__link">
  197. Stability and Support
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  202. Deprecation Policy
  203. </a>
  204. </li>
  205. </ul>
  206. </nav>
  207. </li>
  208. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  209. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  210. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  211. API
  212. <span class="md-nav__icon md-icon"></span>
  213. </label>
  214. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  215. <label class="md-nav__title" for="__nav_2">
  216. <span class="md-nav__icon md-icon"></span>
  217. API
  218. </label>
  219. <ul class="md-nav__list" data-md-scrollfix>
  220. <li class="md-nav__item">
  221. <a href="../components/" class="md-nav__link">
  222. Components
  223. </a>
  224. </li>
  225. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  226. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" checked>
  227. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  228. Core Resources
  229. <span class="md-nav__icon md-icon"></span>
  230. </label>
  231. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="true">
  232. <label class="md-nav__title" for="__nav_2_2">
  233. <span class="md-nav__icon md-icon"></span>
  234. Core Resources
  235. </label>
  236. <ul class="md-nav__list" data-md-scrollfix>
  237. <li class="md-nav__item">
  238. <a href="../externalsecret/" class="md-nav__link">
  239. ExternalSecret
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../secretstore/" class="md-nav__link">
  244. SecretStore
  245. </a>
  246. </li>
  247. <li class="md-nav__item md-nav__item--active">
  248. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  249. <label class="md-nav__link md-nav__link--active" for="__toc">
  250. ClusterSecretStore
  251. <span class="md-nav__icon md-icon"></span>
  252. </label>
  253. <a href="./" class="md-nav__link md-nav__link--active">
  254. ClusterSecretStore
  255. </a>
  256. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  257. <label class="md-nav__title" for="__toc">
  258. <span class="md-nav__icon md-icon"></span>
  259. Table of contents
  260. </label>
  261. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  262. <li class="md-nav__item">
  263. <a href="#example" class="md-nav__link">
  264. Example
  265. </a>
  266. </li>
  267. </ul>
  268. </nav>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="../clusterexternalsecret/" class="md-nav__link">
  272. ClusterExternalSecret
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../pushsecret/" class="md-nav__link">
  277. PushSecret
  278. </a>
  279. </li>
  280. </ul>
  281. </nav>
  282. </li>
  283. <li class="md-nav__item md-nav__item--nested">
  284. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  285. <div class="md-nav__link md-nav__link--index ">
  286. <a href="../generator/">Generators</a>
  287. <label for="__nav_2_3">
  288. <span class="md-nav__icon md-icon"></span>
  289. </label>
  290. </div>
  291. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  292. <label class="md-nav__title" for="__nav_2_3">
  293. <span class="md-nav__icon md-icon"></span>
  294. Generators
  295. </label>
  296. <ul class="md-nav__list" data-md-scrollfix>
  297. <li class="md-nav__item">
  298. <a href="../generator/acr/" class="md-nav__link">
  299. Azure Container Registry
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../generator/ecr/" class="md-nav__link">
  304. AWS Elastic Container Registry
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../generator/gcr/" class="md-nav__link">
  309. Google Container Registry
  310. </a>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="../generator/vault/" class="md-nav__link">
  314. Vault Dynamic Secret
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../generator/password/" class="md-nav__link">
  319. Password
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../generator/fake/" class="md-nav__link">
  324. Fake
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item md-nav__item--nested">
  331. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  332. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  333. Reference Docs
  334. <span class="md-nav__icon md-icon"></span>
  335. </label>
  336. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  337. <label class="md-nav__title" for="__nav_2_4">
  338. <span class="md-nav__icon md-icon"></span>
  339. Reference Docs
  340. </label>
  341. <ul class="md-nav__list" data-md-scrollfix>
  342. <li class="md-nav__item">
  343. <a href="../spec/" class="md-nav__link">
  344. API specification
  345. </a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="../controller-options/" class="md-nav__link">
  349. Controller Options
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../metrics/" class="md-nav__link">
  354. Metrics
  355. </a>
  356. </li>
  357. </ul>
  358. </nav>
  359. </li>
  360. </ul>
  361. </nav>
  362. </li>
  363. <li class="md-nav__item md-nav__item--nested">
  364. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  365. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  366. Guides
  367. <span class="md-nav__icon md-icon"></span>
  368. </label>
  369. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  370. <label class="md-nav__title" for="__nav_3">
  371. <span class="md-nav__icon md-icon"></span>
  372. Guides
  373. </label>
  374. <ul class="md-nav__list" data-md-scrollfix>
  375. <li class="md-nav__item">
  376. <a href="../../guides/introduction/" class="md-nav__link">
  377. Introduction
  378. </a>
  379. </li>
  380. <li class="md-nav__item md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  382. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  383. External Secrets
  384. <span class="md-nav__icon md-icon"></span>
  385. </label>
  386. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  387. <label class="md-nav__title" for="__nav_3_2">
  388. <span class="md-nav__icon md-icon"></span>
  389. External Secrets
  390. </label>
  391. <ul class="md-nav__list" data-md-scrollfix>
  392. <li class="md-nav__item">
  393. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  394. Extract structured data
  395. </a>
  396. </li>
  397. <li class="md-nav__item">
  398. <a href="../../guides/getallsecrets/" class="md-nav__link">
  399. Find Secrets by Name or Metadata
  400. </a>
  401. </li>
  402. <li class="md-nav__item">
  403. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  404. Rewriting Keys
  405. </a>
  406. </li>
  407. <li class="md-nav__item md-nav__item--nested">
  408. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  409. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  410. Advanced Templating
  411. <span class="md-nav__icon md-icon"></span>
  412. </label>
  413. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  414. <label class="md-nav__title" for="__nav_3_2_4">
  415. <span class="md-nav__icon md-icon"></span>
  416. Advanced Templating
  417. </label>
  418. <ul class="md-nav__list" data-md-scrollfix>
  419. <li class="md-nav__item">
  420. <a href="../../guides/templating/" class="md-nav__link">
  421. v2
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../../guides/templating-v1/" class="md-nav__link">
  426. v1
  427. </a>
  428. </li>
  429. </ul>
  430. </nav>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  434. Kubernetes Secret Types
  435. </a>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  439. Lifecycle: ownership & deletion
  440. </a>
  441. </li>
  442. <li class="md-nav__item">
  443. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  444. Decoding Strategies
  445. </a>
  446. </li>
  447. <li class="md-nav__item">
  448. <a href="../../guides/controller-class/" class="md-nav__link">
  449. Controller Classes
  450. </a>
  451. </li>
  452. </ul>
  453. </nav>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../../guides/generator/" class="md-nav__link">
  457. Generators
  458. </a>
  459. </li>
  460. <li class="md-nav__item md-nav__item--nested">
  461. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_4" >
  462. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  463. Operations
  464. <span class="md-nav__icon md-icon"></span>
  465. </label>
  466. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
  467. <label class="md-nav__title" for="__nav_3_4">
  468. <span class="md-nav__icon md-icon"></span>
  469. Operations
  470. </label>
  471. <ul class="md-nav__list" data-md-scrollfix>
  472. <li class="md-nav__item">
  473. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  474. Multi Tenancy
  475. </a>
  476. </li>
  477. <li class="md-nav__item">
  478. <a href="../../guides/security-best-practices/" class="md-nav__link">
  479. Security Best Practices
  480. </a>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="../../guides/threat-model/" class="md-nav__link">
  484. Threat Model
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../../guides/v1beta1/" class="md-nav__link">
  489. Upgrading to v1beta1
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="../../guides/using-latest-image/" class="md-nav__link">
  494. Using Latest Image
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  499. Disable Cluster Features
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. <li class="md-nav__item md-nav__item--nested">
  509. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  510. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  511. Provider
  512. <span class="md-nav__icon md-icon"></span>
  513. </label>
  514. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  515. <label class="md-nav__title" for="__nav_4">
  516. <span class="md-nav__icon md-icon"></span>
  517. Provider
  518. </label>
  519. <ul class="md-nav__list" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  522. AWS Secrets Manager
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  527. AWS Parameter Store
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  532. Azure Key Vault
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../../provider/conjur/" class="md-nav__link">
  537. CyberArk Conjur
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  542. Google Cloud Secret Manager
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  547. HashiCorp Vault
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../provider/kubernetes/" class="md-nav__link">
  552. Kubernetes
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  557. IBM Secrets Manager
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../provider/akeyless/" class="md-nav__link">
  562. Akeyless
  563. </a>
  564. </li>
  565. <li class="md-nav__item">
  566. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  567. Yandex Certificate Manager
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  572. Yandex Lockbox
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../provider/alibaba/" class="md-nav__link">
  577. Alibaba Cloud
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  582. GitLab Variables
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../provider/oracle-vault/" class="md-nav__link">
  587. Oracle Vault
  588. </a>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../../provider/1password-automation/" class="md-nav__link">
  592. 1Password Secrets Automation
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../provider/webhook/" class="md-nav__link">
  597. Webhook
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../../provider/fake/" class="md-nav__link">
  602. Fake
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  607. senhasegura DevOps Secrets Management (DSM)
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../provider/doppler/" class="md-nav__link">
  612. Doppler
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="../../provider/keeper-security/" class="md-nav__link">
  617. Keeper Security
  618. </a>
  619. </li>
  620. <li class="md-nav__item">
  621. <a href="../../provider/cloak/" class="md-nav__link">
  622. Cloak End 2 End Encrypted Secrets
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="../../provider/scaleway/" class="md-nav__link">
  627. Scaleway
  628. </a>
  629. </li>
  630. <li class="md-nav__item">
  631. <a href="../../provider/delinea/" class="md-nav__link">
  632. Delinea
  633. </a>
  634. </li>
  635. </ul>
  636. </nav>
  637. </li>
  638. <li class="md-nav__item md-nav__item--nested">
  639. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  640. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  641. Examples
  642. <span class="md-nav__icon md-icon"></span>
  643. </label>
  644. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  645. <label class="md-nav__title" for="__nav_5">
  646. <span class="md-nav__icon md-icon"></span>
  647. Examples
  648. </label>
  649. <ul class="md-nav__list" data-md-scrollfix>
  650. <li class="md-nav__item">
  651. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  652. FluxCD
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  657. Anchore Engine
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  662. Jenkins
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../examples/bitwarden/" class="md-nav__link">
  667. BitWarden
  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 md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  675. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  676. Community
  677. <span class="md-nav__icon md-icon"></span>
  678. </label>
  679. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  680. <label class="md-nav__title" for="__nav_6">
  681. <span class="md-nav__icon md-icon"></span>
  682. Community
  683. </label>
  684. <ul class="md-nav__list" data-md-scrollfix>
  685. <li class="md-nav__item md-nav__item--nested">
  686. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  687. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  688. Contributing
  689. <span class="md-nav__icon md-icon"></span>
  690. </label>
  691. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  692. <label class="md-nav__title" for="__nav_6_1">
  693. <span class="md-nav__icon md-icon"></span>
  694. Contributing
  695. </label>
  696. <ul class="md-nav__list" data-md-scrollfix>
  697. <li class="md-nav__item">
  698. <a href="../../contributing/devguide/" class="md-nav__link">
  699. Developer guide
  700. </a>
  701. </li>
  702. <li class="md-nav__item">
  703. <a href="../../contributing/process/" class="md-nav__link">
  704. Contributing Process
  705. </a>
  706. </li>
  707. <li class="md-nav__item">
  708. <a href="../../contributing/release/" class="md-nav__link">
  709. Release Process
  710. </a>
  711. </li>
  712. <li class="md-nav__item">
  713. <a href="../../contributing/coc/" class="md-nav__link">
  714. Code of Conduct
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../contributing/roadmap/" class="md-nav__link">
  719. Roadmap
  720. </a>
  721. </li>
  722. </ul>
  723. </nav>
  724. </li>
  725. <li class="md-nav__item md-nav__item--nested">
  726. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  727. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  728. External Resources
  729. <span class="md-nav__icon md-icon"></span>
  730. </label>
  731. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  732. <label class="md-nav__title" for="__nav_6_2">
  733. <span class="md-nav__icon md-icon"></span>
  734. External Resources
  735. </label>
  736. <ul class="md-nav__list" data-md-scrollfix>
  737. <li class="md-nav__item">
  738. <a href="../../eso-talks/" class="md-nav__link">
  739. Talks
  740. </a>
  741. </li>
  742. <li class="md-nav__item">
  743. <a href="../../eso-demos/" class="md-nav__link">
  744. Demos
  745. </a>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="../../eso-blogs/" class="md-nav__link">
  749. Blogs
  750. </a>
  751. </li>
  752. </ul>
  753. </nav>
  754. </li>
  755. </ul>
  756. </nav>
  757. </li>
  758. </ul>
  759. </nav>
  760. </div>
  761. </div>
  762. </div>
  763. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  764. <div class="md-sidebar__scrollwrap">
  765. <div class="md-sidebar__inner">
  766. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  767. <label class="md-nav__title" for="__toc">
  768. <span class="md-nav__icon md-icon"></span>
  769. Table of contents
  770. </label>
  771. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  772. <li class="md-nav__item">
  773. <a href="#example" class="md-nav__link">
  774. Example
  775. </a>
  776. </li>
  777. </ul>
  778. </nav>
  779. </div>
  780. </div>
  781. </div>
  782. <div class="md-content" data-md-component="content">
  783. <article class="md-content__inner md-typeset">
  784. <h1>ClusterSecretStore</h1>
  785. <p><img alt="ClusterSecretStore" src="../../pictures/diagrams-high-level-cluster-detail.png" /></p>
  786. <p>The <code>ClusterSecretStore</code> is a cluster scoped SecretStore that can be referenced by all
  787. <code>ExternalSecrets</code> from all namespaces. Use it to offer a central gateway to your secret backend.</p>
  788. <h2 id="example">Example</h2>
  789. <p>For a full list of supported fields see <a href="../spec/">spec</a> or dig into our <a href="../guides">guides</a>.</p>
  790. <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>
  791. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  792. <span class="nt">metadata</span><span class="p">:</span>
  793. <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">example</span>
  794. <span class="nt">spec</span><span class="p">:</span>
  795. <span class="w"> </span><span class="c1"># Used to select the correct ESO controller (think: ingress.ingressClassName)</span>
  796. <span class="w"> </span><span class="c1"># The ESO controller is instantiated with a specific controller name</span>
  797. <span class="w"> </span><span class="c1"># and filters ES based on this property</span>
  798. <span class="w"> </span><span class="c1"># Optional</span>
  799. <span class="w"> </span><span class="nt">controller</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev</span>
  800. <span class="w"> </span><span class="c1"># provider field contains the configuration to access the provider</span>
  801. <span class="w"> </span><span class="c1"># which contains the secret exactly one provider must be configured.</span>
  802. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  803. <span class="w"> </span><span class="c1"># (1): AWS Secrets Manager</span>
  804. <span class="w"> </span><span class="c1"># aws configures this store to sync secrets using AWS Secret Manager provider</span>
  805. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  806. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  807. <span class="w"> </span><span class="c1"># Role is a Role ARN which the SecretManager provider will assume</span>
  808. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">iam-role</span>
  809. <span class="w"> </span><span class="c1"># AWS Region to be used for the provider</span>
  810. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  811. <span class="w"> </span><span class="c1"># Auth defines the information necessary to authenticate against AWS</span>
  812. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  813. <span class="w"> </span><span class="c1"># Getting the accessKeyID and secretAccessKey from an already created Kubernetes Secret</span>
  814. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  815. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  816. <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">awssm-secret</span>
  817. <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">access-key</span>
  818. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  819. <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">awssm-secret</span>
  820. <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">secret-access-key</span>
  821. <span class="w"> </span><span class="c1"># IAM roles for service accounts</span>
  822. <span class="w"> </span><span class="c1"># https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-technical-overview.html</span>
  823. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  824. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  825. <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-serviceaccount</span>
  826. <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">sa-namespace</span>
  827. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span>
  828. <span class="w"> </span><span class="nt">server</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://vault.acme.org&quot;</span>
  829. <span class="w"> </span><span class="c1"># Path is the mount path of the Vault KV backend endpoint</span>
  830. <span class="w"> </span><span class="c1"># Used as a path prefix for the external secret key</span>
  831. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret&quot;</span>
  832. <span class="w"> </span><span class="c1"># Version is the Vault KV secret engine version.</span>
  833. <span class="w"> </span><span class="c1"># This can be either &quot;v1&quot; or &quot;v2&quot;, defaults to &quot;v2&quot;</span>
  834. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v2&quot;</span>
  835. <span class="w"> </span><span class="c1"># vault enterprise namespace: https://www.vaultproject.io/docs/enterprise/namespaces</span>
  836. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;a-team&quot;</span>
  837. <span class="w"> </span><span class="c1"># base64 encoded string of certificate</span>
  838. <span class="w"> </span><span class="nt">caBundle</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;...&quot;</span>
  839. <span class="w"> </span><span class="c1"># Instead of caBundle you can also specify a caProvider</span>
  840. <span class="w"> </span><span class="c1"># this will retrieve the cert from a Secret or ConfigMap</span>
  841. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  842. <span class="w"> </span><span class="c1"># Can be Secret or ConfigMap</span>
  843. <span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Secret&quot;</span>
  844. <span class="w"> </span><span class="c1"># namespace is mandatory for ClusterSecretStore and not relevant for SecretStore</span>
  845. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-cert-secret-namespace&quot;</span>
  846. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-cert-secret&quot;</span>
  847. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;cert-key&quot;</span>
  848. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  849. <span class="w"> </span><span class="c1"># static token: https://www.vaultproject.io/docs/auth/token</span>
  850. <span class="w"> </span><span class="nt">tokenSecretRef</span><span class="p">:</span>
  851. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  852. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  853. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token&quot;</span>
  854. <span class="w"> </span><span class="c1"># AppRole auth: https://www.vaultproject.io/docs/auth/approle</span>
  855. <span class="w"> </span><span class="nt">appRole</span><span class="p">:</span>
  856. <span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;approle&quot;</span>
  857. <span class="w"> </span><span class="nt">roleId</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;db02de05-fa39-4855-059b-67221c5c2f63&quot;</span>
  858. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  859. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  860. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  861. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault-token&quot;</span>
  862. <span class="w"> </span><span class="c1"># Kubernetes auth: https://www.vaultproject.io/docs/auth/kubernetes</span>
  863. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  864. <span class="w"> </span><span class="nt">mountPath</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;kubernetes&quot;</span>
  865. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;demo&quot;</span>
  866. <span class="w"> </span><span class="c1"># Optional service account reference</span>
  867. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  868. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-sa&quot;</span>
  869. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  870. <span class="w"> </span><span class="c1"># Optional secret field containing a Kubernetes ServiceAccount JWT</span>
  871. <span class="w"> </span><span class="c1"># used for authenticating with Vault</span>
  872. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  873. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;my-secret&quot;</span>
  874. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;secret-admin&quot;</span>
  875. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;vault&quot;</span>
  876. <span class="w"> </span><span class="c1"># (2): GCP Secret Manager</span>
  877. <span class="w"> </span><span class="nt">gcpsm</span><span class="p">:</span>
  878. <span class="w"> </span><span class="c1"># Auth defines the information necessary to authenticate against GCP by getting</span>
  879. <span class="w"> </span><span class="c1"># the credentials from an already created Kubernetes Secret.</span>
  880. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  881. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  882. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  883. <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">gcpsm-secret</span>
  884. <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">secret-access-credentials</span>
  885. <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">example</span>
  886. <span class="w"> </span><span class="nt">projectID</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myproject</span>
  887. <span class="w"> </span><span class="c1"># (3): Kubernetes provider</span>
  888. <span class="w"> </span><span class="nt">kubernetes</span><span class="p">:</span>
  889. <span class="w"> </span><span class="nt">server</span><span class="p">:</span>
  890. <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>
  891. <span class="w"> </span><span class="nt">caProvider</span><span class="p">:</span>
  892. <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">Secret</span>
  893. <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-cluster-secrets</span>
  894. <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">example</span>
  895. <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>
  896. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  897. <span class="w"> </span><span class="nt">serviceAccount</span><span class="p">:</span>
  898. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;example-sa&quot;</span>
  899. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;example&quot;</span>
  900. <span class="w"> </span><span class="c1"># (4): Oracle provider</span>
  901. <span class="w"> </span><span class="nt">oracle</span><span class="p">:</span>
  902. <span class="w"> </span><span class="c1"># The vault OCID</span>
  903. <span class="w"> </span><span class="nt">vault</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocid1.vault.oc1.eu-frankfurt-1.aaa1aaaaaaaaa.aaaaaaaaaaaaaa1aaaaaaa111aaaaaaaaaaaaaaaa</span>
  904. <span class="w"> </span><span class="c1"># The vault region</span>
  905. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-frankfurt-1</span>
  906. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  907. <span class="w"> </span><span class="c1"># The user OCID</span>
  908. <span class="w"> </span><span class="nt">user</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocid1.user.oc1..aaa1aaaaaaaaa.aaaaaaaaaaaaaa1aaaaaaa111aaaaaaaaaaaaaaaa</span>
  909. <span class="w"> </span><span class="c1"># The tenancy OCID</span>
  910. <span class="w"> </span><span class="nt">tenancy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ocid1.tenancy.oc1..aaa1aaaaaaaaa.aaaaaaaaaaaaaa1aaaaaaa111aaaaaaaaaaaaaaaa</span>
  911. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  912. <span class="w"> </span><span class="nt">privatekey</span><span class="p">:</span>
  913. <span class="w"> </span><span class="c1"># The secret that contains your privatekey</span>
  914. <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">oci-secret-name</span>
  915. <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">privateKey</span>
  916. <span class="w"> </span><span class="nt">fingerprint</span><span class="p">:</span>
  917. <span class="w"> </span><span class="c1"># The secret that contains your fingerprint</span>
  918. <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">oci-secret-name</span>
  919. <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">fingerprint</span>
  920. <span class="w"> </span><span class="c1"># (TODO): add more provider examples here</span>
  921. <span class="w"> </span><span class="c1"># Conditions about namespaces in which the ClusterSecretStore is usable for ExternalSecrets</span>
  922. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  923. <span class="w"> </span><span class="c1"># Options are namespaceSelector, or namespaces</span>
  924. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaceSelector</span><span class="p">:</span>
  925. <span class="w"> </span><span class="nt">matchLabels</span><span class="p">:</span>
  926. <span class="w"> </span><span class="nt">my.namespace.io/some-label</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;value&quot;</span><span class="w"> </span><span class="c1"># Only namespaces with that label will work</span>
  927. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaces</span><span class="p">:</span>
  928. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;namespace-a&quot;</span>
  929. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;namespace-b&quot;</span>
  930. <span class="w"> </span><span class="c1"># conditions needs only one of the conditions to meet for the CSS to be usable in the namespace.</span>
  931. <span class="nt">status</span><span class="p">:</span>
  932. <span class="w"> </span><span class="c1"># Standard condition schema</span>
  933. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  934. <span class="w"> </span><span class="c1"># SecretStore ready condition indicates the given store is in ready</span>
  935. <span class="w"> </span><span class="c1"># state and able to referenced by ExternalSecrets</span>
  936. <span class="w"> </span><span class="c1"># If the `status` of this condition is `False`, ExternalSecret controllers</span>
  937. <span class="w"> </span><span class="c1"># should prevent attempts to fetch secrets</span>
  938. <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>
  939. <span class="w"> </span><span class="nt">status</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;False&quot;</span>
  940. <span class="w"> </span><span class="nt">reason</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ConfigError&quot;</span>
  941. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecretStore</span><span class="nv"> </span><span class="s">validation</span><span class="nv"> </span><span class="s">failed&quot;</span>
  942. <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>
  943. </code></pre></div>
  944. </article>
  945. </div>
  946. </div>
  947. </main>
  948. <footer class="md-footer">
  949. <div class="md-footer-meta md-typeset">
  950. <div class="md-footer-meta__inner md-grid">
  951. <div class="md-copyright">
  952. <div class="md-copyright__highlight">
  953. &copy; 2023 The external-secrets Authors.<br/>
  954. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  955. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  956. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  957. </div>
  958. Made with
  959. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  960. Material for MkDocs
  961. </a>
  962. </div>
  963. </div>
  964. </div>
  965. </footer>
  966. </div>
  967. <div class="md-dialog" data-md-component="dialog">
  968. <div class="md-dialog__inner md-typeset"></div>
  969. </div>
  970. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  971. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  972. </body>
  973. </html>