Browse Source

docs: replace logo, add support docs

Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>
Moritz Johner 4 years ago
parent
commit
544c439d7d

+ 19 - 54
README.md

@@ -1,71 +1,36 @@
-# External Secrets
-
-<img src="assets/round_eso_logo.png" width="100">
+<p align="center">
+    <img src="assets/eso-logo-large.png" width="30%" align="center" alt="external-secrets">
+</p>
 
 
-----
-
-The External Secrets Operator reads information from a third party service
-like [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) and automatically injects the values as [Kubernetes Secrets](https://kubernetes.io/docs/concepts/configuration/secret/).
+# External Secrets
+![ci](https://github.com/external-secrets/external-secrets/actions/workflows/ci.yml/badge.svg?branch=main)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5327/badge)](https://bestpractices.coreinfrastructure.org/projects/5947)
+[![Go Report Card](https://goreportcard.com/badge/github.com/external-secrets/external-secrets)](https://goreportcard.com/report/github.com/external-secrets/external-secrets)
+<a href="https://artifacthub.io/packages/search?repo=external-secrets"><img alt="Artifact Hub" src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/external-secrets" /></a>
+
+**External Secrets Operator** is a Kubernetes operator that integrates external
+secret management systems like [AWS Secrets
+Manager](https://aws.amazon.com/secrets-manager/), [HashiCorp
+Vault](https://www.vaultproject.io/), [Google Secrets
+Manager](https://cloud.google.com/secret-manager), [Azure Key
+Vault](https://azure.microsoft.com/en-us/services/key-vault/) and many more. The
+operator reads information from external APIs and automatically injects the
+values into a [Kubernetes
+Secret](https://kubernetes.io/docs/concepts/configuration/secret/).
 
 
 Multiple people and organizations are joining efforts to create a single External Secrets solution based on existing projects. If you are curious about the origins of this project, check out this [issue](https://github.com/external-secrets/kubernetes-external-secrets/issues/47) and this [PR](https://github.com/external-secrets/kubernetes-external-secrets/pull/477).
 Multiple people and organizations are joining efforts to create a single External Secrets solution based on existing projects. If you are curious about the origins of this project, check out this [issue](https://github.com/external-secrets/kubernetes-external-secrets/issues/47) and this [PR](https://github.com/external-secrets/kubernetes-external-secrets/pull/477).
 
 
-# Supported Backends
-
-- [AWS Secrets Manager](https://external-secrets.io/latest/provider-aws-secrets-manager/)
-- [AWS Parameter Store](https://external-secrets.io/latest/provider-aws-parameter-store/)
-- [Akeyless](https://www.akeyless.io/)
-- [Hashicorp Vault](https://www.vaultproject.io/)
-- [Google Cloud Secrets Manager](https://external-secrets.io/latest/provider-google-secrets-manager/)
-- [Azure Key Vault](https://external-secrets.io/latest/provider-azure-key-vault/)
-- [IBM Cloud Secrets Manager](https://external-secrets.io/latest/provider-ibm-secrets-manager/)
-- [Yandex Lockbox](https://external-secrets.io/latest/provider-yandex-lockbox/)
-- [Gitlab Project Variables](https://external-secrets.io/latest/provider-gitlab-project-variables/)
-- [Alibaba Cloud KMS](https://www.alibabacloud.com/product/kms) (Docs still missing, PRs welcomed!)
-- [Oracle Vault](https://external-secrets.io/latest/provider-oracle-vault)
-- [Generic Webhook](https://external-secrets.io/latest/provider-webhook)
-- [Kubernetes](https://external-secrets.io/latest/provider-kubernetes)
-
-## Stability and Support Level
-
-### Internally maintained:
-
-| Provider                                                                 | Stability |                                        Contact |
-| ------------------------------------------------------------------------ | :-------: | ---------------------------------------------: |
-| [AWS SM](https://external-secrets.io/latest/provider-aws-secrets-manager/)      |   stable   | [ESO Org](https://github.com/external-secrets) |
-| [AWS PS](https://external-secrets.io/latest/provider-aws-parameter-store/)      |   stable   | [ESO Org](https://github.com/external-secrets) |
-| [Hashicorp Vault](https://external-secrets.io/latest/provider-hashicorp-vault/) |   stable   | [ESO Org](https://github.com/external-secrets) |
-| [GCP SM](https://external-secrets.io/latest/provider-google-secrets-manager/)   |   stable | [ESO Org](https://github.com/external-secrets) |
-
-### Community maintained:
-
-| Provider                                                            | Stability |                  Contact                   |
-| ------------------------------------------------------------------- | :-------: | :----------------------------------------: |
-| [Azure KV](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 SM](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)          |
-| [Gitlab Project Variables](https://external-secrets.io/latest/provider-gitlab-project-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)                                 |
-| [Generic Webhook](https://external-secrets.io/latest/provider-webhook)  |  alpha  | [@willemm](https://github.com/willemm) |
-
 ## Documentation
 ## 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).
 
 
-## Support
-
-You can use GitHub's [issues](https://github.com/external-secrets/external-secrets/issues) to report bugs/suggest features or use GitHub's [discussions](https://github.com/external-secrets/external-secrets/discussions) to ask for help and figure out problems. You can also reach us at our KES and ESO shared [channel in Kubernetes slack](https://kubernetes.slack.com/messages/external-secrets).
-
-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.
-
 ## Contributing
 ## Contributing
 
 
 We welcome and encourage contributions to this project! Please read the [Developer](https://www.external-secrets.io/latest/contributing-devguide/) and [Contribution process](https://www.external-secrets.io/latest/contributing-process/) guides. Also make sure to check the [Code of Conduct](https://www.external-secrets.io/latest/contributing-coc/) and adhere to its guidelines.
 We welcome and encourage contributions to this project! Please read the [Developer](https://www.external-secrets.io/latest/contributing-devguide/) and [Contribution process](https://www.external-secrets.io/latest/contributing-process/) guides. Also make sure to check the [Code of Conduct](https://www.external-secrets.io/latest/contributing-coc/) and adhere to its guidelines.
 
 
 ## Bi-weekly Development Meeting
 ## Bi-weekly Development Meeting
 
 
-We host our development meeting every odd wednesday at [5:30 PM Berlin Time](https://dateful.com/time-zone-converter?t=17:30&tz=Europe/Berlin) on [Jitsi](https://meet.jit.si/SurroundingContentionsImportSubsequently). Meeting notes are recorded on [hackmd](https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA).
+We host our development meeting every odd wednesday at [5:30 PM Berlin Time](https://dateful.com/time-zone-converter?t=17:30&tz=Europe/Berlin) on [Jitsi](https://meet.jit.si/eso-community-meeting). Meeting notes are recorded on [hackmd](https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA).
 
 
 Anyone is welcome to join. Feel free to ask questions, request feedback, raise awareness for an issue or just say hi ;)
 Anyone is welcome to join. Feel free to ask questions, request feedback, raise awareness for an issue or just say hi ;)
 
 

File diff suppressed because it is too large
+ 1 - 0
assets/eso-icon.svg


BIN
assets/eso-logo-large.png


File diff suppressed because it is too large
+ 1 - 0
assets/eso-logo.svg


File diff suppressed because it is too large
+ 1 - 0
assets/eso-round-logo.svg


+ 1 - 1
deploy/charts/external-secrets/Chart.yaml

@@ -9,7 +9,7 @@ keywords:
   - kubernetes-external-secrets
   - kubernetes-external-secrets
   - secrets
   - secrets
 home: https://github.com/external-secrets/external-secrets
 home: https://github.com/external-secrets/external-secrets
-icon: https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/round_eso_logo.png
+icon: https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/eso-logo-large.png
 maintainers:
 maintainers:
   - name: mcavoyk
   - name: mcavoyk
     email: kellinmcavoy@gmail.com
     email: kellinmcavoy@gmail.com

+ 3 - 1
deploy/charts/external-secrets/README.md

@@ -1,6 +1,8 @@
 # External Secrets
 # External Secrets
 
 
-<p align="left"><img src="https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/round_eso_logo.png" width="100x" /></p>
+<p align="center">
+    <img src="https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/eso-logo-large.png" width="30%" align="center" alt="external-secrets">
+</p>
 
 
 [//]: # (README.md generated by gotmpl. DO NOT EDIT.)
 [//]: # (README.md generated by gotmpl. DO NOT EDIT.)
 
 

+ 1 - 1
deploy/charts/external-secrets/README.md.gotmpl

@@ -3,7 +3,7 @@
 {{- $org := "external-secrets" -}}
 {{- $org := "external-secrets" -}}
 # External Secrets
 # External Secrets
 
 
-<p align="left"><img src="https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/round_eso_logo.png" width="100x" /></p>
+<p align="left"><img src="https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/eso-logo-large.png" width="100x" /></p>
 
 
 [//]: # (README.md generated by gotmpl. DO NOT EDIT.)
 [//]: # (README.md generated by gotmpl. DO NOT EDIT.)
 
 

+ 1 - 1
docs/index.md

@@ -40,7 +40,7 @@ even opinions matter!
 How to get involved:
 How to get involved:
 
 
 - Bi-weekly Development Meeting every odd week at [5:30 PM Berlin Time](https://dateful.com/time-zone-converter?t=17:30&tz=Europe/Berlin)
 - Bi-weekly Development Meeting every odd week at [5:30 PM Berlin Time](https://dateful.com/time-zone-converter?t=17:30&tz=Europe/Berlin)
-  ([agenda](https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA), [jitsi call](https://meet.jit.si/SurroundingContentionsImportSubsequently))
+  ([agenda](https://hackmd.io/GSGEpTVdRZCP6LDxV3FHJA), [jitsi call](https://meet.jit.si/eso-community-meeting))
 - [Kubernetes Slack
 - [Kubernetes Slack
   #external-secrets](https://kubernetes.slack.com/messages/external-secrets)
   #external-secrets](https://kubernetes.slack.com/messages/external-secrets)
 - [Contributing Process](contributing-process.md)
 - [Contributing Process](contributing-process.md)

+ 2 - 0
docs/spec.md

@@ -1296,6 +1296,7 @@ ExternalSecretTarget
 </em>
 </em>
 </td>
 </td>
 <td>
 <td>
+<em>(Optional)</em>
 </td>
 </td>
 </tr>
 </tr>
 <tr>
 <tr>
@@ -1734,6 +1735,7 @@ ExternalSecretTarget
 </em>
 </em>
 </td>
 </td>
 <td>
 <td>
+<em>(Optional)</em>
 </td>
 </td>
 </tr>
 </tr>
 <tr>
 <tr>

+ 42 - 0
docs/stability-support.md

@@ -0,0 +1,42 @@
+This page lists the status, timeline and policy for currently supported ESO releases its providers.
+
+## External Secrets Operator
+
+We are currently in beta and support only the latest release.
+
+| ESO Version | Kubernetes Version |
+| ----------- | ------------------ |
+| 0.5.x       | 1.19 → 1.23        |
+| 0.4.x       | 1.16 → 1.23        |
+| 0.3.x       | 1.16 → 1.23        |
+
+## Provider Stability and Support Level
+
+| Provider                                                                                          | Stability |                                                                                                                                                                   Contact |
+| ------------------------------------------------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| [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) |
+| [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) |
+| [Gitlab Project Variables](https://external-secrets.io/latest/provider-gitlab-project-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) |
+| [Generic Webhook](https://external-secrets.io/latest/provider-webhook)                            |   alpha   |                                                                                                                                    [@willemm](https://github.com/willemm) |
+
+
+## Support Policy
+
+We provide technical support and provide 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
+  #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)
+
+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

@@ -83,4 +83,5 @@ nav:
     - Contributing Process: contributing-process.md
     - Contributing Process: contributing-process.md
     - Release Process: contributing-release.md
     - Release Process: contributing-release.md
     - Code of Conduct: contributing-coc.md
     - Code of Conduct: contributing-coc.md
+  - Stability and Support: stability-support.md
   - Deprecation Policy: deprecation-policy.md
   - Deprecation Policy: deprecation-policy.md