mirror of
https://github.com/external-secrets/external-secrets.git
synced 2024-12-15 17:51:01 +00:00
67 lines
2.5 KiB
Markdown
67 lines
2.5 KiB
Markdown
# External Secrets
|
|
|
|
<img src="assets/round_eso_logo.png" width="100">
|
|
|
|
----
|
|
|
|
The External Secrets Kubernetes 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/).
|
|
|
|
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).
|
|
|
|
<a name="original-projects"></a>
|
|
|
|
# ⚠️ Please bear in mind
|
|
|
|
While this project is not ready, you might consider using the following:
|
|
|
|
- [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/)
|
|
|
|
## Installation
|
|
Clone this repository:
|
|
```shell
|
|
git clone https://github.com/external-secrets/external-secrets.git
|
|
```
|
|
|
|
Install the Custom Resource Definitions:
|
|
```shell
|
|
make install
|
|
```
|
|
|
|
Run the controller against the active Kubernetes cluster context:
|
|
```shell
|
|
make run
|
|
```
|
|
|
|
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
|
|
```
|
|
|
|
We will add more documentation once we have the implementation for the different providers.
|
|
|
|
<a name="features"></a>
|
|
|
|
## Planned Features
|
|
|
|
- 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.
|
|
|
|
|
|
<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.
|
|
|
|
<a name="partners"></a>
|
|
|
|
## Kicked off by
|
|
|
|
|
|
|