index.html 66 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530
  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="../devguide/">
  7. <link rel="next" href="../release/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.21">
  10. <title>Contributing Process - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.66ac8b77.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="#project-management" 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. Contributing Process
  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.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.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="../devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. <li class="md-tabs__item">
  141. <a href="../../spec/" class="md-tabs__link">
  142. References
  143. </a>
  144. </li>
  145. </ul>
  146. </div>
  147. </nav>
  148. <main class="md-main" data-md-component="main">
  149. <div class="md-main__inner md-grid">
  150. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  151. <div class="md-sidebar__scrollwrap">
  152. <div class="md-sidebar__inner">
  153. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  154. <label class="md-nav__title" for="__drawer">
  155. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  156. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  157. </a>
  158. External Secrets Operator
  159. </label>
  160. <div class="md-nav__source">
  161. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  162. <div class="md-source__icon md-icon">
  163. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.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.81z"/></svg>
  164. </div>
  165. <div class="md-source__repository">
  166. External Secrets Operator
  167. </div>
  168. </a>
  169. </div>
  170. <ul class="md-nav__list" data-md-scrollfix>
  171. <li class="md-nav__item md-nav__item--nested">
  172. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  173. <div class="md-nav__link md-nav__container">
  174. <a href="../.." class="md-nav__link ">
  175. <span class="md-ellipsis">
  176. Introduction
  177. </span>
  178. </a>
  179. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  180. <span class="md-nav__icon md-icon"></span>
  181. </label>
  182. </div>
  183. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  184. <label class="md-nav__title" for="__nav_1">
  185. <span class="md-nav__icon md-icon"></span>
  186. Introduction
  187. </label>
  188. <ul class="md-nav__list" data-md-scrollfix>
  189. <li class="md-nav__item">
  190. <a href="../../introduction/overview/" class="md-nav__link">
  191. <span class="md-ellipsis">
  192. Overview
  193. </span>
  194. </a>
  195. </li>
  196. <li class="md-nav__item">
  197. <a href="../../introduction/getting-started/" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. Getting started
  200. </span>
  201. </a>
  202. </li>
  203. <li class="md-nav__item">
  204. <a href="../../introduction/faq/" class="md-nav__link">
  205. <span class="md-ellipsis">
  206. FAQ
  207. </span>
  208. </a>
  209. </li>
  210. <li class="md-nav__item">
  211. <a href="../../introduction/stability-support/" class="md-nav__link">
  212. <span class="md-ellipsis">
  213. Stability and Support
  214. </span>
  215. </a>
  216. </li>
  217. <li class="md-nav__item">
  218. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  219. <span class="md-ellipsis">
  220. Deprecation Policy
  221. </span>
  222. </a>
  223. </li>
  224. </ul>
  225. </nav>
  226. </li>
  227. <li class="md-nav__item md-nav__item--nested">
  228. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  229. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  230. <span class="md-ellipsis">
  231. API
  232. </span>
  233. <span class="md-nav__icon md-icon"></span>
  234. </label>
  235. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  236. <label class="md-nav__title" for="__nav_2">
  237. <span class="md-nav__icon md-icon"></span>
  238. API
  239. </label>
  240. <ul class="md-nav__list" data-md-scrollfix>
  241. <li class="md-nav__item">
  242. <a href="../../api/components/" class="md-nav__link">
  243. <span class="md-ellipsis">
  244. Components
  245. </span>
  246. </a>
  247. </li>
  248. <li class="md-nav__item md-nav__item--nested">
  249. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  250. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  251. <span class="md-ellipsis">
  252. Core Resources
  253. </span>
  254. <span class="md-nav__icon md-icon"></span>
  255. </label>
  256. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  257. <label class="md-nav__title" for="__nav_2_2">
  258. <span class="md-nav__icon md-icon"></span>
  259. Core Resources
  260. </label>
  261. <ul class="md-nav__list" data-md-scrollfix>
  262. <li class="md-nav__item">
  263. <a href="../../api/externalsecret/" class="md-nav__link">
  264. <span class="md-ellipsis">
  265. ExternalSecret
  266. </span>
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="../../api/secretstore/" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. SecretStore
  273. </span>
  274. </a>
  275. </li>
  276. <li class="md-nav__item">
  277. <a href="../../api/clustersecretstore/" class="md-nav__link">
  278. <span class="md-ellipsis">
  279. ClusterSecretStore
  280. </span>
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  285. <span class="md-ellipsis">
  286. ClusterExternalSecret
  287. </span>
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="../../api/pushsecret/" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. PushSecret
  294. </span>
  295. </a>
  296. </li>
  297. </ul>
  298. </nav>
  299. </li>
  300. <li class="md-nav__item md-nav__item--nested">
  301. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  302. <div class="md-nav__link md-nav__container">
  303. <a href="../../api/generator/" class="md-nav__link ">
  304. <span class="md-ellipsis">
  305. Generators
  306. </span>
  307. </a>
  308. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. </div>
  312. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  313. <label class="md-nav__title" for="__nav_2_3">
  314. <span class="md-nav__icon md-icon"></span>
  315. Generators
  316. </label>
  317. <ul class="md-nav__list" data-md-scrollfix>
  318. <li class="md-nav__item">
  319. <a href="../../api/generator/acr/" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. Azure Container Registry
  322. </span>
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="../../api/generator/ecr/" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. AWS Elastic Container Registry
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/generator/gcr/" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. Google Container Registry
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="../../api/generator/vault/" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. Vault Dynamic Secret
  343. </span>
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="../../api/generator/password/" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. Password
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="../../api/generator/fake/" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. Fake
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="../../api/generator/webhook/" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. Webhook
  364. </span>
  365. </a>
  366. </li>
  367. </ul>
  368. </nav>
  369. </li>
  370. <li class="md-nav__item md-nav__item--nested">
  371. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  372. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  373. <span class="md-ellipsis">
  374. Reference Docs
  375. </span>
  376. <span class="md-nav__icon md-icon"></span>
  377. </label>
  378. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  379. <label class="md-nav__title" for="__nav_2_4">
  380. <span class="md-nav__icon md-icon"></span>
  381. Reference Docs
  382. </label>
  383. <ul class="md-nav__list" data-md-scrollfix>
  384. <li class="md-nav__item">
  385. <a href="../../api/spec/" class="md-nav__link">
  386. <span class="md-ellipsis">
  387. API specification
  388. </span>
  389. </a>
  390. </li>
  391. <li class="md-nav__item">
  392. <a href="../../api/controller-options/" class="md-nav__link">
  393. <span class="md-ellipsis">
  394. Controller Options
  395. </span>
  396. </a>
  397. </li>
  398. <li class="md-nav__item">
  399. <a href="../../api/metrics/" class="md-nav__link">
  400. <span class="md-ellipsis">
  401. Metrics
  402. </span>
  403. </a>
  404. </li>
  405. </ul>
  406. </nav>
  407. </li>
  408. </ul>
  409. </nav>
  410. </li>
  411. <li class="md-nav__item md-nav__item--nested">
  412. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  413. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  414. <span class="md-ellipsis">
  415. Guides
  416. </span>
  417. <span class="md-nav__icon md-icon"></span>
  418. </label>
  419. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  420. <label class="md-nav__title" for="__nav_3">
  421. <span class="md-nav__icon md-icon"></span>
  422. Guides
  423. </label>
  424. <ul class="md-nav__list" data-md-scrollfix>
  425. <li class="md-nav__item">
  426. <a href="../../guides/introduction/" class="md-nav__link">
  427. <span class="md-ellipsis">
  428. Introduction
  429. </span>
  430. </a>
  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_3_2" >
  434. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  435. <span class="md-ellipsis">
  436. External Secrets
  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_3_2_label" aria-expanded="false">
  441. <label class="md-nav__title" for="__nav_3_2">
  442. <span class="md-nav__icon md-icon"></span>
  443. External Secrets
  444. </label>
  445. <ul class="md-nav__list" data-md-scrollfix>
  446. <li class="md-nav__item">
  447. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  448. <span class="md-ellipsis">
  449. Extract structured data
  450. </span>
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../../guides/getallsecrets/" class="md-nav__link">
  455. <span class="md-ellipsis">
  456. Find Secrets by Name or Metadata
  457. </span>
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  462. <span class="md-ellipsis">
  463. Rewriting Keys
  464. </span>
  465. </a>
  466. </li>
  467. <li class="md-nav__item md-nav__item--nested">
  468. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  469. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  470. <span class="md-ellipsis">
  471. Advanced Templating
  472. </span>
  473. <span class="md-nav__icon md-icon"></span>
  474. </label>
  475. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  476. <label class="md-nav__title" for="__nav_3_2_4">
  477. <span class="md-nav__icon md-icon"></span>
  478. Advanced Templating
  479. </label>
  480. <ul class="md-nav__list" data-md-scrollfix>
  481. <li class="md-nav__item">
  482. <a href="../../guides/templating/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. v2
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../guides/templating-v1/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. v1
  492. </span>
  493. </a>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. <li class="md-nav__item">
  499. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  500. <span class="md-ellipsis">
  501. Kubernetes Secret Types
  502. </span>
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  507. <span class="md-ellipsis">
  508. Lifecycle: ownership & deletion
  509. </span>
  510. </a>
  511. </li>
  512. <li class="md-nav__item">
  513. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  514. <span class="md-ellipsis">
  515. Decoding Strategies
  516. </span>
  517. </a>
  518. </li>
  519. <li class="md-nav__item">
  520. <a href="../../guides/controller-class/" class="md-nav__link">
  521. <span class="md-ellipsis">
  522. Controller Classes
  523. </span>
  524. </a>
  525. </li>
  526. </ul>
  527. </nav>
  528. </li>
  529. <li class="md-nav__item">
  530. <a href="../../guides/generator/" class="md-nav__link">
  531. <span class="md-ellipsis">
  532. Generators
  533. </span>
  534. </a>
  535. </li>
  536. <li class="md-nav__item">
  537. <a href="../../guides/pushsecrets/" class="md-nav__link">
  538. <span class="md-ellipsis">
  539. Push Secrets
  540. </span>
  541. </a>
  542. </li>
  543. <li class="md-nav__item md-nav__item--nested">
  544. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  545. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  546. <span class="md-ellipsis">
  547. Operations
  548. </span>
  549. <span class="md-nav__icon md-icon"></span>
  550. </label>
  551. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  552. <label class="md-nav__title" for="__nav_3_5">
  553. <span class="md-nav__icon md-icon"></span>
  554. Operations
  555. </label>
  556. <ul class="md-nav__list" data-md-scrollfix>
  557. <li class="md-nav__item">
  558. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  559. <span class="md-ellipsis">
  560. Multi Tenancy
  561. </span>
  562. </a>
  563. </li>
  564. <li class="md-nav__item">
  565. <a href="../../guides/security-best-practices/" class="md-nav__link">
  566. <span class="md-ellipsis">
  567. Security Best Practices
  568. </span>
  569. </a>
  570. </li>
  571. <li class="md-nav__item">
  572. <a href="../../guides/threat-model/" class="md-nav__link">
  573. <span class="md-ellipsis">
  574. Threat Model
  575. </span>
  576. </a>
  577. </li>
  578. <li class="md-nav__item">
  579. <a href="../../guides/v1beta1/" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. Upgrading to v1beta1
  582. </span>
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="../../guides/using-latest-image/" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. Using Latest Image
  589. </span>
  590. </a>
  591. </li>
  592. <li class="md-nav__item">
  593. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  594. <span class="md-ellipsis">
  595. Disable Cluster Features
  596. </span>
  597. </a>
  598. </li>
  599. </ul>
  600. </nav>
  601. </li>
  602. </ul>
  603. </nav>
  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_4" >
  607. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  608. <span class="md-ellipsis">
  609. Provider
  610. </span>
  611. <span class="md-nav__icon md-icon"></span>
  612. </label>
  613. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  614. <label class="md-nav__title" for="__nav_4">
  615. <span class="md-nav__icon md-icon"></span>
  616. Provider
  617. </label>
  618. <ul class="md-nav__list" data-md-scrollfix>
  619. <li class="md-nav__item">
  620. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. AWS Secrets Manager
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. AWS Parameter Store
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Azure Key Vault
  637. </span>
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../../provider/chef/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. Chef
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../../provider/conjur/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. CyberArk Conjur
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. Google Cloud Secret Manager
  658. </span>
  659. </a>
  660. </li>
  661. <li class="md-nav__item">
  662. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  663. <span class="md-ellipsis">
  664. HashiCorp Vault
  665. </span>
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="../../provider/kubernetes/" class="md-nav__link">
  670. <span class="md-ellipsis">
  671. Kubernetes
  672. </span>
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  677. <span class="md-ellipsis">
  678. IBM Secrets Manager
  679. </span>
  680. </a>
  681. </li>
  682. <li class="md-nav__item">
  683. <a href="../../provider/akeyless/" class="md-nav__link">
  684. <span class="md-ellipsis">
  685. Akeyless
  686. </span>
  687. </a>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Yandex Certificate Manager
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Yandex Lockbox
  700. </span>
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../../provider/alibaba/" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. Alibaba Cloud
  707. </span>
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  712. <span class="md-ellipsis">
  713. GitLab Variables
  714. </span>
  715. </a>
  716. </li>
  717. <li class="md-nav__item">
  718. <a href="../../provider/oracle-vault/" class="md-nav__link">
  719. <span class="md-ellipsis">
  720. Oracle Vault
  721. </span>
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="../../provider/1password-automation/" class="md-nav__link">
  726. <span class="md-ellipsis">
  727. 1Password Secrets Automation
  728. </span>
  729. </a>
  730. </li>
  731. <li class="md-nav__item">
  732. <a href="../../provider/webhook/" class="md-nav__link">
  733. <span class="md-ellipsis">
  734. Webhook
  735. </span>
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../provider/fake/" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Fake
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. senhasegura DevOps Secrets Management (DSM)
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="../../provider/doppler/" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Doppler
  756. </span>
  757. </a>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="../../provider/keeper-security/" class="md-nav__link">
  761. <span class="md-ellipsis">
  762. Keeper Security
  763. </span>
  764. </a>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="../../provider/cloak/" class="md-nav__link">
  768. <span class="md-ellipsis">
  769. Cloak End 2 End Encrypted Secrets
  770. </span>
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="../../provider/scaleway/" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Scaleway
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../provider/delinea/" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Delinea
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../../provider/passbolt/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. Passbolt
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../../provider/pulumi/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Pulumi ESC
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../../provider/onboardbase/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. Onboardbase
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../../provider-passworddepot/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Password Depot
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../../provider/fortanix/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Fortanix
  819. </span>
  820. </a>
  821. </li>
  822. </ul>
  823. </nav>
  824. </li>
  825. <li class="md-nav__item md-nav__item--nested">
  826. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  827. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  828. <span class="md-ellipsis">
  829. Examples
  830. </span>
  831. <span class="md-nav__icon md-icon"></span>
  832. </label>
  833. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  834. <label class="md-nav__title" for="__nav_5">
  835. <span class="md-nav__icon md-icon"></span>
  836. Examples
  837. </label>
  838. <ul class="md-nav__list" data-md-scrollfix>
  839. <li class="md-nav__item">
  840. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  841. <span class="md-ellipsis">
  842. FluxCD
  843. </span>
  844. </a>
  845. </li>
  846. <li class="md-nav__item">
  847. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  848. <span class="md-ellipsis">
  849. Anchore Engine
  850. </span>
  851. </a>
  852. </li>
  853. <li class="md-nav__item">
  854. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  855. <span class="md-ellipsis">
  856. Jenkins
  857. </span>
  858. </a>
  859. </li>
  860. <li class="md-nav__item">
  861. <a href="../../examples/bitwarden/" class="md-nav__link">
  862. <span class="md-ellipsis">
  863. BitWarden
  864. </span>
  865. </a>
  866. </li>
  867. </ul>
  868. </nav>
  869. </li>
  870. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  871. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
  872. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
  873. <span class="md-ellipsis">
  874. Community
  875. </span>
  876. <span class="md-nav__icon md-icon"></span>
  877. </label>
  878. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
  879. <label class="md-nav__title" for="__nav_6">
  880. <span class="md-nav__icon md-icon"></span>
  881. Community
  882. </label>
  883. <ul class="md-nav__list" data-md-scrollfix>
  884. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  885. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
  886. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  887. <span class="md-ellipsis">
  888. Contributing
  889. </span>
  890. <span class="md-nav__icon md-icon"></span>
  891. </label>
  892. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
  893. <label class="md-nav__title" for="__nav_6_1">
  894. <span class="md-nav__icon md-icon"></span>
  895. Contributing
  896. </label>
  897. <ul class="md-nav__list" data-md-scrollfix>
  898. <li class="md-nav__item">
  899. <a href="../devguide/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. Developer guide
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item md-nav__item--active">
  906. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  907. <label class="md-nav__link md-nav__link--active" for="__toc">
  908. <span class="md-ellipsis">
  909. Contributing Process
  910. </span>
  911. <span class="md-nav__icon md-icon"></span>
  912. </label>
  913. <a href="./" class="md-nav__link md-nav__link--active">
  914. <span class="md-ellipsis">
  915. Contributing Process
  916. </span>
  917. </a>
  918. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  919. <label class="md-nav__title" for="__toc">
  920. <span class="md-nav__icon md-icon"></span>
  921. Table of contents
  922. </label>
  923. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  924. <li class="md-nav__item">
  925. <a href="#project-management" class="md-nav__link">
  926. <span class="md-ellipsis">
  927. Project Management
  928. </span>
  929. </a>
  930. </li>
  931. <li class="md-nav__item">
  932. <a href="#issues" class="md-nav__link">
  933. <span class="md-ellipsis">
  934. Issues
  935. </span>
  936. </a>
  937. </li>
  938. <li class="md-nav__item">
  939. <a href="#submitting-a-pull-request" class="md-nav__link">
  940. <span class="md-ellipsis">
  941. Submitting a Pull Request
  942. </span>
  943. </a>
  944. <nav class="md-nav" aria-label="Submitting a Pull Request">
  945. <ul class="md-nav__list">
  946. <li class="md-nav__item">
  947. <a href="#triggering-e2e-tests" class="md-nav__link">
  948. <span class="md-ellipsis">
  949. Triggering e2e tests
  950. </span>
  951. </a>
  952. <nav class="md-nav" aria-label="Triggering e2e tests">
  953. <ul class="md-nav__list">
  954. <li class="md-nav__item">
  955. <a href="#executing-e2e-tests-locally" class="md-nav__link">
  956. <span class="md-ellipsis">
  957. Executing e2e tests locally
  958. </span>
  959. </a>
  960. </li>
  961. <li class="md-nav__item">
  962. <a href="#managed-kubernetes-e2e-tests" class="md-nav__link">
  963. <span class="md-ellipsis">
  964. Managed Kubernetes e2e tests
  965. </span>
  966. </a>
  967. </li>
  968. </ul>
  969. </nav>
  970. </li>
  971. <li class="md-nav__item">
  972. <a href="#executing-managed-kubernetes-e2e-tests-locally" class="md-nav__link">
  973. <span class="md-ellipsis">
  974. Executing Managed Kubernetes e2e tests locally
  975. </span>
  976. </a>
  977. </li>
  978. </ul>
  979. </nav>
  980. </li>
  981. <li class="md-nav__item">
  982. <a href="#proposal-process" class="md-nav__link">
  983. <span class="md-ellipsis">
  984. Proposal Process
  985. </span>
  986. </a>
  987. </li>
  988. <li class="md-nav__item">
  989. <a href="#release-planning" class="md-nav__link">
  990. <span class="md-ellipsis">
  991. Release Planning
  992. </span>
  993. </a>
  994. </li>
  995. <li class="md-nav__item">
  996. <a href="#support-questions" class="md-nav__link">
  997. <span class="md-ellipsis">
  998. Support &amp; Questions
  999. </span>
  1000. </a>
  1001. </li>
  1002. <li class="md-nav__item">
  1003. <a href="#cutting-releases" class="md-nav__link">
  1004. <span class="md-ellipsis">
  1005. Cutting Releases
  1006. </span>
  1007. </a>
  1008. </li>
  1009. </ul>
  1010. </nav>
  1011. </li>
  1012. <li class="md-nav__item">
  1013. <a href="../release/" class="md-nav__link">
  1014. <span class="md-ellipsis">
  1015. Release Process
  1016. </span>
  1017. </a>
  1018. </li>
  1019. <li class="md-nav__item">
  1020. <a href="../coc/" class="md-nav__link">
  1021. <span class="md-ellipsis">
  1022. Code of Conduct
  1023. </span>
  1024. </a>
  1025. </li>
  1026. <li class="md-nav__item">
  1027. <a href="../roadmap/" class="md-nav__link">
  1028. <span class="md-ellipsis">
  1029. Roadmap
  1030. </span>
  1031. </a>
  1032. </li>
  1033. </ul>
  1034. </nav>
  1035. </li>
  1036. <li class="md-nav__item md-nav__item--nested">
  1037. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1038. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1039. <span class="md-ellipsis">
  1040. External Resources
  1041. </span>
  1042. <span class="md-nav__icon md-icon"></span>
  1043. </label>
  1044. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1045. <label class="md-nav__title" for="__nav_6_2">
  1046. <span class="md-nav__icon md-icon"></span>
  1047. External Resources
  1048. </label>
  1049. <ul class="md-nav__list" data-md-scrollfix>
  1050. <li class="md-nav__item">
  1051. <a href="../../eso-talks/" class="md-nav__link">
  1052. <span class="md-ellipsis">
  1053. Talks
  1054. </span>
  1055. </a>
  1056. </li>
  1057. <li class="md-nav__item">
  1058. <a href="../../eso-demos/" class="md-nav__link">
  1059. <span class="md-ellipsis">
  1060. Demos
  1061. </span>
  1062. </a>
  1063. </li>
  1064. <li class="md-nav__item">
  1065. <a href="../../eso-blogs/" class="md-nav__link">
  1066. <span class="md-ellipsis">
  1067. Blogs
  1068. </span>
  1069. </a>
  1070. </li>
  1071. </ul>
  1072. </nav>
  1073. </li>
  1074. </ul>
  1075. </nav>
  1076. </li>
  1077. <li class="md-nav__item md-nav__item--nested">
  1078. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
  1079. <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
  1080. <span class="md-ellipsis">
  1081. References
  1082. </span>
  1083. <span class="md-nav__icon md-icon"></span>
  1084. </label>
  1085. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  1086. <label class="md-nav__title" for="__nav_7">
  1087. <span class="md-nav__icon md-icon"></span>
  1088. References
  1089. </label>
  1090. <ul class="md-nav__list" data-md-scrollfix>
  1091. <li class="md-nav__item">
  1092. <a href="../../spec/" class="md-nav__link">
  1093. <span class="md-ellipsis">
  1094. API specification
  1095. </span>
  1096. </a>
  1097. </li>
  1098. </ul>
  1099. </nav>
  1100. </li>
  1101. </ul>
  1102. </nav>
  1103. </div>
  1104. </div>
  1105. </div>
  1106. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1107. <div class="md-sidebar__scrollwrap">
  1108. <div class="md-sidebar__inner">
  1109. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1110. <label class="md-nav__title" for="__toc">
  1111. <span class="md-nav__icon md-icon"></span>
  1112. Table of contents
  1113. </label>
  1114. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1115. <li class="md-nav__item">
  1116. <a href="#project-management" class="md-nav__link">
  1117. <span class="md-ellipsis">
  1118. Project Management
  1119. </span>
  1120. </a>
  1121. </li>
  1122. <li class="md-nav__item">
  1123. <a href="#issues" class="md-nav__link">
  1124. <span class="md-ellipsis">
  1125. Issues
  1126. </span>
  1127. </a>
  1128. </li>
  1129. <li class="md-nav__item">
  1130. <a href="#submitting-a-pull-request" class="md-nav__link">
  1131. <span class="md-ellipsis">
  1132. Submitting a Pull Request
  1133. </span>
  1134. </a>
  1135. <nav class="md-nav" aria-label="Submitting a Pull Request">
  1136. <ul class="md-nav__list">
  1137. <li class="md-nav__item">
  1138. <a href="#triggering-e2e-tests" class="md-nav__link">
  1139. <span class="md-ellipsis">
  1140. Triggering e2e tests
  1141. </span>
  1142. </a>
  1143. <nav class="md-nav" aria-label="Triggering e2e tests">
  1144. <ul class="md-nav__list">
  1145. <li class="md-nav__item">
  1146. <a href="#executing-e2e-tests-locally" class="md-nav__link">
  1147. <span class="md-ellipsis">
  1148. Executing e2e tests locally
  1149. </span>
  1150. </a>
  1151. </li>
  1152. <li class="md-nav__item">
  1153. <a href="#managed-kubernetes-e2e-tests" class="md-nav__link">
  1154. <span class="md-ellipsis">
  1155. Managed Kubernetes e2e tests
  1156. </span>
  1157. </a>
  1158. </li>
  1159. </ul>
  1160. </nav>
  1161. </li>
  1162. <li class="md-nav__item">
  1163. <a href="#executing-managed-kubernetes-e2e-tests-locally" class="md-nav__link">
  1164. <span class="md-ellipsis">
  1165. Executing Managed Kubernetes e2e tests locally
  1166. </span>
  1167. </a>
  1168. </li>
  1169. </ul>
  1170. </nav>
  1171. </li>
  1172. <li class="md-nav__item">
  1173. <a href="#proposal-process" class="md-nav__link">
  1174. <span class="md-ellipsis">
  1175. Proposal Process
  1176. </span>
  1177. </a>
  1178. </li>
  1179. <li class="md-nav__item">
  1180. <a href="#release-planning" class="md-nav__link">
  1181. <span class="md-ellipsis">
  1182. Release Planning
  1183. </span>
  1184. </a>
  1185. </li>
  1186. <li class="md-nav__item">
  1187. <a href="#support-questions" class="md-nav__link">
  1188. <span class="md-ellipsis">
  1189. Support &amp; Questions
  1190. </span>
  1191. </a>
  1192. </li>
  1193. <li class="md-nav__item">
  1194. <a href="#cutting-releases" class="md-nav__link">
  1195. <span class="md-ellipsis">
  1196. Cutting Releases
  1197. </span>
  1198. </a>
  1199. </li>
  1200. </ul>
  1201. </nav>
  1202. </div>
  1203. </div>
  1204. </div>
  1205. <div class="md-content" data-md-component="content">
  1206. <article class="md-content__inner md-typeset">
  1207. <h1>Contributing Process</h1>
  1208. <h2 id="project-management">Project Management</h2>
  1209. <p>The Code, our TODOs and Documentation is maintained on
  1210. <a href="https://github.com/external-secrets/external-secrets">GitHub</a>. All Issues
  1211. should be opened in that repository.
  1212. We have a <a href="../roadmap/">Roadmap</a> to track progress for our road towards GA.</p>
  1213. <h2 id="issues">Issues</h2>
  1214. <p>Features, bugs and any issues regarding the documentation should be filed as
  1215. <a href="https://github.com/external-secrets/external-secrets/issues">GitHub Issue</a> in
  1216. our repository. We use labels like <code>kind/feature</code>, <code>kind/bug</code>, <code>area/aws</code> to
  1217. organize the issues. Issues labeled <code>good first issue</code> and <code>help wanted</code> are
  1218. especially good for a first contribution. If you want to pick up an issue just
  1219. leave a comment.</p>
  1220. <h2 id="submitting-a-pull-request">Submitting a Pull Request</h2>
  1221. <p>This project uses the well-known pull request process from GitHub. To submit a
  1222. pull request, fork the repository and push any changes to a branch on the copy,
  1223. from there a pull request can be made in the main repo. Merging a pull request
  1224. requires the following steps to be completed before the pull request will
  1225. be merged:</p>
  1226. <ul>
  1227. <li>ideally, there is an issue that documents the problem or feature in depth.</li>
  1228. <li>code must have a reasonable amount of test coverage</li>
  1229. <li>tests must pass</li>
  1230. <li>PR needs be reviewed and approved</li>
  1231. </ul>
  1232. <p>Once these steps are completed the PR will be merged by a code owner.
  1233. We're using the pull request <code>assignee</code> feature to track who is responsible
  1234. for the lifecycle of the PR: review, merging, ping on inactivity, close.
  1235. We close pull requests or issues if there is no response from the author for
  1236. a period of time. Feel free to reopen if you want to get back on it.</p>
  1237. <h3 id="triggering-e2e-tests">Triggering e2e tests</h3>
  1238. <p>We have an extensive set of e2e tests that test the integration with <em>real</em> cloud provider APIs.
  1239. Maintainers must trigger these kind of tests manually for PRs that come from forked repositories. These tests run inside a <code>kind</code> cluster in the GitHub Actions runner:</p>
  1240. <div class="highlight"><pre><span></span><code>/ok-to-test sha=xxxxxx
  1241. </code></pre></div>
  1242. <h4 id="executing-e2e-tests-locally">Executing e2e tests locally</h4>
  1243. <p>You have to prepare your shell environment with the necessary variables so the e2e test
  1244. runner knows what credentials to use. See <code>e2e/run.sh</code> for the variables that are passed in.
  1245. If you e.g. want to test AWS integration make sure set all <code>AWS_*</code> variables mentioned
  1246. in that file.</p>
  1247. <p>Use <a href="https://onsi.github.io/ginkgo/#spec-labels">ginkgo labels</a> to select the tests
  1248. you want to execute. You have to specify <code>!managed</code> to ensure that you do not
  1249. run managed tests.</p>
  1250. <div class="highlight"><pre><span></span><code>make test.e2e GINKGO_LABELS=&#39;gcp&amp;&amp;!managed&#39;
  1251. </code></pre></div>
  1252. <h4 id="managed-kubernetes-e2e-tests">Managed Kubernetes e2e tests</h4>
  1253. <p>There's another suite of e2e tests that integrate with managed Kubernetes offerings.
  1254. They create real infrastructure at a cloud provider and deploy the controller
  1255. into that environment.
  1256. This is necessary to test the authentication integration
  1257. (<a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">GCP Workload Identity</a>,
  1258. <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">EKS IRSA</a>...).</p>
  1259. <p>These tests are time intensive (~20-45min) and must be triggered manually by
  1260. a maintainer when a particular provider or authentication mechanism was changed:</p>
  1261. <div class="highlight"><pre><span></span><code>/ok-to-test-managed sha=xxxxxx provider=aws
  1262. # or
  1263. /ok-to-test-managed sha=xxxxxx provider=gcp
  1264. # or
  1265. /ok-to-test-managed sha=xxxxxx provider=azure
  1266. </code></pre></div>
  1267. <p>Both tests can run in parallel. Once started they add a dynamic GitHub check <code>integration-managed-(gcp|aws|azure)</code> to the PR that triggered the test.</p>
  1268. <h3 id="executing-managed-kubernetes-e2e-tests-locally">Executing Managed Kubernetes e2e tests locally</h3>
  1269. <p>You have to prepare your shell environment with the necessary variables so the e2e
  1270. test runner knows what credentials to use. See <code>.github/workflows/e2e-managed.yml</code>
  1271. for the variables that are passed in. If you e.g. want to test AWS integration make
  1272. sure set all variables containing <code>AWS_*</code> and <code>TF_VAR_AWS_*</code> mentioned in that file.</p>
  1273. <p>Then execute <code>tf.apply.aws</code> or <code>tf.apply.gcp</code> to create the infrastructure.</p>
  1274. <div class="highlight"><pre><span></span><code>make tf.apply.aws
  1275. </code></pre></div>
  1276. <p>Then run the <code>managed</code> testsuite. You will need push permissions to the external-secrets ghcr repository. You can set <code>IMAGE_NAME</code> to control which image registry is used to store the controller and e2e test images in.</p>
  1277. <p>You also have to setup a proper Kubeconfig so the e2e test pod gets deployed into the managed cluster.</p>
  1278. <div class="highlight"><pre><span></span><code>aws eks update-kubeconfig --name ${AWS_CLUSTER_NAME}
  1279. or
  1280. gcloud container clusters get-credentials ${GCP_GKE_CLUSTER} --region europe-west1-b
  1281. </code></pre></div>
  1282. <p>Use <a href="https://onsi.github.io/ginkgo/#spec-labels">ginkgo labels</a> to select the tests
  1283. you want to execute.</p>
  1284. <div class="highlight"><pre><span></span><code># you may have to set IMAGE_NAME=docker.io/your-user/external-secrets
  1285. make test.e2e.managed GINKGO_LABELS=&#39;gcp&#39;
  1286. </code></pre></div>
  1287. <h2 id="proposal-process">Proposal Process</h2>
  1288. <p>Before we introduce significant changes to the project we want to gather feedback
  1289. from the community to ensure that we progress in the right direction before we
  1290. develop and release big changes. Significant changes include for example:</p>
  1291. <ul>
  1292. <li>creating new custom resources</li>
  1293. <li>proposing breaking changes</li>
  1294. <li>changing the behavior of the controller significantly</li>
  1295. </ul>
  1296. <p>Please create a document in the <code>design/</code> directory based on the template <code>000-template.md</code>
  1297. and fill in your proposal. Open a pull request in draft mode and request feedback. Once the proposal is accepted and the pull request is merged we can create work packages and proceed with the implementation.</p>
  1298. <h2 id="release-planning">Release Planning</h2>
  1299. <p>We have a <a href="https://github.com/orgs/external-secrets/projects/2/views/1">GitHub Project Board</a> where we organize issues on a high level. We group issues by milestone. Once all issues of a given milestone are closed we should prepare a new feature release. Issues of the next milestone have priority over other issues - but that does not mean that no one is allowed to start working on them.</p>
  1300. <p>Issues must be <em>manually</em> added to that board (at least for now, see <a href="https://github.com/github/roadmap/issues/286">GH Roadmap</a>). Milestones must be assigned manually as well. If no milestone is assigned it is basically a backlog item. It is the responsibility of the maintainers to:</p>
  1301. <ol>
  1302. <li>assign new issues to the GH Project</li>
  1303. <li>add a milestone if needed</li>
  1304. <li>add appropriate labels</li>
  1305. </ol>
  1306. <p>If you would like to raise the priority of an issue for whatever reason feel free to comment on the issue or ping a maintainer.</p>
  1307. <h2 id="support-questions">Support &amp; Questions</h2>
  1308. <p>Providing support to end users is an important and difficult task.
  1309. We have three different channels through which support questions arise:</p>
  1310. <ol>
  1311. <li>Kubernetes Slack <a href="https://kubernetes.slack.com/archives/C017BF84G2Y">#external-secrets</a></li>
  1312. <li><a href="https://github.com/external-secrets/external-secrets/discussions">GitHub Discussions</a></li>
  1313. <li>GitHub Issues</li>
  1314. </ol>
  1315. <p>We use labels to identify GitHub Issues. Specifically for managing support cases we use the following labels to identify the state a support case is in:</p>
  1316. <ul>
  1317. <li><code>triage/needs-information</code>: Indicates an issue needs more information in order to work on it.</li>
  1318. <li><code>triage/not-reproducible</code>: Indicates an issue can not be reproduced as described.</li>
  1319. <li><code>triage/support</code>: Indicates an issue that is a support question.</li>
  1320. </ul>
  1321. <h2 id="cutting-releases">Cutting Releases</h2>
  1322. <p>The external-secrets project is released on a as-needed basis. Feel free to open a issue to request a release. Details on how to cut a release can be found in the <a href="../release/">release</a> page.</p>
  1323. </article>
  1324. </div>
  1325. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1326. </div>
  1327. </main>
  1328. <footer class="md-footer">
  1329. <div class="md-footer-meta md-typeset">
  1330. <div class="md-footer-meta__inner md-grid">
  1331. <div class="md-copyright">
  1332. <div class="md-copyright__highlight">
  1333. &copy; 2024 The external-secrets Authors.<br/>
  1334. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1335. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1336. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1337. </div>
  1338. Made with
  1339. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1340. Material for MkDocs
  1341. </a>
  1342. </div>
  1343. </div>
  1344. </div>
  1345. </footer>
  1346. </div>
  1347. <div class="md-dialog" data-md-component="dialog">
  1348. <div class="md-dialog__inner md-typeset"></div>
  1349. </div>
  1350. <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>
  1351. <script src="../../assets/javascripts/bundle.a7c05c9e.min.js"></script>
  1352. </body>
  1353. </html>