commit 37042fd4884cce2af4bab06e4336f2bf45b23698 Author: Xingchao Yu Date: Mon Jan 18 12:09:44 2016 +0800 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..12b6e4d --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +Gemfile.lock +spec/fixtures/modules/* +spec/fixtures/manifests/site.pp +*.swp +pkg +vendor/ +openstack/ diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..a787989 --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/puppet-oslo.git diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..13f6ec4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2016 OpenStack Foundation + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5cedfa2 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +oslo +======= + +#### Table of Contents + +1. [Overview - What is the oslo module?](#overview) +2. [Module Description - What does the module do?](#module-description) +3. [Setup - The basics of getting started with oslo](#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) + +Overview +-------- + +The oslo module is a part of [OpenStack](https://www.openstack.org), an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects not part of the core software. The module its self is used to flexibly configure and manage the FIXME service for OpenStack. + +Module Description +------------------ + +The oslo module is a thorough attempt to make Puppet capable of managing the entirety of oslo. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the oslo module to assist in manipulation of configuration files. + +Setup +----- + +**What the oslo module affects** + +* [Oslo](https://wiki.openstack.org/wiki/Oslo), the FIXME service for OpenStack. + +### Installing oslo + + oslo is not currently in Puppet Forge, but is anticipated to be added soon. Once that happens, you'll be able to install oslo with: + puppet module install openstack/oslo + +### Beginning with oslo + +To utilize the oslo module's functionality you will need to declare multiple resources. + +Implementation +-------------- + +### oslo + +oslo is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers. + +Limitations +------------ + +* All the oslo types use the CLI tools and so need to be ran on the oslo node. + +Beaker-Rspec +------------ + +This module has beaker-rspec tests + +To run the tests on the default vagrant node: + +```shell +bundle install +bundle exec rake acceptance +``` + +For more information on writing and running beaker-rspec tests visit the documentation: + +* https://github.com/puppetlabs/beaker/wiki/How-to-Write-a-Beaker-Test-for-a-Module + +Development +----------- + +Developer documentation for the entire puppet-openstack project. + +* https://wiki.openstack.org/wiki/Puppet + +Contributors +------------ + +* https://github.com/openstack/puppet-oslo/graphs/contributors diff --git a/lib/puppet/provider/oslo_config/ini_setting.rb b/lib/puppet/provider/oslo_config/ini_setting.rb new file mode 100644 index 0000000..40a6b37 --- /dev/null +++ b/lib/puppet/provider/oslo_config/ini_setting.rb @@ -0,0 +1,10 @@ +Puppet::Type.type(:oslo_config).provide( + :ini_setting, + :parent => Puppet::Type.type(:openstack_config).provider(:ini_setting) +) do + + def self.file_path + '/etc/oslo/oslo.conf' + end + +end diff --git a/lib/puppet/type/oslo_config.rb b/lib/puppet/type/oslo_config.rb new file mode 100644 index 0000000..0fd9196 --- /dev/null +++ b/lib/puppet/type/oslo_config.rb @@ -0,0 +1,53 @@ +Puppet::Type.newtype(:oslo_config) do + + ensurable + + newparam(:name, :namevar => true) do + desc 'Section/setting name to manage from oslo.conf' + newvalues(/\S+\/\S+/) + end + + newproperty(:value) do + desc 'The value of the setting to be defined.' + munge do |value| + value = value.to_s.strip + value.capitalize! if value =~ /^(true|false)$/i + value + end + newvalues(/^[\S ]*$/) + + def is_to_s( currentvalue ) + if resource.secret? + return '[old secret redacted]' + else + return currentvalue + end + end + + def should_to_s( newvalue ) + if resource.secret? + return '[new secret redacted]' + else + return newvalue + end + end + end + + newparam(:secret, :boolean => true) do + desc 'Whether to hide the value from Puppet logs. Defaults to `false`.' + + newvalues(:true, :false) + + defaultto false + end + + newparam(:ensure_absent_val) do + desc 'A value that is specified as the value property will behave as if ensure => absent was specified' + defaultto('') + end + + autorequire(:package) do + 'oslo' + end + +end diff --git a/manifests/config.pp b/manifests/config.pp new file mode 100644 index 0000000..57d371e --- /dev/null +++ b/manifests/config.pp @@ -0,0 +1,30 @@ +# == Class: oslo::config +# +# This class is used to manage arbitrary oslo configurations. +# +# === Parameters +# +# [*oslo_config*] +# (optional) Allow configuration of arbitrary oslo configurations. +# The value is an hash of oslo_config resources. Example: +# { 'DEFAULT/foo' => { value => 'fooValue'}, +# 'DEFAULT/bar' => { value => 'barValue'} +# } +# In yaml format, Example: +# oslo_config: +# DEFAULT/foo: +# value: fooValue +# DEFAULT/bar: +# value: barValue +# +# NOTE: The configuration MUST NOT be already handled by this module +# or Puppet catalog compilation will fail with duplicate resources. +# +class oslo::config ( + $oslo_config = {}, +) { + + validate_hash($oslo_config) + + create_resources('oslo_config', $oslo_config) +} diff --git a/manifests/db.pp b/manifests/db.pp new file mode 100644 index 0000000..b2420cf --- /dev/null +++ b/manifests/db.pp @@ -0,0 +1,97 @@ +# == Class: oslo::db +# +# Configure the oslo database +# +# === Parameters +# +# [*database_connection*] +# Url used to connect to database. +# (Optional) Defaults to "sqlite:////var/lib/oslo/oslo.sqlite". +# +# [*database_idle_timeout*] +# Timeout when db connections should be reaped. +# (Optional) Defaults to $::os_service_default +# +# [*database_max_retries*] +# Maximum number of database connection retries during startup. +# Setting -1 implies an infinite retry count. +# (Optional) Defaults to $::os_service_default +# +# [*database_retry_interval*] +# Interval between retries of opening a database connection. +# (Optional) Defaults to $::os_service_default +# +# [*database_min_pool_size*] +# Minimum number of SQL connections to keep open in a pool. +# (Optional) Defaults to $::os_service_default +# +# [*database_max_pool_size*] +# Maximum number of SQL connections to keep open in a pool. +# (Optional) Defaults to $::os_service_default +# +# [*database_max_overflow*] +# If set, use this value for max_overflow with sqlalchemy. +# (Optional) Defaults to $::os_service_default +# +class oslo::db ( + $database_connection = 'sqlite:////var/lib/oslo/oslo.sqlite', + $database_idle_timeout = $::os_service_default, + $database_min_pool_size = $::os_service_default, + $database_max_pool_size = $::os_service_default, + $database_max_retries = $::os_service_default, + $database_retry_interval = $::os_service_default, + $database_max_overflow = $::os_service_default, +) { + + $database_connection_real = pick($::oslo::database_connection, $database_connection) + $database_idle_timeout_real = pick($::oslo::database_idle_timeout, $database_idle_timeout) + $database_min_pool_size_real = pick($::oslo::database_min_pool_size, $database_min_pool_size) + $database_max_pool_size_real = pick($::oslo::database_max_pool_size, $database_max_pool_size) + $database_max_retries_real = pick($::oslo::database_max_retries, $database_max_retries) + $database_retry_interval_real = pick($::oslo::database_retry_interval, $database_retry_interval) + $database_max_overflow_real = pick($::oslo::database_max_overflow, $database_max_overflow) + + validate_re($database_connection_real, + '(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?') + + case $database_connection_real { + /^mysql(\+pymysql)?:\/\//: { + require 'mysql::bindings' + require 'mysql::bindings::python' + if $database_connection_real =~ /^mysql\+pymysql/ { + $backend_package = $::oslo::params::pymysql_package_name + } else { + $backend_package = false + } + } + /^postgresql:\/\//: { + $backend_package = false + require 'postgresql::lib::python' + } + /^sqlite:\/\//: { + $backend_package = $::oslo::params::sqlite_package_name + } + default: { + fail('Unsupported backend configured') + } + } + + if $backend_package and !defined(Package[$backend_package]) { + package {'oslo-backend-package': + ensure => present, + name => $backend_package, + tag => 'openstack', + } + } + + oslo_config { + 'database/connection': value => $database_connection_real, secret => true; + 'database/idle_timeout': value => $database_idle_timeout_real; + 'database/min_pool_size': value => $database_min_pool_size_real; + 'database/max_retries': value => $database_max_retries_real; + 'database/retry_interval': value => $database_retry_interval_real; + 'database/max_pool_size': value => $database_max_pool_size_real; + 'database/max_overflow': value => $database_max_overflow_real; + } + +} diff --git a/manifests/db/mysql.pp b/manifests/db/mysql.pp new file mode 100644 index 0000000..9368109 --- /dev/null +++ b/manifests/db/mysql.pp @@ -0,0 +1,69 @@ +# The oslo::db::mysql class implements mysql backend for oslo +# +# This class can be used to create tables, users and grant +# privilege for a mysql oslo database. +# +# == parameters +# +# [*password*] +# (Mandatory) Password to connect to the database. +# Defaults to 'false'. +# +# [*dbname*] +# (Optional) Name of the database. +# Defaults to 'oslo'. +# +# [*user*] +# (Optional) User to connect to the database. +# Defaults to 'oslo'. +# +# [*host*] +# (Optional) The default source host user is allowed to connect from. +# Defaults to '127.0.0.1' +# +# [*allowed_hosts*] +# (Optional) Other hosts the user is allowed to connect from. +# Defaults to 'undef'. +# +# [*charset*] +# (Optional) The database charset. +# Defaults to 'utf8' +# +# [*collate*] +# (Optional) The database collate. +# Only used with mysql modules >= 2.2. +# Defaults to 'utf8_general_ci' +# +# == Dependencies +# Class['mysql::server'] +# +# == Examples +# +# == Authors +# +# == Copyright +# +class oslo::db::mysql( + $password, + $dbname = 'oslo', + $user = 'oslo', + $host = '127.0.0.1', + $charset = 'utf8', + $collate = 'utf8_general_ci', + $allowed_hosts = undef +) { + + validate_string($password) + + ::openstacklib::db::mysql { 'oslo': + user => $user, + password_hash => mysql_password($password), + dbname => $dbname, + host => $host, + charset => $charset, + collate => $collate, + allowed_hosts => $allowed_hosts, + } + + ::Openstacklib::Db::Mysql['oslo'] ~> Exec<| title == 'oslo-manage db_sync' |> +} diff --git a/manifests/db/postgresql.pp b/manifests/db/postgresql.pp new file mode 100644 index 0000000..2a9cc99 --- /dev/null +++ b/manifests/db/postgresql.pp @@ -0,0 +1,55 @@ +# == Class: oslo::db::postgresql +# +# Class that configures postgresql for oslo +# Requires the Puppetlabs postgresql module. +# +# === Parameters +# +# [*password*] +# (Required) Password to connect to the database. +# +# [*dbname*] +# (Optional) Name of the database. +# Defaults to 'oslo'. +# +# [*user*] +# (Optional) User to connect to the database. +# Defaults to 'oslo'. +# +# [*encoding*] +# (Optional) The charset to use for the database. +# Default to undef. +# +# [*privileges*] +# (Optional) Privileges given to the database user. +# Default to 'ALL' +# +# == Dependencies +# +# == Examples +# +# == Authors +# +# == Copyright +# +class oslo::db::postgresql( + $password, + $dbname = 'oslo', + $user = 'oslo', + $encoding = undef, + $privileges = 'ALL', +) { + + Class['oslo::db::postgresql'] -> Service<| title == 'oslo' |> + + ::openstacklib::db::postgresql { 'oslo': + password_hash => postgresql_password($user, $password), + dbname => $dbname, + user => $user, + encoding => $encoding, + privileges => $privileges, + } + + ::Openstacklib::Db::Postgresql['oslo'] ~> Exec<| title == 'oslo-manage db_sync' |> + +} diff --git a/manifests/db/sync.pp b/manifests/db/sync.pp new file mode 100644 index 0000000..3fcd7f2 --- /dev/null +++ b/manifests/db/sync.pp @@ -0,0 +1,23 @@ +# +# Class to execute oslo-manage db_sync +# +# == Parameters +# +# [*extra_params*] +# (optional) String of extra command line parameters to append +# to the oslo-dbsync command. +# Defaults to undef +# +class oslo::db::sync( + $extra_params = undef, +) { + exec { 'oslo-db-sync': + command => "oslo-manage db_sync ${extra_params}", + path => '/usr/bin', + user => 'oslo', + refreshonly => true, + subscribe => [Package['oslo'], Oslo_config['database/connection']], + } + + Exec['oslo-manage db_sync'] ~> Service<| title == 'oslo' |> +} diff --git a/manifests/init.pp b/manifests/init.pp new file mode 100644 index 0000000..2f4e2e8 --- /dev/null +++ b/manifests/init.pp @@ -0,0 +1,14 @@ +# == Class: oslo +# +# Full description of class oslo here. +# +# === Parameters +# +# [*sample_parameter*] +# Explanation of what this parameter affects and what it defaults to. +# +class oslo { + + include ::oslo::params + +} diff --git a/manifests/keystone/auth.pp b/manifests/keystone/auth.pp new file mode 100644 index 0000000..94a3aac --- /dev/null +++ b/manifests/keystone/auth.pp @@ -0,0 +1,91 @@ +# == Class: oslo::keystone::auth +# +# Configures oslo user, service and endpoint in Keystone. +# +# === Parameters +# +# [*password*] +# (required) Password for oslo user. +# +# [*auth_name*] +# Username for oslo service. Defaults to 'oslo'. +# +# [*email*] +# Email for oslo user. Defaults to 'oslo@localhost'. +# +# [*tenant*] +# Tenant for oslo user. Defaults to 'services'. +# +# [*configure_endpoint*] +# Should oslo endpoint be configured? Defaults to 'true'. +# +# [*configure_user*] +# (Optional) Should the service user be configured? +# Defaults to 'true'. +# +# [*configure_user_role*] +# (Optional) Should the admin role be configured for the service user? +# Defaults to 'true'. +# +# [*service_type*] +# Type of service. Defaults to 'key-manager'. +# +# [*region*] +# Region for endpoint. Defaults to 'RegionOne'. +# +# [*service_name*] +# (optional) Name of the service. +# Defaults to the value of auth_name. +# +# [*public_url*] +# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:FIXME') +# This url should *not* contain any trailing '/'. +# +# [*admin_url*] +# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:FIXME') +# This url should *not* contain any trailing '/'. +# +# [*internal_url*] +# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:FIXME') +# +class oslo::keystone::auth ( + $password, + $auth_name = 'oslo', + $email = 'oslo@localhost', + $tenant = 'services', + $configure_endpoint = true, + $configure_user = true, + $configure_user_role = true, + $service_name = undef, + $service_type = 'FIXME', + $region = 'RegionOne', + $public_url = 'http://127.0.0.1:FIXME', + $admin_url = 'http://127.0.0.1:FIXME', + $internal_url = 'http://127.0.0.1:FIXME', +) { + + $real_service_name = pick($service_name, $auth_name) + + if $configure_user_role { + Keystone_user_role["${auth_name}@${tenant}"] ~> Service <| name == 'oslo-server' |> + } + Keystone_endpoint["${region}/${real_service_name}::${service_type}"] ~> Service <| name == 'oslo-server' |> + + keystone::resource::service_identity { 'oslo': + configure_user => $configure_user, + configure_user_role => $configure_user_role, + configure_endpoint => $configure_endpoint, + service_name => $real_service_name, + service_type => $service_type, + service_description => 'oslo FIXME Service', + region => $region, + auth_name => $auth_name, + password => $password, + email => $email, + tenant => $tenant, + public_url => $public_url, + internal_url => $internal_url, + admin_url => $admin_url, + } + +} diff --git a/manifests/logging.pp b/manifests/logging.pp new file mode 100644 index 0000000..91db2fe --- /dev/null +++ b/manifests/logging.pp @@ -0,0 +1,143 @@ +# Class oslo::logging +# +# oslo logging configuration +# +# == parameters +# +# [*verbose*] +# (Optional) Should the daemons log verbose messages +# Defaults to $::os_service_default +# +# [*debug*] +# (Optional) Should the daemons log debug messages +# Defaults to $::os_service_default +# +# [*use_syslog*] +# (Optional) Use syslog for logging. +# Defaults to $::os_service_default +# +# [*use_stderr*] +# (optional) Use stderr for logging +# Defaults to $::os_service_default +# +# [*log_facility*] +# (Optional) Syslog facility to receive log lines. +# Defaults to $::os_service_default +# +# [*log_dir*] +# (optional) Directory where logs should be stored. +# If set to boolean false, it will not log to any directory. +# Defaults to '/var/log/oslo'. +# +# [*logging_context_format_string*] +# (optional) Format string to use for log messages with context. +# Defaults to $::os_service_default +# Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\ +# [%(request_id)s %(user_identity)s] %(instance)s%(message)s' +# +# [*logging_default_format_string*] +# (optional) Format string to use for log messages without context. +# Defaults to $::os_service_default +# Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\ +# [-] %(instance)s%(message)s' +# +# [*logging_debug_format_suffix*] +# (optional) Formatted data to append to log format when level is DEBUG. +# Defaults to $::os_service_default +# Example: '%(funcName)s %(pathname)s:%(lineno)d' +# +# [*logging_exception_prefix*] +# (optional) Prefix each line of exception output with this format. +# Defaults to $::os_service_default +# Example: '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s' +# +# [*log_config_append*] +# The name of an additional logging configuration file. +# Defaults to $::os_service_default +# See https://docs.python.org/2/howto/logging.html +# +# [*default_log_levels*] +# (optional) Hash of logger (keys) and level (values) pairs. +# Defaults to $::os_service_default +# Example: +# { 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN', +# 'qpid' => 'WARN', 'sqlalchemy' => 'WARN', 'suds' => 'INFO', +# 'oslo.messaging' => 'INFO', 'iso8601' => 'WARN', +# 'requests.packages.urllib3.connectionpool' => 'WARN', +# 'urllib3.connectionpool' => 'WARN', +# 'websocket' => 'WARN', 'oslomiddleware' => 'WARN', +# 'routes.middleware' => 'WARN', stevedore => 'WARN' } +# +# [*publish_errors*] +# (optional) Publish error events (boolean value). +# Defaults to $::os_service_default +# +# [*fatal_deprecations*] +# (optional) Make deprecations fatal (boolean value) +# Defaults to $::os_service_default +# +# [*instance_format*] +# (optional) If an instance is passed with the log message, format it +# like this (string value). +# Defaults to undef. +# Example: '[instance: %(uuid)s] ' +# +# [*instance_uuid_format*] +# (optional) If an instance UUID is passed with the log message, format +# it like this (string value). +# Defaults to $::os_service_default +# Example: instance_uuid_format='[instance: %(uuid)s] ' +# +# [*log_date_format*] +# (optional) Format string for %%(asctime)s in log records. +# Defaults to $::os_service_default +# Example: 'Y-%m-%d %H:%M:%S' + +class oslo::logging( + $use_syslog = $::os_service_default, + $use_stderr = $::os_service_default, + $log_facility = $::os_service_default, + $log_dir = '/var/log/oslo', + $verbose = $::os_service_default, + $debug = $::os_service_default, + $logging_context_format_string = $::os_service_default, + $logging_default_format_string = $::os_service_default, + $logging_debug_format_suffix = $::os_service_default, + $logging_exception_prefix = $::os_service_default, + $log_config_append = $::os_service_default, + $default_log_levels = $::os_service_default, + $publish_errors = $::os_service_default, + $fatal_deprecations = $::os_service_default, + $instance_format = $::os_service_default, + $instance_uuid_format = $::os_service_default, + $log_date_format = $::os_service_default, +) { + + if is_service_default($default_log_levels) { + $default_log_levels_real = $default_log_levels + } else { + $default_log_levels_real = join(sort(join_keys_to_values($default_log_levels, '=')), ',') + } + + oslo_config { + 'DEFAULT/use_syslog' : value => $use_syslog; + 'DEFAULT/use_stderr' : value => $use_stderr; + 'DEFAULT/syslog_log_facility' : value => $log_facility; + 'DEFAULT/log_dir' : value => $log_dir; + 'DEFAULT/log_file': value => $log_file; + 'DEFAULT/verbose' : value => $verbose; + 'DEFAULT/debug' : value => $debug; + 'DEFAULT/default_log_levels' : value => $default_log_levels_real; + 'DEFAULT/logging_context_format_string' : value => $logging_context_format_string; + 'DEFAULT/logging_default_format_string' : value => $logging_default_format_string; + 'DEFAULT/logging_debug_format_suffix' : value => $logging_debug_format_suffix; + 'DEFAULT/logging_exception_prefix' : value => $logging_exception_prefix; + 'DEFAULT/log_config_append' : value => $log_config_append; + 'DEFAULT/publish_errors' : value => $publish_errors; + 'DEFAULT/fatal_deprecations' : value => $fatal_deprecations; + 'DEFAULT/instance_format' : value => $instance_format; + 'DEFAULT/instance_uuid_format' : value => $instance_uuid_format; + 'DEFAULT/log_date_format' : value => $log_date_format; + } + +} diff --git a/manifests/params.pp b/manifests/params.pp new file mode 100644 index 0000000..03ec40b --- /dev/null +++ b/manifests/params.pp @@ -0,0 +1,19 @@ +# Parameters for puppet-oslo +# +class oslo::params { + + case $::osfamily { + 'RedHat': { + $sqlite_package_name = undef + $pymysql_package_name = undef + } + 'Debian': { + $sqlite_package_name = 'python-pysqlite2' + $pymysql_package_name = 'python-pymysql' + } + default: { + fail("Unsupported osfamily: ${::osfamily} operatingsystem") + } + + } # Case $::osfamily +} diff --git a/manifests/policy.pp b/manifests/policy.pp new file mode 100644 index 0000000..b7f0c29 --- /dev/null +++ b/manifests/policy.pp @@ -0,0 +1,39 @@ +# == Class: oslo::policy +# +# Configure the oslo policies +# +# === Parameters +# +# [*policies*] +# (optional) Set of policies to configure for oslo +# Example : +# { +# 'oslo-context_is_admin' => { +# 'key' => 'context_is_admin', +# 'value' => 'true' +# }, +# 'oslo-default' => { +# 'key' => 'default', +# 'value' => 'rule:admin_or_owner' +# } +# } +# Defaults to empty hash. +# +# [*policy_path*] +# (optional) Path to the nova policy.json file +# Defaults to /etc/oslo/policy.json +# +class oslo::policy ( + $policies = {}, + $policy_path = '/etc/oslo/policy.json', +) { + + validate_hash($policies) + + Openstacklib::Policy::Base { + file_path => $policy_path, + } + + create_resources('openstacklib::policy::base', $policies) + +} diff --git a/metadata.json b/metadata.json new file mode 100644 index 0000000..65a7078 --- /dev/null +++ b/metadata.json @@ -0,0 +1,34 @@ +{ + "name": "puppet-oslo", + "version": "0.0.1", + "author": "OpenStack Contributors", + "summary": "Puppet module for OpenStack Oslo", + "license": "Apache-2.0", + "source": "git://github.com/openstack/puppet-oslo.git", + "project_page": "https://launchpad.net/puppet-oslo", + "issues_url": "https://bugs.launchpad.net/puppet-oslo", + "description": "Installs and configures OpenStack Oslo.", + "operatingsystem_support": [ + { + "operatingsystem": "Debian", + "operatingsystemrelease": ["8"] + }, + { + "operatingsystem": "Fedora", + "operatingsystemrelease": ["21","22"] + }, + { + "operatingsystem": "RedHat", + "operatingsystemrelease": ["7"] + }, + { + "operatingsystem": "Ubuntu", + "operatingsystemrelease": ["14.04"] + } + ], + "dependencies": [ + { "name": "puppetlabs/inifile", "version_requirement": ">=1.0.0 <2.0.0" }, + { "name": "puppetlabs/stdlib", "version_requirement": ">= 4.2.0 <5.0.0" }, + { "name": "openstack/openstacklib", "version_requirement": ">=7.0.0 <8.0.0" } + ] +} diff --git a/spec/classes/oslo_db_mysql_spec.rb b/spec/classes/oslo_db_mysql_spec.rb new file mode 100644 index 0000000..ad1fc5e --- /dev/null +++ b/spec/classes/oslo_db_mysql_spec.rb @@ -0,0 +1,60 @@ +require 'spec_helper' + +describe 'oslo::db::mysql' do + + let :pre_condition do + [ + 'include mysql::server', + 'include oslo::db::sync' + ] + end + + let :facts do + { :osfamily => 'Debian' } + end + + let :params do + { + 'password' => 'fooboozoo_default_password', + } + end + + describe 'with only required params' do + it { is_expected.to contain_openstacklib__db__mysql('oslo').with( + :user => 'oslo', + :password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206', + :dbname => 'oslo', + :host => '127.0.0.1', + :charset => 'utf8', + :collate => 'utf8_general_ci', + )} + end + + describe "overriding allowed_hosts param to array" do + before { params.merge!( :allowed_hosts => ['127.0.0.1','%'] ) } + + it { is_expected.to contain_openstacklib__db__mysql('oslo').with( + :user => 'oslo', + :password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206', + :dbname => 'oslo', + :host => '127.0.0.1', + :charset => 'utf8', + :collate => 'utf8_general_ci', + :allowed_hosts => ['127.0.0.1','%'] + )} + end + describe "overriding allowed_hosts param to string" do + before { params.merge!( :allowed_hosts => '192.168.1.1' ) } + + it { is_expected.to contain_openstacklib__db__mysql('oslo').with( + :user => 'oslo', + :password_hash => '*3DDF34A86854A312A8E2C65B506E21C91800D206', + :dbname => 'oslo', + :host => '127.0.0.1', + :charset => 'utf8', + :collate => 'utf8_general_ci', + :allowed_hosts => '192.168.1.1' + )} + end + +end diff --git a/spec/classes/oslo_db_postgresql_spec.rb b/spec/classes/oslo_db_postgresql_spec.rb new file mode 100644 index 0000000..db9ca89 --- /dev/null +++ b/spec/classes/oslo_db_postgresql_spec.rb @@ -0,0 +1,58 @@ +require 'spec_helper' + +describe 'oslo::db::postgresql' do + + let :req_params do + { :password => 'pw' } + end + + let :pre_condition do + 'include postgresql::server' + end + + context 'on a RedHat osfamily' do + let :facts do + { + :osfamily => 'RedHat', + :operatingsystemrelease => '7.0', + :concat_basedir => '/var/lib/puppet/concat' + } + end + + context 'with only required parameters' do + let :params do + req_params + end + + it { is_expected.to contain_postgresql__server__db('oslo').with( + :user => 'oslo', + :password => 'md5c530c33636c58ae83ca933f39319273e' + )} + end + + end + + context 'on a Debian osfamily' do + let :facts do + { + :operatingsystemrelease => '7.8', + :operatingsystem => 'Debian', + :osfamily => 'Debian', + :concat_basedir => '/var/lib/puppet/concat' + } + end + + context 'with only required parameters' do + let :params do + req_params + end + + it { is_expected.to contain_postgresql__server__db('oslo').with( + :user => 'oslo', + :password => 'md5c530c33636c58ae83ca933f39319273e' + )} + end + + end + +end diff --git a/spec/classes/oslo_db_spec.rb b/spec/classes/oslo_db_spec.rb new file mode 100644 index 0000000..3986d6b --- /dev/null +++ b/spec/classes/oslo_db_spec.rb @@ -0,0 +1,120 @@ +require 'spec_helper' + +describe 'oslo::db' do + + shared_examples 'oslo::db' do + context 'with default parameters' do + it { is_expected.to contain_oslo_config('database/connection').with_value('sqlite:////var/lib/oslo/oslo.sqlite') } + it { is_expected.to contain_oslo_config('database/idle_timeout').with_value('') } + it { is_expected.to contain_oslo_config('database/min_pool_size').with_value('') } + it { is_expected.to contain_oslo_config('database/max_retries').with_value('') } + it { is_expected.to contain_oslo_config('database/retry_interval').with_value('') } + it { is_expected.to contain_oslo_config('database/max_pool_size').with_value('') } + it { is_expected.to contain_oslo_config('database/max_overflow').with_value('') } + end + + context 'with specific parameters' do + let :params do + { :database_connection => 'mysql+pymysql://oslo:oslo@localhost/oslo', + :database_idle_timeout => '3601', + :database_min_pool_size => '2', + :database_max_retries => '11', + :database_retry_interval => '11', + :database_max_pool_size => '11', + :database_max_overflow => '21', + } + end + + it { is_expected.to contain_oslo_config('database/connection').with_value('mysql+pymysql://oslo:oslo@localhost/oslo') } + it { is_expected.to contain_oslo_config('database/idle_timeout').with_value('3601') } + it { is_expected.to contain_oslo_config('database/min_pool_size').with_value('2') } + it { is_expected.to contain_oslo_config('database/max_retries').with_value('11') } + it { is_expected.to contain_oslo_config('database/retry_interval').with_value('11') } + it { is_expected.to contain_oslo_config('database/max_pool_size').with_value('11') } + it { is_expected.to contain_oslo_config('database/max_overflow').with_value('21') } + end + + context 'with postgresql backend' do + let :params do + { :database_connection => 'postgresql://oslo:oslo@localhost/oslo', } + end + + it 'install the proper backend package' do + is_expected.to contain_package('python-psycopg2').with(:ensure => 'present') + end + + end + + context 'with MySQL-python library as backend package' do + let :params do + { :database_connection => 'mysql://oslo:oslo@localhost/oslo', } + end + + it { is_expected.to contain_package('python-mysqldb').with(:ensure => 'present') } + end + + context 'with incorrect database_connection string' do + let :params do + { :database_connection => 'foodb://oslo:oslo@localhost/oslo', } + end + + it_raises 'a Puppet::Error', /validate_re/ + end + + context 'with incorrect pymysql database_connection string' do + let :params do + { :database_connection => 'foo+pymysql://oslo:oslo@localhost/oslo', } + end + + it_raises 'a Puppet::Error', /validate_re/ + end + + end + + context 'on Debian platforms' do + let :facts do + @default_facts.merge({ + :osfamily => 'Debian', + :operatingsystem => 'Debian', + :operatingsystemrelease => 'jessie', + }) + end + + it_configures 'oslo::db' + + context 'using pymysql driver' do + let :params do + { :database_connection => 'mysql+pymysql://oslo:oslo@localhost/oslo', } + end + + it 'install the proper backend package' do + is_expected.to contain_package('oslo-backend-package').with( + :ensure => 'present', + :name => 'python-pymysql', + :tag => 'openstack' + ) + end + end + end + + context 'on Redhat platforms' do + let :facts do + @default_facts.merge({ + :osfamily => 'RedHat', + :operatingsystemrelease => '7.1', + }) + end + + it_configures 'oslo::db' + + context 'using pymysql driver' do + let :params do + { :database_connection => 'mysql+pymysql://oslo:oslo@localhost/oslo', } + end + + it 'install the proper backend package' do + is_expected.not_to contain_package('oslo-backend-package') + end + end + +end diff --git a/spec/classes/oslo_keystone_auth_spec.rb b/spec/classes/oslo_keystone_auth_spec.rb new file mode 100644 index 0000000..fc2676c --- /dev/null +++ b/spec/classes/oslo_keystone_auth_spec.rb @@ -0,0 +1,120 @@ +# +# Unit tests for oslo::keystone::auth +# + +require 'spec_helper' + +describe 'oslo::keystone::auth' do + + let :facts do + { :osfamily => 'Debian' } + end + + describe 'with default class parameters' do + let :params do + { :password => 'oslo_password', + :tenant => 'foobar' } + end + + it { is_expected.to contain_keystone_user('oslo').with( + :ensure => 'present', + :password => 'oslo_password', + ) } + + it { is_expected.to contain_keystone_user_role('oslo@foobar').with( + :ensure => 'present', + :roles => ['admin'] + )} + + it { is_expected.to contain_keystone_service('oslo::FIXME').with( + :ensure => 'present', + :description => 'oslo FIXME Service' + ) } + + it { is_expected.to contain_keystone_endpoint('RegionOne/oslo::FIXME').with( + :ensure => 'present', + :public_url => 'http://127.0.0.1:FIXME', + :admin_url => 'http://127.0.0.1:FIXME', + :internal_url => 'http://127.0.0.1:FIXME', + ) } + end + + describe 'when overriding URL parameters' do + let :params do + { :password => 'oslo_password', + :public_url => 'https://10.10.10.10:80', + :internal_url => 'http://10.10.10.11:81', + :admin_url => 'http://10.10.10.12:81', } + end + + it { is_expected.to contain_keystone_endpoint('RegionOne/oslo::FIXME').with( + :ensure => 'present', + :public_url => 'https://10.10.10.10:80', + :internal_url => 'http://10.10.10.11:81', + :admin_url => 'http://10.10.10.12:81', + ) } + end + + describe 'when overriding auth name' do + let :params do + { :password => 'foo', + :auth_name => 'osloy' } + end + + it { is_expected.to contain_keystone_user('osloy') } + it { is_expected.to contain_keystone_user_role('osloy@services') } + it { is_expected.to contain_keystone_service('osloy::FIXME') } + it { is_expected.to contain_keystone_endpoint('RegionOne/osloy::FIXME') } + end + + describe 'when overriding service name' do + let :params do + { :service_name => 'oslo_service', + :auth_name => 'oslo', + :password => 'oslo_password' } + end + + it { is_expected.to contain_keystone_user('oslo') } + it { is_expected.to contain_keystone_user_role('oslo@services') } + it { is_expected.to contain_keystone_service('oslo_service::FIXME') } + it { is_expected.to contain_keystone_endpoint('RegionOne/oslo_service::FIXME') } + end + + describe 'when disabling user configuration' do + + let :params do + { + :password => 'oslo_password', + :configure_user => false + } + end + + it { is_expected.not_to contain_keystone_user('oslo') } + it { is_expected.to contain_keystone_user_role('oslo@services') } + it { is_expected.to contain_keystone_service('oslo::FIXME').with( + :ensure => 'present', + :description => 'oslo FIXME Service' + ) } + + end + + describe 'when disabling user and user role configuration' do + + let :params do + { + :password => 'oslo_password', + :configure_user => false, + :configure_user_role => false + } + end + + it { is_expected.not_to contain_keystone_user('oslo') } + it { is_expected.not_to contain_keystone_user_role('oslo@services') } + it { is_expected.to contain_keystone_service('oslo::FIXME').with( + :ensure => 'present', + :description => 'oslo FIXME Service' + ) } + + end + +end diff --git a/spec/classes/oslo_logging_spec.rb b/spec/classes/oslo_logging_spec.rb new file mode 100644 index 0000000..f63b013 --- /dev/null +++ b/spec/classes/oslo_logging_spec.rb @@ -0,0 +1,144 @@ +require 'spec_helper' + +describe 'oslo::logging' do + + let :params do + { + } + end + + let :log_params do + { + :logging_context_format_string => '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s', + :logging_default_format_string => '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s', + :logging_debug_format_suffix => '%(funcName)s %(pathname)s:%(lineno)d', + :logging_exception_prefix => '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s', + :log_config_append => '/etc/oslo/logging.conf', + :publish_errors => true, + :default_log_levels => { + 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN', + 'qpid' => 'WARN', 'sqlalchemy' => 'WARN', 'suds' => 'INFO', + 'iso8601' => 'WARN', + 'requests.packages.urllib3.connectionpool' => 'WARN' }, + :fatal_deprecations => true, + :instance_format => '[instance: %(uuid)s] ', + :instance_uuid_format => '[instance: %(uuid)s] ', + :log_date_format => '%Y-%m-%d %H:%M:%S', + :use_syslog => true, + :use_stderr => false, + :log_facility => 'LOG_FOO', + :log_dir => '/var/log', + :verbose => true, + :debug => true, + } + end + + shared_examples_for 'oslo-logging' do + + context 'with basic logging options and default settings' do + it_configures 'basic default logging settings' + end + + context 'with basic logging options and non-default settings' do + before { params.merge!( log_params ) } + it_configures 'basic non-default logging settings' + end + + context 'with extended logging options' do + before { params.merge!( log_params ) } + it_configures 'logging params set' + end + + context 'without extended logging options' do + it_configures 'logging params unset' + end + + end + + shared_examples 'basic default logging settings' do + it 'configures oslo logging settins with default values' do + is_expected.to contain_oslo_config('DEFAULT/use_syslog').with(:value => '') + is_expected.to contain_oslo_config('DEFAULT/use_stderr').with(:value => '') + is_expected.to contain_oslo_config('DEFAULT/syslog_log_facility').with(:value => '') + is_expected.to contain_oslo_config('DEFAULT/log_dir').with(:value => '/var/log/oslo') + is_expected.to contain_oslo_config('DEFAULT/verbose').with(:value => '') + is_expected.to contain_oslo_config('DEFAULT/debug').with(:value => '') + end + end + + shared_examples 'basic non-default logging settings' do + it 'configures oslo logging settins with non-default values' do + is_expected.to contain_oslo_config('DEFAULT/use_syslog').with(:value => 'true') + is_expected.to contain_oslo_config('DEFAULT/use_stderr').with(:value => 'false') + is_expected.to contain_oslo_config('DEFAULT/syslog_log_facility').with(:value => 'LOG_FOO') + is_expected.to contain_oslo_config('DEFAULT/log_dir').with(:value => '/var/log') + is_expected.to contain_oslo_config('DEFAULT/verbose').with(:value => 'true') + is_expected.to contain_oslo_config('DEFAULT/debug').with(:value => 'true') + end + end + + shared_examples_for 'logging params set' do + it 'enables logging params' do + is_expected.to contain_oslo_config('DEFAULT/logging_context_format_string').with_value( + '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s') + + is_expected.to contain_oslo_config('DEFAULT/logging_default_format_string').with_value( + '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s') + + is_expected.to contain_oslo_config('DEFAULT/logging_debug_format_suffix').with_value( + '%(funcName)s %(pathname)s:%(lineno)d') + + is_expected.to contain_oslo_config('DEFAULT/logging_exception_prefix').with_value( + '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s') + + is_expected.to contain_oslo_config('DEFAULT/log_config_append').with_value( + '/etc/oslo/logging.conf') + is_expected.to contain_oslo_config('DEFAULT/publish_errors').with_value( + true) + + is_expected.to contain_oslo_config('DEFAULT/default_log_levels').with_value( + 'amqp=WARN,amqplib=WARN,boto=WARN,iso8601=WARN,qpid=WARN,requests.packages.urllib3.connectionpool=WARN,sqlalchemy=WARN,suds=INFO') + + is_expected.to contain_oslo_config('DEFAULT/fatal_deprecations').with_value( + true) + + is_expected.to contain_oslo_config('DEFAULT/instance_format').with_value( + '[instance: %(uuid)s] ') + + is_expected.to contain_oslo_config('DEFAULT/instance_uuid_format').with_value( + '[instance: %(uuid)s] ') + + is_expected.to contain_oslo_config('DEFAULT/log_date_format').with_value( + '%Y-%m-%d %H:%M:%S') + end + end + + + shared_examples_for 'logging params unset' do + [ :logging_context_format_string, :logging_default_format_string, + :logging_debug_format_suffix, :logging_exception_prefix, + :log_config_append, :publish_errors, + :default_log_levels, :fatal_deprecations, + :instance_format, :instance_uuid_format, + :log_date_format, ].each { |param| + it { is_expected.to contain_oslo_config("DEFAULT/#{param}").with_value('') } + } + end + + context 'on Debian platforms' do + let :facts do + @default_facts.merge({ :osfamily => 'Debian' }) + end + + it_configures 'oslo-logging' + end + + context 'on RedHat platforms' do + let :facts do + @default_facts.merge({ :osfamily => 'RedHait' }) + end + + it_configures 'oslo-logging' + end + +end diff --git a/spec/classes/oslo_policy_spec.rb b/spec/classes/oslo_policy_spec.rb new file mode 100644 index 0000000..19a5aaf --- /dev/null +++ b/spec/classes/oslo_policy_spec.rb @@ -0,0 +1,41 @@ +require 'spec_helper' + +describe 'oslo::policy' do + + shared_examples_for 'oslo policies' do + let :params do + { + :policy_path => '/etc/oslo/policy.json', + :policies => { + 'context_is_admin' => { + 'key' => 'context_is_admin', + 'value' => 'foo:bar' + } + } + } + end + + it 'set up the policies' do + is_expected.to contain_openstacklib__policy__base('context_is_admin').with({ + :key => 'context_is_admin', + :value => 'foo:bar' + }) + end + end + + context 'on Debian platforms' do + let :facts do + { :osfamily => 'Debian' } + end + + it_configures 'oslo policies' + end + + context 'on RedHat platforms' do + let :facts do + { :osfamily => 'RedHat' } + end + + it_configures 'oslo policies' + end +end diff --git a/spec/shared_examples.rb b/spec/shared_examples.rb new file mode 100644 index 0000000..fec0eac --- /dev/null +++ b/spec/shared_examples.rb @@ -0,0 +1,5 @@ +shared_examples_for "a Puppet::Error" do |description| + it "with message matching #{description.inspect}" do + expect { is_expected.to have_class_count(1) }.to raise_error(Puppet::Error, description) + end +end diff --git a/spec/unit/provider/oslo_config/ini_setting_spec.rb b/spec/unit/provider/oslo_config/ini_setting_spec.rb new file mode 100644 index 0000000..6278391 --- /dev/null +++ b/spec/unit/provider/oslo_config/ini_setting_spec.rb @@ -0,0 +1,68 @@ +# +# these tests are a little concerning b/c they are hacking around the +# modulepath, so these tests will not catch issues that may eventually arise +# related to loading these plugins. +# I could not, for the life of me, figure out how to programatcally set the modulepath +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + '..', + 'fixtures', + 'modules', + 'inifile', + 'lib') +) +$LOAD_PATH.push( + File.join( + File.dirname(__FILE__), + '..', + '..', + '..', + 'fixtures', + 'modules', + 'openstacklib', + 'lib') +) +require 'spec_helper' +provider_class = Puppet::Type.type(:oslo_config).provider(:ini_setting) +describe provider_class do + + it 'should default to the default setting when no other one is specified' do + resource = Puppet::Type::Oslo_config.new( + {:name => 'DEFAULT/foo', :value => 'bar'} + ) + provider = provider_class.new(resource) + expect(provider.section).to eq('DEFAULT') + expect(provider.setting).to eq('foo') + end + + it 'should allow setting to be set explicitly' do + resource = Puppet::Type::Oslo_config.new( + {:name => 'dude/foo', :value => 'bar'} + ) + provider = provider_class.new(resource) + expect(provider.section).to eq('dude') + expect(provider.setting).to eq('foo') + end + + it 'should ensure absent when is specified as a value' do + resource = Puppet::Type::Oslo_config.new( + {:name => 'dude/foo', :value => ''} + ) + provider = provider_class.new(resource) + provider.exists? + expect(resource[:ensure]).to eq :absent + end + + it 'should ensure absent when value matches ensure_absent_val' do + resource = Puppet::Type::Oslo_config.new( + {:name => 'dude/foo', :value => 'foo', :ensure_absent_val => 'foo' } + ) + provider = provider_class.new(resource) + provider.exists? + expect(resource[:ensure]).to eq :absent + end + +end diff --git a/spec/unit/type/oslo_config_spec.rb b/spec/unit/type/oslo_config_spec.rb new file mode 100644 index 0000000..79461c5 --- /dev/null +++ b/spec/unit/type/oslo_config_spec.rb @@ -0,0 +1,64 @@ +require 'puppet' +require 'puppet/type/oslo_config' +describe 'Puppet::Type.type(:oslo_config)' do + before :each do + @oslo_config = Puppet::Type.type(:oslo_config).new(:name => 'DEFAULT/foo', :value => 'bar') + end + + it 'should require a name' do + expect { + Puppet::Type.type(:oslo_config).new({}) + }.to raise_error(Puppet::Error, 'Title or name must be provided') + end + + it 'should not expect a name with whitespace' do + expect { + Puppet::Type.type(:oslo_config).new(:name => 'f oo') + }.to raise_error(Puppet::Error, /Parameter name failed/) + end + + it 'should fail when there is no section' do + expect { + Puppet::Type.type(:oslo_config).new(:name => 'foo') + }.to raise_error(Puppet::Error, /Parameter name failed/) + end + + it 'should not require a value when ensure is absent' do + Puppet::Type.type(:oslo_config).new(:name => 'DEFAULT/foo', :ensure => :absent) + end + + it 'should accept a valid value' do + @oslo_config[:value] = 'bar' + expect(@oslo_config[:value]).to eq('bar') + end + + it 'should not accept a value with whitespace' do + @oslo_config[:value] = 'b ar' + expect(@oslo_config[:value]).to eq('b ar') + end + + it 'should accept valid ensure values' do + @oslo_config[:ensure] = :present + expect(@oslo_config[:ensure]).to eq(:present) + @oslo_config[:ensure] = :absent + expect(@oslo_config[:ensure]).to eq(:absent) + end + + it 'should not accept invalid ensure values' do + expect { + @oslo_config[:ensure] = :latest + }.to raise_error(Puppet::Error, /Invalid value/) + end + + it 'should autorequire the package that install the file' do + catalog = Puppet::Resource::Catalog.new + package = Puppet::Type.type(:package).new(:name => 'oslo') + catalog.add_resource package, @oslo_config + dependency = @oslo_config.autorequire + expect(dependency.size).to eq(1) + expect(dependency[0].target).to eq(@oslo_config) + expect(dependency[0].source).to eq(package) + end + + +end diff --git a/tests/init.pp b/tests/init.pp new file mode 100644 index 0000000..3e55da7 --- /dev/null +++ b/tests/init.pp @@ -0,0 +1,12 @@ +# The baseline for module testing used by Puppet Labs is that each manifest +# should have a corresponding test manifest that declares that class or defined +# type. +# +# Tests are then run by using puppet apply --noop (to check for compilation +# errors and view a log of events) or by fully applying the test in a virtual +# environment (to compare the resulting system state to the desired state). +# +# Learn more about module testing here: +# http://docs.puppetlabs.com/guides/tests_smoke.html +# +include ::oslo