index.html 51 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288
  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="icon" href="../../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>Contributing Process - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("../..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#project-management" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Contributing Process
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <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>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <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>
  72. <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>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <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>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../devguide/" class="md-tabs__link md-tabs__link--active">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/vault/" class="md-nav__link">
  294. Vault Dynamic Secret
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/password/" class="md-nav__link">
  299. Password
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../../api/generator/fake/" class="md-nav__link">
  304. Fake
  305. </a>
  306. </li>
  307. </ul>
  308. </nav>
  309. </li>
  310. <li class="md-nav__item md-nav__item--nested">
  311. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  312. <label class="md-nav__link" for="__nav_2_4">
  313. Reference Docs
  314. <span class="md-nav__icon md-icon"></span>
  315. </label>
  316. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  317. <label class="md-nav__title" for="__nav_2_4">
  318. <span class="md-nav__icon md-icon"></span>
  319. Reference Docs
  320. </label>
  321. <ul class="md-nav__list" data-md-scrollfix>
  322. <li class="md-nav__item">
  323. <a href="../../api/spec/" class="md-nav__link">
  324. API specification
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/controller-options/" class="md-nav__link">
  329. Controller Options
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="../../api/metrics/" class="md-nav__link">
  334. Metrics
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. </ul>
  341. </nav>
  342. </li>
  343. <li class="md-nav__item md-nav__item--nested">
  344. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  345. <label class="md-nav__link" for="__nav_3">
  346. Guides
  347. <span class="md-nav__icon md-icon"></span>
  348. </label>
  349. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  350. <label class="md-nav__title" for="__nav_3">
  351. <span class="md-nav__icon md-icon"></span>
  352. Guides
  353. </label>
  354. <ul class="md-nav__list" data-md-scrollfix>
  355. <li class="md-nav__item">
  356. <a href="../../guides/introduction/" class="md-nav__link">
  357. Introduction
  358. </a>
  359. </li>
  360. <li class="md-nav__item md-nav__item--nested">
  361. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  362. <label class="md-nav__link" for="__nav_3_2">
  363. Advanced Templating
  364. <span class="md-nav__icon md-icon"></span>
  365. </label>
  366. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  367. <label class="md-nav__title" for="__nav_3_2">
  368. <span class="md-nav__icon md-icon"></span>
  369. Advanced Templating
  370. </label>
  371. <ul class="md-nav__list" data-md-scrollfix>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating/" class="md-nav__link">
  374. v2
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="../../guides/templating-v1/" class="md-nav__link">
  379. v1
  380. </a>
  381. </li>
  382. </ul>
  383. </nav>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/generator/" class="md-nav__link">
  387. Generators
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  392. All keys, One secret
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  397. Common K8S Secret Types
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/controller-class/" class="md-nav__link">
  402. Controller Classes
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  407. Lifecycle: ownership & deletion
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  412. Decoding Strategies
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/getallsecrets/" class="md-nav__link">
  417. Getting Multiple Secrets
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  422. Multi Tenancy
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  427. Rewriting Keys
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/v1beta1/" class="md-nav__link">
  432. Upgrading to v1beta1
  433. </a>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="../../guides/using-latest-image/" class="md-nav__link">
  437. Using Latest Image
  438. </a>
  439. </li>
  440. <li class="md-nav__item">
  441. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  442. Disable Cluster Features
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item md-nav__item--nested">
  449. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  450. <label class="md-nav__link" for="__nav_4">
  451. Provider
  452. <span class="md-nav__icon md-icon"></span>
  453. </label>
  454. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  455. <label class="md-nav__title" for="__nav_4">
  456. <span class="md-nav__icon md-icon"></span>
  457. Provider
  458. </label>
  459. <ul class="md-nav__list" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  462. AWS Secrets Manager
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  467. AWS Parameter Store
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  472. Azure Key Vault
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  477. Google Secret Manager
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  482. IBM Secrets Manager
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../../provider/akeyless/" class="md-nav__link">
  487. Akeyless
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  492. HashiCorp Vault
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  497. Yandex Certificate Manager
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  502. Yandex Lockbox
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  507. Gitlab Variables
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../../provider/oracle-vault/" class="md-nav__link">
  512. Oracle Vault
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../provider/1password-automation/" class="md-nav__link">
  517. 1Password Secrets Automation
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../../provider/webhook/" class="md-nav__link">
  522. Webhook
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../provider/fake/" class="md-nav__link">
  527. Fake
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../provider/kubernetes/" class="md-nav__link">
  532. Kubernetes
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  537. senhasegura DevOps Secrets Management (DSM)
  538. </a>
  539. </li>
  540. <li class="md-nav__item">
  541. <a href="../../provider/doppler/" class="md-nav__link">
  542. Doppler
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../../provider/keeper-security/" class="md-nav__link">
  547. Keeper Security
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../../provider/scaleway/" class="md-nav__link">
  552. Scaleway
  553. </a>
  554. </li>
  555. </ul>
  556. </nav>
  557. </li>
  558. <li class="md-nav__item md-nav__item--nested">
  559. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  560. <label class="md-nav__link" for="__nav_5">
  561. Examples
  562. <span class="md-nav__icon md-icon"></span>
  563. </label>
  564. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  565. <label class="md-nav__title" for="__nav_5">
  566. <span class="md-nav__icon md-icon"></span>
  567. Examples
  568. </label>
  569. <ul class="md-nav__list" data-md-scrollfix>
  570. <li class="md-nav__item">
  571. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  572. FluxCD
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  577. Anchore Engine
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  582. Jenkins
  583. </a>
  584. </li>
  585. </ul>
  586. </nav>
  587. </li>
  588. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  589. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  590. <label class="md-nav__link" for="__nav_6">
  591. Community
  592. <span class="md-nav__icon md-icon"></span>
  593. </label>
  594. <nav class="md-nav" aria-label="Community" data-md-level="1">
  595. <label class="md-nav__title" for="__nav_6">
  596. <span class="md-nav__icon md-icon"></span>
  597. Community
  598. </label>
  599. <ul class="md-nav__list" data-md-scrollfix>
  600. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  601. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" checked>
  602. <label class="md-nav__link" for="__nav_6_1">
  603. Contributing
  604. <span class="md-nav__icon md-icon"></span>
  605. </label>
  606. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  607. <label class="md-nav__title" for="__nav_6_1">
  608. <span class="md-nav__icon md-icon"></span>
  609. Contributing
  610. </label>
  611. <ul class="md-nav__list" data-md-scrollfix>
  612. <li class="md-nav__item">
  613. <a href="../devguide/" class="md-nav__link">
  614. Developer guide
  615. </a>
  616. </li>
  617. <li class="md-nav__item md-nav__item--active">
  618. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  619. <label class="md-nav__link md-nav__link--active" for="__toc">
  620. Contributing Process
  621. <span class="md-nav__icon md-icon"></span>
  622. </label>
  623. <a href="./" class="md-nav__link md-nav__link--active">
  624. Contributing Process
  625. </a>
  626. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  627. <label class="md-nav__title" for="__toc">
  628. <span class="md-nav__icon md-icon"></span>
  629. Table of contents
  630. </label>
  631. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  632. <li class="md-nav__item">
  633. <a href="#project-management" class="md-nav__link">
  634. Project Management
  635. </a>
  636. </li>
  637. <li class="md-nav__item">
  638. <a href="#issues" class="md-nav__link">
  639. Issues
  640. </a>
  641. </li>
  642. <li class="md-nav__item">
  643. <a href="#submitting-a-pull-request" class="md-nav__link">
  644. Submitting a Pull Request
  645. </a>
  646. <nav class="md-nav" aria-label="Submitting a Pull Request">
  647. <ul class="md-nav__list">
  648. <li class="md-nav__item">
  649. <a href="#triggering-e2e-tests" class="md-nav__link">
  650. Triggering e2e tests
  651. </a>
  652. <nav class="md-nav" aria-label="Triggering e2e tests">
  653. <ul class="md-nav__list">
  654. <li class="md-nav__item">
  655. <a href="#executing-e2e-tests-locally" class="md-nav__link">
  656. Executing e2e tests locally
  657. </a>
  658. </li>
  659. <li class="md-nav__item">
  660. <a href="#managed-kubernetes-e2e-tests" class="md-nav__link">
  661. Managed Kubernetes e2e tests
  662. </a>
  663. </li>
  664. </ul>
  665. </nav>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="#executing-managed-kubernetes-e2e-tests-locally" class="md-nav__link">
  669. Executing Managed Kubernetes e2e tests locally
  670. </a>
  671. </li>
  672. </ul>
  673. </nav>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="#proposal-process" class="md-nav__link">
  677. Proposal Process
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="#release-planning" class="md-nav__link">
  682. Release Planning
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="#support-questions" class="md-nav__link">
  687. Support &amp; Questions
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="#cutting-releases" class="md-nav__link">
  692. Cutting Releases
  693. </a>
  694. </li>
  695. </ul>
  696. </nav>
  697. </li>
  698. <li class="md-nav__item">
  699. <a href="../release/" class="md-nav__link">
  700. Release Process
  701. </a>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="../coc/" class="md-nav__link">
  705. Code of Conduct
  706. </a>
  707. </li>
  708. <li class="md-nav__item">
  709. <a href="../roadmap/" class="md-nav__link">
  710. Roadmap
  711. </a>
  712. </li>
  713. </ul>
  714. </nav>
  715. </li>
  716. <li class="md-nav__item md-nav__item--nested">
  717. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  718. <label class="md-nav__link" for="__nav_6_2">
  719. External Resources
  720. <span class="md-nav__icon md-icon"></span>
  721. </label>
  722. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  723. <label class="md-nav__title" for="__nav_6_2">
  724. <span class="md-nav__icon md-icon"></span>
  725. External Resources
  726. </label>
  727. <ul class="md-nav__list" data-md-scrollfix>
  728. <li class="md-nav__item">
  729. <a href="../../eso-talks/" class="md-nav__link">
  730. Talks
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="../../eso-demos/" class="md-nav__link">
  735. Demos
  736. </a>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="../../eso-blogs/" class="md-nav__link">
  740. Blogs
  741. </a>
  742. </li>
  743. </ul>
  744. </nav>
  745. </li>
  746. </ul>
  747. </nav>
  748. </li>
  749. </ul>
  750. </nav>
  751. </div>
  752. </div>
  753. </div>
  754. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  755. <div class="md-sidebar__scrollwrap">
  756. <div class="md-sidebar__inner">
  757. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  758. <label class="md-nav__title" for="__toc">
  759. <span class="md-nav__icon md-icon"></span>
  760. Table of contents
  761. </label>
  762. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  763. <li class="md-nav__item">
  764. <a href="#project-management" class="md-nav__link">
  765. Project Management
  766. </a>
  767. </li>
  768. <li class="md-nav__item">
  769. <a href="#issues" class="md-nav__link">
  770. Issues
  771. </a>
  772. </li>
  773. <li class="md-nav__item">
  774. <a href="#submitting-a-pull-request" class="md-nav__link">
  775. Submitting a Pull Request
  776. </a>
  777. <nav class="md-nav" aria-label="Submitting a Pull Request">
  778. <ul class="md-nav__list">
  779. <li class="md-nav__item">
  780. <a href="#triggering-e2e-tests" class="md-nav__link">
  781. Triggering e2e tests
  782. </a>
  783. <nav class="md-nav" aria-label="Triggering e2e tests">
  784. <ul class="md-nav__list">
  785. <li class="md-nav__item">
  786. <a href="#executing-e2e-tests-locally" class="md-nav__link">
  787. Executing e2e tests locally
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="#managed-kubernetes-e2e-tests" class="md-nav__link">
  792. Managed Kubernetes e2e tests
  793. </a>
  794. </li>
  795. </ul>
  796. </nav>
  797. </li>
  798. <li class="md-nav__item">
  799. <a href="#executing-managed-kubernetes-e2e-tests-locally" class="md-nav__link">
  800. Executing Managed Kubernetes e2e tests locally
  801. </a>
  802. </li>
  803. </ul>
  804. </nav>
  805. </li>
  806. <li class="md-nav__item">
  807. <a href="#proposal-process" class="md-nav__link">
  808. Proposal Process
  809. </a>
  810. </li>
  811. <li class="md-nav__item">
  812. <a href="#release-planning" class="md-nav__link">
  813. Release Planning
  814. </a>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="#support-questions" class="md-nav__link">
  818. Support &amp; Questions
  819. </a>
  820. </li>
  821. <li class="md-nav__item">
  822. <a href="#cutting-releases" class="md-nav__link">
  823. Cutting Releases
  824. </a>
  825. </li>
  826. </ul>
  827. </nav>
  828. </div>
  829. </div>
  830. </div>
  831. <div class="md-content" data-md-component="content">
  832. <article class="md-content__inner md-typeset">
  833. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/contributing/process.md" title="Edit this page" class="md-content__button md-icon">
  834. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  835. </a>
  836. <h1>Contributing Process</h1>
  837. <h2 id="project-management">Project Management</h2>
  838. <p>The Code, our TODOs and Documentation is maintained on
  839. <a href="https://github.com/external-secrets/external-secrets">GitHub</a>. All Issues
  840. should be opened in that repository.
  841. We have a <a href="../roadmap/">Roadmap</a> to track progress for our road towards GA.</p>
  842. <h2 id="issues">Issues</h2>
  843. <p>Features, bugs and any issues regarding the documentation should be filed as
  844. <a href="https://github.com/external-secrets/external-secrets/issues">GitHub Issue</a> in
  845. our repository. We use labels like <code>kind/feature</code>, <code>kind/bug</code>, <code>area/aws</code> to
  846. organize the issues. Issues labeled <code>good first issue</code> and <code>help wanted</code> are
  847. especially good for a first contribution. If you want to pick up an issue just
  848. leave a comment.</p>
  849. <h2 id="submitting-a-pull-request">Submitting a Pull Request</h2>
  850. <p>This project uses the well-known pull request process from GitHub. To submit a
  851. pull request, fork the repository and push any changes to a branch on the copy,
  852. from there a pull request can be made in the main repo. Merging a pull request
  853. requires the following steps to be completed before the pull request will
  854. be merged:</p>
  855. <ul>
  856. <li>ideally, there is an issue that documents the problem or feature in depth.</li>
  857. <li>code must have a reasonable amount of test coverage</li>
  858. <li>tests must pass</li>
  859. <li>PR needs be reviewed and approved</li>
  860. </ul>
  861. <p>Once these steps are completed the PR will be merged by a code owner.
  862. We're using the pull request <code>assignee</code> feature to track who is responsible
  863. for the lifecycle of the PR: review, merging, ping on inactivity, close.
  864. We close pull requests or issues if there is no response from the author for
  865. a period of time. Feel free to reopen if you want to get back on it.</p>
  866. <h3 id="triggering-e2e-tests">Triggering e2e tests</h3>
  867. <p>We have an extensive set of e2e tests that test the integration with <em>real</em> cloud provider APIs.
  868. 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>
  869. <div class="highlight"><pre><span></span><code>/ok-to-test sha=xxxxxx
  870. </code></pre></div>
  871. <h4 id="executing-e2e-tests-locally">Executing e2e tests locally</h4>
  872. <p>You have to prepare your shell environment with the necessary variables so the e2e test
  873. runner knows what credentials to use. See <code>e2e/run.sh</code> for the variables that are passed in.
  874. If you e.g. want to test AWS integration make sure set all <code>AWS_*</code> variables mentioned
  875. in that file.</p>
  876. <p>Use <a href="https://onsi.github.io/ginkgo/#spec-labels">ginkgo labels</a> to select the tests
  877. you want to execute. You have to specify <code>!managed</code> to ensure that you do not
  878. run managed tests.</p>
  879. <div class="highlight"><pre><span></span><code>make test.e2e GINKGO_LABELS=&#39;gcp&amp;&amp;!managed&#39;
  880. </code></pre></div>
  881. <h4 id="managed-kubernetes-e2e-tests">Managed Kubernetes e2e tests</h4>
  882. <p>There's another suite of e2e tests that integrate with managed Kubernetes offerings.
  883. They create real infrastructure at a cloud provider and deploy the controller
  884. into that environment.
  885. This is necessary to test the authentication integration
  886. (<a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">GCP Workload Identity</a>,
  887. <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">EKS IRSA</a>...).</p>
  888. <p>These tests are time intensive (~20-45min) and must be triggered manually by
  889. a maintainer when a particular provider or authentication mechanism was changed:</p>
  890. <div class="highlight"><pre><span></span><code>/ok-to-test-managed sha=xxxxxx provider=aws
  891. # or
  892. /ok-to-test-managed sha=xxxxxx provider=gcp
  893. </code></pre></div>
  894. <p>Both tests can run in parallel. Once started they add a dynamic GitHub check <code>integration-managed-(gcp|aws)</code> to the PR that triggered the test.</p>
  895. <h3 id="executing-managed-kubernetes-e2e-tests-locally">Executing Managed Kubernetes e2e tests locally</h3>
  896. <p>You have to prepare your shell environment with the necessary variables so the e2e
  897. test runner knows what credentials to use. See <code>.github/workflows/e2e-managed.yml</code>
  898. for the variables that are passed in. If you e.g. want to test AWS integration make
  899. sure set all variables containing <code>AWS_*</code> and <code>TF_VAR_AWS_*</code> mentioned in that file.</p>
  900. <p>Then execute <code>tf.apply.aws</code> or <code>tf.apply.gcp</code> to create the infrastructure.</p>
  901. <div class="highlight"><pre><span></span><code>make tf.apply.aws
  902. </code></pre></div>
  903. <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>
  904. <p>You also have to setup a proper Kubeconfig so the e2e test pod gets deployed into the managed cluster.</p>
  905. <div class="highlight"><pre><span></span><code>aws eks update-kubeconfig --name ${AWS_CLUSTER_NAME}
  906. or
  907. gcloud container clusters get-credentials ${GCP_GKE_CLUSTER} --region europe-west1-b
  908. </code></pre></div>
  909. <p>Use <a href="https://onsi.github.io/ginkgo/#spec-labels">ginkgo labels</a> to select the tests
  910. you want to execute.</p>
  911. <div class="highlight"><pre><span></span><code># you may have to set IMAGE_NAME=docker.io/your-user/external-secrets
  912. make test.e2e.managed GINKGO_LABELS=&#39;gcp&#39;
  913. </code></pre></div>
  914. <h2 id="proposal-process">Proposal Process</h2>
  915. <p>Before we introduce significant changes to the project we want to gather feedback
  916. from the community to ensure that we progress in the right direction before we
  917. develop and release big changes. Significant changes include for example:</p>
  918. <ul>
  919. <li>creating new custom resources</li>
  920. <li>proposing breaking changes</li>
  921. <li>changing the behavior of the controller significantly</li>
  922. </ul>
  923. <p>Please create a document in the <code>design/</code> directory based on the template <code>000-template.md</code>
  924. 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>
  925. <h2 id="release-planning">Release Planning</h2>
  926. <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>
  927. <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>
  928. <ol>
  929. <li>assign new issues to the GH Project</li>
  930. <li>add a milestone if needed</li>
  931. <li>add appropriate labels</li>
  932. </ol>
  933. <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>
  934. <h2 id="support-questions">Support &amp; Questions</h2>
  935. <p>Providing support to end users is an important and difficult task.
  936. We have three different channels through which support questions arise:</p>
  937. <ol>
  938. <li>Kubernetes Slack <a href="https://kubernetes.slack.com/archives/C017BF84G2Y">#external-secrets</a></li>
  939. <li><a href="https://github.com/external-secrets/external-secrets/discussions">GitHub Discussions</a></li>
  940. <li>GitHub Issues</li>
  941. </ol>
  942. <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>
  943. <ul>
  944. <li><code>triage/needs-information</code>: Indicates an issue needs more information in order to work on it.</li>
  945. <li><code>triage/not-reproducible</code>: Indicates an issue can not be reproduced as described.</li>
  946. <li><code>triage/support</code>: Indicates an issue that is a support question.</li>
  947. </ul>
  948. <h2 id="cutting-releases">Cutting Releases</h2>
  949. <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>
  950. </article>
  951. </div>
  952. </div>
  953. </main>
  954. <footer class="md-footer">
  955. <nav class="md-footer__inner md-grid" aria-label="Footer">
  956. <a href="../devguide/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Developer guide" rel="prev">
  957. <div class="md-footer__button md-icon">
  958. <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>
  959. </div>
  960. <div class="md-footer__title">
  961. <div class="md-ellipsis">
  962. <span class="md-footer__direction">
  963. Previous
  964. </span>
  965. Developer guide
  966. </div>
  967. </div>
  968. </a>
  969. <a href="../release/" class="md-footer__link md-footer__link--next" aria-label="Next: Release Process" rel="next">
  970. <div class="md-footer__title">
  971. <div class="md-ellipsis">
  972. <span class="md-footer__direction">
  973. Next
  974. </span>
  975. Release Process
  976. </div>
  977. </div>
  978. <div class="md-footer__button md-icon">
  979. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  980. </div>
  981. </a>
  982. </nav>
  983. <div class="md-footer-meta md-typeset">
  984. <div class="md-footer-meta__inner md-grid">
  985. <div class="md-copyright">
  986. <div class="md-copyright__highlight">
  987. &copy; 2023 The external-secrets Authors.<br/>
  988. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  989. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  990. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  991. </div>
  992. Made with
  993. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  994. Material for MkDocs
  995. </a>
  996. </div>
  997. </div>
  998. </div>
  999. </footer>
  1000. </div>
  1001. <div class="md-dialog" data-md-component="dialog">
  1002. <div class="md-dialog__inner md-typeset"></div>
  1003. </div>
  1004. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  1005. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  1006. </body>
  1007. </html>