index.html 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698
  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="../overview/">
  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.5.48">
  10. <title>Getting started - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.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]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <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 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 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>
  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 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 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>
  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 md-nav__item--active">
  203. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  204. <label class="md-nav__link md-nav__link--active" for="__toc">
  205. <span class="md-ellipsis">
  206. Getting started
  207. </span>
  208. <span class="md-nav__icon md-icon"></span>
  209. </label>
  210. <a href="./" class="md-nav__link md-nav__link--active">
  211. <span class="md-ellipsis">
  212. Getting started
  213. </span>
  214. </a>
  215. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  216. <label class="md-nav__title" for="__toc">
  217. <span class="md-nav__icon md-icon"></span>
  218. Table of contents
  219. </label>
  220. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  221. <li class="md-nav__item">
  222. <a href="#installing-with-helm" class="md-nav__link">
  223. <span class="md-ellipsis">
  224. Installing with Helm
  225. </span>
  226. </a>
  227. <nav class="md-nav" aria-label="Installing with Helm">
  228. <ul class="md-nav__list">
  229. <li class="md-nav__item">
  230. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  231. <span class="md-ellipsis">
  232. Option 1: Install from chart repository
  233. </span>
  234. </a>
  235. </li>
  236. <li class="md-nav__item">
  237. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  238. <span class="md-ellipsis">
  239. Option 2: Install chart from local build
  240. </span>
  241. </a>
  242. </li>
  243. <li class="md-nav__item">
  244. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  245. <span class="md-ellipsis">
  246. Create a secret containing your AWS credentials
  247. </span>
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="#create-your-first-secretstore" class="md-nav__link">
  252. <span class="md-ellipsis">
  253. Create your first SecretStore
  254. </span>
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="#create-your-first-externalsecret" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. Create your first ExternalSecret
  261. </span>
  262. </a>
  263. </li>
  264. </ul>
  265. </nav>
  266. </li>
  267. <li class="md-nav__item">
  268. <a href="#installing-with-olm" class="md-nav__link">
  269. <span class="md-ellipsis">
  270. Installing with OLM
  271. </span>
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="#uninstalling" class="md-nav__link">
  276. <span class="md-ellipsis">
  277. Uninstalling
  278. </span>
  279. </a>
  280. <nav class="md-nav" aria-label="Uninstalling">
  281. <ul class="md-nav__list">
  282. <li class="md-nav__item">
  283. <a href="#uninstalling-with-helm" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. Uninstalling with Helm
  286. </span>
  287. </a>
  288. </li>
  289. </ul>
  290. </nav>
  291. </li>
  292. </ul>
  293. </nav>
  294. </li>
  295. <li class="md-nav__item">
  296. <a href="../faq/" class="md-nav__link">
  297. <span class="md-ellipsis">
  298. FAQ
  299. </span>
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../stability-support/" class="md-nav__link">
  304. <span class="md-ellipsis">
  305. Stability and Support
  306. </span>
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="../deprecation-policy/" class="md-nav__link">
  311. <span class="md-ellipsis">
  312. Deprecation Policy
  313. </span>
  314. </a>
  315. </li>
  316. </ul>
  317. </nav>
  318. </li>
  319. <li class="md-nav__item md-nav__item--nested">
  320. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  321. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  322. <span class="md-ellipsis">
  323. API
  324. </span>
  325. <span class="md-nav__icon md-icon"></span>
  326. </label>
  327. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  328. <label class="md-nav__title" for="__nav_2">
  329. <span class="md-nav__icon md-icon"></span>
  330. API
  331. </label>
  332. <ul class="md-nav__list" data-md-scrollfix>
  333. <li class="md-nav__item">
  334. <a href="../../api/components/" class="md-nav__link">
  335. <span class="md-ellipsis">
  336. Components
  337. </span>
  338. </a>
  339. </li>
  340. <li class="md-nav__item md-nav__item--nested">
  341. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  342. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  343. <span class="md-ellipsis">
  344. Core Resources
  345. </span>
  346. <span class="md-nav__icon md-icon"></span>
  347. </label>
  348. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  349. <label class="md-nav__title" for="__nav_2_2">
  350. <span class="md-nav__icon md-icon"></span>
  351. Core Resources
  352. </label>
  353. <ul class="md-nav__list" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="../../api/externalsecret/" class="md-nav__link">
  356. <span class="md-ellipsis">
  357. ExternalSecret
  358. </span>
  359. </a>
  360. </li>
  361. <li class="md-nav__item">
  362. <a href="../../api/secretstore/" class="md-nav__link">
  363. <span class="md-ellipsis">
  364. SecretStore
  365. </span>
  366. </a>
  367. </li>
  368. <li class="md-nav__item">
  369. <a href="../../api/clustersecretstore/" class="md-nav__link">
  370. <span class="md-ellipsis">
  371. ClusterSecretStore
  372. </span>
  373. </a>
  374. </li>
  375. <li class="md-nav__item">
  376. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  377. <span class="md-ellipsis">
  378. ClusterExternalSecret
  379. </span>
  380. </a>
  381. </li>
  382. <li class="md-nav__item">
  383. <a href="../../api/pushsecret/" class="md-nav__link">
  384. <span class="md-ellipsis">
  385. PushSecret
  386. </span>
  387. </a>
  388. </li>
  389. </ul>
  390. </nav>
  391. </li>
  392. <li class="md-nav__item md-nav__item--nested">
  393. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  394. <div class="md-nav__link md-nav__container">
  395. <a href="../../api/generator/" class="md-nav__link ">
  396. <span class="md-ellipsis">
  397. Generators
  398. </span>
  399. </a>
  400. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  401. <span class="md-nav__icon md-icon"></span>
  402. </label>
  403. </div>
  404. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  405. <label class="md-nav__title" for="__nav_2_3">
  406. <span class="md-nav__icon md-icon"></span>
  407. Generators
  408. </label>
  409. <ul class="md-nav__list" data-md-scrollfix>
  410. <li class="md-nav__item">
  411. <a href="../../api/generator/acr/" class="md-nav__link">
  412. <span class="md-ellipsis">
  413. Azure Container Registry
  414. </span>
  415. </a>
  416. </li>
  417. <li class="md-nav__item">
  418. <a href="../../api/generator/ecr/" class="md-nav__link">
  419. <span class="md-ellipsis">
  420. AWS Elastic Container Registry
  421. </span>
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../../api/generator/sts/" class="md-nav__link">
  426. <span class="md-ellipsis">
  427. AWS STS Session Token
  428. </span>
  429. </a>
  430. </li>
  431. <li class="md-nav__item">
  432. <a href="../../api/generator/cluster/" class="md-nav__link">
  433. <span class="md-ellipsis">
  434. Cluster Generator
  435. </span>
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../../api/generator/gcr/" class="md-nav__link">
  440. <span class="md-ellipsis">
  441. Google Container Registry
  442. </span>
  443. </a>
  444. </li>
  445. <li class="md-nav__item">
  446. <a href="../../api/generator/vault/" class="md-nav__link">
  447. <span class="md-ellipsis">
  448. Vault Dynamic Secret
  449. </span>
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="../../api/generator/password/" class="md-nav__link">
  454. <span class="md-ellipsis">
  455. Password
  456. </span>
  457. </a>
  458. </li>
  459. <li class="md-nav__item">
  460. <a href="../../api/generator/fake/" class="md-nav__link">
  461. <span class="md-ellipsis">
  462. Fake
  463. </span>
  464. </a>
  465. </li>
  466. <li class="md-nav__item">
  467. <a href="../../api/generator/webhook/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Webhook
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../../api/generator/github/" class="md-nav__link">
  475. <span class="md-ellipsis">
  476. Github
  477. </span>
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../api/generator/uuid/" class="md-nav__link">
  482. <span class="md-ellipsis">
  483. UUID
  484. </span>
  485. </a>
  486. </li>
  487. </ul>
  488. </nav>
  489. </li>
  490. <li class="md-nav__item md-nav__item--nested">
  491. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  492. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  493. <span class="md-ellipsis">
  494. Reference Docs
  495. </span>
  496. <span class="md-nav__icon md-icon"></span>
  497. </label>
  498. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  499. <label class="md-nav__title" for="__nav_2_4">
  500. <span class="md-nav__icon md-icon"></span>
  501. Reference Docs
  502. </label>
  503. <ul class="md-nav__list" data-md-scrollfix>
  504. <li class="md-nav__item">
  505. <a href="../../api/spec/" class="md-nav__link">
  506. <span class="md-ellipsis">
  507. API specification
  508. </span>
  509. </a>
  510. </li>
  511. <li class="md-nav__item">
  512. <a href="../../api/controller-options/" class="md-nav__link">
  513. <span class="md-ellipsis">
  514. Controller Options
  515. </span>
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../../api/metrics/" class="md-nav__link">
  520. <span class="md-ellipsis">
  521. Metrics
  522. </span>
  523. </a>
  524. </li>
  525. </ul>
  526. </nav>
  527. </li>
  528. </ul>
  529. </nav>
  530. </li>
  531. <li class="md-nav__item md-nav__item--nested">
  532. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  533. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  534. <span class="md-ellipsis">
  535. Guides
  536. </span>
  537. <span class="md-nav__icon md-icon"></span>
  538. </label>
  539. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  540. <label class="md-nav__title" for="__nav_3">
  541. <span class="md-nav__icon md-icon"></span>
  542. Guides
  543. </label>
  544. <ul class="md-nav__list" data-md-scrollfix>
  545. <li class="md-nav__item">
  546. <a href="../../guides/introduction/" class="md-nav__link">
  547. <span class="md-ellipsis">
  548. Introduction
  549. </span>
  550. </a>
  551. </li>
  552. <li class="md-nav__item md-nav__item--nested">
  553. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  554. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  555. <span class="md-ellipsis">
  556. External Secrets
  557. </span>
  558. <span class="md-nav__icon md-icon"></span>
  559. </label>
  560. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  561. <label class="md-nav__title" for="__nav_3_2">
  562. <span class="md-nav__icon md-icon"></span>
  563. External Secrets
  564. </label>
  565. <ul class="md-nav__list" data-md-scrollfix>
  566. <li class="md-nav__item">
  567. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  568. <span class="md-ellipsis">
  569. Extract structured data
  570. </span>
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="../../guides/getallsecrets/" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. Find Secrets by Name or Metadata
  577. </span>
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  582. <span class="md-ellipsis">
  583. Rewriting Keys
  584. </span>
  585. </a>
  586. </li>
  587. <li class="md-nav__item md-nav__item--nested">
  588. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  589. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  590. <span class="md-ellipsis">
  591. Advanced Templating
  592. </span>
  593. <span class="md-nav__icon md-icon"></span>
  594. </label>
  595. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  596. <label class="md-nav__title" for="__nav_3_2_4">
  597. <span class="md-nav__icon md-icon"></span>
  598. Advanced Templating
  599. </label>
  600. <ul class="md-nav__list" data-md-scrollfix>
  601. <li class="md-nav__item">
  602. <a href="../../guides/templating/" class="md-nav__link">
  603. <span class="md-ellipsis">
  604. v2
  605. </span>
  606. </a>
  607. </li>
  608. <li class="md-nav__item">
  609. <a href="../../guides/templating-v1/" class="md-nav__link">
  610. <span class="md-ellipsis">
  611. v1
  612. </span>
  613. </a>
  614. </li>
  615. </ul>
  616. </nav>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  620. <span class="md-ellipsis">
  621. Kubernetes Secret Types
  622. </span>
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  627. <span class="md-ellipsis">
  628. Lifecycle: ownership & deletion
  629. </span>
  630. </a>
  631. </li>
  632. <li class="md-nav__item">
  633. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  634. <span class="md-ellipsis">
  635. Decoding Strategies
  636. </span>
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="../../guides/controller-class/" class="md-nav__link">
  641. <span class="md-ellipsis">
  642. Controller Classes
  643. </span>
  644. </a>
  645. </li>
  646. </ul>
  647. </nav>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="../../guides/generator/" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. Generators
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="../../guides/pushsecrets/" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. Push Secrets
  660. </span>
  661. </a>
  662. </li>
  663. <li class="md-nav__item md-nav__item--nested">
  664. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  665. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  666. <span class="md-ellipsis">
  667. Operations
  668. </span>
  669. <span class="md-nav__icon md-icon"></span>
  670. </label>
  671. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  672. <label class="md-nav__title" for="__nav_3_5">
  673. <span class="md-nav__icon md-icon"></span>
  674. Operations
  675. </label>
  676. <ul class="md-nav__list" data-md-scrollfix>
  677. <li class="md-nav__item">
  678. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  679. <span class="md-ellipsis">
  680. Multi Tenancy
  681. </span>
  682. </a>
  683. </li>
  684. <li class="md-nav__item">
  685. <a href="../../guides/security-best-practices/" class="md-nav__link">
  686. <span class="md-ellipsis">
  687. Security Best Practices
  688. </span>
  689. </a>
  690. </li>
  691. <li class="md-nav__item">
  692. <a href="../../guides/threat-model/" class="md-nav__link">
  693. <span class="md-ellipsis">
  694. Threat Model
  695. </span>
  696. </a>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../../guides/v1beta1/" class="md-nav__link">
  700. <span class="md-ellipsis">
  701. Upgrading to v1beta1
  702. </span>
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="../../guides/using-latest-image/" class="md-nav__link">
  707. <span class="md-ellipsis">
  708. Using Latest Image
  709. </span>
  710. </a>
  711. </li>
  712. <li class="md-nav__item">
  713. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  714. <span class="md-ellipsis">
  715. Disable Cluster Features
  716. </span>
  717. </a>
  718. </li>
  719. </ul>
  720. </nav>
  721. </li>
  722. </ul>
  723. </nav>
  724. </li>
  725. <li class="md-nav__item md-nav__item--nested">
  726. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  727. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  728. <span class="md-ellipsis">
  729. Provider
  730. </span>
  731. <span class="md-nav__icon md-icon"></span>
  732. </label>
  733. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  734. <label class="md-nav__title" for="__nav_4">
  735. <span class="md-nav__icon md-icon"></span>
  736. Provider
  737. </label>
  738. <ul class="md-nav__list" data-md-scrollfix>
  739. <li class="md-nav__item">
  740. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. AWS Secrets Manager
  743. </span>
  744. </a>
  745. </li>
  746. <li class="md-nav__item">
  747. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  748. <span class="md-ellipsis">
  749. AWS Parameter Store
  750. </span>
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  755. <span class="md-ellipsis">
  756. Azure Key Vault
  757. </span>
  758. </a>
  759. </li>
  760. <li class="md-nav__item">
  761. <a href="../../provider/beyondtrust/" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. BeyondTrust
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Bitwarden Secrets Manager
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="../../provider/chef/" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. Chef
  778. </span>
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="../../provider/conjur/" class="md-nav__link">
  783. <span class="md-ellipsis">
  784. CyberArk Conjur
  785. </span>
  786. </a>
  787. </li>
  788. <li class="md-nav__item">
  789. <a href="../../provider/device42/" class="md-nav__link">
  790. <span class="md-ellipsis">
  791. Device42
  792. </span>
  793. </a>
  794. </li>
  795. <li class="md-nav__item">
  796. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  797. <span class="md-ellipsis">
  798. Google Cloud Secret Manager
  799. </span>
  800. </a>
  801. </li>
  802. <li class="md-nav__item">
  803. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  804. <span class="md-ellipsis">
  805. HashiCorp Vault
  806. </span>
  807. </a>
  808. </li>
  809. <li class="md-nav__item">
  810. <a href="../../provider/kubernetes/" class="md-nav__link">
  811. <span class="md-ellipsis">
  812. Kubernetes
  813. </span>
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  818. <span class="md-ellipsis">
  819. IBM Secrets Manager
  820. </span>
  821. </a>
  822. </li>
  823. <li class="md-nav__item">
  824. <a href="../../provider/akeyless/" class="md-nav__link">
  825. <span class="md-ellipsis">
  826. Akeyless
  827. </span>
  828. </a>
  829. </li>
  830. <li class="md-nav__item">
  831. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  832. <span class="md-ellipsis">
  833. Yandex Certificate Manager
  834. </span>
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  839. <span class="md-ellipsis">
  840. Yandex Lockbox
  841. </span>
  842. </a>
  843. </li>
  844. <li class="md-nav__item">
  845. <a href="../../provider/alibaba/" class="md-nav__link">
  846. <span class="md-ellipsis">
  847. Alibaba Cloud
  848. </span>
  849. </a>
  850. </li>
  851. <li class="md-nav__item">
  852. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  853. <span class="md-ellipsis">
  854. GitLab Variables
  855. </span>
  856. </a>
  857. </li>
  858. <li class="md-nav__item">
  859. <a href="../../provider/oracle-vault/" class="md-nav__link">
  860. <span class="md-ellipsis">
  861. Oracle Vault
  862. </span>
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="../../provider/1password-automation/" class="md-nav__link">
  867. <span class="md-ellipsis">
  868. 1Password Secrets Automation
  869. </span>
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="../../provider/webhook/" class="md-nav__link">
  874. <span class="md-ellipsis">
  875. Webhook
  876. </span>
  877. </a>
  878. </li>
  879. <li class="md-nav__item">
  880. <a href="../../provider/fake/" class="md-nav__link">
  881. <span class="md-ellipsis">
  882. Fake
  883. </span>
  884. </a>
  885. </li>
  886. <li class="md-nav__item">
  887. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  888. <span class="md-ellipsis">
  889. senhasegura DevOps Secrets Management (DSM)
  890. </span>
  891. </a>
  892. </li>
  893. <li class="md-nav__item">
  894. <a href="../../provider/doppler/" class="md-nav__link">
  895. <span class="md-ellipsis">
  896. Doppler
  897. </span>
  898. </a>
  899. </li>
  900. <li class="md-nav__item">
  901. <a href="../../provider/keeper-security/" class="md-nav__link">
  902. <span class="md-ellipsis">
  903. Keeper Security
  904. </span>
  905. </a>
  906. </li>
  907. <li class="md-nav__item">
  908. <a href="../../provider/cloak/" class="md-nav__link">
  909. <span class="md-ellipsis">
  910. Cloak End 2 End Encrypted Secrets
  911. </span>
  912. </a>
  913. </li>
  914. <li class="md-nav__item">
  915. <a href="../../provider/scaleway/" class="md-nav__link">
  916. <span class="md-ellipsis">
  917. Scaleway
  918. </span>
  919. </a>
  920. </li>
  921. <li class="md-nav__item">
  922. <a href="../../provider/delinea/" class="md-nav__link">
  923. <span class="md-ellipsis">
  924. Delinea
  925. </span>
  926. </a>
  927. </li>
  928. <li class="md-nav__item">
  929. <a href="../../provider/secretserver/" class="md-nav__link">
  930. <span class="md-ellipsis">
  931. Secret Server
  932. </span>
  933. </a>
  934. </li>
  935. <li class="md-nav__item">
  936. <a href="../../provider/passbolt/" class="md-nav__link">
  937. <span class="md-ellipsis">
  938. Passbolt
  939. </span>
  940. </a>
  941. </li>
  942. <li class="md-nav__item">
  943. <a href="../../provider/pulumi/" class="md-nav__link">
  944. <span class="md-ellipsis">
  945. Pulumi ESC
  946. </span>
  947. </a>
  948. </li>
  949. <li class="md-nav__item">
  950. <a href="../../provider/onboardbase/" class="md-nav__link">
  951. <span class="md-ellipsis">
  952. Onboardbase
  953. </span>
  954. </a>
  955. </li>
  956. <li class="md-nav__item">
  957. <a href="../../provider-passworddepot/" class="md-nav__link">
  958. <span class="md-ellipsis">
  959. Password Depot
  960. </span>
  961. </a>
  962. </li>
  963. <li class="md-nav__item">
  964. <a href="../../provider/fortanix/" class="md-nav__link">
  965. <span class="md-ellipsis">
  966. Fortanix
  967. </span>
  968. </a>
  969. </li>
  970. <li class="md-nav__item">
  971. <a href="../../provider/infisical/" class="md-nav__link">
  972. <span class="md-ellipsis">
  973. Infisical
  974. </span>
  975. </a>
  976. </li>
  977. <li class="md-nav__item">
  978. <a href="../../provider/previder/" class="md-nav__link">
  979. <span class="md-ellipsis">
  980. Previder
  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/roadmap/" class="md-nav__link">
  1090. <span class="md-ellipsis">
  1091. Roadmap
  1092. </span>
  1093. </a>
  1094. </li>
  1095. </ul>
  1096. </nav>
  1097. </li>
  1098. <li class="md-nav__item md-nav__item--nested">
  1099. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1100. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1101. <span class="md-ellipsis">
  1102. External Resources
  1103. </span>
  1104. <span class="md-nav__icon md-icon"></span>
  1105. </label>
  1106. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1107. <label class="md-nav__title" for="__nav_6_2">
  1108. <span class="md-nav__icon md-icon"></span>
  1109. External Resources
  1110. </label>
  1111. <ul class="md-nav__list" data-md-scrollfix>
  1112. <li class="md-nav__item">
  1113. <a href="../../eso-talks/" class="md-nav__link">
  1114. <span class="md-ellipsis">
  1115. Talks
  1116. </span>
  1117. </a>
  1118. </li>
  1119. <li class="md-nav__item">
  1120. <a href="../../eso-demos/" class="md-nav__link">
  1121. <span class="md-ellipsis">
  1122. Demos
  1123. </span>
  1124. </a>
  1125. </li>
  1126. <li class="md-nav__item">
  1127. <a href="../../eso-blogs/" class="md-nav__link">
  1128. <span class="md-ellipsis">
  1129. Blogs
  1130. </span>
  1131. </a>
  1132. </li>
  1133. <li class="md-nav__item">
  1134. <a href="../../eso-tools/" class="md-nav__link">
  1135. <span class="md-ellipsis">
  1136. Tools
  1137. </span>
  1138. </a>
  1139. </li>
  1140. </ul>
  1141. </nav>
  1142. </li>
  1143. </ul>
  1144. </nav>
  1145. </li>
  1146. </ul>
  1147. </nav>
  1148. </div>
  1149. </div>
  1150. </div>
  1151. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1152. <div class="md-sidebar__scrollwrap">
  1153. <div class="md-sidebar__inner">
  1154. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1155. <label class="md-nav__title" for="__toc">
  1156. <span class="md-nav__icon md-icon"></span>
  1157. Table of contents
  1158. </label>
  1159. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1160. <li class="md-nav__item">
  1161. <a href="#installing-with-helm" class="md-nav__link">
  1162. <span class="md-ellipsis">
  1163. Installing with Helm
  1164. </span>
  1165. </a>
  1166. <nav class="md-nav" aria-label="Installing with Helm">
  1167. <ul class="md-nav__list">
  1168. <li class="md-nav__item">
  1169. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  1170. <span class="md-ellipsis">
  1171. Option 1: Install from chart repository
  1172. </span>
  1173. </a>
  1174. </li>
  1175. <li class="md-nav__item">
  1176. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  1177. <span class="md-ellipsis">
  1178. Option 2: Install chart from local build
  1179. </span>
  1180. </a>
  1181. </li>
  1182. <li class="md-nav__item">
  1183. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  1184. <span class="md-ellipsis">
  1185. Create a secret containing your AWS credentials
  1186. </span>
  1187. </a>
  1188. </li>
  1189. <li class="md-nav__item">
  1190. <a href="#create-your-first-secretstore" class="md-nav__link">
  1191. <span class="md-ellipsis">
  1192. Create your first SecretStore
  1193. </span>
  1194. </a>
  1195. </li>
  1196. <li class="md-nav__item">
  1197. <a href="#create-your-first-externalsecret" class="md-nav__link">
  1198. <span class="md-ellipsis">
  1199. Create your first ExternalSecret
  1200. </span>
  1201. </a>
  1202. </li>
  1203. </ul>
  1204. </nav>
  1205. </li>
  1206. <li class="md-nav__item">
  1207. <a href="#installing-with-olm" class="md-nav__link">
  1208. <span class="md-ellipsis">
  1209. Installing with OLM
  1210. </span>
  1211. </a>
  1212. </li>
  1213. <li class="md-nav__item">
  1214. <a href="#uninstalling" class="md-nav__link">
  1215. <span class="md-ellipsis">
  1216. Uninstalling
  1217. </span>
  1218. </a>
  1219. <nav class="md-nav" aria-label="Uninstalling">
  1220. <ul class="md-nav__list">
  1221. <li class="md-nav__item">
  1222. <a href="#uninstalling-with-helm" class="md-nav__link">
  1223. <span class="md-ellipsis">
  1224. Uninstalling with Helm
  1225. </span>
  1226. </a>
  1227. </li>
  1228. </ul>
  1229. </nav>
  1230. </li>
  1231. </ul>
  1232. </nav>
  1233. </div>
  1234. </div>
  1235. </div>
  1236. <div class="md-content" data-md-component="content">
  1237. <article class="md-content__inner md-typeset">
  1238. <h1 id="getting-started">Getting started</h1>
  1239. <p>External-secrets runs within your Kubernetes cluster as a deployment resource.
  1240. It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources
  1241. and manages Kubernetes secret resources with ExternalSecret resources.</p>
  1242. <blockquote>
  1243. <p>Note: The minimum supported version of Kubernetes is <code>1.16.0</code>. Users still running Kubernetes v1.15 or below should upgrade
  1244. to a supported version before installing external-secrets.</p>
  1245. </blockquote>
  1246. <h2 id="installing-with-helm">Installing with Helm</h2>
  1247. <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>
  1248. <p>You can install those CRDs outside of <code>helm</code> using:
  1249. <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>
  1250. </code></pre></div></p>
  1251. <p>Uncomment the relevant line in the next steps to disable the automatic install of CRDs.</p>
  1252. <h3 id="option-1-install-from-chart-repository">Option 1: Install from chart repository</h3>
  1253. <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
  1254. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1255. <span class="w"> </span>external-secrets/external-secrets<span class="w"> </span><span class="se">\</span>
  1256. <span class="w"> </span>-n<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1257. <span class="w"> </span>--create-namespace<span class="w"> </span><span class="se">\</span>
  1258. <span class="w"> </span><span class="c1"># --set installCRDs=false</span>
  1259. </code></pre></div>
  1260. <h3 id="option-2-install-chart-from-local-build">Option 2: Install chart from local build</h3>
  1261. <p>Build and install the Helm chart locally after cloning the repository.</p>
  1262. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>helm.build
  1263. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1264. <span class="w"> </span>./bin/chart/external-secrets.tgz<span class="w"> </span><span class="se">\</span>
  1265. <span class="w"> </span>-n<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1266. <span class="w"> </span>--create-namespace<span class="w"> </span><span class="se">\</span>
  1267. <span class="w"> </span><span class="c1"># --set installCRDs=false</span>
  1268. </code></pre></div>
  1269. <h3 id="create-a-secret-containing-your-aws-credentials">Create a secret containing your AWS credentials</h3>
  1270. <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
  1271. <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
  1272. 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
  1273. </code></pre></div>
  1274. <h3 id="create-your-first-secretstore">Create your first SecretStore</h3>
  1275. <p>Create a file 'basic-secret-store.yaml' with the following content.</p>
  1276. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1277. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1278. <span class="nt">metadata</span><span class="p">:</span>
  1279. <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>
  1280. <span class="nt">spec</span><span class="p">:</span>
  1281. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1282. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1283. <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>
  1284. <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>
  1285. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1286. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1287. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1288. <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>
  1289. <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>
  1290. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1291. <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>
  1292. <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>
  1293. </code></pre></div>
  1294. <p>Apply it to create a SecretStore resource.</p>
  1295. <div class="highlight"><pre><span></span><code>kubectl apply -f &quot;basic-secret-store.yaml&quot;
  1296. </code></pre></div>
  1297. <h3 id="create-your-first-externalsecret">Create your first ExternalSecret</h3>
  1298. <p>Create a file 'basic-external-secret.yaml' with the following content.</p>
  1299. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1300. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1301. <span class="nt">metadata</span><span class="p">:</span>
  1302. <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>
  1303. <span class="nt">spec</span><span class="p">:</span>
  1304. <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>
  1305. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1306. <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>
  1307. <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>
  1308. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1309. <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>
  1310. <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>
  1311. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1312. <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>
  1313. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1314. <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>
  1315. <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>
  1316. <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>
  1317. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1318. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1319. <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>
  1320. </code></pre></div>
  1321. <p>Apply it to create an External Secret resource.</p>
  1322. <div class="highlight"><pre><span></span><code>kubectl apply -f &quot;basic-external-secret.yaml&quot;
  1323. </code></pre></div>
  1324. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>describe<span class="w"> </span>externalsecret<span class="w"> </span>example
  1325. <span class="c1"># [...]</span>
  1326. Name:<span class="w"> </span>example
  1327. Status:
  1328. <span class="w"> </span>Binding:
  1329. <span class="w"> </span>Name:<span class="w"> </span>secret-to-be-created
  1330. <span class="w"> </span>Conditions:
  1331. <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
  1332. <span class="w"> </span>Message:<span class="w"> </span>Secret<span class="w"> </span>was<span class="w"> </span>synced
  1333. <span class="w"> </span>Reason:<span class="w"> </span>SecretSynced
  1334. <span class="w"> </span>Status:<span class="w"> </span>True
  1335. <span class="w"> </span>Type:<span class="w"> </span>Ready
  1336. <span class="w"> </span>Refresh<span class="w"> </span>Time:<span class="w"> </span><span class="m">2021</span>-02-24T16:45:24Z
  1337. Events:<span class="w"> </span>&lt;none&gt;
  1338. </code></pre></div>
  1339. <p>For more advanced examples, please read the other
  1340. <a href="../../guides/introduction/">guides</a>.</p>
  1341. <h2 id="installing-with-olm">Installing with OLM</h2>
  1342. <p>External-secrets can be managed by <a href="https://olm.operatorframework.io/">Operator Lifecycle Manager</a> (OLM) via an installer operator. It is made available through <a href="https://operatorhub.io/">OperatorHub.io</a>, this installation method is suited best for OpenShift. See installation instructions on the <a href="https://operatorhub.io/operator/external-secrets-operator">external-secrets-operator</a> package.</p>
  1343. <h2 id="uninstalling">Uninstalling</h2>
  1344. <p>Before continuing, ensure that all external-secret resources that have been created by users have been deleted.
  1345. You can check for any existing resources with the following command:</p>
  1346. <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
  1347. </code></pre></div>
  1348. <p>Once all these resources have been deleted you are ready to uninstall external-secrets.</p>
  1349. <h3 id="uninstalling-with-helm">Uninstalling with Helm</h3>
  1350. <p>Uninstall the helm release using the delete command.</p>
  1351. <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
  1352. </code></pre></div>
  1353. </article>
  1354. </div>
  1355. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1356. </div>
  1357. </main>
  1358. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1359. <footer class="md-footer">
  1360. <div class="md-footer-meta md-typeset">
  1361. <div class="md-footer-meta__inner md-grid">
  1362. <div class="md-copyright">
  1363. <div class="md-copyright__highlight">
  1364. &copy; 2024 The external-secrets Authors.<br/>
  1365. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1366. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1367. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1368. </div>
  1369. Made with
  1370. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1371. Material for MkDocs
  1372. </a>
  1373. </div>
  1374. </div>
  1375. </div>
  1376. </footer>
  1377. </div>
  1378. <div class="md-dialog" data-md-component="dialog">
  1379. <div class="md-dialog__inner md-typeset"></div>
  1380. </div>
  1381. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1382. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1383. </body>
  1384. </html>