index.html 51 KB

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