index.html 45 KB

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