1
0
Fork 0
mirror of https://github.com/external-secrets/external-secrets.git synced 2024-12-14 11:57:59 +00:00
external-secrets/README.md

61 lines
2.1 KiB
Markdown
Raw Normal View History

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
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
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
2020-11-23 14:21:01 +00:00
We will add more documentation once we have the implementation for the different providers.
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
2020-11-23 14:21:01 +00:00
## Planned 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.
2020-11-19 15:35:34 +00:00
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
![](assets/CS_logo_1.png)
![](assets/Godaddylogo_2020.png)