From ad5a41082e06f4cea94a4a8fa671fc82a32c3d38 Mon Sep 17 00:00:00 2001 From: Rickard von Essen Date: Mon, 13 Mar 2017 20:18:05 +0100 Subject: [PATCH] openstack: Updated docs for ssh_agent_auth and temporary_key_pair_name --- website/source/docs/builders/openstack.html.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/website/source/docs/builders/openstack.html.md b/website/source/docs/builders/openstack.html.md index a3920afa5..8ace2652b 100644 --- a/website/source/docs/builders/openstack.html.md +++ b/website/source/docs/builders/openstack.html.md @@ -144,14 +144,21 @@ builder. - `ssh_keypair_name` (string) - If specified, this is the key that will be used for SSH with the machine. By default, this is blank, and Packer will generate a temporary keypair. + [`ssh_password`](/docs/templates/communicator.html#ssh_password) is used. [`ssh_private_key_file`](/docs/templates/communicator.html#ssh_private_key_file) - must be specified with this. + or `ssh_agent_auth` must be specified when `ssh_keypair_name` is utilized. - `ssh_agent_auth` (boolean) - If true, the local SSH agent will be used to - authenticate connections to the source instance. No temporary key pair will - be used, and the values of `ssh_password` and `ssh_private_key_file` will - be ignored. Useful for when a temporary keypair can't be used, or when using - a certificate authority for SSH authentication. + authenticate connections to the source instance. No temporary keypair will + be created, and the values of `ssh_password` and `ssh_private_key_file` will + be ignored. To use this option with a key pair already configured in the source + image, leave the `ssh_keypair_name` blank. To associate an existing key pair + with the source instance, set the `ssh_keypair_name` field to the name + of the key pair. + +- `temporary_key_pair_name` (string) - The name of the temporary key pair + to generate. By default, Packer generates a name that looks like + `packer_`, where \ is a 36 character unique identifier. - `tenant_id` or `tenant_name` (string) - The tenant ID or name to boot the instance into. Some OpenStack installations require this. If not specified,