index.html 54 KB

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