Skip to content

add documentation for passwordstore usage #4219

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add documentation for passwordstore usage #4219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ If you **don't** use SSH keys for authentication, but rather a regular password,

If you **do** use SSH keys for authentication, **and** use a non-root user to *become* root (sudo), you may need to add `-K` (`--ask-become-pass`) to all Ansible commands.

If you use a password manager like `pass` or `gopass`, you can also add `ansible_become_password: "{{ lookup('community.general.passwordstore', 'path/to/password' }}"` to the hosts file. See the [documentation](https://docs.ansible.com/ansible/latest/collections/community/general/passwordstore_lookup.html) for more configuration options.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably better to mention Ansible Vault and how one could use that, before nudging people to use other tools (plugins from the community collection that integrate with other password managers).

Naturally, one may wish to use another password manager for storing the Ansible Vault encryption passphrase, but still.. Storing various sensitive variables in Ansible Vault sounds like a better go-to choice for most people.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, as a not-at-all-experienced Ansible user it took me two years to find out that there are more options than just --ask-become-pass, so I wanted to let more people know about this.

Yes, Ansible Vault as yet another option should definitely be mentioned in this documentation, but I would not call it a "better" option and then withheld the (go)pass way to go.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By now I really need to point out, that using the (go)pass option works™ … but it obviously requests the password from the store again on every single task – which made the playbook run slow down tremendously. It just took ~90 minutes here. So yeah, you are probably right. This should not be the second best option to be mentioned in the docs 😅


There 2 ways to start the installation process — depending on whether you're [Installing a brand new server (without importing data)](#installing-a-brand-new-server-without-importing-data) or [Installing a server into which you'll import old data](#installing-a-server-into-which-youll-import-old-data).

**Note**: if you are migrating from an old server to a new one, take a look at [this guide](maintenance-migrating.md) instead. This is an easier and more straightforward way than installing a server and importing old data into it.
Expand Down
3 changes: 2 additions & 1 deletion examples/hosts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
#
# To connect using a non-root user (and elevate to root with sudo later),
# replace `ansible_ssh_user=root` with something like this: `ansible_ssh_user=username ansible_become=true ansible_become_user=root`.
# If sudo requires a password, either add `ansible_become_password=PASSWORD_HERE` to the host line
# If sudo requires a password, either add `ansible_become_password=PASSWORD_HERE`
# or `ansible_become_password: "{{ lookup('community.general.passwordstore', 'path/to/password' }}"` to the host line,
# or tell Ansible to ask you for the password interactively by adding a `--ask-become-pass` (`-K`) flag to all `ansible-playbook` (or `just`) commands.
#
# For improved Ansible performance, SSH pipelining is enabled by default in `ansible.cfg`.
Expand Down
Loading