index.html 70 KB

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