Puppet Class: trove::guestagent

Inherits:
trove
Defined in:
manifests/guestagent.pp

Overview

Class: trove::guestagent

Manages trove guest agent package and service

Parameters:

enabled

(optional) Whether to enable the trove guest agent service Defaults to false

manage_service

(optional) Whether to start/stop the service Defaults to true

package_ensure

(optional) The state of the trove guest agent package Defaults to ‘present’

debug

(optional) Rather to log the trove guest agent service at debug level. Default: false

log_file

(optional) The path of file used for logging If set to $::os_service_default, it will not log to any file. Default: /var/log/trove/trove-guestagent.log

log_dir

(optional) directory to which trove logs are sent. If set to $::os_service_default, it will not log to any directory. Defaults to ‘/var/log/trove’

use_syslog

(optional) Use syslog for logging. Defaults to $::os_service_default

log_facility

(optional) Syslog facility to receive log lines. Defaults to ‘LOG_USER’.

swift_url

(optional) Swift URL. If this is unset in the class, Trove will lookup the URL using the Keystone catalog. Defaults to $::os_service_default.

swift_service_type

(optional) Service type to use when searching catalog Defaults to $::os_service_default.

default_transport_url

(optional) A URL representing the messaging driver to use and its full configuration. Transport URLs take the form:

transport://user:pass@host1:port[,hostN:portN]/virtual_host

Defaults to $::trove::default_transport_url

rabbit_use_ssl

(optional) Connect over SSL for RabbitMQ Defaults to the value set in the trove class. The default can generally be left unless the guests need to talk to the rabbit cluster via a different ssl connection option.

root_grant

(optional) Permissions to grant “root” user. Defaults to $::os_service_default.

root_grant_option

(optional) Permissions to grant “root” user option. Defaults to $::os_service_default.

default_password_length

(optional) Default password Length for root password. Defaults to $::os_service_default.

DEPRECATED PARAMETERS
backup_aes_cbc_key

(optional) Default OpenSSL aes_cbc key Defaults to undef

Parameters:

  • enabled (Any) (defaults to: false)
  • manage_service (Any) (defaults to: true)
  • package_ensure (Any) (defaults to: 'present')
  • debug (Any) (defaults to: $::os_service_default)
  • log_file (Any) (defaults to: '/var/log/trove/trove-guestagent.log')
  • log_dir (Any) (defaults to: '/var/log/trove')
  • use_syslog (Any) (defaults to: $::os_service_default)
  • log_facility (Any) (defaults to: $::os_service_default)
  • swift_url (Any) (defaults to: $::os_service_default)
  • swift_service_type (Any) (defaults to: $::os_service_default)
  • default_transport_url (Any) (defaults to: $::trove::default_transport_url)
  • rabbit_use_ssl (Any) (defaults to: $::trove::rabbit_use_ssl)
  • root_grant (Any) (defaults to: $::os_service_default)
  • root_grant_option (Any) (defaults to: $::os_service_default)
  • default_password_length (Any) (defaults to: $::os_service_default)
  • backup_aes_cbc_key (Any) (defaults to: undef) 


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'manifests/guestagent.pp', line 81

class trove::guestagent(
  $enabled                 = false,
  $manage_service          = true,
  $package_ensure          = 'present',
  $debug                   = $::os_service_default,
  $log_file                = '/var/log/trove/trove-guestagent.log',
  $log_dir                 = '/var/log/trove',
  $use_syslog              = $::os_service_default,
  $log_facility            = $::os_service_default,
  $swift_url               = $::os_service_default,
  $swift_service_type      = $::os_service_default,
  $default_transport_url   = $::trove::default_transport_url,
  $rabbit_use_ssl          = $::trove::rabbit_use_ssl,
  $root_grant              = $::os_service_default,
  $root_grant_option       = $::os_service_default,
  $default_password_length = $::os_service_default,
  # DEPRECATED PARAMETERS
  $backup_aes_cbc_key      = undef,
) inherits trove {

  include trove::deps
  include trove::params
  include trove::guestagent::service_credentials

  if $backup_aes_cbc_key != undef {
    warning('The parameter backup_aes_cbc_key is deprecated for removal')
  }

  # basic service config
  trove_guestagent_config {
    'DEFAULT/swift_url':               value => $swift_url;
    'DEFAULT/swift_service_type':      value => $swift_service_type;
    'DEFAULT/root_grant':              value => $root_grant;
    'DEFAULT/root_grant_option':       value => $root_grant_option;
    'DEFAULT/default_password_length': value => $default_password_length;
    'DEFAULT/backup_aes_cbc_key':      value => pick($backup_aes_cbc_key, $::os_service_default);
  }

  oslo::messaging::default { 'trove_guestagent_config':
    transport_url        => $default_transport_url,
    control_exchange     => $::trove::control_exchange,
    rpc_response_timeout => $::trove::rpc_response_timeout,
  }

  oslo::messaging::notifications { 'trove_guestagent_config':
    transport_url => $::trove::notification_transport_url,
    driver        => $::trove::notification_driver,
    topics        => $::trove::notification_topics
  }

  oslo::messaging::rabbit {'trove_guestagent_config':
    rabbit_use_ssl          => $rabbit_use_ssl,
    rabbit_ha_queues        => $::trove::rabbit_ha_queues,
    heartbeat_in_pthread    => $::trove::rabbit_heartbeat_in_pthread,
    kombu_reconnect_delay   => $::trove::kombu_reconnect_delay,
    kombu_failover_strategy => $::trove::kombu_failover_strategy,
    amqp_durable_queues     => $::trove::amqp_durable_queues,
    kombu_ssl_ca_certs      => $::trove::kombu_ssl_ca_certs,
    kombu_ssl_certfile      => $::trove::kombu_ssl_certfile,
    kombu_ssl_keyfile       => $::trove::kombu_ssl_keyfile,
    kombu_ssl_version       => $::trove::kombu_ssl_version
  }

  oslo::messaging::amqp { 'trove_guestagent_config':
    server_request_prefix => $::trove::amqp_server_request_prefix,
    broadcast_prefix      => $::trove::amqp_broadcast_prefix,
    group_request_prefix  => $::trove::amqp_group_request_prefix,
    container_name        => $::trove::amqp_container_name,
    idle_timeout          => $::trove::amqp_idle_timeout,
    trace                 => $::trove::amqp_trace,
    ssl_ca_file           => $::trove::amqp_ssl_ca_file,
    ssl_cert_file         => $::trove::amqp_ssl_cert_file,
    ssl_key_file          => $::trove::amqp_ssl_key_file,
    ssl_key_password      => $::trove::amqp_ssl_key_password,
    sasl_mechanisms       => $::trove::amqp_sasl_mechanisms,
    sasl_config_dir       => $::trove::amqp_sasl_config_dir,
    sasl_config_name      => $::trove::amqp_sasl_config_name,
    username              => $::trove::amqp_username,
    password              => $::trove::amqp_password,
  }

  oslo::log { 'trove_guestagent_config':
    debug               => $debug,
    log_file            => $log_file,
    log_dir             => $log_dir,
    use_syslog          => $use_syslog,
    syslog_log_facility => $log_facility
  }

  trove::generic_service { 'guestagent':
    enabled        => $enabled,
    manage_service => $manage_service,
    package_name   => $::trove::params::guestagent_package_name,
    service_name   => $::trove::params::guestagent_service_name,
    package_ensure => $package_ensure,
  }

}