Browse Source

chore: update docs for release (#2126)

Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>
Moritz Johner 3 years ago
parent
commit
05dacdc104

+ 14 - 11
docs/contributing/roadmap.md

@@ -11,21 +11,24 @@ These CRDs are currently at `v1beta1` and are considered production ready. Going
 
 We have identified the following areas of work. This is subject to change while we gather feedback. We have a [GitHub Project Board](https://github.com/orgs/external-secrets/projects/2/views/1) where we organize issues and milestones on a high level.
 
+
 * Conformance testing
-    * end to end testing with ArgoCD and Flux
-    * end to end testing for all project maintained providers
+    * end to end testing with ArgoCD and Flux
+    * end to end testing for all project maintained providers
 * API enhancements
     * consolidate provider fields
-    * dataFrom key rewrites
+    * dataFrom key rewrites
     * provider versioning strategy
-    * pushing secrets to a provider
+    * pushing secrets to a provider
 * Documentation Improvements
     * Troubleshooting Guides
-    * FAQ
-    * review multi tenancy docs
-    * provide security model for infosec teams
-    * provider specific guides
+    * ✓ FAQ
+    * ✓ review multi tenancy docs
+    * security model for infosec teams
+    * security best practices guide
+    * ✓ provider specific guides
 * Observability
-    * Provide Grafana Dashboard and Prometheus alerts
-    * add provider-level metrics
-* Pentest & SBOM
+    * ✓ Provide Grafana Dashboard and Prometheus alerts
+    * ✓ add provider-level metrics
+* Pentest
+* ✓ SBOM

+ 30 - 29
docs/introduction/stability-support.md

@@ -11,6 +11,7 @@ We are currently in beta and support **only the latest release** for the time be
 
 | ESO Version | Kubernetes Version |
 | ----------- | ------------------ |
+| 0.8.x       | 1.19 → 1.26        |
 | 0.7.x       | 1.19 → 1.26        |
 | 0.6.x       | 1.19 → 1.24        |
 | 0.5.x       | 1.19 → 1.24        |
@@ -21,37 +22,37 @@ We are currently in beta and support **only the latest release** for the time be
 
 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   |                                                                                        [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/)                             |  stable   |                                                                                        [external-secrets](https://github.com/external-secrets) |
+| Provider                                                                                                   | Stability |                                                                                                                                                                              Maintainer |
+| ---------------------------------------------------------------------------------------------------------- | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| [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/)                             |  stable   |                                                                                                                                 [external-secrets](https://github.com/external-secrets) |
 | [IBM Cloud Secrets Manager](https://external-secrets.io/latest/provider/ibm-secrets-manager/)              |  stable   | [@knelasevero](https://github.com/knelasevero) [@sebagomez](https://github.com/sebagomez) [@ricardoptcosta](https://github.com/ricardoptcosta) [@IdanAdar](https://github.com/IdanAdar) |
-| [Kubernetes](https://external-secrets.io/latest/provider/kubernetes)                                       |   alpha   |                                                                                        [external-secrets](https://github.com/external-secrets) |
-| [Yandex Lockbox](https://external-secrets.io/latest/provider/yandex-lockbox/)                              |   alpha   |                                            [@AndreyZamyslov](https://github.com/AndreyZamyslov) [@knelasevero](https://github.com/knelasevero) |
-| [Gitlab Variables](https://external-secrets.io/latest/provider/gitlab-variables/)                          |   alpha   |                                                                                                         [@Jabray5](https://github.com/Jabray5) |
-| Alibaba Cloud KMS                                                                                          |   alpha   |                                                                                                 [@ElsaChelala](https://github.com/ElsaChelala) |
-| [Oracle Vault](https://external-secrets.io/latest/provider/oracle-vault)                                   |   alpha   |                                                        [@KianTigger](https://github.com/KianTigger) [@EladGabay](https://github.com/EladGabay) |
-| [Akeyless](https://external-secrets.io/latest/provider/akeyless)                                           |   alpha   |                                                                                           [@renanaAkeyless](https://github.com/renanaAkeyless) |
-| [1Password](https://external-secrets.io/latest/provider/1password-automation)                              |   alpha   |                                              [@SimSpaceCorp](https://github.com/Simspace) [@snarlysodboxer](https://github.com/snarlysodboxer) |
-| [Generic Webhook](https://external-secrets.io/latest/provider/webhook)                                     |   alpha   |                                                                                                         [@willemm](https://github.com/willemm) |
-| [senhasegura DevOps Secrets Management (DSM)](https://external-secrets.io/latest/provider/senhasegura-dsm) |   alpha   |                                                                                                           [@lfraga](https://github.com/lfraga) |
-| [Doppler SecretOps Platform](https://external-secrets.io/latest/provider/doppler)                          |   alpha   |                                                [@ryan-blunden](https://github.com/ryan-blunden/) [@nmanoogian](https://github.com/nmanoogian/) |
+| [Kubernetes](https://external-secrets.io/latest/provider/kubernetes)                                       |   alpha   |                                                                                                                                 [external-secrets](https://github.com/external-secrets) |
+| [Yandex Lockbox](https://external-secrets.io/latest/provider/yandex-lockbox/)                              |   alpha   |                                                                                     [@AndreyZamyslov](https://github.com/AndreyZamyslov) [@knelasevero](https://github.com/knelasevero) |
+| [Gitlab Variables](https://external-secrets.io/latest/provider/gitlab-variables/)                          |   alpha   |                                                                                                                                                  [@Jabray5](https://github.com/Jabray5) |
+| Alibaba Cloud KMS                                                                                          |   alpha   |                                                                                                                                          [@ElsaChelala](https://github.com/ElsaChelala) |
+| [Oracle Vault](https://external-secrets.io/latest/provider/oracle-vault)                                   |   alpha   |                                                                                                 [@KianTigger](https://github.com/KianTigger) [@EladGabay](https://github.com/EladGabay) |
+| [Akeyless](https://external-secrets.io/latest/provider/akeyless)                                           |   alpha   |                                                                                                                                    [@renanaAkeyless](https://github.com/renanaAkeyless) |
+| [1Password](https://external-secrets.io/latest/provider/1password-automation)                              |   alpha   |                                                                                       [@SimSpaceCorp](https://github.com/Simspace) [@snarlysodboxer](https://github.com/snarlysodboxer) |
+| [Generic Webhook](https://external-secrets.io/latest/provider/webhook)                                     |   alpha   |                                                                                                                                                  [@willemm](https://github.com/willemm) |
+| [senhasegura DevOps Secrets Management (DSM)](https://external-secrets.io/latest/provider/senhasegura-dsm) |   alpha   |                                                                                                                                                    [@lfraga](https://github.com/lfraga) |
+| [Doppler SecretOps Platform](https://external-secrets.io/latest/provider/doppler)                          |   alpha   |                                                                                         [@ryan-blunden](https://github.com/ryan-blunden/) [@nmanoogian](https://github.com/nmanoogian/) |
 
 ## Provider Feature Support
 
 The following table show the support for features across different providers.
 
 | Provider                  | find by name | find by tags | metadataPolicy Fetch | referent authentication | store validation | push secret | DeletionPolicy Merge/Delete |
-|---------------------------|:------------:|:------------:| :------------------: | :---------------------: | :--------------: | :---------: | :-------------------------:
-| AWS Secrets Manager       |      x       |      x       |                      |            x            |        x         |     x       |            x                |
-| AWS Parameter Store       |      x       |      x       |                      |            x            |        x         |     x       |            x                |
-| Hashicorp Vault           |      x       |      x       |                      |            x            |        x         |     x       |            x                |
-| GCP Secret Manager        |      x       |      x       |                      |            x            |        x         |     x       |            x                |
-| Azure Keyvault            |      x       |      x       |          x           |            x            |        x         |     x       |            x                |
-| Kubernetes                |      x       |      x       |                      |            x            |        x         |     x       |            x                |
+| ------------------------- | :----------: | :----------: | :------------------: | :---------------------: | :--------------: | :---------: | :-------------------------: |
+| AWS Secrets Manager       |      x       |      x       |          x           |            x            |        x         |      x      |              x              |
+| AWS Parameter Store       |      x       |      x       |          x           |            x            |        x         |      x      |              x              |
+| Hashicorp Vault           |      x       |      x       |          x           |            x            |        x         |      x      |              x              |
+| GCP Secret Manager        |      x       |      x       |                      |            x            |        x         |      x      |              x              |
+| Azure Keyvault            |      x       |      x       |          x           |            x            |        x         |      x      |              x              |
+| Kubernetes                |      x       |      x       |                      |            x            |        x         |             |              x              |
 | IBM Cloud Secrets Manager |              |              |                      |                         |        x         |             |                             |
 | Yandex Lockbox            |              |              |                      |                         |        x         |             |                             |
 | Gitlab Variables          |      x       |      x       |                      |                         |        x         |             |                             |
@@ -59,21 +60,21 @@ The following table show the support for features across different providers.
 | Oracle Vault              |              |              |                      |                         |        x         |             |                             |
 | Akeyless                  |      x       |      x       |                      |                         |        x         |             |                             |
 | 1Password                 |      x       |              |                      |                         |        x         |             |                             |
-| Generic Webhook           |              |              |                      |                         |                  |             |            x                |
+| Generic Webhook           |              |              |                      |                         |                  |             |              x              |
 | senhasegura DSM           |              |              |                      |                         |        x         |             |                             |
 | Doppler                   |      x       |              |                      |                         |        x         |             |                             |
 
-
 ## Support Policy
 
 We provide technical support and security / bug fixes for the above listed versions.
 
 ### Technical support
+
 We provide assistance for deploying/upgrading etc. on a best-effort basis. You can request support through the following channels:
 
-* [Kubernetes Slack
+- [Kubernetes Slack
   #external-secrets](https://kubernetes.slack.com/messages/external-secrets)
-* GitHub [Issues](https://github.com/external-secrets/external-secrets/issues)
-* GitHub [Discussions](https://github.com/external-secrets/external-secrets/discussions)
+- GitHub [Issues](https://github.com/external-secrets/external-secrets/issues)
+- GitHub [Discussions](https://github.com/external-secrets/external-secrets/discussions)
 
 Even though we have active maintainers and people assigned to this project, we kindly ask for patience when asking for support. We will try to get to priority issues as fast as possible, but there may be some delays.

+ 1 - 0
hack/api-docs/mkdocs.yml

@@ -78,6 +78,7 @@ nav:
     - Rewriting Keys: guides/datafrom-rewrite.md
     - Upgrading to v1beta1: guides/v1beta1.md
     - Using Latest Image: guides/using-latest-image.md
+    - Disable Cluster Features: guides/disable-cluster-features.md
   - Provider:
     - AWS Secrets Manager: provider/aws-secrets-manager.md
     - AWS Parameter Store: provider/aws-parameter-store.md

+ 1 - 1
pkg/provider/azure/keyvault/keyvault.go

@@ -124,7 +124,7 @@ func init() {
 
 // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
 func (a *Azure) Capabilities() esv1beta1.SecretStoreCapabilities {
-	return esv1beta1.SecretStoreReadOnly
+	return esv1beta1.SecretStoreReadWrite
 }
 
 // NewClient constructs a new secrets client based on the provided store.