-
Notifications
You must be signed in to change notification settings - Fork 4
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
[DOCS] Configuration of custom mount for salt-master to use when authentication against vault is documented incorrectly. #68
Comments
Thanks a lot for taking the time to get to the bottom of this! Imo the best way forward is to correct the example AppRole configuration. Do you want to submit the fix yourself? Otherwise, I'll do it. On a side note, sorry about your setup issues. The docs could definitely be improved a lot, especially for beginners. If you want to voice any specific issues or have further questions, you're welcome to submit or ask them. :) Note that I don't monitor the mailing list (unsure how active it is these days). |
Hi @lkubb, Thanks for the prompt response.
I'd agree!
I'd be happy to help, but I'm not sure how I'd go about fixing https://salt-extensions.github.io/saltext-vault/topics/basic_configuration.html as it's outside of the repo.
It's been a steep learning curve but I'm getting there :) Thanks Steve |
Awesome :)
That's the compiled documentation, the source of which is part of this repo:
When I started using the legacy Salt-Vault integration, I climbed a similar steep curve – there was essentially no documentation to follow, just some hints and an outdated blog post by a third party. With the rewrite, I wanted to create much more detailed documentation. Sadly, once you're in too deep, it becomes more difficult to write beginner-friendly documentation... :) I really think you can make a difference here.
If it's helpful for other people and you're fine with it, I'd like to make it part of the official docs. Once you're finished, you can create a new doc page, e.g. |
@sscotter I just merged the doc fix myself. If you want to publish your guide here at some point, you're very welcome to open a PR. :) Thanks again for taking the time to investigate and sorry about the oversight! |
Description
Documentation at https://salt-extensions.github.io/saltext-vault/topics/basic_configuration.html say it should be configured as below.
However, this doesn't work. The salt master makes requests to the default /auth/approle/login rather than auth/salt-master-approle/login as expected.
However the documentation at https://github.com/salt-extensions/saltext-vault/blob/main/docs/ref/configuration.md#approle_mount indicates it should be
Note the third line is different (
mount
vsapprole_mount
). Usingapprole_mount
works as expected.Suggested Fix
Either one of the following
auth:auth:mount
instead ofauth:auth:approle_mount
and update https://github.com/salt-extensions/saltext-vault/blob/main/docs/ref/configuration.md to matchI'll leave it to you to decide what makes the most sense.
Location or format of documentation
Additional context
My, discussing with myself on Salt Users discussion group trying to get the bottom of the issue.
The text was updated successfully, but these errors were encountered: