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

Unclear documentation and VaultInvalidConfigError #15

Open
alzaki-clgx opened this issue Apr 26, 2023 · 3 comments
Open

Unclear documentation and VaultInvalidConfigError #15

alzaki-clgx opened this issue Apr 26, 2023 · 3 comments

Comments

@alzaki-clgx
Copy link

alzaki-clgx commented Apr 26, 2023

The Wiki does not provide a basic example to answer the following:

"I have VAULT_TOKEN, VAULT_ADDR, and I provide the path in the following code:

const Value = await vault({
      method: 'read',
      path: '.../.../.../KEY'
    })

These three things should be enough to retrieve a value from my vault's kv pair, ergo what is an example of the simplest config that need only these 3 things to make my app not land me in the same puddle as this person: https://stackoverflow.com/questions/76114726/vaultinvalidconfigerror-how-can-i-add-a-simple-config-to-typescriptss-vault-ap"

Secondly, I read the docs and realize that I should first create a vault-api instance
Screenshot 2023-04-26 at 1 35 52 PM

However as seen above my 2023.1 IntelliJ with Version 4.9.5 TypeScript doesn't know what create is.
I haveimport vault from 'vault-api'; and I got that from npmjs

@mjeghers-tmx
Copy link

Yes this documentation is very sparse, and I am left with no idea how to make a simple "Hello World"-level example program work. The code snippers given don't work and I don't know what else is needed.

Please document better!

@alzaki-clgx
Copy link
Author

I emailed SBR but no response yet, I am compelled to open a Pull Request but until then I'm going to use https://stackoverflow.com/questions/65702556/vault-hashicorp-curl-equivalent-of-vault-read

@alzaki-clgx
Copy link
Author

@bshreddy is back online!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants