Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ramizpolic committed Oct 6, 2023
1 parent e611646 commit 32e99bf
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
<div style="text-align: center;">

# Secret Sync

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bank-vaults/secret-sync/ci.yaml?branch=main&style=flat-square)](https://github.com/bank-vaults/secret-sync/actions/workflows/ci.yaml?query=workflow%3ACI)
[![Go Report Card](https://goreportcard.com/badge/github.com/bank-vaults/secret-sync?style=flat-square)](https://goreportcard.com/report/github.com/bank-vaults/secret-sync)

Perform secret synchronization between secret stores (e.g. Hashicorp Vault to AWS Secret Manager) in a configurable manner.
Enable seamless interoperability between different secret stores and make use of explicit API to control when, what, and how to synchronize.
</div>

🧩 **Supported providers**

The list of providers is rather small since the project is still in its early stage.
We are actively working on expanding the list of supported providers,
as well as consolidating APIs across and for these providers.
### 🧩 Supported providers

| **Name** | **Status** |
|---------------------|----------------|
| HashiCorps Vault | alpha |
| Local Directory | alpha |

The list of providers is rather small since the project is still in its early stage.
We are actively working on expanding the list of supported providers,
as well as consolidating APIs across and for these providers.


> [!WARNING]
> This is an _early alpha version_ and there will be changes made to the API.
>
> You can support us with your feedback, bug reports, and feature requests.
## Goal
Expand Down Expand Up @@ -125,13 +128,9 @@ The output should contain something like:
* Login with `root` as token.
* Find `synced-secret-1`, `synced-secret-2`, and `synced-secret-3` keys.
Note that the values might be base64 encoded.
---

## Documentation

Here you can find documentation about various secret sync features and components.
You can use this as a reference point to create a more complete sync process based on given requirements.

### Secret Store
Secret store defines the actual secret store which will be used for API requests.
A secret store can be either a **source** where the secrets are synced from or a **target** where
Expand Down Expand Up @@ -196,6 +195,7 @@ sync:
```
Each sync action specifies one of four modes of operation depending on the specifications.
You can use this as a reference point to create a more complete sync process based on given requirements.
<details>
<summary>Action Spec: <b>Synchronize a secret from reference</b></summary>
Expand Down

0 comments on commit 32e99bf

Please sign in to comment.