index.html 42 KB

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