From d3c8b76cd31e02981c91be51176d212cc8de0c28 Mon Sep 17 00:00:00 2001 From: Moritz Johner Date: Fri, 22 Apr 2022 21:22:08 +0200 Subject: [PATCH] fix: update deprecation policy, add link to support policy --- README.md | 2 +- docs/deprecation-policy.md | 2 +- docs/stability-support.md | 16 +++++++++------- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cce4161da..d1d04e457 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Multiple people and organizations are joining efforts to create a single Externa ## Documentation -External Secrets Operator guides and reference documentation is available at [external-secrets.io](https://external-secrets.io). +External Secrets Operator guides and reference documentation is available at [external-secrets.io](https://external-secrets.io). Also see our [stability and support](https://external-secrets.io/latest/stability-support/) policy. ## Contributing diff --git a/docs/deprecation-policy.md b/docs/deprecation-policy.md index e0acfee92..77d34e4f5 100644 --- a/docs/deprecation-policy.md +++ b/docs/deprecation-policy.md @@ -2,7 +2,7 @@ We follow the [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/) and [API Versioning Scheme](https://kubernetes.io/docs/reference/using-api/#api-versioning): alpha, beta, GA. -The project is currently in `alpha` state. We track `beta` progress in [this GitHub Project](https://github.com/external-secrets/external-secrets/projects/3). Please try the `alpha` and `beta` features and provide feedback. After the features exit beta, it may not be practical to make more changes. +The project is currently in `beta` state. Please try the `beta` features and provide feedback. After the features exits beta, it may not be practical to make more changes. * alpha * The support for a feature may be dropped at any time without notice. diff --git a/docs/stability-support.md b/docs/stability-support.md index e0bdb6133..1263445f4 100644 --- a/docs/stability-support.md +++ b/docs/stability-support.md @@ -1,8 +1,8 @@ -This page lists the status, timeline and policy for currently supported ESO releases its providers. +This page lists the status, timeline and policy for currently supported ESO releases and its providers. Please also see our [deprecation policy](deprecation-policy.md) that describes API versioning, deprecation and API surface. ## External Secrets Operator -We are currently in beta and support only the latest release. +We are currently in beta and support **only the latest release** for the time being. | ESO Version | Kubernetes Version | | ----------- | ------------------ | @@ -12,12 +12,14 @@ We are currently in beta and support only the latest release. ## Provider Stability and Support Level -| Provider | Stability | Contact | +The following table describes the stability level of each provider and who's responsible. + +| Provider | Stability | Maintainer | | ------------------------------------------------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [AWS Secrets Manager](https://external-secrets.io/latest/provider-aws-secrets-manager/) | stable | [ESO Maintained](https://github.com/external-secrets) | -| [AWS Parameter Store](https://external-secrets.io/latest/provider-aws-parameter-store/) | stable | [ESO Maintained](https://github.com/external-secrets) | -| [Hashicorp Vault](https://external-secrets.io/latest/provider-hashicorp-vault/) | stable | [ESO Maintained](https://github.com/external-secrets) | -| [GCP Secret Manager](https://external-secrets.io/latest/provider-google-secrets-manager/) | stable | [ESO Maintained](https://github.com/external-secrets) | +| [AWS Secrets Manager](https://external-secrets.io/latest/provider-aws-secrets-manager/) | stable | [external-secrets](https://github.com/external-secrets) | +| [AWS Parameter Store](https://external-secrets.io/latest/provider-aws-parameter-store/) | stable | [external-secrets](https://github.com/external-secrets) | +| [Hashicorp Vault](https://external-secrets.io/latest/provider-hashicorp-vault/) | stable | [external-secrets](https://github.com/external-secrets) | +| [GCP Secret Manager](https://external-secrets.io/latest/provider-google-secrets-manager/) | stable | [external-secrets](https://github.com/external-secrets) | | [Azure Keyvault](https://external-secrets.io/latest/provider-azure-key-vault/) | beta | [@ahmedmus-1A](https://github.com/ahmedmus-1A) [@asnowfix](https://github.com/asnowfix) [@ncourbet-1A](https://github.com/ncourbet-1A) [@1A-mj](https://github.com/1A-mj) | | [IBM Secrets Manager](https://external-secrets.io/latest/provider-ibm-secrets-manager/) | alpha | [@knelasevero](https://github.com/knelasevero) [@sebagomez](https://github.com/sebagomez) [@ricardoptcosta](https://github.com/ricardoptcosta) | | [Yandex Lockbox](https://external-secrets.io/latest/provider-yandex-lockbox/) | alpha | [@AndreyZamyslov](https://github.com/AndreyZamyslov) [@knelasevero](https://github.com/knelasevero) |