index.html 70 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123
  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.6.1, mkdocs-material-9.6.13">
  10. <title>Developer guide - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.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. Developer guide
  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">
  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 md-tabs__item--active">
  147. <a href="./" 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--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  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="0">
  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="false">
  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="../../introduction/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="../../introduction/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="../../introduction/prerequisites/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. Prerequisites
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/getting-started/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Getting started
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/faq/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. FAQ
  227. </span>
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../../introduction/stability-support/" class="md-nav__link">
  232. <span class="md-ellipsis">
  233. Stability and Support
  234. </span>
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  239. <span class="md-ellipsis">
  240. Deprecation Policy
  241. </span>
  242. </a>
  243. </li>
  244. </ul>
  245. </nav>
  246. </li>
  247. <li class="md-nav__item md-nav__item--nested">
  248. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  249. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  250. <span class="md-ellipsis">
  251. API
  252. </span>
  253. <span class="md-nav__icon md-icon"></span>
  254. </label>
  255. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  256. <label class="md-nav__title" for="__nav_2">
  257. <span class="md-nav__icon md-icon"></span>
  258. API
  259. </label>
  260. <ul class="md-nav__list" data-md-scrollfix>
  261. <li class="md-nav__item">
  262. <a href="../../api/components/" class="md-nav__link">
  263. <span class="md-ellipsis">
  264. Components
  265. </span>
  266. </a>
  267. </li>
  268. <li class="md-nav__item md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  270. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  271. <span class="md-ellipsis">
  272. Core Resources
  273. </span>
  274. <span class="md-nav__icon md-icon"></span>
  275. </label>
  276. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  277. <label class="md-nav__title" for="__nav_2_2">
  278. <span class="md-nav__icon md-icon"></span>
  279. Core Resources
  280. </label>
  281. <ul class="md-nav__list" data-md-scrollfix>
  282. <li class="md-nav__item">
  283. <a href="../../api/externalsecret/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ExternalSecret
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/secretstore/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. SecretStore
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/clustersecretstore/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. ClusterSecretStore
  300. </span>
  301. </a>
  302. </li>
  303. <li class="md-nav__item">
  304. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  305. <span class="md-ellipsis">
  306. ClusterExternalSecret
  307. </span>
  308. </a>
  309. </li>
  310. <li class="md-nav__item">
  311. <a href="../../api/clusterpushsecret/" class="md-nav__link">
  312. <span class="md-ellipsis">
  313. ClusterPushSecret
  314. </span>
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../../api/pushsecret/" class="md-nav__link">
  319. <span class="md-ellipsis">
  320. PushSecret
  321. </span>
  322. </a>
  323. </li>
  324. </ul>
  325. </nav>
  326. </li>
  327. <li class="md-nav__item md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  329. <div class="md-nav__link md-nav__container">
  330. <a href="../../api/generator/" class="md-nav__link ">
  331. <span class="md-ellipsis">
  332. Generators
  333. </span>
  334. </a>
  335. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  336. <span class="md-nav__icon md-icon"></span>
  337. </label>
  338. </div>
  339. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  340. <label class="md-nav__title" for="__nav_2_3">
  341. <span class="md-nav__icon md-icon"></span>
  342. Generators
  343. </label>
  344. <ul class="md-nav__list" data-md-scrollfix>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/acr/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Azure Container Registry
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/ecr/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. AWS Elastic Container Registry
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/sts/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. AWS STS Session Token
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/cluster/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Cluster Generator
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/gcr/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Google Container Registry
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/quay/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Quay
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../api/generator/vault/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. Vault Dynamic Secret
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../api/generator/password/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. Password
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../api/generator/fake/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. Fake
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../api/generator/webhook/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. Webhook
  412. </span>
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../api/generator/github/" class="md-nav__link">
  417. <span class="md-ellipsis">
  418. Github
  419. </span>
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../../api/generator/uuid/" class="md-nav__link">
  424. <span class="md-ellipsis">
  425. UUID
  426. </span>
  427. </a>
  428. </li>
  429. </ul>
  430. </nav>
  431. </li>
  432. <li class="md-nav__item md-nav__item--nested">
  433. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  434. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  435. <span class="md-ellipsis">
  436. Reference Docs
  437. </span>
  438. <span class="md-nav__icon md-icon"></span>
  439. </label>
  440. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  441. <label class="md-nav__title" for="__nav_2_4">
  442. <span class="md-nav__icon md-icon"></span>
  443. Reference Docs
  444. </label>
  445. <ul class="md-nav__list" data-md-scrollfix>
  446. <li class="md-nav__item">
  447. <a href="../../api/spec/" class="md-nav__link">
  448. <span class="md-ellipsis">
  449. API specification
  450. </span>
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../api/controller-options/" class="md-nav__link">
  455. <span class="md-ellipsis">
  456. Controller Options
  457. </span>
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../../api/metrics/" class="md-nav__link">
  462. <span class="md-ellipsis">
  463. Metrics
  464. </span>
  465. </a>
  466. </li>
  467. </ul>
  468. </nav>
  469. </li>
  470. </ul>
  471. </nav>
  472. </li>
  473. <li class="md-nav__item md-nav__item--nested">
  474. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  475. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  476. <span class="md-ellipsis">
  477. Guides
  478. </span>
  479. <span class="md-nav__icon md-icon"></span>
  480. </label>
  481. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  482. <label class="md-nav__title" for="__nav_3">
  483. <span class="md-nav__icon md-icon"></span>
  484. Guides
  485. </label>
  486. <ul class="md-nav__list" data-md-scrollfix>
  487. <li class="md-nav__item">
  488. <a href="../../guides/introduction/" class="md-nav__link">
  489. <span class="md-ellipsis">
  490. Introduction
  491. </span>
  492. </a>
  493. </li>
  494. <li class="md-nav__item md-nav__item--nested">
  495. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  496. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  497. <span class="md-ellipsis">
  498. External Secrets
  499. </span>
  500. <span class="md-nav__icon md-icon"></span>
  501. </label>
  502. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  503. <label class="md-nav__title" for="__nav_3_2">
  504. <span class="md-nav__icon md-icon"></span>
  505. External Secrets
  506. </label>
  507. <ul class="md-nav__list" data-md-scrollfix>
  508. <li class="md-nav__item">
  509. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. Extract structured data
  512. </span>
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../guides/getallsecrets/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. Find Secrets by Name or Metadata
  519. </span>
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Rewriting Keys
  526. </span>
  527. </a>
  528. </li>
  529. <li class="md-nav__item md-nav__item--nested">
  530. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  531. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  532. <span class="md-ellipsis">
  533. Advanced Templating
  534. </span>
  535. <span class="md-nav__icon md-icon"></span>
  536. </label>
  537. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  538. <label class="md-nav__title" for="__nav_3_2_4">
  539. <span class="md-nav__icon md-icon"></span>
  540. Advanced Templating
  541. </label>
  542. <ul class="md-nav__list" data-md-scrollfix>
  543. <li class="md-nav__item">
  544. <a href="../../guides/templating/" class="md-nav__link">
  545. <span class="md-ellipsis">
  546. v2
  547. </span>
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../guides/templating-v1/" class="md-nav__link">
  552. <span class="md-ellipsis">
  553. v1
  554. </span>
  555. </a>
  556. </li>
  557. </ul>
  558. </nav>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  562. <span class="md-ellipsis">
  563. Kubernetes Secret Types
  564. </span>
  565. </a>
  566. </li>
  567. <li class="md-nav__item">
  568. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  569. <span class="md-ellipsis">
  570. Lifecycle: ownership & deletion
  571. </span>
  572. </a>
  573. </li>
  574. <li class="md-nav__item">
  575. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  576. <span class="md-ellipsis">
  577. Decoding Strategies
  578. </span>
  579. </a>
  580. </li>
  581. <li class="md-nav__item">
  582. <a href="../../guides/controller-class/" class="md-nav__link">
  583. <span class="md-ellipsis">
  584. Controller Classes
  585. </span>
  586. </a>
  587. </li>
  588. </ul>
  589. </nav>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../../guides/generator/" class="md-nav__link">
  593. <span class="md-ellipsis">
  594. Generators
  595. </span>
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../../guides/pushsecrets/" class="md-nav__link">
  600. <span class="md-ellipsis">
  601. Push Secrets
  602. </span>
  603. </a>
  604. </li>
  605. <li class="md-nav__item md-nav__item--nested">
  606. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  607. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  608. <span class="md-ellipsis">
  609. Operations
  610. </span>
  611. <span class="md-nav__icon md-icon"></span>
  612. </label>
  613. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  614. <label class="md-nav__title" for="__nav_3_5">
  615. <span class="md-nav__icon md-icon"></span>
  616. Operations
  617. </label>
  618. <ul class="md-nav__list" data-md-scrollfix>
  619. <li class="md-nav__item">
  620. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Multi Tenancy
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../guides/security-best-practices/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Security Best Practices
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../guides/threat-model/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Threat Model
  637. </span>
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../guides/v1beta1/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. Upgrading to v1beta1
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../guides/using-latest-image/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. Using Latest Image
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. Disable Cluster Features
  658. </span>
  659. </a>
  660. </li>
  661. </ul>
  662. </nav>
  663. </li>
  664. <li class="md-nav__item md-nav__item--nested">
  665. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_6" >
  666. <label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
  667. <span class="md-ellipsis">
  668. Tooling
  669. </span>
  670. <span class="md-nav__icon md-icon"></span>
  671. </label>
  672. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
  673. <label class="md-nav__title" for="__nav_3_6">
  674. <span class="md-nav__icon md-icon"></span>
  675. Tooling
  676. </label>
  677. <ul class="md-nav__list" data-md-scrollfix>
  678. <li class="md-nav__item">
  679. <a href="../../guides/using-esoctl-tool/" class="md-nav__link">
  680. <span class="md-ellipsis">
  681. Using the esoctl tool
  682. </span>
  683. </a>
  684. </li>
  685. </ul>
  686. </nav>
  687. </li>
  688. </ul>
  689. </nav>
  690. </li>
  691. <li class="md-nav__item md-nav__item--nested">
  692. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  693. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  694. <span class="md-ellipsis">
  695. Provider
  696. </span>
  697. <span class="md-nav__icon md-icon"></span>
  698. </label>
  699. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  700. <label class="md-nav__title" for="__nav_4">
  701. <span class="md-nav__icon md-icon"></span>
  702. Provider
  703. </label>
  704. <ul class="md-nav__list" data-md-scrollfix>
  705. <li class="md-nav__item">
  706. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  707. <span class="md-ellipsis">
  708. AWS Secrets Manager
  709. </span>
  710. </a>
  711. </li>
  712. <li class="md-nav__item">
  713. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  714. <span class="md-ellipsis">
  715. AWS Parameter Store
  716. </span>
  717. </a>
  718. </li>
  719. <li class="md-nav__item">
  720. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  721. <span class="md-ellipsis">
  722. Azure Key Vault
  723. </span>
  724. </a>
  725. </li>
  726. <li class="md-nav__item">
  727. <a href="../../provider/beyondtrust/" class="md-nav__link">
  728. <span class="md-ellipsis">
  729. BeyondTrust
  730. </span>
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  735. <span class="md-ellipsis">
  736. Bitwarden Secrets Manager
  737. </span>
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../../provider/chef/" class="md-nav__link">
  742. <span class="md-ellipsis">
  743. Chef
  744. </span>
  745. </a>
  746. </li>
  747. <li class="md-nav__item">
  748. <a href="../../provider/cloudru/" class="md-nav__link">
  749. <span class="md-ellipsis">
  750. Cloud.ru Secret Manager
  751. </span>
  752. </a>
  753. </li>
  754. <li class="md-nav__item">
  755. <a href="../../provider/conjur/" class="md-nav__link">
  756. <span class="md-ellipsis">
  757. CyberArk Conjur
  758. </span>
  759. </a>
  760. </li>
  761. <li class="md-nav__item">
  762. <a href="../../provider/device42/" class="md-nav__link">
  763. <span class="md-ellipsis">
  764. Device42
  765. </span>
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  770. <span class="md-ellipsis">
  771. Google Cloud Secret Manager
  772. </span>
  773. </a>
  774. </li>
  775. <li class="md-nav__item">
  776. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  777. <span class="md-ellipsis">
  778. HashiCorp Vault
  779. </span>
  780. </a>
  781. </li>
  782. <li class="md-nav__item">
  783. <a href="../../provider/kubernetes/" class="md-nav__link">
  784. <span class="md-ellipsis">
  785. Kubernetes
  786. </span>
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  791. <span class="md-ellipsis">
  792. IBM Secrets Manager
  793. </span>
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="../../provider/akeyless/" class="md-nav__link">
  798. <span class="md-ellipsis">
  799. Akeyless
  800. </span>
  801. </a>
  802. </li>
  803. <li class="md-nav__item">
  804. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  805. <span class="md-ellipsis">
  806. Yandex Certificate Manager
  807. </span>
  808. </a>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  812. <span class="md-ellipsis">
  813. Yandex Lockbox
  814. </span>
  815. </a>
  816. </li>
  817. <li class="md-nav__item">
  818. <a href="../../provider/alibaba/" class="md-nav__link">
  819. <span class="md-ellipsis">
  820. Alibaba Cloud
  821. </span>
  822. </a>
  823. </li>
  824. <li class="md-nav__item">
  825. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  826. <span class="md-ellipsis">
  827. GitLab Variables
  828. </span>
  829. </a>
  830. </li>
  831. <li class="md-nav__item">
  832. <a href="../../provider/github/" class="md-nav__link">
  833. <span class="md-ellipsis">
  834. Github Actions Secrets
  835. </span>
  836. </a>
  837. </li>
  838. <li class="md-nav__item">
  839. <a href="../../provider/oracle-vault/" class="md-nav__link">
  840. <span class="md-ellipsis">
  841. Oracle Vault
  842. </span>
  843. </a>
  844. </li>
  845. <li class="md-nav__item">
  846. <a href="../../provider/1password-automation/" class="md-nav__link">
  847. <span class="md-ellipsis">
  848. 1Password Connect Server
  849. </span>
  850. </a>
  851. </li>
  852. <li class="md-nav__item">
  853. <a href="../../provider/1password-sdk/" class="md-nav__link">
  854. <span class="md-ellipsis">
  855. 1Password SDK
  856. </span>
  857. </a>
  858. </li>
  859. <li class="md-nav__item">
  860. <a href="../../provider/webhook/" class="md-nav__link">
  861. <span class="md-ellipsis">
  862. Webhook
  863. </span>
  864. </a>
  865. </li>
  866. <li class="md-nav__item">
  867. <a href="../../provider/fake/" class="md-nav__link">
  868. <span class="md-ellipsis">
  869. Fake
  870. </span>
  871. </a>
  872. </li>
  873. <li class="md-nav__item">
  874. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  875. <span class="md-ellipsis">
  876. senhasegura DevOps Secrets Management (DSM)
  877. </span>
  878. </a>
  879. </li>
  880. <li class="md-nav__item">
  881. <a href="../../provider/doppler/" class="md-nav__link">
  882. <span class="md-ellipsis">
  883. Doppler
  884. </span>
  885. </a>
  886. </li>
  887. <li class="md-nav__item">
  888. <a href="../../provider/keeper-security/" class="md-nav__link">
  889. <span class="md-ellipsis">
  890. Keeper Security
  891. </span>
  892. </a>
  893. </li>
  894. <li class="md-nav__item">
  895. <a href="../../provider/cloak/" class="md-nav__link">
  896. <span class="md-ellipsis">
  897. Cloak End 2 End Encrypted Secrets
  898. </span>
  899. </a>
  900. </li>
  901. <li class="md-nav__item">
  902. <a href="../../provider/scaleway/" class="md-nav__link">
  903. <span class="md-ellipsis">
  904. Scaleway
  905. </span>
  906. </a>
  907. </li>
  908. <li class="md-nav__item">
  909. <a href="../../provider/delinea/" class="md-nav__link">
  910. <span class="md-ellipsis">
  911. Delinea
  912. </span>
  913. </a>
  914. </li>
  915. <li class="md-nav__item">
  916. <a href="../../provider/secretserver/" class="md-nav__link">
  917. <span class="md-ellipsis">
  918. Secret Server
  919. </span>
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="../../provider/passbolt/" class="md-nav__link">
  924. <span class="md-ellipsis">
  925. Passbolt
  926. </span>
  927. </a>
  928. </li>
  929. <li class="md-nav__item">
  930. <a href="../../provider/pulumi/" class="md-nav__link">
  931. <span class="md-ellipsis">
  932. Pulumi ESC
  933. </span>
  934. </a>
  935. </li>
  936. <li class="md-nav__item">
  937. <a href="../../provider/onboardbase/" class="md-nav__link">
  938. <span class="md-ellipsis">
  939. Onboardbase
  940. </span>
  941. </a>
  942. </li>
  943. <li class="md-nav__item">
  944. <a href="../../provider-passworddepot/" class="md-nav__link">
  945. <span class="md-ellipsis">
  946. Password Depot
  947. </span>
  948. </a>
  949. </li>
  950. <li class="md-nav__item">
  951. <a href="../../provider/fortanix/" class="md-nav__link">
  952. <span class="md-ellipsis">
  953. Fortanix
  954. </span>
  955. </a>
  956. </li>
  957. <li class="md-nav__item">
  958. <a href="../../provider/infisical/" class="md-nav__link">
  959. <span class="md-ellipsis">
  960. Infisical
  961. </span>
  962. </a>
  963. </li>
  964. <li class="md-nav__item">
  965. <a href="../../provider/previder/" class="md-nav__link">
  966. <span class="md-ellipsis">
  967. Previder
  968. </span>
  969. </a>
  970. </li>
  971. <li class="md-nav__item">
  972. <a href="../../provider/openbao/" class="md-nav__link">
  973. <span class="md-ellipsis">
  974. OpenBao
  975. </span>
  976. </a>
  977. </li>
  978. </ul>
  979. </nav>
  980. </li>
  981. <li class="md-nav__item md-nav__item--nested">
  982. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  983. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  984. <span class="md-ellipsis">
  985. Examples
  986. </span>
  987. <span class="md-nav__icon md-icon"></span>
  988. </label>
  989. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  990. <label class="md-nav__title" for="__nav_5">
  991. <span class="md-nav__icon md-icon"></span>
  992. Examples
  993. </label>
  994. <ul class="md-nav__list" data-md-scrollfix>
  995. <li class="md-nav__item">
  996. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  997. <span class="md-ellipsis">
  998. FluxCD
  999. </span>
  1000. </a>
  1001. </li>
  1002. <li class="md-nav__item">
  1003. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1004. <span class="md-ellipsis">
  1005. Anchore Engine
  1006. </span>
  1007. </a>
  1008. </li>
  1009. <li class="md-nav__item">
  1010. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1011. <span class="md-ellipsis">
  1012. Jenkins
  1013. </span>
  1014. </a>
  1015. </li>
  1016. <li class="md-nav__item">
  1017. <a href="../../examples/bitwarden/" class="md-nav__link">
  1018. <span class="md-ellipsis">
  1019. Bitwarden
  1020. </span>
  1021. </a>
  1022. </li>
  1023. </ul>
  1024. </nav>
  1025. </li>
  1026. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  1027. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
  1028. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  1029. <span class="md-ellipsis">
  1030. Community
  1031. </span>
  1032. <span class="md-nav__icon md-icon"></span>
  1033. </label>
  1034. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
  1035. <label class="md-nav__title" for="__nav_6">
  1036. <span class="md-nav__icon md-icon"></span>
  1037. Community
  1038. </label>
  1039. <ul class="md-nav__list" data-md-scrollfix>
  1040. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  1041. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
  1042. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1043. <span class="md-ellipsis">
  1044. Contributing
  1045. </span>
  1046. <span class="md-nav__icon md-icon"></span>
  1047. </label>
  1048. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
  1049. <label class="md-nav__title" for="__nav_6_1">
  1050. <span class="md-nav__icon md-icon"></span>
  1051. Contributing
  1052. </label>
  1053. <ul class="md-nav__list" data-md-scrollfix>
  1054. <li class="md-nav__item md-nav__item--active">
  1055. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  1056. <label class="md-nav__link md-nav__link--active" for="__toc">
  1057. <span class="md-ellipsis">
  1058. Developer guide
  1059. </span>
  1060. <span class="md-nav__icon md-icon"></span>
  1061. </label>
  1062. <a href="./" class="md-nav__link md-nav__link--active">
  1063. <span class="md-ellipsis">
  1064. Developer guide
  1065. </span>
  1066. </a>
  1067. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1068. <label class="md-nav__title" for="__toc">
  1069. <span class="md-nav__icon md-icon"></span>
  1070. Table of contents
  1071. </label>
  1072. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1073. <li class="md-nav__item">
  1074. <a href="#getting-started" class="md-nav__link">
  1075. <span class="md-ellipsis">
  1076. Getting Started
  1077. </span>
  1078. </a>
  1079. </li>
  1080. <li class="md-nav__item">
  1081. <a href="#building-testing" class="md-nav__link">
  1082. <span class="md-ellipsis">
  1083. Building &amp; Testing
  1084. </span>
  1085. </a>
  1086. </li>
  1087. <li class="md-nav__item">
  1088. <a href="#using-tilt" class="md-nav__link">
  1089. <span class="md-ellipsis">
  1090. Using Tilt
  1091. </span>
  1092. </a>
  1093. </li>
  1094. <li class="md-nav__item">
  1095. <a href="#installing" class="md-nav__link">
  1096. <span class="md-ellipsis">
  1097. Installing
  1098. </span>
  1099. </a>
  1100. </li>
  1101. <li class="md-nav__item">
  1102. <a href="#documentation" class="md-nav__link">
  1103. <span class="md-ellipsis">
  1104. Documentation
  1105. </span>
  1106. </a>
  1107. </li>
  1108. </ul>
  1109. </nav>
  1110. </li>
  1111. <li class="md-nav__item">
  1112. <a href="../process/" class="md-nav__link">
  1113. <span class="md-ellipsis">
  1114. Contributing Process
  1115. </span>
  1116. </a>
  1117. </li>
  1118. <li class="md-nav__item">
  1119. <a href="../release/" class="md-nav__link">
  1120. <span class="md-ellipsis">
  1121. Release Process
  1122. </span>
  1123. </a>
  1124. </li>
  1125. <li class="md-nav__item">
  1126. <a href="../coc/" class="md-nav__link">
  1127. <span class="md-ellipsis">
  1128. Code of Conduct
  1129. </span>
  1130. </a>
  1131. </li>
  1132. <li class="md-nav__item">
  1133. <a href="../calendar/" class="md-nav__link">
  1134. <span class="md-ellipsis">
  1135. Community meetings calendar
  1136. </span>
  1137. </a>
  1138. </li>
  1139. <li class="md-nav__item">
  1140. <a href="../roadmap/" class="md-nav__link">
  1141. <span class="md-ellipsis">
  1142. Roadmap
  1143. </span>
  1144. </a>
  1145. </li>
  1146. </ul>
  1147. </nav>
  1148. </li>
  1149. <li class="md-nav__item md-nav__item--nested">
  1150. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1151. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1152. <span class="md-ellipsis">
  1153. External Resources
  1154. </span>
  1155. <span class="md-nav__icon md-icon"></span>
  1156. </label>
  1157. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1158. <label class="md-nav__title" for="__nav_6_2">
  1159. <span class="md-nav__icon md-icon"></span>
  1160. External Resources
  1161. </label>
  1162. <ul class="md-nav__list" data-md-scrollfix>
  1163. <li class="md-nav__item">
  1164. <a href="../../eso-talks/" class="md-nav__link">
  1165. <span class="md-ellipsis">
  1166. Talks
  1167. </span>
  1168. </a>
  1169. </li>
  1170. <li class="md-nav__item">
  1171. <a href="../../eso-demos/" class="md-nav__link">
  1172. <span class="md-ellipsis">
  1173. Demos
  1174. </span>
  1175. </a>
  1176. </li>
  1177. <li class="md-nav__item">
  1178. <a href="../../eso-blogs/" class="md-nav__link">
  1179. <span class="md-ellipsis">
  1180. Blogs
  1181. </span>
  1182. </a>
  1183. </li>
  1184. <li class="md-nav__item">
  1185. <a href="../../eso-tools/" class="md-nav__link">
  1186. <span class="md-ellipsis">
  1187. Tools
  1188. </span>
  1189. </a>
  1190. </li>
  1191. </ul>
  1192. </nav>
  1193. </li>
  1194. </ul>
  1195. </nav>
  1196. </li>
  1197. </ul>
  1198. </nav>
  1199. </div>
  1200. </div>
  1201. </div>
  1202. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1203. <div class="md-sidebar__scrollwrap">
  1204. <div class="md-sidebar__inner">
  1205. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1206. <label class="md-nav__title" for="__toc">
  1207. <span class="md-nav__icon md-icon"></span>
  1208. Table of contents
  1209. </label>
  1210. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1211. <li class="md-nav__item">
  1212. <a href="#getting-started" class="md-nav__link">
  1213. <span class="md-ellipsis">
  1214. Getting Started
  1215. </span>
  1216. </a>
  1217. </li>
  1218. <li class="md-nav__item">
  1219. <a href="#building-testing" class="md-nav__link">
  1220. <span class="md-ellipsis">
  1221. Building &amp; Testing
  1222. </span>
  1223. </a>
  1224. </li>
  1225. <li class="md-nav__item">
  1226. <a href="#using-tilt" class="md-nav__link">
  1227. <span class="md-ellipsis">
  1228. Using Tilt
  1229. </span>
  1230. </a>
  1231. </li>
  1232. <li class="md-nav__item">
  1233. <a href="#installing" class="md-nav__link">
  1234. <span class="md-ellipsis">
  1235. Installing
  1236. </span>
  1237. </a>
  1238. </li>
  1239. <li class="md-nav__item">
  1240. <a href="#documentation" class="md-nav__link">
  1241. <span class="md-ellipsis">
  1242. Documentation
  1243. </span>
  1244. </a>
  1245. </li>
  1246. </ul>
  1247. </nav>
  1248. </div>
  1249. </div>
  1250. </div>
  1251. <div class="md-content" data-md-component="content">
  1252. <article class="md-content__inner md-typeset">
  1253. <h1>Developer guide</h1>
  1254. <h2 id="getting-started">Getting Started</h2>
  1255. <p>You must have a working <a href="https://golang.org/doc/install">Go environment</a> and
  1256. then clone the repo:</p>
  1257. <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
  1258. <span class="nb">cd</span><span class="w"> </span>external-secrets
  1259. </code></pre></div>
  1260. <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>
  1261. <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>
  1262. <div class="highlight"><pre><span></span><code>$ helm plugin install https://github.com/helm-unittest/helm-unittest
  1263. </code></pre></div>
  1264. <h2 id="building-testing">Building &amp; Testing</h2>
  1265. <p>The project uses the <code>make</code> build system. It'll run code generators, tests and
  1266. static code analysis.</p>
  1267. <p>Building the operator binary and docker image:</p>
  1268. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>build
  1269. 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
  1270. </code></pre></div>
  1271. <p>Run tests and lint the code:
  1272. <div class="highlight"><pre><span></span><code>make<span class="w"> </span><span class="nb">test</span>
  1273. make<span class="w"> </span>lint<span class="w"> </span><span class="c1"># OR</span>
  1274. 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
  1275. </code></pre></div></p>
  1276. <p>Build the documentation:
  1277. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs
  1278. </code></pre></div></p>
  1279. <h2 id="using-tilt">Using Tilt</h2>
  1280. <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
  1281. the running binary in the container using a process manager of its own.</p>
  1282. <p>To run tilt, download the utility for your operating system and run <code>make tilt-up</code>. This will do two things:
  1283. - downloads tilt for the current OS and ARCH under <code>bin/tilt</code>
  1284. - make manifest files of your current changes and place them under <code>./bin/deploy/manifests/external-secrets.yaml</code>
  1285. - run tilt with <code>tilt run</code></p>
  1286. <p>Hit <code>space</code> and you can observe all the pods starting up and track their output in the tilt UI.</p>
  1287. <h2 id="installing">Installing</h2>
  1288. <p>To install the External Secret Operator into a Kubernetes Cluster run:</p>
  1289. <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
  1290. helm<span class="w"> </span>repo<span class="w"> </span>update
  1291. helm<span class="w"> </span>install<span class="w"> </span>external-secrets<span class="w"> </span>external-secrets/external-secrets
  1292. </code></pre></div>
  1293. <p>You can alternatively run the controller on your host system for development purposes:</p>
  1294. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>crds.install
  1295. make<span class="w"> </span>run
  1296. </code></pre></div>
  1297. <p>To remove the CRDs run:</p>
  1298. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>crds.uninstall
  1299. </code></pre></div>
  1300. <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>
  1301. <div class="highlight"><pre><span></span><code><span class="c1"># Start a local K8S cluster with KinD</span>
  1302. kind<span class="w"> </span>create<span class="w"> </span>cluster<span class="w"> </span>--name<span class="w"> </span>external-secrets
  1303. <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>
  1304. <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>
  1305. <span class="c1"># Build docker image</span>
  1306. make<span class="w"> </span>docker.build
  1307. <span class="c1"># Load docker image into local kind cluster</span>
  1308. 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
  1309. <span class="c1"># (Optional) Pull the image from GitHub Repo to copy into kind</span>
  1310. <span class="c1"># docker pull ghcr.io/external-secrets/external-secrets:v0.8.2</span>
  1311. <span class="c1"># kind load docker-image ghcr.io/external-secrets/external-secrets:v0.8.2 -n external-secrets</span>
  1312. <span class="c1"># export TAG=v0.8.2</span>
  1313. <span class="c1"># Update helm charts and install to KinD cluster</span>
  1314. make<span class="w"> </span>helm.generate
  1315. 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>
  1316. --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>
  1317. --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>
  1318. --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>
  1319. <span class="c1"># Command to delete the cluster when done</span>
  1320. <span class="c1"># kind delete cluster -n external-secrets</span>
  1321. </code></pre></div>
  1322. <div class="admonition note">
  1323. <p class="admonition-title">Contributing Flow</p>
  1324. <p>The HOW TO guide for contributing is at the <a href="../process/">Contributing Process</a> page.</p>
  1325. </div>
  1326. <h2 id="documentation">Documentation</h2>
  1327. <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
  1328. documentation. See <code>/docs</code> for the source code and <code>/hack/api-docs</code> for the build process.</p>
  1329. <p>When writing documentation it is advised to run the mkdocs server with livereload:</p>
  1330. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs.serve
  1331. </code></pre></div>
  1332. <p>Run the following command to run a complete build. The rendered assets are available under <code>/site</code>.</p>
  1333. <div class="highlight"><pre><span></span><code>make<span class="w"> </span>docs
  1334. make<span class="w"> </span>docs.serve
  1335. </code></pre></div>
  1336. <p>Open <code>http://localhost:8000</code> in your browser.</p>
  1337. <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>
  1338. <p>When finished writing/reviewing the docs, clean up your local docs branch changes with <code>git branch -D gh-pages</code></p>
  1339. </article>
  1340. </div>
  1341. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1342. </div>
  1343. </main>
  1344. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" alt=""/>
  1345. <footer class="md-footer">
  1346. <div class="md-footer-meta md-typeset">
  1347. <div class="md-footer-meta__inner md-grid">
  1348. <div class="md-copyright">
  1349. <div class="md-copyright__highlight">
  1350. &copy; 2025 The external-secrets Authors.<br/>
  1351. &copy; 2025 The Linux Foundation. All rights reserved.<br/><br/>
  1352. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1353. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1354. </div>
  1355. Made with
  1356. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1357. Material for MkDocs
  1358. </a>
  1359. </div>
  1360. </div>
  1361. </div>
  1362. </footer>
  1363. </div>
  1364. <div class="md-dialog" data-md-component="dialog">
  1365. <div class="md-dialog__inner md-typeset"></div>
  1366. </div>
  1367. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.d50fe291.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>
  1368. <script src="../../assets/javascripts/bundle.13a4f30d.min.js"></script>
  1369. </body>
  1370. </html>