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

Improve documentation regarding kamus-cli encrypt with Azure KeyVault #380

Open
jozala opened this issue Nov 26, 2019 · 3 comments
Open
Labels
documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jozala
Copy link

jozala commented Nov 26, 2019

General remarks
Aim of this issue is to provide clear documentation on how to use kamus-cli when using Azure KeyVault.

Is your feature request related to a problem? Please describe.
I've spend a lot of time trying to understand why I cannot encrypt secret with kamus using Azure KeyVault. It was unclear for me how I should use kamus-cli to encypt it and I was suspecting this is an issue. The problem was with permissions in Azure, but I've spent some time trying to fix it with CLI arguments. There are parameters like --auth-tenant, --auth-application and --auth-resource and it is unclear when to use them.

Describe the solution you'd like

Documentation could contain description with example on how to use kamus-cli when using Azure KeyVault. Additionally it should explain when and how to use parameters --auth-tenant, --auth-application and --auth-resource .

Describe alternatives you've considered

What would also help in my case is better error message, explaining what permissions are missing on service principal for Azure KeyVault. There is separate ticket #37 which can handle that.

@omerlh omerlh added documentation good first issue Good for newcomers help wanted Extra attention is needed labels Feb 22, 2020
@omerlh
Copy link
Contributor

omerlh commented Feb 22, 2020

Looking on kamus cli doc, look like there is a specific section for auth - could you clarify what we can improve there?

@jozala
Copy link
Author

jozala commented Feb 23, 2020

Adding an example would definitely let me better understand which parameters should I use and could save me some time..
Mentioned documentation describes parameters shortly and if they are required, but I believe it would be valuable also to write in what cases these parameters have to be set and when they are not needed.

@bd-g
Copy link

bd-g commented Sep 15, 2021

+1 here. Have spend the better part of the day trying to figure out how to use Kamus with Azure KeyVault.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants