openstack/heat
Code Issues Proposed changes

Document user_data replace-on-update policy

Browse Source 
Since d4188127a1 the documentation for the
user_data property of OS::Nova::Server has been dangerously misleading,
stating that updates to the property don't cause replacement of the
resource, which is not true by default. This adds documentation that
explains exactly what is going on.

Change-Id: I2d95205fbcbd0bfafa6690a6efec1a56441ce22d
This commit is contained in:
Zane Bitter 2017-06-15 12:18:54 -04:00
parent 724d60949e
commit 3ffe67eaf4
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
heat/engine/resources/openstack/nova/server.py
View File

@ -538,7 +538,9 @@ class Server(server_base.BaseServer, sh.SchedulerHintsMixin,
),
USER_DATA: properties.Schema(
properties.Schema.STRING,
_('User data script to be executed by cloud-init.'),
_('User data script to be executed by cloud-init. Changes cause '
'replacement of the resource by default, but can be ignored '
'altogether by setting the `user_data_update_policy` property.'),
default='',
update_allowed=True
),