Skip to content

Commit

Permalink
- Added "How it works" in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dmakeroam committed Apr 4, 2021
1 parent f768b2f commit a75dba0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Cloud Secret Resolvers is a set of tools to help your applications (on Kubernete
- [CSR](#csr)
- [Installation](#installation)
- [Using on Kubernetes](#using-on-kubernetes)
- [How it works](#how-it-works)

<!-- /TOC -->

Expand Down Expand Up @@ -66,4 +67,11 @@ Cloud Secret Resolvers is available on Linux, ARM, macOS and Windows platforms.
- Coming Soon!

- Google Cloud
- Coming Soon!
- Coming Soon!

## How it works
The architecture looks like below.

Internally, the `CSR` find local environment variables in the Kubernetes Pod Container which have Cloud Vault key placeholders for example: export db_username=${db_username}, then the `CSR` will extract db_username as a key and ${db_username} as a value. Finally, the `CSR` will use ${db_username} to match cloud vault key, retrieve cloud vault value, and map the value with db_username local environment.

![Diagram](https://github.com/kubeopsskills/cloud-secret-resolvers/blob/main/assets/diagram.png)
Binary file added assets/diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a75dba0

Please sign in to comment.