index.html 73 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075
  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="../../examples/bitwarden/">
  7. <link rel="next" href="../process/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.15">
  10. <title>Developer guide - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.7e359304.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. Developer guide
  59. </span>
  60. </div>
  61. </div>
  62. </div>
  63. <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  64. <label class="md-header__button md-icon" for="__search">
  65. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  74. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  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 md-tabs__item--active">
  136. <a href="./" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. <li class="md-tabs__item">
  146. <a href="../../contributing-devguide.md" class="md-tabs__link">
  147. Contributing
  148. </a>
  149. </li>
  150. <li class="md-tabs__item">
  151. <a href="../../deprecation-policy.md" class="md-tabs__link">
  152. Deprecation Policy
  153. </a>
  154. </li>
  155. </ul>
  156. </div>
  157. </nav>
  158. <main class="md-main" data-md-component="main">
  159. <div class="md-main__inner md-grid">
  160. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  161. <div class="md-sidebar__scrollwrap">
  162. <div class="md-sidebar__inner">
  163. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  164. <label class="md-nav__title" for="__drawer">
  165. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  166. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  167. </a>
  168. External Secrets Operator
  169. </label>
  170. <div class="md-nav__source">
  171. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  172. <div class="md-source__icon md-icon">
  173. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  174. </div>
  175. <div class="md-source__repository">
  176. External Secrets Operator
  177. </div>
  178. </a>
  179. </div>
  180. <ul class="md-nav__list" data-md-scrollfix>
  181. <li class="md-nav__item md-nav__item--nested">
  182. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  183. <div class="md-nav__link md-nav__container">
  184. <a href="../.." class="md-nav__link ">
  185. <span class="md-ellipsis">
  186. Introduction
  187. </span>
  188. </a>
  189. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  190. <span class="md-nav__icon md-icon"></span>
  191. </label>
  192. </div>
  193. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  194. <label class="md-nav__title" for="__nav_1">
  195. <span class="md-nav__icon md-icon"></span>
  196. Introduction
  197. </label>
  198. <ul class="md-nav__list" data-md-scrollfix>
  199. <li class="md-nav__item">
  200. <a href="../../introduction/overview/" class="md-nav__link">
  201. <span class="md-ellipsis">
  202. Overview
  203. </span>
  204. </a>
  205. </li>
  206. <li class="md-nav__item">
  207. <a href="../../introduction/getting-started/" class="md-nav__link">
  208. <span class="md-ellipsis">
  209. Getting started
  210. </span>
  211. </a>
  212. </li>
  213. <li class="md-nav__item">
  214. <a href="../../introduction/faq/" class="md-nav__link">
  215. <span class="md-ellipsis">
  216. FAQ
  217. </span>
  218. </a>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../../introduction/stability-support/" class="md-nav__link">
  222. <span class="md-ellipsis">
  223. Stability and Support
  224. </span>
  225. </a>
  226. </li>
  227. <li class="md-nav__item">
  228. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  229. <span class="md-ellipsis">
  230. Deprecation Policy
  231. </span>
  232. </a>
  233. </li>
  234. </ul>
  235. </nav>
  236. </li>
  237. <li class="md-nav__item md-nav__item--nested">
  238. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  239. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  240. <span class="md-ellipsis">
  241. API
  242. </span>
  243. <span class="md-nav__icon md-icon"></span>
  244. </label>
  245. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  246. <label class="md-nav__title" for="__nav_2">
  247. <span class="md-nav__icon md-icon"></span>
  248. API
  249. </label>
  250. <ul class="md-nav__list" data-md-scrollfix>
  251. <li class="md-nav__item">
  252. <a href="../../api/components/" class="md-nav__link">
  253. <span class="md-ellipsis">
  254. Components
  255. </span>
  256. </a>
  257. </li>
  258. <li class="md-nav__item md-nav__item--nested">
  259. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  260. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  261. <span class="md-ellipsis">
  262. Core Resources
  263. </span>
  264. <span class="md-nav__icon md-icon"></span>
  265. </label>
  266. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  267. <label class="md-nav__title" for="__nav_2_2">
  268. <span class="md-nav__icon md-icon"></span>
  269. Core Resources
  270. </label>
  271. <ul class="md-nav__list" data-md-scrollfix>
  272. <li class="md-nav__item">
  273. <a href="../../api/externalsecret/" class="md-nav__link">
  274. <span class="md-ellipsis">
  275. ExternalSecret
  276. </span>
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../../api/secretstore/" class="md-nav__link">
  281. <span class="md-ellipsis">
  282. SecretStore
  283. </span>
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../../api/clustersecretstore/" class="md-nav__link">
  288. <span class="md-ellipsis">
  289. ClusterSecretStore
  290. </span>
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  295. <span class="md-ellipsis">
  296. ClusterExternalSecret
  297. </span>
  298. </a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="../../api/pushsecret/" class="md-nav__link">
  302. <span class="md-ellipsis">
  303. PushSecret
  304. </span>
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  312. <div class="md-nav__link md-nav__container">
  313. <a href="../../api/generator/" class="md-nav__link ">
  314. <span class="md-ellipsis">
  315. Generators
  316. </span>
  317. </a>
  318. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  319. <span class="md-nav__icon md-icon"></span>
  320. </label>
  321. </div>
  322. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  323. <label class="md-nav__title" for="__nav_2_3">
  324. <span class="md-nav__icon md-icon"></span>
  325. Generators
  326. </label>
  327. <ul class="md-nav__list" data-md-scrollfix>
  328. <li class="md-nav__item">
  329. <a href="../../api/generator/acr/" class="md-nav__link">
  330. <span class="md-ellipsis">
  331. Azure Container Registry
  332. </span>
  333. </a>
  334. </li>
  335. <li class="md-nav__item">
  336. <a href="../../api/generator/ecr/" class="md-nav__link">
  337. <span class="md-ellipsis">
  338. AWS Elastic Container Registry
  339. </span>
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="../../api/generator/gcr/" class="md-nav__link">
  344. <span class="md-ellipsis">
  345. Google Container Registry
  346. </span>
  347. </a>
  348. </li>
  349. <li class="md-nav__item">
  350. <a href="../../api/generator/vault/" class="md-nav__link">
  351. <span class="md-ellipsis">
  352. Vault Dynamic Secret
  353. </span>
  354. </a>
  355. </li>
  356. <li class="md-nav__item">
  357. <a href="../../api/generator/password/" class="md-nav__link">
  358. <span class="md-ellipsis">
  359. Password
  360. </span>
  361. </a>
  362. </li>
  363. <li class="md-nav__item">
  364. <a href="../../api/generator/fake/" class="md-nav__link">
  365. <span class="md-ellipsis">
  366. Fake
  367. </span>
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../../api/generator/webhook/" class="md-nav__link">
  372. <span class="md-ellipsis">
  373. Webhook
  374. </span>
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item md-nav__item--nested">
  381. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  382. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  383. <span class="md-ellipsis">
  384. Reference Docs
  385. </span>
  386. <span class="md-nav__icon md-icon"></span>
  387. </label>
  388. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  389. <label class="md-nav__title" for="__nav_2_4">
  390. <span class="md-nav__icon md-icon"></span>
  391. Reference Docs
  392. </label>
  393. <ul class="md-nav__list" data-md-scrollfix>
  394. <li class="md-nav__item">
  395. <a href="../../api/spec/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. API specification
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/controller-options/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Controller Options
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/metrics/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Metrics
  412. </span>
  413. </a>
  414. </li>
  415. </ul>
  416. </nav>
  417. </li>
  418. </ul>
  419. </nav>
  420. </li>
  421. <li class="md-nav__item md-nav__item--nested">
  422. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  423. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  424. <span class="md-ellipsis">
  425. Guides
  426. </span>
  427. <span class="md-nav__icon md-icon"></span>
  428. </label>
  429. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  430. <label class="md-nav__title" for="__nav_3">
  431. <span class="md-nav__icon md-icon"></span>
  432. Guides
  433. </label>
  434. <ul class="md-nav__list" data-md-scrollfix>
  435. <li class="md-nav__item">
  436. <a href="../../guides/introduction/" class="md-nav__link">
  437. <span class="md-ellipsis">
  438. Introduction
  439. </span>
  440. </a>
  441. </li>
  442. <li class="md-nav__item md-nav__item--nested">
  443. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  444. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  445. <span class="md-ellipsis">
  446. External Secrets
  447. </span>
  448. <span class="md-nav__icon md-icon"></span>
  449. </label>
  450. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  451. <label class="md-nav__title" for="__nav_3_2">
  452. <span class="md-nav__icon md-icon"></span>
  453. External Secrets
  454. </label>
  455. <ul class="md-nav__list" data-md-scrollfix>
  456. <li class="md-nav__item">
  457. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  458. <span class="md-ellipsis">
  459. Extract structured data
  460. </span>
  461. </a>
  462. </li>
  463. <li class="md-nav__item">
  464. <a href="../../guides/getallsecrets/" class="md-nav__link">
  465. <span class="md-ellipsis">
  466. Find Secrets by Name or Metadata
  467. </span>
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  472. <span class="md-ellipsis">
  473. Rewriting Keys
  474. </span>
  475. </a>
  476. </li>
  477. <li class="md-nav__item md-nav__item--nested">
  478. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  479. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  480. <span class="md-ellipsis">
  481. Advanced Templating
  482. </span>
  483. <span class="md-nav__icon md-icon"></span>
  484. </label>
  485. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  486. <label class="md-nav__title" for="__nav_3_2_4">
  487. <span class="md-nav__icon md-icon"></span>
  488. Advanced Templating
  489. </label>
  490. <ul class="md-nav__list" data-md-scrollfix>
  491. <li class="md-nav__item">
  492. <a href="../../guides/templating/" class="md-nav__link">
  493. <span class="md-ellipsis">
  494. v2
  495. </span>
  496. </a>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../guides/templating-v1/" class="md-nav__link">
  500. <span class="md-ellipsis">
  501. v1
  502. </span>
  503. </a>
  504. </li>
  505. </ul>
  506. </nav>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. Kubernetes Secret Types
  512. </span>
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. Lifecycle: ownership & deletion
  519. </span>
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Decoding Strategies
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../guides/controller-class/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. Controller Classes
  533. </span>
  534. </a>
  535. </li>
  536. </ul>
  537. </nav>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/generator/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Generators
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../guides/pushsecrets/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Push Secrets
  550. </span>
  551. </a>
  552. </li>
  553. <li class="md-nav__item md-nav__item--nested">
  554. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  555. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  556. <span class="md-ellipsis">
  557. Operations
  558. </span>
  559. <span class="md-nav__icon md-icon"></span>
  560. </label>
  561. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  562. <label class="md-nav__title" for="__nav_3_5">
  563. <span class="md-nav__icon md-icon"></span>
  564. Operations
  565. </label>
  566. <ul class="md-nav__list" data-md-scrollfix>
  567. <li class="md-nav__item">
  568. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  569. <span class="md-ellipsis">
  570. Multi Tenancy
  571. </span>
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="../../guides/security-best-practices/" class="md-nav__link">
  576. <span class="md-ellipsis">
  577. Security Best Practices
  578. </span>
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../guides/threat-model/" class="md-nav__link">
  583. <span class="md-ellipsis">
  584. Threat Model
  585. </span>
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="../../guides/v1beta1/" class="md-nav__link">
  590. <span class="md-ellipsis">
  591. Upgrading to v1beta1
  592. </span>
  593. </a>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="../../guides/using-latest-image/" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. Using Latest Image
  599. </span>
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  604. <span class="md-ellipsis">
  605. Disable Cluster Features
  606. </span>
  607. </a>
  608. </li>
  609. </ul>
  610. </nav>
  611. </li>
  612. </ul>
  613. </nav>
  614. </li>
  615. <li class="md-nav__item md-nav__item--nested">
  616. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  617. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  618. <span class="md-ellipsis">
  619. Provider
  620. </span>
  621. <span class="md-nav__icon md-icon"></span>
  622. </label>
  623. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  624. <label class="md-nav__title" for="__nav_4">
  625. <span class="md-nav__icon md-icon"></span>
  626. Provider
  627. </label>
  628. <ul class="md-nav__list" data-md-scrollfix>
  629. <li class="md-nav__item">
  630. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  631. <span class="md-ellipsis">
  632. AWS Secrets Manager
  633. </span>
  634. </a>
  635. </li>
  636. <li class="md-nav__item">
  637. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  638. <span class="md-ellipsis">
  639. AWS Parameter Store
  640. </span>
  641. </a>
  642. </li>
  643. <li class="md-nav__item">
  644. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  645. <span class="md-ellipsis">
  646. Azure Key Vault
  647. </span>
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="../../provider/chef/" class="md-nav__link">
  652. <span class="md-ellipsis">
  653. Chef
  654. </span>
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="../../provider/conjur/" class="md-nav__link">
  659. <span class="md-ellipsis">
  660. CyberArk Conjur
  661. </span>
  662. </a>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  666. <span class="md-ellipsis">
  667. Google Cloud Secret Manager
  668. </span>
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  673. <span class="md-ellipsis">
  674. HashiCorp Vault
  675. </span>
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../../provider/kubernetes/" class="md-nav__link">
  680. <span class="md-ellipsis">
  681. Kubernetes
  682. </span>
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  687. <span class="md-ellipsis">
  688. IBM Secrets Manager
  689. </span>
  690. </a>
  691. </li>
  692. <li class="md-nav__item">
  693. <a href="../../provider/akeyless/" class="md-nav__link">
  694. <span class="md-ellipsis">
  695. Akeyless
  696. </span>
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  701. <span class="md-ellipsis">
  702. Yandex Certificate Manager
  703. </span>
  704. </a>
  705. </li>
  706. <li class="md-nav__item">
  707. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  708. <span class="md-ellipsis">
  709. Yandex Lockbox
  710. </span>
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../../provider/alibaba/" class="md-nav__link">
  715. <span class="md-ellipsis">
  716. Alibaba Cloud
  717. </span>
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  722. <span class="md-ellipsis">
  723. GitLab Variables
  724. </span>
  725. </a>
  726. </li>
  727. <li class="md-nav__item">
  728. <a href="../../provider/oracle-vault/" class="md-nav__link">
  729. <span class="md-ellipsis">
  730. Oracle Vault
  731. </span>
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="../../provider/1password-automation/" class="md-nav__link">
  736. <span class="md-ellipsis">
  737. 1Password Secrets Automation
  738. </span>
  739. </a>
  740. </li>
  741. <li class="md-nav__item">
  742. <a href="../../provider/webhook/" class="md-nav__link">
  743. <span class="md-ellipsis">
  744. Webhook
  745. </span>
  746. </a>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="../../provider/fake/" class="md-nav__link">
  750. <span class="md-ellipsis">
  751. Fake
  752. </span>
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  757. <span class="md-ellipsis">
  758. senhasegura DevOps Secrets Management (DSM)
  759. </span>
  760. </a>
  761. </li>
  762. <li class="md-nav__item">
  763. <a href="../../provider/doppler/" class="md-nav__link">
  764. <span class="md-ellipsis">
  765. Doppler
  766. </span>
  767. </a>
  768. </li>
  769. <li class="md-nav__item">
  770. <a href="../../provider/keeper-security/" class="md-nav__link">
  771. <span class="md-ellipsis">
  772. Keeper Security
  773. </span>
  774. </a>
  775. </li>
  776. <li class="md-nav__item">
  777. <a href="../../provider/cloak/" class="md-nav__link">
  778. <span class="md-ellipsis">
  779. Cloak End 2 End Encrypted Secrets
  780. </span>
  781. </a>
  782. </li>
  783. <li class="md-nav__item">
  784. <a href="../../provider/scaleway/" class="md-nav__link">
  785. <span class="md-ellipsis">
  786. Scaleway
  787. </span>
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="../../provider/delinea/" class="md-nav__link">
  792. <span class="md-ellipsis">
  793. Delinea
  794. </span>
  795. </a>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="../../provider/pulumi/" class="md-nav__link">
  799. <span class="md-ellipsis">
  800. Pulumi ESC
  801. </span>
  802. </a>
  803. </li>
  804. <li class="md-nav__item">
  805. <a href="../../provider/onboardbase/" class="md-nav__link">
  806. <span class="md-ellipsis">
  807. Onboardbase
  808. </span>
  809. </a>
  810. </li>
  811. </ul>
  812. </nav>
  813. </li>
  814. <li class="md-nav__item md-nav__item--nested">
  815. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  816. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  817. <span class="md-ellipsis">
  818. Examples
  819. </span>
  820. <span class="md-nav__icon md-icon"></span>
  821. </label>
  822. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  823. <label class="md-nav__title" for="__nav_5">
  824. <span class="md-nav__icon md-icon"></span>
  825. Examples
  826. </label>
  827. <ul class="md-nav__list" data-md-scrollfix>
  828. <li class="md-nav__item">
  829. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  830. <span class="md-ellipsis">
  831. FluxCD
  832. </span>
  833. </a>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  837. <span class="md-ellipsis">
  838. Anchore Engine
  839. </span>
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. Jenkins
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="../../examples/bitwarden/" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. BitWarden
  853. </span>
  854. </a>
  855. </li>
  856. </ul>
  857. </nav>
  858. </li>
  859. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  860. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
  861. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  862. <span class="md-ellipsis">
  863. Community
  864. </span>
  865. <span class="md-nav__icon md-icon"></span>
  866. </label>
  867. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
  868. <label class="md-nav__title" for="__nav_6">
  869. <span class="md-nav__icon md-icon"></span>
  870. Community
  871. </label>
  872. <ul class="md-nav__list" data-md-scrollfix>
  873. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  874. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
  875. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  876. <span class="md-ellipsis">
  877. Contributing
  878. </span>
  879. <span class="md-nav__icon md-icon"></span>
  880. </label>
  881. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
  882. <label class="md-nav__title" for="__nav_6_1">
  883. <span class="md-nav__icon md-icon"></span>
  884. Contributing
  885. </label>
  886. <ul class="md-nav__list" data-md-scrollfix>
  887. <li class="md-nav__item md-nav__item--active">
  888. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  889. <label class="md-nav__link md-nav__link--active" for="__toc">
  890. <span class="md-ellipsis">
  891. Developer guide
  892. </span>
  893. <span class="md-nav__icon md-icon"></span>
  894. </label>
  895. <a href="./" class="md-nav__link md-nav__link--active">
  896. <span class="md-ellipsis">
  897. Developer guide
  898. </span>
  899. </a>
  900. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  901. <label class="md-nav__title" for="__toc">
  902. <span class="md-nav__icon md-icon"></span>
  903. Table of contents
  904. </label>
  905. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  906. <li class="md-nav__item">
  907. <a href="#getting-started" class="md-nav__link">
  908. <span class="md-ellipsis">
  909. Getting Started
  910. </span>
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="#building-testing" class="md-nav__link">
  915. <span class="md-ellipsis">
  916. Building &amp; Testing
  917. </span>
  918. </a>
  919. </li>
  920. <li class="md-nav__item">
  921. <a href="#using-tilt" class="md-nav__link">
  922. <span class="md-ellipsis">
  923. Using Tilt
  924. </span>
  925. </a>
  926. </li>
  927. <li class="md-nav__item">
  928. <a href="#installing" class="md-nav__link">
  929. <span class="md-ellipsis">
  930. Installing
  931. </span>
  932. </a>
  933. </li>
  934. <li class="md-nav__item">
  935. <a href="#documentation" class="md-nav__link">
  936. <span class="md-ellipsis">
  937. Documentation
  938. </span>
  939. </a>
  940. </li>
  941. </ul>
  942. </nav>
  943. </li>
  944. <li class="md-nav__item">
  945. <a href="../process/" class="md-nav__link">
  946. <span class="md-ellipsis">
  947. Contributing Process
  948. </span>
  949. </a>
  950. </li>
  951. <li class="md-nav__item">
  952. <a href="../release/" class="md-nav__link">
  953. <span class="md-ellipsis">
  954. Release Process
  955. </span>
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="../coc/" class="md-nav__link">
  960. <span class="md-ellipsis">
  961. Code of Conduct
  962. </span>
  963. </a>
  964. </li>
  965. <li class="md-nav__item">
  966. <a href="../roadmap/" class="md-nav__link">
  967. <span class="md-ellipsis">
  968. Roadmap
  969. </span>
  970. </a>
  971. </li>
  972. </ul>
  973. </nav>
  974. </li>
  975. <li class="md-nav__item md-nav__item--nested">
  976. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  977. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  978. <span class="md-ellipsis">
  979. External Resources
  980. </span>
  981. <span class="md-nav__icon md-icon"></span>
  982. </label>
  983. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  984. <label class="md-nav__title" for="__nav_6_2">
  985. <span class="md-nav__icon md-icon"></span>
  986. External Resources
  987. </label>
  988. <ul class="md-nav__list" data-md-scrollfix>
  989. <li class="md-nav__item">
  990. <a href="../../eso-talks/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Talks
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../../eso-demos/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Demos
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../../eso-blogs/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Blogs
  1007. </span>
  1008. </a>
  1009. </li>
  1010. </ul>
  1011. </nav>
  1012. </li>
  1013. <li class="md-nav__item md-nav__item--nested">
  1014. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_3" >
  1015. <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
  1016. <span class="md-ellipsis">
  1017. AWS
  1018. </span>
  1019. <span class="md-nav__icon md-icon"></span>
  1020. </label>
  1021. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
  1022. <label class="md-nav__title" for="__nav_6_3">
  1023. <span class="md-nav__icon md-icon"></span>
  1024. AWS
  1025. </label>
  1026. <ul class="md-nav__list" data-md-scrollfix>
  1027. <li class="md-nav__item">
  1028. <a href="../../provider-aws-secrets-manager.md" class="md-nav__link">
  1029. <span class="md-ellipsis">
  1030. Secrets Manager
  1031. </span>
  1032. </a>
  1033. </li>
  1034. <li class="md-nav__item">
  1035. <a href="../../provider-aws-parameter-store.md" class="md-nav__link">
  1036. <span class="md-ellipsis">
  1037. Parameter Store
  1038. </span>
  1039. </a>
  1040. </li>
  1041. </ul>
  1042. </nav>
  1043. </li>
  1044. <li class="md-nav__item md-nav__item--nested">
  1045. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_4" >
  1046. <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
  1047. <span class="md-ellipsis">
  1048. Azure
  1049. </span>
  1050. <span class="md-nav__icon md-icon"></span>
  1051. </label>
  1052. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
  1053. <label class="md-nav__title" for="__nav_6_4">
  1054. <span class="md-nav__icon md-icon"></span>
  1055. Azure
  1056. </label>
  1057. <ul class="md-nav__list" data-md-scrollfix>
  1058. <li class="md-nav__item">
  1059. <a href="../../provider-azure-key-vault.md" class="md-nav__link">
  1060. <span class="md-ellipsis">
  1061. Key Vault
  1062. </span>
  1063. </a>
  1064. </li>
  1065. </ul>
  1066. </nav>
  1067. </li>
  1068. <li class="md-nav__item md-nav__item--nested">
  1069. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_5" >
  1070. <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
  1071. <span class="md-ellipsis">
  1072. Google
  1073. </span>
  1074. <span class="md-nav__icon md-icon"></span>
  1075. </label>
  1076. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
  1077. <label class="md-nav__title" for="__nav_6_5">
  1078. <span class="md-nav__icon md-icon"></span>
  1079. Google
  1080. </label>
  1081. <ul class="md-nav__list" data-md-scrollfix>
  1082. <li class="md-nav__item">
  1083. <a href="../../provider-google-secrets-manager.md" class="md-nav__link">
  1084. <span class="md-ellipsis">
  1085. Secrets Manager
  1086. </span>
  1087. </a>
  1088. </li>
  1089. </ul>
  1090. </nav>
  1091. </li>
  1092. <li class="md-nav__item md-nav__item--nested">
  1093. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_6" >
  1094. <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
  1095. <span class="md-ellipsis">
  1096. IBM
  1097. </span>
  1098. <span class="md-nav__icon md-icon"></span>
  1099. </label>
  1100. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
  1101. <label class="md-nav__title" for="__nav_6_6">
  1102. <span class="md-nav__icon md-icon"></span>
  1103. IBM
  1104. </label>
  1105. <ul class="md-nav__list" data-md-scrollfix>
  1106. <li class="md-nav__item">
  1107. <a href="../../provider-ibm-secrets-manager.md" class="md-nav__link">
  1108. <span class="md-ellipsis">
  1109. Secrets Manager
  1110. </span>
  1111. </a>
  1112. </li>
  1113. </ul>
  1114. </nav>
  1115. </li>
  1116. <li class="md-nav__item">
  1117. <a href="../../provider-hashicorp-vault.md" class="md-nav__link">
  1118. <span class="md-ellipsis">
  1119. HashiCorp Vault
  1120. </span>
  1121. </a>
  1122. </li>
  1123. <li class="md-nav__item md-nav__item--nested">
  1124. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_8" >
  1125. <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
  1126. <span class="md-ellipsis">
  1127. Yandex
  1128. </span>
  1129. <span class="md-nav__icon md-icon"></span>
  1130. </label>
  1131. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
  1132. <label class="md-nav__title" for="__nav_6_8">
  1133. <span class="md-nav__icon md-icon"></span>
  1134. Yandex
  1135. </label>
  1136. <ul class="md-nav__list" data-md-scrollfix>
  1137. <li class="md-nav__item">
  1138. <a href="../../provider-yandex-lockbox.md" class="md-nav__link">
  1139. <span class="md-ellipsis">
  1140. Lockbox
  1141. </span>
  1142. </a>
  1143. </li>
  1144. </ul>
  1145. </nav>
  1146. </li>
  1147. <li class="md-nav__item">
  1148. <a href="../../provider-passworddepot/" class="md-nav__link">
  1149. <span class="md-ellipsis">
  1150. Password Depot
  1151. </span>
  1152. </a>
  1153. </li>
  1154. <li class="md-nav__item md-nav__item--nested">
  1155. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_10" >
  1156. <label class="md-nav__link" for="__nav_6_10" id="__nav_6_10_label" tabindex="0">
  1157. <span class="md-ellipsis">
  1158. Gitlab
  1159. </span>
  1160. <span class="md-nav__icon md-icon"></span>
  1161. </label>
  1162. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_10_label" aria-expanded="false">
  1163. <label class="md-nav__title" for="__nav_6_10">
  1164. <span class="md-nav__icon md-icon"></span>
  1165. Gitlab
  1166. </label>
  1167. <ul class="md-nav__list" data-md-scrollfix>
  1168. <li class="md-nav__item">
  1169. <a href="../../provider-gitlab-project-variables.md" class="md-nav__link">
  1170. <span class="md-ellipsis">
  1171. Gitlab Project Variables
  1172. </span>
  1173. </a>
  1174. </li>
  1175. </ul>
  1176. </nav>
  1177. </li>
  1178. <li class="md-nav__item md-nav__item--nested">
  1179. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_11" >
  1180. <label class="md-nav__link" for="__nav_6_11" id="__nav_6_11_label" tabindex="0">
  1181. <span class="md-ellipsis">
  1182. Oracle
  1183. </span>
  1184. <span class="md-nav__icon md-icon"></span>
  1185. </label>
  1186. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_11_label" aria-expanded="false">
  1187. <label class="md-nav__title" for="__nav_6_11">
  1188. <span class="md-nav__icon md-icon"></span>
  1189. Oracle
  1190. </label>
  1191. <ul class="md-nav__list" data-md-scrollfix>
  1192. <li class="md-nav__item">
  1193. <a href="../../provider-oracle-vault.md" class="md-nav__link">
  1194. <span class="md-ellipsis">
  1195. Oracle Vault
  1196. </span>
  1197. </a>
  1198. </li>
  1199. </ul>
  1200. </nav>
  1201. </li>
  1202. </ul>
  1203. </nav>
  1204. </li>
  1205. <li class="md-nav__item md-nav__item--nested">
  1206. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1207. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1208. <span class="md-ellipsis">
  1209. References
  1210. </span>
  1211. <span class="md-nav__icon md-icon"></span>
  1212. </label>
  1213. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1214. <label class="md-nav__title" for="__nav_7">
  1215. <span class="md-nav__icon md-icon"></span>
  1216. References
  1217. </label>
  1218. <ul class="md-nav__list" data-md-scrollfix>
  1219. <li class="md-nav__item">
  1220. <a href="../../spec/" class="md-nav__link">
  1221. <span class="md-ellipsis">
  1222. API specification
  1223. </span>
  1224. </a>
  1225. </li>
  1226. </ul>
  1227. </nav>
  1228. </li>
  1229. <li class="md-nav__item md-nav__item--nested">
  1230. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
  1231. <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
  1232. <span class="md-ellipsis">
  1233. Contributing
  1234. </span>
  1235. <span class="md-nav__icon md-icon"></span>
  1236. </label>
  1237. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  1238. <label class="md-nav__title" for="__nav_8">
  1239. <span class="md-nav__icon md-icon"></span>
  1240. Contributing
  1241. </label>
  1242. <ul class="md-nav__list" data-md-scrollfix>
  1243. <li class="md-nav__item">
  1244. <a href="../../contributing-devguide.md" class="md-nav__link">
  1245. <span class="md-ellipsis">
  1246. Developer guide
  1247. </span>
  1248. </a>
  1249. </li>
  1250. <li class="md-nav__item">
  1251. <a href="../../contributing-process.md" class="md-nav__link">
  1252. <span class="md-ellipsis">
  1253. Contributing Process
  1254. </span>
  1255. </a>
  1256. </li>
  1257. <li class="md-nav__item">
  1258. <a href="../../contributing-coc.md" class="md-nav__link">
  1259. <span class="md-ellipsis">
  1260. Code of Conduct
  1261. </span>
  1262. </a>
  1263. </li>
  1264. </ul>
  1265. </nav>
  1266. </li>
  1267. <li class="md-nav__item">
  1268. <a href="../../deprecation-policy.md" class="md-nav__link">
  1269. <span class="md-ellipsis">
  1270. Deprecation Policy
  1271. </span>
  1272. </a>
  1273. </li>
  1274. </ul>
  1275. </nav>
  1276. </div>
  1277. </div>
  1278. </div>
  1279. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1280. <div class="md-sidebar__scrollwrap">
  1281. <div class="md-sidebar__inner">
  1282. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1283. <label class="md-nav__title" for="__toc">
  1284. <span class="md-nav__icon md-icon"></span>
  1285. Table of contents
  1286. </label>
  1287. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1288. <li class="md-nav__item">
  1289. <a href="#getting-started" class="md-nav__link">
  1290. <span class="md-ellipsis">
  1291. Getting Started
  1292. </span>
  1293. </a>
  1294. </li>
  1295. <li class="md-nav__item">
  1296. <a href="#building-testing" class="md-nav__link">
  1297. <span class="md-ellipsis">
  1298. Building &amp; Testing
  1299. </span>
  1300. </a>
  1301. </li>
  1302. <li class="md-nav__item">
  1303. <a href="#using-tilt" class="md-nav__link">
  1304. <span class="md-ellipsis">
  1305. Using Tilt
  1306. </span>
  1307. </a>
  1308. </li>
  1309. <li class="md-nav__item">
  1310. <a href="#installing" class="md-nav__link">
  1311. <span class="md-ellipsis">
  1312. Installing
  1313. </span>
  1314. </a>
  1315. </li>
  1316. <li class="md-nav__item">
  1317. <a href="#documentation" class="md-nav__link">
  1318. <span class="md-ellipsis">
  1319. Documentation
  1320. </span>
  1321. </a>
  1322. </li>
  1323. </ul>
  1324. </nav>
  1325. </div>
  1326. </div>
  1327. </div>
  1328. <div class="md-content" data-md-component="content">
  1329. <article class="md-content__inner md-typeset">
  1330. <h1>Developer guide</h1>
  1331. <h2 id="getting-started">Getting Started</h2>
  1332. <p>You must have a working <a href="https://golang.org/doc/install">Go environment</a> and
  1333. then clone the repo:</p>
  1334. <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/external-secrets/external-secrets.git
  1335. <span class="nb">cd</span><span class="w"> </span>external-secrets
  1336. </code></pre></div>
  1337. <p><em>Note: many of the <code>make</code> commands use <a href="https://github.com/mikefarah/yq">yq</a>, version 4.2X.X or higher.</em></p>
  1338. <p>Our helm chart is tested using <code>helm-unittest</code>. You will need it to run tests locally if you modify the helm chart. Install it with the following command:</p>
  1339. <div class="highlight"><pre><span></span><code>$ helm plugin install https://github.com/helm-unittest/helm-unittest
  1340. </code></pre></div>
  1341. <h2 id="building-testing">Building &amp; Testing</h2>
  1342. <p>The project uses the <code>make</code> build system. It'll run code generators, tests and
  1343. static code analysis.</p>
  1344. <p>Building the operator binary and docker image:</p>
  1345. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>build
  1346. make<span class="w"> </span>docker.build<span class="w"> </span><span class="nv">IMAGE_NAME</span><span class="o">=</span>external-secrets<span class="w"> </span><span class="nv">IMAGE_TAG</span><span class="o">=</span>latest
  1347. </code></pre></div>
  1348. <p>Run tests and lint the code:
  1349. <div class="highlight"><pre><span></span><code>make<span class="w"> </span><span class="nb">test</span>
  1350. make<span class="w"> </span>lint<span class="w"> </span><span class="c1"># OR</span>
  1351. docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>-v<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>:/app<span class="w"> </span>-w<span class="w"> </span>/app<span class="w"> </span>golangci/golangci-lint:v1.49.0<span class="w"> </span>golangci-lint<span class="w"> </span>run
  1352. </code></pre></div></p>
  1353. <p>Build the documentation:
  1354. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs
  1355. </code></pre></div></p>
  1356. <h2 id="using-tilt">Using Tilt</h2>
  1357. <p><a href="https://tilt.dev">Tilt</a> can be used to develop external-secrets. Tilt will hot-reload changes to the code and replace
  1358. the running binary in the container using a process manager of its own.</p>
  1359. <p>To run tilt, download the utility for your operating system and run <code>make tilt-up</code>. This will do two things:
  1360. - downloads tilt for the current OS and ARCH under <code>bin/tilt</code>
  1361. - make manifest files of your current changes and place them under <code>./bin/deploy/manifests/external-secrets.yaml</code>
  1362. - run tilt with <code>tilt run</code></p>
  1363. <p>Hit <code>space</code> and you can observe all the pods starting up and track their output in the tilt UI.</p>
  1364. <h2 id="installing">Installing</h2>
  1365. <p>To install the External Secret Operator into a Kubernetes Cluster run:</p>
  1366. <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
  1367. helm<span class="w"> </span>repo<span class="w"> </span>update
  1368. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span>external-secrets/external-secrets
  1369. </code></pre></div>
  1370. <p>You can alternatively run the controller on your host system for development purposes:</p>
  1371. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>crds.install
  1372. make<span class="w"> </span>run
  1373. </code></pre></div>
  1374. <p>To remove the CRDs run:</p>
  1375. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>crds.uninstall
  1376. </code></pre></div>
  1377. <p>If you need to test some other k8s integrations and need the operator to be deployed to the actual cluster while developing, you can use the following workflow:</p>
  1378. <div class="highlight"><pre><span></span><code><span class="c1"># Start a local K8S cluster with KinD</span>
  1379. kind<span class="w"> </span>create<span class="w"> </span>cluster<span class="w"> </span>--name<span class="w"> </span>external-secrets
  1380. <span class="nb">export</span><span class="w"> </span><span class="nv">TAG</span><span class="o">=</span><span class="k">$(</span>make<span class="w"> </span>docker.tag<span class="k">)</span>
  1381. <span class="nb">export</span><span class="w"> </span><span class="nv">IMAGE</span><span class="o">=</span><span class="k">$(</span>make<span class="w"> </span>docker.imagename<span class="k">)</span>
  1382. <span class="c1"># Build docker image</span>
  1383. make<span class="w"> </span>docker.build
  1384. <span class="c1"># Load docker image into local kind cluster</span>
  1385. kind<span class="w"> </span>load<span class="w"> </span>docker-image<span class="w"> </span><span class="nv">$IMAGE</span>:<span class="nv">$TAG</span><span class="w"> </span>--name<span class="w"> </span>external-secrets
  1386. <span class="c1"># (Optional) Pull the image from GitHub Repo to copy into kind</span>
  1387. <span class="c1"># docker pull ghcr.io/external-secrets/external-secrets:v0.8.2</span>
  1388. <span class="c1"># kind load docker-image ghcr.io/external-secrets/external-secrets:v0.8.2 -n external-secrets</span>
  1389. <span class="c1"># export TAG=v0.8.2</span>
  1390. <span class="c1"># Update helm charts and install to KinD cluster</span>
  1391. make<span class="w"> </span>helm.generate
  1392. helm<span class="w"> </span>upgrade<span class="w"> </span>--install<span class="w"> </span>external-secrets<span class="w"> </span>./deploy/charts/external-secrets/<span class="w"> </span><span class="se">\</span>
  1393. --set<span class="w"> </span>image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>image.tag<span class="o">=</span><span class="nv">$TAG</span><span class="w"> </span><span class="se">\</span>
  1394. --set<span class="w"> </span>webhook.image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>webhook.image.tag<span class="o">=</span><span class="nv">$TAG</span><span class="w"> </span><span class="se">\</span>
  1395. --set<span class="w"> </span>certController.image.repository<span class="o">=</span><span class="nv">$IMAGE</span><span class="w"> </span>--set<span class="w"> </span>certController.image.tag<span class="o">=</span><span class="nv">$TAG</span>
  1396. <span class="c1"># Command to delete the cluster when done</span>
  1397. <span class="c1"># kind delete cluster -n external-secrets</span>
  1398. </code></pre></div>
  1399. <div class="admonition note">
  1400. <p class="admonition-title">Contributing Flow</p>
  1401. <p>The HOW TO guide for contributing is at the <a href="../process/">Contributing Process</a> page.</p>
  1402. </div>
  1403. <h2 id="documentation">Documentation</h2>
  1404. <p>We use <a href="https://squidfunk.github.io/mkdocs-material/">mkdocs material</a> and <a href="https://github.com/jimporter/mike">mike</a> to generate this
  1405. documentation. See <code>/docs</code> for the source code and <code>/hack/api-docs</code> for the build process.</p>
  1406. <p>When writing documentation it is advised to run the mkdocs server with livereload:</p>
  1407. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs.serve
  1408. </code></pre></div>
  1409. <p>Run the following command to run a complete build. The rendered assets are available under <code>/site</code>.</p>
  1410. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs
  1411. make<span class="w"> </span>docs.serve
  1412. </code></pre></div>
  1413. <p>Open <code>http://localhost:8000</code> in your browser.</p>
  1414. <p>Since mike uses a branch to create/update documentation, any docs operation will create a diff on your local <code>gh-pages</code> branch.</p>
  1415. <p>When finished writing/reviewing the docs, clean up your local docs branch changes with <code>git branch -D gh-pages</code></p>
  1416. </article>
  1417. </div>
  1418. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1419. </div>
  1420. </main>
  1421. <footer class="md-footer">
  1422. <div class="md-footer-meta md-typeset">
  1423. <div class="md-footer-meta__inner md-grid">
  1424. <div class="md-copyright">
  1425. <div class="md-copyright__highlight">
  1426. &copy; 2024 The external-secrets Authors.<br/>
  1427. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1428. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1429. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1430. </div>
  1431. Made with
  1432. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1433. Material for MkDocs
  1434. </a>
  1435. </div>
  1436. </div>
  1437. </div>
  1438. </footer>
  1439. </div>
  1440. <div class="md-dialog" data-md-component="dialog">
  1441. <div class="md-dialog__inner md-typeset"></div>
  1442. </div>
  1443. <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>
  1444. <script src="../../assets/javascripts/bundle.bd41221c.min.js"></script>
  1445. </body>
  1446. </html>