index.html 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224
  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/password/" class="md-nav__link">
  294. Password
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/fake/" class="md-nav__link">
  299. Fake
  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_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  307. <label class="md-nav__link" for="__nav_2_4">
  308. Reference Docs
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_2_4">
  313. <span class="md-nav__icon md-icon"></span>
  314. Reference Docs
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../../api/spec/" class="md-nav__link">
  319. API specification
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../../api/controller-options/" class="md-nav__link">
  324. Controller Options
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/metrics/" class="md-nav__link">
  329. Metrics
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. </ul>
  336. </nav>
  337. </li>
  338. <li class="md-nav__item md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  340. <label class="md-nav__link" for="__nav_3">
  341. Guides
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  345. <label class="md-nav__title" for="__nav_3">
  346. <span class="md-nav__icon md-icon"></span>
  347. Guides
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="../../guides/introduction/" class="md-nav__link">
  352. Introduction
  353. </a>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  357. <label class="md-nav__link" for="__nav_3_2">
  358. Advanced Templating
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_3_2">
  363. <span class="md-nav__icon md-icon"></span>
  364. Advanced Templating
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../../guides/templating/" class="md-nav__link">
  369. v2
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating-v1/" class="md-nav__link">
  374. v1
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../guides/generator/" class="md-nav__link">
  382. Generators
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  387. All keys, One secret
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  392. Common K8S Secret Types
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/controller-class/" class="md-nav__link">
  397. Controller Classes
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  402. Lifecycle: ownership & deletion
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  407. Decoding Strategies
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/getallsecrets/" class="md-nav__link">
  412. Getting Multiple Secrets
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  417. Multi Tenancy
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  422. Rewriting Keys
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/v1beta1/" class="md-nav__link">
  427. Upgrading to v1beta1
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/using-latest-image/" class="md-nav__link">
  432. Using Latest Image
  433. </a>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. <li class="md-nav__item md-nav__item--nested">
  439. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  440. <label class="md-nav__link" for="__nav_4">
  441. Provider
  442. <span class="md-nav__icon md-icon"></span>
  443. </label>
  444. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  445. <label class="md-nav__title" for="__nav_4">
  446. <span class="md-nav__icon md-icon"></span>
  447. Provider
  448. </label>
  449. <ul class="md-nav__list" data-md-scrollfix>
  450. <li class="md-nav__item">
  451. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  452. AWS Secrets Manager
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  457. AWS Parameter Store
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  462. Azure Key Vault
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  467. Google Secret Manager
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  472. IBM Secrets Manager
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../../provider/akeyless/" class="md-nav__link">
  477. Akeyless
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  482. HashiCorp Vault
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  487. Yandex Certificate Manager
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  492. Yandex Lockbox
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  497. Gitlab Variables
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../../provider/oracle-vault/" class="md-nav__link">
  502. Oracle Vault
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../provider/1password-automation/" class="md-nav__link">
  507. 1Password Secrets Automation
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../../provider/webhook/" class="md-nav__link">
  512. Webhook
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../provider/fake/" class="md-nav__link">
  517. Fake
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../../provider/kubernetes/" class="md-nav__link">
  522. Kubernetes
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  527. senhasegura DevOps Secrets Management (DSM)
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../provider/doppler/" class="md-nav__link">
  532. Doppler
  533. </a>
  534. </li>
  535. </ul>
  536. </nav>
  537. </li>
  538. <li class="md-nav__item md-nav__item--nested">
  539. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  540. <label class="md-nav__link" for="__nav_5">
  541. Examples
  542. <span class="md-nav__icon md-icon"></span>
  543. </label>
  544. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  545. <label class="md-nav__title" for="__nav_5">
  546. <span class="md-nav__icon md-icon"></span>
  547. Examples
  548. </label>
  549. <ul class="md-nav__list" data-md-scrollfix>
  550. <li class="md-nav__item">
  551. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  552. FluxCD
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  557. Anchore Engine
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  562. Jenkins
  563. </a>
  564. </li>
  565. </ul>
  566. </nav>
  567. </li>
  568. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  569. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  570. <label class="md-nav__link" for="__nav_6">
  571. Community
  572. <span class="md-nav__icon md-icon"></span>
  573. </label>
  574. <nav class="md-nav" aria-label="Community" data-md-level="1">
  575. <label class="md-nav__title" for="__nav_6">
  576. <span class="md-nav__icon md-icon"></span>
  577. Community
  578. </label>
  579. <ul class="md-nav__list" data-md-scrollfix>
  580. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  581. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" checked>
  582. <label class="md-nav__link" for="__nav_6_1">
  583. Contributing
  584. <span class="md-nav__icon md-icon"></span>
  585. </label>
  586. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  587. <label class="md-nav__title" for="__nav_6_1">
  588. <span class="md-nav__icon md-icon"></span>
  589. Contributing
  590. </label>
  591. <ul class="md-nav__list" data-md-scrollfix>
  592. <li class="md-nav__item">
  593. <a href="../devguide/" class="md-nav__link">
  594. Developer guide
  595. </a>
  596. </li>
  597. <li class="md-nav__item md-nav__item--active">
  598. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  599. <label class="md-nav__link md-nav__link--active" for="__toc">
  600. Contributing Process
  601. <span class="md-nav__icon md-icon"></span>
  602. </label>
  603. <a href="./" class="md-nav__link md-nav__link--active">
  604. Contributing Process
  605. </a>
  606. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  607. <label class="md-nav__title" for="__toc">
  608. <span class="md-nav__icon md-icon"></span>
  609. Table of contents
  610. </label>
  611. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  612. <li class="md-nav__item">
  613. <a href="#project-management" class="md-nav__link">
  614. Project Management
  615. </a>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="#issues" class="md-nav__link">
  619. Issues
  620. </a>
  621. </li>
  622. <li class="md-nav__item">
  623. <a href="#submitting-a-pull-request" class="md-nav__link">
  624. Submitting a Pull Request
  625. </a>
  626. <nav class="md-nav" aria-label="Submitting a Pull Request">
  627. <ul class="md-nav__list">
  628. <li class="md-nav__item">
  629. <a href="#triggering-e2e-tests" class="md-nav__link">
  630. Triggering e2e tests
  631. </a>
  632. <nav class="md-nav" aria-label="Triggering e2e tests">
  633. <ul class="md-nav__list">
  634. <li class="md-nav__item">
  635. <a href="#executing-e2e-tests-locally" class="md-nav__link">
  636. Executing e2e tests locally
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="#managed-kubernetes-e2e-tests" class="md-nav__link">
  641. Managed Kubernetes e2e tests
  642. </a>
  643. </li>
  644. </ul>
  645. </nav>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="#executing-managed-kubernetes-e2e-tests-locally" class="md-nav__link">
  649. Executing Managed Kubernetes e2e tests locally
  650. </a>
  651. </li>
  652. </ul>
  653. </nav>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="#proposal-process" class="md-nav__link">
  657. Proposal Process
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="#release-planning" class="md-nav__link">
  662. Release Planning
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="#support-questions" class="md-nav__link">
  667. Support &amp; Questions
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="#cutting-releases" class="md-nav__link">
  672. Cutting Releases
  673. </a>
  674. </li>
  675. </ul>
  676. </nav>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../release/" class="md-nav__link">
  680. Release Process
  681. </a>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="../coc/" class="md-nav__link">
  685. Code of Conduct
  686. </a>
  687. </li>
  688. <li class="md-nav__item">
  689. <a href="../roadmap/" class="md-nav__link">
  690. Roadmap
  691. </a>
  692. </li>
  693. </ul>
  694. </nav>
  695. </li>
  696. <li class="md-nav__item md-nav__item--nested">
  697. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  698. <label class="md-nav__link" for="__nav_6_2">
  699. External Resources
  700. <span class="md-nav__icon md-icon"></span>
  701. </label>
  702. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  703. <label class="md-nav__title" for="__nav_6_2">
  704. <span class="md-nav__icon md-icon"></span>
  705. External Resources
  706. </label>
  707. <ul class="md-nav__list" data-md-scrollfix>
  708. <li class="md-nav__item">
  709. <a href="../../eso-talks/" class="md-nav__link">
  710. Talks
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="../../eso-demos/" class="md-nav__link">
  715. Demos
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="../../eso-blogs/" class="md-nav__link">
  720. Blogs
  721. </a>
  722. </li>
  723. </ul>
  724. </nav>
  725. </li>
  726. </ul>
  727. </nav>
  728. </li>
  729. </ul>
  730. </nav>
  731. </div>
  732. </div>
  733. </div>
  734. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  735. <div class="md-sidebar__scrollwrap">
  736. <div class="md-sidebar__inner">
  737. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  738. <label class="md-nav__title" for="__toc">
  739. <span class="md-nav__icon md-icon"></span>
  740. Table of contents
  741. </label>
  742. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  743. <li class="md-nav__item">
  744. <a href="#project-management" class="md-nav__link">
  745. Project Management
  746. </a>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="#issues" class="md-nav__link">
  750. Issues
  751. </a>
  752. </li>
  753. <li class="md-nav__item">
  754. <a href="#submitting-a-pull-request" class="md-nav__link">
  755. Submitting a Pull Request
  756. </a>
  757. <nav class="md-nav" aria-label="Submitting a Pull Request">
  758. <ul class="md-nav__list">
  759. <li class="md-nav__item">
  760. <a href="#triggering-e2e-tests" class="md-nav__link">
  761. Triggering e2e tests
  762. </a>
  763. <nav class="md-nav" aria-label="Triggering e2e tests">
  764. <ul class="md-nav__list">
  765. <li class="md-nav__item">
  766. <a href="#executing-e2e-tests-locally" class="md-nav__link">
  767. Executing e2e tests locally
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="#managed-kubernetes-e2e-tests" class="md-nav__link">
  772. Managed Kubernetes e2e tests
  773. </a>
  774. </li>
  775. </ul>
  776. </nav>
  777. </li>
  778. <li class="md-nav__item">
  779. <a href="#executing-managed-kubernetes-e2e-tests-locally" class="md-nav__link">
  780. Executing Managed Kubernetes e2e tests locally
  781. </a>
  782. </li>
  783. </ul>
  784. </nav>
  785. </li>
  786. <li class="md-nav__item">
  787. <a href="#proposal-process" class="md-nav__link">
  788. Proposal Process
  789. </a>
  790. </li>
  791. <li class="md-nav__item">
  792. <a href="#release-planning" class="md-nav__link">
  793. Release Planning
  794. </a>
  795. </li>
  796. <li class="md-nav__item">
  797. <a href="#support-questions" class="md-nav__link">
  798. Support &amp; Questions
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="#cutting-releases" class="md-nav__link">
  803. Cutting Releases
  804. </a>
  805. </li>
  806. </ul>
  807. </nav>
  808. </div>
  809. </div>
  810. </div>
  811. <div class="md-content" data-md-component="content">
  812. <article class="md-content__inner md-typeset">
  813. <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">
  814. <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>
  815. </a>
  816. <h1>Contributing Process</h1>
  817. <h2 id="project-management">Project Management</h2>
  818. <p>The Code, our TODOs and Documentation is maintained on
  819. <a href="https://github.com/external-secrets/external-secrets">GitHub</a>. All Issues
  820. should be opened in that repository.
  821. We have a <a href="../roadmap/">Roadmap</a> to track progress for our road towards GA.</p>
  822. <h2 id="issues">Issues</h2>
  823. <p>Features, bugs and any issues regarding the documentation should be filed as
  824. <a href="https://github.com/external-secrets/external-secrets/issues">GitHub Issue</a> in
  825. our repository. We use labels like <code>kind/feature</code>, <code>kind/bug</code>, <code>area/aws</code> to
  826. organize the issues. Issues labeled <code>good first issue</code> and <code>help wanted</code> are
  827. especially good for a first contribution. If you want to pick up an issue just
  828. leave a comment.</p>
  829. <h2 id="submitting-a-pull-request">Submitting a Pull Request</h2>
  830. <p>This project uses the well-known pull request process from GitHub. To submit a
  831. pull request, fork the repository and push any changes to a branch on the copy,
  832. from there a pull request can be made in the main repo. Merging a pull request
  833. requires the following steps to be completed before the pull request will
  834. be merged:</p>
  835. <ul>
  836. <li>ideally, there is an issue that documents the problem or feature in depth.</li>
  837. <li>code must have a reasonable amount of test coverage</li>
  838. <li>tests must pass</li>
  839. <li>PR needs be reviewed and approved</li>
  840. </ul>
  841. <p>Once these steps are completed the PR will be merged by a code owner.
  842. We're using the pull request <code>assignee</code> feature to track who is responsible
  843. for the lifecycle of the PR: review, merging, ping on inactivity, close.
  844. We close pull requests or issues if there is no response from the author for
  845. a period of time. Feel free to reopen if you want to get back on it.</p>
  846. <h3 id="triggering-e2e-tests">Triggering e2e tests</h3>
  847. <p>We have an extensive set of e2e tests that test the integration with <em>real</em> cloud provider APIs.
  848. 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>
  849. <div class="highlight"><pre><span></span><code>/ok-to-test sha=xxxxxx
  850. </code></pre></div>
  851. <h4 id="executing-e2e-tests-locally">Executing e2e tests locally</h4>
  852. <p>You have to prepare your shell environment with the necessary variables so the e2e test
  853. runner knows what credentials to use. See <code>e2e/run.sh</code> for the variables that are passed in.
  854. If you e.g. want to test AWS integration make sure set all <code>AWS_*</code> variables mentioned
  855. in that file.</p>
  856. <p>Use <a href="https://onsi.github.io/ginkgo/#spec-labels">ginkgo labels</a> to select the tests
  857. you want to execute. You have to specify <code>!managed</code> to ensure that you do not
  858. run managed tests.</p>
  859. <div class="highlight"><pre><span></span><code>make test.e2e GINKGO_LABELS=&#39;gcp&amp;&amp;!managed&#39;
  860. </code></pre></div>
  861. <h4 id="managed-kubernetes-e2e-tests">Managed Kubernetes e2e tests</h4>
  862. <p>There's another suite of e2e tests that integrate with managed Kuberentes offerings.
  863. They create real infrastructure at a cloud provider and deploy the controller
  864. into that environment.
  865. This is necessary to test the authentication integration
  866. (<a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">GCP Workload Identity</a>,
  867. <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">EKS IRSA</a>...).</p>
  868. <p>These tests are time intensive (~20-45min) and must be triggered manually by
  869. a maintainer when a particular provider or authentication mechanism was changed:</p>
  870. <div class="highlight"><pre><span></span><code>/ok-to-test-managed sha=xxxxxx provider=aws
  871. # or
  872. /ok-to-test-managed sha=xxxxxx provider=gcp
  873. </code></pre></div>
  874. <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>
  875. <h3 id="executing-managed-kubernetes-e2e-tests-locally">Executing Managed Kubernetes e2e tests locally</h3>
  876. <p>You have to prepare your shell environment with the necessary variables so the e2e
  877. test runner knows what credentials to use. See <code>.github/workflows/e2e-managed.yml</code>
  878. for the variables that are passed in. If you e.g. want to test AWS integration make
  879. sure set all variables containing <code>AWS_*</code> and <code>TF_VAR_AWS_*</code> mentioned in that file.</p>
  880. <p>Then execute <code>tf.apply.aws</code> or <code>tf.apply.gcp</code> to create the infrastructure.</p>
  881. <div class="highlight"><pre><span></span><code>make tf.apply.aws
  882. </code></pre></div>
  883. <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>
  884. <p>You also have to setup a proper Kubeconfig so the e2e test pod gets deployed into the managed cluster.</p>
  885. <div class="highlight"><pre><span></span><code>aws eks update-kubeconfig --name ${AWS_CLUSTER_NAME}
  886. or
  887. gcloud container clusters get-credentials ${GCP_GKE_CLUSTER} --region europe-west1-b
  888. </code></pre></div>
  889. <p>Use <a href="https://onsi.github.io/ginkgo/#spec-labels">ginkgo labels</a> to select the tests
  890. you want to execute.</p>
  891. <div class="highlight"><pre><span></span><code># you may have to set IMAGE_NAME=docker.io/your-user/external-secrets
  892. make test.e2e.managed GINKGO_LABELS=&#39;gcp&#39;
  893. </code></pre></div>
  894. <h2 id="proposal-process">Proposal Process</h2>
  895. <p>Before we introduce significant changes to the project we want to gather feedback
  896. from the community to ensure that we progress in the right direction before we
  897. develop and release big changes. Significant changes include for example:</p>
  898. <ul>
  899. <li>creating new custom resources</li>
  900. <li>proposing breaking changes</li>
  901. <li>changing the behavior of the controller significantly</li>
  902. </ul>
  903. <p>Please create a document in the <code>design/</code> directory based on the template <code>000-template.md</code>
  904. 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>
  905. <h2 id="release-planning">Release Planning</h2>
  906. <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>
  907. <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>
  908. <ol>
  909. <li>assign new issues to the GH Project</li>
  910. <li>add a milestone if needed</li>
  911. <li>add appropriate labels</li>
  912. </ol>
  913. <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>
  914. <h2 id="support-questions">Support &amp; Questions</h2>
  915. <p>Providing support to end users is an important and difficult task.
  916. We have three different channels through which support questions arise:</p>
  917. <ol>
  918. <li>Kubernetes Slack <a href="https://kubernetes.slack.com/archives/C017BF84G2Y">#external-secrets</a></li>
  919. <li><a href="https://github.com/external-secrets/external-secrets/discussions">GitHub Discussions</a></li>
  920. <li>GitHub Issues</li>
  921. </ol>
  922. <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>
  923. <ul>
  924. <li><code>triage/needs-information</code>: Indicates an issue needs more information in order to work on it.</li>
  925. <li><code>triage/not-reproducible</code>: Indicates an issue can not be reproduced as described.</li>
  926. <li><code>triage/support</code>: Indicates an issue that is a support question.</li>
  927. </ul>
  928. <h2 id="cutting-releases">Cutting Releases</h2>
  929. <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>
  930. </article>
  931. </div>
  932. </div>
  933. </main>
  934. <footer class="md-footer">
  935. <nav class="md-footer__inner md-grid" aria-label="Footer">
  936. <a href="../devguide/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Developer guide" rel="prev">
  937. <div class="md-footer__button md-icon">
  938. <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>
  939. </div>
  940. <div class="md-footer__title">
  941. <div class="md-ellipsis">
  942. <span class="md-footer__direction">
  943. Previous
  944. </span>
  945. Developer guide
  946. </div>
  947. </div>
  948. </a>
  949. <a href="../release/" class="md-footer__link md-footer__link--next" aria-label="Next: Release Process" rel="next">
  950. <div class="md-footer__title">
  951. <div class="md-ellipsis">
  952. <span class="md-footer__direction">
  953. Next
  954. </span>
  955. Release Process
  956. </div>
  957. </div>
  958. <div class="md-footer__button md-icon">
  959. <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>
  960. </div>
  961. </a>
  962. </nav>
  963. <div class="md-footer-meta md-typeset">
  964. <div class="md-footer-meta__inner md-grid">
  965. <div class="md-copyright">
  966. <div class="md-copyright__highlight">
  967. &copy; 2022 The external-secrets Authors.<br/>
  968. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  969. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  970. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  971. </div>
  972. Made with
  973. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  974. Material for MkDocs
  975. </a>
  976. </div>
  977. </div>
  978. </div>
  979. </footer>
  980. </div>
  981. <div class="md-dialog" data-md-component="dialog">
  982. <div class="md-dialog__inner md-typeset"></div>
  983. </div>
  984. <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>
  985. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  986. </body>
  987. </html>