index.html 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017
  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>Release 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="#release-eso" 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. Release Process
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  106. <div class="md-tabs__inner md-grid">
  107. <ul class="md-tabs__list">
  108. <li class="md-tabs__item">
  109. <a href="../.." class="md-tabs__link">
  110. Introduction
  111. </a>
  112. </li>
  113. <li class="md-tabs__item">
  114. <a href="../../api/components/" class="md-tabs__link">
  115. API
  116. </a>
  117. </li>
  118. <li class="md-tabs__item">
  119. <a href="../../guides/introduction/" class="md-tabs__link">
  120. Guides
  121. </a>
  122. </li>
  123. <li class="md-tabs__item">
  124. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  125. Provider
  126. </a>
  127. </li>
  128. <li class="md-tabs__item">
  129. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  130. Examples
  131. </a>
  132. </li>
  133. <li class="md-tabs__item">
  134. <a href="../devguide/" class="md-tabs__link md-tabs__link--active">
  135. Community
  136. </a>
  137. </li>
  138. </ul>
  139. </div>
  140. </nav>
  141. <main class="md-main" data-md-component="main">
  142. <div class="md-main__inner md-grid">
  143. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  144. <div class="md-sidebar__scrollwrap">
  145. <div class="md-sidebar__inner">
  146. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  147. <label class="md-nav__title" for="__drawer">
  148. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  149. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  150. </a>
  151. External Secrets Operator
  152. </label>
  153. <div class="md-nav__source">
  154. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  155. <div class="md-source__icon md-icon">
  156. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  157. </div>
  158. <div class="md-source__repository">
  159. External Secrets Operator
  160. </div>
  161. </a>
  162. </div>
  163. <ul class="md-nav__list" data-md-scrollfix>
  164. <li class="md-nav__item md-nav__item--nested">
  165. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" data-md-state="indeterminate" type="checkbox" id="__nav_1" checked>
  166. <div class="md-nav__link md-nav__link--index ">
  167. <a href="../..">Introduction</a>
  168. <label for="__nav_1">
  169. <span class="md-nav__icon md-icon"></span>
  170. </label>
  171. </div>
  172. <nav class="md-nav" aria-label="Introduction" data-md-level="1">
  173. <label class="md-nav__title" for="__nav_1">
  174. <span class="md-nav__icon md-icon"></span>
  175. Introduction
  176. </label>
  177. <ul class="md-nav__list" data-md-scrollfix>
  178. <li class="md-nav__item">
  179. <a href="../../introduction/overview/" class="md-nav__link">
  180. Overview
  181. </a>
  182. </li>
  183. <li class="md-nav__item">
  184. <a href="../../introduction/getting-started/" class="md-nav__link">
  185. Getting started
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../../introduction/faq/" class="md-nav__link">
  190. FAQ
  191. </a>
  192. </li>
  193. <li class="md-nav__item">
  194. <a href="../../introduction/stability-support/" class="md-nav__link">
  195. Stability and Support
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  200. Deprecation Policy
  201. </a>
  202. </li>
  203. </ul>
  204. </nav>
  205. </li>
  206. <li class="md-nav__item md-nav__item--nested">
  207. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" data-md-state="indeterminate" type="checkbox" id="__nav_2" checked>
  208. <label class="md-nav__link" for="__nav_2">
  209. API
  210. <span class="md-nav__icon md-icon"></span>
  211. </label>
  212. <nav class="md-nav" aria-label="API" data-md-level="1">
  213. <label class="md-nav__title" for="__nav_2">
  214. <span class="md-nav__icon md-icon"></span>
  215. API
  216. </label>
  217. <ul class="md-nav__list" data-md-scrollfix>
  218. <li class="md-nav__item">
  219. <a href="../../api/components/" class="md-nav__link">
  220. Components
  221. </a>
  222. </li>
  223. <li class="md-nav__item md-nav__item--nested">
  224. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_2" data-md-state="indeterminate" type="checkbox" id="__nav_2_2" checked>
  225. <label class="md-nav__link" for="__nav_2_2">
  226. Core Resources
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. <nav class="md-nav" aria-label="Core Resources" data-md-level="2">
  230. <label class="md-nav__title" for="__nav_2_2">
  231. <span class="md-nav__icon md-icon"></span>
  232. Core Resources
  233. </label>
  234. <ul class="md-nav__list" data-md-scrollfix>
  235. <li class="md-nav__item">
  236. <a href="../../api/externalsecret/" class="md-nav__link">
  237. ExternalSecret
  238. </a>
  239. </li>
  240. <li class="md-nav__item">
  241. <a href="../../api/secretstore/" class="md-nav__link">
  242. SecretStore
  243. </a>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="../../api/clustersecretstore/" class="md-nav__link">
  247. ClusterSecretStore
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  252. ClusterExternalSecret
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="../../api/pushsecret/" class="md-nav__link">
  257. PushSecret
  258. </a>
  259. </li>
  260. </ul>
  261. </nav>
  262. </li>
  263. <li class="md-nav__item md-nav__item--nested">
  264. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" data-md-state="indeterminate" type="checkbox" id="__nav_2_3" checked>
  265. <div class="md-nav__link md-nav__link--index ">
  266. <a href="../../api/generator/">Generators</a>
  267. <label for="__nav_2_3">
  268. <span class="md-nav__icon md-icon"></span>
  269. </label>
  270. </div>
  271. <nav class="md-nav" aria-label="Generators" data-md-level="2">
  272. <label class="md-nav__title" for="__nav_2_3">
  273. <span class="md-nav__icon md-icon"></span>
  274. Generators
  275. </label>
  276. <ul class="md-nav__list" data-md-scrollfix>
  277. <li class="md-nav__item">
  278. <a href="../../api/generator/acr/" class="md-nav__link">
  279. Azure Container Registry
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/generator/ecr/" class="md-nav__link">
  284. AWS Elastic Container Registry
  285. </a>
  286. </li>
  287. <li class="md-nav__item">
  288. <a href="../../api/generator/gcr/" class="md-nav__link">
  289. Google Container Registry
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../../api/generator/password/" class="md-nav__link">
  294. Password
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../../api/generator/fake/" class="md-nav__link">
  299. Fake
  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_2_4" data-md-state="indeterminate" type="checkbox" id="__nav_2_4" checked>
  307. <label class="md-nav__link" for="__nav_2_4">
  308. Reference Docs
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" aria-label="Reference Docs" data-md-level="2">
  312. <label class="md-nav__title" for="__nav_2_4">
  313. <span class="md-nav__icon md-icon"></span>
  314. Reference Docs
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../../api/spec/" class="md-nav__link">
  319. API specification
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../../api/controller-options/" class="md-nav__link">
  324. Controller Options
  325. </a>
  326. </li>
  327. <li class="md-nav__item">
  328. <a href="../../api/metrics/" class="md-nav__link">
  329. Metrics
  330. </a>
  331. </li>
  332. </ul>
  333. </nav>
  334. </li>
  335. </ul>
  336. </nav>
  337. </li>
  338. <li class="md-nav__item md-nav__item--nested">
  339. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" data-md-state="indeterminate" type="checkbox" id="__nav_3" checked>
  340. <label class="md-nav__link" for="__nav_3">
  341. Guides
  342. <span class="md-nav__icon md-icon"></span>
  343. </label>
  344. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  345. <label class="md-nav__title" for="__nav_3">
  346. <span class="md-nav__icon md-icon"></span>
  347. Guides
  348. </label>
  349. <ul class="md-nav__list" data-md-scrollfix>
  350. <li class="md-nav__item">
  351. <a href="../../guides/introduction/" class="md-nav__link">
  352. Introduction
  353. </a>
  354. </li>
  355. <li class="md-nav__item md-nav__item--nested">
  356. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
  357. <label class="md-nav__link" for="__nav_3_2">
  358. Advanced Templating
  359. <span class="md-nav__icon md-icon"></span>
  360. </label>
  361. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  362. <label class="md-nav__title" for="__nav_3_2">
  363. <span class="md-nav__icon md-icon"></span>
  364. Advanced Templating
  365. </label>
  366. <ul class="md-nav__list" data-md-scrollfix>
  367. <li class="md-nav__item">
  368. <a href="../../guides/templating/" class="md-nav__link">
  369. v2
  370. </a>
  371. </li>
  372. <li class="md-nav__item">
  373. <a href="../../guides/templating-v1/" class="md-nav__link">
  374. v1
  375. </a>
  376. </li>
  377. </ul>
  378. </nav>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../guides/generator/" class="md-nav__link">
  382. Generators
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  387. All keys, One secret
  388. </a>
  389. </li>
  390. <li class="md-nav__item">
  391. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  392. Common K8S Secret Types
  393. </a>
  394. </li>
  395. <li class="md-nav__item">
  396. <a href="../../guides/controller-class/" class="md-nav__link">
  397. Controller Classes
  398. </a>
  399. </li>
  400. <li class="md-nav__item">
  401. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  402. Lifecycle: ownership & deletion
  403. </a>
  404. </li>
  405. <li class="md-nav__item">
  406. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  407. Decoding Strategies
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="../../guides/getallsecrets/" class="md-nav__link">
  412. Getting Multiple Secrets
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  417. Multi Tenancy
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  422. Rewriting Keys
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../guides/v1beta1/" class="md-nav__link">
  427. Upgrading to v1beta1
  428. </a>
  429. </li>
  430. <li class="md-nav__item">
  431. <a href="../../guides/using-latest-image/" class="md-nav__link">
  432. Using Latest Image
  433. </a>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. <li class="md-nav__item md-nav__item--nested">
  439. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" data-md-state="indeterminate" type="checkbox" id="__nav_4" checked>
  440. <label class="md-nav__link" for="__nav_4">
  441. Provider
  442. <span class="md-nav__icon md-icon"></span>
  443. </label>
  444. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  445. <label class="md-nav__title" for="__nav_4">
  446. <span class="md-nav__icon md-icon"></span>
  447. Provider
  448. </label>
  449. <ul class="md-nav__list" data-md-scrollfix>
  450. <li class="md-nav__item">
  451. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  452. AWS Secrets Manager
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  457. AWS Parameter Store
  458. </a>
  459. </li>
  460. <li class="md-nav__item">
  461. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  462. Azure Key Vault
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  467. Google Secret Manager
  468. </a>
  469. </li>
  470. <li class="md-nav__item">
  471. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  472. IBM Secrets Manager
  473. </a>
  474. </li>
  475. <li class="md-nav__item">
  476. <a href="../../provider/akeyless/" class="md-nav__link">
  477. Akeyless
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  482. HashiCorp Vault
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  487. Yandex Certificate Manager
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  492. Yandex Lockbox
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  497. Gitlab Variables
  498. </a>
  499. </li>
  500. <li class="md-nav__item">
  501. <a href="../../provider/oracle-vault/" class="md-nav__link">
  502. Oracle Vault
  503. </a>
  504. </li>
  505. <li class="md-nav__item">
  506. <a href="../../provider/1password-automation/" class="md-nav__link">
  507. 1Password Secrets Automation
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="../../provider/webhook/" class="md-nav__link">
  512. Webhook
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../provider/fake/" class="md-nav__link">
  517. Fake
  518. </a>
  519. </li>
  520. <li class="md-nav__item">
  521. <a href="../../provider/kubernetes/" class="md-nav__link">
  522. Kubernetes
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  527. senhasegura DevOps Secrets Management (DSM)
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../provider/doppler/" class="md-nav__link">
  532. Doppler
  533. </a>
  534. </li>
  535. </ul>
  536. </nav>
  537. </li>
  538. <li class="md-nav__item md-nav__item--nested">
  539. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" data-md-state="indeterminate" type="checkbox" id="__nav_5" checked>
  540. <label class="md-nav__link" for="__nav_5">
  541. Examples
  542. <span class="md-nav__icon md-icon"></span>
  543. </label>
  544. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  545. <label class="md-nav__title" for="__nav_5">
  546. <span class="md-nav__icon md-icon"></span>
  547. Examples
  548. </label>
  549. <ul class="md-nav__list" data-md-scrollfix>
  550. <li class="md-nav__item">
  551. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  552. FluxCD
  553. </a>
  554. </li>
  555. <li class="md-nav__item">
  556. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  557. Anchore Engine
  558. </a>
  559. </li>
  560. <li class="md-nav__item">
  561. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  562. Jenkins
  563. </a>
  564. </li>
  565. </ul>
  566. </nav>
  567. </li>
  568. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  569. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
  570. <label class="md-nav__link" for="__nav_6">
  571. Community
  572. <span class="md-nav__icon md-icon"></span>
  573. </label>
  574. <nav class="md-nav" aria-label="Community" data-md-level="1">
  575. <label class="md-nav__title" for="__nav_6">
  576. <span class="md-nav__icon md-icon"></span>
  577. Community
  578. </label>
  579. <ul class="md-nav__list" data-md-scrollfix>
  580. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  581. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" checked>
  582. <label class="md-nav__link" for="__nav_6_1">
  583. Contributing
  584. <span class="md-nav__icon md-icon"></span>
  585. </label>
  586. <nav class="md-nav" aria-label="Contributing" data-md-level="2">
  587. <label class="md-nav__title" for="__nav_6_1">
  588. <span class="md-nav__icon md-icon"></span>
  589. Contributing
  590. </label>
  591. <ul class="md-nav__list" data-md-scrollfix>
  592. <li class="md-nav__item">
  593. <a href="../devguide/" class="md-nav__link">
  594. Developer guide
  595. </a>
  596. </li>
  597. <li class="md-nav__item">
  598. <a href="../process/" class="md-nav__link">
  599. Contributing Process
  600. </a>
  601. </li>
  602. <li class="md-nav__item md-nav__item--active">
  603. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  604. <label class="md-nav__link md-nav__link--active" for="__toc">
  605. Release Process
  606. <span class="md-nav__icon md-icon"></span>
  607. </label>
  608. <a href="./" class="md-nav__link md-nav__link--active">
  609. Release Process
  610. </a>
  611. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  612. <label class="md-nav__title" for="__toc">
  613. <span class="md-nav__icon md-icon"></span>
  614. Table of contents
  615. </label>
  616. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  617. <li class="md-nav__item">
  618. <a href="#release-eso" class="md-nav__link">
  619. Release ESO
  620. </a>
  621. </li>
  622. <li class="md-nav__item">
  623. <a href="#release-helm-chart" class="md-nav__link">
  624. Release Helm Chart
  625. </a>
  626. </li>
  627. <li class="md-nav__item">
  628. <a href="#release-olm-bundle" class="md-nav__link">
  629. Release OLM Bundle
  630. </a>
  631. </li>
  632. </ul>
  633. </nav>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="../coc/" class="md-nav__link">
  637. Code of Conduct
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../roadmap/" class="md-nav__link">
  642. Roadmap
  643. </a>
  644. </li>
  645. </ul>
  646. </nav>
  647. </li>
  648. <li class="md-nav__item md-nav__item--nested">
  649. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" data-md-state="indeterminate" type="checkbox" id="__nav_6_2" checked>
  650. <label class="md-nav__link" for="__nav_6_2">
  651. External Resources
  652. <span class="md-nav__icon md-icon"></span>
  653. </label>
  654. <nav class="md-nav" aria-label="External Resources" data-md-level="2">
  655. <label class="md-nav__title" for="__nav_6_2">
  656. <span class="md-nav__icon md-icon"></span>
  657. External Resources
  658. </label>
  659. <ul class="md-nav__list" data-md-scrollfix>
  660. <li class="md-nav__item">
  661. <a href="../../eso-talks/" class="md-nav__link">
  662. Talks
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../eso-demos/" class="md-nav__link">
  667. Demos
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../../eso-blogs/" class="md-nav__link">
  672. Blogs
  673. </a>
  674. </li>
  675. </ul>
  676. </nav>
  677. </li>
  678. </ul>
  679. </nav>
  680. </li>
  681. </ul>
  682. </nav>
  683. </div>
  684. </div>
  685. </div>
  686. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  687. <div class="md-sidebar__scrollwrap">
  688. <div class="md-sidebar__inner">
  689. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  690. <label class="md-nav__title" for="__toc">
  691. <span class="md-nav__icon md-icon"></span>
  692. Table of contents
  693. </label>
  694. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  695. <li class="md-nav__item">
  696. <a href="#release-eso" class="md-nav__link">
  697. Release ESO
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="#release-helm-chart" class="md-nav__link">
  702. Release Helm Chart
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="#release-olm-bundle" class="md-nav__link">
  707. Release OLM Bundle
  708. </a>
  709. </li>
  710. </ul>
  711. </nav>
  712. </div>
  713. </div>
  714. </div>
  715. <div class="md-content" data-md-component="content">
  716. <article class="md-content__inner md-typeset">
  717. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/contributing/release.md" title="Edit this page" class="md-content__button md-icon">
  718. <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>
  719. </a>
  720. <h1>Release Process</h1>
  721. <p>ESO and the ESO Helm Chart have two distinct lifecycles and can be released independently. Helm Chart releases are named <code>external-secrets-x.y.z</code>.</p>
  722. <p>The external-secrets project is released on a as-needed basis. Feel free to open a issue to request a release.</p>
  723. <h2 id="release-eso">Release ESO</h2>
  724. <ol>
  725. <li>Run <code>Create Release</code> Action to create a new release, pass in the desired version number to release.</li>
  726. <li>GitHub Release, Changelog will be created by the <code>release.yml</code> workflow which also promotes the container image.</li>
  727. <li>update Helm Chart, see below</li>
  728. <li>update OLM bundle, see <a href="https://github.com/external-secrets/external-secrets-helm-operator/blob/main/docs/release.md#operatorhubio">helm-operator docs</a></li>
  729. <li>Announce the new release in the <code>#external-secrets</code> Kubernetes Slack</li>
  730. </ol>
  731. <h2 id="release-helm-chart">Release Helm Chart</h2>
  732. <ol>
  733. <li>Update <code>version</code> and/or <code>appVersion</code> in <code>Chart.yaml</code> and run <code>make helm.docs</code></li>
  734. <li>push to branch and open pr</li>
  735. <li>run <code>/ok-to-test-managed</code> commands for all cloud providers</li>
  736. <li>merge PR if everyhing is green</li>
  737. <li>CI picks up the new chart version and creates a new GitHub Release for it</li>
  738. </ol>
  739. <h2 id="release-olm-bundle">Release OLM Bundle</h2>
  740. <p>In order to make the latest release available to <a href="https://operatorhub.io/">OperatorHub.io</a> we need to create a bundle and open a PR in the <a href="https://github.com/k8s-operatorhub/community-operators/">community-operators</a> repository.</p>
  741. <p>To create a bundle first increment the <code>VERSION</code> in the Makefile as described above. Then run the following commands in the root of the repository:</p>
  742. <div class="highlight"><pre><span></span><code><span class="c1"># clone repo</span>
  743. git clone https://github.com/external-secrets/external-secrets-helm-operator
  744. <span class="nb">cd</span> external-secrets-helm-operator
  745. <span class="c1"># bump version</span>
  746. <span class="nb">export</span> <span class="nv">VERSION</span><span class="o">=</span>x.y.z
  747. sed -i <span class="s2">&quot;s/^VERSION ?= .*/VERSION ?= </span><span class="si">${</span><span class="nv">VERSION</span><span class="si">}</span><span class="s2">/&quot;</span> Makefile
  748. <span class="c1"># prep release</span>
  749. make prepare-stable-release
  750. </code></pre></div>
  751. <p>Check the generated files in the <code>bundle/</code> directory. If they look good add &amp; commit them, open a PR against this repository. You can always use the <a href="https://operatorhub.io/preview">OperatorHub.io/preview</a> page to preview the generated CSV.</p>
  752. <div class="highlight"><pre><span></span><code>git status
  753. git add .
  754. git commit -s -m <span class="s2">&quot;chore: bump version xyz&quot;</span>
  755. git push
  756. </code></pre></div>
  757. <p>Once the PR is merged we need create a pull request against both community-operators repositories. There's a make target that does the heavy lifting for you:
  758. <div class="highlight"><pre><span></span><code>make bundle-operatorhub
  759. </code></pre></div></p>
  760. <p>This command will add/commit/push and open pull requests in the respective repositories.</p>
  761. </article>
  762. </div>
  763. </div>
  764. </main>
  765. <footer class="md-footer">
  766. <nav class="md-footer__inner md-grid" aria-label="Footer">
  767. <a href="../process/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Contributing Process" rel="prev">
  768. <div class="md-footer__button md-icon">
  769. <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>
  770. </div>
  771. <div class="md-footer__title">
  772. <div class="md-ellipsis">
  773. <span class="md-footer__direction">
  774. Previous
  775. </span>
  776. Contributing Process
  777. </div>
  778. </div>
  779. </a>
  780. <a href="../coc/" class="md-footer__link md-footer__link--next" aria-label="Next: Code of Conduct" rel="next">
  781. <div class="md-footer__title">
  782. <div class="md-ellipsis">
  783. <span class="md-footer__direction">
  784. Next
  785. </span>
  786. Code of Conduct
  787. </div>
  788. </div>
  789. <div class="md-footer__button md-icon">
  790. <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>
  791. </div>
  792. </a>
  793. </nav>
  794. <div class="md-footer-meta md-typeset">
  795. <div class="md-footer-meta__inner md-grid">
  796. <div class="md-copyright">
  797. <div class="md-copyright__highlight">
  798. &copy; 2022 The external-secrets Authors.<br/>
  799. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  800. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  801. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  802. </div>
  803. Made with
  804. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  805. Material for MkDocs
  806. </a>
  807. </div>
  808. </div>
  809. </div>
  810. </footer>
  811. </div>
  812. <div class="md-dialog" data-md-component="dialog">
  813. <div class="md-dialog__inner md-typeset"></div>
  814. </div>
  815. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  816. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  817. </body>
  818. </html>