index.html 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157
  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.1, mkdocs-material-7.1.8">
  8. <title>Deprecation Policy - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.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-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
  14. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){"undefined"!=typeof location$&&location$.subscribe(function(t){gtag("config","G-QP38TD8K7V",{page_path:t.pathname})})})</script>
  15. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  16. </head>
  17. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  18. <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  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="#deprecation-policy" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <header class="md-header" data-md-component="header">
  30. <nav class="md-header__inner md-grid" aria-label="Header">
  31. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  32. <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>
  33. </a>
  34. <label class="md-header__button md-icon" for="__drawer">
  35. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  36. </label>
  37. <div class="md-header__title" data-md-component="header-title">
  38. <div class="md-header__ellipsis">
  39. <div class="md-header__topic">
  40. <span class="md-ellipsis">
  41. External Secrets Operator
  42. </span>
  43. </div>
  44. <div class="md-header__topic" data-md-component="header-topic">
  45. <span class="md-ellipsis">
  46. Deprecation Policy
  47. </span>
  48. </div>
  49. </div>
  50. </div>
  51. <label class="md-header__button md-icon" for="__search">
  52. <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>
  53. </label>
  54. <div class="md-search" data-md-component="search" role="dialog">
  55. <label class="md-search__overlay" for="__search"></label>
  56. <div class="md-search__inner" role="search">
  57. <form class="md-search__form" name="search">
  58. <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" data-md-state="active" required>
  59. <label class="md-search__icon md-icon" for="__search">
  60. <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>
  61. <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>
  62. </label>
  63. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  64. <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>
  65. </button>
  66. </form>
  67. <div class="md-search__output">
  68. <div class="md-search__scrollwrap" data-md-scrollfix>
  69. <div class="md-search-result" data-md-component="search-result">
  70. <div class="md-search-result__meta">
  71. Initializing search
  72. </div>
  73. <ol class="md-search-result__list"></ol>
  74. </div>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. <div class="md-header__source">
  80. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  81. <div class="md-source__icon md-icon">
  82. <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>
  83. </div>
  84. <div class="md-source__repository">
  85. External Secrets Operator
  86. </div>
  87. </a>
  88. </div>
  89. </nav>
  90. </header>
  91. <div class="md-container" data-md-component="container">
  92. <main class="md-main" data-md-component="main">
  93. <div class="md-main__inner md-grid">
  94. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  95. <div class="md-sidebar__scrollwrap">
  96. <div class="md-sidebar__inner">
  97. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  98. <label class="md-nav__title" for="__drawer">
  99. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  100. <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>
  101. </a>
  102. External Secrets Operator
  103. </label>
  104. <div class="md-nav__source">
  105. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  106. <div class="md-source__icon md-icon">
  107. <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>
  108. </div>
  109. <div class="md-source__repository">
  110. External Secrets Operator
  111. </div>
  112. </a>
  113. </div>
  114. <ul class="md-nav__list" data-md-scrollfix>
  115. <li class="md-nav__item">
  116. <a href=".." class="md-nav__link">
  117. Introduction
  118. </a>
  119. </li>
  120. <li class="md-nav__item">
  121. <a href="../api-overview/" class="md-nav__link">
  122. Overview
  123. </a>
  124. </li>
  125. <li class="md-nav__item md-nav__item--nested">
  126. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  127. <label class="md-nav__link" for="__nav_3">
  128. API Types
  129. <span class="md-nav__icon md-icon"></span>
  130. </label>
  131. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  132. <label class="md-nav__title" for="__nav_3">
  133. <span class="md-nav__icon md-icon"></span>
  134. API Types
  135. </label>
  136. <ul class="md-nav__list" data-md-scrollfix>
  137. <li class="md-nav__item">
  138. <a href="../api-externalsecret/" class="md-nav__link">
  139. ExternalSecret
  140. </a>
  141. </li>
  142. <li class="md-nav__item">
  143. <a href="../api-secretstore/" class="md-nav__link">
  144. SecretStore
  145. </a>
  146. </li>
  147. <li class="md-nav__item">
  148. <a href="../api-clustersecretstore/" class="md-nav__link">
  149. ClusterSecretStore
  150. </a>
  151. </li>
  152. </ul>
  153. </nav>
  154. </li>
  155. <li class="md-nav__item md-nav__item--nested">
  156. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  157. <label class="md-nav__link" for="__nav_4">
  158. Guides
  159. <span class="md-nav__icon md-icon"></span>
  160. </label>
  161. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  162. <label class="md-nav__title" for="__nav_4">
  163. <span class="md-nav__icon md-icon"></span>
  164. Guides
  165. </label>
  166. <ul class="md-nav__list" data-md-scrollfix>
  167. <li class="md-nav__item">
  168. <a href="../guides-introduction/" class="md-nav__link">
  169. Introduction
  170. </a>
  171. </li>
  172. <li class="md-nav__item">
  173. <a href="../guides-getting-started/" class="md-nav__link">
  174. Getting started
  175. </a>
  176. </li>
  177. <li class="md-nav__item">
  178. <a href="../guides-templating/" class="md-nav__link">
  179. Advanced Templating
  180. </a>
  181. </li>
  182. <li class="md-nav__item">
  183. <a href="../guides-controller-class/" class="md-nav__link">
  184. Controller Classes
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  189. All keys, One secret
  190. </a>
  191. </li>
  192. <li class="md-nav__item">
  193. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  194. Common K8S Secret Types
  195. </a>
  196. </li>
  197. <li class="md-nav__item">
  198. <a href="../guides-multi-tenancy/" class="md-nav__link">
  199. Multi Tenancy
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../guides-metrics/" class="md-nav__link">
  204. Metrics
  205. </a>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="../guides-using-latest-image/" class="md-nav__link">
  209. Using Latest Image
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-gitops-using-fluxcd/" class="md-nav__link">
  214. GitOps using FluxCD
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item md-nav__item--nested">
  221. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  222. <label class="md-nav__link" for="__nav_5">
  223. Provider
  224. <span class="md-nav__icon md-icon"></span>
  225. </label>
  226. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  227. <label class="md-nav__title" for="__nav_5">
  228. <span class="md-nav__icon md-icon"></span>
  229. Provider
  230. </label>
  231. <ul class="md-nav__list" data-md-scrollfix>
  232. <li class="md-nav__item md-nav__item--nested">
  233. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  234. <label class="md-nav__link" for="__nav_5_1">
  235. AWS
  236. <span class="md-nav__icon md-icon"></span>
  237. </label>
  238. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  239. <label class="md-nav__title" for="__nav_5_1">
  240. <span class="md-nav__icon md-icon"></span>
  241. AWS
  242. </label>
  243. <ul class="md-nav__list" data-md-scrollfix>
  244. <li class="md-nav__item">
  245. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  246. Secrets Manager
  247. </a>
  248. </li>
  249. <li class="md-nav__item">
  250. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  251. Parameter Store
  252. </a>
  253. </li>
  254. </ul>
  255. </nav>
  256. </li>
  257. <li class="md-nav__item md-nav__item--nested">
  258. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  259. <label class="md-nav__link" for="__nav_5_2">
  260. Azure
  261. <span class="md-nav__icon md-icon"></span>
  262. </label>
  263. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  264. <label class="md-nav__title" for="__nav_5_2">
  265. <span class="md-nav__icon md-icon"></span>
  266. Azure
  267. </label>
  268. <ul class="md-nav__list" data-md-scrollfix>
  269. <li class="md-nav__item">
  270. <a href="../provider-azure-key-vault/" class="md-nav__link">
  271. Key Vault
  272. </a>
  273. </li>
  274. </ul>
  275. </nav>
  276. </li>
  277. <li class="md-nav__item md-nav__item--nested">
  278. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  279. <label class="md-nav__link" for="__nav_5_3">
  280. Google
  281. <span class="md-nav__icon md-icon"></span>
  282. </label>
  283. <nav class="md-nav" aria-label="Google" data-md-level="2">
  284. <label class="md-nav__title" for="__nav_5_3">
  285. <span class="md-nav__icon md-icon"></span>
  286. Google
  287. </label>
  288. <ul class="md-nav__list" data-md-scrollfix>
  289. <li class="md-nav__item">
  290. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  291. Secrets Manager
  292. </a>
  293. </li>
  294. </ul>
  295. </nav>
  296. </li>
  297. <li class="md-nav__item md-nav__item--nested">
  298. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  299. <label class="md-nav__link" for="__nav_5_4">
  300. IBM
  301. <span class="md-nav__icon md-icon"></span>
  302. </label>
  303. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  304. <label class="md-nav__title" for="__nav_5_4">
  305. <span class="md-nav__icon md-icon"></span>
  306. IBM
  307. </label>
  308. <ul class="md-nav__list" data-md-scrollfix>
  309. <li class="md-nav__item">
  310. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  311. Secrets Manager
  312. </a>
  313. </li>
  314. </ul>
  315. </nav>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../provider-akeyless/" class="md-nav__link">
  319. Akeyless
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  324. HashiCorp Vault
  325. </a>
  326. </li>
  327. <li class="md-nav__item md-nav__item--nested">
  328. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  329. <label class="md-nav__link" for="__nav_5_7">
  330. Yandex
  331. <span class="md-nav__icon md-icon"></span>
  332. </label>
  333. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  334. <label class="md-nav__title" for="__nav_5_7">
  335. <span class="md-nav__icon md-icon"></span>
  336. Yandex
  337. </label>
  338. <ul class="md-nav__list" data-md-scrollfix>
  339. <li class="md-nav__item">
  340. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  341. Lockbox
  342. </a>
  343. </li>
  344. </ul>
  345. </nav>
  346. </li>
  347. <li class="md-nav__item md-nav__item--nested">
  348. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  349. <label class="md-nav__link" for="__nav_5_8">
  350. Gitlab
  351. <span class="md-nav__icon md-icon"></span>
  352. </label>
  353. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  354. <label class="md-nav__title" for="__nav_5_8">
  355. <span class="md-nav__icon md-icon"></span>
  356. Gitlab
  357. </label>
  358. <ul class="md-nav__list" data-md-scrollfix>
  359. <li class="md-nav__item">
  360. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  361. Gitlab Project Variables
  362. </a>
  363. </li>
  364. </ul>
  365. </nav>
  366. </li>
  367. <li class="md-nav__item md-nav__item--nested">
  368. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  369. <label class="md-nav__link" for="__nav_5_9">
  370. Oracle
  371. <span class="md-nav__icon md-icon"></span>
  372. </label>
  373. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  374. <label class="md-nav__title" for="__nav_5_9">
  375. <span class="md-nav__icon md-icon"></span>
  376. Oracle
  377. </label>
  378. <ul class="md-nav__list" data-md-scrollfix>
  379. <li class="md-nav__item">
  380. <a href="../provider-oracle-vault/" class="md-nav__link">
  381. Oracle Vault
  382. </a>
  383. </li>
  384. </ul>
  385. </nav>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../provider-webhook/" class="md-nav__link">
  389. Webhook
  390. </a>
  391. </li>
  392. </ul>
  393. </nav>
  394. </li>
  395. <li class="md-nav__item md-nav__item--nested">
  396. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  397. <label class="md-nav__link" for="__nav_6">
  398. References
  399. <span class="md-nav__icon md-icon"></span>
  400. </label>
  401. <nav class="md-nav" aria-label="References" data-md-level="1">
  402. <label class="md-nav__title" for="__nav_6">
  403. <span class="md-nav__icon md-icon"></span>
  404. References
  405. </label>
  406. <ul class="md-nav__list" data-md-scrollfix>
  407. <li class="md-nav__item">
  408. <a href="../spec/" class="md-nav__link">
  409. API specification
  410. </a>
  411. </li>
  412. </ul>
  413. </nav>
  414. </li>
  415. <li class="md-nav__item md-nav__item--nested">
  416. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  417. <label class="md-nav__link" for="__nav_7">
  418. Contributing
  419. <span class="md-nav__icon md-icon"></span>
  420. </label>
  421. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  422. <label class="md-nav__title" for="__nav_7">
  423. <span class="md-nav__icon md-icon"></span>
  424. Contributing
  425. </label>
  426. <ul class="md-nav__list" data-md-scrollfix>
  427. <li class="md-nav__item">
  428. <a href="../contributing-devguide/" class="md-nav__link">
  429. Developer guide
  430. </a>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../contributing-process/" class="md-nav__link">
  434. Contributing Process
  435. </a>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="../contributing-coc/" class="md-nav__link">
  439. Code of Conduct
  440. </a>
  441. </li>
  442. </ul>
  443. </nav>
  444. </li>
  445. <li class="md-nav__item md-nav__item--active">
  446. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  447. <label class="md-nav__link md-nav__link--active" for="__toc">
  448. Deprecation Policy
  449. <span class="md-nav__icon md-icon"></span>
  450. </label>
  451. <a href="./" class="md-nav__link md-nav__link--active">
  452. Deprecation Policy
  453. </a>
  454. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  455. <label class="md-nav__title" for="__toc">
  456. <span class="md-nav__icon md-icon"></span>
  457. Table of contents
  458. </label>
  459. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  460. <li class="md-nav__item">
  461. <a href="#api-surface" class="md-nav__link">
  462. API Surface
  463. </a>
  464. <nav class="md-nav" aria-label="API Surface">
  465. <ul class="md-nav__list">
  466. <li class="md-nav__item">
  467. <a href="#scope" class="md-nav__link">
  468. Scope
  469. </a>
  470. </li>
  471. <li class="md-nav__item">
  472. <a href="#non-scope" class="md-nav__link">
  473. Non-Scope
  474. </a>
  475. </li>
  476. </ul>
  477. </nav>
  478. </li>
  479. </ul>
  480. </nav>
  481. </li>
  482. </ul>
  483. </nav>
  484. </div>
  485. </div>
  486. </div>
  487. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  488. <div class="md-sidebar__scrollwrap">
  489. <div class="md-sidebar__inner">
  490. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  491. <label class="md-nav__title" for="__toc">
  492. <span class="md-nav__icon md-icon"></span>
  493. Table of contents
  494. </label>
  495. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  496. <li class="md-nav__item">
  497. <a href="#api-surface" class="md-nav__link">
  498. API Surface
  499. </a>
  500. <nav class="md-nav" aria-label="API Surface">
  501. <ul class="md-nav__list">
  502. <li class="md-nav__item">
  503. <a href="#scope" class="md-nav__link">
  504. Scope
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="#non-scope" class="md-nav__link">
  509. Non-Scope
  510. </a>
  511. </li>
  512. </ul>
  513. </nav>
  514. </li>
  515. </ul>
  516. </nav>
  517. </div>
  518. </div>
  519. </div>
  520. <div class="md-content" data-md-component="content">
  521. <article class="md-content__inner md-typeset">
  522. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/deprecation-policy.md" title="Edit this page" class="md-content__button md-icon">
  523. <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>
  524. </a>
  525. <h1 id="deprecation-policy">Deprecation Policy</h1>
  526. <p>We follow the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-policy/">Kubernetes Deprecation Policy</a> and <a href="https://kubernetes.io/docs/reference/using-api/#api-versioning">API Versioning Scheme</a>: alpha, beta, GA.</p>
  527. <p>The project is currently in <code>alpha</code> state. We track <code>beta</code> progress in <a href="https://github.com/external-secrets/external-secrets/projects/3">this GitHub Project</a>. Please try the <code>alpha</code> and <code>beta</code> features and provide feedback. After the features exit beta, it may not be practical to make more changes.</p>
  528. <ul>
  529. <li>
  530. <p>alpha</p>
  531. <ul>
  532. <li>The support for a feature may be dropped at any time without notice.</li>
  533. <li>The API may change in incompatible ways in a later software release without notice.</li>
  534. <li>The software is recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.</li>
  535. </ul>
  536. </li>
  537. <li>
  538. <p>beta</p>
  539. <ul>
  540. <li>The software is well tested. Enabling a feature is considered safe. Features are enabled by default.</li>
  541. <li>The support for a feature will not be dropped, though the details may change.</li>
  542. <li>The schema and/or semantics of objects may change in incompatible ways in a subsequent beta or stable release. When this happens, migration instructions are provided. Schema changes may require deleting, editing, and re-creating API objects. The editing process may not be straightforward. The migration may require downtime for applications that rely on the feature.</li>
  543. <li>The software is not recommended for production uses. Subsequent releases may introduce incompatible changes. If you have multiple clusters which can be upgraded independently, you may be able to relax this restriction.</li>
  544. </ul>
  545. </li>
  546. <li>GA<ul>
  547. <li>The stable versions of features appear in released software for many subsequent versions.</li>
  548. <li>Use it in production ;)</li>
  549. </ul>
  550. </li>
  551. </ul>
  552. <h2 id="api-surface">API Surface</h2>
  553. <p>We define the following scope that is covered by our deprecation policy. We follow the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-policy/">9 Rules of the Kuberenetes Deprecation Policy</a>.</p>
  554. <h3 id="scope">Scope</h3>
  555. <ul>
  556. <li>API Objects and fields: <code>.Spec</code>, <code>.Status</code> and <code>.Status.Conditions[]</code></li>
  557. <li>Enums and constant values</li>
  558. <li>Controller Configuration: CLI flags &amp; environment variables</li>
  559. <li>Metrics as defined in the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-a-metric">Kubernetes docs</a></li>
  560. <li>a feature or specific behavior:<ul>
  561. <li><code>ExternalSecret</code> <a href="http://localhost:8000/api-externalsecret/#update-behavior">update mechanics</a></li>
  562. </ul>
  563. </li>
  564. </ul>
  565. <h3 id="non-scope">Non-Scope</h3>
  566. <p>We do not provide stability guarantee for <strong>source code imports</strong>. The Interfaces and the behavior will change in a unexpected and backwards-incompatible way. However,
  567. The maintained helm chart is not part of this deprecation policy.</p>
  568. </article>
  569. </div>
  570. </div>
  571. </main>
  572. <footer class="md-footer">
  573. <nav class="md-footer__inner md-grid" aria-label="Footer">
  574. <a href="../contributing-coc/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Code of Conduct" rel="prev">
  575. <div class="md-footer__button md-icon">
  576. <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>
  577. </div>
  578. <div class="md-footer__title">
  579. <div class="md-ellipsis">
  580. <span class="md-footer__direction">
  581. Previous
  582. </span>
  583. Code of Conduct
  584. </div>
  585. </div>
  586. </a>
  587. </nav>
  588. <div class="md-footer-meta md-typeset">
  589. <div class="md-footer-meta__inner md-grid">
  590. <div class="md-footer-copyright">
  591. Made with
  592. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  593. Material for MkDocs
  594. </a>
  595. </div>
  596. </div>
  597. </div>
  598. </footer>
  599. </div>
  600. <div class="md-dialog" data-md-component="dialog">
  601. <div class="md-dialog__inner md-typeset"></div>
  602. </div>
  603. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.b0710199.min.js", "version": {"provider": "mike"}}</script>
  604. <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
  605. </body>
  606. </html>