Puppet Class: neutron::agents::ovn_metadata

Defined in:
manifests/agents/ovn_metadata.pp

Overview

Class: neutron::agents::ovn_metadata

Setup and configure neutron ovn metadata agent.

Parameters

shared_secret

(required) Shared secret to validate proxies Neutron metadata requests.

package_ensure

Ensure state of the package. Defaults to ‘present’.

enabled

State of the service. Defaults to true.

manage_service

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

debug

Debug. Defaults to false.

auth_ca_cert

CA cert to check against with for ssl keystone. (Defaults to $::os_service_default)

nova_client_cert

Client certificate for nova metadata api server. (Defaults to $::os_service_default)

nova_client_priv_key

Private key of client certificate. (Defaults to $::os_service_default)

metadata_ip

The IP address of the metadata service. Defaults to $::os_service_default.

metadata_host

The hostname of the metadata service. Defaults to $::os_service_default.

metadata_port

The TCP port of the metadata service. Defaults to $::os_service_default.

metadata_protocol

The protocol to use for requests to Nova metadata server. Defaults to $::os_service_default.

metadata_workers

(optional) Number of separate worker processes to spawn. Greater than 0 launches that number of child processes as workers. The parent process manages them. Defaults to: 2

metadata_backlog

(optional) Number of backlog requests to configure the metadata server socket with. Defaults to $::os_service_default

metadata_insecure

(optional) Allow to perform insecure SSL (https) requests to nova metadata. Defaults to $::os_service_default

ovsdb_connection

(optional) The URI used to connect to the local OVSDB server. Defaults to ‘tcp:127.0.0.1:6640’

ovs_manager

The manager target that will be set to OVS so that the metadata agent can connect to. Defaults to ‘ptcp:6640:127.0.0.1’

ovn_sb_connection

(optional) The connection string for the OVN_Southbound OVSDB Defaults to ‘$::os_service_default’

ovn_sb_private_key

(optional) TThe PEM file with private key for SSL connection to OVN-SB-DB Defaults to $::os_service_default

ovn_sb_certificate

(optional) The PEM file with certificate that certifies the private key specified in ovn_sb_private_key Defaults to $::os_service_default

ovn_sb_ca_cert

(optional) TThe PEM file with CA certificate that OVN should use to verify certificates presented to it by SSL peers Defaults to $::os_service_default

ovsdb_connection_timeout

(optional) Timeout in seconds for the OVSDB connection transaction Defaults to $::os_service_default

root_helper

(optional) Use “sudo neutron-rootwrap /etc/neutron/rootwrap.conf” to use the real root filter facility. Change to “sudo” to skip the filtering and just run the command directly Defaults to ‘sudo neutron-rootwrap /etc/neutron/rootwrap.conf’.

root_helper_daemon

(optional) Root helper daemon application to use when possible. Defaults to $::os_service_default.

state_path

(optional) Where to store state files. This directory must be writable by the user executing the agent Defaults to: ‘/var/lib/neutron’.

purge_config

(optional) Whether to set only the specified config options in the metadata config. Defaults to false.

DEPRECATED PARAMETERS

ovn_remote_probe_interval

(optional) Set probe interval, based on user configuration, value is in ms Defaults to undef

Parameters:

  • shared_secret (Any)
  • package_ensure (Any) (defaults to: 'present')
  • enabled (Any) (defaults to: true)
  • manage_service (Any) (defaults to: true)
  • debug (Any) (defaults to: false)
  • auth_ca_cert (Any) (defaults to: $::os_service_default)
  • metadata_ip (Any) (defaults to: $::os_service_default)
  • metadata_host (Any) (defaults to: $::os_service_default)
  • metadata_port (Any) (defaults to: $::os_service_default)
  • metadata_protocol (Any) (defaults to: $::os_service_default)
  • metadata_workers (Any) (defaults to: 2)
  • metadata_backlog (Any) (defaults to: $::os_service_default)
  • metadata_insecure (Any) (defaults to: $::os_service_default)
  • nova_client_cert (Any) (defaults to: $::os_service_default)
  • nova_client_priv_key (Any) (defaults to: $::os_service_default)
  • ovsdb_connection (Any) (defaults to: 'tcp:127.0.0.1:6640')
  • ovs_manager (Any) (defaults to: 'ptcp:6640:127.0.0.1')
  • ovn_sb_connection (Any) (defaults to: $::os_service_default)
  • ovn_sb_private_key (Any) (defaults to: $::os_service_default)
  • ovn_sb_certificate (Any) (defaults to: $::os_service_default)
  • ovn_sb_ca_cert (Any) (defaults to: $::os_service_default)
  • ovsdb_connection_timeout (Any) (defaults to: $::os_service_default)
  • root_helper (Any) (defaults to: 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf')
  • root_helper_daemon (Any) (defaults to: $::os_service_default)
  • state_path (Any) (defaults to: '/var/lib/neutron')
  • purge_config (Any) (defaults to: false)
  • ovn_remote_probe_interval (Any) (defaults to: undef)


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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'manifests/agents/ovn_metadata.pp', line 115

class neutron::agents::ovn_metadata (
  $shared_secret,
  $package_ensure            = 'present',
  $enabled                   = true,
  $manage_service            = true,
  $debug                     = false,
  $auth_ca_cert              = $::os_service_default,
  $metadata_ip               = $::os_service_default,
  $metadata_host             = $::os_service_default,
  $metadata_port             = $::os_service_default,
  $metadata_protocol         = $::os_service_default,
  $metadata_workers          = 2,
  $metadata_backlog          = $::os_service_default,
  $metadata_insecure         = $::os_service_default,
  $nova_client_cert          = $::os_service_default,
  $nova_client_priv_key      = $::os_service_default,
  $ovsdb_connection          = 'tcp:127.0.0.1:6640',
  $ovs_manager               = 'ptcp:6640:127.0.0.1',
  $ovn_sb_connection         = $::os_service_default,
  $ovn_sb_private_key        = $::os_service_default,
  $ovn_sb_certificate        = $::os_service_default,
  $ovn_sb_ca_cert            = $::os_service_default,
  $ovsdb_connection_timeout  = $::os_service_default,
  $root_helper               = 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf',
  $root_helper_daemon        = $::os_service_default,
  $state_path                = '/var/lib/neutron',
  $purge_config              = false,
  # DEPRECATED PARAMETERS
  $ovn_remote_probe_interval = undef,
  ) {

  include neutron::deps
  include neutron::params

  if $ovn_remote_probe_interval != undef {
    warning('The ovn_remote_probe_interval parameter is deprecated and has no effect')
  }
  ovn_metadata_agent_config {
    'ovn/ovn_remote_probe_interval': ensure => absent;
  }

  resources { 'ovn_metadata_agent_config':
    purge => $purge_config,
  }

  ovn_metadata_agent_config {
    'DEFAULT/debug':                          value => $debug;
    'DEFAULT/auth_ca_cert':                   value => $auth_ca_cert;
    'DEFAULT/nova_metadata_ip':               value => $metadata_ip;
    'DEFAULT/nova_metadata_host':             value => $metadata_host;
    'DEFAULT/nova_metadata_port':             value => $metadata_port;
    'DEFAULT/nova_metadata_protocol':         value => $metadata_protocol;
    'DEFAULT/nova_metadata_insecure':         value => $metadata_insecure;
    'DEFAULT/metadata_proxy_shared_secret':   value => $shared_secret;
    'DEFAULT/metadata_workers':               value => $metadata_workers;
    'DEFAULT/metadata_backlog':               value => $metadata_backlog;
    'DEFAULT/nova_client_cert':               value => $nova_client_cert;
    'DEFAULT/nova_client_priv_key':           value => $nova_client_priv_key;
    'DEFAULT/state_path':                     value => $state_path;
    'agent/root_helper':                      value => $root_helper;
    'agent/root_helper_daemon':               value => $root_helper_daemon;
    'ovs/ovsdb_connection':                   value => $ovsdb_connection;
    'ovs/ovsdb_connection_timeout':           value => $ovsdb_connection_timeout;
    'ovn/ovn_sb_connection':                  value => $ovn_sb_connection;
    'ovn/ovn_sb_private_key':                 value => $ovn_sb_private_key;
    'ovn/ovn_sb_certificate':                 value => $ovn_sb_certificate;
    'ovn/ovn_sb_ca_cert':                     value => $ovn_sb_ca_cert;
  }

  if $::neutron::params::ovn_metadata_agent_package {
    package { 'ovn-metadata':
      ensure => $package_ensure,
      name   => $::neutron::params::ovn_metadata_agent_package,
      tag    => ['openstack', 'neutron-package'],
    }
  }

  if $manage_service {
    if $enabled {
      $service_ensure = 'running'
    } else {
      $service_ensure = 'stopped'
    }
    service { 'ovn-metadata':
      ensure => $service_ensure,
      name   => $::neutron::params::ovn_metadata_agent_service,
      enable => $enabled,
      tag    => 'neutron-service',
    }
    Exec['Set OVS Manager'] -> Service['ovn-metadata']
  }

  # Set OVS manager so that metadata agent can connect to Open vSwitch
  exec { 'Set OVS Manager':
    command => "ovs-vsctl --timeout=5 --id=@manager -- create Manager target=\\\"${ovs_manager}\\\" \
               -- add Open_vSwitch . manager_options @manager",
    unless  => "ovs-vsctl show | grep \"${ovs_manager}\"",
    path    => '/usr/sbin:/usr/bin:/sbin:/bin',
  }

  Package<| title == 'ovn-metadata' |> -> Exec['Set OVS Manager']
}