index.html 77 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189
  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="../..">
  7. <link rel="next" href="../getting-started/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.15">
  10. <title>Overview - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.7e359304.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="#api-overview" 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. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  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. Overview
  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 md-tabs__item--active">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" 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. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. <li class="md-tabs__item">
  146. <a href="../../contributing-devguide.md" class="md-tabs__link">
  147. Contributing
  148. </a>
  149. </li>
  150. <li class="md-tabs__item">
  151. <a href="../../deprecation-policy.md" class="md-tabs__link">
  152. Deprecation Policy
  153. </a>
  154. </li>
  155. </ul>
  156. </div>
  157. </nav>
  158. <main class="md-main" data-md-component="main">
  159. <div class="md-main__inner md-grid">
  160. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  161. <div class="md-sidebar__scrollwrap">
  162. <div class="md-sidebar__inner">
  163. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  164. <label class="md-nav__title" for="__drawer">
  165. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  166. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  167. </a>
  168. External Secrets Operator
  169. </label>
  170. <div class="md-nav__source">
  171. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  172. <div class="md-source__icon md-icon">
  173. <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>
  174. </div>
  175. <div class="md-source__repository">
  176. External Secrets Operator
  177. </div>
  178. </a>
  179. </div>
  180. <ul class="md-nav__list" data-md-scrollfix>
  181. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  182. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  183. <div class="md-nav__link md-nav__container">
  184. <a href="../.." class="md-nav__link ">
  185. <span class="md-ellipsis">
  186. Introduction
  187. </span>
  188. </a>
  189. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
  190. <span class="md-nav__icon md-icon"></span>
  191. </label>
  192. </div>
  193. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  194. <label class="md-nav__title" for="__nav_1">
  195. <span class="md-nav__icon md-icon"></span>
  196. Introduction
  197. </label>
  198. <ul class="md-nav__list" data-md-scrollfix>
  199. <li class="md-nav__item md-nav__item--active">
  200. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  201. <label class="md-nav__link md-nav__link--active" for="__toc">
  202. <span class="md-ellipsis">
  203. Overview
  204. </span>
  205. <span class="md-nav__icon md-icon"></span>
  206. </label>
  207. <a href="./" class="md-nav__link md-nav__link--active">
  208. <span class="md-ellipsis">
  209. Overview
  210. </span>
  211. </a>
  212. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  213. <label class="md-nav__title" for="__toc">
  214. <span class="md-nav__icon md-icon"></span>
  215. Table of contents
  216. </label>
  217. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="#architecture" class="md-nav__link">
  220. <span class="md-ellipsis">
  221. Architecture
  222. </span>
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="#resource-model" class="md-nav__link">
  227. <span class="md-ellipsis">
  228. Resource model
  229. </span>
  230. </a>
  231. <nav class="md-nav" aria-label="Resource model">
  232. <ul class="md-nav__list">
  233. <li class="md-nav__item">
  234. <a href="#secretstore" class="md-nav__link">
  235. <span class="md-ellipsis">
  236. SecretStore
  237. </span>
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="#externalsecret" class="md-nav__link">
  242. <span class="md-ellipsis">
  243. ExternalSecret
  244. </span>
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="#clustersecretstore" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. ClusterSecretStore
  251. </span>
  252. </a>
  253. </li>
  254. </ul>
  255. </nav>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="#behavior" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. Behavior
  261. </span>
  262. </a>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="#roles-and-responsibilities" class="md-nav__link">
  266. <span class="md-ellipsis">
  267. Roles and responsibilities
  268. </span>
  269. </a>
  270. </li>
  271. <li class="md-nav__item">
  272. <a href="#access-control" class="md-nav__link">
  273. <span class="md-ellipsis">
  274. Access Control
  275. </span>
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="#running-multiple-controller" class="md-nav__link">
  280. <span class="md-ellipsis">
  281. Running multiple Controller
  282. </span>
  283. </a>
  284. </li>
  285. </ul>
  286. </nav>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="../getting-started/" class="md-nav__link">
  290. <span class="md-ellipsis">
  291. Getting started
  292. </span>
  293. </a>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="../faq/" class="md-nav__link">
  297. <span class="md-ellipsis">
  298. FAQ
  299. </span>
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../stability-support/" class="md-nav__link">
  304. <span class="md-ellipsis">
  305. Stability and Support
  306. </span>
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="../deprecation-policy/" class="md-nav__link">
  311. <span class="md-ellipsis">
  312. Deprecation Policy
  313. </span>
  314. </a>
  315. </li>
  316. </ul>
  317. </nav>
  318. </li>
  319. <li class="md-nav__item md-nav__item--nested">
  320. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  321. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  322. <span class="md-ellipsis">
  323. API
  324. </span>
  325. <span class="md-nav__icon md-icon"></span>
  326. </label>
  327. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  328. <label class="md-nav__title" for="__nav_2">
  329. <span class="md-nav__icon md-icon"></span>
  330. API
  331. </label>
  332. <ul class="md-nav__list" data-md-scrollfix>
  333. <li class="md-nav__item">
  334. <a href="../../api/components/" class="md-nav__link">
  335. <span class="md-ellipsis">
  336. Components
  337. </span>
  338. </a>
  339. </li>
  340. <li class="md-nav__item md-nav__item--nested">
  341. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  342. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  343. <span class="md-ellipsis">
  344. Core Resources
  345. </span>
  346. <span class="md-nav__icon md-icon"></span>
  347. </label>
  348. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  349. <label class="md-nav__title" for="__nav_2_2">
  350. <span class="md-nav__icon md-icon"></span>
  351. Core Resources
  352. </label>
  353. <ul class="md-nav__list" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="../../api/externalsecret/" class="md-nav__link">
  356. <span class="md-ellipsis">
  357. ExternalSecret
  358. </span>
  359. </a>
  360. </li>
  361. <li class="md-nav__item">
  362. <a href="../../api/secretstore/" class="md-nav__link">
  363. <span class="md-ellipsis">
  364. SecretStore
  365. </span>
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="../../api/clustersecretstore/" class="md-nav__link">
  370. <span class="md-ellipsis">
  371. ClusterSecretStore
  372. </span>
  373. </a>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  377. <span class="md-ellipsis">
  378. ClusterExternalSecret
  379. </span>
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="../../api/pushsecret/" class="md-nav__link">
  384. <span class="md-ellipsis">
  385. PushSecret
  386. </span>
  387. </a>
  388. </li>
  389. </ul>
  390. </nav>
  391. </li>
  392. <li class="md-nav__item md-nav__item--nested">
  393. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  394. <div class="md-nav__link md-nav__container">
  395. <a href="../../api/generator/" class="md-nav__link ">
  396. <span class="md-ellipsis">
  397. Generators
  398. </span>
  399. </a>
  400. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  401. <span class="md-nav__icon md-icon"></span>
  402. </label>
  403. </div>
  404. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  405. <label class="md-nav__title" for="__nav_2_3">
  406. <span class="md-nav__icon md-icon"></span>
  407. Generators
  408. </label>
  409. <ul class="md-nav__list" data-md-scrollfix>
  410. <li class="md-nav__item">
  411. <a href="../../api/generator/acr/" class="md-nav__link">
  412. <span class="md-ellipsis">
  413. Azure Container Registry
  414. </span>
  415. </a>
  416. </li>
  417. <li class="md-nav__item">
  418. <a href="../../api/generator/ecr/" class="md-nav__link">
  419. <span class="md-ellipsis">
  420. AWS Elastic Container Registry
  421. </span>
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../../api/generator/gcr/" class="md-nav__link">
  426. <span class="md-ellipsis">
  427. Google Container Registry
  428. </span>
  429. </a>
  430. </li>
  431. <li class="md-nav__item">
  432. <a href="../../api/generator/vault/" class="md-nav__link">
  433. <span class="md-ellipsis">
  434. Vault Dynamic Secret
  435. </span>
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../api/generator/password/" class="md-nav__link">
  440. <span class="md-ellipsis">
  441. Password
  442. </span>
  443. </a>
  444. </li>
  445. <li class="md-nav__item">
  446. <a href="../../api/generator/fake/" class="md-nav__link">
  447. <span class="md-ellipsis">
  448. Fake
  449. </span>
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="../../api/generator/webhook/" class="md-nav__link">
  454. <span class="md-ellipsis">
  455. Webhook
  456. </span>
  457. </a>
  458. </li>
  459. </ul>
  460. </nav>
  461. </li>
  462. <li class="md-nav__item md-nav__item--nested">
  463. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  464. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  465. <span class="md-ellipsis">
  466. Reference Docs
  467. </span>
  468. <span class="md-nav__icon md-icon"></span>
  469. </label>
  470. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  471. <label class="md-nav__title" for="__nav_2_4">
  472. <span class="md-nav__icon md-icon"></span>
  473. Reference Docs
  474. </label>
  475. <ul class="md-nav__list" data-md-scrollfix>
  476. <li class="md-nav__item">
  477. <a href="../../api/spec/" class="md-nav__link">
  478. <span class="md-ellipsis">
  479. API specification
  480. </span>
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../../api/controller-options/" class="md-nav__link">
  485. <span class="md-ellipsis">
  486. Controller Options
  487. </span>
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../../api/metrics/" class="md-nav__link">
  492. <span class="md-ellipsis">
  493. Metrics
  494. </span>
  495. </a>
  496. </li>
  497. </ul>
  498. </nav>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. <li class="md-nav__item md-nav__item--nested">
  504. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  505. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  506. <span class="md-ellipsis">
  507. Guides
  508. </span>
  509. <span class="md-nav__icon md-icon"></span>
  510. </label>
  511. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  512. <label class="md-nav__title" for="__nav_3">
  513. <span class="md-nav__icon md-icon"></span>
  514. Guides
  515. </label>
  516. <ul class="md-nav__list" data-md-scrollfix>
  517. <li class="md-nav__item">
  518. <a href="../../guides/introduction/" class="md-nav__link">
  519. <span class="md-ellipsis">
  520. Introduction
  521. </span>
  522. </a>
  523. </li>
  524. <li class="md-nav__item md-nav__item--nested">
  525. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  526. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  527. <span class="md-ellipsis">
  528. External Secrets
  529. </span>
  530. <span class="md-nav__icon md-icon"></span>
  531. </label>
  532. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  533. <label class="md-nav__title" for="__nav_3_2">
  534. <span class="md-nav__icon md-icon"></span>
  535. External Secrets
  536. </label>
  537. <ul class="md-nav__list" data-md-scrollfix>
  538. <li class="md-nav__item">
  539. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  540. <span class="md-ellipsis">
  541. Extract structured data
  542. </span>
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../../guides/getallsecrets/" class="md-nav__link">
  547. <span class="md-ellipsis">
  548. Find Secrets by Name or Metadata
  549. </span>
  550. </a>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  554. <span class="md-ellipsis">
  555. Rewriting Keys
  556. </span>
  557. </a>
  558. </li>
  559. <li class="md-nav__item md-nav__item--nested">
  560. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  561. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  562. <span class="md-ellipsis">
  563. Advanced Templating
  564. </span>
  565. <span class="md-nav__icon md-icon"></span>
  566. </label>
  567. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  568. <label class="md-nav__title" for="__nav_3_2_4">
  569. <span class="md-nav__icon md-icon"></span>
  570. Advanced Templating
  571. </label>
  572. <ul class="md-nav__list" data-md-scrollfix>
  573. <li class="md-nav__item">
  574. <a href="../../guides/templating/" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. v2
  577. </span>
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../guides/templating-v1/" class="md-nav__link">
  582. <span class="md-ellipsis">
  583. v1
  584. </span>
  585. </a>
  586. </li>
  587. </ul>
  588. </nav>
  589. </li>
  590. <li class="md-nav__item">
  591. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  592. <span class="md-ellipsis">
  593. Kubernetes Secret Types
  594. </span>
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  599. <span class="md-ellipsis">
  600. Lifecycle: ownership & deletion
  601. </span>
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  606. <span class="md-ellipsis">
  607. Decoding Strategies
  608. </span>
  609. </a>
  610. </li>
  611. <li class="md-nav__item">
  612. <a href="../../guides/controller-class/" class="md-nav__link">
  613. <span class="md-ellipsis">
  614. Controller Classes
  615. </span>
  616. </a>
  617. </li>
  618. </ul>
  619. </nav>
  620. </li>
  621. <li class="md-nav__item">
  622. <a href="../../guides/generator/" class="md-nav__link">
  623. <span class="md-ellipsis">
  624. Generators
  625. </span>
  626. </a>
  627. </li>
  628. <li class="md-nav__item">
  629. <a href="../../guides/pushsecrets/" class="md-nav__link">
  630. <span class="md-ellipsis">
  631. Push Secrets
  632. </span>
  633. </a>
  634. </li>
  635. <li class="md-nav__item md-nav__item--nested">
  636. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  637. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  638. <span class="md-ellipsis">
  639. Operations
  640. </span>
  641. <span class="md-nav__icon md-icon"></span>
  642. </label>
  643. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  644. <label class="md-nav__title" for="__nav_3_5">
  645. <span class="md-nav__icon md-icon"></span>
  646. Operations
  647. </label>
  648. <ul class="md-nav__list" data-md-scrollfix>
  649. <li class="md-nav__item">
  650. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. Multi Tenancy
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../../guides/security-best-practices/" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. Security Best Practices
  660. </span>
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="../../guides/threat-model/" class="md-nav__link">
  665. <span class="md-ellipsis">
  666. Threat Model
  667. </span>
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../../guides/v1beta1/" class="md-nav__link">
  672. <span class="md-ellipsis">
  673. Upgrading to v1beta1
  674. </span>
  675. </a>
  676. </li>
  677. <li class="md-nav__item">
  678. <a href="../../guides/using-latest-image/" class="md-nav__link">
  679. <span class="md-ellipsis">
  680. Using Latest Image
  681. </span>
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  686. <span class="md-ellipsis">
  687. Disable Cluster Features
  688. </span>
  689. </a>
  690. </li>
  691. </ul>
  692. </nav>
  693. </li>
  694. </ul>
  695. </nav>
  696. </li>
  697. <li class="md-nav__item md-nav__item--nested">
  698. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  699. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  700. <span class="md-ellipsis">
  701. Provider
  702. </span>
  703. <span class="md-nav__icon md-icon"></span>
  704. </label>
  705. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  706. <label class="md-nav__title" for="__nav_4">
  707. <span class="md-nav__icon md-icon"></span>
  708. Provider
  709. </label>
  710. <ul class="md-nav__list" data-md-scrollfix>
  711. <li class="md-nav__item">
  712. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. AWS Secrets Manager
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. AWS Parameter Store
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. Azure Key Vault
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="../../provider/chef/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. Chef
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="../../provider/conjur/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. CyberArk Conjur
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Google Cloud Secret Manager
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. HashiCorp Vault
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../provider/kubernetes/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Kubernetes
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. IBM Secrets Manager
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../provider/akeyless/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. Akeyless
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. Yandex Certificate Manager
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. Yandex Lockbox
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../provider/alibaba/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. Alibaba Cloud
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. GitLab Variables
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="../../provider/oracle-vault/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. Oracle Vault
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../../provider/1password-automation/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. 1Password Secrets Automation
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="../../provider/webhook/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Webhook
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="../../provider/fake/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Fake
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. senhasegura DevOps Secrets Management (DSM)
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="../../provider/doppler/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Doppler
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="../../provider/keeper-security/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. Keeper Security
  855. </span>
  856. </a>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="../../provider/cloak/" class="md-nav__link">
  860. <span class="md-ellipsis">
  861. Cloak End 2 End Encrypted Secrets
  862. </span>
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="../../provider/scaleway/" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. Scaleway
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="../../provider/delinea/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. Delinea
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="../../provider/pulumi/" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. Pulumi ESC
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="../../provider/onboardbase/" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. Onboardbase
  890. </span>
  891. </a>
  892. </li>
  893. </ul>
  894. </nav>
  895. </li>
  896. <li class="md-nav__item md-nav__item--nested">
  897. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  898. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  899. <span class="md-ellipsis">
  900. Examples
  901. </span>
  902. <span class="md-nav__icon md-icon"></span>
  903. </label>
  904. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  905. <label class="md-nav__title" for="__nav_5">
  906. <span class="md-nav__icon md-icon"></span>
  907. Examples
  908. </label>
  909. <ul class="md-nav__list" data-md-scrollfix>
  910. <li class="md-nav__item">
  911. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  912. <span class="md-ellipsis">
  913. FluxCD
  914. </span>
  915. </a>
  916. </li>
  917. <li class="md-nav__item">
  918. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  919. <span class="md-ellipsis">
  920. Anchore Engine
  921. </span>
  922. </a>
  923. </li>
  924. <li class="md-nav__item">
  925. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  926. <span class="md-ellipsis">
  927. Jenkins
  928. </span>
  929. </a>
  930. </li>
  931. <li class="md-nav__item">
  932. <a href="../../examples/bitwarden/" class="md-nav__link">
  933. <span class="md-ellipsis">
  934. BitWarden
  935. </span>
  936. </a>
  937. </li>
  938. </ul>
  939. </nav>
  940. </li>
  941. <li class="md-nav__item md-nav__item--nested">
  942. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  943. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  944. <span class="md-ellipsis">
  945. Community
  946. </span>
  947. <span class="md-nav__icon md-icon"></span>
  948. </label>
  949. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  950. <label class="md-nav__title" for="__nav_6">
  951. <span class="md-nav__icon md-icon"></span>
  952. Community
  953. </label>
  954. <ul class="md-nav__list" data-md-scrollfix>
  955. <li class="md-nav__item md-nav__item--nested">
  956. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  957. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  958. <span class="md-ellipsis">
  959. Contributing
  960. </span>
  961. <span class="md-nav__icon md-icon"></span>
  962. </label>
  963. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  964. <label class="md-nav__title" for="__nav_6_1">
  965. <span class="md-nav__icon md-icon"></span>
  966. Contributing
  967. </label>
  968. <ul class="md-nav__list" data-md-scrollfix>
  969. <li class="md-nav__item">
  970. <a href="../../contributing/devguide/" class="md-nav__link">
  971. <span class="md-ellipsis">
  972. Developer guide
  973. </span>
  974. </a>
  975. </li>
  976. <li class="md-nav__item">
  977. <a href="../../contributing/process/" class="md-nav__link">
  978. <span class="md-ellipsis">
  979. Contributing Process
  980. </span>
  981. </a>
  982. </li>
  983. <li class="md-nav__item">
  984. <a href="../../contributing/release/" class="md-nav__link">
  985. <span class="md-ellipsis">
  986. Release Process
  987. </span>
  988. </a>
  989. </li>
  990. <li class="md-nav__item">
  991. <a href="../../contributing/coc/" class="md-nav__link">
  992. <span class="md-ellipsis">
  993. Code of Conduct
  994. </span>
  995. </a>
  996. </li>
  997. <li class="md-nav__item">
  998. <a href="../../contributing/roadmap/" class="md-nav__link">
  999. <span class="md-ellipsis">
  1000. Roadmap
  1001. </span>
  1002. </a>
  1003. </li>
  1004. </ul>
  1005. </nav>
  1006. </li>
  1007. <li class="md-nav__item md-nav__item--nested">
  1008. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1009. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1010. <span class="md-ellipsis">
  1011. External Resources
  1012. </span>
  1013. <span class="md-nav__icon md-icon"></span>
  1014. </label>
  1015. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1016. <label class="md-nav__title" for="__nav_6_2">
  1017. <span class="md-nav__icon md-icon"></span>
  1018. External Resources
  1019. </label>
  1020. <ul class="md-nav__list" data-md-scrollfix>
  1021. <li class="md-nav__item">
  1022. <a href="../../eso-talks/" class="md-nav__link">
  1023. <span class="md-ellipsis">
  1024. Talks
  1025. </span>
  1026. </a>
  1027. </li>
  1028. <li class="md-nav__item">
  1029. <a href="../../eso-demos/" class="md-nav__link">
  1030. <span class="md-ellipsis">
  1031. Demos
  1032. </span>
  1033. </a>
  1034. </li>
  1035. <li class="md-nav__item">
  1036. <a href="../../eso-blogs/" class="md-nav__link">
  1037. <span class="md-ellipsis">
  1038. Blogs
  1039. </span>
  1040. </a>
  1041. </li>
  1042. </ul>
  1043. </nav>
  1044. </li>
  1045. <li class="md-nav__item md-nav__item--nested">
  1046. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_3" >
  1047. <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
  1048. <span class="md-ellipsis">
  1049. AWS
  1050. </span>
  1051. <span class="md-nav__icon md-icon"></span>
  1052. </label>
  1053. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
  1054. <label class="md-nav__title" for="__nav_6_3">
  1055. <span class="md-nav__icon md-icon"></span>
  1056. AWS
  1057. </label>
  1058. <ul class="md-nav__list" data-md-scrollfix>
  1059. <li class="md-nav__item">
  1060. <a href="../../provider-aws-secrets-manager.md" class="md-nav__link">
  1061. <span class="md-ellipsis">
  1062. Secrets Manager
  1063. </span>
  1064. </a>
  1065. </li>
  1066. <li class="md-nav__item">
  1067. <a href="../../provider-aws-parameter-store.md" class="md-nav__link">
  1068. <span class="md-ellipsis">
  1069. Parameter Store
  1070. </span>
  1071. </a>
  1072. </li>
  1073. </ul>
  1074. </nav>
  1075. </li>
  1076. <li class="md-nav__item md-nav__item--nested">
  1077. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_4" >
  1078. <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
  1079. <span class="md-ellipsis">
  1080. Azure
  1081. </span>
  1082. <span class="md-nav__icon md-icon"></span>
  1083. </label>
  1084. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
  1085. <label class="md-nav__title" for="__nav_6_4">
  1086. <span class="md-nav__icon md-icon"></span>
  1087. Azure
  1088. </label>
  1089. <ul class="md-nav__list" data-md-scrollfix>
  1090. <li class="md-nav__item">
  1091. <a href="../../provider-azure-key-vault.md" class="md-nav__link">
  1092. <span class="md-ellipsis">
  1093. Key Vault
  1094. </span>
  1095. </a>
  1096. </li>
  1097. </ul>
  1098. </nav>
  1099. </li>
  1100. <li class="md-nav__item md-nav__item--nested">
  1101. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_5" >
  1102. <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
  1103. <span class="md-ellipsis">
  1104. Google
  1105. </span>
  1106. <span class="md-nav__icon md-icon"></span>
  1107. </label>
  1108. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
  1109. <label class="md-nav__title" for="__nav_6_5">
  1110. <span class="md-nav__icon md-icon"></span>
  1111. Google
  1112. </label>
  1113. <ul class="md-nav__list" data-md-scrollfix>
  1114. <li class="md-nav__item">
  1115. <a href="../../provider-google-secrets-manager.md" class="md-nav__link">
  1116. <span class="md-ellipsis">
  1117. Secrets Manager
  1118. </span>
  1119. </a>
  1120. </li>
  1121. </ul>
  1122. </nav>
  1123. </li>
  1124. <li class="md-nav__item md-nav__item--nested">
  1125. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_6" >
  1126. <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
  1127. <span class="md-ellipsis">
  1128. IBM
  1129. </span>
  1130. <span class="md-nav__icon md-icon"></span>
  1131. </label>
  1132. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
  1133. <label class="md-nav__title" for="__nav_6_6">
  1134. <span class="md-nav__icon md-icon"></span>
  1135. IBM
  1136. </label>
  1137. <ul class="md-nav__list" data-md-scrollfix>
  1138. <li class="md-nav__item">
  1139. <a href="../../provider-ibm-secrets-manager.md" class="md-nav__link">
  1140. <span class="md-ellipsis">
  1141. Secrets Manager
  1142. </span>
  1143. </a>
  1144. </li>
  1145. </ul>
  1146. </nav>
  1147. </li>
  1148. <li class="md-nav__item">
  1149. <a href="../../provider-hashicorp-vault.md" class="md-nav__link">
  1150. <span class="md-ellipsis">
  1151. HashiCorp Vault
  1152. </span>
  1153. </a>
  1154. </li>
  1155. <li class="md-nav__item md-nav__item--nested">
  1156. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_8" >
  1157. <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
  1158. <span class="md-ellipsis">
  1159. Yandex
  1160. </span>
  1161. <span class="md-nav__icon md-icon"></span>
  1162. </label>
  1163. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
  1164. <label class="md-nav__title" for="__nav_6_8">
  1165. <span class="md-nav__icon md-icon"></span>
  1166. Yandex
  1167. </label>
  1168. <ul class="md-nav__list" data-md-scrollfix>
  1169. <li class="md-nav__item">
  1170. <a href="../../provider-yandex-lockbox.md" class="md-nav__link">
  1171. <span class="md-ellipsis">
  1172. Lockbox
  1173. </span>
  1174. </a>
  1175. </li>
  1176. </ul>
  1177. </nav>
  1178. </li>
  1179. <li class="md-nav__item">
  1180. <a href="../../provider-passworddepot/" class="md-nav__link">
  1181. <span class="md-ellipsis">
  1182. Password Depot
  1183. </span>
  1184. </a>
  1185. </li>
  1186. <li class="md-nav__item md-nav__item--nested">
  1187. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_10" >
  1188. <label class="md-nav__link" for="__nav_6_10" id="__nav_6_10_label" tabindex="0">
  1189. <span class="md-ellipsis">
  1190. Gitlab
  1191. </span>
  1192. <span class="md-nav__icon md-icon"></span>
  1193. </label>
  1194. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_10_label" aria-expanded="false">
  1195. <label class="md-nav__title" for="__nav_6_10">
  1196. <span class="md-nav__icon md-icon"></span>
  1197. Gitlab
  1198. </label>
  1199. <ul class="md-nav__list" data-md-scrollfix>
  1200. <li class="md-nav__item">
  1201. <a href="../../provider-gitlab-project-variables.md" class="md-nav__link">
  1202. <span class="md-ellipsis">
  1203. Gitlab Project Variables
  1204. </span>
  1205. </a>
  1206. </li>
  1207. </ul>
  1208. </nav>
  1209. </li>
  1210. <li class="md-nav__item md-nav__item--nested">
  1211. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_11" >
  1212. <label class="md-nav__link" for="__nav_6_11" id="__nav_6_11_label" tabindex="0">
  1213. <span class="md-ellipsis">
  1214. Oracle
  1215. </span>
  1216. <span class="md-nav__icon md-icon"></span>
  1217. </label>
  1218. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_11_label" aria-expanded="false">
  1219. <label class="md-nav__title" for="__nav_6_11">
  1220. <span class="md-nav__icon md-icon"></span>
  1221. Oracle
  1222. </label>
  1223. <ul class="md-nav__list" data-md-scrollfix>
  1224. <li class="md-nav__item">
  1225. <a href="../../provider-oracle-vault.md" class="md-nav__link">
  1226. <span class="md-ellipsis">
  1227. Oracle Vault
  1228. </span>
  1229. </a>
  1230. </li>
  1231. </ul>
  1232. </nav>
  1233. </li>
  1234. </ul>
  1235. </nav>
  1236. </li>
  1237. <li class="md-nav__item md-nav__item--nested">
  1238. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1239. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1240. <span class="md-ellipsis">
  1241. References
  1242. </span>
  1243. <span class="md-nav__icon md-icon"></span>
  1244. </label>
  1245. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1246. <label class="md-nav__title" for="__nav_7">
  1247. <span class="md-nav__icon md-icon"></span>
  1248. References
  1249. </label>
  1250. <ul class="md-nav__list" data-md-scrollfix>
  1251. <li class="md-nav__item">
  1252. <a href="../../spec/" class="md-nav__link">
  1253. <span class="md-ellipsis">
  1254. API specification
  1255. </span>
  1256. </a>
  1257. </li>
  1258. </ul>
  1259. </nav>
  1260. </li>
  1261. <li class="md-nav__item md-nav__item--nested">
  1262. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
  1263. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  1264. <span class="md-ellipsis">
  1265. Contributing
  1266. </span>
  1267. <span class="md-nav__icon md-icon"></span>
  1268. </label>
  1269. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  1270. <label class="md-nav__title" for="__nav_8">
  1271. <span class="md-nav__icon md-icon"></span>
  1272. Contributing
  1273. </label>
  1274. <ul class="md-nav__list" data-md-scrollfix>
  1275. <li class="md-nav__item">
  1276. <a href="../../contributing-devguide.md" class="md-nav__link">
  1277. <span class="md-ellipsis">
  1278. Developer guide
  1279. </span>
  1280. </a>
  1281. </li>
  1282. <li class="md-nav__item">
  1283. <a href="../../contributing-process.md" class="md-nav__link">
  1284. <span class="md-ellipsis">
  1285. Contributing Process
  1286. </span>
  1287. </a>
  1288. </li>
  1289. <li class="md-nav__item">
  1290. <a href="../../contributing-coc.md" class="md-nav__link">
  1291. <span class="md-ellipsis">
  1292. Code of Conduct
  1293. </span>
  1294. </a>
  1295. </li>
  1296. </ul>
  1297. </nav>
  1298. </li>
  1299. <li class="md-nav__item">
  1300. <a href="../../deprecation-policy.md" class="md-nav__link">
  1301. <span class="md-ellipsis">
  1302. Deprecation Policy
  1303. </span>
  1304. </a>
  1305. </li>
  1306. </ul>
  1307. </nav>
  1308. </div>
  1309. </div>
  1310. </div>
  1311. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1312. <div class="md-sidebar__scrollwrap">
  1313. <div class="md-sidebar__inner">
  1314. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1315. <label class="md-nav__title" for="__toc">
  1316. <span class="md-nav__icon md-icon"></span>
  1317. Table of contents
  1318. </label>
  1319. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1320. <li class="md-nav__item">
  1321. <a href="#architecture" class="md-nav__link">
  1322. <span class="md-ellipsis">
  1323. Architecture
  1324. </span>
  1325. </a>
  1326. </li>
  1327. <li class="md-nav__item">
  1328. <a href="#resource-model" class="md-nav__link">
  1329. <span class="md-ellipsis">
  1330. Resource model
  1331. </span>
  1332. </a>
  1333. <nav class="md-nav" aria-label="Resource model">
  1334. <ul class="md-nav__list">
  1335. <li class="md-nav__item">
  1336. <a href="#secretstore" class="md-nav__link">
  1337. <span class="md-ellipsis">
  1338. SecretStore
  1339. </span>
  1340. </a>
  1341. </li>
  1342. <li class="md-nav__item">
  1343. <a href="#externalsecret" class="md-nav__link">
  1344. <span class="md-ellipsis">
  1345. ExternalSecret
  1346. </span>
  1347. </a>
  1348. </li>
  1349. <li class="md-nav__item">
  1350. <a href="#clustersecretstore" class="md-nav__link">
  1351. <span class="md-ellipsis">
  1352. ClusterSecretStore
  1353. </span>
  1354. </a>
  1355. </li>
  1356. </ul>
  1357. </nav>
  1358. </li>
  1359. <li class="md-nav__item">
  1360. <a href="#behavior" class="md-nav__link">
  1361. <span class="md-ellipsis">
  1362. Behavior
  1363. </span>
  1364. </a>
  1365. </li>
  1366. <li class="md-nav__item">
  1367. <a href="#roles-and-responsibilities" class="md-nav__link">
  1368. <span class="md-ellipsis">
  1369. Roles and responsibilities
  1370. </span>
  1371. </a>
  1372. </li>
  1373. <li class="md-nav__item">
  1374. <a href="#access-control" class="md-nav__link">
  1375. <span class="md-ellipsis">
  1376. Access Control
  1377. </span>
  1378. </a>
  1379. </li>
  1380. <li class="md-nav__item">
  1381. <a href="#running-multiple-controller" class="md-nav__link">
  1382. <span class="md-ellipsis">
  1383. Running multiple Controller
  1384. </span>
  1385. </a>
  1386. </li>
  1387. </ul>
  1388. </nav>
  1389. </div>
  1390. </div>
  1391. </div>
  1392. <div class="md-content" data-md-component="content">
  1393. <article class="md-content__inner md-typeset">
  1394. <h1 id="api-overview">API Overview</h1>
  1395. <h2 id="architecture">Architecture</h2>
  1396. <p><img alt="high-level" src="../../pictures/diagrams-high-level-simple.png" /></p>
  1397. <p>The External Secrets Operator extends Kubernetes with <a href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/">Custom
  1398. Resources</a>,
  1399. which define where secrets live and how to synchronize them. The controller
  1400. fetches secrets from an external API and creates Kubernetes
  1401. <a href="https://kubernetes.io/docs/concepts/configuration/secret/">secrets</a>. If the
  1402. secret from the external API changes, the controller will reconcile the state in
  1403. the cluster and update the secrets accordingly.</p>
  1404. <h2 id="resource-model">Resource model</h2>
  1405. <p>To understand the mechanics of the operator let's start with the data model. The
  1406. SecretStore references a bucket of key/value pairs. But because every external
  1407. API is slightly different this bucket may be e.g. an instance of an Azure
  1408. KeyVault or a AWS Secrets Manager in a certain AWS Account and region. Please
  1409. take a look at the provider documentation to see what the Bucket actually maps
  1410. to.</p>
  1411. <p><img alt="Resource Mapping" src="../../pictures/diagrams-resource-mapping.png" /></p>
  1412. <h3 id="secretstore">SecretStore</h3>
  1413. <p>The idea behind the <a href="../../api/secretstore/">SecretStore</a> resource is to separate concerns of
  1414. authentication/access and the actual Secret and configuration needed for
  1415. workloads. The ExternalSecret specifies what to fetch, the SecretStore specifies
  1416. how to access. This resource is namespaced.</p>
  1417. <p><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>
  1418. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1419. <span class="nt">metadata</span><span class="p">:</span>
  1420. <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">secretstore-sample</span>
  1421. <span class="nt">spec</span><span class="p">:</span>
  1422. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1423. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1424. <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>
  1425. <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">us-east-1</span>
  1426. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1427. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1428. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1429. <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>
  1430. <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>
  1431. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1432. <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>
  1433. <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>
  1434. </code></pre></div>
  1435. The <code>SecretStore</code> contains references to secrets which hold credentials to
  1436. access the external API.</p>
  1437. <h3 id="externalsecret">ExternalSecret</h3>
  1438. <p>An <a href="../../api/externalsecret/">ExternalSecret</a> declares what data to fetch. It has a reference to a
  1439. <code>SecretStore</code> which knows how to access that data. The controller uses that
  1440. <code>ExternalSecret</code> as a blueprint to create secrets.</p>
  1441. <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>
  1442. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1443. <span class="nt">metadata</span><span class="p">:</span>
  1444. <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>
  1445. <span class="nt">spec</span><span class="p">:</span>
  1446. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span>
  1447. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1448. <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">secretstore-sample</span>
  1449. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1450. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1451. <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">secret-to-be-created</span>
  1452. <span class="w"> </span><span class="nt">creationPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Owner</span>
  1453. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1454. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-key-to-be-managed</span>
  1455. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1456. <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">provider-key</span>
  1457. <span class="w"> </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">provider-key-version</span>
  1458. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">provider-key-property</span>
  1459. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1460. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1461. <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">remote-key-in-the-provider</span>
  1462. </code></pre></div>
  1463. <h3 id="clustersecretstore">ClusterSecretStore</h3>
  1464. <p>The <a href="../../api/clustersecretstore/">ClusterSecretStore</a> is a global, cluster-wide SecretStore that can be
  1465. referenced from all namespaces. You can use it to provide a central gateway to your secret provider.</p>
  1466. <h2 id="behavior">Behavior</h2>
  1467. <p>The External Secret Operator (ESO for brevity) reconciles <code>ExternalSecrets</code> in
  1468. the following manner:</p>
  1469. <ol>
  1470. <li>ESO uses <code>spec.secretStoreRef</code> to find an appropriate <code>SecretStore</code>. If it
  1471. doesn't exist or the <code>spec.controller</code> field doesn't match it won't further
  1472. process this ExternalSecret.</li>
  1473. <li>ESO instanciates an external API client using the specified credentials from
  1474. the <code>SecretStore</code> spec.</li>
  1475. <li>ESO fetches the secrets as requested by the <code>ExternalSecret</code>, it will decode
  1476. the secrets if required</li>
  1477. <li>ESO creates an <code>Kind=Secret</code> based on the template provided by
  1478. <code>ExternalSecret.target.template</code>. The <code>Secret.data</code> can be templated using
  1479. the secret values from the external API.</li>
  1480. <li>ESO ensures that the secret values stay in sync with the external API</li>
  1481. </ol>
  1482. <h2 id="roles-and-responsibilities">Roles and responsibilities</h2>
  1483. <p>The External Secret Operator is designed to target the following persona:</p>
  1484. <ul>
  1485. <li><strong>Cluster Operator</strong>: The cluster operator is responsible for setting up the
  1486. External Secret Operator, managing access policies and creating
  1487. ClusterSecretStores.</li>
  1488. <li><strong>Application developer</strong>: The Application developer is responsible for
  1489. defining ExternalSecrets and the application configuration</li>
  1490. </ul>
  1491. <p>Each persona will roughly map to a Kubernetes RBAC role. Depending on your
  1492. environment these roles can map to a single user. <strong>Note:</strong> There is no Secret
  1493. Operator that handles the lifecycle of the secret, this is out of the scope of
  1494. ESO.</p>
  1495. <h2 id="access-control">Access Control</h2>
  1496. <p>The External Secrets Operator runs as a deployment in your cluster with elevated
  1497. privileges. It will create/read/update secrets in all namespaces and has access
  1498. to secrets stored in some external API. Ensure that the credentials you provide
  1499. give ESO the least privilege necessary.</p>
  1500. <p>Design your <code>SecretStore</code>/<code>ClusterSecretStore</code> carefully! Be sure to restrict
  1501. access of application developers to read only certain
  1502. keys in a shared environment.</p>
  1503. <p>You should also consider using Kubernetes' admission control system (e.g.
  1504. <a href="https://www.openpolicyagent.org/">OPA</a> or <a href="https://kyverno.io/">Kyverno</a>) for
  1505. fine-grained access control.</p>
  1506. <h2 id="running-multiple-controller">Running multiple Controller</h2>
  1507. <p>You can run multiple controllers within the cluster. One controller can be
  1508. limited to only process <code>SecretStores</code> with a predefined <code>spec.controller</code>
  1509. field.</p>
  1510. <div class="admonition note">
  1511. <p class="admonition-title">Testers welcome</p>
  1512. <p>This is not widely tested. Please help us test the setup and/or document use-cases.</p>
  1513. </div>
  1514. </article>
  1515. </div>
  1516. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1517. </div>
  1518. </main>
  1519. <footer class="md-footer">
  1520. <div class="md-footer-meta md-typeset">
  1521. <div class="md-footer-meta__inner md-grid">
  1522. <div class="md-copyright">
  1523. <div class="md-copyright__highlight">
  1524. &copy; 2024 The external-secrets Authors.<br/>
  1525. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1526. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1527. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1528. </div>
  1529. Made with
  1530. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1531. Material for MkDocs
  1532. </a>
  1533. </div>
  1534. </div>
  1535. </div>
  1536. </footer>
  1537. </div>
  1538. <div class="md-dialog" data-md-component="dialog">
  1539. <div class="md-dialog__inner md-typeset"></div>
  1540. </div>
  1541. <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>
  1542. <script src="../../assets/javascripts/bundle.bd41221c.min.js"></script>
  1543. </body>
  1544. </html>