index.html 80 KB

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