openstack/puppet-glance
Code Issues Proposed changes

Fix lint issues (doc, metadata, manifests)

Browse Source 
Add puppet parameters lint (with puppet-lint-param-docs gem) and fix
missing documentations, this commit also fix metadata.json file (SPDX
license, and open dependencies).

Change-Id: I0d590b930a8d0263c3a74d861b9786770be7d183
This commit is contained in:
Sebastien Badia 2015-02-23 01:29:11 +01:00
parent 9a4568c361
commit 0d83409381
13 changed files with 163 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Gemfile
View File

@ -3,7 +3,8 @@ source 'https://rubygems.org'
group :development, :test do
gem 'puppetlabs_spec_helper', :require => false
gem 'rspec-puppet', '~> 1.0.1'
gem 'puppet-lint', '~> 1.1.0'
gem 'metadata-json-lint'
gem 'puppet-lint-param-docs'
gem 'puppet-lint-absolute_classname-check'
gem 'puppet-lint-absolute_template_path'
gem 'puppet-lint-trailing_newline-check'

11
manifests/backend/file.pp
View File

@ -1,9 +1,14 @@
# === class: glance::backend::file
#
# used to configure file backends for glance
#
# $filesystem_store_datadir - Location where dist images are stored when
# default_store == file.
# Optional. Default: /var/lib/glance/images/
# === parameters:
#
# [*filesystem_store_datadir*]
# Location where dist images are stored when
# default_store == file.
# Optional. Default: /var/lib/glance/images/
#
class glance::backend::file(
$filesystem_store_datadir = '/var/lib/glance/images/'
) inherits glance::api {

20
manifests/backend/rbd.pp
View File

@ -1,17 +1,25 @@
# == class: glance::backend::rbd
#
# configures the storage backend for glance
# as a rbd instance
#
# $rbd_store_user - Optional.
# === parameters:
#
# $rbd_store_pool - Optional. Default:'images'
# [*rbd_store_user*]
# Optional.
#
# $rbd_store_ceph_conf - Optional. Default:'/etc/ceph/ceph.conf'
# [*rbd_store_pool*]
# Optional. Default:'images'
#
# $rbd_store_chunk_size - Optional. Default:'8'
# [*rbd_store_ceph_conf*]
# Optional. Default:'/etc/ceph/ceph.conf'
#
# $show_image_direct_url - Optional. Enables direct COW from glance to rbd
# DEPRECATED, use show_image_direct_url in glance::api
# [*rbd_store_chunk_size*]
# Optional. Default:'8'
#
# [*show_image_direct_url*]
# Optional. Enables direct COW from glance to rbd
# DEPRECATED, use show_image_direct_url in glance::api
#
# [*package_ensure*]
# (optional) Desired ensure state of packages.

25
manifests/backend/swift.pp
View File

@ -1,20 +1,31 @@
# == class: glance::backend::swift
#
# configures the storage backend for glance
# as a swift instance
#
# $swift_store_user - Required.
# === parameters:
#
# $swift_store_key - Required.
# [*swift_store_user*]
# Required. Swift store user.
#
# $swift_store_auth_address - Optional. Default: '127.0.0.1:5000/v2.0/'
# [*swift_store_key*]
# Required. Swift store key.
#
# $swift_store_container - Optional. Default: 'glance'
# [*swift_store_auth_address*]
# Optional. Default: '127.0.0.1:5000/v2.0/'
#
# $swift_store_auth_version - Optional. Default: '2'
# [*swift_store_container*]
# Optional. Default: 'glance'
#
# $swift_store_create_container_on_put - Optional. Default: 'False'
# [*swift_store_auth_version*]
# Optional. Default: '2'
#
# [*swift_store_large_object_size*]
# Optional. Default: '5120'
#
# [*swift_store_create_container_on_put*]
# Optional. Default: 'False'
#
# $swift_store_large_object_size - Optional. Default: '5120'
class glance::backend::swift(
$swift_store_user,
$swift_store_key,

4
manifests/client.pp
View File

@ -2,7 +2,9 @@
# Installs the glance python library.
#
# == parameters
# * ensure - ensure state for pachage.
# [*ensure*]
# (Optional) Ensure state for pachage.
# Defaults to 'present'
#
class glance::client (
$ensure = 'present'

10
manifests/config.pp
View File

@ -17,19 +17,19 @@
# DEFAULT/bar:
# value: barValue
#
# [**api_config**]
# [*api_config*]
# (optional) Allow configuration of glance-api.conf configurations.
#
# [**api_paste_ini_config**]
# [*api_paste_ini_config*]
# (optional) Allow configuration of glance-api-paste.ini configurations.
#
# [**registry_config**]
# [*registry_config*]
# (optional) Allow configuration of glance-registry.conf configurations.
#
# [**registry_paste_ini_config**]
# [*registry_paste_ini_config*]
# (optional) Allow configuration of glance-registry-paste.ini configurations.
#
# [**cache_config**]
# [*cache_config*]
# (optional) Allow configuration of glance-cache.conf configurations.
#
# NOTE: The configuration MUST NOT be already handled by this module

4
manifests/db/mysql.pp
View File

@ -29,6 +29,10 @@
# [*mysql_module*]
# (optional) Deprecated. Does nothing.
#
# === Deprecated parameters:
#
# [*cluster_id*] This parameter does nothing
#
class glance::db::mysql(
$password,
$dbname = 'glance',

8
manifests/init.pp
View File

@ -1,8 +1,12 @@
# == class: glance
#
# base glance config.
#
# == parameters
# * package_ensure - ensure state for package.
# === parameters:
#
# [*package_ensure*]
# (Optional) ensure state for package.
# Defaults to 'present'
#
class glance(
$package_ensure = 'present'

70
manifests/keystone/auth.pp
View File

@ -1,25 +1,61 @@
# == Class: glance::keystone::auth
#
# Sets up glance users, service and endpoint
#
# == Parameters:
#
# $auth_name :: identifier used for all keystone objects related to glance.
# Optional. Defaults to glance.
# $password :: password for glance user. Optional. Defaults to glance_password.
# $configure_user :: Whether to configure a service user. Optional. Defaults to true.
# $configure_user_role :: Whether to configure the admin role for the service user.
# Optional. Defaults to true.
# $service_name :: name of the service. Optional. Defaults to value of auth_name.
# $service_type :: type of service to create. Optional. Defaults to image.
# $public_address :: Public address for endpoint. Optional. Defaults to 127.0.0.1.
# $admin_address :: Admin address for endpoint. Optional. Defaults to 127.0.0.1.
# $inernal_address :: Internal address for endpoint. Optional. Defaults to 127.0.0.1.
# $port :: Port for endpoint. Needs to match glance api service port. Optional.
# Defaults to 9292.
# $region :: Region where endpoint is set.
# $public_protocol :: Protocol for public endpoint. Optional. Defaults to http.
# $admin_protocol :: Protocol for admin endpoint. Optional. Defaults to http.
# $internal_protocol :: Protocol for internal endpoint. Optional. Defaults to http.
# [*password*]
# Password for glance user. Required.
#
# [*email*]
# Email for glance user. Optional. Defaults to 'glance@localhost'.
#
# [*auth_name*]
# Username for glance service. Optional. Defaults to 'glance'.
#
# [*configure_endpoint*]
# Should glance endpoint be configured? Optional. Defaults to 'true'.
#
# [*configure_user*]
# Should the service user be configured? Optional. Defaults to 'true'.
#
# [*configure_user_role*]
# Should the admin role be configured for the service user?
# Optional. Defaults to 'true'.
#
# [*service_name*]
# Name of the service. Optional.
# Defaults to value of auth_name.
#
# [*service_type*]
# Type of service. Optional. Defaults to 'image'.
#
# [*public_address*]
# Public address for endpoint. Optional. Defaults to '127.0.0.1'.
#
# [*admin_address*]
# Admin address for endpoint. Optional. Defaults to '127.0.0.1'.
#
# [*internal_address*]
# Internal address for endpoint. Optional. Defaults to '127.0.0.1'.
#
# [*port*]
# Port for endpoint. Optional. Defaults to '9292'.
#
# [*region*]
# Region for endpoint. Optional. Defaults to 'RegionOne'.
#
# [*tenant*]
# Tenant for glance user. Optional. Defaults to 'services'.
#
# [*public_protocol*]
# Protocol for public endpoint. Optional. Defaults to 'http'.
#
# [*internal_protocol*]
# Protocol for internal endpoint. Optional. Defaults to 'http'.
#
# [*admin_protocol*]
# Protocol for admin endpoint. Optional. Defaults to 'http'.
#
class glance::keystone::auth(
$password,

22
manifests/notify/qpid.pp
View File

@ -1,6 +1,28 @@
# == Class: glance::notify::qpid
#
# used to configure qpid notifications for glance
#
# === Parameters:
#
# [*qpid_password*]
# (required) Password to connect to the qpid server.
#
# [*qpid_username*]
# (Optional) User to connect to the qpid server.
# Defaults to 'guest'.
#
# [*qpid_hostname*]
# (Optional) IP or hostname of the qpid server.
# Defaults to 'localhost'.
#
# [*qpid_port*]
# (Optional) Port of the qpid server.
# Defaults to 5672.
#
# [*qpid_protocol*]
# (Optional) Protocol to use for qpid (tcp/ssl).
# Defaults to tcp.
#
class glance::notify::qpid(
$qpid_password,
$qpid_username = 'guest',

21
manifests/notify/rabbitmq.pp
View File

@ -3,38 +3,59 @@
#
# [*rabbit_password*]
# password to connect to the rabbit_server.
#
# [*rabbit_userid*]
# user to connect to the rabbit server. Optional. Defaults to 'guest'
#
# [*rabbit_host*]
# ip or hostname of the rabbit server. Optional. Defaults to 'localhost'
#
# [*rabbit_hosts*]
# (Optional) IP or hostname of the rabbits servers.
# comma separated array (ex: ['1.0.0.10:5672','1.0.0.11:5672'])
# Defaults to false.
#
# [*rabbit_port*]
# port of the rabbit server. Optional. Defaults to 5672.
#
# [*rabbit_virtual_host*]
# virtual_host to use. Optional. Defaults to '/'
#
# [*rabbit_use_ssl*]
# (optional) Connect over SSL for RabbitMQ
# Defaults to false
#
# [*kombu_ssl_ca_certs*]
# (optional) SSL certification authority file (valid only if SSL enabled).
# Defaults to undef
#
# [*kombu_ssl_certfile*]
# (optional) SSL cert file (valid only if SSL enabled).
# Defaults to undef
#
# [*kombu_ssl_keyfile*]
# (optional) SSL key file (valid only if SSL enabled).
# Defaults to undef
#
# [*kombu_ssl_version*]
# (optional) SSL version to use (valid only if SSL enabled).
# Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be
# available on some distributions.
# Defaults to 'TLSv1'
#
# [*rabbit_notification_exchange*]
# Defaults to 'glance'
#
# [*rabbit_notification_topic*]
# Defaults to 'notifications'
#
# [*rabbit_durable_queues*]
# Defaults to false
#
# [*amqp_durable_queues*]
# (Optional) Use durable queues in broker.
# Defaults to false.
#
class glance::notify::rabbitmq(
$rabbit_password,
$rabbit_userid = 'guest',

5
manifests/registry.pp
View File

@ -77,6 +77,11 @@
# (optional) administrative user name to connect to keystone.
# Defaults to 'glance'.
#
# [*pipeline*]
# (optional) Partial name of a pipeline in your paste configuration
# file with the service name removed.
# Defaults to 'keystone'.
#
# [*use_syslog*]
# (optional) Use syslog for logging.
# Defaults to false.

4
metadata.json
View File

@ -3,7 +3,7 @@
"version": "5.0.0",
"author": "Puppet Labs and StackForge Contributors",
"summary": "Puppet module for OpenStack Glance",
"license": "Apache License 2.0",
"license": "Apache-2.0",
"source": "git://github.com/stackforge/puppet-glance.git",
"project_page": "https://launchpad.net/puppet-glance",
"issues_url": "https://bugs.launchpad.net/puppet-glance",
@ -34,6 +34,6 @@
{ "name": "puppetlabs/inifile", "version_requirement": ">=1.0.0 <2.0.0" },
{ "name": "stackforge/keystone", "version_requirement": ">=5.0.0 <6.0.0" },
{ "name": "puppetlabs/stdlib", "version_requirement": ">=4.0.0 <5.0.0" },
{ "name": "stackforge/openstacklib", "version_requirement": ">=5.0.0" }
{ "name": "stackforge/openstacklib", "version_requirement": ">=5.0.0 <6.0.0" }
]
}