[libcloud] 04/06: Clarify the need to install an SSH key.

[to...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tomaz pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/libcloud.git

commit b49ed7e953ecacc35d42953245e7a95ee72b374c
Author: Tomaz Muraus <to...@tomaz.me>
AuthorDate: Fri Dec 20 23:13:44 2019 +0100

    Clarify the need to install an SSH key.
---
 docs/examples/compute/gce/deploy_node.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/examples/compute/gce/deploy_node.py b/docs/examples/compute/gce/deploy_node.py
index 44f547d..9ea4cab 100644
--- a/docs/examples/compute/gce/deploy_node.py
+++ b/docs/examples/compute/gce/deploy_node.py
@@ -39,7 +39,13 @@ image = [i for i in images if i.name == 'ubuntu-1604-xenial-v20191217'][0]
 size = [s for s in sizes if s.name == 'e2-micro'][0]
 
 # NOTE: We specify which public key is installed on the instance using
-# metadata functionality
+# metadata functionality.
+# Keep in mind that this step is only needed if you want to install a specific
+# key which is used to run the deployment script.
+# If you are using a VM image with a public SSH key already pre-baked in or if
+# you use project wide ssh-keys GCP functionality, you can remove ex_metadata
+# argument, but you still need to make sure the private key you use inside this
+# script matches the one which is installed / available on the server.
 ex_metadata = metadata = {
     'items': [
         {