index.html 63 KB

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