From 937073b0ca7b854dba6c2fa989ad1e0111835bfd Mon Sep 17 00:00:00 2001 From: Marc Sauter Date: Mon, 14 Mar 2022 23:12:20 +0100 Subject: [PATCH] docs: add app role auth method --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index aed5d5d..0a8d9a8 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,15 @@ The usual environment variables for Vault will be used: ## Configuration - VAULT_ROLE - Required the name of the Vault role to use for authentication. +> For a successful Kubernetes authentication the environment variable VAULT_ROLE must be set. + +...or... + +- VAULT_ROLE_ID - see https://www.vaultproject.io/docs/auth/approle +- VAULT_SECRET_ID - see https://www.vaultproject.io/docs/auth/approle + +> If the environment variables VAULT_ROLE_ID and VAULT_SECRET_ID are set, AppRole Auth Method will be used, Kubernetes Auth Method otherwise. + - VAULT_TOKEN_PATH - the destination path on disk to store the token. Usually this is a shared volume.