index.html 76 KB

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