index.html 66 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248
  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="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.7">
  10. <title>Getting started - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.f2e4d321.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. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  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. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <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>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
  168. <div class="md-nav__link md-nav__container">
  169. <a href="../.." class="md-nav__link ">
  170. <span class="md-ellipsis">
  171. Introduction
  172. </span>
  173. </a>
  174. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
  175. <span class="md-nav__icon md-icon"></span>
  176. </label>
  177. </div>
  178. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
  179. <label class="md-nav__title" for="__nav_1">
  180. <span class="md-nav__icon md-icon"></span>
  181. Introduction
  182. </label>
  183. <ul class="md-nav__list" data-md-scrollfix>
  184. <li class="md-nav__item">
  185. <a href="../overview/" class="md-nav__link">
  186. <span class="md-ellipsis">
  187. Overview
  188. </span>
  189. </a>
  190. </li>
  191. <li class="md-nav__item md-nav__item--active">
  192. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  193. <label class="md-nav__link md-nav__link--active" for="__toc">
  194. <span class="md-ellipsis">
  195. Getting started
  196. </span>
  197. <span class="md-nav__icon md-icon"></span>
  198. </label>
  199. <a href="./" class="md-nav__link md-nav__link--active">
  200. <span class="md-ellipsis">
  201. Getting started
  202. </span>
  203. </a>
  204. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  205. <label class="md-nav__title" for="__toc">
  206. <span class="md-nav__icon md-icon"></span>
  207. Table of contents
  208. </label>
  209. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  210. <li class="md-nav__item">
  211. <a href="#installing-with-helm" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Installing with Helm
  214. </span>
  215. </a>
  216. <nav class="md-nav" aria-label="Installing with Helm">
  217. <ul class="md-nav__list">
  218. <li class="md-nav__item">
  219. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  220. <span class="md-ellipsis">
  221. Option 1: Install from chart repository
  222. </span>
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  227. <span class="md-ellipsis">
  228. Option 2: Install chart from local build
  229. </span>
  230. </a>
  231. </li>
  232. <li class="md-nav__item">
  233. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  234. <span class="md-ellipsis">
  235. Create a secret containing your AWS credentials
  236. </span>
  237. </a>
  238. </li>
  239. <li class="md-nav__item">
  240. <a href="#create-your-first-secretstore" class="md-nav__link">
  241. <span class="md-ellipsis">
  242. Create your first SecretStore
  243. </span>
  244. </a>
  245. </li>
  246. <li class="md-nav__item">
  247. <a href="#create-your-first-externalsecret" class="md-nav__link">
  248. <span class="md-ellipsis">
  249. Create your first ExternalSecret
  250. </span>
  251. </a>
  252. </li>
  253. </ul>
  254. </nav>
  255. </li>
  256. <li class="md-nav__item">
  257. <a href="#installing-with-olm" class="md-nav__link">
  258. <span class="md-ellipsis">
  259. Installing with OLM
  260. </span>
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="#uninstalling" class="md-nav__link">
  265. <span class="md-ellipsis">
  266. Uninstalling
  267. </span>
  268. </a>
  269. <nav class="md-nav" aria-label="Uninstalling">
  270. <ul class="md-nav__list">
  271. <li class="md-nav__item">
  272. <a href="#uninstalling-with-helm" class="md-nav__link">
  273. <span class="md-ellipsis">
  274. Uninstalling with Helm
  275. </span>
  276. </a>
  277. </li>
  278. </ul>
  279. </nav>
  280. </li>
  281. </ul>
  282. </nav>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../faq/" class="md-nav__link">
  286. <span class="md-ellipsis">
  287. FAQ
  288. </span>
  289. </a>
  290. </li>
  291. <li class="md-nav__item">
  292. <a href="../stability-support/" class="md-nav__link">
  293. <span class="md-ellipsis">
  294. Stability and Support
  295. </span>
  296. </a>
  297. </li>
  298. <li class="md-nav__item">
  299. <a href="../deprecation-policy/" class="md-nav__link">
  300. <span class="md-ellipsis">
  301. Deprecation Policy
  302. </span>
  303. </a>
  304. </li>
  305. </ul>
  306. </nav>
  307. </li>
  308. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  309. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  310. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
  311. <span class="md-ellipsis">
  312. API
  313. </span>
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  317. <label class="md-nav__title" for="__nav_2">
  318. <span class="md-nav__icon md-icon"></span>
  319. API
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../../api/components/" class="md-nav__link">
  324. <span class="md-ellipsis">
  325. Components
  326. </span>
  327. </a>
  328. </li>
  329. <li class="md-nav__item md-nav__item--nested">
  330. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  331. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  332. <span class="md-ellipsis">
  333. Core Resources
  334. </span>
  335. <span class="md-nav__icon md-icon"></span>
  336. </label>
  337. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  338. <label class="md-nav__title" for="__nav_2_2">
  339. <span class="md-nav__icon md-icon"></span>
  340. Core Resources
  341. </label>
  342. <ul class="md-nav__list" data-md-scrollfix>
  343. <li class="md-nav__item">
  344. <a href="../../api/externalsecret/" class="md-nav__link">
  345. <span class="md-ellipsis">
  346. ExternalSecret
  347. </span>
  348. </a>
  349. </li>
  350. <li class="md-nav__item">
  351. <a href="../../api/secretstore/" class="md-nav__link">
  352. <span class="md-ellipsis">
  353. SecretStore
  354. </span>
  355. </a>
  356. </li>
  357. <li class="md-nav__item">
  358. <a href="../../api/clustersecretstore/" class="md-nav__link">
  359. <span class="md-ellipsis">
  360. ClusterSecretStore
  361. </span>
  362. </a>
  363. </li>
  364. <li class="md-nav__item">
  365. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  366. <span class="md-ellipsis">
  367. ClusterExternalSecret
  368. </span>
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="../../api/pushsecret/" class="md-nav__link">
  373. <span class="md-ellipsis">
  374. PushSecret
  375. </span>
  376. </a>
  377. </li>
  378. </ul>
  379. </nav>
  380. </li>
  381. <li class="md-nav__item md-nav__item--nested">
  382. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  383. <div class="md-nav__link md-nav__container">
  384. <a href="../../api/generator/" class="md-nav__link ">
  385. <span class="md-ellipsis">
  386. Generators
  387. </span>
  388. </a>
  389. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  390. <span class="md-nav__icon md-icon"></span>
  391. </label>
  392. </div>
  393. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  394. <label class="md-nav__title" for="__nav_2_3">
  395. <span class="md-nav__icon md-icon"></span>
  396. Generators
  397. </label>
  398. <ul class="md-nav__list" data-md-scrollfix>
  399. <li class="md-nav__item">
  400. <a href="../../api/generator/acr/" class="md-nav__link">
  401. <span class="md-ellipsis">
  402. Azure Container Registry
  403. </span>
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../../api/generator/ecr/" class="md-nav__link">
  408. <span class="md-ellipsis">
  409. AWS Elastic Container Registry
  410. </span>
  411. </a>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="../../api/generator/gcr/" class="md-nav__link">
  415. <span class="md-ellipsis">
  416. Google Container Registry
  417. </span>
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../api/generator/vault/" class="md-nav__link">
  422. <span class="md-ellipsis">
  423. Vault Dynamic Secret
  424. </span>
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="../../api/generator/password/" class="md-nav__link">
  429. <span class="md-ellipsis">
  430. Password
  431. </span>
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="../../api/generator/fake/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. Fake
  438. </span>
  439. </a>
  440. </li>
  441. </ul>
  442. </nav>
  443. </li>
  444. <li class="md-nav__item md-nav__item--nested">
  445. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  446. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  447. <span class="md-ellipsis">
  448. Reference Docs
  449. </span>
  450. <span class="md-nav__icon md-icon"></span>
  451. </label>
  452. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  453. <label class="md-nav__title" for="__nav_2_4">
  454. <span class="md-nav__icon md-icon"></span>
  455. Reference Docs
  456. </label>
  457. <ul class="md-nav__list" data-md-scrollfix>
  458. <li class="md-nav__item">
  459. <a href="../../api/spec/" class="md-nav__link">
  460. <span class="md-ellipsis">
  461. API specification
  462. </span>
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../../api/controller-options/" class="md-nav__link">
  467. <span class="md-ellipsis">
  468. Controller Options
  469. </span>
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="../../api/metrics/" class="md-nav__link">
  474. <span class="md-ellipsis">
  475. Metrics
  476. </span>
  477. </a>
  478. </li>
  479. </ul>
  480. </nav>
  481. </li>
  482. </ul>
  483. </nav>
  484. </li>
  485. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  486. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  487. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  488. <span class="md-ellipsis">
  489. Guides
  490. </span>
  491. <span class="md-nav__icon md-icon"></span>
  492. </label>
  493. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  494. <label class="md-nav__title" for="__nav_3">
  495. <span class="md-nav__icon md-icon"></span>
  496. Guides
  497. </label>
  498. <ul class="md-nav__list" data-md-scrollfix>
  499. <li class="md-nav__item">
  500. <a href="../../guides/introduction/" class="md-nav__link">
  501. <span class="md-ellipsis">
  502. Introduction
  503. </span>
  504. </a>
  505. </li>
  506. <li class="md-nav__item md-nav__item--nested">
  507. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  508. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  509. <span class="md-ellipsis">
  510. External Secrets
  511. </span>
  512. <span class="md-nav__icon md-icon"></span>
  513. </label>
  514. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  515. <label class="md-nav__title" for="__nav_3_2">
  516. <span class="md-nav__icon md-icon"></span>
  517. External Secrets
  518. </label>
  519. <ul class="md-nav__list" data-md-scrollfix>
  520. <li class="md-nav__item">
  521. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  522. <span class="md-ellipsis">
  523. Extract structured data
  524. </span>
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../../guides/getallsecrets/" class="md-nav__link">
  529. <span class="md-ellipsis">
  530. Find Secrets by Name or Metadata
  531. </span>
  532. </a>
  533. </li>
  534. <li class="md-nav__item">
  535. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  536. <span class="md-ellipsis">
  537. Rewriting Keys
  538. </span>
  539. </a>
  540. </li>
  541. <li class="md-nav__item md-nav__item--nested">
  542. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  543. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  544. <span class="md-ellipsis">
  545. Advanced Templating
  546. </span>
  547. <span class="md-nav__icon md-icon"></span>
  548. </label>
  549. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  550. <label class="md-nav__title" for="__nav_3_2_4">
  551. <span class="md-nav__icon md-icon"></span>
  552. Advanced Templating
  553. </label>
  554. <ul class="md-nav__list" data-md-scrollfix>
  555. <li class="md-nav__item">
  556. <a href="../../guides/templating/" class="md-nav__link">
  557. <span class="md-ellipsis">
  558. v2
  559. </span>
  560. </a>
  561. </li>
  562. <li class="md-nav__item">
  563. <a href="../../guides/templating-v1/" class="md-nav__link">
  564. <span class="md-ellipsis">
  565. v1
  566. </span>
  567. </a>
  568. </li>
  569. </ul>
  570. </nav>
  571. </li>
  572. <li class="md-nav__item">
  573. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  574. <span class="md-ellipsis">
  575. Kubernetes Secret Types
  576. </span>
  577. </a>
  578. </li>
  579. <li class="md-nav__item">
  580. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  581. <span class="md-ellipsis">
  582. Lifecycle: ownership & deletion
  583. </span>
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  588. <span class="md-ellipsis">
  589. Decoding Strategies
  590. </span>
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../guides/controller-class/" class="md-nav__link">
  595. <span class="md-ellipsis">
  596. Controller Classes
  597. </span>
  598. </a>
  599. </li>
  600. </ul>
  601. </nav>
  602. </li>
  603. <li class="md-nav__item">
  604. <a href="../../guides/generator/" class="md-nav__link">
  605. <span class="md-ellipsis">
  606. Generators
  607. </span>
  608. </a>
  609. </li>
  610. <li class="md-nav__item">
  611. <a href="../../guides/pushsecrets/" class="md-nav__link">
  612. <span class="md-ellipsis">
  613. Push Secrets
  614. </span>
  615. </a>
  616. </li>
  617. <li class="md-nav__item md-nav__item--nested">
  618. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  619. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  620. <span class="md-ellipsis">
  621. Operations
  622. </span>
  623. <span class="md-nav__icon md-icon"></span>
  624. </label>
  625. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  626. <label class="md-nav__title" for="__nav_3_5">
  627. <span class="md-nav__icon md-icon"></span>
  628. Operations
  629. </label>
  630. <ul class="md-nav__list" data-md-scrollfix>
  631. <li class="md-nav__item">
  632. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  633. <span class="md-ellipsis">
  634. Multi Tenancy
  635. </span>
  636. </a>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="../../guides/security-best-practices/" class="md-nav__link">
  640. <span class="md-ellipsis">
  641. Security Best Practices
  642. </span>
  643. </a>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="../../guides/threat-model/" class="md-nav__link">
  647. <span class="md-ellipsis">
  648. Threat Model
  649. </span>
  650. </a>
  651. </li>
  652. <li class="md-nav__item">
  653. <a href="../../guides/v1beta1/" class="md-nav__link">
  654. <span class="md-ellipsis">
  655. Upgrading to v1beta1
  656. </span>
  657. </a>
  658. </li>
  659. <li class="md-nav__item">
  660. <a href="../../guides/using-latest-image/" class="md-nav__link">
  661. <span class="md-ellipsis">
  662. Using Latest Image
  663. </span>
  664. </a>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  668. <span class="md-ellipsis">
  669. Disable Cluster Features
  670. </span>
  671. </a>
  672. </li>
  673. </ul>
  674. </nav>
  675. </li>
  676. </ul>
  677. </nav>
  678. </li>
  679. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  680. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  681. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  682. <span class="md-ellipsis">
  683. Provider
  684. </span>
  685. <span class="md-nav__icon md-icon"></span>
  686. </label>
  687. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  688. <label class="md-nav__title" for="__nav_4">
  689. <span class="md-nav__icon md-icon"></span>
  690. Provider
  691. </label>
  692. <ul class="md-nav__list" data-md-scrollfix>
  693. <li class="md-nav__item">
  694. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  695. <span class="md-ellipsis">
  696. AWS Secrets Manager
  697. </span>
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  702. <span class="md-ellipsis">
  703. AWS Parameter Store
  704. </span>
  705. </a>
  706. </li>
  707. <li class="md-nav__item">
  708. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  709. <span class="md-ellipsis">
  710. Azure Key Vault
  711. </span>
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="../../provider/conjur/" class="md-nav__link">
  716. <span class="md-ellipsis">
  717. CyberArk Conjur
  718. </span>
  719. </a>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  723. <span class="md-ellipsis">
  724. Google Cloud Secret Manager
  725. </span>
  726. </a>
  727. </li>
  728. <li class="md-nav__item">
  729. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  730. <span class="md-ellipsis">
  731. HashiCorp Vault
  732. </span>
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="../../provider/kubernetes/" class="md-nav__link">
  737. <span class="md-ellipsis">
  738. Kubernetes
  739. </span>
  740. </a>
  741. </li>
  742. <li class="md-nav__item">
  743. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  744. <span class="md-ellipsis">
  745. IBM Secrets Manager
  746. </span>
  747. </a>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="../../provider/akeyless/" class="md-nav__link">
  751. <span class="md-ellipsis">
  752. Akeyless
  753. </span>
  754. </a>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  758. <span class="md-ellipsis">
  759. Yandex Certificate Manager
  760. </span>
  761. </a>
  762. </li>
  763. <li class="md-nav__item">
  764. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  765. <span class="md-ellipsis">
  766. Yandex Lockbox
  767. </span>
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="../../provider/alibaba/" class="md-nav__link">
  772. <span class="md-ellipsis">
  773. Alibaba Cloud
  774. </span>
  775. </a>
  776. </li>
  777. <li class="md-nav__item">
  778. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  779. <span class="md-ellipsis">
  780. GitLab Variables
  781. </span>
  782. </a>
  783. </li>
  784. <li class="md-nav__item">
  785. <a href="../../provider/oracle-vault/" class="md-nav__link">
  786. <span class="md-ellipsis">
  787. Oracle Vault
  788. </span>
  789. </a>
  790. </li>
  791. <li class="md-nav__item">
  792. <a href="../../provider/1password-automation/" class="md-nav__link">
  793. <span class="md-ellipsis">
  794. 1Password Secrets Automation
  795. </span>
  796. </a>
  797. </li>
  798. <li class="md-nav__item">
  799. <a href="../../provider/webhook/" class="md-nav__link">
  800. <span class="md-ellipsis">
  801. Webhook
  802. </span>
  803. </a>
  804. </li>
  805. <li class="md-nav__item">
  806. <a href="../../provider/fake/" class="md-nav__link">
  807. <span class="md-ellipsis">
  808. Fake
  809. </span>
  810. </a>
  811. </li>
  812. <li class="md-nav__item">
  813. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  814. <span class="md-ellipsis">
  815. senhasegura DevOps Secrets Management (DSM)
  816. </span>
  817. </a>
  818. </li>
  819. <li class="md-nav__item">
  820. <a href="../../provider/doppler/" class="md-nav__link">
  821. <span class="md-ellipsis">
  822. Doppler
  823. </span>
  824. </a>
  825. </li>
  826. <li class="md-nav__item">
  827. <a href="../../provider/keeper-security/" class="md-nav__link">
  828. <span class="md-ellipsis">
  829. Keeper Security
  830. </span>
  831. </a>
  832. </li>
  833. <li class="md-nav__item">
  834. <a href="../../provider/cloak/" class="md-nav__link">
  835. <span class="md-ellipsis">
  836. Cloak End 2 End Encrypted Secrets
  837. </span>
  838. </a>
  839. </li>
  840. <li class="md-nav__item">
  841. <a href="../../provider/scaleway/" class="md-nav__link">
  842. <span class="md-ellipsis">
  843. Scaleway
  844. </span>
  845. </a>
  846. </li>
  847. <li class="md-nav__item">
  848. <a href="../../provider/delinea/" class="md-nav__link">
  849. <span class="md-ellipsis">
  850. Delinea
  851. </span>
  852. </a>
  853. </li>
  854. </ul>
  855. </nav>
  856. </li>
  857. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  858. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  859. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
  860. <span class="md-ellipsis">
  861. Examples
  862. </span>
  863. <span class="md-nav__icon md-icon"></span>
  864. </label>
  865. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  866. <label class="md-nav__title" for="__nav_5">
  867. <span class="md-nav__icon md-icon"></span>
  868. Examples
  869. </label>
  870. <ul class="md-nav__list" data-md-scrollfix>
  871. <li class="md-nav__item">
  872. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  873. <span class="md-ellipsis">
  874. FluxCD
  875. </span>
  876. </a>
  877. </li>
  878. <li class="md-nav__item">
  879. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  880. <span class="md-ellipsis">
  881. Anchore Engine
  882. </span>
  883. </a>
  884. </li>
  885. <li class="md-nav__item">
  886. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  887. <span class="md-ellipsis">
  888. Jenkins
  889. </span>
  890. </a>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="../../examples/bitwarden/" class="md-nav__link">
  894. <span class="md-ellipsis">
  895. BitWarden
  896. </span>
  897. </a>
  898. </li>
  899. </ul>
  900. </nav>
  901. </li>
  902. <li class="md-nav__item md-nav__item--section md-nav__item--nested">
  903. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  904. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  905. <span class="md-ellipsis">
  906. Community
  907. </span>
  908. <span class="md-nav__icon md-icon"></span>
  909. </label>
  910. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  911. <label class="md-nav__title" for="__nav_6">
  912. <span class="md-nav__icon md-icon"></span>
  913. Community
  914. </label>
  915. <ul class="md-nav__list" data-md-scrollfix>
  916. <li class="md-nav__item md-nav__item--nested">
  917. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  918. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  919. <span class="md-ellipsis">
  920. Contributing
  921. </span>
  922. <span class="md-nav__icon md-icon"></span>
  923. </label>
  924. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  925. <label class="md-nav__title" for="__nav_6_1">
  926. <span class="md-nav__icon md-icon"></span>
  927. Contributing
  928. </label>
  929. <ul class="md-nav__list" data-md-scrollfix>
  930. <li class="md-nav__item">
  931. <a href="../../contributing/devguide/" class="md-nav__link">
  932. <span class="md-ellipsis">
  933. Developer guide
  934. </span>
  935. </a>
  936. </li>
  937. <li class="md-nav__item">
  938. <a href="../../contributing/process/" class="md-nav__link">
  939. <span class="md-ellipsis">
  940. Contributing Process
  941. </span>
  942. </a>
  943. </li>
  944. <li class="md-nav__item">
  945. <a href="../../contributing/release/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. Release Process
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../../contributing/coc/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Code of Conduct
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../../contributing/roadmap/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. Roadmap
  962. </span>
  963. </a>
  964. </li>
  965. </ul>
  966. </nav>
  967. </li>
  968. <li class="md-nav__item md-nav__item--nested">
  969. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  970. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  971. <span class="md-ellipsis">
  972. External Resources
  973. </span>
  974. <span class="md-nav__icon md-icon"></span>
  975. </label>
  976. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  977. <label class="md-nav__title" for="__nav_6_2">
  978. <span class="md-nav__icon md-icon"></span>
  979. External Resources
  980. </label>
  981. <ul class="md-nav__list" data-md-scrollfix>
  982. <li class="md-nav__item">
  983. <a href="../../eso-talks/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. Talks
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../../eso-demos/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Demos
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../../eso-blogs/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Blogs
  1000. </span>
  1001. </a>
  1002. </li>
  1003. </ul>
  1004. </nav>
  1005. </li>
  1006. </ul>
  1007. </nav>
  1008. </li>
  1009. </ul>
  1010. </nav>
  1011. </div>
  1012. </div>
  1013. </div>
  1014. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1015. <div class="md-sidebar__scrollwrap">
  1016. <div class="md-sidebar__inner">
  1017. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1018. <label class="md-nav__title" for="__toc">
  1019. <span class="md-nav__icon md-icon"></span>
  1020. Table of contents
  1021. </label>
  1022. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1023. <li class="md-nav__item">
  1024. <a href="#installing-with-helm" class="md-nav__link">
  1025. <span class="md-ellipsis">
  1026. Installing with Helm
  1027. </span>
  1028. </a>
  1029. <nav class="md-nav" aria-label="Installing with Helm">
  1030. <ul class="md-nav__list">
  1031. <li class="md-nav__item">
  1032. <a href="#option-1-install-from-chart-repository" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Option 1: Install from chart repository
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Option 2: Install chart from local build
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="#create-a-secret-containing-your-aws-credentials" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Create a secret containing your AWS credentials
  1049. </span>
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="#create-your-first-secretstore" class="md-nav__link">
  1054. <span class="md-ellipsis">
  1055. Create your first SecretStore
  1056. </span>
  1057. </a>
  1058. </li>
  1059. <li class="md-nav__item">
  1060. <a href="#create-your-first-externalsecret" class="md-nav__link">
  1061. <span class="md-ellipsis">
  1062. Create your first ExternalSecret
  1063. </span>
  1064. </a>
  1065. </li>
  1066. </ul>
  1067. </nav>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="#installing-with-olm" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Installing with OLM
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="#uninstalling" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. Uninstalling
  1080. </span>
  1081. </a>
  1082. <nav class="md-nav" aria-label="Uninstalling">
  1083. <ul class="md-nav__list">
  1084. <li class="md-nav__item">
  1085. <a href="#uninstalling-with-helm" class="md-nav__link">
  1086. <span class="md-ellipsis">
  1087. Uninstalling with Helm
  1088. </span>
  1089. </a>
  1090. </li>
  1091. </ul>
  1092. </nav>
  1093. </li>
  1094. </ul>
  1095. </nav>
  1096. </div>
  1097. </div>
  1098. </div>
  1099. <div class="md-content" data-md-component="content">
  1100. <article class="md-content__inner md-typeset">
  1101. <h1 id="getting-started">Getting started</h1>
  1102. <p>External-secrets runs within your Kubernetes cluster as a deployment resource.
  1103. It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources
  1104. and manages Kubernetes secret resources with ExternalSecret resources.</p>
  1105. <blockquote>
  1106. <p>Note: The minimum supported version of Kubernetes is <code>1.16.0</code>. Users still running Kubernetes v1.15 or below should upgrade
  1107. to a supported version before installing external-secrets.</p>
  1108. </blockquote>
  1109. <h2 id="installing-with-helm">Installing with Helm</h2>
  1110. <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>
  1111. <p>You can install those CRDs outside of <code>helm</code> using:
  1112. <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>
  1113. </code></pre></div></p>
  1114. <p>Uncomment the relevant line in the next steps to disable the automatic install of CRDs.</p>
  1115. <h3 id="option-1-install-from-chart-repository">Option 1: Install from chart repository</h3>
  1116. <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
  1117. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1118. <span class="w"> </span>external-secrets/external-secrets<span class="w"> </span><span class="se">\</span>
  1119. <span class="w"> </span>-n<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1120. <span class="w"> </span>--create-namespace<span class="w"> </span><span class="se">\</span>
  1121. <span class="w"> </span><span class="c1"># --set installCRDs=false</span>
  1122. </code></pre></div>
  1123. <h3 id="option-2-install-chart-from-local-build">Option 2: Install chart from local build</h3>
  1124. <p>Build and install the Helm chart locally after cloning the repository.</p>
  1125. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>helm.build
  1126. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1127. <span class="w"> </span>./bin/chart/external-secrets.tgz<span class="w"> </span><span class="se">\</span>
  1128. <span class="w"> </span>-n<span class="w"> </span>external-secrets<span class="w"> </span><span class="se">\</span>
  1129. <span class="w"> </span>--create-namespace<span class="w"> </span><span class="se">\</span>
  1130. <span class="w"> </span><span class="c1"># --set installCRDs=false</span>
  1131. </code></pre></div>
  1132. <h3 id="create-a-secret-containing-your-aws-credentials">Create a secret containing your AWS credentials</h3>
  1133. <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
  1134. <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
  1135. 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
  1136. </code></pre></div>
  1137. <h3 id="create-your-first-secretstore">Create your first SecretStore</h3>
  1138. <p>Create a file 'basic-secret-store.yaml' with the following content.</p>
  1139. <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>
  1140. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1141. <span class="nt">metadata</span><span class="p">:</span>
  1142. <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>
  1143. <span class="nt">spec</span><span class="p">:</span>
  1144. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1145. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1146. <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>
  1147. <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>
  1148. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1149. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1150. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1151. <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>
  1152. <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>
  1153. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1154. <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>
  1155. <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>
  1156. </code></pre></div>
  1157. <p>Apply it to create a SecretStore resource.</p>
  1158. <div class="highlight"><pre><span></span><code>kubectl apply -f &quot;basic-secret-store.yaml&quot;
  1159. </code></pre></div>
  1160. <h3 id="create-your-first-externalsecret">Create your first ExternalSecret</h3>
  1161. <p>Create a file 'basic-external-secret.yaml' with the following content.</p>
  1162. <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>
  1163. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1164. <span class="nt">metadata</span><span class="p">:</span>
  1165. <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>
  1166. <span class="nt">spec</span><span class="p">:</span>
  1167. <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>
  1168. <span class="w"> </span><span class="nt">secretStoreRef</span><span class="p">:</span>
  1169. <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>
  1170. <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>
  1171. <span class="w"> </span><span class="nt">target</span><span class="p">:</span>
  1172. <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>
  1173. <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>
  1174. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1175. <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>
  1176. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1177. <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>
  1178. <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>
  1179. <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>
  1180. <span class="w"> </span><span class="nt">dataFrom</span><span class="p">:</span>
  1181. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">extract</span><span class="p">:</span>
  1182. <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>
  1183. </code></pre></div>
  1184. <p>Apply it to create an External Secret resource.</p>
  1185. <div class="highlight"><pre><span></span><code>kubectl apply -f &quot;basic-external-secret.yaml&quot;
  1186. </code></pre></div>
  1187. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>describe<span class="w"> </span>externalsecret<span class="w"> </span>example
  1188. <span class="c1"># [...]</span>
  1189. Name:<span class="w"> </span>example
  1190. Status:
  1191. <span class="w"> </span>Binding:
  1192. <span class="w"> </span>Name:<span class="w"> </span>secret-to-be-created
  1193. <span class="w"> </span>Conditions:
  1194. <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
  1195. <span class="w"> </span>Message:<span class="w"> </span>Secret<span class="w"> </span>was<span class="w"> </span>synced
  1196. <span class="w"> </span>Reason:<span class="w"> </span>SecretSynced
  1197. <span class="w"> </span>Status:<span class="w"> </span>True
  1198. <span class="w"> </span>Type:<span class="w"> </span>Ready
  1199. <span class="w"> </span>Refresh<span class="w"> </span>Time:<span class="w"> </span><span class="m">2021</span>-02-24T16:45:24Z
  1200. Events:<span class="w"> </span>&lt;none&gt;
  1201. </code></pre></div>
  1202. <p>For more advanced examples, please read the other
  1203. <a href="../../guides/introduction/">guides</a>.</p>
  1204. <h2 id="installing-with-olm">Installing with OLM</h2>
  1205. <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>
  1206. <h2 id="uninstalling">Uninstalling</h2>
  1207. <p>Before continuing, ensure that all external-secret resources that have been created by users have been deleted.
  1208. You can check for any existing resources with the following command:</p>
  1209. <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
  1210. </code></pre></div>
  1211. <p>Once all these resources have been deleted you are ready to uninstall external-secrets.</p>
  1212. <h3 id="uninstalling-with-helm">Uninstalling with Helm</h3>
  1213. <p>Uninstall the helm release using the delete command.</p>
  1214. <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
  1215. </code></pre></div>
  1216. </article>
  1217. </div>
  1218. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1219. </div>
  1220. </main>
  1221. <footer class="md-footer">
  1222. <div class="md-footer-meta md-typeset">
  1223. <div class="md-footer-meta__inner md-grid">
  1224. <div class="md-copyright">
  1225. <div class="md-copyright__highlight">
  1226. &copy; 2023 The external-secrets Authors.<br/>
  1227. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1228. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1229. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1230. </div>
  1231. Made with
  1232. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1233. Material for MkDocs
  1234. </a>
  1235. </div>
  1236. </div>
  1237. </div>
  1238. </footer>
  1239. </div>
  1240. <div class="md-dialog" data-md-component="dialog">
  1241. <div class="md-dialog__inner md-typeset"></div>
  1242. </div>
  1243. <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>
  1244. <script src="../../assets/javascripts/bundle.caa56a14.min.js"></script>
  1245. </body>
  1246. </html>