Split release notes into a CHANGELOG.md file

This patch splits out release notes into a separate dedicated file for
consistency with the puppetlabs puppet modules. Additionally, this
patch improves the release notes by:

- Fixing the tense to be consistent with commit message standards ("Add
  new feature" instead of "Added new feature" or "Adds new feature")
- Breaking up changes into categories to make it easier for operators
  to know what happened in the change: backwards-incompatible changes,
  features, bugfixes, and maintenance commits
- Linewrapping to 80 chars
- Adding release dates, formatted according to ISO-8601

Change-Id: I015761a2f063b08f393e69c9ef6ba33a9a32003e
This commit is contained in:
Colleen Murphy 2015-06-26 13:14:13 -07:00
parent 93f79bb56d
commit d0b89d242a
2 changed files with 167 additions and 110 deletions

167
CHANGELOG.md Normal file
View File

@ -0,0 +1,167 @@
##2015-06-17 - 5.1.0
###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Add service validation for Glance-API
- Switch to TLSv1
- Makes kombu_ssl_* parameters optional when rabbit_use_ssl => true
- Allow overriding package ensure for glance-registry
- Add openstack tag to glance packages
- Create a sync_db boolean for Glance
- Command parameter to sync the correct Database
- Add $notification_driver parameter to notify::rabbitmq
####Bugfixes
- Move rbd related options into glance_store section
- Change default MySQL collate to utf8_general_ci
- Correctly munge glance_image is_public property
- Fix catalog compilation when not configuring endpoint
- Fix is_public munge
####Maintenance
- spec: pin rspec-puppet to 1.0.1
- Pin puppetlabs-concat to 1.2.1 in fixtures
- Update .gitreview file for project rename
##2014-11-24 - 5.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Juno.
####Backwards-incompatible changes
- Bump stdlib dependency to >=4.0.0
- Migrate the mysql backend to use openstacklib::db::mysql, adding dependency
on puppet-openstacklib
####Features
- Add ceilometer::policy to control policy.json
- Add parameter os_region_name to glance::api
- Add support for vSphere datastore backend
- Update the calls to the glance command-line utility
- Add parameter swift_store_large_object_size to glance::backend::swift
- Add parameter command_options to glance::cache::cleaner and
glance::cache::pruner
- Add parameter package_ensure to glance::backend::rbd
- Add parameter manage_service to various classes
- Add parameters to control whether to configure users
- Add parameter registery_client_protocol to glance::api
####Bugfixes
- Fix bug in glance_image type
- Fix ssl parameter requirements for kombu and rabbit
##2014-10-16 - 4.2.0
###Summary
This is a feature release in the Icehouse series.
####Features
- Add ability to hide secret type parameters from logs
##2014-06-19 - 4.1.0
###Summary
This is a feature and bugfix release in the Icehouse series.
####Features
- Add multiple rabbit hosts support.
- Add image_cache_dir parameter.
- Deprecate old SQL parameters.
####Bugfixes
- Fix the Glance add_image parser for new client.
- Fix values in get_glance_image_attrs.
- Fix 'could not find user glance' bug.
####Maintenance
- Pin major gems.
##2014-05-01 - 4.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Icehouse.
####Backwards-incompatible changes
- Remove deprecated notifier_stratgy parameter.
####Features
- Add glance::config to handle additional custom options.
- Add known_stores option for glance::api.
- Add copy-on-write cloning of images to volumes.
- Add support for puppetlabs-mysql 2.2 and greater.
- Add support for python-glanceclient v2 API update.
- Deprecate show_image_direct_url in glance::rbd.
##2014-03-26 - 3.1.0
###Summary
This is a feature and bugfix release in the Havana series.
####Features
- Add availability to configure show_image_direct_url.
- Add support for https authentication endpoints.
- Enable ssl configuration for glance-registry.
- Explicitly set default notifier strategy.
####Bugfixes
- Remove Keystone client warnings.
##2014-01-09 - 3.0.0
###Summary
This is a major release for OpenStack Havana but contains no API-breaking
changes.
####Features
- Add Cinder backend to image storage.
####Bugfixes
- Fix bug to ensure keystone endpoint is set before service starts.
- Fix qpid_hostname bug.
##2013-10-07 - 2.2.0
###Summary
This is a feature and bugfix release in the Grizzly series.
####Features
- Add syslog support.
- Add support for iso disk format.
####Bugfixes
- Fix bug to allow support for rdb options in glance-api.conf.
- Fix bug for rabbitmq options in notify::rabbitmq.
- Remove non-implemented glance::scrubber class.
##2013-08-07 - 2.1.0
###Summary
This is a feature and bugfix release in the Grizzly series.
####Features
- Add glance-cache-cleaner and glance-cache-pruner.
- Add ceph/rdb support.
- Add retry for glance provider to account for service startup time.
- Add support for both file and swift backends.
####Bugfixes
- Fix allowed_hosts/database access bug.
- Fix glance_image type example.
- Remove unnecessary mysql::server dependency.
- Remove --silent-upload option.
- Remove glance-manage version_control.
####Maintenance
- Pin rabbit and mysql module versions.
##2013-06-24 - 2.0.0
###Summary
Initial release on Stackforge.
####Features
- Add postgresql support.

110
README.md
View File

@ -12,7 +12,6 @@ glance
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
7. [Contributors - Those with commits](#contributors)
8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
Overview
--------
@ -147,112 +146,3 @@ Contributors
------------
* https://github.com/stackforge/puppet-glance/graphs/contributors
Release Notes
-------------
**5.1.0**
* Service Validation for Glance-API
* Switch to TLSv1
* spec: pin rspec-puppet to 1.0.1
* Makes kombu_ssl_* parameters optional when rabbit_use_ssl => true
* Allow overriding package ensure for glance-registry
* Move rbd related options into glance_store section
* Pin puppetlabs-concat to 1.2.1 in fixtures
* change default MySQL collate to utf8_general_ci
* Add openstack tag to glance packages
* Correctly munge glance_image is_public property
* Create a sync_db boolean for Glance
* Command parameter to sync the correct Database
* Fix catalog compilation when not configuring endpoint
* Add $notification_driver parameter to notify::rabbitmq
* Fix is_public munge
* Update .gitreview file for project rename
**5.0.0**
* Stable Juno release
* Added ceilometer::policy to control policy.json
* Fixed bug in glance_image type
* Added parameter os_region_name to glance::api
* Added support for vSphere datastore backend
* Updated the calls to the glance command-line utility
* Added parameter swift_store_large_object_size to glance::backend::swift
* Bumped stdlib dependency to >=4.0.0
* Added parameter command_options to glance::cache::cleaner and glance::cache::pruner
* Added parameter package_ensure to glance::backend::rbd
* Added parameter manage_service to various classes
* Added parameters to control whether to configure users
* Migrated the glance::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
* Added parameter registery_client_protocol to glance::api
* Fixed ssl parameter requirements for kombu and rabbit
**4.2.0**
* Added ability to hide secret type parameters from logs
**4.1.0**
* Added multiple rabbit hosts support.
* Added image_cache_dir parameter.
* Deprecated old SQL parameters.
* Fixed the Glance add_image parser for new client.
* Fixed values in get_glance_image_attrs.
* Fixed 'could not find user glance' bug.
* Pinned major gems.
**4.0.0**
* Stable Icehouse release.
* Added glance::config to handle additional custom options.
* Added known_stores option for glance::api.
* Added copy-on-write cloning of images to volumes.
* Added support for puppetlabs-mysql 2.2 and greater.
* Added support for python-glanceclient v2 API update.
* Removed deprecated notifier_stratgy parameter.
* Deprecated show_image_direct_url in glance::rbd.
**3.1.0**
* Added availability to configure show_image_direct_url.
* Removed Keystone client warnings.
* Added support for https authentication endpoints.
* Enabled ssl configuration for glance-registry.
* Explicitly sets default notifier strategy.
**3.0.0**
* Major release for OpenStack Havana.
* Fixed bug to ensure keystone endpoint is set before service starts.
* Added Cinder backend to image storage.
* Fixed qpid_hostname bug.
**2.2.0**
* Added syslog support.
* Added support for iso disk format.
* Fixed bug to allow support for rdb options in glance-api.conf.
* Fixed bug for rabbitmq options in notify::rabbitmq.
* Removed non-implemented glance::scrubber class.
* Various lint and bug fixes.
**2.1.0**
* Added glance-cache-cleaner and glance-cache-pruner.
* Added ceph/rdb support.
* Added retry for glance provider to account for service startup time.
* Added support for both file and swift backends.
* Fixed allowed_hosts/database access bug.
* Fixed glance_image type example.
* Removed unnecessary mysql::server dependency.
* Removed --silent-upload option.
* Removed glance-manage version_control.
* Pinned rabbit and mysql module versions.
* Various lint and bug fixes.
**2.0.0**
* Upstream is now part of stackfoge.
* Added postgresql support.
* Various cleanups and bug fixes.