tripleo-heat-templates/releasenotes/notes/roles_deprecated_params-50b4bbe8b9e4abc7.yaml
Steven Hardy 1aad286ca3 Convert controller-role.yaml to role.role.j2.yaml
Add deprecated role-specific parameters to role definition, in
order to special-case some parameters for backwards compatibility,
such that the Controller role can be rendered via j2 for support
of composable networks.

Co-Authored By: Dan Sneddon <dsneddon@redhat.com>
Change-Id: I5983f03ae1b7f0b6add793914540b8ca405f9b2b
Partially-Implements: blueprint composable-networks
2017-08-11 15:06:34 +01:00

22 lines
1.2 KiB
YAML

---
deprecations:
- |
The static role definitions contained a number of conflicting parameters
which require special handling to convert to dynamic template generation.
In the future, these parameters will be removed. If a role requires one
of these deprecated parameters, then it will be defined in the role
definition in a property named "deprecated_param_<name>". If the role has one
or more deprecated parameters, then "uses_deprecated_params" should be
set to True as well. This will enable creation of a parameter_group
containing the deprecated parameters in the role definition, which will enable
warning users if they use deprecated parameters on deployment.
upgrade:
- |
For deployments where a custom roles_data file is used, it should be rebased
against the default roles_data.yaml, as several additional items, e.g to
specify deprecated parameter names for some of the default roles, have been
added. Alternatively you can regenerate your roles_data using the new
overcloud roles generate command, so that the updated role definitions in
/usr/share/openstack-tripleo-heat-templates/roles are used, which include
the necessary additional data.