index.html 78 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328
  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="../prerequisites/">
  7. <link rel="next" href="../faq/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.19">
  10. <title>Getting started - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.7e37652d.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <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">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <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>
  17. <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>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#getting-started" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL("../.."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Getting started
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <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">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <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>
  68. </label>
  69. <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">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <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>
  72. </label>
  73. </form>
  74. <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>
  75. <label class="md-header__button md-icon" for="__search">
  76. <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>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <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>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <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>
  85. <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>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <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>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item md-tabs__item--active">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item">
  137. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../glossary/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Glossary
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../prerequisites/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. Prerequisites
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item md-nav__item--active">
  217. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  218. <label class="md-nav__link md-nav__link--active" for="__toc">
  219. <span class="md-ellipsis">
  220. Getting started
  221. </span>
  222. <span class="md-nav__icon md-icon"></span>
  223. </label>
  224. <a href="./" class="md-nav__link md-nav__link--active">
  225. <span class="md-ellipsis">
  226. Getting started
  227. </span>
  228. </a>
  229. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  230. <label class="md-nav__title" for="__toc">
  231. <span class="md-nav__icon md-icon"></span>
  232. Table of contents
  233. </label>
  234. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="#installing-with-helm" class="md-nav__link">
  237. <span class="md-ellipsis">
  238. Installing with Helm
  239. </span>
  240. </a>
  241. <nav class="md-nav" aria-label="Installing with Helm">
  242. <ul class="md-nav__list">
  243. <li class="md-nav__item">
  244. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  245. <span class="md-ellipsis">
  246. Option 1: Install from chart repository
  247. </span>
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  252. <span class="md-ellipsis">
  253. Option 2: Install chart from local build
  254. </span>
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. Create a secret containing your AWS credentials
  261. </span>
  262. </a>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="#create-your-first-secretstore" class="md-nav__link">
  266. <span class="md-ellipsis">
  267. Create your first SecretStore
  268. </span>
  269. </a>
  270. </li>
  271. <li class="md-nav__item">
  272. <a href="#create-your-first-externalsecret" class="md-nav__link">
  273. <span class="md-ellipsis">
  274. Create your first ExternalSecret
  275. </span>
  276. </a>
  277. </li>
  278. </ul>
  279. </nav>
  280. </li>
  281. <li class="md-nav__item">
  282. <a href="#uninstalling" class="md-nav__link">
  283. <span class="md-ellipsis">
  284. Uninstalling
  285. </span>
  286. </a>
  287. <nav class="md-nav" aria-label="Uninstalling">
  288. <ul class="md-nav__list">
  289. <li class="md-nav__item">
  290. <a href="#uninstalling-with-helm" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. Uninstalling with Helm
  293. </span>
  294. </a>
  295. </li>
  296. </ul>
  297. </nav>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../faq/" class="md-nav__link">
  304. <span class="md-ellipsis">
  305. FAQ
  306. </span>
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="../stability-support/" class="md-nav__link">
  311. <span class="md-ellipsis">
  312. Stability and Support
  313. </span>
  314. </a>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="../deprecation-policy/" class="md-nav__link">
  318. <span class="md-ellipsis">
  319. Deprecation Policy
  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" >
  328. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  329. <span class="md-ellipsis">
  330. API
  331. </span>
  332. <span class="md-nav__icon md-icon"></span>
  333. </label>
  334. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  335. <label class="md-nav__title" for="__nav_2">
  336. <span class="md-nav__icon md-icon"></span>
  337. API
  338. </label>
  339. <ul class="md-nav__list" data-md-scrollfix>
  340. <li class="md-nav__item">
  341. <a href="../../api/components/" class="md-nav__link">
  342. <span class="md-ellipsis">
  343. Components
  344. </span>
  345. </a>
  346. </li>
  347. <li class="md-nav__item md-nav__item--nested">
  348. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  349. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  350. <span class="md-ellipsis">
  351. Core Resources
  352. </span>
  353. <span class="md-nav__icon md-icon"></span>
  354. </label>
  355. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  356. <label class="md-nav__title" for="__nav_2_2">
  357. <span class="md-nav__icon md-icon"></span>
  358. Core Resources
  359. </label>
  360. <ul class="md-nav__list" data-md-scrollfix>
  361. <li class="md-nav__item">
  362. <a href="../../api/externalsecret/" class="md-nav__link">
  363. <span class="md-ellipsis">
  364. ExternalSecret
  365. </span>
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="../../api/secretstore/" class="md-nav__link">
  370. <span class="md-ellipsis">
  371. SecretStore
  372. </span>
  373. </a>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../../api/clustersecretstore/" class="md-nav__link">
  377. <span class="md-ellipsis">
  378. ClusterSecretStore
  379. </span>
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  384. <span class="md-ellipsis">
  385. ClusterExternalSecret
  386. </span>
  387. </a>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="../../api/clusterpushsecret/" class="md-nav__link">
  391. <span class="md-ellipsis">
  392. ClusterPushSecret
  393. </span>
  394. </a>
  395. </li>
  396. <li class="md-nav__item">
  397. <a href="../../api/pushsecret/" class="md-nav__link">
  398. <span class="md-ellipsis">
  399. PushSecret
  400. </span>
  401. </a>
  402. </li>
  403. </ul>
  404. </nav>
  405. </li>
  406. <li class="md-nav__item md-nav__item--nested">
  407. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  408. <div class="md-nav__link md-nav__container">
  409. <a href="../../api/generator/" class="md-nav__link ">
  410. <span class="md-ellipsis">
  411. Generators
  412. </span>
  413. </a>
  414. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  415. <span class="md-nav__icon md-icon"></span>
  416. </label>
  417. </div>
  418. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  419. <label class="md-nav__title" for="__nav_2_3">
  420. <span class="md-nav__icon md-icon"></span>
  421. Generators
  422. </label>
  423. <ul class="md-nav__list" data-md-scrollfix>
  424. <li class="md-nav__item">
  425. <a href="../../api/generator/acr/" class="md-nav__link">
  426. <span class="md-ellipsis">
  427. Azure Container Registry
  428. </span>
  429. </a>
  430. </li>
  431. <li class="md-nav__item">
  432. <a href="../../api/generator/ecr/" class="md-nav__link">
  433. <span class="md-ellipsis">
  434. AWS Elastic Container Registry
  435. </span>
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../api/generator/sts/" class="md-nav__link">
  440. <span class="md-ellipsis">
  441. AWS STS Session Token
  442. </span>
  443. </a>
  444. </li>
  445. <li class="md-nav__item">
  446. <a href="../../api/generator/cluster/" class="md-nav__link">
  447. <span class="md-ellipsis">
  448. Cluster Generator
  449. </span>
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="../../api/generator/gcr/" class="md-nav__link">
  454. <span class="md-ellipsis">
  455. Google Container Registry
  456. </span>
  457. </a>
  458. </li>
  459. <li class="md-nav__item">
  460. <a href="../../api/generator/quay/" class="md-nav__link">
  461. <span class="md-ellipsis">
  462. Quay
  463. </span>
  464. </a>
  465. </li>
  466. <li class="md-nav__item">
  467. <a href="../../api/generator/vault/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Vault Dynamic Secret
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../../api/generator/password/" class="md-nav__link">
  475. <span class="md-ellipsis">
  476. Password
  477. </span>
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../api/generator/fake/" class="md-nav__link">
  482. <span class="md-ellipsis">
  483. Fake
  484. </span>
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../../api/generator/webhook/" class="md-nav__link">
  489. <span class="md-ellipsis">
  490. Webhook
  491. </span>
  492. </a>
  493. </li>
  494. <li class="md-nav__item">
  495. <a href="../../api/generator/github/" class="md-nav__link">
  496. <span class="md-ellipsis">
  497. Github
  498. </span>
  499. </a>
  500. </li>
  501. <li class="md-nav__item">
  502. <a href="../../api/generator/uuid/" class="md-nav__link">
  503. <span class="md-ellipsis">
  504. UUID
  505. </span>
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../api/generator/mfa/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. MFA
  512. </span>
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../api/generator/sshkey/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. SSHKey
  519. </span>
  520. </a>
  521. </li>
  522. </ul>
  523. </nav>
  524. </li>
  525. <li class="md-nav__item md-nav__item--nested">
  526. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  527. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  528. <span class="md-ellipsis">
  529. Reference Docs
  530. </span>
  531. <span class="md-nav__icon md-icon"></span>
  532. </label>
  533. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  534. <label class="md-nav__title" for="__nav_2_4">
  535. <span class="md-nav__icon md-icon"></span>
  536. Reference Docs
  537. </label>
  538. <ul class="md-nav__list" data-md-scrollfix>
  539. <li class="md-nav__item">
  540. <a href="../../api/spec/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. API specification
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../api/controller-options/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Controller Options
  550. </span>
  551. </a>
  552. </li>
  553. <li class="md-nav__item">
  554. <a href="../../api/metrics/" class="md-nav__link">
  555. <span class="md-ellipsis">
  556. Metrics
  557. </span>
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../api/selectable-fields/" class="md-nav__link">
  562. <span class="md-ellipsis">
  563. Selectable Fields
  564. </span>
  565. </a>
  566. </li>
  567. </ul>
  568. </nav>
  569. </li>
  570. </ul>
  571. </nav>
  572. </li>
  573. <li class="md-nav__item md-nav__item--nested">
  574. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  575. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  576. <span class="md-ellipsis">
  577. Guides
  578. </span>
  579. <span class="md-nav__icon md-icon"></span>
  580. </label>
  581. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  582. <label class="md-nav__title" for="__nav_3">
  583. <span class="md-nav__icon md-icon"></span>
  584. Guides
  585. </label>
  586. <ul class="md-nav__list" data-md-scrollfix>
  587. <li class="md-nav__item">
  588. <a href="../../guides/introduction/" class="md-nav__link">
  589. <span class="md-ellipsis">
  590. Introduction
  591. </span>
  592. </a>
  593. </li>
  594. <li class="md-nav__item md-nav__item--nested">
  595. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  596. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  597. <span class="md-ellipsis">
  598. External Secrets
  599. </span>
  600. <span class="md-nav__icon md-icon"></span>
  601. </label>
  602. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  603. <label class="md-nav__title" for="__nav_3_2">
  604. <span class="md-nav__icon md-icon"></span>
  605. External Secrets
  606. </label>
  607. <ul class="md-nav__list" data-md-scrollfix>
  608. <li class="md-nav__item">
  609. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  610. <span class="md-ellipsis">
  611. Extract structured data
  612. </span>
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="../../guides/getallsecrets/" class="md-nav__link">
  617. <span class="md-ellipsis">
  618. Find Secrets by Name or Metadata
  619. </span>
  620. </a>
  621. </li>
  622. <li class="md-nav__item">
  623. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  624. <span class="md-ellipsis">
  625. Rewriting Keys
  626. </span>
  627. </a>
  628. </li>
  629. <li class="md-nav__item md-nav__item--nested">
  630. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  631. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  632. <span class="md-ellipsis">
  633. Advanced Templating
  634. </span>
  635. <span class="md-nav__icon md-icon"></span>
  636. </label>
  637. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  638. <label class="md-nav__title" for="__nav_3_2_4">
  639. <span class="md-nav__icon md-icon"></span>
  640. Advanced Templating
  641. </label>
  642. <ul class="md-nav__list" data-md-scrollfix>
  643. <li class="md-nav__item">
  644. <a href="../../guides/templating/" class="md-nav__link">
  645. <span class="md-ellipsis">
  646. v2
  647. </span>
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="../../guides/templating-v1/" class="md-nav__link">
  652. <span class="md-ellipsis">
  653. v1
  654. </span>
  655. </a>
  656. </li>
  657. </ul>
  658. </nav>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  662. <span class="md-ellipsis">
  663. Kubernetes Secret Types
  664. </span>
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  669. <span class="md-ellipsis">
  670. Lifecycle: ownership & deletion
  671. </span>
  672. </a>
  673. </li>
  674. <li class="md-nav__item">
  675. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  676. <span class="md-ellipsis">
  677. Decoding Strategies
  678. </span>
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../../guides/controller-class/" class="md-nav__link">
  683. <span class="md-ellipsis">
  684. Controller Classes
  685. </span>
  686. </a>
  687. </li>
  688. </ul>
  689. </nav>
  690. </li>
  691. <li class="md-nav__item">
  692. <a href="../../guides/generator/" class="md-nav__link">
  693. <span class="md-ellipsis">
  694. Generators
  695. </span>
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../../guides/pushsecrets/" class="md-nav__link">
  700. <span class="md-ellipsis">
  701. Push Secrets
  702. </span>
  703. </a>
  704. </li>
  705. <li class="md-nav__item md-nav__item--nested">
  706. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  707. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  708. <span class="md-ellipsis">
  709. Operations
  710. </span>
  711. <span class="md-nav__icon md-icon"></span>
  712. </label>
  713. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  714. <label class="md-nav__title" for="__nav_3_5">
  715. <span class="md-nav__icon md-icon"></span>
  716. Operations
  717. </label>
  718. <ul class="md-nav__list" data-md-scrollfix>
  719. <li class="md-nav__item">
  720. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  721. <span class="md-ellipsis">
  722. Multi Tenancy
  723. </span>
  724. </a>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../../guides/security-best-practices/" class="md-nav__link">
  728. <span class="md-ellipsis">
  729. Security Best Practices
  730. </span>
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="../../guides/threat-model/" class="md-nav__link">
  735. <span class="md-ellipsis">
  736. Threat Model
  737. </span>
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../../guides/v1beta1/" class="md-nav__link">
  742. <span class="md-ellipsis">
  743. Upgrading to v1beta1
  744. </span>
  745. </a>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="../../guides/using-latest-image/" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. Using Latest Image
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. Disable Cluster Features
  758. </span>
  759. </a>
  760. </li>
  761. </ul>
  762. </nav>
  763. </li>
  764. <li class="md-nav__item md-nav__item--nested">
  765. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  766. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  767. <span class="md-ellipsis">
  768. Tooling
  769. </span>
  770. <span class="md-nav__icon md-icon"></span>
  771. </label>
  772. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  773. <label class="md-nav__title" for="__nav_3_6">
  774. <span class="md-nav__icon md-icon"></span>
  775. Tooling
  776. </label>
  777. <ul class="md-nav__list" data-md-scrollfix>
  778. <li class="md-nav__item">
  779. <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
  780. <span class="md-ellipsis">
  781. Using the esoctl tool
  782. </span>
  783. </a>
  784. </li>
  785. </ul>
  786. </nav>
  787. </li>
  788. </ul>
  789. </nav>
  790. </li>
  791. <li class="md-nav__item md-nav__item--nested">
  792. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  793. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  794. <span class="md-ellipsis">
  795. Provider
  796. </span>
  797. <span class="md-nav__icon md-icon"></span>
  798. </label>
  799. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  800. <label class="md-nav__title" for="__nav_4">
  801. <span class="md-nav__icon md-icon"></span>
  802. Provider
  803. </label>
  804. <ul class="md-nav__list" data-md-scrollfix>
  805. <li class="md-nav__item">
  806. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  807. <span class="md-ellipsis">
  808. AWS Secrets Manager
  809. </span>
  810. </a>
  811. </li>
  812. <li class="md-nav__item">
  813. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  814. <span class="md-ellipsis">
  815. AWS Parameter Store
  816. </span>
  817. </a>
  818. </li>
  819. <li class="md-nav__item">
  820. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  821. <span class="md-ellipsis">
  822. Azure Key Vault
  823. </span>
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="../../provider/beyondtrust/" class="md-nav__link">
  828. <span class="md-ellipsis">
  829. BeyondTrust
  830. </span>
  831. </a>
  832. </li>
  833. <li class="md-nav__item">
  834. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  835. <span class="md-ellipsis">
  836. Bitwarden Secrets Manager
  837. </span>
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="../../provider/chef/" class="md-nav__link">
  842. <span class="md-ellipsis">
  843. Chef
  844. </span>
  845. </a>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="../../provider/cloudru/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. Cloud.ru Secret Manager
  851. </span>
  852. </a>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="../../provider/conjur/" class="md-nav__link">
  856. <span class="md-ellipsis">
  857. CyberArk Conjur
  858. </span>
  859. </a>
  860. </li>
  861. <li class="md-nav__item">
  862. <a href="../../provider/device42/" class="md-nav__link">
  863. <span class="md-ellipsis">
  864. Device42
  865. </span>
  866. </a>
  867. </li>
  868. <li class="md-nav__item">
  869. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  870. <span class="md-ellipsis">
  871. Google Cloud Secret Manager
  872. </span>
  873. </a>
  874. </li>
  875. <li class="md-nav__item">
  876. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  877. <span class="md-ellipsis">
  878. HashiCorp Vault
  879. </span>
  880. </a>
  881. </li>
  882. <li class="md-nav__item">
  883. <a href="../../provider/kubernetes/" class="md-nav__link">
  884. <span class="md-ellipsis">
  885. Kubernetes
  886. </span>
  887. </a>
  888. </li>
  889. <li class="md-nav__item">
  890. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  891. <span class="md-ellipsis">
  892. IBM Secrets Manager
  893. </span>
  894. </a>
  895. </li>
  896. <li class="md-nav__item">
  897. <a href="../../provider/akeyless/" class="md-nav__link">
  898. <span class="md-ellipsis">
  899. Akeyless
  900. </span>
  901. </a>
  902. </li>
  903. <li class="md-nav__item">
  904. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  905. <span class="md-ellipsis">
  906. Yandex Certificate Manager
  907. </span>
  908. </a>
  909. </li>
  910. <li class="md-nav__item">
  911. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  912. <span class="md-ellipsis">
  913. Yandex Lockbox
  914. </span>
  915. </a>
  916. </li>
  917. <li class="md-nav__item">
  918. <a href="../../provider/alibaba/" class="md-nav__link">
  919. <span class="md-ellipsis">
  920. Alibaba Cloud
  921. </span>
  922. </a>
  923. </li>
  924. <li class="md-nav__item">
  925. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  926. <span class="md-ellipsis">
  927. GitLab Variables
  928. </span>
  929. </a>
  930. </li>
  931. <li class="md-nav__item">
  932. <a href="../../provider/github/" class="md-nav__link">
  933. <span class="md-ellipsis">
  934. Github Actions Secrets
  935. </span>
  936. </a>
  937. </li>
  938. <li class="md-nav__item">
  939. <a href="../../provider/oracle-vault/" class="md-nav__link">
  940. <span class="md-ellipsis">
  941. Oracle Vault
  942. </span>
  943. </a>
  944. </li>
  945. <li class="md-nav__item">
  946. <a href="../../provider/1password-automation/" class="md-nav__link">
  947. <span class="md-ellipsis">
  948. 1Password Connect Server
  949. </span>
  950. </a>
  951. </li>
  952. <li class="md-nav__item">
  953. <a href="../../provider/1password-sdk/" class="md-nav__link">
  954. <span class="md-ellipsis">
  955. 1Password SDK
  956. </span>
  957. </a>
  958. </li>
  959. <li class="md-nav__item">
  960. <a href="../../provider/webhook/" class="md-nav__link">
  961. <span class="md-ellipsis">
  962. Webhook
  963. </span>
  964. </a>
  965. </li>
  966. <li class="md-nav__item">
  967. <a href="../../provider/fake/" class="md-nav__link">
  968. <span class="md-ellipsis">
  969. Fake
  970. </span>
  971. </a>
  972. </li>
  973. <li class="md-nav__item">
  974. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  975. <span class="md-ellipsis">
  976. senhasegura DevOps Secrets Management (DSM)
  977. </span>
  978. </a>
  979. </li>
  980. <li class="md-nav__item">
  981. <a href="../../provider/doppler/" class="md-nav__link">
  982. <span class="md-ellipsis">
  983. Doppler
  984. </span>
  985. </a>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="../../provider/keeper-security/" class="md-nav__link">
  989. <span class="md-ellipsis">
  990. Keeper Security
  991. </span>
  992. </a>
  993. </li>
  994. <li class="md-nav__item">
  995. <a href="../../provider/cloak/" class="md-nav__link">
  996. <span class="md-ellipsis">
  997. Cloak End 2 End Encrypted Secrets
  998. </span>
  999. </a>
  1000. </li>
  1001. <li class="md-nav__item">
  1002. <a href="../../provider/scaleway/" class="md-nav__link">
  1003. <span class="md-ellipsis">
  1004. Scaleway
  1005. </span>
  1006. </a>
  1007. </li>
  1008. <li class="md-nav__item">
  1009. <a href="../../provider/delinea/" class="md-nav__link">
  1010. <span class="md-ellipsis">
  1011. Delinea
  1012. </span>
  1013. </a>
  1014. </li>
  1015. <li class="md-nav__item">
  1016. <a href="../../provider/secretserver/" class="md-nav__link">
  1017. <span class="md-ellipsis">
  1018. Secret Server
  1019. </span>
  1020. </a>
  1021. </li>
  1022. <li class="md-nav__item">
  1023. <a href="../../provider/passbolt/" class="md-nav__link">
  1024. <span class="md-ellipsis">
  1025. Passbolt
  1026. </span>
  1027. </a>
  1028. </li>
  1029. <li class="md-nav__item">
  1030. <a href="../../provider/pulumi/" class="md-nav__link">
  1031. <span class="md-ellipsis">
  1032. Pulumi ESC
  1033. </span>
  1034. </a>
  1035. </li>
  1036. <li class="md-nav__item">
  1037. <a href="../../provider/onboardbase/" class="md-nav__link">
  1038. <span class="md-ellipsis">
  1039. Onboardbase
  1040. </span>
  1041. </a>
  1042. </li>
  1043. <li class="md-nav__item">
  1044. <a href="../../provider-passworddepot/" class="md-nav__link">
  1045. <span class="md-ellipsis">
  1046. Password Depot
  1047. </span>
  1048. </a>
  1049. </li>
  1050. <li class="md-nav__item">
  1051. <a href="../../provider/fortanix/" class="md-nav__link">
  1052. <span class="md-ellipsis">
  1053. Fortanix
  1054. </span>
  1055. </a>
  1056. </li>
  1057. <li class="md-nav__item">
  1058. <a href="../../provider/infisical/" class="md-nav__link">
  1059. <span class="md-ellipsis">
  1060. Infisical
  1061. </span>
  1062. </a>
  1063. </li>
  1064. <li class="md-nav__item">
  1065. <a href="../../provider/previder/" class="md-nav__link">
  1066. <span class="md-ellipsis">
  1067. Previder
  1068. </span>
  1069. </a>
  1070. </li>
  1071. <li class="md-nav__item">
  1072. <a href="../../provider/openbao/" class="md-nav__link">
  1073. <span class="md-ellipsis">
  1074. OpenBao
  1075. </span>
  1076. </a>
  1077. </li>
  1078. </ul>
  1079. </nav>
  1080. </li>
  1081. <li class="md-nav__item md-nav__item--nested">
  1082. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1083. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1084. <span class="md-ellipsis">
  1085. Examples
  1086. </span>
  1087. <span class="md-nav__icon md-icon"></span>
  1088. </label>
  1089. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1090. <label class="md-nav__title" for="__nav_5">
  1091. <span class="md-nav__icon md-icon"></span>
  1092. Examples
  1093. </label>
  1094. <ul class="md-nav__list" data-md-scrollfix>
  1095. <li class="md-nav__item">
  1096. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1097. <span class="md-ellipsis">
  1098. FluxCD
  1099. </span>
  1100. </a>
  1101. </li>
  1102. <li class="md-nav__item">
  1103. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1104. <span class="md-ellipsis">
  1105. Anchore Engine
  1106. </span>
  1107. </a>
  1108. </li>
  1109. <li class="md-nav__item">
  1110. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1111. <span class="md-ellipsis">
  1112. Jenkins
  1113. </span>
  1114. </a>
  1115. </li>
  1116. <li class="md-nav__item">
  1117. <a href="../../examples/bitwarden/" class="md-nav__link">
  1118. <span class="md-ellipsis">
  1119. Bitwarden
  1120. </span>
  1121. </a>
  1122. </li>
  1123. </ul>
  1124. </nav>
  1125. </li>
  1126. <li class="md-nav__item md-nav__item--nested">
  1127. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1128. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1129. <span class="md-ellipsis">
  1130. Community
  1131. </span>
  1132. <span class="md-nav__icon md-icon"></span>
  1133. </label>
  1134. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1135. <label class="md-nav__title" for="__nav_6">
  1136. <span class="md-nav__icon md-icon"></span>
  1137. Community
  1138. </label>
  1139. <ul class="md-nav__list" data-md-scrollfix>
  1140. <li class="md-nav__item md-nav__item--nested">
  1141. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1142. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1143. <span class="md-ellipsis">
  1144. Contributing
  1145. </span>
  1146. <span class="md-nav__icon md-icon"></span>
  1147. </label>
  1148. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1149. <label class="md-nav__title" for="__nav_6_1">
  1150. <span class="md-nav__icon md-icon"></span>
  1151. Contributing
  1152. </label>
  1153. <ul class="md-nav__list" data-md-scrollfix>
  1154. <li class="md-nav__item">
  1155. <a href="../../contributing/devguide/" class="md-nav__link">
  1156. <span class="md-ellipsis">
  1157. Developer guide
  1158. </span>
  1159. </a>
  1160. </li>
  1161. <li class="md-nav__item">
  1162. <a href="../../contributing/process/" class="md-nav__link">
  1163. <span class="md-ellipsis">
  1164. Contributing Process
  1165. </span>
  1166. </a>
  1167. </li>
  1168. <li class="md-nav__item">
  1169. <a href="../../contributing/release/" class="md-nav__link">
  1170. <span class="md-ellipsis">
  1171. Release Process
  1172. </span>
  1173. </a>
  1174. </li>
  1175. <li class="md-nav__item">
  1176. <a href="../../contributing/coc/" class="md-nav__link">
  1177. <span class="md-ellipsis">
  1178. Code of Conduct
  1179. </span>
  1180. </a>
  1181. </li>
  1182. <li class="md-nav__item">
  1183. <a href="../../contributing/calendar/" class="md-nav__link">
  1184. <span class="md-ellipsis">
  1185. Community meetings calendar
  1186. </span>
  1187. </a>
  1188. </li>
  1189. <li class="md-nav__item">
  1190. <a href="../../contributing/roadmap/" class="md-nav__link">
  1191. <span class="md-ellipsis">
  1192. Roadmap
  1193. </span>
  1194. </a>
  1195. </li>
  1196. <li class="md-nav__item">
  1197. <a href="../../contributing/burnout-mitigation/" class="md-nav__link">
  1198. <span class="md-ellipsis">
  1199. Burnout Prevention
  1200. </span>
  1201. </a>
  1202. </li>
  1203. </ul>
  1204. </nav>
  1205. </li>
  1206. <li class="md-nav__item md-nav__item--nested">
  1207. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1208. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1209. <span class="md-ellipsis">
  1210. External Resources
  1211. </span>
  1212. <span class="md-nav__icon md-icon"></span>
  1213. </label>
  1214. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1215. <label class="md-nav__title" for="__nav_6_2">
  1216. <span class="md-nav__icon md-icon"></span>
  1217. External Resources
  1218. </label>
  1219. <ul class="md-nav__list" data-md-scrollfix>
  1220. <li class="md-nav__item">
  1221. <a href="../../eso-talks/" class="md-nav__link">
  1222. <span class="md-ellipsis">
  1223. Talks
  1224. </span>
  1225. </a>
  1226. </li>
  1227. <li class="md-nav__item">
  1228. <a href="../../eso-demos/" class="md-nav__link">
  1229. <span class="md-ellipsis">
  1230. Demos
  1231. </span>
  1232. </a>
  1233. </li>
  1234. <li class="md-nav__item">
  1235. <a href="../../eso-blogs/" class="md-nav__link">
  1236. <span class="md-ellipsis">
  1237. Blogs
  1238. </span>
  1239. </a>
  1240. </li>
  1241. <li class="md-nav__item">
  1242. <a href="../../eso-tools/" class="md-nav__link">
  1243. <span class="md-ellipsis">
  1244. Tools
  1245. </span>
  1246. </a>
  1247. </li>
  1248. </ul>
  1249. </nav>
  1250. </li>
  1251. </ul>
  1252. </nav>
  1253. </li>
  1254. </ul>
  1255. </nav>
  1256. </div>
  1257. </div>
  1258. </div>
  1259. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1260. <div class="md-sidebar__scrollwrap">
  1261. <div class="md-sidebar__inner">
  1262. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1263. <label class="md-nav__title" for="__toc">
  1264. <span class="md-nav__icon md-icon"></span>
  1265. Table of contents
  1266. </label>
  1267. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1268. <li class="md-nav__item">
  1269. <a href="#installing-with-helm" class="md-nav__link">
  1270. <span class="md-ellipsis">
  1271. Installing with Helm
  1272. </span>
  1273. </a>
  1274. <nav class="md-nav" aria-label="Installing with Helm">
  1275. <ul class="md-nav__list">
  1276. <li class="md-nav__item">
  1277. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  1278. <span class="md-ellipsis">
  1279. Option 1: Install from chart repository
  1280. </span>
  1281. </a>
  1282. </li>
  1283. <li class="md-nav__item">
  1284. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  1285. <span class="md-ellipsis">
  1286. Option 2: Install chart from local build
  1287. </span>
  1288. </a>
  1289. </li>
  1290. <li class="md-nav__item">
  1291. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  1292. <span class="md-ellipsis">
  1293. Create a secret containing your AWS credentials
  1294. </span>
  1295. </a>
  1296. </li>
  1297. <li class="md-nav__item">
  1298. <a href="#create-your-first-secretstore" class="md-nav__link">
  1299. <span class="md-ellipsis">
  1300. Create your first SecretStore
  1301. </span>
  1302. </a>
  1303. </li>
  1304. <li class="md-nav__item">
  1305. <a href="#create-your-first-externalsecret" class="md-nav__link">
  1306. <span class="md-ellipsis">
  1307. Create your first ExternalSecret
  1308. </span>
  1309. </a>
  1310. </li>
  1311. </ul>
  1312. </nav>
  1313. </li>
  1314. <li class="md-nav__item">
  1315. <a href="#uninstalling" class="md-nav__link">
  1316. <span class="md-ellipsis">
  1317. Uninstalling
  1318. </span>
  1319. </a>
  1320. <nav class="md-nav" aria-label="Uninstalling">
  1321. <ul class="md-nav__list">
  1322. <li class="md-nav__item">
  1323. <a href="#uninstalling-with-helm" class="md-nav__link">
  1324. <span class="md-ellipsis">
  1325. Uninstalling with Helm
  1326. </span>
  1327. </a>
  1328. </li>
  1329. </ul>
  1330. </nav>
  1331. </li>
  1332. </ul>
  1333. </nav>
  1334. </div>
  1335. </div>
  1336. </div>
  1337. <div class="md-content" data-md-component="content">
  1338. <article class="md-content__inner md-typeset">
  1339. <h1 id="getting-started">Getting started</h1>
  1340. <p>External-secrets runs within your Kubernetes cluster as a deployment resource.
  1341. It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources
  1342. and manages Kubernetes secret resources with ExternalSecret resources.</p>
  1343. <p>This tutorial is intended for those who already have the PreRequisites complete. If there is a term that you don't comprehend, we suggest you to take a look at the Glossary for a general understanding.</p>
  1344. <blockquote>
  1345. <p>Note: The minimum supported version of Kubernetes is <code>1.16.0</code>. Users still running Kubernetes v1.15 or below should upgrade
  1346. to a supported version before installing external-secrets.</p>
  1347. <p>Note: Our CRDs have reached the 256KB limit! You have to use <a href="https://kubernetes.io/docs/reference/using-api/server-side-apply/">server-side-apply</a> in all locations to install them correctly.</p>
  1348. </blockquote>
  1349. <h2 id="installing-with-helm">Installing with Helm</h2>
  1350. <p>The default install options will automatically install and manage the CRDs as part of your helm release. If you do not want the CRDs to be automatically upgraded and managed, you must set the <code>installCRDs</code> option to <code>false</code>. (e.g. <code>--set installCRDs=false</code>)</p>
  1351. <p>You can install those CRDs outside of <code>helm</code> using:
  1352. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>apply<span class="w"> </span>-k<span class="w"> </span><span class="s2">&quot;https://raw.githubusercontent.com/external-secrets/external-secrets/&lt;replace_with_your_version&gt;/deploy/crds/bundle.yaml&quot;</span><span class="w"> </span>--server-side
  1353. </code></pre></div></p>
  1354. <p>Uncomment the relevant line in the next steps to disable the automatic install of CRDs.</p>
  1355. <h3 id="option-1-install-from-chart-repository">Option 1: Install from chart repository</h3>
  1356. <div class="highlight"><pre><span></span><code>helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>external-secrets<span class="w"> </span>https://charts.external-secrets.io
  1357. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1358. <span class="w"> </span>external-secrets/external-secrets<span class="w"> </span><span class="se">\</span>
  1359. <span class="w"> </span>-n<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1360. <span class="w"> </span>--create-namespace<span class="w"> </span><span class="se">\</span>
  1361. <span class="w"> </span><span class="c1"># --set installCRDs=false</span>
  1362. </code></pre></div>
  1363. <h3 id="option-2-install-chart-from-local-build">Option 2: Install chart from local build</h3>
  1364. <p>Build and install the Helm chart locally after cloning the repository.</p>
  1365. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>helm.build
  1366. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1367. <span class="w"> </span>./bin/chart/external-secrets.tgz<span class="w"> </span><span class="se">\</span>
  1368. <span class="w"> </span>-n<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1369. <span class="w"> </span>--create-namespace<span class="w"> </span><span class="se">\</span>
  1370. <span class="w"> </span><span class="c1"># --set installCRDs=false</span>
  1371. </code></pre></div>
  1372. <h3 id="create-a-secret-containing-your-aws-credentials">Create a secret containing your AWS credentials</h3>
  1373. <div class="highlight"><pre><span></span><code><span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;KEYID&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>./access-key
  1374. <span class="nb">echo</span><span class="w"> </span>-n<span class="w"> </span><span class="s1">&#39;SECRETKEY&#39;</span><span class="w"> </span>&gt;<span class="w"> </span>./secret-access-key
  1375. kubectl<span class="w"> </span>create<span class="w"> </span>secret<span class="w"> </span>generic<span class="w"> </span>awssm-secret<span class="w"> </span>--from-file<span class="o">=</span>./access-key<span class="w"> </span>--from-file<span class="o">=</span>./secret-access-key
  1376. </code></pre></div>
  1377. <h3 id="create-your-first-secretstore">Create your first SecretStore</h3>
  1378. <p>Create a file 'basic-secret-store.yaml' with the following content.</p>
  1379. <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/v1</span>
  1380. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1381. <span class="nt">metadata</span><span class="p">:</span>
  1382. <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>
  1383. <span class="nt">spec</span><span class="p">:</span>
  1384. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1385. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1386. <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>
  1387. <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>
  1388. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1389. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1390. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1391. <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>
  1392. <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>
  1393. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1394. <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>
  1395. <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>
  1396. </code></pre></div>
  1397. <p>Apply it to create a SecretStore resource.</p>
  1398. <div class="highlight"><pre><span></span><code>kubectl apply -f &quot;basic-secret-store.yaml&quot;
  1399. </code></pre></div>
  1400. <h3 id="create-your-first-externalsecret">Create your first ExternalSecret</h3>
  1401. <p>Create a file 'basic-external-secret.yaml' with the following content.</p>
  1402. <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/v1</span>
  1403. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1404. <span class="nt">metadata</span><span class="p">:</span>
  1405. <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>
  1406. <span class="nt">spec</span><span class="p">:</span>
  1407. <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>
  1408. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1409. <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>
  1410. <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>
  1411. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1412. <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>
  1413. <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>
  1414. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1415. <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>
  1416. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1417. <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>
  1418. <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>
  1419. <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>
  1420. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1421. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1422. <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>
  1423. </code></pre></div>
  1424. <p>Apply it to create an External Secret resource.</p>
  1425. <div class="highlight"><pre><span></span><code>kubectl apply -f &quot;basic-external-secret.yaml&quot;
  1426. </code></pre></div>
  1427. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>describe<span class="w"> </span>externalsecret<span class="w"> </span>example
  1428. <span class="c1"># [...]</span>
  1429. Name:<span class="w"> </span>example
  1430. Status:
  1431. <span class="w"> </span>Binding:
  1432. <span class="w"> </span>Name:<span class="w"> </span>secret-to-be-created
  1433. <span class="w"> </span>Conditions:
  1434. <span class="w"> </span>Last<span class="w"> </span>Transition<span class="w"> </span>Time:<span class="w"> </span><span class="m">2021</span>-02-24T16:45:23Z
  1435. <span class="w"> </span>Message:<span class="w"> </span>Secret<span class="w"> </span>was<span class="w"> </span>synced
  1436. <span class="w"> </span>Reason:<span class="w"> </span>SecretSynced
  1437. <span class="w"> </span>Status:<span class="w"> </span>True
  1438. <span class="w"> </span>Type:<span class="w"> </span>Ready
  1439. <span class="w"> </span>Refresh<span class="w"> </span>Time:<span class="w"> </span><span class="m">2021</span>-02-24T16:45:24Z
  1440. Events:<span class="w"> </span>&lt;none&gt;
  1441. </code></pre></div>
  1442. <p>For more advanced examples, please read the other
  1443. <a href="../../guides/introduction/">guides</a>.</p>
  1444. <h2 id="uninstalling">Uninstalling</h2>
  1445. <p>Before continuing, ensure that all external-secret resources that have been created by users have been deleted.
  1446. You can check for any existing resources with the following command:</p>
  1447. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>SecretStores,ClusterSecretStores,ExternalSecrets<span class="w"> </span>--all-namespaces
  1448. </code></pre></div>
  1449. <p>Once all these resources have been deleted you are ready to uninstall external-secrets.</p>
  1450. <h3 id="uninstalling-with-helm">Uninstalling with Helm</h3>
  1451. <p>Uninstall the helm release using the delete command.</p>
  1452. <div class="highlight"><pre><span></span><code>helm<span class="w"> </span>delete<span class="w"> </span>external-secrets<span class="w"> </span>--namespace<span class="w"> </span>external-secrets
  1453. </code></pre></div>
  1454. </article>
  1455. </div>
  1456. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1457. </div>
  1458. </main>
  1459. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1460. <footer class="md-footer">
  1461. <div class="md-footer-meta md-typeset">
  1462. <div class="md-footer-meta__inner md-grid">
  1463. <div class="md-copyright">
  1464. <div class="md-copyright__highlight">
  1465. &copy; 2025 The external-secrets Authors.<br/>
  1466. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1467. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1468. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1469. </div>
  1470. Made with
  1471. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1472. Material for MkDocs
  1473. </a>
  1474. </div>
  1475. </div>
  1476. </div>
  1477. </footer>
  1478. </div>
  1479. <div class="md-dialog" data-md-component="dialog">
  1480. <div class="md-dialog__inner md-typeset"></div>
  1481. </div>
  1482. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.973d3a69.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>
  1483. <script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
  1484. </body>
  1485. </html>