openstack_ssh_public_key is not in the playbooks/provisioning/openstack/README.md file.

[mbruzek]

Is this a BUG REPORT or FEATURE REQUEST? (choose one): BUG REPORT

Problem Description

The playbooks/provisioning/openstack/README.md file defines a variable openstack_ssh_key as a Nova keypair. Currently there is no variable named "openstack_ssh_key" in the entire project! (I am sure there was a variable with this name at some point.)

The provisioning/openstack/sample-inventory/group_vars/all.yml file does contain a key named "openstack_ssh_public_key" and the playbooks/provisioning/openstack/README.md file should be updated with the correct variable name.

However, this is very confusing because "openstack_ssh_public_key" should be the Nova keypair name (not a path to an actual public key), and a different variable "openstack_private_ssh_key" is a path to a private key.

Proposed Change

Change the name of this variable to reflect more accurately what the variable should be set to, such as "openstack_keypair_name" or "openstack_keypair".

Overview

Alternatives

If making this change is too dangerous or risky we should comment the variable in all.yml and update the README.md file to reflect the correct variable name.

Documentation Impact

Update playbooks/provisioning/openstack/README.md

Acceptance criteria

The playbooks/provisioning/openstack/README.md file should describes each OpenStack variable in all.yml so new developers can correctly run the OpenStack provisioning step.

[tzumainn]

Interesting! I'd suggest something like openstack_ssh_public_key_name, as this value eventually gets used as the value for a Heat template parameter named key_name. I don't know if this will be the highest immediate priority, though.

[tomassedovic]

Good catch! As it happens, I've just created a pull request that updates the readme and fixes this issue: #799

I'd like to spend some time cleaning up the variables and the sample inventories and this is a good suggestion. I'll try to make this happen before we do the first release.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale