search

hashicorp / vault

A tool for secrets management, encryption as a service, and privileged access management
https://www.vaultproject.io/
Other
31.07k stars 4.2k forks source link

VAULT_CA_CERT documentation error #28725

Open evdtempel opened 4 days ago

evdtempel commented 4 days ago

The documentation incorrectly specifies VAULT_CA_CERT can be used as an ENV-var to configure a specific CA, in two documentation files:

However, the actual ENV-var that needs to be used is VAULT_CACERT: https://github.com/hashicorp/vault/blob/f2041b00e52e4503ed9f23a65142154b6c841ae3/api/client.go#L39

miagilepner commented 4 days ago

Thanks for reporting this! I agree that the top two examples should be changed, and I'll get that updated.

The bottom two examples reference the vault github action and they explain that secrets.VAULT_CA_CERT is a github secret in these examples and gets passed as the caCertificates parameter in the action. This secret can be named whatever value you like.

evdtempel commented 4 days ago

The bottom two examples reference the vault github action and they explain that secrets.VAULT_CA_CERT is a github secret in these examples and gets passed as the caCertificates parameter in the action. This secret can be named whatever value you like.

I realize that; I've included it in this issue as to remove any confusion as to what the ENV-var is supposed to be. Having that example mismatch can still nudge someone into a false direction, leading to very unneccessary time loss and frustration.