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
- Correcting spelling issues

Change-Id: If5c0c3e763ddec5862ad5337e42d8cc8652bc41b
This commit is contained in:
Colleen Murphy 2015-06-26 12:38:46 -07:00
parent c718627edb
commit b262459ff9
2 changed files with 193 additions and 125 deletions

193
CHANGELOG.md Normal file
View File

@ -0,0 +1,193 @@
##2015-06-17 - 5.1.0
###Summary
This is a feature and bugfix release in the Juno series.
####Features
- Service Validation for Cinder-API
- Automate generation of NFS config file
- Make kombu_ssl_* parameters optional when rabbit_use_ssl => true
- Switch to TLSv1
- Add nfs_mount_options variable when backend is NetApp
- Add configuration helpers for Quobyte
- Implement HP 3par iscsi backend module
####Bugfixes
- Switch to using the new SolidFire driver name
- Create type-key only if it doesn't exist
- use lioadm on Fedora
- Change default MySQL collate to utf8_general_ci
####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-20 - 5.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Juno.
####Backwards-incompatible changes
- Change the default value of the san_thin_provision parameter for eqlx
- Migrate the mysql backend to use openstacklib::db::mysql, adding dependency
on puppet-openstacklib
####Features
- Add class to manage policy.json
- Add database tuning parameters
- Made keystone user creation optional when creating a service
- Add ability to hide secrets from logs
- Add parameters for netapp and and cinder-api workers
- Add support for the EMC VNX direct driver
- Add support for availability zones
####Bugfixes
- Correct the package name for cinder backup
##2014-10-16 - 4.2.0
###Summary
This is a feature and bugfix release in the Icehouse series.
####Features
- Add parameters to set cinder volume driver
- Add class for extended logging options
- Add option to specify endpoint protocol
- Add option to specify cinder volume path
- Add option to configure os_region_name in the cinder config
####Bugfixes
- Fix cinder type path issues
- Fix targetcli package dependency on target service
- Fix os version fact comparison for RedHat-based operating systems for
specifying service provider
##2014-06-19 - 4.1.0
###Summary
This is a feature and bugfix release in the Icehouse series.
####Features
- Add Cinder v2 endpoint support
- Add SSL support for Cinder API
- Add RabbitMQ SSL support
####Bugfixes
- Move default_volume_type to cinder::api
- Remove warnings for existing Cinder volumes
####Maintenance
- Pin major gems
##2014-01-29 - 4.0.0
###Summary
This is a backwards-incompatible major release for OpenStack Icehouse.
####Backwards-incompatible changes
- Remove control exchange flag
- Remove deprecated cinder::base class
- Update NetApp unified driver config options
####Features
- Update support for latest RabbitMQ module
- Add Glance support
- Add GlusterFS driver support
- Add region support
- Add support for MySQL module (>= 2.2)
- Add support for Swift and Ceph backup backend
- Add cinder::config to handle additional custom options
- Refactor duplicate code for single and multiple backends
####Bugfixes
None
##2014-04-15 - 3.1.1
###Summary
This is a bugfix release in the Havana series.
####Bugfixes
- Fix resource duplication bug
##2014-03-26 - 3.1.0
###Summary
This is a feature and bugfix release in the Havana series.
####Features
- Add default_volume_type as a Cinder API parameter
- Add parameter for endpoint protocols
- Deprecate glance_api_version
- Add support for VMDK
- Add support for Cinder multi backend
- Add support for https authentication endpoints
####Bugfixes
- Replace pip with native package manager (VMDK)
##2014-01-13 - 3.0.0
###Summary
This is a major release for OpenStack Havana but contains no API-breaking
changes.
####Features
- Add support for SolidFire
- Add support for ceilometer
####Bugfixes
- Fix bug for cinder-volume requirement
##2013-10-07 - 2.2.0
###Summary
This is a feature and bugfix release in the Grizzly series.
####Features
- Add support for rate limiting via api-paste.ini
- Add support to configure control_exchange
- Add parameter check to enable or disable db_sync
- Add syslog support
- Add default auth_uri setting for auth token
- Set package defaults to present
####Bugfixes
- Fix a bug to create empty init script when necessary
####Maintenance
- Various lint fixes
##2013-08-07 - 2.1.0
###Summary
This is a feature and bugfix release in the Grizzly series.
####Features
- Add configuration of Cinder quotas
- Add support for NetApp direct driver backend
- Add support for ceph backend
- Add support for SQL idle timeout
- Add support for RabbitMQ clustering with single IP
####Bugfixes
- Fix allowed_hosts/database connection bug
- Fix lvm2 setup failure for Ubuntu
- Remove unnecessary mysql::server dependency
####Maintenance
- Pinned RabbitMQ and database module versions
- Various lint and bug fixes
##2013-06-24 - 2.0.0
###Summary
Initial release on Stackforge.
####Features
- Nexenta, NFS, and SAN support added as cinder volume drivers
- Postgres support added
- The Apache Qpid and the RabbitMQ message brokers available as RPC backends
- Configurability of scheduler_driver

125
README.md
View File

@ -12,7 +12,6 @@ cinder
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
--------
@ -186,127 +185,3 @@ Contributors
------------
* https://github.com/stackforge/puppet-cinder/graphs/contributors
Release Notes
-------------
**5.1.0**
* Service Validation for Cinder-API
* Automates generation of NFS config file
* spec: pin rspec-puppet to 1.0.1
* Switch to using the new SolidFire driver name
* Makes kombu_ssl_* parameters optional when rabbit_use_ssl => true
* Switch to TLSv1
* Create type-key only if it doesn't exist
* use lioadm on Fedora
* Pin puppetlabs-concat to 1.2.1 in fixtures
* Add nfs_mount_options variable when backend is NetApp
* Change default MySQL collate to utf8_general_ci
* Add configuration helpers for Quobyte
* Implement HP 3par iscsi backend module
* Update .gitreview file for project rename
**5.0.0**
* Stable Juno release
* Added class to manage policy.json
* Changed the default value of the san_thin_provision parameter for eqlx
* Added database tuning parameters
* Made keystone user creation optional when creating a service
* Added ability to hide secrets from logs
* Added parameters for netapp and and cinder-api workers
* Corrected the package name for cinder backup
* Added support for the EMC VNX direct driver
* Migrated the mysql backend to use openstacklib::db::mysql
* Added support for availability zones
**4.2.0**
* Added parameters to set cinder volume driver
* Added class for extended logging options
* Added option to specify endpoint protocol
* Fixed cinder type path issues
* Added option to specify cinder volume path
* Fixed targetcli package dependency on target service
* Fixed os version fact comparison for RedHat-based operating systems
for specifying service provider
* Added option to configure os_region_name in the cinder config
**4.1.0**
* Added Cinder v2 endpoint support.
* Added SSL support for Cinder API.
* Added RabbitMQ SSL support.
* Moved default_volume_type to cinder::api
* Removed warnings for existing Cinder volumes.
* Pinned major gems.
**4.0.0**
* Stable Icehouse release.
* Updated NetApp unified driver config options.
* Updated support for latest RabbitMQ module.
* Added Glance support.
* Added GlusterFS driver support.
* Added region support.
* Added support for MySQL module (>= 2.2).
* Added support for Swift and Ceph backup backend.
* Added cinder::config to handle additional custom options.
* Refactored duplicate code for single and multiple backends.
* Removed control exchange flag.
* Removed deprecated cinder::base class.
**3.1.1**
* Fixed resource duplication bug.
**3.1.0**
* Added default_volume_type as a Cinder API parameter.
* Added parameter for endpoint procols.
* Deprecated glance_api_version.
* Added support for VMDK.
* Added support for Cinder multi backend.
* Added support for https authentication endpoints.
* Replaced pip with native package manager (VMDK).
**3.0.0**
* Major release for OpenStack Havana.
* Added support for SolidFire.
* Added support for ceilometer.
* Fixed bug for cinder-volume requirement.
**2.2.0**
* Added support for rate limiting via api-paste.ini
* Added support to configure control_exchange.
* Added parameter check to enable or disable db_sync.
* Added syslog support.
* Added default auth_uri setting for auth token.
* Set package defaults to present.
* Fixed a bug to create empty init script when necessary.
* Various lint fixes.
**2.1.0**
* Added configuration of Cinder quotas.
* Added support for NetApp direct driver backend.
* Added support for ceph backend.
* Added support for SQL idle timeout.
* Added support for RabbitMQ clustering with single IP.
* Fixed allowed_hosts/database connection bug.
* Fixed lvm2 setup failure for Ubuntu.
* Removed unnecessary mysql::server dependency.
* Pinned RabbitMQ and database module versions.
* Various lint and bug fixes.
**2.0.0**
* Upstream is now part of stackfoge.
* Nexenta, NFS, and SAN support added as cinder volume drivers.
* Postgres support added.
* The Apache Qpid and the RabbitMQ message brokers available as RPC backends.
* Configurability of scheduler_driver.
* Various cleanups and bug fixes.