Add release note for generated sample environments

This was missed in the original patch series, but this is a
significant enough change that it needs to be communicated to users.

Change-Id: Ibcfdde3cc544d152e78529fc57a63c7dc6592c4f
This commit is contained in:
Ben Nemec 2017-06-20 14:53:19 -05:00
parent f3b2e14430
commit 2cd328d79d
1 changed files with 21 additions and 0 deletions

View File

@ -0,0 +1,21 @@
---
features:
- |
There is now a tool in tripleo-heat-templates, similar to the
oslo-config-generator, that can be used to programmatically generate
sample environment files based directly on the contents of the templates
themselves. This ensures consistency in the sample environments, as well
as making it easier to update environments to reflect changes to the
templates.
upgrade:
- |
Some sample environment files will be moving as part of the work to
generate them programmatically. The old versions will be left in place for
one cycle to allow a smooth upgrade process. When upgrading, if any of the
environment files in use for the deployment have been deprecated they
should be replaced with the new generated verions.
deprecations:
- |
Where a generated sample environment replaces an existing one, the existing
environment is deprecated. This will be noted in a comment at the top of
the file.