2020-11-19 15:35:34 +00:00
# External Secrets
2021-02-10 14:14:02 +00:00
< img src = "assets/round_eso_logo.png" width = "100" >
2021-02-10 14:10:13 +00:00
----
2020-11-20 10:25:44 +00:00
The External Secrets Kubernetes operator reads information from a third party service
2020-11-23 14:21:01 +00:00
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/ ).
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
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 ).
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
< a name = "original-projects" > < / a >
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
# ⚠️ Please bear in mind
2020-11-19 15:35:34 +00:00
2021-03-01 07:31:02 +00:00
While this project is not ready, you might consider using the following:
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
- [Kubernetes External Secrets ](https://github.com/external-secrets/kubernetes-external-secrets )
- [Secrets Manager ](https://github.com/itscontained/secret-manager )
- [External Secrets Operator ](https://github.com/ContainerSolutions/externalsecret-operator/ )
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
## Installation
2020-11-24 08:48:19 +00:00
Clone this repository:
2020-11-23 14:21:01 +00:00
```shell
git clone https://github.com/external-secrets/external-secrets.git
```
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
Install the Custom Resource Definitions:
```shell
make install
```
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
Run the controller against the active Kubernetes cluster context:
```shell
make run
```
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
Apply the sample resources:
```shell
kubectl apply -f config/samples/external-secrets_v1alpha1_secretstore.yaml
2021-01-06 15:49:59 +00:00
kubectl apply -f config/samples/external-secrets_v1alpha1_externalsecret.yaml
2020-11-23 14:21:01 +00:00
```
2020-11-19 15:35:34 +00:00
2021-05-06 10:45:34 +00:00
If you want to use helm:
```shell
helm repo add external-secrets https://charts.external-secrets.io
helm install RELEASE_NAME external-secrets/external-secrets
```
We will add more documentation once we have the implementation for the different providers. You can find some here: https://external-secrets.io
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
< a name = "features" > < / a >
2020-11-19 15:35:34 +00:00
2021-05-06 10:45:34 +00:00
## Features
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
- Support to multiple Provider stores (AWS Secret Manager, GCP Secret Manger, Vault and more) simultaneously.
- Multiple External Secrets operator instances for different contexts/environments.
- A custom refresh interval to sync the data from the Providers, syncing your Kubernetes Secrets up to date.
- Select specific versions of the Provider data.
2021-05-06 10:45:34 +00:00
- Advanced [templating ](https://external-secrets.io/guides-templating/ )
2020-11-19 15:35:34 +00:00
2021-03-03 12:55:58 +00:00
< a name = "contributing" > < / a >
## Contributing
We welcome and encourage contributions to this project! Please read the [Developer ](https://www.external-secrets.io/contributing-devguide/ ) and [Contribution process ](https://www.external-secrets.io/contributing-process/ ) guides. Also make sure to check the [Code of Conduct ](https://www.external-secrets.io/contributing-coc/ ) and adhere to its guidelines.
2020-11-23 14:21:01 +00:00
< a name = "partners" > < / a >
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
## Kicked off by
2020-11-19 15:35:34 +00:00
2020-11-23 14:21:01 +00:00
