index.html 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961
  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="next" href="introduction/overview/">
  7. <link rel="icon" href="pictures/eso-round-logo.svg">
  8. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
  9. <title>Introduction - External Secrets Operator</title>
  10. <link rel="stylesheet" href="assets/stylesheets/main.342714a4.min.css">
  11. <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.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 e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  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="#sponsored-by" 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]"),base=new URL("."),outdated=__md_get("__outdated",sessionStorage,base);!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 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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. Introduction
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <form class="md-header__option" data-md-component="palette">
  64. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  65. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  66. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  67. </label>
  68. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  69. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  70. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  71. </label>
  72. </form>
  73. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var 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(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  74. <label class="md-header__button md-icon" for="__search">
  75. <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.52 6.52 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 5"/></svg>
  76. </label>
  77. <div class="md-search" data-md-component="search" role="dialog">
  78. <label class="md-search__overlay" for="__search"></label>
  79. <div class="md-search__inner" role="search">
  80. <form class="md-search__form" name="search">
  81. <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>
  82. <label class="md-search__icon md-icon" for="__search">
  83. <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.52 6.52 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 5"/></svg>
  84. <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 11z"/></svg>
  85. </label>
  86. <nav class="md-search__options" aria-label="Search">
  87. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  88. <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 12z"/></svg>
  89. </button>
  90. </nav>
  91. </form>
  92. <div class="md-search__output">
  93. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  94. <div class="md-search-result" data-md-component="search-result">
  95. <div class="md-search-result__meta">
  96. Initializing search
  97. </div>
  98. <ol class="md-search-result__list" role="presentation"></ol>
  99. </div>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. <div class="md-header__source">
  105. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  106. <div class="md-source__icon md-icon">
  107. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 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 2024 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.81"/></svg>
  108. </div>
  109. <div class="md-source__repository">
  110. External Secrets Operator
  111. </div>
  112. </a>
  113. </div>
  114. </nav>
  115. </header>
  116. <div class="md-container" data-md-component="container">
  117. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  118. <div class="md-grid">
  119. <ul class="md-tabs__list">
  120. <li class="md-tabs__item md-tabs__item--active">
  121. <a href="." class="md-tabs__link">
  122. Introduction
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="api/components/" class="md-tabs__link">
  127. API
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="guides/introduction/" class="md-tabs__link">
  132. Guides
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="provider/aws-secrets-manager/" class="md-tabs__link">
  137. Provider
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="examples/gitops-using-fluxcd/" class="md-tabs__link">
  142. Examples
  143. </a>
  144. </li>
  145. <li class="md-tabs__item">
  146. <a href="contributing/devguide/" class="md-tabs__link">
  147. Community
  148. </a>
  149. </li>
  150. </ul>
  151. </div>
  152. </nav>
  153. <main class="md-main" data-md-component="main">
  154. <div class="md-main__inner md-grid">
  155. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  156. <div class="md-sidebar__scrollwrap">
  157. <div class="md-sidebar__inner">
  158. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  159. <label class="md-nav__title" for="__drawer">
  160. <a href="." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  161. <img src="pictures/eso-round-logo.svg" alt="logo">
  162. </a>
  163. External Secrets Operator
  164. </label>
  165. <div class="md-nav__source">
  166. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  167. <div class="md-source__icon md-icon">
  168. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 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 2024 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.81"/></svg>
  169. </div>
  170. <div class="md-source__repository">
  171. External Secrets Operator
  172. </div>
  173. </a>
  174. </div>
  175. <ul class="md-nav__list" data-md-scrollfix>
  176. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  177. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  178. <div class="md-nav__link md-nav__container">
  179. <a href="." class="md-nav__link md-nav__link--active">
  180. <span class="md-ellipsis">
  181. Introduction
  182. </span>
  183. </a>
  184. <label class="md-nav__link md-nav__link--active" for="__nav_1" id="__nav_1_label" tabindex="">
  185. <span class="md-nav__icon md-icon"></span>
  186. </label>
  187. </div>
  188. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  189. <label class="md-nav__title" for="__nav_1">
  190. <span class="md-nav__icon md-icon"></span>
  191. Introduction
  192. </label>
  193. <ul class="md-nav__list" data-md-scrollfix>
  194. <li class="md-nav__item">
  195. <a href="introduction/overview/" class="md-nav__link">
  196. <span class="md-ellipsis">
  197. Overview
  198. </span>
  199. </a>
  200. </li>
  201. <li class="md-nav__item">
  202. <a href="introduction/glossary/" class="md-nav__link">
  203. <span class="md-ellipsis">
  204. Glossary
  205. </span>
  206. </a>
  207. </li>
  208. <li class="md-nav__item">
  209. <a href="introduction/prerequisites/" class="md-nav__link">
  210. <span class="md-ellipsis">
  211. Prerequisites
  212. </span>
  213. </a>
  214. </li>
  215. <li class="md-nav__item">
  216. <a href="introduction/getting-started/" class="md-nav__link">
  217. <span class="md-ellipsis">
  218. Getting started
  219. </span>
  220. </a>
  221. </li>
  222. <li class="md-nav__item">
  223. <a href="introduction/faq/" class="md-nav__link">
  224. <span class="md-ellipsis">
  225. FAQ
  226. </span>
  227. </a>
  228. </li>
  229. <li class="md-nav__item">
  230. <a href="introduction/stability-support/" class="md-nav__link">
  231. <span class="md-ellipsis">
  232. Stability and Support
  233. </span>
  234. </a>
  235. </li>
  236. <li class="md-nav__item">
  237. <a href="introduction/deprecation-policy/" class="md-nav__link">
  238. <span class="md-ellipsis">
  239. Deprecation Policy
  240. </span>
  241. </a>
  242. </li>
  243. </ul>
  244. </nav>
  245. </li>
  246. <li class="md-nav__item md-nav__item--nested">
  247. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  248. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  249. <span class="md-ellipsis">
  250. API
  251. </span>
  252. <span class="md-nav__icon md-icon"></span>
  253. </label>
  254. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  255. <label class="md-nav__title" for="__nav_2">
  256. <span class="md-nav__icon md-icon"></span>
  257. API
  258. </label>
  259. <ul class="md-nav__list" data-md-scrollfix>
  260. <li class="md-nav__item">
  261. <a href="api/components/" class="md-nav__link">
  262. <span class="md-ellipsis">
  263. Components
  264. </span>
  265. </a>
  266. </li>
  267. <li class="md-nav__item md-nav__item--nested">
  268. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  269. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  270. <span class="md-ellipsis">
  271. Core Resources
  272. </span>
  273. <span class="md-nav__icon md-icon"></span>
  274. </label>
  275. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  276. <label class="md-nav__title" for="__nav_2_2">
  277. <span class="md-nav__icon md-icon"></span>
  278. Core Resources
  279. </label>
  280. <ul class="md-nav__list" data-md-scrollfix>
  281. <li class="md-nav__item">
  282. <a href="api/externalsecret/" class="md-nav__link">
  283. <span class="md-ellipsis">
  284. ExternalSecret
  285. </span>
  286. </a>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="api/secretstore/" class="md-nav__link">
  290. <span class="md-ellipsis">
  291. SecretStore
  292. </span>
  293. </a>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="api/clustersecretstore/" class="md-nav__link">
  297. <span class="md-ellipsis">
  298. ClusterSecretStore
  299. </span>
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="api/clusterexternalsecret/" class="md-nav__link">
  304. <span class="md-ellipsis">
  305. ClusterExternalSecret
  306. </span>
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="api/clusterpushsecret/" class="md-nav__link">
  311. <span class="md-ellipsis">
  312. ClusterPushSecret
  313. </span>
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="api/pushsecret/" class="md-nav__link">
  318. <span class="md-ellipsis">
  319. PushSecret
  320. </span>
  321. </a>
  322. </li>
  323. </ul>
  324. </nav>
  325. </li>
  326. <li class="md-nav__item md-nav__item--nested">
  327. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  328. <div class="md-nav__link md-nav__container">
  329. <a href="api/generator/" class="md-nav__link ">
  330. <span class="md-ellipsis">
  331. Generators
  332. </span>
  333. </a>
  334. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  335. <span class="md-nav__icon md-icon"></span>
  336. </label>
  337. </div>
  338. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  339. <label class="md-nav__title" for="__nav_2_3">
  340. <span class="md-nav__icon md-icon"></span>
  341. Generators
  342. </label>
  343. <ul class="md-nav__list" data-md-scrollfix>
  344. <li class="md-nav__item">
  345. <a href="api/generator/acr/" class="md-nav__link">
  346. <span class="md-ellipsis">
  347. Azure Container Registry
  348. </span>
  349. </a>
  350. </li>
  351. <li class="md-nav__item">
  352. <a href="api/generator/ecr/" class="md-nav__link">
  353. <span class="md-ellipsis">
  354. AWS Elastic Container Registry
  355. </span>
  356. </a>
  357. </li>
  358. <li class="md-nav__item">
  359. <a href="api/generator/sts/" class="md-nav__link">
  360. <span class="md-ellipsis">
  361. AWS STS Session Token
  362. </span>
  363. </a>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="api/generator/cluster/" class="md-nav__link">
  367. <span class="md-ellipsis">
  368. Cluster Generator
  369. </span>
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="api/generator/gcr/" class="md-nav__link">
  374. <span class="md-ellipsis">
  375. Google Container Registry
  376. </span>
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="api/generator/quay/" class="md-nav__link">
  381. <span class="md-ellipsis">
  382. Quay
  383. </span>
  384. </a>
  385. </li>
  386. <li class="md-nav__item">
  387. <a href="api/generator/vault/" class="md-nav__link">
  388. <span class="md-ellipsis">
  389. Vault Dynamic Secret
  390. </span>
  391. </a>
  392. </li>
  393. <li class="md-nav__item">
  394. <a href="api/generator/password/" class="md-nav__link">
  395. <span class="md-ellipsis">
  396. Password
  397. </span>
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="api/generator/fake/" class="md-nav__link">
  402. <span class="md-ellipsis">
  403. Fake
  404. </span>
  405. </a>
  406. </li>
  407. <li class="md-nav__item">
  408. <a href="api/generator/webhook/" class="md-nav__link">
  409. <span class="md-ellipsis">
  410. Webhook
  411. </span>
  412. </a>
  413. </li>
  414. <li class="md-nav__item">
  415. <a href="api/generator/github/" class="md-nav__link">
  416. <span class="md-ellipsis">
  417. Github
  418. </span>
  419. </a>
  420. </li>
  421. <li class="md-nav__item">
  422. <a href="api/generator/uuid/" class="md-nav__link">
  423. <span class="md-ellipsis">
  424. UUID
  425. </span>
  426. </a>
  427. </li>
  428. <li class="md-nav__item">
  429. <a href="api/generator/mfa/" class="md-nav__link">
  430. <span class="md-ellipsis">
  431. MFA
  432. </span>
  433. </a>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. <li class="md-nav__item md-nav__item--nested">
  439. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  440. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  441. <span class="md-ellipsis">
  442. Reference Docs
  443. </span>
  444. <span class="md-nav__icon md-icon"></span>
  445. </label>
  446. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  447. <label class="md-nav__title" for="__nav_2_4">
  448. <span class="md-nav__icon md-icon"></span>
  449. Reference Docs
  450. </label>
  451. <ul class="md-nav__list" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="api/spec/" class="md-nav__link">
  454. <span class="md-ellipsis">
  455. API specification
  456. </span>
  457. </a>
  458. </li>
  459. <li class="md-nav__item">
  460. <a href="api/controller-options/" class="md-nav__link">
  461. <span class="md-ellipsis">
  462. Controller Options
  463. </span>
  464. </a>
  465. </li>
  466. <li class="md-nav__item">
  467. <a href="api/metrics/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Metrics
  470. </span>
  471. </a>
  472. </li>
  473. </ul>
  474. </nav>
  475. </li>
  476. </ul>
  477. </nav>
  478. </li>
  479. <li class="md-nav__item md-nav__item--nested">
  480. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  481. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  482. <span class="md-ellipsis">
  483. Guides
  484. </span>
  485. <span class="md-nav__icon md-icon"></span>
  486. </label>
  487. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  488. <label class="md-nav__title" for="__nav_3">
  489. <span class="md-nav__icon md-icon"></span>
  490. Guides
  491. </label>
  492. <ul class="md-nav__list" data-md-scrollfix>
  493. <li class="md-nav__item">
  494. <a href="guides/introduction/" class="md-nav__link">
  495. <span class="md-ellipsis">
  496. Introduction
  497. </span>
  498. </a>
  499. </li>
  500. <li class="md-nav__item md-nav__item--nested">
  501. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  502. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  503. <span class="md-ellipsis">
  504. External Secrets
  505. </span>
  506. <span class="md-nav__icon md-icon"></span>
  507. </label>
  508. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  509. <label class="md-nav__title" for="__nav_3_2">
  510. <span class="md-nav__icon md-icon"></span>
  511. External Secrets
  512. </label>
  513. <ul class="md-nav__list" data-md-scrollfix>
  514. <li class="md-nav__item">
  515. <a href="guides/all-keys-one-secret/" class="md-nav__link">
  516. <span class="md-ellipsis">
  517. Extract structured data
  518. </span>
  519. </a>
  520. </li>
  521. <li class="md-nav__item">
  522. <a href="guides/getallsecrets/" class="md-nav__link">
  523. <span class="md-ellipsis">
  524. Find Secrets by Name or Metadata
  525. </span>
  526. </a>
  527. </li>
  528. <li class="md-nav__item">
  529. <a href="guides/datafrom-rewrite/" class="md-nav__link">
  530. <span class="md-ellipsis">
  531. Rewriting Keys
  532. </span>
  533. </a>
  534. </li>
  535. <li class="md-nav__item md-nav__item--nested">
  536. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  537. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  538. <span class="md-ellipsis">
  539. Advanced Templating
  540. </span>
  541. <span class="md-nav__icon md-icon"></span>
  542. </label>
  543. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  544. <label class="md-nav__title" for="__nav_3_2_4">
  545. <span class="md-nav__icon md-icon"></span>
  546. Advanced Templating
  547. </label>
  548. <ul class="md-nav__list" data-md-scrollfix>
  549. <li class="md-nav__item">
  550. <a href="guides/templating/" class="md-nav__link">
  551. <span class="md-ellipsis">
  552. v2
  553. </span>
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="guides/templating-v1/" class="md-nav__link">
  558. <span class="md-ellipsis">
  559. v1
  560. </span>
  561. </a>
  562. </li>
  563. </ul>
  564. </nav>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="guides/common-k8s-secret-types/" class="md-nav__link">
  568. <span class="md-ellipsis">
  569. Kubernetes Secret Types
  570. </span>
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="guides/ownership-deletion-policy/" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. Lifecycle: ownership & deletion
  577. </span>
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="guides/decoding-strategy/" class="md-nav__link">
  582. <span class="md-ellipsis">
  583. Decoding Strategies
  584. </span>
  585. </a>
  586. </li>
  587. <li class="md-nav__item">
  588. <a href="guides/controller-class/" class="md-nav__link">
  589. <span class="md-ellipsis">
  590. Controller Classes
  591. </span>
  592. </a>
  593. </li>
  594. </ul>
  595. </nav>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="guides/generator/" class="md-nav__link">
  599. <span class="md-ellipsis">
  600. Generators
  601. </span>
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="guides/pushsecrets/" class="md-nav__link">
  606. <span class="md-ellipsis">
  607. Push Secrets
  608. </span>
  609. </a>
  610. </li>
  611. <li class="md-nav__item md-nav__item--nested">
  612. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  613. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  614. <span class="md-ellipsis">
  615. Operations
  616. </span>
  617. <span class="md-nav__icon md-icon"></span>
  618. </label>
  619. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  620. <label class="md-nav__title" for="__nav_3_5">
  621. <span class="md-nav__icon md-icon"></span>
  622. Operations
  623. </label>
  624. <ul class="md-nav__list" data-md-scrollfix>
  625. <li class="md-nav__item">
  626. <a href="guides/multi-tenancy/" class="md-nav__link">
  627. <span class="md-ellipsis">
  628. Multi Tenancy
  629. </span>
  630. </a>
  631. </li>
  632. <li class="md-nav__item">
  633. <a href="guides/security-best-practices/" class="md-nav__link">
  634. <span class="md-ellipsis">
  635. Security Best Practices
  636. </span>
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="guides/threat-model/" class="md-nav__link">
  641. <span class="md-ellipsis">
  642. Threat Model
  643. </span>
  644. </a>
  645. </li>
  646. <li class="md-nav__item">
  647. <a href="guides/v1beta1/" class="md-nav__link">
  648. <span class="md-ellipsis">
  649. Upgrading to v1beta1
  650. </span>
  651. </a>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="guides/using-latest-image/" class="md-nav__link">
  655. <span class="md-ellipsis">
  656. Using Latest Image
  657. </span>
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="guides/disable-cluster-features/" class="md-nav__link">
  662. <span class="md-ellipsis">
  663. Disable Cluster Features
  664. </span>
  665. </a>
  666. </li>
  667. </ul>
  668. </nav>
  669. </li>
  670. <li class="md-nav__item md-nav__item--nested">
  671. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  672. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  673. <span class="md-ellipsis">
  674. Tooling
  675. </span>
  676. <span class="md-nav__icon md-icon"></span>
  677. </label>
  678. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  679. <label class="md-nav__title" for="__nav_3_6">
  680. <span class="md-nav__icon md-icon"></span>
  681. Tooling
  682. </label>
  683. <ul class="md-nav__list" data-md-scrollfix>
  684. <li class="md-nav__item">
  685. <a href="guides/using-esoctl-tool/" class="md-nav__link">
  686. <span class="md-ellipsis">
  687. Using the esoctl tool
  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/beyondtrust/" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. BeyondTrust
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="provider/bitwarden-secrets-manager/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. Bitwarden Secrets Manager
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="provider/chef/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. Chef
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="provider/cloudru/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Cloud.ru Secret Manager
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="provider/conjur/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. CyberArk Conjur
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="provider/device42/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Device42
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="provider/google-secrets-manager/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. Google Cloud Secret Manager
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="provider/hashicorp-vault/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. HashiCorp Vault
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="provider/kubernetes/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. Kubernetes
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="provider/ibm-secrets-manager/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. IBM Secrets Manager
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="provider/akeyless/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. Akeyless
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="provider/yandex-certificate-manager/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. Yandex Certificate Manager
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="provider/yandex-lockbox/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. Yandex Lockbox
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="provider/alibaba/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Alibaba Cloud
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="provider/gitlab-variables/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. GitLab Variables
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="provider/github/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. Github Actions Secrets
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="provider/oracle-vault/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Oracle Vault
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="provider/1password-automation/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. 1Password Connect Server
  855. </span>
  856. </a>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="provider/1password-sdk/" class="md-nav__link">
  860. <span class="md-ellipsis">
  861. 1Password SDK
  862. </span>
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="provider/webhook/" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. Webhook
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="provider/fake/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. Fake
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="provider/senhasegura-dsm/" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. senhasegura DevOps Secrets Management (DSM)
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="provider/doppler/" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. Doppler
  890. </span>
  891. </a>
  892. </li>
  893. <li class="md-nav__item">
  894. <a href="provider/keeper-security/" class="md-nav__link">
  895. <span class="md-ellipsis">
  896. Keeper Security
  897. </span>
  898. </a>
  899. </li>
  900. <li class="md-nav__item">
  901. <a href="provider/cloak/" class="md-nav__link">
  902. <span class="md-ellipsis">
  903. Cloak End 2 End Encrypted Secrets
  904. </span>
  905. </a>
  906. </li>
  907. <li class="md-nav__item">
  908. <a href="provider/scaleway/" class="md-nav__link">
  909. <span class="md-ellipsis">
  910. Scaleway
  911. </span>
  912. </a>
  913. </li>
  914. <li class="md-nav__item">
  915. <a href="provider/delinea/" class="md-nav__link">
  916. <span class="md-ellipsis">
  917. Delinea
  918. </span>
  919. </a>
  920. </li>
  921. <li class="md-nav__item">
  922. <a href="provider/secretserver/" class="md-nav__link">
  923. <span class="md-ellipsis">
  924. Secret Server
  925. </span>
  926. </a>
  927. </li>
  928. <li class="md-nav__item">
  929. <a href="provider/passbolt/" class="md-nav__link">
  930. <span class="md-ellipsis">
  931. Passbolt
  932. </span>
  933. </a>
  934. </li>
  935. <li class="md-nav__item">
  936. <a href="provider/pulumi/" class="md-nav__link">
  937. <span class="md-ellipsis">
  938. Pulumi ESC
  939. </span>
  940. </a>
  941. </li>
  942. <li class="md-nav__item">
  943. <a href="provider/onboardbase/" class="md-nav__link">
  944. <span class="md-ellipsis">
  945. Onboardbase
  946. </span>
  947. </a>
  948. </li>
  949. <li class="md-nav__item">
  950. <a href="provider-passworddepot/" class="md-nav__link">
  951. <span class="md-ellipsis">
  952. Password Depot
  953. </span>
  954. </a>
  955. </li>
  956. <li class="md-nav__item">
  957. <a href="provider/fortanix/" class="md-nav__link">
  958. <span class="md-ellipsis">
  959. Fortanix
  960. </span>
  961. </a>
  962. </li>
  963. <li class="md-nav__item">
  964. <a href="provider/infisical/" class="md-nav__link">
  965. <span class="md-ellipsis">
  966. Infisical
  967. </span>
  968. </a>
  969. </li>
  970. <li class="md-nav__item">
  971. <a href="provider/previder/" class="md-nav__link">
  972. <span class="md-ellipsis">
  973. Previder
  974. </span>
  975. </a>
  976. </li>
  977. <li class="md-nav__item">
  978. <a href="provider/openbao/" class="md-nav__link">
  979. <span class="md-ellipsis">
  980. OpenBao
  981. </span>
  982. </a>
  983. </li>
  984. </ul>
  985. </nav>
  986. </li>
  987. <li class="md-nav__item md-nav__item--nested">
  988. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  989. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  990. <span class="md-ellipsis">
  991. Examples
  992. </span>
  993. <span class="md-nav__icon md-icon"></span>
  994. </label>
  995. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  996. <label class="md-nav__title" for="__nav_5">
  997. <span class="md-nav__icon md-icon"></span>
  998. Examples
  999. </label>
  1000. <ul class="md-nav__list" data-md-scrollfix>
  1001. <li class="md-nav__item">
  1002. <a href="examples/gitops-using-fluxcd/" class="md-nav__link">
  1003. <span class="md-ellipsis">
  1004. FluxCD
  1005. </span>
  1006. </a>
  1007. </li>
  1008. <li class="md-nav__item">
  1009. <a href="examples/anchore-engine-credentials/" class="md-nav__link">
  1010. <span class="md-ellipsis">
  1011. Anchore Engine
  1012. </span>
  1013. </a>
  1014. </li>
  1015. <li class="md-nav__item">
  1016. <a href="examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1017. <span class="md-ellipsis">
  1018. Jenkins
  1019. </span>
  1020. </a>
  1021. </li>
  1022. <li class="md-nav__item">
  1023. <a href="examples/bitwarden/" class="md-nav__link">
  1024. <span class="md-ellipsis">
  1025. Bitwarden
  1026. </span>
  1027. </a>
  1028. </li>
  1029. </ul>
  1030. </nav>
  1031. </li>
  1032. <li class="md-nav__item md-nav__item--nested">
  1033. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1034. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1035. <span class="md-ellipsis">
  1036. Community
  1037. </span>
  1038. <span class="md-nav__icon md-icon"></span>
  1039. </label>
  1040. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1041. <label class="md-nav__title" for="__nav_6">
  1042. <span class="md-nav__icon md-icon"></span>
  1043. Community
  1044. </label>
  1045. <ul class="md-nav__list" data-md-scrollfix>
  1046. <li class="md-nav__item md-nav__item--nested">
  1047. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1048. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1049. <span class="md-ellipsis">
  1050. Contributing
  1051. </span>
  1052. <span class="md-nav__icon md-icon"></span>
  1053. </label>
  1054. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1055. <label class="md-nav__title" for="__nav_6_1">
  1056. <span class="md-nav__icon md-icon"></span>
  1057. Contributing
  1058. </label>
  1059. <ul class="md-nav__list" data-md-scrollfix>
  1060. <li class="md-nav__item">
  1061. <a href="contributing/devguide/" class="md-nav__link">
  1062. <span class="md-ellipsis">
  1063. Developer guide
  1064. </span>
  1065. </a>
  1066. </li>
  1067. <li class="md-nav__item">
  1068. <a href="contributing/process/" class="md-nav__link">
  1069. <span class="md-ellipsis">
  1070. Contributing Process
  1071. </span>
  1072. </a>
  1073. </li>
  1074. <li class="md-nav__item">
  1075. <a href="contributing/release/" class="md-nav__link">
  1076. <span class="md-ellipsis">
  1077. Release Process
  1078. </span>
  1079. </a>
  1080. </li>
  1081. <li class="md-nav__item">
  1082. <a href="contributing/coc/" class="md-nav__link">
  1083. <span class="md-ellipsis">
  1084. Code of Conduct
  1085. </span>
  1086. </a>
  1087. </li>
  1088. <li class="md-nav__item">
  1089. <a href="contributing/calendar/" class="md-nav__link">
  1090. <span class="md-ellipsis">
  1091. Community meetings calendar
  1092. </span>
  1093. </a>
  1094. </li>
  1095. <li class="md-nav__item">
  1096. <a href="contributing/roadmap/" class="md-nav__link">
  1097. <span class="md-ellipsis">
  1098. Roadmap
  1099. </span>
  1100. </a>
  1101. </li>
  1102. </ul>
  1103. </nav>
  1104. </li>
  1105. <li class="md-nav__item md-nav__item--nested">
  1106. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1107. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1108. <span class="md-ellipsis">
  1109. External Resources
  1110. </span>
  1111. <span class="md-nav__icon md-icon"></span>
  1112. </label>
  1113. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1114. <label class="md-nav__title" for="__nav_6_2">
  1115. <span class="md-nav__icon md-icon"></span>
  1116. External Resources
  1117. </label>
  1118. <ul class="md-nav__list" data-md-scrollfix>
  1119. <li class="md-nav__item">
  1120. <a href="eso-talks/" class="md-nav__link">
  1121. <span class="md-ellipsis">
  1122. Talks
  1123. </span>
  1124. </a>
  1125. </li>
  1126. <li class="md-nav__item">
  1127. <a href="eso-demos/" class="md-nav__link">
  1128. <span class="md-ellipsis">
  1129. Demos
  1130. </span>
  1131. </a>
  1132. </li>
  1133. <li class="md-nav__item">
  1134. <a href="eso-blogs/" class="md-nav__link">
  1135. <span class="md-ellipsis">
  1136. Blogs
  1137. </span>
  1138. </a>
  1139. </li>
  1140. <li class="md-nav__item">
  1141. <a href="eso-tools/" class="md-nav__link">
  1142. <span class="md-ellipsis">
  1143. Tools
  1144. </span>
  1145. </a>
  1146. </li>
  1147. </ul>
  1148. </nav>
  1149. </li>
  1150. </ul>
  1151. </nav>
  1152. </li>
  1153. </ul>
  1154. </nav>
  1155. </div>
  1156. </div>
  1157. </div>
  1158. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1159. <div class="md-sidebar__scrollwrap">
  1160. <div class="md-sidebar__inner">
  1161. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1162. </nav>
  1163. </div>
  1164. </div>
  1165. </div>
  1166. <div class="md-content" data-md-component="content">
  1167. <article class="md-content__inner md-typeset">
  1168. <h1 id="sponsored-by"><a href="https://opencollective.com/external-secrets-org">Sponsored by</a></h1>
  1169. <p><a href="https://container-solutions.com"><img alt="cs-logo" src="pictures/cs_logo.png" /></a>
  1170. <a href="https://externalsecrets.com"><img alt="External Secrets inc." src="pictures/ESI_Logo.svg" /></a>
  1171. <a href="https://www.form3.tech/"><img alt="Form3" src="pictures/form3_logo.png" /></a>
  1172. <a href="https://www.pento.io"><img alt="Pento" src="pictures/pento_logo.png" /></a></p>
  1173. <h1 id="introduction">Introduction</h1>
  1174. <p><img alt="high-level" src="pictures/diagrams-high-level-simple.png" /></p>
  1175. <p><strong>External Secrets Operator</strong> is a Kubernetes operator that integrates external
  1176. secret management systems like <a href="https://aws.amazon.com/secrets-manager/">AWS Secrets
  1177. Manager</a>, <a href="https://www.vaultproject.io/">HashiCorp
  1178. Vault</a>, <a href="https://cloud.google.com/secret-manager">Google Secrets
  1179. Manager</a>, <a href="https://azure.microsoft.com/en-us/services/key-vault/">Azure Key
  1180. Vault</a>, <a href="https://www.ibm.com/cloud/secrets-manager">IBM Cloud Secrets Manager</a>, <a href="https://www.conjur.org">CyberArk Conjur</a>, <a href="https://www.pulumi.com/product/esc/">Pulumi ESC</a> and many more. The
  1181. operator reads information from external APIs and automatically injects the
  1182. values into a <a href="https://kubernetes.io/docs/concepts/configuration/secret/">Kubernetes
  1183. Secret</a>.</p>
  1184. <h3 id="what-is-the-goal-of-external-secrets-operator">What is the goal of External Secrets Operator?</h3>
  1185. <p>The goal of External Secrets Operator is to synchronize secrets from external
  1186. APIs into Kubernetes. ESO is a collection of custom API resources -
  1187. <code>ExternalSecret</code>, <code>SecretStore</code> and <code>ClusterSecretStore</code> that provide a
  1188. user-friendly abstraction for the external API that stores and manages the
  1189. lifecycle of the secrets for you.</p>
  1190. <h3 id="where-to-get-started">Where to get started</h3>
  1191. <p>To get started, please read through <a href="introduction/overview/">API overview</a> this should
  1192. give you a high-level overview to understand the API and use-cases. After that
  1193. please follow one of our <a href="guides/introduction/">guides</a> to get a jump start
  1194. using the operator. See our <a href="introduction/getting-started/">getting started guide</a> for installation instructions.</p>
  1195. <p>For a complete reference of the API types please refer to our <a href="api/spec/">API
  1196. Reference</a>.</p>
  1197. <h3 id="how-to-get-involved">How to get involved</h3>
  1198. <p>This project is driven by its users and contributors, and we welcome everybody
  1199. to get involved. Join our meetings, open issues or ask questions in Slack. The
  1200. success of this project depends on your input: No contribution is too small -
  1201. even opinions matter!</p>
  1202. <p>How to get involved:</p>
  1203. <ul>
  1204. <li>Bi-weekly Development Meeting every odd week at <a href="https://dateful.com/time-zone-converter?t=20:00&amp;tz=Europe/Berlin">8:00 PM Berlin Time</a> on Wednesday
  1205. (<a href="https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA">agenda</a>, <a href="https://meet.jit.si/eso-community-meeting">jitsi call</a>)</li>
  1206. <li><a href="https://kubernetes.slack.com/messages/external-secrets">Kubernetes Slack
  1207. #external-secrets</a></li>
  1208. <li><a href="contributing/process/">Contributing Process</a></li>
  1209. <li><a href="https://twitter.com/ExtSecretsOptr">Twitter</a></li>
  1210. </ul>
  1211. <h3 id="kicked-off-by">Kicked off by</h3>
  1212. <p><img alt="godaddy-logo" src="pictures/godaddy_logo.png" /></p>
  1213. </article>
  1214. </div>
  1215. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1216. </div>
  1217. </main>
  1218. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1219. <footer class="md-footer">
  1220. <div class="md-footer-meta md-typeset">
  1221. <div class="md-footer-meta__inner md-grid">
  1222. <div class="md-copyright">
  1223. <div class="md-copyright__highlight">
  1224. &copy; 2025 The external-secrets Authors.<br/>
  1225. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1226. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1227. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1228. </div>
  1229. Made with
  1230. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1231. Material for MkDocs
  1232. </a>
  1233. </div>
  1234. </div>
  1235. </div>
  1236. </footer>
  1237. </div>
  1238. <div class="md-dialog" data-md-component="dialog">
  1239. <div class="md-dialog__inner md-typeset"></div>
  1240. </div>
  1241. <script id="__config" type="application/json">{"base": ".", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "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>
  1242. <script src="assets/javascripts/bundle.13a4f30d.min.js"></script>
  1243. </body>
  1244. </html>