document use_host_id default change #362
Description
I think that the change of default settings for use_host_id warrants a documentation update. When I tried the dev release recently, I kept getting prompted to enter a passphrase for my default key. When I tried entering my passphrase, I received an error saying, "Bad passphrase, try again…". It took me a while to realize that the vm would still provision as expected.
Eventually, using git bisect, I was able to track the issue down to the change linked to above. Part of my problem is presumably explained by the fact that the documentation for use_host_id mentions, that it Does not support identites that require a passphrase.
I'm not sure if this is something that should just get reflected in the release notes or whether it's better to also call it out in the docs, since it could be confusing to first time users who also happen to have a passphrase on their default key.