index.html 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934
  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. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../guides-getallsecrets/" class="md-nav__link">
  242. Getting Multiple Secrets
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../guides-multi-tenancy/" class="md-nav__link">
  247. Multi Tenancy
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../guides-metrics/" class="md-nav__link">
  252. Metrics
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../guides-v1beta1/" class="md-nav__link">
  257. Upgrading to v1beta1
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="../guides-using-latest-image/" class="md-nav__link">
  262. Using Latest Image
  263. </a>
  264. </li>
  265. </ul>
  266. </nav>
  267. </li>
  268. <li class="md-nav__item md-nav__item--nested">
  269. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  270. <label class="md-nav__link" for="__nav_5">
  271. Provider
  272. <span class="md-nav__icon md-icon"></span>
  273. </label>
  274. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  275. <label class="md-nav__title" for="__nav_5">
  276. <span class="md-nav__icon md-icon"></span>
  277. Provider
  278. </label>
  279. <ul class="md-nav__list" data-md-scrollfix>
  280. <li class="md-nav__item md-nav__item--nested">
  281. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  282. <label class="md-nav__link" for="__nav_5_1">
  283. AWS
  284. <span class="md-nav__icon md-icon"></span>
  285. </label>
  286. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  287. <label class="md-nav__title" for="__nav_5_1">
  288. <span class="md-nav__icon md-icon"></span>
  289. AWS
  290. </label>
  291. <ul class="md-nav__list" data-md-scrollfix>
  292. <li class="md-nav__item">
  293. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  294. Secrets Manager
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  299. Parameter Store
  300. </a>
  301. </li>
  302. </ul>
  303. </nav>
  304. </li>
  305. <li class="md-nav__item md-nav__item--nested">
  306. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  307. <label class="md-nav__link" for="__nav_5_2">
  308. Azure
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_5_2">
  313. <span class="md-nav__icon md-icon"></span>
  314. Azure
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../provider-azure-key-vault/" class="md-nav__link">
  319. Key Vault
  320. </a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </li>
  325. <li class="md-nav__item md-nav__item--nested">
  326. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  327. <label class="md-nav__link" for="__nav_5_3">
  328. Google
  329. <span class="md-nav__icon md-icon"></span>
  330. </label>
  331. <nav class="md-nav" aria-label="Google" data-md-level="2">
  332. <label class="md-nav__title" for="__nav_5_3">
  333. <span class="md-nav__icon md-icon"></span>
  334. Google
  335. </label>
  336. <ul class="md-nav__list" data-md-scrollfix>
  337. <li class="md-nav__item">
  338. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  339. Secret Manager
  340. </a>
  341. </li>
  342. </ul>
  343. </nav>
  344. </li>
  345. <li class="md-nav__item md-nav__item--nested">
  346. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  347. <label class="md-nav__link" for="__nav_5_4">
  348. IBM
  349. <span class="md-nav__icon md-icon"></span>
  350. </label>
  351. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  352. <label class="md-nav__title" for="__nav_5_4">
  353. <span class="md-nav__icon md-icon"></span>
  354. IBM
  355. </label>
  356. <ul class="md-nav__list" data-md-scrollfix>
  357. <li class="md-nav__item">
  358. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  359. Secrets Manager
  360. </a>
  361. </li>
  362. </ul>
  363. </nav>
  364. </li>
  365. <li class="md-nav__item">
  366. <a href="../provider-akeyless/" class="md-nav__link">
  367. Akeyless
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  372. HashiCorp Vault
  373. </a>
  374. </li>
  375. <li class="md-nav__item md-nav__item--nested">
  376. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  377. <label class="md-nav__link" for="__nav_5_7">
  378. Yandex
  379. <span class="md-nav__icon md-icon"></span>
  380. </label>
  381. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  382. <label class="md-nav__title" for="__nav_5_7">
  383. <span class="md-nav__icon md-icon"></span>
  384. Yandex
  385. </label>
  386. <ul class="md-nav__list" data-md-scrollfix>
  387. <li class="md-nav__item">
  388. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  389. Certificate Manager
  390. </a>
  391. </li>
  392. <li class="md-nav__item">
  393. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  394. Lockbox
  395. </a>
  396. </li>
  397. </ul>
  398. </nav>
  399. </li>
  400. <li class="md-nav__item md-nav__item--nested">
  401. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  402. <label class="md-nav__link" for="__nav_5_8">
  403. Gitlab
  404. <span class="md-nav__icon md-icon"></span>
  405. </label>
  406. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  407. <label class="md-nav__title" for="__nav_5_8">
  408. <span class="md-nav__icon md-icon"></span>
  409. Gitlab
  410. </label>
  411. <ul class="md-nav__list" data-md-scrollfix>
  412. <li class="md-nav__item">
  413. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  414. Gitlab Project Variables
  415. </a>
  416. </li>
  417. </ul>
  418. </nav>
  419. </li>
  420. <li class="md-nav__item md-nav__item--nested">
  421. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  422. <label class="md-nav__link" for="__nav_5_9">
  423. Oracle
  424. <span class="md-nav__icon md-icon"></span>
  425. </label>
  426. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  427. <label class="md-nav__title" for="__nav_5_9">
  428. <span class="md-nav__icon md-icon"></span>
  429. Oracle
  430. </label>
  431. <ul class="md-nav__list" data-md-scrollfix>
  432. <li class="md-nav__item">
  433. <a href="../provider-oracle-vault/" class="md-nav__link">
  434. Oracle Vault
  435. </a>
  436. </li>
  437. </ul>
  438. </nav>
  439. </li>
  440. <li class="md-nav__item md-nav__item--nested">
  441. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  442. <label class="md-nav__link" for="__nav_5_10">
  443. 1Password
  444. <span class="md-nav__icon md-icon"></span>
  445. </label>
  446. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  447. <label class="md-nav__title" for="__nav_5_10">
  448. <span class="md-nav__icon md-icon"></span>
  449. 1Password
  450. </label>
  451. <ul class="md-nav__list" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="../provider-1password-automation/" class="md-nav__link">
  454. Secrets Automation
  455. </a>
  456. </li>
  457. </ul>
  458. </nav>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../provider-webhook/" class="md-nav__link">
  462. Webhook
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../provider-fake/" class="md-nav__link">
  467. Fake
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../provider-kubernetes/" class="md-nav__link">
  472. Kubernetes
  473. </a>
  474. </li>
  475. <li class="md-nav__item md-nav__item--nested">
  476. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  477. <label class="md-nav__link" for="__nav_5_14">
  478. senhasegura
  479. <span class="md-nav__icon md-icon"></span>
  480. </label>
  481. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  482. <label class="md-nav__title" for="__nav_5_14">
  483. <span class="md-nav__icon md-icon"></span>
  484. senhasegura
  485. </label>
  486. <ul class="md-nav__list" data-md-scrollfix>
  487. <li class="md-nav__item">
  488. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  489. DevOps Secrets Management (DSM)
  490. </a>
  491. </li>
  492. </ul>
  493. </nav>
  494. </li>
  495. </ul>
  496. </nav>
  497. </li>
  498. <li class="md-nav__item md-nav__item--nested">
  499. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  500. <label class="md-nav__link" for="__nav_6">
  501. Examples
  502. <span class="md-nav__icon md-icon"></span>
  503. </label>
  504. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  505. <label class="md-nav__title" for="__nav_6">
  506. <span class="md-nav__icon md-icon"></span>
  507. Examples
  508. </label>
  509. <ul class="md-nav__list" data-md-scrollfix>
  510. <li class="md-nav__item">
  511. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  512. FluxCD
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  517. Anchore Engine
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  522. Jenkins
  523. </a>
  524. </li>
  525. </ul>
  526. </nav>
  527. </li>
  528. <li class="md-nav__item md-nav__item--nested">
  529. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  530. <label class="md-nav__link" for="__nav_7">
  531. External Resources
  532. <span class="md-nav__icon md-icon"></span>
  533. </label>
  534. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  535. <label class="md-nav__title" for="__nav_7">
  536. <span class="md-nav__icon md-icon"></span>
  537. External Resources
  538. </label>
  539. <ul class="md-nav__list" data-md-scrollfix>
  540. <li class="md-nav__item">
  541. <a href="../eso-talks/" class="md-nav__link">
  542. Talks
  543. </a>
  544. </li>
  545. <li class="md-nav__item">
  546. <a href="../eso-demos/" class="md-nav__link">
  547. Demos
  548. </a>
  549. </li>
  550. <li class="md-nav__item">
  551. <a href="../eso-blogs/" class="md-nav__link">
  552. Blogs
  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_8" type="checkbox" id="__nav_8" >
  560. <label class="md-nav__link" for="__nav_8">
  561. References
  562. <span class="md-nav__icon md-icon"></span>
  563. </label>
  564. <nav class="md-nav" aria-label="References" data-md-level="1">
  565. <label class="md-nav__title" for="__nav_8">
  566. <span class="md-nav__icon md-icon"></span>
  567. References
  568. </label>
  569. <ul class="md-nav__list" data-md-scrollfix>
  570. <li class="md-nav__item">
  571. <a href="../spec/" class="md-nav__link">
  572. API specification
  573. </a>
  574. </li>
  575. </ul>
  576. </nav>
  577. </li>
  578. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  579. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" checked>
  580. <label class="md-nav__link" for="__nav_9">
  581. Contributing
  582. <span class="md-nav__icon md-icon"></span>
  583. </label>
  584. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  585. <label class="md-nav__title" for="__nav_9">
  586. <span class="md-nav__icon md-icon"></span>
  587. Contributing
  588. </label>
  589. <ul class="md-nav__list" data-md-scrollfix>
  590. <li class="md-nav__item">
  591. <a href="../contributing-devguide/" class="md-nav__link">
  592. Developer guide
  593. </a>
  594. </li>
  595. <li class="md-nav__item md-nav__item--active">
  596. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  597. <label class="md-nav__link md-nav__link--active" for="__toc">
  598. Contributing Process
  599. <span class="md-nav__icon md-icon"></span>
  600. </label>
  601. <a href="./" class="md-nav__link md-nav__link--active">
  602. Contributing Process
  603. </a>
  604. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  605. <label class="md-nav__title" for="__toc">
  606. <span class="md-nav__icon md-icon"></span>
  607. Table of contents
  608. </label>
  609. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  610. <li class="md-nav__item">
  611. <a href="#project-management" class="md-nav__link">
  612. Project Management
  613. </a>
  614. </li>
  615. <li class="md-nav__item">
  616. <a href="#issues" class="md-nav__link">
  617. Issues
  618. </a>
  619. </li>
  620. <li class="md-nav__item">
  621. <a href="#submitting-a-pull-request" class="md-nav__link">
  622. Submitting a Pull Request
  623. </a>
  624. <nav class="md-nav" aria-label="Submitting a Pull Request">
  625. <ul class="md-nav__list">
  626. <li class="md-nav__item">
  627. <a href="#triggering-e2e-tests" class="md-nav__link">
  628. Triggering e2e tests
  629. </a>
  630. <nav class="md-nav" aria-label="Triggering e2e tests">
  631. <ul class="md-nav__list">
  632. <li class="md-nav__item">
  633. <a href="#executing-e2e-tests-locally" class="md-nav__link">
  634. Executing e2e tests locally
  635. </a>
  636. </li>
  637. <li class="md-nav__item">
  638. <a href="#managed-kubernetes-e2e-tests" class="md-nav__link">
  639. Managed Kubernetes e2e tests
  640. </a>
  641. </li>
  642. </ul>
  643. </nav>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="#executing-managed-kubernetes-e2e-tests-locally" class="md-nav__link">
  647. Executing Managed Kubernetes e2e tests locally
  648. </a>
  649. </li>
  650. </ul>
  651. </nav>
  652. </li>
  653. <li class="md-nav__item">
  654. <a href="#proposal-process" class="md-nav__link">
  655. Proposal Process
  656. </a>
  657. </li>
  658. <li class="md-nav__item">
  659. <a href="#release-planning" class="md-nav__link">
  660. Release Planning
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="#support-questions" class="md-nav__link">
  665. Support &amp; Questions
  666. </a>
  667. </li>
  668. <li class="md-nav__item">
  669. <a href="#cutting-releases" class="md-nav__link">
  670. Cutting Releases
  671. </a>
  672. </li>
  673. </ul>
  674. </nav>
  675. </li>
  676. <li class="md-nav__item">
  677. <a href="../contributing-release/" class="md-nav__link">
  678. Release Process
  679. </a>
  680. </li>
  681. <li class="md-nav__item">
  682. <a href="../contributing-coc/" class="md-nav__link">
  683. Code of Conduct
  684. </a>
  685. </li>
  686. </ul>
  687. </nav>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="../roadmap/" class="md-nav__link">
  691. Roadmap
  692. </a>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="../faq/" class="md-nav__link">
  696. FAQ
  697. </a>
  698. </li>
  699. <li class="md-nav__item">
  700. <a href="../stability-support/" class="md-nav__link">
  701. Stability and Support
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="../deprecation-policy/" class="md-nav__link">
  706. Deprecation Policy
  707. </a>
  708. </li>
  709. </ul>
  710. </nav>
  711. </div>
  712. </div>
  713. </div>
  714. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  715. <div class="md-sidebar__scrollwrap">
  716. <div class="md-sidebar__inner">
  717. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  718. <label class="md-nav__title" for="__toc">
  719. <span class="md-nav__icon md-icon"></span>
  720. Table of contents
  721. </label>
  722. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  723. <li class="md-nav__item">
  724. <a href="#project-management" class="md-nav__link">
  725. Project Management
  726. </a>
  727. </li>
  728. <li class="md-nav__item">
  729. <a href="#issues" class="md-nav__link">
  730. Issues
  731. </a>
  732. </li>
  733. <li class="md-nav__item">
  734. <a href="#submitting-a-pull-request" class="md-nav__link">
  735. Submitting a Pull Request
  736. </a>
  737. <nav class="md-nav" aria-label="Submitting a Pull Request">
  738. <ul class="md-nav__list">
  739. <li class="md-nav__item">
  740. <a href="#triggering-e2e-tests" class="md-nav__link">
  741. Triggering e2e tests
  742. </a>
  743. <nav class="md-nav" aria-label="Triggering e2e tests">
  744. <ul class="md-nav__list">
  745. <li class="md-nav__item">
  746. <a href="#executing-e2e-tests-locally" class="md-nav__link">
  747. Executing e2e tests locally
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="#managed-kubernetes-e2e-tests" class="md-nav__link">
  752. Managed Kubernetes e2e tests
  753. </a>
  754. </li>
  755. </ul>
  756. </nav>
  757. </li>
  758. <li class="md-nav__item">
  759. <a href="#executing-managed-kubernetes-e2e-tests-locally" class="md-nav__link">
  760. Executing Managed Kubernetes e2e tests locally
  761. </a>
  762. </li>
  763. </ul>
  764. </nav>
  765. </li>
  766. <li class="md-nav__item">
  767. <a href="#proposal-process" class="md-nav__link">
  768. Proposal Process
  769. </a>
  770. </li>
  771. <li class="md-nav__item">
  772. <a href="#release-planning" class="md-nav__link">
  773. Release Planning
  774. </a>
  775. </li>
  776. <li class="md-nav__item">
  777. <a href="#support-questions" class="md-nav__link">
  778. Support &amp; Questions
  779. </a>
  780. </li>
  781. <li class="md-nav__item">
  782. <a href="#cutting-releases" class="md-nav__link">
  783. Cutting Releases
  784. </a>
  785. </li>
  786. </ul>
  787. </nav>
  788. </div>
  789. </div>
  790. </div>
  791. <div class="md-content" data-md-component="content">
  792. <article class="md-content__inner md-typeset">
  793. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/contributing-process.md" title="Edit this page" class="md-content__button md-icon">
  794. <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>
  795. </a>
  796. <h1>Contributing Process</h1>
  797. <h2 id="project-management">Project Management</h2>
  798. <p>The Code, our TODOs and Documentation is maintained on
  799. <a href="https://github.com/external-secrets/external-secrets">GitHub</a>. All Issues
  800. should be opened in that repository.
  801. We have a <a href="../roadmap/">Roadmap</a> to track progress for our road towards GA.</p>
  802. <h2 id="issues">Issues</h2>
  803. <p>Features, bugs and any issues regarding the documentation should be filed as
  804. <a href="https://github.com/external-secrets/external-secrets/issues">GitHub Issue</a> in
  805. our repository. We use labels like <code>kind/feature</code>, <code>kind/bug</code>, <code>area/aws</code> to
  806. organize the issues. Issues labeled <code>good first issue</code> and <code>help wanted</code> are
  807. especially good for a first contribution. If you want to pick up an issue just
  808. leave a comment.</p>
  809. <h2 id="submitting-a-pull-request">Submitting a Pull Request</h2>
  810. <p>This project uses the well-known pull request process from GitHub. To submit a
  811. pull request, fork the repository and push any changes to a branch on the copy,
  812. from there a pull request can be made in the main repo. Merging a pull request
  813. requires the following steps to be completed before the pull request will
  814. be merged:</p>
  815. <ul>
  816. <li>ideally, there is an issue that documents the problem or feature in depth.</li>
  817. <li>code must have a reasonable amount of test coverage</li>
  818. <li>tests must pass</li>
  819. <li>PR needs be reviewed and approved</li>
  820. </ul>
  821. <p>Once these steps are completed the PR will be merged by a code owner.
  822. We're using the pull request <code>assignee</code> feature to track who is responsible
  823. for the lifecycle of the PR: review, merging, ping on inactivity, close.
  824. We close pull requests or issues if there is no response from the author for
  825. a period of time. Feel free to reopen if you want to get back on it.</p>
  826. <h3 id="triggering-e2e-tests">Triggering e2e tests</h3>
  827. <p>We have an extensive set of e2e tests that test the integration with <em>real</em> cloud provider APIs.
  828. 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>
  829. <div class="highlight"><pre><span></span><code>/ok-to-test sha=xxxxxx
  830. </code></pre></div>
  831. <h4 id="executing-e2e-tests-locally">Executing e2e tests locally</h4>
  832. <p>You have to prepare your shell environment with the necessary variables so the e2e test
  833. runner knows what credentials to use. See <code>e2e/run.sh</code> for the variables that are passed in.
  834. If you e.g. want to test AWS integration make sure set all <code>AWS_*</code> variables mentioned
  835. in that file.</p>
  836. <p>Use <a href="https://onsi.github.io/ginkgo/#spec-labels">ginkgo labels</a> to select the tests
  837. you want to execute. You have to specify <code>!managed</code> to ensure that you do not
  838. run managed tests.</p>
  839. <div class="highlight"><pre><span></span><code>make test.e2e GINKGO_LABELS=&#39;gcp&amp;&amp;!managed&#39;
  840. </code></pre></div>
  841. <h4 id="managed-kubernetes-e2e-tests">Managed Kubernetes e2e tests</h4>
  842. <p>There's another suite of e2e tests that integrate with managed Kuberentes offerings.
  843. They create real infrastructure at a cloud provider and deploy the controller
  844. into that environment.
  845. This is necessary to test the authentication integration
  846. (<a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">GCP Workload Identity</a>,
  847. <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">EKS IRSA</a>...).</p>
  848. <p>These tests are time intensive (~20-45min) and must be triggered manually by
  849. a maintainer when a particular provider or authentication mechanism was changed:</p>
  850. <div class="highlight"><pre><span></span><code>/ok-to-test-managed sha=xxxxxx provider=aws
  851. # or
  852. /ok-to-test-managed sha=xxxxxx provider=gcp
  853. </code></pre></div>
  854. <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>
  855. <h3 id="executing-managed-kubernetes-e2e-tests-locally">Executing Managed Kubernetes e2e tests locally</h3>
  856. <p>You have to prepare your shell environment with the necessary variables so the e2e
  857. test runner knows what credentials to use. See <code>.github/workflows/e2e-managed.yml</code>
  858. for the variables that are passed in. If you e.g. want to test AWS integration make
  859. sure set all variables containing <code>AWS_*</code> and <code>TF_VAR_AWS_*</code> mentioned in that file.</p>
  860. <p>Then execute <code>tf.apply.aws</code> or <code>tf.apply.gcp</code> to create the infrastructure.</p>
  861. <div class="highlight"><pre><span></span><code>make tf.apply.aws
  862. </code></pre></div>
  863. <p>Then run the <code>managed</code> testsuite. You will need push permissions to the external-secrets ghcr repository. You can set <code>IMAGE_REGISTRY</code> to control which image registry is used to store the controller and e2e test images in.</p>
  864. <p>You also have to setup a proper Kubeconfig so the e2e test pod gets deployed into the managed cluster.</p>
  865. <div class="highlight"><pre><span></span><code>aws eks update-kubeconfig --name ${AWS_CLUSTER_NAME}
  866. or
  867. gcloud container clusters get-credentials ${GCP_GKE_CLUSTER} --region europe-west1-b
  868. </code></pre></div>
  869. <p>Use <a href="https://onsi.github.io/ginkgo/#spec-labels">ginkgo labels</a> to select the tests
  870. you want to execute.</p>
  871. <div class="highlight"><pre><span></span><code># you may have to set IMAGE_REGISTRY=docker.io/your-user/external-secrets
  872. make test.e2e.managed GINKGO_LABELS=&#39;gcp&#39;
  873. </code></pre></div>
  874. <h2 id="proposal-process">Proposal Process</h2>
  875. <p>Before we introduce significant changes to the project we want to gather feedback
  876. from the community to ensure that we progress in the right direction before we
  877. develop and release big changes. Significant changes include for example:</p>
  878. <ul>
  879. <li>creating new custom resources</li>
  880. <li>proposing breaking changes</li>
  881. <li>changing the behavior of the controller significantly</li>
  882. </ul>
  883. <p>Please create a document in the <code>design/</code> directory based on the template <code>000-template.md</code>
  884. 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>
  885. <h2 id="release-planning">Release Planning</h2>
  886. <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>
  887. <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>
  888. <ol>
  889. <li>assign new issues to the GH Project</li>
  890. <li>add a milestone if needed</li>
  891. <li>add appropriate labels</li>
  892. </ol>
  893. <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>
  894. <h2 id="support-questions">Support &amp; Questions</h2>
  895. <p>Providing support to end users is an important and difficult task.
  896. We have three different channels through which support questions arise:</p>
  897. <ol>
  898. <li>Kubernetes Slack <a href="https://kubernetes.slack.com/archives/C017BF84G2Y">#external-secrets</a></li>
  899. <li><a href="https://github.com/external-secrets/external-secrets/discussions">GitHub Discussions</a></li>
  900. <li>GitHub Issues</li>
  901. </ol>
  902. <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>
  903. <ul>
  904. <li><code>triage/needs-information</code>: Indicates an issue needs more information in order to work on it.</li>
  905. <li><code>triage/not-reproducible</code>: Indicates an issue can not be reproduced as described.</li>
  906. <li><code>triage/support</code>: Indicates an issue that is a support question.</li>
  907. </ul>
  908. <h2 id="cutting-releases">Cutting Releases</h2>
  909. <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="../contributing-release/">release</a> page.</p>
  910. </article>
  911. </div>
  912. </div>
  913. </main>
  914. <footer class="md-footer">
  915. <nav class="md-footer__inner md-grid" aria-label="Footer">
  916. <a href="../contributing-devguide/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Developer guide" rel="prev">
  917. <div class="md-footer__button md-icon">
  918. <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>
  919. </div>
  920. <div class="md-footer__title">
  921. <div class="md-ellipsis">
  922. <span class="md-footer__direction">
  923. Previous
  924. </span>
  925. Developer guide
  926. </div>
  927. </div>
  928. </a>
  929. <a href="../contributing-release/" class="md-footer__link md-footer__link--next" aria-label="Next: Release Process" rel="next">
  930. <div class="md-footer__title">
  931. <div class="md-ellipsis">
  932. <span class="md-footer__direction">
  933. Next
  934. </span>
  935. Release Process
  936. </div>
  937. </div>
  938. <div class="md-footer__button md-icon">
  939. <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>
  940. </div>
  941. </a>
  942. </nav>
  943. <div class="md-footer-meta md-typeset">
  944. <div class="md-footer-meta__inner md-grid">
  945. <div class="md-copyright">
  946. Made with
  947. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  948. Material for MkDocs
  949. </a>
  950. </div>
  951. </div>
  952. </div>
  953. </footer>
  954. </div>
  955. <div class="md-dialog" data-md-component="dialog">
  956. <div class="md-dialog__inner md-typeset"></div>
  957. </div>
  958. <script id="__config" type="application/json">{"base": "..", "features": [], "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>
  959. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  960. </body>
  961. </html>