From e1d20a669570ba5a2e754967dc4fcbba6fb8d7b4 Mon Sep 17 00:00:00 2001
From: Dan Bode <bodepd@gmail.com>
Date: Wed, 4 May 2016 16:19:21 -0700
Subject: [PATCH] Document that ssh_public_key_path must be set

The public key parameter should be set and
point to the public key that you wish to
inject into systems built with ironic.

Otherwise, the ansible deploy call fails.

Change-Id: I986bb9cabf44ad8940a8e57a37435e3880bc5c01
---
 README.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.rst b/README.rst
index 3a530138d..224e22e0d 100644
--- a/README.rst
+++ b/README.rst
@@ -343,6 +343,13 @@ To utilize the newer dynamic inventory based deployment::
   export BIFROST_INVENTORY_SOURCE=/tmp/baremetal.json
   ansible-playbook -vvvv -i inventory/bifrost_inventory.py deploy-dynamic.yaml
 
+Note::
+
+  Before running the above command, ensure that the value for `ssh_public_key_path` in
+  ``./playbooks/inventory/group_vars/baremetal`` refers to a valid public key file,
+  or set the ssh_public_key_path option on the ansible-playbook command line by
+  setting the variable. Example: "-e ssh_public_key_path=~/.ssh/id_rsa.pub"
+
 Testing with a single command
 =============================