index.html 52 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013
  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="../../introduction/deprecation-policy/">
  7. <link rel="next" href="../externalsecret/">
  8. <link rel="icon" href="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.7">
  10. <title>Components - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.f2e4d321.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. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#components" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  31. <aside class="md-banner md-banner--warning">
  32. <div class="md-banner__inner md-grid md-typeset">
  33. You're not viewing the latest version.
  34. <a href="../../..">
  35. <strong>Click here to go to latest.</strong>
  36. </a>
  37. </div>
  38. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  39. </aside>
  40. </div>
  41. <header class="md-header" data-md-component="header">
  42. <nav class="md-header__inner md-grid" aria-label="Header">
  43. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  44. <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>
  45. </a>
  46. <label class="md-header__button md-icon" for="__drawer">
  47. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  48. </label>
  49. <div class="md-header__title" data-md-component="header-title">
  50. <div class="md-header__ellipsis">
  51. <div class="md-header__topic">
  52. <span class="md-ellipsis">
  53. External Secrets Operator
  54. </span>
  55. </div>
  56. <div class="md-header__topic" data-md-component="header-topic">
  57. <span class="md-ellipsis">
  58. Components
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  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.5.1 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 md-tabs__item--active">
  116. <a href="./" class="md-tabs__link">
  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.5.1 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--section 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__container">
  169. <a href="../.." class="md-nav__link ">
  170. <span class="md-ellipsis">
  171. Introduction
  172. </span>
  173. </a>
  174. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
  175. <span class="md-nav__icon md-icon"></span>
  176. </label>
  177. </div>
  178. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  179. <label class="md-nav__title" for="__nav_1">
  180. <span class="md-nav__icon md-icon"></span>
  181. Introduction
  182. </label>
  183. <ul class="md-nav__list" data-md-scrollfix>
  184. <li class="md-nav__item">
  185. <a href="../../introduction/overview/" class="md-nav__link">
  186. <span class="md-ellipsis">
  187. Overview
  188. </span>
  189. </a>
  190. </li>
  191. <li class="md-nav__item">
  192. <a href="../../introduction/getting-started/" class="md-nav__link">
  193. <span class="md-ellipsis">
  194. Getting started
  195. </span>
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/faq/" class="md-nav__link">
  200. <span class="md-ellipsis">
  201. FAQ
  202. </span>
  203. </a>
  204. </li>
  205. <li class="md-nav__item">
  206. <a href="../../introduction/stability-support/" class="md-nav__link">
  207. <span class="md-ellipsis">
  208. Stability and Support
  209. </span>
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  214. <span class="md-ellipsis">
  215. Deprecation Policy
  216. </span>
  217. </a>
  218. </li>
  219. </ul>
  220. </nav>
  221. </li>
  222. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  223. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
  224. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  225. <span class="md-ellipsis">
  226. API
  227. </span>
  228. <span class="md-nav__icon md-icon"></span>
  229. </label>
  230. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
  231. <label class="md-nav__title" for="__nav_2">
  232. <span class="md-nav__icon md-icon"></span>
  233. API
  234. </label>
  235. <ul class="md-nav__list" data-md-scrollfix>
  236. <li class="md-nav__item md-nav__item--active">
  237. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  238. <label class="md-nav__link md-nav__link--active" for="__toc">
  239. <span class="md-ellipsis">
  240. Components
  241. </span>
  242. <span class="md-nav__icon md-icon"></span>
  243. </label>
  244. <a href="./" class="md-nav__link md-nav__link--active">
  245. <span class="md-ellipsis">
  246. Components
  247. </span>
  248. </a>
  249. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  250. <label class="md-nav__title" for="__toc">
  251. <span class="md-nav__icon md-icon"></span>
  252. Table of contents
  253. </label>
  254. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  255. <li class="md-nav__item">
  256. <a href="#overview" class="md-nav__link">
  257. <span class="md-ellipsis">
  258. Overview
  259. </span>
  260. </a>
  261. <nav class="md-nav" aria-label="Overview">
  262. <ul class="md-nav__list">
  263. <li class="md-nav__item">
  264. <a href="#tls-bootstrap" class="md-nav__link">
  265. <span class="md-ellipsis">
  266. TLS Bootstrap
  267. </span>
  268. </a>
  269. </li>
  270. </ul>
  271. </nav>
  272. </li>
  273. </ul>
  274. </nav>
  275. </li>
  276. <li class="md-nav__item md-nav__item--nested">
  277. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  278. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  279. <span class="md-ellipsis">
  280. Core Resources
  281. </span>
  282. <span class="md-nav__icon md-icon"></span>
  283. </label>
  284. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  285. <label class="md-nav__title" for="__nav_2_2">
  286. <span class="md-nav__icon md-icon"></span>
  287. Core Resources
  288. </label>
  289. <ul class="md-nav__list" data-md-scrollfix>
  290. <li class="md-nav__item">
  291. <a href="../externalsecret/" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. ExternalSecret
  294. </span>
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../secretstore/" class="md-nav__link">
  299. <span class="md-ellipsis">
  300. SecretStore
  301. </span>
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="../clustersecretstore/" class="md-nav__link">
  306. <span class="md-ellipsis">
  307. ClusterSecretStore
  308. </span>
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="../clusterexternalsecret/" class="md-nav__link">
  313. <span class="md-ellipsis">
  314. ClusterExternalSecret
  315. </span>
  316. </a>
  317. </li>
  318. <li class="md-nav__item">
  319. <a href="../pushsecret/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. PushSecret
  322. </span>
  323. </a>
  324. </li>
  325. </ul>
  326. </nav>
  327. </li>
  328. <li class="md-nav__item md-nav__item--nested">
  329. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  330. <div class="md-nav__link md-nav__container">
  331. <a href="../generator/" class="md-nav__link ">
  332. <span class="md-ellipsis">
  333. Generators
  334. </span>
  335. </a>
  336. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  337. <span class="md-nav__icon md-icon"></span>
  338. </label>
  339. </div>
  340. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  341. <label class="md-nav__title" for="__nav_2_3">
  342. <span class="md-nav__icon md-icon"></span>
  343. Generators
  344. </label>
  345. <ul class="md-nav__list" data-md-scrollfix>
  346. <li class="md-nav__item">
  347. <a href="../generator/acr/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Azure Container Registry
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../generator/ecr/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. AWS Elastic Container Registry
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../generator/gcr/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. Google Container Registry
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="../generator/vault/" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. Vault Dynamic Secret
  371. </span>
  372. </a>
  373. </li>
  374. <li class="md-nav__item">
  375. <a href="../generator/password/" class="md-nav__link">
  376. <span class="md-ellipsis">
  377. Password
  378. </span>
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="../generator/fake/" class="md-nav__link">
  383. <span class="md-ellipsis">
  384. Fake
  385. </span>
  386. </a>
  387. </li>
  388. </ul>
  389. </nav>
  390. </li>
  391. <li class="md-nav__item md-nav__item--nested">
  392. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  393. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  394. <span class="md-ellipsis">
  395. Reference Docs
  396. </span>
  397. <span class="md-nav__icon md-icon"></span>
  398. </label>
  399. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  400. <label class="md-nav__title" for="__nav_2_4">
  401. <span class="md-nav__icon md-icon"></span>
  402. Reference Docs
  403. </label>
  404. <ul class="md-nav__list" data-md-scrollfix>
  405. <li class="md-nav__item">
  406. <a href="../spec/" class="md-nav__link">
  407. <span class="md-ellipsis">
  408. API specification
  409. </span>
  410. </a>
  411. </li>
  412. <li class="md-nav__item">
  413. <a href="../controller-options/" class="md-nav__link">
  414. <span class="md-ellipsis">
  415. Controller Options
  416. </span>
  417. </a>
  418. </li>
  419. <li class="md-nav__item">
  420. <a href="../metrics/" class="md-nav__link">
  421. <span class="md-ellipsis">
  422. Metrics
  423. </span>
  424. </a>
  425. </li>
  426. </ul>
  427. </nav>
  428. </li>
  429. </ul>
  430. </nav>
  431. </li>
  432. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  433. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  434. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  435. <span class="md-ellipsis">
  436. Guides
  437. </span>
  438. <span class="md-nav__icon md-icon"></span>
  439. </label>
  440. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  441. <label class="md-nav__title" for="__nav_3">
  442. <span class="md-nav__icon md-icon"></span>
  443. Guides
  444. </label>
  445. <ul class="md-nav__list" data-md-scrollfix>
  446. <li class="md-nav__item">
  447. <a href="../../guides/introduction/" class="md-nav__link">
  448. <span class="md-ellipsis">
  449. Introduction
  450. </span>
  451. </a>
  452. </li>
  453. <li class="md-nav__item md-nav__item--nested">
  454. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  455. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  456. <span class="md-ellipsis">
  457. External Secrets
  458. </span>
  459. <span class="md-nav__icon md-icon"></span>
  460. </label>
  461. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  462. <label class="md-nav__title" for="__nav_3_2">
  463. <span class="md-nav__icon md-icon"></span>
  464. External Secrets
  465. </label>
  466. <ul class="md-nav__list" data-md-scrollfix>
  467. <li class="md-nav__item">
  468. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  469. <span class="md-ellipsis">
  470. Extract structured data
  471. </span>
  472. </a>
  473. </li>
  474. <li class="md-nav__item">
  475. <a href="../../guides/getallsecrets/" class="md-nav__link">
  476. <span class="md-ellipsis">
  477. Find Secrets by Name or Metadata
  478. </span>
  479. </a>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. Rewriting Keys
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item md-nav__item--nested">
  489. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  490. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  491. <span class="md-ellipsis">
  492. Advanced Templating
  493. </span>
  494. <span class="md-nav__icon md-icon"></span>
  495. </label>
  496. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  497. <label class="md-nav__title" for="__nav_3_2_4">
  498. <span class="md-nav__icon md-icon"></span>
  499. Advanced Templating
  500. </label>
  501. <ul class="md-nav__list" data-md-scrollfix>
  502. <li class="md-nav__item">
  503. <a href="../../guides/templating/" class="md-nav__link">
  504. <span class="md-ellipsis">
  505. v2
  506. </span>
  507. </a>
  508. </li>
  509. <li class="md-nav__item">
  510. <a href="../../guides/templating-v1/" class="md-nav__link">
  511. <span class="md-ellipsis">
  512. v1
  513. </span>
  514. </a>
  515. </li>
  516. </ul>
  517. </nav>
  518. </li>
  519. <li class="md-nav__item">
  520. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  521. <span class="md-ellipsis">
  522. Kubernetes Secret Types
  523. </span>
  524. </a>
  525. </li>
  526. <li class="md-nav__item">
  527. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  528. <span class="md-ellipsis">
  529. Lifecycle: ownership & deletion
  530. </span>
  531. </a>
  532. </li>
  533. <li class="md-nav__item">
  534. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  535. <span class="md-ellipsis">
  536. Decoding Strategies
  537. </span>
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../../guides/controller-class/" class="md-nav__link">
  542. <span class="md-ellipsis">
  543. Controller Classes
  544. </span>
  545. </a>
  546. </li>
  547. </ul>
  548. </nav>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../guides/generator/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. Generators
  554. </span>
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../../guides/pushsecrets/" class="md-nav__link">
  559. <span class="md-ellipsis">
  560. Push Secrets
  561. </span>
  562. </a>
  563. </li>
  564. <li class="md-nav__item md-nav__item--nested">
  565. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  566. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  567. <span class="md-ellipsis">
  568. Operations
  569. </span>
  570. <span class="md-nav__icon md-icon"></span>
  571. </label>
  572. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  573. <label class="md-nav__title" for="__nav_3_5">
  574. <span class="md-nav__icon md-icon"></span>
  575. Operations
  576. </label>
  577. <ul class="md-nav__list" data-md-scrollfix>
  578. <li class="md-nav__item">
  579. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. Multi Tenancy
  582. </span>
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../guides/security-best-practices/" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. Security Best Practices
  589. </span>
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../guides/threat-model/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. Threat Model
  596. </span>
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="../../guides/v1beta1/" class="md-nav__link">
  601. <span class="md-ellipsis">
  602. Upgrading to v1beta1
  603. </span>
  604. </a>
  605. </li>
  606. <li class="md-nav__item">
  607. <a href="../../guides/using-latest-image/" class="md-nav__link">
  608. <span class="md-ellipsis">
  609. Using Latest Image
  610. </span>
  611. </a>
  612. </li>
  613. <li class="md-nav__item">
  614. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  615. <span class="md-ellipsis">
  616. Disable Cluster Features
  617. </span>
  618. </a>
  619. </li>
  620. </ul>
  621. </nav>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  627. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  628. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  629. <span class="md-ellipsis">
  630. Provider
  631. </span>
  632. <span class="md-nav__icon md-icon"></span>
  633. </label>
  634. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  635. <label class="md-nav__title" for="__nav_4">
  636. <span class="md-nav__icon md-icon"></span>
  637. Provider
  638. </label>
  639. <ul class="md-nav__list" data-md-scrollfix>
  640. <li class="md-nav__item">
  641. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. AWS Secrets Manager
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. AWS Parameter Store
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. Azure Key Vault
  658. </span>
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../../provider/conjur/" class="md-nav__link">
  663. <span class="md-ellipsis">
  664. CyberArk Conjur
  665. </span>
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. Google Cloud Secret Manager
  672. </span>
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. HashiCorp Vault
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../provider/kubernetes/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. Kubernetes
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. IBM Secrets Manager
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../provider/akeyless/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Akeyless
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. Yandex Certificate Manager
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. Yandex Lockbox
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/alibaba/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. Alibaba Cloud
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. GitLab Variables
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/oracle-vault/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Oracle Vault
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/1password-automation/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. 1Password Secrets Automation
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/webhook/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Webhook
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/fake/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Fake
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. senhasegura DevOps Secrets Management (DSM)
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/doppler/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Doppler
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/keeper-security/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Keeper Security
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/cloak/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Cloak End 2 End Encrypted Secrets
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/scaleway/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. Scaleway
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/delinea/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Delinea
  798. </span>
  799. </a>
  800. </li>
  801. </ul>
  802. </nav>
  803. </li>
  804. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  805. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  806. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
  807. <span class="md-ellipsis">
  808. Examples
  809. </span>
  810. <span class="md-nav__icon md-icon"></span>
  811. </label>
  812. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  813. <label class="md-nav__title" for="__nav_5">
  814. <span class="md-nav__icon md-icon"></span>
  815. Examples
  816. </label>
  817. <ul class="md-nav__list" data-md-scrollfix>
  818. <li class="md-nav__item">
  819. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  820. <span class="md-ellipsis">
  821. FluxCD
  822. </span>
  823. </a>
  824. </li>
  825. <li class="md-nav__item">
  826. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  827. <span class="md-ellipsis">
  828. Anchore Engine
  829. </span>
  830. </a>
  831. </li>
  832. <li class="md-nav__item">
  833. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  834. <span class="md-ellipsis">
  835. Jenkins
  836. </span>
  837. </a>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="../../examples/bitwarden/" class="md-nav__link">
  841. <span class="md-ellipsis">
  842. BitWarden
  843. </span>
  844. </a>
  845. </li>
  846. </ul>
  847. </nav>
  848. </li>
  849. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  850. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  851. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  852. <span class="md-ellipsis">
  853. Community
  854. </span>
  855. <span class="md-nav__icon md-icon"></span>
  856. </label>
  857. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  858. <label class="md-nav__title" for="__nav_6">
  859. <span class="md-nav__icon md-icon"></span>
  860. Community
  861. </label>
  862. <ul class="md-nav__list" data-md-scrollfix>
  863. <li class="md-nav__item md-nav__item--nested">
  864. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  865. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  866. <span class="md-ellipsis">
  867. Contributing
  868. </span>
  869. <span class="md-nav__icon md-icon"></span>
  870. </label>
  871. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  872. <label class="md-nav__title" for="__nav_6_1">
  873. <span class="md-nav__icon md-icon"></span>
  874. Contributing
  875. </label>
  876. <ul class="md-nav__list" data-md-scrollfix>
  877. <li class="md-nav__item">
  878. <a href="../../contributing/devguide/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. Developer guide
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../../contributing/process/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. Contributing Process
  888. </span>
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../../contributing/release/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Release Process
  895. </span>
  896. </a>
  897. </li>
  898. <li class="md-nav__item">
  899. <a href="../../contributing/coc/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. Code of Conduct
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="../../contributing/roadmap/" class="md-nav__link">
  907. <span class="md-ellipsis">
  908. Roadmap
  909. </span>
  910. </a>
  911. </li>
  912. </ul>
  913. </nav>
  914. </li>
  915. <li class="md-nav__item md-nav__item--nested">
  916. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  917. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  918. <span class="md-ellipsis">
  919. External Resources
  920. </span>
  921. <span class="md-nav__icon md-icon"></span>
  922. </label>
  923. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  924. <label class="md-nav__title" for="__nav_6_2">
  925. <span class="md-nav__icon md-icon"></span>
  926. External Resources
  927. </label>
  928. <ul class="md-nav__list" data-md-scrollfix>
  929. <li class="md-nav__item">
  930. <a href="../../eso-talks/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. Talks
  933. </span>
  934. </a>
  935. </li>
  936. <li class="md-nav__item">
  937. <a href="../../eso-demos/" class="md-nav__link">
  938. <span class="md-ellipsis">
  939. Demos
  940. </span>
  941. </a>
  942. </li>
  943. <li class="md-nav__item">
  944. <a href="../../eso-blogs/" class="md-nav__link">
  945. <span class="md-ellipsis">
  946. Blogs
  947. </span>
  948. </a>
  949. </li>
  950. </ul>
  951. </nav>
  952. </li>
  953. </ul>
  954. </nav>
  955. </li>
  956. </ul>
  957. </nav>
  958. </div>
  959. </div>
  960. </div>
  961. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  962. <div class="md-sidebar__scrollwrap">
  963. <div class="md-sidebar__inner">
  964. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  965. <label class="md-nav__title" for="__toc">
  966. <span class="md-nav__icon md-icon"></span>
  967. Table of contents
  968. </label>
  969. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  970. <li class="md-nav__item">
  971. <a href="#overview" class="md-nav__link">
  972. <span class="md-ellipsis">
  973. Overview
  974. </span>
  975. </a>
  976. <nav class="md-nav" aria-label="Overview">
  977. <ul class="md-nav__list">
  978. <li class="md-nav__item">
  979. <a href="#tls-bootstrap" class="md-nav__link">
  980. <span class="md-ellipsis">
  981. TLS Bootstrap
  982. </span>
  983. </a>
  984. </li>
  985. </ul>
  986. </nav>
  987. </li>
  988. </ul>
  989. </nav>
  990. </div>
  991. </div>
  992. </div>
  993. <div class="md-content" data-md-component="content">
  994. <article class="md-content__inner md-typeset">
  995. <h1 id="components">Components</h1>
  996. <h2 id="overview">Overview</h2>
  997. <p>Exernal Secrets comes with three components: <code>Core Controller</code>, <code>Webhook</code> and <code>Cert Controller</code>.</p>
  998. <p>This is due to the need to implement conversion webhooks in order to convert custom resources between api versions and
  999. to provide a ValidatingWebhook for the <code>ExternalSecret</code> and <code>SecretStore</code> resources.</p>
  1000. <p>These features are optional but highly recommended. You can disable them with helm chart values <code>certController.create=false</code> and <code>webhook.create=false</code>.</p>
  1001. <p><br/>
  1002. <img alt="Component Overview" src="../../pictures/diagrams-component-overview.png" /></p>
  1003. <h3 id="tls-bootstrap">TLS Bootstrap</h3>
  1004. <p>Cert-controller is responsible for (1) generating TLS credentials which will be used by the webhook component and (2) injecting the certificate as <code>caBundle</code> into <code>Kind=CustomResourceDefinition</code> for conversion webhooks and <code>Kind=ValidatingWebhookConfiguration</code> for validating admission webhook. The TLS credentials are stored in a <code>Kind=Secret</code> which is consumed by the webhook.</p>
  1005. <p><img alt="" src="../../pictures/eso-threat-model-TLS%20Bootstrap.drawio.png" style="width:70%;" /></p>
  1006. </article>
  1007. </div>
  1008. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1009. </div>
  1010. </main>
  1011. <footer class="md-footer">
  1012. <div class="md-footer-meta md-typeset">
  1013. <div class="md-footer-meta__inner md-grid">
  1014. <div class="md-copyright">
  1015. <div class="md-copyright__highlight">
  1016. &copy; 2023 The external-secrets Authors.<br/>
  1017. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1018. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1019. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1020. </div>
  1021. Made with
  1022. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1023. Material for MkDocs
  1024. </a>
  1025. </div>
  1026. </div>
  1027. </div>
  1028. </footer>
  1029. </div>
  1030. <div class="md-dialog" data-md-component="dialog">
  1031. <div class="md-dialog__inner md-typeset"></div>
  1032. </div>
  1033. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.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>
  1034. <script src="../../assets/javascripts/bundle.caa56a14.min.js"></script>
  1035. </body>
  1036. </html>