Updated to match semver and release notes.

Before this update the Modulefile was not following semver in
relation to stable/havana, and the README files were not in sync.
This update introduces proper semver and consistency.

Change-Id: I9ecce6a74fa139d339d8c5d9c7392c3d8c3344ec

diff --git a/Modulefile b/Modulefile
index dfc125f0a50b0aa32442a5664854ae14c9a4c63a..48cb3c8f7a72948350e29f8902505dc8896aa47d 100644 (file)
--- a/Modulefile
+++ b/Modulefile
@@ -1,13 +1,14 @@
-name    'enovance-ceilometer'
-version '0.0.1'
-source 'none'
+name    'puppetlabs-ceilometer'
+version '4.0.0-devel'
+source 'https://github.com/stackforge/puppet-ceilometer'
 author 'enovance'
 license 'Apache License, Version 2.0'
 summary 'Install/configure Openstack Ceilometer'
 description 'Install/configure Openstack Ceilometer'
-project_page 'https://launchpad.net/ceilometer'
+project_page 'https://launchpad.net/puppet-ceilometer'
 
 # Dependencies
+dependency 'puppetlabs/inifile', '>=1.0.0 <2.0.0'
+dependency 'puppetlabs/keystone', '>=4.0.0 <5.0.0'
+dependency 'puppetlabs/mysql', '>=0.9.0 <1.0.0'
 dependency 'puppetlabs/stdlib', '>= 3.2.0'
-dependency 'cprice404/inifile', '>= 0.9.0'
-dependency 'puppetlabs/mysql', '>=0.6.1 <1.0.0'

diff --git a/README b/README
deleted file mode 100644 (file)
index 4dcb005..0000000
--- a/README
+++ /dev/null
@@ -1,32 +0,0 @@
-puppet-ceilometer
-
-This is the ceilometer module.
-
-Limitations
---------------------------
-
-The Ceilometer Openstack service depends on a sqlalchemy database. If you are using puppetlabs-mysql to achieve this, there is a parameter called mysql_module that can be used to swap between the two supported versions: 0.9 and 2.2. This is needed because the puppetlabs-mysql module was rewritten and the custom type names have changed between versions.
-
-License
--------
-
-Apache License 2.0
-
-   Copyright 2012 eNovance <licensing@enovance.com>
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
-Contact
--------
-
-techs@enovance.com

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..7bdd41d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,115 @@
+Ceilometer
+==========
+
+#### Table of Contents
+
+1. [Overview - What is the ceilometer module?](#overview)
+2. [Module Description - What does the module do?](#module-description)
+3. [Setup - The basics of getting started with ceilometer](#setup)
+4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
+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
+--------
+
+The ceilometer module is part of [Stackforge](https://github.com/stackforge), an effort by the
+OpenStack infrastructure team to provice continuous integration testing and code review for
+OpenStack and OpenStack community projects not part of the core software. The module itself
+is used to flexibly configure and manage the metering service for OpenStack.
+
+Module Description
+------------------
+
+The ceilometer module is an attempt to make Puppet capable of managing the entirety of ceilometer.
+This includes manifests to provision the ceilometer api, agents, and database stores. A
+ceilometer_config type is supplied to assist in the manipulation of configuration files.
+
+Setup
+-----
+
+**What the ceilometer module affects**
+
+* ceilometer, the metering service for OpenStack
+
+### Installing ceilometer
+
+  example% puppet module install puppetlabs/ceilometer
+
+### Beginning with ceilometer
+
+Implementation
+--------------
+
+### ceilometer
+
+ceilometer is a combination of Puppet manifests and Ruby code to deliver configuration and
+extra functionality through types and providers.
+
+Limitations
+-----------
+
+* The ceilometer modules have only been tested on RedHat and Ubuntu family systems.
+
+Development
+-----------
+
+Developer documentation for the entire puppet-openstack project
+
+* https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
+
+Contributors
+------------
+
+* https://github.com/stackforge/puppet-ceilometer/graphs/contributors
+
+This is the ceilometer module.
+
+Release Notes
+-------------
+
+** 3.1.1 **
+
+* Removed enforcement of glance_control_exchange.
+* Fixed user reference in db.pp.
+* Allow db fields configuration without need for dbsync for better replicaset support.
+* Fixed alarm package parameters Debian/Ubuntu.
+
+
+** 3.1.0 **
+
+* Fixed package ceilometer-alarm type error on Debian.
+* Remove log_dir from params and make logs configurable in init.
+* Removed glance_notifications from notification_topic.
+* Don't match commented [DEFAULT] section.
+
+** 3.0.0 **
+
+* Initial release of the puppet-ceilometer module.
+
+
+License
+--------
+
+Apache License 2.0
+
+   Copyright 2012 eNovance <licensing@enovance.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+Contact
+-------
+
+techs@enovance.com