Skip to content

Commit cec11f5

Browse files
committed
Adjust README
Signed-off-by: Jan Steffen <[email protected]>
1 parent acae3d9 commit cec11f5

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,40 @@
77
[![GitHub release](https://img.shields.io/github/release/finleap-connect/vaultoperator.svg)](https://github.com/finleap-connect/vaultoperator/releases)
88

99
The `vault-operator` provides several CRDs to interact securely and indirectly with secrets.
10+
11+
## Quick start
12+
13+
Add the helm repository to your list of repos:
14+
15+
```bash
16+
$ helm repo add finleap-connect https://finleap-connect.github.io/charts/
17+
$ helm repo update
18+
```
19+
20+
Execute the following to get the complete list of values available:
21+
22+
```bash
23+
helm show values finleap-connect/vault-operator --version <VERSION>
24+
```
25+
26+
Configure at least the following settings within your `values.yaml` :
27+
```yaml
28+
# Configure Vault connection
29+
vault:
30+
addr: "" # Address of the Vault instance
31+
tls:
32+
secretName: "" # Specify secret containing CA to access Vault
33+
credentials:
34+
secretName: "" # Specify secret containing AppRole credentials as fields VAULT_ROLE_ID and VAULT_SECRET_ID, see https://www.vaultproject.io/docs/auth/approle
35+
namespace: "" # Which Vault namespace to connect to
36+
```
37+
38+
Install VaultOperator with the following command:
39+
40+
```bash
41+
$ helm install finleap-connect/vault-operator --name myrealease --version <VERSION> --values values.yaml
42+
```
43+
1044
## Details
1145

1246
Currently only _stage 1_ is implemented, which includes the `VaultSecret`-CRD.
@@ -97,4 +131,3 @@ The test suite needs the kubebuilder assets. If they are not installed in the de
97131
path make sure to set `KUBEBUILDER_ASSETS` before running tests.
98132
Similarly the vault CLI needs to be setup, if it is outside your `PATH` make sure to
99133
set `VAULT_ASSETS` to the directory containing the vault executable.
100-

0 commit comments

Comments
 (0)