Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] Inconsistent README examples #547

Closed
acidprime opened this issue May 6, 2024 · 0 comments · Fixed by #554
Closed

[BUG] Inconsistent README examples #547

acidprime opened this issue May 6, 2024 · 0 comments · Fixed by #554
Labels
bug Something isn't working

Comments

@acidprime
Copy link

acidprime commented May 6, 2024

Vault server version

N/A

vault-action version

N/A

Describe the bug

The README has both secret/ and secret/data with no explanations. It makes it un-intuitive to figure out what format the secrets key uses without much troubleshooting. The data part of this path is new and realtive to the secret type and doesn't not existing logically in the vault command line and is an artifact more of the api.

We should also document WHY this format exists such as expounding on how the kv2 is involved in this path. This makes this Action difficult to setup with things like HCP cloud if you already need to specify a namespace. A full HCP working example ( and perhaps Terraform code example using the terraform provider) in the disclosure triangle for the vault configuration is needed.

Small inconsistencies in a project like this already has many other moving pieces makes it hard to setup and troubleshoot. I'd also recommend a full Github Actions OIDC example which is not currently fully documented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant