Add hooks for external install & svc management

This adds defined anchor points for external modules to hook into the
software install, config and service dependency chain.  This allows
external modules to manage software installation (virtualenv,
containers, etc) and service management (pacemaker) without needing rely
on resources that may change or be renamed.

Change-Id: If683fbd098e701a3c4da91941cf818b18b41b209
This commit is contained in:
Clayton O'Neill 2016-06-08 12:40:15 +00:00
parent a2acbc7110
commit 18b010975c
36 changed files with 153 additions and 45 deletions

View File

@ -328,6 +328,7 @@ class glance::api(
$verbose = undef,
) inherits glance {
include ::glance::deps
include ::glance::policy
include ::glance::api::db
include ::glance::api::logging
@ -346,15 +347,6 @@ class glance::api(
)
}
Package[$glance::params::api_package_name] -> Class['glance::policy']
# adding all of this stuff b/c it devstack says glance-api uses the
# db now
Glance_api_config<||> ~> Service['glance-api']
Glance_cache_config<||> ~> Service['glance-api']
Class['glance::policy'] ~> Service['glance-api']
Service['glance-api'] ~> Glance_image<||>
# basic service config
glance_api_config {
'DEFAULT/bind_host': value => $bind_host;

View File

@ -43,6 +43,8 @@ class glance::api::db (
$database_max_overflow = $::os_service_default,
) {
include ::glance::deps
# NOTE(degorenko): In order to keep backward compatibility we rely on the pick function
# to use glance::api::<myparam> if glance::api::db::<myparam> isn't specified.
$database_connection_real = pick($::glance::api::database_connection, $database_connection)

View File

@ -117,6 +117,8 @@ class glance::api::logging(
$verbose = undef,
) {
include ::glance::deps
# NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
# to use glance::<myparam> first then glance::logging::<myparam>.
$use_syslog_real = pick($::glance::api::use_syslog,$use_syslog)

View File

@ -71,6 +71,8 @@ class glance::backend::cinder(
$glare_enabled = false,
) {
include ::glance::deps
if $os_region_name {
notice('The os_region_name parameter is deprecated and has no effect. Use glance::api::os_region_name instead.')
}

View File

@ -23,6 +23,8 @@ class glance::backend::file(
$glare_enabled = false,
) {
include ::glance::deps
glance_api_config {
'glance_store/filesystem_store_datadir': value => $filesystem_store_datadir;
}

View File

@ -51,6 +51,8 @@ class glance::backend::rbd(
$multi_store = false,
$glare_enabled = false,
) {
include ::glance::deps
include ::glance::params
if $show_image_direct_url {
@ -85,6 +87,7 @@ class glance::backend::rbd(
package { 'python-ceph':
ensure => $package_ensure,
name => $::glance::params::pyceph_package_name,
tag => 'glance-support-package',
}
}

View File

@ -77,6 +77,8 @@ class glance::backend::s3(
$default_store = undef,
) {
include ::glance::deps
if !is_service_default($large_object_chunk_size){
if !is_integer($large_object_chunk_size) or $large_object_chunk_size < 5 {
fail('glance::backend::s3::large_object_chunk_size must be an integer >= 5')

View File

@ -69,6 +69,8 @@ class glance::backend::swift(
$glare_enabled = false,
) {
include ::glance::deps
glance_api_config {
'glance_store/swift_store_region': value => $swift_store_region;
'glance_store/swift_store_container': value => $swift_store_container;

View File

@ -120,6 +120,8 @@ class glance::backend::vsphere(
$vcenter_api_insecure = undef,
) {
include ::glance::deps
if $vcenter_api_insecure {
warning('The vcenter_api_insecure parameter is deprecated, use parameter vcenter_insecure')
$vmware_insecure_real = $vcenter_api_insecure

View File

@ -33,6 +33,7 @@ class glance::cache::cleaner(
$command_options = '',
) {
include ::glance::deps
include ::glance::params
cron { 'glance-cache-cleaner':
@ -44,6 +45,6 @@ class glance::cache::cleaner(
monthday => $monthday,
month => $month,
weekday => $weekday,
require => Package[$::glance::params::api_package_name],
require => Anchor['glance::config::end'],
}
}

View File

@ -118,6 +118,8 @@ class glance::cache::logging(
$verbose = undef,
) {
include ::glance::deps
$use_syslog_real = pick($::glance::api::use_syslog,$use_syslog)
$use_stderr_real = pick($::glance::api::use_stderr,$use_stderr)
$log_facility_real = pick($::glance::api::log_facility,$log_facility)

View File

@ -33,6 +33,7 @@ class glance::cache::pruner(
$command_options = '',
) {
include ::glance::deps
include ::glance::params
cron { 'glance-cache-pruner':
@ -44,7 +45,7 @@ class glance::cache::pruner(
monthday => $monthday,
month => $month,
weekday => $weekday,
require => Package[$::glance::params::api_package_name],
require => Anchor['glance::config::end'],
}
}

View File

@ -10,12 +10,13 @@ class glance::client(
$ensure = 'present'
) {
include ::glance::deps
include ::glance::params
package { 'python-glanceclient':
ensure => $ensure,
name => $::glance::params::client_package_name,
tag => ['openstack'],
tag => ['openstack', 'glance-support-package'],
}
}

View File

@ -50,6 +50,9 @@ class glance::config (
$glare_paste_ini_config = {},
$cache_config = {},
) {
include ::glance::deps
validate_hash($api_config)
validate_hash($api_paste_ini_config)
validate_hash($registry_config)

View File

@ -36,6 +36,8 @@ class glance::db::mysql(
$collate = 'utf8_general_ci',
) {
include ::glance::deps
validate_string($password)
::openstacklib::db::mysql { 'glance':
@ -48,6 +50,7 @@ class glance::db::mysql(
allowed_hosts => $allowed_hosts,
}
::Openstacklib::Db::Mysql['glance'] ~> Exec<| title == 'glance-manage db_sync' |>
Anchor['glance::db::begin']
~> Class['glance::db::mysql']
~> Anchor['glance::db::end']
}

View File

@ -32,6 +32,8 @@ class glance::db::postgresql(
$privileges = 'ALL',
) {
include ::glance::deps
::openstacklib::db::postgresql { 'glance':
password_hash => postgresql_password($user, $password),
dbname => $dbname,
@ -40,6 +42,8 @@ class glance::db::postgresql(
privileges => $privileges,
}
::Openstacklib::Db::Postgresql['glance'] ~> Exec<| title == 'glance-manage db_sync' |>
Anchor['glance::db::begin']
~> Class['glance::db::postgresql']
~> Anchor['glance::db::end']
}

View File

@ -13,21 +13,21 @@ class glance::db::sync(
$extra_params = '--config-file /etc/glance/glance-registry.conf',
) {
include ::glance::deps
include ::glance::params
Package<| tag == 'glance-package' |> ~> Exec['glance-manage db_sync']
Exec['glance-manage db_sync'] ~> Service<| tag == 'glance-service' |>
Glance_registry_config<||> ~> Exec['glance-manage db_sync']
Glance_api_config<||> ~> Exec['glance-manage db_sync']
Glance_cache_config<||> ~> Exec['glance-manage db_sync']
exec { 'glance-manage db_sync':
command => "glance-manage ${extra_params} db_sync",
path => '/usr/bin',
user => 'glance',
refreshonly => true,
logoutput => on_failure,
subscribe => [
Anchor['glance::install::end'],
Anchor['glance::config::end'],
Anchor['glance::dbsync::begin']
],
notify => Anchor['glance::dbsync::end'],
}
}

61
manifests/deps.pp Normal file
View File

@ -0,0 +1,61 @@
# == Class: glance::deps
#
# glance anchors and dependency management
#
class glance::deps {
# Setup anchors for install, config and service phases of the module. These
# anchors allow external modules to hook the begin and end of any of these
# phases. Package or service management can also be replaced by ensuring the
# package is absent or turning off service management and having the
# replacement depend on the appropriate anchors. When applicable, end tags
# should be notified so that subscribers can determine if installation,
# config or service state changed and act on that if needed.
anchor { 'glance::install::begin': }
-> Package<| tag == 'glance-package'|>
~> anchor { 'glance::install::end': }
-> anchor { 'glance::config::begin': }
-> File<| tag == 'glance-config-file' |>
~> anchor { 'glance::config::end': }
-> anchor { 'glance::db::begin': }
-> anchor { 'glance::db::end': }
~> anchor { 'glance::dbsync::begin': }
-> anchor { 'glance::dbsync::end': }
~> anchor { 'glance::service::begin': }
~> Service<| tag == 'glance-service' |>
~> anchor { 'glance::service::end': }
# Ensure files are modified in the config block
Anchor['glance::config::begin']
-> File_line<| tag == 'glance-file-line' |>
~> Anchor['glance::config::end']
# Ensure all files are in place before modifying them
File<| tag == 'glance-config-file' |> -> File_line<| tag == 'glance-file-line' |>
# All other inifile providers need to be processed in the config block
Anchor['glance::config::begin'] -> Glance_api_config<||> ~> Anchor['glance::config::end']
Anchor['glance::config::begin'] -> Glance_api_paste_ini<||> ~> Anchor['glance::config::end']
Anchor['glance::config::begin'] -> Glance_cache_config<||> ~> Anchor['glance::config::end']
Anchor['glance::config::begin'] -> Glance_glare_config<||> ~> Anchor['glance::config::end']
Anchor['glance::config::begin'] -> Glance_glare_paste_ini<||> ~> Anchor['glance::config::end']
Anchor['glance::config::begin'] -> Glance_registry_config<||> ~> Anchor['glance::config::end']
Anchor['glance::config::begin'] -> Glance_registry_paste_ini<||> ~> Anchor['glance::config::end']
Anchor['glance::config::begin'] -> Glance_swift_config<||> ~> Anchor['glance::config::end']
# Support packages need to be installed in the install phase, but we don't
# put them in the chain above because we don't want any false dependencies
# between packages with the glance-package tag and the glance-support-package
# tag. Note: the package resources here will have a 'before' relationshop on
# the glance::install::end anchor. The line between glance-support-package and
# glance-package should be whether or not glance services would need to be
# restarted if the package state was changed.
Anchor['glance::install::begin']
-> Package<| tag == 'glance-support-package'|>
-> Anchor['glance::install::end']
Anchor['glance::service::end'] -> Glance_image<||>
# Installation or config changes will always restart services.
Anchor['glance::install::end'] ~> Anchor['glance::service::begin']
Anchor['glance::config::end'] ~> Anchor['glance::service::begin']
}

View File

@ -142,6 +142,7 @@ class glance::glare(
$token_cache_time = $::os_service_default,
) inherits glance {
include ::glance::deps
include ::glance::policy
include ::glance::glare::db
include ::glance::glare::logging
@ -153,11 +154,6 @@ class glance::glare(
})
}
Package[$::glance::params::glare_package_name] -> Class['glance::policy']
Glance_glare_config<||> ~> Service['glance-glare']
Class['glance::policy'] ~> Service['glance-glare']
glance_glare_config {
'DEFAULT/bind_host': value => $bind_host;
'DEFAULT/bind_port': value => $bind_port;

View File

@ -43,6 +43,8 @@ class glance::glare::db (
$database_max_overflow = $::os_service_default,
) {
include ::glance::deps
validate_re($database_connection,
'^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?')

View File

@ -117,6 +117,8 @@ class glance::glare::logging(
$verbose = undef,
) {
include ::glance::deps
if $verbose {
warning('verbose is deprecated, has no effect and will be removed after Newton cycle.')
}

View File

@ -13,6 +13,7 @@ class glance(
$package_ensure = 'present'
) {
include ::glance::deps
include ::glance::params
if ( $glance::params::api_package_name == $glance::params::registry_package_name ) {

View File

@ -77,9 +77,10 @@ class glance::keystone::auth(
$internal_url = 'http://127.0.0.1:9292',
) {
include ::glance::deps
if $configure_endpoint {
Keystone_endpoint["${region}/${service_name}::${service_type}"] ~> Service<| title == 'glance-api' |>
Keystone_endpoint["${region}/${service_name}::${service_type}"] -> Glance_image<||>
Keystone_endpoint["${region}/${service_name}::${service_type}"] ~> Anchor['glance::service::begin']
}
keystone::resource::service_identity { 'glance':
@ -100,8 +101,7 @@ class glance::keystone::auth(
}
if $configure_user_role {
Keystone_user_role["${auth_name}@${tenant}"] ~> Service<| title == 'glance-registry' |>
Keystone_user_role["${auth_name}@${tenant}"] ~> Service<| title == 'glance-api' |>
Keystone_user_role["${auth_name}@${tenant}"] ~> Anchor['glance::service::begin']
}
}

View File

@ -76,8 +76,10 @@ class glance::keystone::glare_auth(
$internal_url = 'http://127.0.0.1:9494',
) {
include ::glance::deps
if $configure_endpoint {
Keystone_endpoint["${region}/${service_name}::${service_type}"] ~> Service<| title == 'glance-glare' |>
Keystone_endpoint["${region}/${service_name}::${service_type}"] ~> Anchor['glance::service::begin']
}
keystone::resource::service_identity { 'glare':
@ -98,6 +100,6 @@ class glance::keystone::glare_auth(
}
if $configure_user_role {
Keystone_user_role["${auth_name}@${tenant}"] ~> Service<| title == 'glance-glare' |>
Keystone_user_role["${auth_name}@${tenant}"] ~> Anchor['glance::service::begin']
}
}

View File

@ -119,6 +119,8 @@ class glance::notify::rabbitmq(
$notification_driver = $::os_service_default,
) {
include ::glance::deps
oslo::messaging::rabbit { ['glance_api_config', 'glance_registry_config']:
rabbit_password => $rabbit_password,
rabbit_userid => $rabbit_userid,

View File

@ -28,10 +28,14 @@ class glance::policy(
$policy_path = '/etc/glance/policy.json',
) {
include ::glance::deps
validate_hash($policies)
Openstacklib::Policy::Base {
file_path => $policy_path,
require => Anchor['glance::config::begin'],
notify => Anchor['glance::config::end'],
}
create_resources('openstacklib::policy::base', $policies)

View File

@ -195,6 +195,7 @@ class glance::registry(
$verbose = undef,
) inherits glance {
include ::glance::deps
include ::glance::registry::logging
include ::glance::registry::db
@ -211,8 +212,6 @@ class glance::registry(
)
}
Glance_registry_config<||> ~> Service['glance-registry']
resources { 'glance_registry_config':
purge => $purge_config
}
@ -277,7 +276,6 @@ class glance::registry(
enable => $enabled,
hasstatus => true,
hasrestart => true,
require => Class['glance'],
tag => 'glance-service',
}

View File

@ -49,6 +49,8 @@ class glance::registry::db (
$database_max_overflow = $::os_service_default,
) {
include ::glance::deps
# NOTE(degorenko): In order to keep backward compatibility we rely on the pick function
# to use glance::registry::<myparam> if glance::registry::db::<myparam> isn't specified.
$database_connection_real = pick($::glance::registry::database_connection, $database_connection)

View File

@ -117,6 +117,8 @@ class glance::registry::logging(
$verbose = undef,
) {
include ::glance::deps
# NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
# to use glance::<myparam> first, then glance::logging::<myparam>.
$use_syslog_real = pick($::glance::registry::use_syslog,$use_syslog)

View File

@ -0,0 +1,10 @@
---
prelude: >
Add hooks for external install & svc management.
features:
- This adds defined anchor points for external modules to
hook into the software install, config and service dependency
chain. This allows external modules to manage software
installation (virtualenv, containers, etc) and service management
(pacemaker) without needing rely on resources that may change or
be renamed.

View File

@ -18,8 +18,8 @@ describe 'glance::cache::cleaner' do
:weekday => '*'
)
is_expected.to contain_cron('glance-cache-cleaner').with(
:require => "Package[#{platform_params[:api_package_name]}]"
is_expected.to contain_cron('glance-cache-cleaner').that_requires(
'Anchor[glance::config::end]'
)
end
end

View File

@ -17,8 +17,8 @@ describe 'glance::cache::pruner' do
:month => '*',
:weekday => '*'
)
is_expected.to contain_cron('glance-cache-pruner').with(
:require => "Package[#{platform_params[:api_package_name]}]"
is_expected.to contain_cron('glance-cache-pruner').that_requires(
'Anchor[glance::config::end]'
)
end
end

View File

@ -7,7 +7,7 @@ describe 'glance::client' do
it { is_expected.to contain_package('python-glanceclient').with(
:name => 'python-glanceclient',
:ensure => 'present',
:tag => ['openstack'],
:tag => ['openstack', 'glance-support-package'],
)
}
end

View File

@ -138,7 +138,7 @@ describe 'glance::keystone::auth' do
}
end
it { is_expected.to contain_keystone_endpoint('RegionOne/glance::image').with_notify(["Service[glance-api]"]) }
it { is_expected.to contain_keystone_endpoint('RegionOne/glance::image').that_notifies(["Anchor[glance::service::begin]"]) }
end
describe 'when overriding service name' do

View File

@ -138,7 +138,7 @@ describe 'glance::keystone::glare_auth' do
}
end
it { is_expected.to contain_keystone_endpoint('RegionOne/Glance Artifacts::artifact').with_notify(["Service[glance-glare]"]) }
it { is_expected.to contain_keystone_endpoint('RegionOne/Glance Artifacts::artifact').with_notify(["Anchor[glance::service::begin]"]) }
end
describe 'when overriding service name' do

View File

@ -68,9 +68,10 @@ describe 'glance::registry' do
'enable' => param_hash[:enabled],
'hasstatus' => true,
'hasrestart' => true,
'require' => 'Class[Glance]',
'tag' => 'glance-service',
)}
it { is_expected.to contain_service('glance-registry').that_subscribes_to('Anchor[glance::service::begin]')}
it { is_expected.to contain_service('glance-registry').that_notifies('Anchor[glance::service::end]')}
it 'is_expected.to not sync the db if sync_db is set to false' do
@ -141,9 +142,10 @@ describe 'glance::registry' do
'enable' => false,
'hasstatus' => true,
'hasrestart' => true,
'require' => 'Class[Glance]',
'tag' => 'glance-service',
)}
it { is_expected.to contain_service('glance-registry').that_subscribes_to('Anchor[glance::service::begin]')}
it { is_expected.to contain_service('glance-registry').that_notifies('Anchor[glance::service::end]')}
end
describe 'with overridden pipeline' do