-
Notifications
You must be signed in to change notification settings - Fork 59
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 for those not familiar with 1password Connect #150
Comments
Hey there. Thank you so much for the feedback regarding the documentation on this repo. I've raised this with my team and we will work on making an improvement on them. Thanks 😄 |
Sure! Thank you! |
Summary
I had a difficult time getting the operator set up in Kubernetes. A lot of it stemmed from my lack knowledge of 1password connect. This repo was my first time hearing about 1password's connect server. So when the documentation was pointing me to different repo for a different project (the connect helmchart) I was confused.
The credentials situation was also confusing to me since connect needs the json file, but the operator needs a token. However, it wasn't clear how to get the token nor if the token was different then the connect credentials. The current Readme.md also has the wrong
op
command to get the token:This command gives me the following error:
Finally, I wanted to use kustomize to download the helmchart and I didn't want the credentials json file in git. So I had to read the helm template to understand that as long as I set op-credenitlas to the base64 contents of the credentials json, I won't need to include the credentials in git.
Use cases
Better documentation would significantly improve user experience.
Proposed solution
I would suggest working with someone who does not have experience with 1password connect set up the operator and share the questions and issues that they had.
Is there a workaround to accomplish this today?
These are the steps I took to get it working in my environment:
1password-credentials.json
as a secretCreate a token in the 1password web ui under the integrations.
Add the token created in step 2 to kubectl
(if you add a space before you run the command it won't save in your git history)
kustomize build ./ --enable-helm | kubectl apply -f -
The text was updated successfully, but these errors were encountered: