Skip to content

Commit

Permalink
Merge pull request #4 from gkarthiks/feat/doc
Browse files Browse the repository at this point in the history
chore: adding details to readme
  • Loading branch information
gkarthiks authored Jul 26, 2020
2 parents 0aba394 + b907c31 commit c260213
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,13 @@

![](go-vault-balancer.png)

*Vault Load Balancer(VLB)* is a simple load balancer written in GoLang to help get HA of the Open Source Vault.

## How does it work
The VLB is based on round robin mechanism. Collects all the Vault Pod IP addresses by matching the label selector. Adds it to the list of available services.

Using the seal-status API of Vault, determines the availability of the vault pod. If a vault pod is available, and the seal-status of the pod is `unsealed`, then the corresponding pod will be marked alive and made available for queries.

## How to use VLB

To make use of VLB, the vault pods must be already initialized and unsealed. DIY initialization and unsealing or you can also use the [Vault Initializer](https://github.com/gkarthiks/vault-initializer). After doing so, deploy the VLB to achieve the HA of the vault pods.

0 comments on commit c260213

Please sign in to comment.