| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157 |
- <!doctype html>
- <html lang="en" class="no-js">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
-
-
-
-
- <link rel="icon" href="../assets/images/favicon.png">
- <meta name="generator" content="mkdocs-1.1, mkdocs-material-7.1.8">
-
-
-
- <title>Deprecation Policy - External Secrets Operator</title>
-
-
-
- <link rel="stylesheet" href="../assets/stylesheets/main.ca7ac06f.min.css">
-
-
- <link rel="stylesheet" href="../assets/stylesheets/palette.f1a3b89f.min.css">
-
-
-
-
-
-
-
- <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
- <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
-
-
-
-
-
-
-
-
-
- <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>
- <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
-
-
- </head>
-
-
-
-
-
-
-
- <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
-
-
- <script>function __prefix(e){return new URL("..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
-
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
- <label class="md-overlay" for="__drawer"></label>
- <div data-md-component="skip">
-
-
- <a href="#deprecation-policy" class="md-skip">
- Skip to content
- </a>
-
- </div>
- <div data-md-component="announce">
-
- </div>
-
- <header class="md-header" data-md-component="header">
- <nav class="md-header__inner md-grid" aria-label="Header">
- <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
-
- <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>
- </a>
- <label class="md-header__button md-icon" for="__drawer">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
- </label>
- <div class="md-header__title" data-md-component="header-title">
- <div class="md-header__ellipsis">
- <div class="md-header__topic">
- <span class="md-ellipsis">
- External Secrets Operator
- </span>
- </div>
- <div class="md-header__topic" data-md-component="header-topic">
- <span class="md-ellipsis">
-
- Deprecation Policy
-
- </span>
- </div>
- </div>
- </div>
-
-
-
- <label class="md-header__button md-icon" for="__search">
- <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>
- </label>
-
- <div class="md-search" data-md-component="search" role="dialog">
- <label class="md-search__overlay" for="__search"></label>
- <div class="md-search__inner" role="search">
- <form class="md-search__form" name="search">
- <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>
- <label class="md-search__icon md-icon" for="__search">
- <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>
- <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>
- </label>
- <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
- <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>
- </button>
- </form>
- <div class="md-search__output">
- <div class="md-search__scrollwrap" data-md-scrollfix>
- <div class="md-search-result" data-md-component="search-result">
- <div class="md-search-result__meta">
- Initializing search
- </div>
- <ol class="md-search-result__list"></ol>
- </div>
- </div>
- </div>
- </div>
- </div>
-
-
- <div class="md-header__source">
-
- <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <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>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- </nav>
- </header>
-
- <div class="md-container" data-md-component="container">
-
-
-
-
- <main class="md-main" data-md-component="main">
- <div class="md-main__inner md-grid">
-
-
-
- <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
- <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
- <label class="md-nav__title" for="__drawer">
- <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
-
-
- <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>
- </a>
- External Secrets Operator
- </label>
-
- <div class="md-nav__source">
-
- <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
- <div class="md-source__icon md-icon">
-
- <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>
- </div>
- <div class="md-source__repository">
- External Secrets Operator
- </div>
- </a>
- </div>
-
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href=".." class="md-nav__link">
- Introduction
- </a>
- </li>
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../api-overview/" class="md-nav__link">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
-
- <label class="md-nav__link" for="__nav_3">
- API Types
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="API Types" data-md-level="1">
- <label class="md-nav__title" for="__nav_3">
- <span class="md-nav__icon md-icon"></span>
- API Types
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../api-externalsecret/" class="md-nav__link">
- ExternalSecret
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../api-secretstore/" class="md-nav__link">
- SecretStore
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../api-clustersecretstore/" class="md-nav__link">
- ClusterSecretStore
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
-
- <label class="md-nav__link" for="__nav_4">
- Guides
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Guides" data-md-level="1">
- <label class="md-nav__title" for="__nav_4">
- <span class="md-nav__icon md-icon"></span>
- Guides
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-introduction/" class="md-nav__link">
- Introduction
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-getting-started/" class="md-nav__link">
- Getting started
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-templating/" class="md-nav__link">
- Advanced Templating
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-controller-class/" class="md-nav__link">
- Controller Classes
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-all-keys-one-secret/" class="md-nav__link">
- All keys, One secret
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
- Common K8S Secret Types
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-multi-tenancy/" class="md-nav__link">
- Multi Tenancy
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-metrics/" class="md-nav__link">
- Metrics
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-using-latest-image/" class="md-nav__link">
- Using Latest Image
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../guides-gitops-using-fluxcd/" class="md-nav__link">
- GitOps using FluxCD
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
-
- <label class="md-nav__link" for="__nav_5">
- Provider
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Provider" data-md-level="1">
- <label class="md-nav__title" for="__nav_5">
- <span class="md-nav__icon md-icon"></span>
- Provider
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
-
- <label class="md-nav__link" for="__nav_5_1">
- AWS
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="AWS" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_1">
- <span class="md-nav__icon md-icon"></span>
- AWS
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-aws-secrets-manager/" class="md-nav__link">
- Secrets Manager
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-aws-parameter-store/" class="md-nav__link">
- Parameter Store
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
-
- <label class="md-nav__link" for="__nav_5_2">
- Azure
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Azure" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_2">
- <span class="md-nav__icon md-icon"></span>
- Azure
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-azure-key-vault/" class="md-nav__link">
- Key Vault
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
-
- <label class="md-nav__link" for="__nav_5_3">
- Google
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Google" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_3">
- <span class="md-nav__icon md-icon"></span>
- Google
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-google-secrets-manager/" class="md-nav__link">
- Secrets Manager
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
-
- <label class="md-nav__link" for="__nav_5_4">
- IBM
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="IBM" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_4">
- <span class="md-nav__icon md-icon"></span>
- IBM
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
- Secrets Manager
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-akeyless/" class="md-nav__link">
- Akeyless
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-hashicorp-vault/" class="md-nav__link">
- HashiCorp Vault
- </a>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
-
- <label class="md-nav__link" for="__nav_5_7">
- Yandex
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Yandex" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_7">
- <span class="md-nav__icon md-icon"></span>
- Yandex
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-yandex-lockbox/" class="md-nav__link">
- Lockbox
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
-
- <label class="md-nav__link" for="__nav_5_8">
- Gitlab
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_8">
- <span class="md-nav__icon md-icon"></span>
- Gitlab
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-gitlab-project-variables/" class="md-nav__link">
- Gitlab Project Variables
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
-
- <label class="md-nav__link" for="__nav_5_9">
- Oracle
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Oracle" data-md-level="2">
- <label class="md-nav__title" for="__nav_5_9">
- <span class="md-nav__icon md-icon"></span>
- Oracle
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-oracle-vault/" class="md-nav__link">
- Oracle Vault
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../provider-webhook/" class="md-nav__link">
- Webhook
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
-
- <label class="md-nav__link" for="__nav_6">
- References
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="References" data-md-level="1">
- <label class="md-nav__title" for="__nav_6">
- <span class="md-nav__icon md-icon"></span>
- References
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../spec/" class="md-nav__link">
- API specification
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--nested">
-
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
-
- <label class="md-nav__link" for="__nav_7">
- Contributing
- <span class="md-nav__icon md-icon"></span>
- </label>
- <nav class="md-nav" aria-label="Contributing" data-md-level="1">
- <label class="md-nav__title" for="__nav_7">
- <span class="md-nav__icon md-icon"></span>
- Contributing
- </label>
- <ul class="md-nav__list" data-md-scrollfix>
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../contributing-devguide/" class="md-nav__link">
- Developer guide
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../contributing-process/" class="md-nav__link">
- Contributing Process
- </a>
- </li>
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../contributing-coc/" class="md-nav__link">
- Code of Conduct
- </a>
- </li>
-
-
- </ul>
- </nav>
- </li>
-
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
-
-
-
-
-
- <label class="md-nav__link md-nav__link--active" for="__toc">
- Deprecation Policy
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <a href="./" class="md-nav__link md-nav__link--active">
- Deprecation Policy
- </a>
-
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
-
-
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#api-surface" class="md-nav__link">
- API Surface
- </a>
-
- <nav class="md-nav" aria-label="API Surface">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#scope" class="md-nav__link">
- Scope
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#non-scope" class="md-nav__link">
- Non-Scope
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
-
- </nav>
-
- </li>
-
-
- </ul>
- </nav>
- </div>
- </div>
- </div>
-
-
-
- <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
- <div class="md-sidebar__scrollwrap">
- <div class="md-sidebar__inner">
-
- <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-
-
-
-
-
-
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#api-surface" class="md-nav__link">
- API Surface
- </a>
-
- <nav class="md-nav" aria-label="API Surface">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#scope" class="md-nav__link">
- Scope
- </a>
-
- </li>
-
- <li class="md-nav__item">
- <a href="#non-scope" class="md-nav__link">
- Non-Scope
- </a>
-
- </li>
-
- </ul>
- </nav>
-
- </li>
-
- </ul>
-
- </nav>
- </div>
- </div>
- </div>
-
-
- <div class="md-content" data-md-component="content">
- <article class="md-content__inner md-typeset">
-
-
- <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">
- <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>
- </a>
-
-
- <h1 id="deprecation-policy">Deprecation Policy</h1>
- <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>
- <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>
- <ul>
- <li>
- <p>alpha</p>
- <ul>
- <li>The support for a feature may be dropped at any time without notice.</li>
- <li>The API may change in incompatible ways in a later software release without notice.</li>
- <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>
- </ul>
- </li>
- <li>
- <p>beta</p>
- <ul>
- <li>The software is well tested. Enabling a feature is considered safe. Features are enabled by default.</li>
- <li>The support for a feature will not be dropped, though the details may change.</li>
- <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>
- <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>
- </ul>
- </li>
- <li>GA<ul>
- <li>The stable versions of features appear in released software for many subsequent versions.</li>
- <li>Use it in production ;)</li>
- </ul>
- </li>
- </ul>
- <h2 id="api-surface">API Surface</h2>
- <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>
- <h3 id="scope">Scope</h3>
- <ul>
- <li>API Objects and fields: <code>.Spec</code>, <code>.Status</code> and <code>.Status.Conditions[]</code></li>
- <li>Enums and constant values</li>
- <li>Controller Configuration: CLI flags & environment variables</li>
- <li>Metrics as defined in the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-a-metric">Kubernetes docs</a></li>
- <li>a feature or specific behavior:<ul>
- <li><code>ExternalSecret</code> <a href="http://localhost:8000/api-externalsecret/#update-behavior">update mechanics</a></li>
- </ul>
- </li>
- </ul>
- <h3 id="non-scope">Non-Scope</h3>
- <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,
- The maintained helm chart is not part of this deprecation policy.</p>
-
-
-
-
-
- </article>
- </div>
- </div>
-
- </main>
-
-
- <footer class="md-footer">
-
- <nav class="md-footer__inner md-grid" aria-label="Footer">
-
-
- <a href="../contributing-coc/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Code of Conduct" rel="prev">
- <div class="md-footer__button md-icon">
- <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>
- </div>
- <div class="md-footer__title">
- <div class="md-ellipsis">
- <span class="md-footer__direction">
- Previous
- </span>
- Code of Conduct
- </div>
- </div>
- </a>
-
-
- </nav>
-
- <div class="md-footer-meta md-typeset">
- <div class="md-footer-meta__inner md-grid">
- <div class="md-footer-copyright">
-
- Made with
- <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
- Material for MkDocs
- </a>
-
- </div>
-
- </div>
- </div>
- </footer>
-
- </div>
- <div class="md-dialog" data-md-component="dialog">
- <div class="md-dialog__inner md-typeset"></div>
- </div>
- <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>
-
-
- <script src="../assets/javascripts/bundle.76f349be.min.js"></script>
-
-
- </body>
- </html>
|