openstack/puppet-octavia
Code Issues Proposed changes

Add hooks for external install & svc management

Browse Source 
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: I281a300df5abfa927b8b6de54f1755ad89ccf563
This commit is contained in:
ZhongShengping
2016-12-07 11:48:51 +08:00
parent a245d07f19
commit 925794a2c9
18 changed files with 97 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
manifests/api.pp
View File

@@ -35,13 +35,9 @@ class octavia::api (
$sync_db = false,
) inherits octavia::params {
include ::octavia::deps
include ::octavia::policy
Octavia_config<||> ~> Service['octavia-api']
Class['octavia::policy'] ~> Service['octavia-api']
Package['octavia-api'] -> Service['octavia-api']
Package['octavia-api'] -> Class['octavia::policy']
package { 'octavia-api':
ensure => $package_ensure,
name => $::octavia::params::api_package_name,
@@ -66,7 +62,6 @@ class octavia::api (
enable => $enabled,
hasstatus => true,
hasrestart => true,
require => Class['octavia::db'],
tag => ['octavia-service', 'octavia-db-sync-service'],
}

2
manifests/config.pp
View File

@@ -24,6 +24,8 @@ class octavia::config (
$octavia_config = {},
) {
include ::octavia::deps
validate_hash($octavia_config)
create_resources('octavia_config', $octavia_config)

2
manifests/db.pp
View File

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

7
manifests/db/mysql.pp
View File

@@ -53,6 +53,8 @@ class octavia::db::mysql(
$allowed_hosts = undef
) {
include ::octavia::deps
validate_string($password)
::openstacklib::db::mysql { 'octavia':
@@ -65,5 +67,8 @@ class octavia::db::mysql(
allowed_hosts => $allowed_hosts,
}
::Openstacklib::Db::Mysql['octavia'] ~> Exec<| title == 'octavia-manage db_sync' |>
Anchor['octavia::db::begin']
~> Class['octavia::db::mysql']
~> Anchor['octavia::db::end']
}

6
manifests/db/postgresql.pp
View File

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

11
manifests/db/sync.pp
View File

@@ -11,6 +11,9 @@
class octavia::db::sync(
$extra_params = undef,
) {
include ::octavia::deps
exec { 'octavia-db-sync':
command => "octavia-db-manage upgrade head ${extra_params}",
path => '/usr/bin',
@@ -18,8 +21,12 @@ class octavia::db::sync(
refreshonly => true,
try_sleep => 5,
tries => 10,
subscribe => [Package['octavia'], Octavia_config['database/connection']],
subscribe => [
Anchor['octavia::install::end'],
Anchor['octavia::config::end'],
Anchor['octavia::dbsync::begin']
],
notify => Anchor['octavia::dbsync::end'],
}
Exec['octavia-db-sync'] ~> Service<| tag == 'octavia-db-sync-service' |>
}

35
manifests/deps.pp Normal file
View File

@@ -0,0 +1,35 @@
# == Class: octavia::deps
#
# Octavia anchors and dependency management
#
class octavia::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 { 'octavia::install::begin': }
-> Package<| tag == 'octavia-package'|>
~> anchor { 'octavia::install::end': }
-> anchor { 'octavia::config::begin': }
-> Octavia_config<||>
~> anchor { 'octavia::config::end': }
-> anchor { 'octavia::db::begin': }
-> anchor { 'octavia::db::end': }
~> anchor { 'octavia::dbsync::begin': }
-> anchor { 'octavia::dbsync::end': }
~> anchor { 'octavia::service::begin': }
~> Service<| tag == 'octavia-service' |>
~> anchor { 'octavia::service::end': }
# policy config should occur in the config block also.
Anchor['octavia::config::begin']
-> Openstacklib::Policy::Base<||>
~> Anchor['octavia::config::end']
# Installation or config changes will always restart services.
Anchor['octavia::install::end'] ~> Anchor['octavia::service::begin']
Anchor['octavia::config::end'] ~> Anchor['octavia::service::begin']
}

13
manifests/health_manager.pp
View File

@@ -21,19 +21,18 @@
# (optional) Driver to use for synchronizing octavia and lbaas databases.
# Defaults to $::os_service_default
#
class octavia::health_manager (
$heartbeat_key,
$manage_service = true,
$enabled = true,
$package_ensure = 'present',
$event_streamer_driver = $::os_service_default,
$manage_service = true,
$enabled = true,
$package_ensure = 'present',
$event_streamer_driver = $::os_service_default,
) inherits octavia::params {
include ::octavia::deps
validate_string($heartbeat_key)
Octavia_config<||> ~> Service['octavia-health-manager']
Package['octavia-health-manager'] -> Service['octavia-health-manager']
package { 'octavia-health-manager':
ensure => $package_ensure,
name => $::octavia::params::health_manager_package_name,

6
manifests/housekeeping.pp
View File

@@ -45,7 +45,7 @@
# [*cert_rotate_threads*]
# (optional) Number of threads performing amphora certificate rotation.
# Defaults to $::os_service_default
#
class octavia::housekeeping (
$manage_service = true,
$enabled = true,
@@ -60,8 +60,8 @@ class octavia::housekeeping (
$cert_rotate_threads = $::os_service_default,
) inherits octavia::params {
Octavia_config<||> ~> Service['octavia-housekeeping']
Package['octavia-housekeeping'] -> Service['octavia-housekeeping']
include ::octavia::deps
package { 'octavia-housekeeping':
ensure => $package_ensure,
name => $::octavia::params::housekeeping_package_name,

1
manifests/init.pp
View File

@@ -203,6 +203,7 @@ class octavia (
$purge_config = false,
) inherits octavia::params {
include ::octavia::deps
include ::octavia::logging
include ::octavia::db

2
manifests/keystone/auth.pp
View File

@@ -64,6 +64,8 @@ class octavia::keystone::auth (
$internal_url = 'http://127.0.0.1:9876',
) {
include ::octavia::deps
keystone::resource::service_identity { 'octavia':
configure_user => $configure_user,
configure_user_role => $configure_user_role,

2
manifests/keystone/authtoken.pp
View File

@@ -222,6 +222,8 @@ class octavia::keystone::authtoken(
$token_cache_time = $::os_service_default,
) {
include ::octavia::deps
keystone::resource::authtoken { 'octavia_config':
username => $username,
password => $password,

2
manifests/logging.pp
View File

@@ -113,6 +113,8 @@ class octavia::logging(
$log_date_format = $::os_service_default,
) {
include ::octavia::deps
oslo::log { 'octavia_config':
debug => $debug,
use_syslog => $use_syslog,

2
manifests/policy.pp
View File

@@ -28,6 +28,8 @@ class octavia::policy (
$policy_path = '/etc/octavia/policy.json',
) {
include ::octavia::deps
validate_hash($policies)
Openstacklib::Policy::Base {

7
manifests/worker.pp
View File

@@ -47,7 +47,6 @@
# Possible options are documented in puppet-nova nova_flavor type.
# Defaults to {}.
#
class octavia::worker (
$manage_service = true,
$enabled = true,
@@ -60,7 +59,9 @@ class octavia::worker (
$nova_flavor_config = {},
) inherits octavia::params {
validate_hash($nova_flavor_config)
include ::octavia::deps
validate_hash($nova_flavor_config)
if ! is_service_default($loadbalancer_topology) and ! ($loadbalancer_topology in ['SINGLE', 'ACTIVE_STANDBY']) {
fail('load balancer topology must be one of SINGLE or ACTIVE_STANDBY')
@@ -88,8 +89,6 @@ validate_hash($nova_flavor_config)
}
}
Octavia_config<||> ~> Service['octavia-worker']
Package['octavia-worker'] -> Service['octavia-worker']
package { 'octavia-worker':
ensure => $package_ensure,
name => $::octavia::params::worker_package_name,

10
releasenotes/notes/external_install_mgmt_hook-1e652961711571a3.yaml Normal file
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.

4
spec/classes/octavia_api_spec.rb
View File

@@ -18,6 +18,7 @@ describe 'octavia::api' do
shared_examples_for 'octavia-api' do
it { is_expected.to contain_class('octavia::deps') }
it { is_expected.to contain_class('octavia::params') }
it { is_expected.to contain_class('octavia::policy') }
@@ -47,10 +48,11 @@ describe 'octavia::api' do
:enable => params[:enabled],
:hasstatus => true,
:hasrestart => true,
:require => 'Class[Octavia::Db]',
:tag => ['octavia-service', 'octavia-db-sync-service'],
)
end
it { is_expected.to contain_service('octavia-api').that_subscribes_to('Anchor[octavia::service::begin]')}
it { is_expected.to contain_service('octavia-api').that_notifies('Anchor[octavia::service::end]')}
end
end

4
spec/classes/octavia_init_spec.rb
View File

@@ -9,6 +9,10 @@ describe 'octavia' do
{ :purge_config => false }
end
it 'contains the deps class' do
is_expected.to contain_class('octavia::deps')
end
it 'contains the logging class' do
is_expected.to contain_class('octavia::logging')
end