Puppet Class: neutron::agents::metadata

Defined in:
manifests/agents/metadata.pp

Overview

Class: neutron::agents::metadata

Setup and configure Neutron metadata agent.

Parameters

shared_secret

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

package_ensure

(optional) Ensure state of the package. Defaults to ‘present’.

enabled

(optional) State of the service. Defaults to true.

manage_service

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

debug

Debug. Defaults to $facts.

auth_ca_cert

(optionall) CA cert to check against with for ssl keystone. Defaults to $facts

nova_client_cert

(optionall) Client certificate for nova metadata api server. Defaults to $facts

nova_client_priv_key

(optionall) Private key of client certificate. Defaults to $facts

metadata_host

(optionall) The hostname of the metadata service. Defaults to $facts

metadata_port

(optionall) The TCP port of the metadata service. Defaults to $facts

metadata_protocol

(optionall) The protocol to use for requests to Nova metadata server. Defaults to $facts

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 $facts

metadata_backlog

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

metadata_insecure

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

report_interval

(optional) Set the agent report interval. By default the global report interval in neutron.conf ([agent]/report_interval) is used. This parameter can be used to override the reporting interval for the sriov-agent. Defaults to $facts

rpc_response_max_timeout

(Optional) Maximum seconds to wait for a response from an RPC call Defaults to: $facts

purge_config

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

DEPRECATED PRAMETERS

metadata_memory_cache_ttl

(optional) Specifies time in seconds a metadata cache entry is valid in memory caching backend. Defaults to undef

Parameters:

  • shared_secret (Any)
  • package_ensure (Any) (defaults to: 'present')
  • enabled (Boolean) (defaults to: true)
  • manage_service (Boolean) (defaults to: true)
  • debug (Any) (defaults to: $facts['os_service_default'])
  • auth_ca_cert (Any) (defaults to: $facts['os_service_default'])
  • nova_client_cert (Any) (defaults to: $facts['os_service_default'])
  • nova_client_priv_key (Any) (defaults to: $facts['os_service_default'])
  • metadata_host (Any) (defaults to: $facts['os_service_default'])
  • metadata_port (Any) (defaults to: $facts['os_service_default'])
  • metadata_protocol (Any) (defaults to: $facts['os_service_default'])
  • metadata_workers (Any) (defaults to: $facts['os_workers'])
  • metadata_backlog (Any) (defaults to: $facts['os_service_default'])
  • metadata_insecure (Any) (defaults to: $facts['os_service_default'])
  • report_interval (Any) (defaults to: $facts['os_service_default'])
  • rpc_response_max_timeout (Any) (defaults to: $facts['os_service_default'])
  • purge_config (Boolean) (defaults to: false)
  • metadata_memory_cache_ttl (Any) (defaults to: undef) 


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
 
# File 'manifests/agents/metadata.pp', line 86

class neutron::agents::metadata (
  $shared_secret,
  $package_ensure            = 'present',
  Boolean $enabled           = true,
  Boolean $manage_service    = true,
  $debug                     = $facts['os_service_default'],
  $auth_ca_cert              = $facts['os_service_default'],
  $nova_client_cert          = $facts['os_service_default'],
  $nova_client_priv_key      = $facts['os_service_default'],
  $metadata_host             = $facts['os_service_default'],
  $metadata_port             = $facts['os_service_default'],
  $metadata_protocol         = $facts['os_service_default'],
  $metadata_workers          = $facts['os_workers'],
  $metadata_backlog          = $facts['os_service_default'],
  $metadata_insecure         = $facts['os_service_default'],
  $report_interval           = $facts['os_service_default'],
  $rpc_response_max_timeout  = $facts['os_service_default'],
  Boolean $purge_config      = false,
  # DEPRECATED PARAMETERS
  $metadata_memory_cache_ttl = undef,
) {

  include neutron::deps
  include neutron::params

  if $metadata_memory_cache_ttl {
    warning('The metadata_memory_cache_ttl parameter is deprecated and has no effect.')
  }

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

  neutron_metadata_agent_config {
    'DEFAULT/debug':                          value => $debug;
    'DEFAULT/auth_ca_cert':                   value => $auth_ca_cert;
    'DEFAULT/nova_client_cert':               value => $nova_client_cert;
    'DEFAULT/nova_client_priv_key':           value => $nova_client_priv_key;
    '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, secret => true;
    'DEFAULT/metadata_workers':               value => $metadata_workers;
    'DEFAULT/metadata_backlog':               value => $metadata_backlog;
    'agent/report_interval':                  value => $report_interval;
    'DEFAULT/rpc_response_max_timeout':       value => $rpc_response_max_timeout;
  }

  # TODO(tkajinam): Remove this after 2024.1 release
  neutron_metadata_agent_config {
    'DEFAULT/cache_url': ensure => absent;
  }

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

  if $manage_service {
    if $enabled {
      $service_ensure = 'running'
    } else {
      $service_ensure = 'stopped'
    }
    service { 'neutron-metadata':
      ensure => $service_ensure,
      name   => $::neutron::params::metadata_agent_service,
      enable => $enabled,
      tag    => 'neutron-service',
    }
    Neutron_metadata_agent_config<||> ~> Service['neutron-metadata']
  }
}